@cumulus/db 18.2.2 → 18.3.0

package/dist/config.d.ts

@@ -1,16 +1,24 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import AWS from 'aws-sdk';
+import { SecretsManager } from '@aws-sdk/client-secrets-manager';
 import { Knex } from 'knex';
 export declare const localStackConnectionEnv: {
+    PG_DATABASE: string;
     PG_HOST: string;
-    PG_USER: string;
     PG_PASSWORD: string;
-    PG_DATABASE: string;
     PG_PORT: string;
+    PG_USER: string;
+    DISABLE_PG_SSL: string;
 };
+/**
+ * Determines if Knex debugging is enabled based on environment variable.
+ *
+ * @param {NodeJS.ProcessEnv} env - The environment variables object, defaults to an empty object.
+ * @returns {boolean} Returns true if the KNEX_DEBUG environment variable is set to 'true',
+ * false otherwise.
+ */
 export declare const isKnexDebugEnabled: (env?: NodeJS.ProcessEnv) => boolean;
-export declare const getSecretConnectionConfig: (SecretId: string, secretsManager: AWS.SecretsManager) => Promise<Knex.PgConnectionConfig>;
+export declare const getSecretConnectionConfig: (SecretId: string, secretsManager: SecretsManager) => Promise<Knex.PgConnectionConfig>;
 export declare const getConnectionConfigEnv: (env: NodeJS.ProcessEnv) => Knex.PgConnectionConfig;
 /**
  * Return configuration to make a database connection.
@@ -18,14 +26,14 @@ export declare const getConnectionConfigEnv: (env: NodeJS.ProcessEnv) => Knex.Pg
  * @param {Object} params
  * @param {NodeJS.ProcessEnv} params.env
  *   Environment values for the operation
- * @param {AWS.SecretsManager} params.secretsManager
+ * @param {SecretsManager} params.secretsManager
  *   An instance of an AWS Secrets Manager client
  * @returns {Knex.PgConnectionConfig}
  *   Configuration to make a Postgres database connection.
  */
 export declare const getConnectionConfig: ({ env, secretsManager, }: {
     env: NodeJS.ProcessEnv;
-    secretsManager?: AWS.SecretsManager | undefined;
+    secretsManager?: SecretsManager | undefined;
 }) => Promise<Knex.PgConnectionConfig>;
 /**
  * Given a NodeJS.ProcessEnv with configuration values, build and return Knex
@@ -69,6 +77,6 @@ export declare const getConnectionConfig: ({ env, secretsManager, }: {
  */
 export declare const getKnexConfig: ({ env, secretsManager, }?: {
     env?: NodeJS.ProcessEnv | undefined;
-    secretsManager?: AWS.SecretsManager | undefined;
+    secretsManager?: SecretsManager | undefined;
 }) => Promise<Knex.Config>;
 //# sourceMappingURL=config.d.ts.map

package/dist/config.js

@@ -1,22 +1,27 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getKnexConfig = exports.getConnectionConfig = exports.getConnectionConfigEnv = exports.getSecretConnectionConfig = exports.isKnexDebugEnabled = exports.localStackConnectionEnv = void 0;
-const aws_sdk_1 = __importDefault(require("aws-sdk"));
+const aws_client_1 = require("@cumulus/aws-client");
 const common_1 = require("@cumulus/common");
 exports.localStackConnectionEnv = {
+    PG_DATABASE: 'postgres',
     PG_HOST: 'localhost',
-    PG_USER: 'postgres',
     PG_PASSWORD: 'password',
-    PG_DATABASE: 'postgres',
     PG_PORT: '5432',
+    PG_USER: 'postgres',
+    DISABLE_PG_SSL: 'true',
 };
+/**
+ * Determines if Knex debugging is enabled based on environment variable.
+ *
+ * @param {NodeJS.ProcessEnv} env - The environment variables object, defaults to an empty object.
+ * @returns {boolean} Returns true if the KNEX_DEBUG environment variable is set to 'true',
+ * false otherwise.
+ */
 const isKnexDebugEnabled = (env = {}) => env.KNEX_DEBUG === 'true';
 exports.isKnexDebugEnabled = isKnexDebugEnabled;
 const getSecretConnectionConfig = async (SecretId, secretsManager) => {
-    const response = await secretsManager.getSecretValue({ SecretId }).promise();
+    const response = await secretsManager.getSecretValue({ SecretId });
     if (response.SecretString === undefined) {
         throw new Error(`AWS Secret did not contain a stored value: ${SecretId}`);
     }
@@ -26,22 +31,30 @@ const getSecretConnectionConfig = async (SecretId, secretsManager) => {
             throw new Error(`AWS Secret ${SecretId} is missing required key '${key}'`);
         }
     });
