feat: add statement_timeout option, BasePgStoreModule (#6)

* feat: add statement timeout

* 1.1.0

* chore: specify units

* chore: add all methods to module

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hirosystems/api-toolkit",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "API development toolkit",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",

src/helpers.ts

@@ -0,0 +1,7 @@
+export const isDevEnv = process.env.NODE_ENV === 'development';
+export const isTestEnv = process.env.NODE_ENV === 'test';
+export const isProdEnv =
+  process.env.NODE_ENV === 'production' ||
+  process.env.NODE_ENV === 'prod' ||
+  !process.env.NODE_ENV ||
+  (!isTestEnv && !isDevEnv);

src/index.ts

@@ -1,3 +1,4 @@
+export * from './helpers';
 export * from './logger';
 export * from './postgres';
 export * from './server-version';

src/postgres/base-pg-store.ts

@@ -1,5 +1,6 @@
 import { AsyncLocalStorage } from 'async_hooks';
 import { PgSqlClient } from '.';
+import { isProdEnv } from '../helpers';
 
 /**
  * AsyncLocalStorage used to determine if the current async context is running inside a SQL
@@ -73,4 +74,44 @@ export class BasePgStore {
   ): Promise<UnwrapPromiseArray<T>> {
     return this.sqlTransaction(callback, false);
   }
+
+  /**
+   * Refreshes a materialized view concurrently depending on the current environment.
+   * @param viewName - Materialized view name
+   */
+  async refreshMaterializedView(viewName: string): Promise<void> {
+    await this.sql`REFRESH MATERIALIZED VIEW ${
+      isProdEnv ? this.sql`CONCURRENTLY` : this.sql``
+    } ${this.sql(viewName)}`;
+  }
+}
+
+/**
+ * Base module that extends PgStore functionality and allows organizing queries in separate files.
+ */
+export class BasePgStoreModule {
+  private readonly parent: BasePgStore;
+
+  constructor(db: BasePgStore) {
+    this.parent = db;
+  }
+
+  protected get sql(): PgSqlClient {
+    return this.parent.sql;
+  }
+
+  async sqlTransaction<T>(
+    callback: (sql: PgSqlClient) => T | Promise<T>,
+    readOnly = true
+  ): Promise<UnwrapPromiseArray<T>> {
+    return this.parent.sqlTransaction(callback, readOnly);
+  }
+  async sqlWriteTransaction<T>(
+    callback: (sql: PgSqlClient) => T | Promise<T>
+  ): Promise<UnwrapPromiseArray<T>> {
+    return this.sqlTransaction(callback, false);
+  }
+  async refreshMaterializedView(viewName: string): Promise<void> {
+    return this.parent.refreshMaterializedView(viewName);
+  }
 }

src/postgres/connection.ts

@@ -15,7 +15,7 @@ export type PgConnectionVars = {
   user?: string;
   password?: string;
   host?: string;
-  port?: string;
+  port?: number;
   schema?: string;
   ssl?: boolean;
   application_name?: string;
@@ -24,8 +24,13 @@ export type PgConnectionVars = {
 export type PgConnectionArgs = PgConnectionUri | PgConnectionVars;
 /** Postgres connection options */
 export type PgConnectionOptions = {
+  /** Time to wait before automatically closing an idle connection (s) */
   idleTimeout?: number;
+  /** Maximum allowed duration of any statement (ms) */
+  statementTimeout?: number;
+  /** Maximum time a connection can exist (s) */
   maxLifetime?: number;
+  /** Max number of connections */
   poolMax?: number;
 };
 
@@ -49,7 +54,7 @@ export function standardizedConnectionArgs(
       user: process.env.PGUSER,
       password: process.env.PGPASSWORD,
       host: process.env.PGHOST,
-      port: process.env.PGPORT ?? '5432',
+      port: parseInt(process.env.PGPORT ?? '5432'),
       ssl: true,
       application_name: `${appName}:${appUsage}`,
     };
@@ -150,7 +155,7 @@ export function getPostgres({
       user: args.user,
       password: args.password,
       host: args.host,
-      port: args.port ? parseInt(args.port) : undefined,
+      port: args.port,
       ssl: args.ssl,
       idle_timeout: connectionConfig?.idleTimeout,
       max_lifetime: connectionConfig?.maxLifetime,
@@ -159,6 +164,7 @@ export function getPostgres({
       connection: {
         application_name: args.application_name,
         search_path: args.schema,
+        statement_timeout: connectionConfig?.statementTimeout?.toString(),
       },
     });
   }

src/postgres/migrations.ts

@@ -25,7 +25,7 @@ export async function runMigrations(
         ? args
         : {
             host: args.host,
-            port: args.port ? parseInt(args.port) : undefined,
+            port: args.port,
             user: args.user,
             password: args.password,
             database: args.database,