@cumulus/db 14.0.0 → 15.0.0

package/dist/config.js

@@ -16,7 +16,6 @@ exports.localStackConnectionEnv = {
 const isKnexDebugEnabled = (env = {}) => env.KNEX_DEBUG === 'true';
 exports.isKnexDebugEnabled = isKnexDebugEnabled;
 const getSecretConnectionConfig = async (SecretId, secretsManager) => {
-    var _a;
     const response = await secretsManager.getSecretValue({ SecretId }).promise();
     if (response.SecretString === undefined) {
         throw new Error(`AWS Secret did not contain a stored value: ${SecretId}`);
@@ -32,20 +31,17 @@ const getSecretConnectionConfig = async (SecretId, secretsManager) => {
         user: dbAccessMeta.username,
         password: dbAccessMeta.password,
         database: dbAccessMeta.database,
-        port: (_a = dbAccessMeta.port) !== null && _a !== void 0 ? _a : 5432,
+        port: dbAccessMeta.port ?? 5432,
     };
 };
 exports.getSecretConnectionConfig = getSecretConnectionConfig;
-const getConnectionConfigEnv = (env) => {
-    var _a;
-    return ({
-        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((_a = env.PG_PORT) !== null && _a !== void 0 ? _a : '5432', 10),
-    });
-};
+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),
+});
 exports.getConnectionConfigEnv = getConnectionConfigEnv;
 /**
  * Return configuration to make a database connection.
@@ -108,7 +104,6 @@ exports.getConnectionConfig = getConnectionConfig;
  * @returns {Promise<Knex.Config>} a Knex configuration object
  */
 const getKnexConfig = async ({ env = process.env, secretsManager = new aws_sdk_1.default.SecretsManager(), } = {}) => {
-    var _a, _b, _c, _d, _e, _f, _g;
     const knexConfig = {
         client: 'pg',
         connection: await (0, exports.getConnectionConfig)({ env, secretsManager }),
@@ -116,16 +111,16 @@ const getKnexConfig = async ({ env = process.env, secretsManager = new aws_sdk_1
         asyncStackTraces: env.KNEX_ASYNC_STACK_TRACES === 'true',
         pool: {
             min: 0,
-            max: Number.parseInt((_a = env.dbMaxPool) !== null && _a !== void 0 ? _a : '2', 10),
-            idleTimeoutMillis: Number.parseInt((_b = env.idleTimeoutMillis) !== null && _b !== void 0 ? _b : '1000', 10),
+            max: Number.parseInt(env.dbMaxPool ?? '2', 10),
+            idleTimeoutMillis: Number.parseInt(env.idleTimeoutMillis ?? '1000', 10),
             // ts-ignore as https://github.com/knex/knex/blob/master/types/index.d.ts#L1886
             // is improperly typed.
             //@ts-ignore
-            acquireTimeoutMillis: Number.parseInt((_c = env.acquireTimeoutMillis) !== null && _c !== void 0 ? _c : '90000', 10),
-            createRetryIntervalMillis: Number.parseInt((_d = env.createRetryIntervalMillis) !== null && _d !== void 0 ? _d : '30000', 10),
-            createTimeoutMillis: Number.parseInt((_e = env.createTimeoutMillis) !== null && _e !== void 0 ? _e : '20000', 10),
-            destroyTimeoutMillis: Number.parseInt((_f = env.destroyTimeoutMillis) !== null && _f !== void 0 ? _f : '5000', 10),
-            reapIntervalMillis: Number.parseInt((_g = env.reapIntervalMillis) !== null && _g !== void 0 ? _g : '1000', 10),
+            acquireTimeoutMillis: Number.parseInt(env.acquireTimeoutMillis ?? '90000', 10),
+            createRetryIntervalMillis: Number.parseInt(env.createRetryIntervalMillis ?? '30000', 10),
+            createTimeoutMillis: Number.parseInt(env.createTimeoutMillis ?? '20000', 10),
+            destroyTimeoutMillis: Number.parseInt(env.destroyTimeoutMillis ?? '5000', 10),
+            reapIntervalMillis: Number.parseInt(env.reapIntervalMillis ?? '1000', 10),
             propagateCreateError: false,
         },
     };

package/dist/lib/execution.js

@@ -87,7 +87,7 @@ exports.executionArnsFromGranuleIdsAndWorkflowNames = executionArnsFromGranuleId
  */
 const newestExecutionArnFromGranuleIdWorkflowName = async (granuleId, workflowName, testKnex) => {
     try {
-        const knex = testKnex !== null && testKnex !== void 0 ? testKnex : await getKnexClient({ env: process.env });
+        const knex = testKnex ?? await getKnexClient({ env: process.env });
         const executions = await (0, exports.executionArnsFromGranuleIdsAndWorkflowNames)(knex, [granuleId], [workflowName]);
         if (executions.length === 0) {
             throw new errors_1.RecordDoesNotExist(`No executionArns found for granuleId:${granuleId} running workflow:${workflowName}`);

package/dist/lib/granule.d.ts

@@ -4,7 +4,9 @@ import { GranulePgModel } from '../models/granule';
 import { GranulesExecutionsPgModel } from '../models/granules-executions';
 import { PostgresGranule, PostgresGranuleRecord } from '../types/granule';
 import { UpdatedAtRange } from '../types/record';
-export declare const getGranuleCollectionId: (knexOrTransaction: Knex | Knex.Transaction, granule: PostgresGranule) => Promise<string>;
+export declare const getGranuleCollectionId: (knexOrTransaction: Knex, granule: {
+    collection_cumulus_id: number;
+}) => Promise<string>;
 /**
  * Upsert a granule and a record in the granules/executions join table.
  *
@@ -89,7 +91,7 @@ export declare const getGranulesByApiPropertiesQuery: (knex: Knex, { collectionI
  *
  * @param {Knex | Knex.Transaction} knexOrTransaction - DB client or transaction
  * @param {string} granuleId - Granule ID
- * @returns {Promise<Array<PostgresGranuleRecord>} The returned list of records
+ * @returns {Promise<PostgresGranuleRecord[]>} The returned list of records
  */
-export declare const getGranulesByGranuleId: (knexOrTransaction: Knex | Knex.Transaction, granuleId: string) => Promise<Array<PostgresGranuleRecord>>;
+export declare const getGranulesByGranuleId: (knexOrTransaction: Knex | Knex.Transaction, granuleId: string) => Promise<PostgresGranuleRecord[]>;
 //# sourceMappingURL=granule.d.ts.map

package/dist/lib/granule.js

@@ -187,7 +187,7 @@ exports.getGranulesByApiPropertiesQuery = getGranulesByApiPropertiesQuery;
  *
  * @param {Knex | Knex.Transaction} knexOrTransaction - DB client or transaction
  * @param {string} granuleId - Granule ID
- * @returns {Promise<Array<PostgresGranuleRecord>} The returned list of records
+ * @returns {Promise<PostgresGranuleRecord[]>} The returned list of records
  */
 const getGranulesByGranuleId = async (knexOrTransaction, granuleId) => {
     const { granules: granulesTable, } = TableNames;

package/dist/models/base.d.ts

@@ -88,8 +88,8 @@ declare class BasePgModel<ItemType, RecordType extends BaseRecord> {
      * @param {ItemType} item - A record to insert into the DB
      * @param {string | Array<string>} returningFields - A string or array of strings
      *   of columns to return. Defaults to 'cumulus_id'.
-     * @returns {Promise<unknown[] | Object[]>} Returns an array of objects or an
-     *   array of values from the specified column(s) from returningFields.
+     * @returns {Promise<unknown[] | Object[]>} Returns an array of objects
+     *   from the specified column(s) from returningFields.
      */
     create(knexOrTransaction: Knex | Knex.Transaction, item: ItemType, returningFields?: string | string[]): Promise<unknown[] | Object[]>;
     /**
@@ -99,8 +99,8 @@ declare class BasePgModel<ItemType, RecordType extends BaseRecord> {
      * @param {ItemType[]} items - Records to insert into the DB
      * @param {string | Array<string>} returningFields - A string or array of strings
      *   of columns to return. Defaults to 'cumulus_id'.
-     * @returns {Promise<unknown[] | Object[]>} Returns an array of objects or an
-     *   array of values from the specified column(s) from returningFields.
+     * @returns {Promise<unknown[] | Object[]>} Returns an array of objects
+     *   from the specified column(s) from returningFields.
      */
     insert(knexOrTransaction: Knex | Knex.Transaction, items: ItemType[], returningFields?: string | string[]): Promise<unknown[] | Object[]>;
     /**

package/dist/models/base.js

@@ -17,12 +17,11 @@ class BasePgModel {
      */
     async searchWithUpdatedAtRange(knexOrTransaction, params, updatedAtParams) {
         const records = await knexOrTransaction(this.tableName).where((builder) => {
-            var _a, _b;
             builder.where(params);
             if (updatedAtParams.updatedAtFrom || updatedAtParams.updatedAtTo) {
                 builder.whereBetween('updated_at', [
-                    (_a = updatedAtParams === null || updatedAtParams === void 0 ? void 0 : updatedAtParams.updatedAtFrom) !== null && _a !== void 0 ? _a : new Date(0),
-                    (_b = updatedAtParams === null || updatedAtParams === void 0 ? void 0 : updatedAtParams.updatedAtTo) !== null && _b !== void 0 ? _b : new Date(),
+                    updatedAtParams?.updatedAtFrom ?? new Date(0),
+                    updatedAtParams?.updatedAtTo ?? new Date(),
                 ]);
             }
         });
@@ -155,8 +154,8 @@ class BasePgModel {
      * @param {ItemType} item - A record to insert into the DB
      * @param {string | Array<string>} returningFields - A string or array of strings
      *   of columns to return. Defaults to 'cumulus_id'.
-     * @returns {Promise<unknown[] | Object[]>} Returns an array of objects or an
-     *   array of values from the specified column(s) from returningFields.
+     * @returns {Promise<unknown[] | Object[]>} Returns an array of objects
+     *   from the specified column(s) from returningFields.
      */
     async create(knexOrTransaction, item, returningFields = 'cumulus_id') {
         return await knexOrTransaction(this.tableName)
@@ -170,8 +169,8 @@ class BasePgModel {
      * @param {ItemType[]} items - Records to insert into the DB
      * @param {string | Array<string>} returningFields - A string or array of strings
      *   of columns to return. Defaults to 'cumulus_id'.
-     * @returns {Promise<unknown[] | Object[]>} Returns an array of objects or an
-     *   array of values from the specified column(s) from returningFields.
+     * @returns {Promise<unknown[] | Object[]>} Returns an array of objects
+     *   from the specified column(s) from returningFields.
      */
     async insert(knexOrTransaction, items, returningFields = 'cumulus_id') {
         return await knexOrTransaction(this.tableName)

package/dist/models/collection.d.ts

@@ -3,7 +3,7 @@ import { BasePgModel } from './base';
 import { PostgresCollection, PostgresCollectionRecord } from '../types/collection';
 declare class CollectionPgModel extends BasePgModel<PostgresCollection, PostgresCollectionRecord> {
     constructor();
-    create(knexOrTransaction: Knex | Knex.Transaction, item: PostgresCollection): Promise<Object[] | unknown[]>;
+    create(knexOrTransaction: Knex | Knex.Transaction, item: PostgresCollection): Promise<unknown[] | Object[]>;
     upsert(knexOrTransaction: Knex | Knex.Transaction, collection: PostgresCollection): Knex.QueryBuilder<any, {
         _base: any;
         _hasSelection: false;

package/dist/models/execution.d.ts

@@ -4,7 +4,7 @@ import { PostgresExecution, PostgresExecutionRecord } from '../types/execution';
 declare class ExecutionPgModel extends BasePgModel<PostgresExecution, PostgresExecutionRecord> {
     constructor();
     static nonActiveStatuses: string[];
-    create(knexOrTransaction: Knex | Knex.Transaction, item: PostgresExecution): Promise<Object[] | unknown[]>;
+    create(knexOrTransaction: Knex | Knex.Transaction, item: PostgresExecution): Promise<unknown[] | Object[]>;
     upsert(knexOrTrx: Knex | Knex.Transaction, execution: PostgresExecution): Promise<any[]>;
     /**
      * Get executions from the execution cumulus_id

package/dist/models/granule.d.ts

@@ -7,7 +7,7 @@ interface RecordSelect {
 }
 export default class GranulePgModel extends BasePgModel<PostgresGranule, PostgresGranuleRecord> {
     constructor();
-    create(knexOrTransaction: Knex | Knex.Transaction, item: PostgresGranule): Promise<Object[] | unknown[]>;
+    create(knexOrTransaction: Knex | Knex.Transaction, item: PostgresGranule): Promise<unknown[] | Object[]>;
     /**
      * Deletes the item from Postgres
      *
@@ -52,7 +52,7 @@ export default class GranulePgModel extends BasePgModel<PostgresGranule, Postgre
         executionCumulusId?: number;
         executionPgModel?: ExecutionPgModel;
         writeConstraints: boolean;
-    }): Promise<any[]>;
+    }): Promise<PostgresGranuleRecord[]>;
     /**
      * Get granules from the granule cumulus_id
      *

package/dist/models/granule.js

@@ -107,8 +107,7 @@ class GranulePgModel extends base_1.BasePgModel {
                 // exist at all
                 upsertQuery.whereNotExists(exclusionClause);
             }
-            upsertQuery.returning('*');
-            return await upsertQuery;
+            return await upsertQuery.returning('*');
         }
         const upsertQuery = knexOrTrx(this.tableName)
             .insert(granule)
@@ -120,8 +119,7 @@ class GranulePgModel extends base_1.BasePgModel {
             }
             upsertQuery.where(knexOrTrx.raw(`${this.tableName}.created_at <= to_timestamp(${(0, timestamp_1.translateDateToUTC)(granule.created_at)})`));
         }
-        upsertQuery.returning('*');
-        return await upsertQuery;
+        return await upsertQuery.returning('*');
     }
     /**
      * Get granules from the granule cumulus_id

package/dist/models/granules-executions.js

@@ -19,7 +19,8 @@ class GranulesExecutionsPgModel {
         return await knexTransaction(this.tableName)
             .insert(item)
             .onConflict(['granule_cumulus_id', 'execution_cumulus_id'])
-            .merge();
+            .merge()
+            .returning('*');
     }
     /**
      * Get execution_cumulus_id column values from the granule_cumulus_id

package/dist/models/provider.d.ts

@@ -6,9 +6,9 @@ declare class ProviderPgModel extends BasePgModel<PostgresProvider, PostgresProv
     upsert(knexOrTransaction: Knex | Knex.Transaction, provider: PostgresProvider): Knex.QueryBuilder<any, {
         _base: any;
         _hasSelection: true;
-        _keys: "name" | "cumulus_id";
+        _keys: "cumulus_id";
         _aliases: {};
-        _single: true;
+        _single: false;
         _intersectProps: {};
         _unionProps: never;
     }[]>;

package/dist/models/rule.d.ts

@@ -6,9 +6,9 @@ declare class RulePgModel extends BasePgModel<PostgresRule, PostgresRuleRecord>
     upsert(knexOrTransaction: Knex | Knex.Transaction, rule: PostgresRule): Knex.QueryBuilder<any, {
         _base: any;
         _hasSelection: true;
-        _keys: "name" | "cumulus_id";
+        _keys: "cumulus_id";
         _aliases: {};
-        _single: true;
+        _single: false;
         _intersectProps: {};
         _unionProps: never;
     }[]>;

package/dist/test-utils.d.ts

@@ -10,8 +10,8 @@ import { PostgresRule } from './types/rule';
 export declare const createTestDatabase: (knex: Knex, dbName: string, dbUser: string) => Promise<void>;
 export declare const deleteTestDatabase: (knex: Knex, dbName: string) => Promise<any>;
 export declare const generateLocalTestDb: (testDbName: string, migrationDir: string, envParams: object) => Promise<{
-    knex: Knex<any, unknown[]>;
-    knexAdmin: Knex<any, unknown[]>;
+    knex: Knex<any, any[]>;
+    knexAdmin: Knex<any, any[]>;
 }>;
 export declare const destroyLocalTestDb: ({ knex, knexAdmin, testDbName, }: {
     knex: Knex;

package/dist/translate/executions.js

@@ -12,7 +12,6 @@ const execution_1 = require("../models/execution");
 const collection_1 = require("../models/collection");
 const async_operation_1 = require("../models/async_operation");
 const translatePostgresExecutionToApiExecution = async (executionRecord, knex, collectionPgModel = new collection_1.CollectionPgModel(), asyncOperationPgModel = new async_operation_1.AsyncOperationPgModel(), executionPgModel = new execution_1.ExecutionPgModel()) => {
-    var _a;
     let parentArn;
     let collectionId;
     let asyncOperationId;
@@ -55,7 +54,7 @@ const translatePostgresExecutionToApiExecution = async (executionRecord, knex, c
         parentArn,
         createdAt: executionRecord.created_at.getTime(),
         updatedAt: executionRecord.updated_at.getTime(),
-        timestamp: (_a = executionRecord.timestamp) === null || _a === void 0 ? void 0 : _a.getTime(),
+        timestamp: executionRecord.timestamp?.getTime(),
     };
     return (0, util_1.removeNilProperties)(translatedRecord);
 };

package/dist/translate/granules.d.ts

@@ -25,7 +25,7 @@ import { PostgresProviderRecord } from '../types/provider';
 export declare const translatePostgresGranuleToApiGranule: ({ granulePgRecord, collectionPgRecord, knexOrTransaction, providerPgRecord, collectionPgModel, pdrPgModel, providerPgModel, filePgModel, }: {
     granulePgRecord: PostgresGranuleRecord;
     knexOrTransaction: Knex | Knex.Transaction;
-    collectionPgRecord?: Pick<PostgresCollectionRecord, "name" | "version" | "cumulus_id"> | undefined;
+    collectionPgRecord?: Pick<PostgresCollectionRecord, "version" | "name" | "cumulus_id"> | undefined;
     providerPgRecord?: Pick<PostgresProviderRecord, "name"> | undefined;
     collectionPgModel?: CollectionPgModel | undefined;
     pdrPgModel?: PdrPgModel | undefined;

package/dist/translate/granules.js

@@ -30,7 +30,6 @@ const file_2 = require("./file");
  * @returns {Object} An API Granule with associated Files
  */
 const translatePostgresGranuleToApiGranule = async ({ granulePgRecord, collectionPgRecord, knexOrTransaction, providerPgRecord, collectionPgModel = new collection_1.CollectionPgModel(), pdrPgModel = new pdr_1.PdrPgModel(), providerPgModel = new provider_1.ProviderPgModel(), filePgModel = new file_1.FilePgModel(), }) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
     const collection = collectionPgRecord || await collectionPgModel.get(knexOrTransaction, { cumulus_id: granulePgRecord.collection_cumulus_id });
     if (granulePgRecord.collection_cumulus_id !== collection.cumulus_id) {
         throw new errors_1.ValidationError(`Input collection.cumulus_id: ${collection.cumulus_id} does not match the granule PG record collection_cumulus_id: ${granulePgRecord.collection_cumulus_id}`);
@@ -54,30 +53,30 @@ const translatePostgresGranuleToApiGranule = async ({ granulePgRecord, collectio
         provider = await providerPgModel.get(knexOrTransaction, { cumulus_id: granulePgRecord.provider_cumulus_id });
     }
     const apiGranule = (0, util_1.removeNilProperties)({
-        beginningDateTime: (_a = granulePgRecord.beginning_date_time) === null || _a === void 0 ? void 0 : _a.toISOString(),
+        beginningDateTime: granulePgRecord.beginning_date_time?.toISOString(),
         cmrLink: granulePgRecord.cmr_link,
         collectionId: (0, Collections_1.constructCollectionId)(collection.name, collection.version),
-        createdAt: (_b = granulePgRecord.created_at) === null || _b === void 0 ? void 0 : _b.getTime(),
+        createdAt: granulePgRecord.created_at?.getTime(),
         duration: granulePgRecord.duration,
-        endingDateTime: (_c = granulePgRecord.ending_date_time) === null || _c === void 0 ? void 0 : _c.toISOString(),
+        endingDateTime: granulePgRecord.ending_date_time?.toISOString(),
         error: granulePgRecord.error,
         execution: executionUrls[0] ? executionUrls[0].url : undefined,
         files: files.length > 0 ? files.map((file) => (0, file_2.translatePostgresFileToApiFile)(file)) : [],
         granuleId: granulePgRecord.granule_id,
-        lastUpdateDateTime: (_d = granulePgRecord.last_update_date_time) === null || _d === void 0 ? void 0 : _d.toISOString(),
+        lastUpdateDateTime: granulePgRecord.last_update_date_time?.toISOString(),
         pdrName: pdr ? pdr.name : undefined,
-        processingEndDateTime: (_e = granulePgRecord.processing_end_date_time) === null || _e === void 0 ? void 0 : _e.toISOString(),
-        processingStartDateTime: (_f = granulePgRecord.processing_start_date_time) === null || _f === void 0 ? void 0 : _f.toISOString(),
-        productionDateTime: (_g = granulePgRecord.production_date_time) === null || _g === void 0 ? void 0 : _g.toISOString(),
+        processingEndDateTime: granulePgRecord.processing_end_date_time?.toISOString(),
+        processingStartDateTime: granulePgRecord.processing_start_date_time?.toISOString(),
+        productionDateTime: granulePgRecord.production_date_time?.toISOString(),
         productVolume: granulePgRecord.product_volume,
         provider: provider ? provider.name : undefined,
         published: granulePgRecord.published,
         queryFields: granulePgRecord.query_fields,
         status: granulePgRecord.status,
-        timestamp: (_h = granulePgRecord.timestamp) === null || _h === void 0 ? void 0 : _h.getTime(),
+        timestamp: granulePgRecord.timestamp?.getTime(),
         timeToArchive: granulePgRecord.time_to_archive,
         timeToPreprocess: granulePgRecord.time_to_process,
-        updatedAt: (_j = granulePgRecord.updated_at) === null || _j === void 0 ? void 0 : _j.getTime(),
+        updatedAt: granulePgRecord.updated_at?.getTime(),
     });
     return apiGranule;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/db",
-  "version": "14.0.0",
+  "version": "15.0.0",
   "description": "Utilities for working with the Cumulus DB",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -26,18 +26,18 @@
     "timeout": "5m"
   },
   "engines": {
-    "node": ">=14.19.1"
+    "node": ">=16.19.0"
   },
   "dependencies": {
-    "@cumulus/aws-client": "14.0.0",
-    "@cumulus/common": "14.0.0",
-    "@cumulus/errors": "14.0.0",
-    "@cumulus/logger": "14.0.0",
-    "@cumulus/message": "14.0.0",
-    "@cumulus/types": "14.0.0",
+    "@cumulus/aws-client": "15.0.0",
+    "@cumulus/common": "15.0.0",
+    "@cumulus/errors": "15.0.0",
+    "@cumulus/logger": "15.0.0",
+    "@cumulus/message": "15.0.0",
+    "@cumulus/types": "15.0.0",
     "crypto-random-string": "^3.2.0",
     "is-valid-hostname": "1.0.2",
-    "knex": "0.95.15",
+    "knex": "2.4.1",
     "lodash": "^4.17.21",
     "pg": "^8.3.0",
     "snake-camel": "^1.0.6",
@@ -46,5 +46,5 @@
   "devDependencies": {
     "@types/uuid": "^8.0.0"
   },
-  "gitHead": "bc0cd0857e007b64e4e8809f7de16a4aeb1e6840"
+  "gitHead": "15986abef3ef23dc9ccefd31f219f78203dcd8db"
 }