feat: add ENV configs for DB close and API shutdown timeouts (#1366)

* style: async/await in postgres classes

* chore: tag read only pg txs

* feat: pg close timeout

* feat: force kill timeout env

* fix: remaining read only

* fix: correct use of scoped sql conns

* fix: resolveOrTimeout promise handling

Author: rafaelcr

.env

@@ -9,6 +9,8 @@ PG_SSL=false
 # PG_IDLE_TIMEOUT=30
 # Max connection lifetime in seconds, defaults to 60
 # PG_MAX_LIFETIME=60
+# Seconds before force-ending running queries on connection close, defaults to 5
+# PG_CLOSE_TIMEOUT=5
 
 # Can be any string, use to specify a use case specific to a deployment
 PG_APPLICATION_NAME=stacks-blockchain-api
@@ -33,6 +35,7 @@ PG_APPLICATION_NAME=stacks-blockchain-api
 # PG_PRIMARY_SSL=
 # PG_PRIMARY_IDLE_TIMEOUT=
 # PG_PRIMARY_MAX_LIFETIME=
+# PG_PRIMARY_CLOSE_TIMEOUT=
 # The connection URI below can be used in place of the PG variables above,
 # but if enabled it must be defined without others or omitted.
 # PG_PRIMARY_CONNECTION_URI=
@@ -84,6 +87,9 @@ STACKS_CORE_RPC_PORT=20443
 ## configure the chainID/networkID; testnet: 0x80000000, mainnet: 0x00000001
 STACKS_CHAIN_ID=0x00000001
 
+# Seconds to allow API components to shut down gracefully before force-killing them, defaults to 60
+# STACKS_SHUTDOWN_FORCE_KILL_TIMEOUT=60
+
 BTC_RPC_HOST=http://127.0.0.1
 BTC_RPC_PORT=18443
 BTC_RPC_USER=btc

src/datastore/connection.ts

@@ -115,35 +115,42 @@ export async function connectPostgres({
   return sql;
 }
 
+/**
+ * Retrieve a postgres ENV value depending on the target database server (read-replica/default or
+ * primary). We will fall back to read-replica values if a primary value was not given. See the
+ * `.env` file for more information on these options.
+ */
+export function getPgConnectionEnvValue(
+  name: string,
+  pgServer: PgServer = PgServer.default
+): string | undefined {
+  return pgServer === PgServer.primary
+    ? process.env[`PG_PRIMARY_${name}`] ?? process.env[`PG_${name}`]
+    : process.env[`PG_${name}`];
+}
+
 export function getPostgres({
   usageName,
   pgServer,
 }: {
   usageName: string;
   pgServer?: PgServer;
 }): PgSqlClient {
-  // Retrieve a postgres ENV value depending on the target database server (read-replica/default or primary).
-  // We will fall back to read-replica values if a primary value was not given.
-  // See the `.env` file for more information on these options.
-  const pgEnvValue = (name: string): string | undefined =>
-    pgServer === PgServer.primary
-      ? process.env[`PG_PRIMARY_${name}`] ?? process.env[`PG_${name}`]
-      : process.env[`PG_${name}`];
   const pgEnvVars = {
-    database: pgEnvValue('DATABASE'),
-    user: pgEnvValue('USER'),
-    password: pgEnvValue('PASSWORD'),
-    host: pgEnvValue('HOST'),
-    port: pgEnvValue('PORT'),
-    ssl: pgEnvValue('SSL'),
-    schema: pgEnvValue('SCHEMA'),
-    applicationName: pgEnvValue('APPLICATION_NAME'),
-    idleTimeout: parseInt(pgEnvValue('IDLE_TIMEOUT') ?? '30'),
-    maxLifetime: parseInt(pgEnvValue('MAX_LIFETIME') ?? '60'),
+    database: getPgConnectionEnvValue('DATABASE', pgServer),
+    user: getPgConnectionEnvValue('USER', pgServer),
+    password: getPgConnectionEnvValue('PASSWORD', pgServer),
+    host: getPgConnectionEnvValue('HOST', pgServer),
+    port: getPgConnectionEnvValue('PORT', pgServer),
+    ssl: getPgConnectionEnvValue('SSL', pgServer),
+    schema: getPgConnectionEnvValue('SCHEMA', pgServer),
+    applicationName: getPgConnectionEnvValue('APPLICATION_NAME', pgServer),
+    idleTimeout: parseInt(getPgConnectionEnvValue('IDLE_TIMEOUT', pgServer) ?? '30'),
+    maxLifetime: parseInt(getPgConnectionEnvValue('MAX_LIFETIME', pgServer) ?? '60'),
     poolMax: parseInt(process.env['PG_CONNECTION_POOL_MAX'] ?? '10'),
   };
   const defaultAppName = 'stacks-blockchain-api';
-  const pgConnectionUri = pgEnvValue('CONNECTION_URI');
+  const pgConnectionUri = getPgConnectionEnvValue('CONNECTION_URI', pgServer);
   const pgConfigEnvVar = Object.entries(pgEnvVars).find(([, v]) => typeof v === 'string')?.[0];
   if (pgConfigEnvVar && pgConnectionUri) {
     throw new Error(