+    const rejectUnauthorized = dbAccessMeta.rejectUnauthorized !== 'false' && dbAccessMeta.rejectUnauthorized !== false;
+    const disableSsl = dbAccessMeta.disableSSL === 'true' || dbAccessMeta.disableSSL === true;
     return {
+        database: dbAccessMeta.database,
         host: dbAccessMeta.host,
-        user: dbAccessMeta.username,
         password: dbAccessMeta.password,
-        database: dbAccessMeta.database,
         port: dbAccessMeta.port ?? 5432,
+        ssl: disableSsl ? undefined : { rejectUnauthorized },
+        user: dbAccessMeta.username,
     };
 };
 exports.getSecretConnectionConfig = getSecretConnectionConfig;
-const getConnectionConfigEnv = (env) => ({
-    host: common_1.envUtils.getRequiredEnvVar('PG_HOST', env),
-    user: common_1.envUtils.getRequiredEnvVar('PG_USER', env),
-    password: common_1.envUtils.getRequiredEnvVar('PG_PASSWORD', env),
-    database: common_1.envUtils.getRequiredEnvVar('PG_DATABASE', env),
-    port: Number.parseInt(env.PG_PORT ?? '5432', 10),
-});
+const getConnectionConfigEnv = (env) => {
+    const rejectUnauthorized = env.REJECT_UNAUTHORIZED !== 'false';
+    const connectionConfigEnv = {
+        host: common_1.envUtils.getRequiredEnvVar('PG_HOST', env),
+        user: common_1.envUtils.getRequiredEnvVar('PG_USER', env),
+        password: common_1.envUtils.getRequiredEnvVar('PG_PASSWORD', env),
+        database: common_1.envUtils.getRequiredEnvVar('PG_DATABASE', env),
+        port: Number.parseInt(env.PG_PORT ?? '5432', 10),
+        ssl: env.DISABLE_PG_SSL === 'true' ? undefined : { rejectUnauthorized },
+    };
+    return connectionConfigEnv;
+};
 exports.getConnectionConfigEnv = getConnectionConfigEnv;
 /**
  * Return configuration to make a database connection.
@@ -49,12 +62,12 @@ exports.getConnectionConfigEnv = getConnectionConfigEnv;
  * @param {Object} params
  * @param {NodeJS.ProcessEnv} params.env
  *   Environment values for the operation
- * @param {AWS.SecretsManager} params.secretsManager
+ * @param {SecretsManager} params.secretsManager
  *   An instance of an AWS Secrets Manager client
  * @returns {Knex.PgConnectionConfig}
  *   Configuration to make a Postgres database connection.
  */
-const getConnectionConfig = async ({ env, secretsManager = new aws_sdk_1.default.SecretsManager(), }) => {
+const getConnectionConfig = async ({ env, secretsManager = aws_client_1.services.secretsManager(), }) => {
     // Storing credentials in Secrets Manager
     if (env.databaseCredentialSecretArn) {
         return await (0, exports.getSecretConnectionConfig)(env.databaseCredentialSecretArn, secretsManager);
@@ -103,7 +116,7 @@ exports.getConnectionConfig = getConnectionConfig;
  *                                                     connections
  * @returns {Promise<Knex.Config>} a Knex configuration object
  */
-const getKnexConfig = async ({ env = process.env, secretsManager = new aws_sdk_1.default.SecretsManager(), } = {}) => {
+const getKnexConfig = async ({ env = process.env, secretsManager = aws_client_1.services.secretsManager(), } = {}) => {
     const knexConfig = {
         client: 'pg',
         connection: await (0, exports.getConnectionConfig)({ env, secretsManager }),

package/dist/connection.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import AWS from 'aws-sdk';
+import { SecretsManager } from '@aws-sdk/client-secrets-manager';
 import { Knex } from 'knex';
 import Logger from '@cumulus/logger';
 /**
@@ -35,11 +35,13 @@ import Logger from '@cumulus/logger';
  *   acquireConnectionTimeout connection timeout
  * @param {string} [params.env.migrationDir] - Directory to look in for
  *   migrations
+ * @param {SecretsManager} [params.secretsManager] - An instance of an AWS secrets manager client
+ * @param {Logger} [params.knexLogger] - a logger instance
  * @returns {Promise<Knex>} a Knex configuration object that has returned at least one query
  */
 export declare const getKnexClient: ({ env, secretsManager, knexLogger, }?: {
     env?: NodeJS.ProcessEnv | undefined;
-    secretsManager?: AWS.SecretsManager | undefined;
+    secretsManager?: SecretsManager | undefined;
     knexLogger?: Logger | undefined;
 }) => Promise<Knex>;
 //# sourceMappingURL=connection.d.ts.map

package/dist/connection.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getKnexClient = void 0;
-const aws_sdk_1 = __importDefault(require("aws-sdk"));
+const aws_client_1 = require("@cumulus/aws-client");
 const knex_1 = require("knex");
 const logger_1 = __importDefault(require("@cumulus/logger"));
 const config_1 = require("./config");
@@ -41,9 +41,11 @@ const log = new logger_1.default({ sender: '@cumulus/db/connection' });
  *   acquireConnectionTimeout connection timeout
  * @param {string} [params.env.migrationDir] - Directory to look in for
  *   migrations
+ * @param {SecretsManager} [params.secretsManager] - An instance of an AWS secrets manager client
+ * @param {Logger} [params.knexLogger] - a logger instance
  * @returns {Promise<Knex>} a Knex configuration object that has returned at least one query
  */
-const getKnexClient = async ({ env = process.env, secretsManager = new aws_sdk_1.default.SecretsManager(), knexLogger = log, } = {}) => {
+const getKnexClient = async ({ env = process.env, secretsManager = aws_client_1.services.secretsManager(), knexLogger = log, } = {}) => {
     if ((0, config_1.isKnexDebugEnabled)(env)) {
         knexLogger.info('Initializing connection pool...');
     }

package/dist/migrations/20240322161147_alter_async_operations_table_operation_type.d.ts

@@ -0,0 +1,4 @@
+import { Knex } from 'knex';
+export declare const up: (knex: Knex) => Promise<void>;
+export declare const down: (knex: Knex) => Promise<void>;
+//# sourceMappingURL=20240322161147_alter_async_operations_table_operation_type.d.ts.map

package/dist/migrations/20240322161147_alter_async_operations_table_operation_type.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.down = exports.up = void 0;
+const formatAlterTableEnumSql = (tableName, columnName, enums) => {
+    const constraintName = `${tableName}_${columnName}_check`;
+    return [
+        `ALTER TABLE ${tableName}`,
+        `DROP CONSTRAINT IF EXISTS ${constraintName};`,
+        `ALTER TABLE ${tableName} ADD CONSTRAINT ${constraintName} CHECK (${columnName} = ANY (ARRAY['${enums.join("'::text, '")}'::text]));`,
+    ].join('\n');
+};
+const up = async (knex) => {
+    await knex.raw(formatAlterTableEnumSql('async_operations', 'operation_type', [
+        'ES Index',
+        'Bulk Granules',
+        'Bulk Granule Reingest',
+        'Bulk Granule Delete',
+        'Dead-Letter Processing',
+        'DLA Migration',
+        'Kinesis Replay',
+        'Reconciliation Report',
+        'Data Migration',
+        'SQS Replay',
+    ]));
+};
+exports.up = up;
+const down = async (knex) => {
+    await knex.raw(formatAlterTableEnumSql('async_operations', 'operation_type', [
+        'ES Index',
+        'Bulk Granules',
+        'Bulk Granule Reingest',
+        'Bulk Granule Delete',
+        'Dead-Letter Processing',
+        'Kinesis Replay',
+        'Reconciliation Report',
+        'Data Migration',
+        'SQS Replay',
+    ]));
+};
+exports.down = down;
+//# sourceMappingURL=20240322161147_alter_async_operations_table_operation_type.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/db",
-  "version": "18.2.2",
+  "version": "18.3.0",
   "description": "Utilities for working with the Cumulus DB",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -15,6 +15,7 @@
     "tsc": "../../node_modules/.bin/tsc",
     "tsc:listEmittedFiles": "../../node_modules/.bin/tsc --listEmittedFiles",
     "test": "../../node_modules/.bin/ava",
+    "test:ci": "../../scripts/run_package_ci_unit.sh",
     "test:coverage": "../../node_modules/.bin/nyc npm test",
     "watch": "../../node_modules/.bin/tsc -w",
     "coverage": "python ../../scripts/coverage_handler/coverage.py"
@@ -24,18 +25,20 @@
       "tests/**"
     ],
     "verbose": true,
-    "timeout": "5m"
+    "timeout": "5m",
+    "failFast": true
   },
   "engines": {
-    "node": ">=16.19.0"
+    "node": ">=20.12.2"
   },
   "dependencies": {
-    "@cumulus/aws-client": "18.2.2",
-    "@cumulus/common": "18.2.2",
-    "@cumulus/errors": "18.2.2",
-    "@cumulus/logger": "18.2.2",
-    "@cumulus/message": "18.2.2",
-    "@cumulus/types": "18.2.2",
+    "@aws-sdk/client-secrets-manager": "^3.447.0",
+    "@cumulus/aws-client": "18.3.0",
+    "@cumulus/common": "18.3.0",
+    "@cumulus/errors": "18.3.0",
+    "@cumulus/logger": "18.3.0",
+    "@cumulus/message": "18.3.0",
+    "@cumulus/types": "18.3.0",
     "crypto-random-string": "^3.2.0",
     "is-valid-hostname": "1.0.2",
     "knex": "2.4.1",
@@ -47,5 +50,5 @@
   "devDependencies": {
     "@types/uuid": "^8.0.0"
   },
-  "gitHead": "d2f030f1d77b6d3072cb20f84261b10a7b160620"
+  "gitHead": "e8731c150ac49c1bab058183a7a5d91464e1701c"
 }