@cumulus/db 10.1.1-alpha.0 → 11.0.0

package/LICENSE

@@ -0,0 +1,60 @@
+Copyright © 2020 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICE NSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+---
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+    You must give any other recipients of the Work or Derivative Works a copy of this License; and
+    You must cause any modified files to carry prominent notices stating that You changed the files; and
+    You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+    If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/dist/config.d.ts

@@ -8,6 +8,7 @@ export declare const localStackConnectionEnv: {
     PG_DATABASE: string;
     PG_PORT: string;
 };
+export declare const isKnexDebugEnabled: (env?: NodeJS.ProcessEnv) => boolean;
 export declare const getSecretConnectionConfig: (SecretId: string, secretsManager: AWS.SecretsManager) => Promise<Knex.PgConnectionConfig>;
 export declare const getConnectionConfigEnv: (env: NodeJS.ProcessEnv) => Knex.PgConnectionConfig;
 /**

package/dist/config.js

@@ -3,7 +3,7 @@ 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.localStackConnectionEnv = void 0;
+exports.getKnexConfig = exports.getConnectionConfig = exports.getConnectionConfigEnv = exports.getSecretConnectionConfig = exports.isKnexDebugEnabled = exports.localStackConnectionEnv = void 0;
 const aws_sdk_1 = __importDefault(require("aws-sdk"));
 const common_1 = require("@cumulus/common");
 exports.localStackConnectionEnv = {
@@ -13,6 +13,8 @@ exports.localStackConnectionEnv = {
     PG_DATABASE: 'postgres',
     PG_PORT: '5432',
 };
+const isKnexDebugEnabled = (env = {}) => env.KNEX_DEBUG === 'true';
+exports.isKnexDebugEnabled = isKnexDebugEnabled;
 const getSecretConnectionConfig = async (SecretId, secretsManager) => {
     var _a;
     const response = await secretsManager.getSecretValue({ SecretId }).promise();
@@ -110,7 +112,7 @@ const getKnexConfig = async ({ env = process.env, secretsManager = new aws_sdk_1
     const knexConfig = {
         client: 'pg',
         connection: await (0, exports.getConnectionConfig)({ env, secretsManager }),
-        debug: env.KNEX_DEBUG === 'true',
+        debug: (0, exports.isKnexDebugEnabled)(env),
         asyncStackTraces: env.KNEX_ASYNC_STACK_TRACES === 'true',
         pool: {
             min: 0,

package/dist/connection.js

@@ -44,16 +44,37 @@ const log = new logger_1.default({ sender: '@cumulus/db/connection' });
  * @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, } = {}) => {
+    if ((0, config_1.isKnexDebugEnabled)(env)) {
+        knexLogger.info('Initializing connection pool...');
+    }
     const knexConfig = await (0, config_1.getKnexConfig)({ env, secretsManager });
     const knexClient = (0, knex_1.knex)(knexConfig);
-    //@ts-ignore
-    // context is an internal object that isn't typed
-    // this is needed to force tarn to log per-retry failures
-    // and allow propagateCreateError to be set `false`
-    knexClient.context.client.pool.on('createFail', (_, error) => {
-        knexLogger.warn('knex failed on attempted connection', error);
-        throw error;
-    });
+    if ((0, config_1.isKnexDebugEnabled)(env)) {
+        //@ts-ignore
+        // context is an internal object that isn't typed
+        // this is needed to force tarn to log per-retry failures
+        // and allow propagateCreateError to be set `false`
+        knexClient.context.client.pool.on('createFail', (_, error) => {
+            knexLogger.warn('knex failed on attempted connection', error);
+            throw error;
+        });
+        //@ts-ignore
+        knexClient.context.client.pool.on('createSuccess', (_, resource) => {
+            knexLogger.info(`added connection to pool: ${JSON.stringify(resource)}`);
+        });
+        //@ts-ignore
+        knexClient.context.client.pool.on('acquireSuccess', (_, resource) => {
+            knexLogger.info(`acquired connection from pool: ${JSON.stringify(resource)}`);
+        });
+        //@ts-ignore
+        knexClient.context.client.pool.on('release', (resource) => {
+            knexLogger.info(`released connection from pool: ${JSON.stringify(resource)}`);
+        });
+        //@ts-ignore
+        knexClient.context.client.pool.on('poolDestroySuccess', () => {
+            knexLogger.info('pool is destroyed');
+        });
+    }
     return knexClient;
 };
 exports.getKnexClient = getKnexClient;

package/dist/index.d.ts

@@ -20,7 +20,7 @@ export { translateApiAsyncOperationToPostgresAsyncOperation, translatePostgresAs
 export { translateApiFiletoPostgresFile, translatePostgresFileToApiFile, } from './translate/file';
 export { translateApiCollectionToPostgresCollection, translatePostgresCollectionToApiCollection, } from './translate/collections';
 export { translateApiProviderToPostgresProvider, translatePostgresProviderToApiProvider, } from './translate/providers';
-export { translateApiRuleToPostgresRule, translatePostgresRuleToApiRule, } from './translate/rules';
+export { translatePostgresRuleToApiRule, translateApiRuleToPostgresRule, translateApiRuleToPostgresRuleRaw, } from './translate/rules';
 export { translateApiExecutionToPostgresExecution, translatePostgresExecutionToApiExecution, } from './translate/executions';
 export { translateApiGranuleToPostgresGranule, translatePostgresGranuleToApiGranule, translatePostgresGranuleResultToApiGranule, } from './translate/granules';
 export { translateApiPdrToPostgresPdr, translatePostgresPdrToApiPdr, } from './translate/pdr';

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -19,8 +23,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getGranuleCollectionId = exports.getApiGranuleExecutionCumulusIds = exports.getApiGranuleCumulusIds = exports.getFilesAndGranuleInfoQuery = exports.getExecutionInfoByGranuleCumulusId = exports.getApiGranuleExecutionCumulusIdsByExecution = exports.getApiExecutionCumulusIds = exports.getWorkflowNameIntersectFromGranuleIds = exports.newestExecutionArnFromGranuleIdWorkflowName = exports.executionArnsFromGranuleIdsAndWorkflowNames = exports.getCollectionsByGranuleIds = exports.translatePostgresPdrToApiPdr = exports.translateApiPdrToPostgresPdr = exports.translatePostgresGranuleResultToApiGranule = exports.translatePostgresGranuleToApiGranule = exports.translateApiGranuleToPostgresGranule = exports.translatePostgresExecutionToApiExecution = exports.translateApiExecutionToPostgresExecution = exports.translatePostgresRuleToApiRule = exports.translateApiRuleToPostgresRule = exports.translatePostgresProviderToApiProvider = exports.translateApiProviderToPostgresProvider = exports.translatePostgresCollectionToApiCollection = exports.translateApiCollectionToPostgresCollection = exports.translatePostgresFileToApiFile = exports.translateApiFiletoPostgresFile = exports.translatePostgresAsyncOperationToApiAsyncOperation = exports.translateApiAsyncOperationToPostgresAsyncOperation = exports.nullifyUndefinedProviderValues = exports.validateProviderHost = exports.migrationDir = exports.TableNames = exports.createRejectableTransaction = exports.localStackConnectionEnv = exports.getKnexConfig = exports.getKnexClient = exports.isCollisionError = exports.generateLocalTestDb = exports.fakeRuleRecordFactory = exports.fakeProviderRecordFactory = exports.fakePdrRecordFactory = exports.fakeGranuleRecordFactory = exports.fakeFileRecordFactory = exports.fakeExecutionRecordFactory = exports.fakeCollectionRecordFactory = exports.fakeAsyncOperationRecordFactory = exports.destroyLocalTestDb = exports.deleteTestDatabase = exports.createTestDatabase = exports.Knex = void 0;
-exports.RulePgModel = exports.ProviderPgModel = exports.PdrPgModel = exports.GranulesExecutionsPgModel = exports.GranulePgModel = exports.FilePgModel = exports.ExecutionPgModel = exports.CollectionPgModel = exports.BasePgModel = exports.AsyncOperationPgModel = exports.QuerySearchClient = exports.getGranulesByApiPropertiesQuery = exports.upsertGranuleWithExecutionJoinRecord = exports.getUniqueGranuleByGranuleId = void 0;
+exports.getApiGranuleExecutionCumulusIds = exports.getApiGranuleCumulusIds = exports.getFilesAndGranuleInfoQuery = exports.getExecutionInfoByGranuleCumulusId = exports.getApiGranuleExecutionCumulusIdsByExecution = exports.getApiExecutionCumulusIds = exports.getWorkflowNameIntersectFromGranuleIds = exports.newestExecutionArnFromGranuleIdWorkflowName = exports.executionArnsFromGranuleIdsAndWorkflowNames = exports.getCollectionsByGranuleIds = exports.translatePostgresPdrToApiPdr = exports.translateApiPdrToPostgresPdr = exports.translatePostgresGranuleResultToApiGranule = exports.translatePostgresGranuleToApiGranule = exports.translateApiGranuleToPostgresGranule = exports.translatePostgresExecutionToApiExecution = exports.translateApiExecutionToPostgresExecution = exports.translateApiRuleToPostgresRuleRaw = exports.translateApiRuleToPostgresRule = exports.translatePostgresRuleToApiRule = exports.translatePostgresProviderToApiProvider = exports.translateApiProviderToPostgresProvider = exports.translatePostgresCollectionToApiCollection = exports.translateApiCollectionToPostgresCollection = exports.translatePostgresFileToApiFile = exports.translateApiFiletoPostgresFile = exports.translatePostgresAsyncOperationToApiAsyncOperation = exports.translateApiAsyncOperationToPostgresAsyncOperation = exports.nullifyUndefinedProviderValues = exports.validateProviderHost = exports.migrationDir = exports.TableNames = exports.createRejectableTransaction = exports.localStackConnectionEnv = exports.getKnexConfig = exports.getKnexClient = exports.isCollisionError = exports.generateLocalTestDb = exports.fakeRuleRecordFactory = exports.fakeProviderRecordFactory = exports.fakePdrRecordFactory = exports.fakeGranuleRecordFactory = exports.fakeFileRecordFactory = exports.fakeExecutionRecordFactory = exports.fakeCollectionRecordFactory = exports.fakeAsyncOperationRecordFactory = exports.destroyLocalTestDb = exports.deleteTestDatabase = exports.createTestDatabase = exports.Knex = void 0;
+exports.RulePgModel = exports.ProviderPgModel = exports.PdrPgModel = exports.GranulesExecutionsPgModel = exports.GranulePgModel = exports.FilePgModel = exports.ExecutionPgModel = exports.CollectionPgModel = exports.BasePgModel = exports.AsyncOperationPgModel = exports.QuerySearchClient = exports.getGranulesByApiPropertiesQuery = exports.upsertGranuleWithExecutionJoinRecord = exports.getUniqueGranuleByGranuleId = exports.getGranuleCollectionId = void 0;
 const path = __importStar(require("path"));
 var knex_1 = require("knex");
 Object.defineProperty(exports, "Knex", { enumerable: true, get: function () { return knex_1.Knex; } });
@@ -65,8 +69,9 @@ var providers_1 = require("./translate/providers");
 Object.defineProperty(exports, "translateApiProviderToPostgresProvider", { enumerable: true, get: function () { return providers_1.translateApiProviderToPostgresProvider; } });
 Object.defineProperty(exports, "translatePostgresProviderToApiProvider", { enumerable: true, get: function () { return providers_1.translatePostgresProviderToApiProvider; } });
 var rules_1 = require("./translate/rules");
-Object.defineProperty(exports, "translateApiRuleToPostgresRule", { enumerable: true, get: function () { return rules_1.translateApiRuleToPostgresRule; } });
 Object.defineProperty(exports, "translatePostgresRuleToApiRule", { enumerable: true, get: function () { return rules_1.translatePostgresRuleToApiRule; } });
+Object.defineProperty(exports, "translateApiRuleToPostgresRule", { enumerable: true, get: function () { return rules_1.translateApiRuleToPostgresRule; } });
+Object.defineProperty(exports, "translateApiRuleToPostgresRuleRaw", { enumerable: true, get: function () { return rules_1.translateApiRuleToPostgresRuleRaw; } });
 var executions_1 = require("./translate/executions");
 Object.defineProperty(exports, "translateApiExecutionToPostgresExecution", { enumerable: true, get: function () { return executions_1.translateApiExecutionToPostgresExecution; } });
 Object.defineProperty(exports, "translatePostgresExecutionToApiExecution", { enumerable: true, get: function () { return executions_1.translatePostgresExecutionToApiExecution; } });

package/dist/migrations/20220126172008_files_granule_id_index.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=20220126172008_files_granule_id_index.d.ts.map

package/dist/migrations/20220126172008_files_granule_id_index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.down = exports.up = void 0;
+const up = async (knex) => {
+    await knex.schema.table('files', (table) => {
+        table.index('granule_cumulus_id');
+    });
+};
+exports.up = up;
+const down = async (knex) => {
+    await knex.schema.table('files', (table) => {
+        table.dropIndex('granule_cumulus_id');
+    });
+};
+exports.down = down;
+//# sourceMappingURL=20220126172008_files_granule_id_index.js.map

package/dist/models/base.d.ts

@@ -4,7 +4,7 @@ import { BaseRecord } from '../types/base';
 import { TableNames } from '../tables';
 declare class BasePgModel<ItemType, RecordType extends BaseRecord> {
     readonly tableName: TableNames;
-    constructor({ tableName, }: {
+    constructor({ tableName }: {
         tableName: TableNames;
     });
     /**
@@ -29,11 +29,27 @@ declare class BasePgModel<ItemType, RecordType extends BaseRecord> {
     get(knexOrTransaction: Knex | Knex.Transaction, params: Partial<RecordType>): Promise<RecordType>;
     getMaxCumulusId(knexOrTransaction: Knex | Knex.Transaction): Promise<number>;
     paginateByCumulusId(knexOrTransaction: Knex | Knex.Transaction, startId?: number, pageSize?: number): Promise<RecordType[]>;
+    /**
+     * Builds query to fetch mulitple items from postgres
+     *
+     * @param {Knex | Knex.Transaction} knexOrTransaction - DB client or transaction
+     * @param {Object} params - An object or any portion of an object of type RecordType
+     * @returns {Object} - Knex querybuilder object
+     */
+    queryBuilderSearch(knexOrTransaction: Knex | Knex.Transaction, params: Partial<RecordType>): Knex.QueryBuilder<any, {
+        _base: any;
+        _hasSelection: false;
+        _keys: never;
+        _aliases: {};
+        _single: false;
+        _intersectProps: {};
+        _unionProps: never;
+    }[]>;
     /**
      * Fetches multiple items from Postgres
      *
      * @param {Knex | Knex.Transaction} knexOrTransaction - DB client or transaction
-     * @param {Partial<RecordType>} params - An object or any portion of an object of type RecordType
+     * @param {Object} params - An object or any portion of an object of type RecordType
      * @returns {Promise<RecordType[]>} List of returned records
      */
     search(knexOrTransaction: Knex | Knex.Transaction, params: Partial<RecordType>): Promise<RecordType[]>;
@@ -106,15 +122,15 @@ declare class BasePgModel<ItemType, RecordType extends BaseRecord> {
      */
     update(knexOrTransaction: Knex | Knex.Transaction, whereClause: Partial<RecordType>, updateParams: Partial<RecordType>, returning?: Array<string>): Promise<any[]>;
     /**
-    * Deletes items from postgres based on params, excluding any cumulus_ids in the excludeCumulusIds
-    * @param {Object} params
-    * @param {Knex | Knex.Transaction} params.knexOrTransaction - DB client or transaction
-    * @param {Partial<RecordType>} params.queryParams - An object or any portion
-    *                                             of an object of type RecordType
-    * @param {[number]} params.excludeCumulusIds - A list of cumulus_ids to exclude from the deletion
-    *                                       request
-    * @returns {Promise<number>} The number of rows deleted
-    */
+     * Deletes items from postgres based on params, excluding any cumulus_ids in the excludeCumulusIds
+     * @param {Object} params
+     * @param {Knex | Knex.Transaction} params.knexOrTransaction - DB client or transaction
+     * @param {Partial<RecordType>} params.queryParams - An object or any portion
+     *                                             of an object of type RecordType
+     * @param {[number]} params.excludeCumulusIds - A list of cumulus_ids to exclude from the deletion
+     *                                       request
+     * @returns {Promise<number>} The number of rows deleted
+     */
     deleteExcluding({ knexOrTransaction, excludeCumulusIds, queryParams, }: {
         knexOrTransaction: Knex | Knex.Transaction;
         excludeCumulusIds: Number[];

package/dist/models/base.js

@@ -4,7 +4,7 @@ exports.BasePgModel = void 0;
 const errors_1 = require("@cumulus/errors");
 const database_1 = require("../database");
 class BasePgModel {
-    constructor({ tableName, }) {
+    constructor({ tableName }) {
         this.tableName = tableName;
     }
     /**
@@ -16,8 +16,7 @@ class BasePgModel {
      * @returns {Promise<PostgresCollectionRecord[]>} List of returned records
      */
     async searchWithUpdatedAtRange(knexOrTransaction, params, updatedAtParams) {
-        const records = await knexOrTransaction(this.tableName)
-            .where((builder) => {
+        const records = await knexOrTransaction(this.tableName).where((builder) => {
             var _a, _b;
             builder.where(params);
             if (updatedAtParams.updatedAtFrom || updatedAtParams.updatedAtTo) {
@@ -30,7 +29,8 @@ class BasePgModel {
         return records;
     }
     async count(knexOrTransaction, params) {
-        const query = knexOrTransaction(this.tableName).where((builder) => {
+        const query = knexOrTransaction(this.tableName)
+            .where((builder) => {
             params.forEach((param) => {
                 if (param.length === 3) {
                     builder.where(...param);
@@ -39,7 +39,8 @@ class BasePgModel {
                     builder.where(param[0]);
                 }
             });
-        }).count();
+        })
+            .count();
         return await query;
     }
     /**
@@ -59,27 +60,39 @@ class BasePgModel {
         return record;
     }
     async getMaxCumulusId(knexOrTransaction) {
-        const result = await knexOrTransaction(this.tableName).max('cumulus_id').first();
+        const result = await knexOrTransaction(this.tableName)
+            .max('cumulus_id')
+            .first();
         if (!result) {
             throw new Error(`Invalid .max "cumulus_id" query on ${this.tableName}, MAX cumulus_id cannot be returned`);
         }
         return Number(result.max);
     }
     async paginateByCumulusId(knexOrTransaction, startId = 0, pageSize = 100) {
-        return await knexOrTransaction.select()
+        return await knexOrTransaction
+            .select()
             .from(this.tableName)
             .whereBetween('cumulus_id', [startId, startId + pageSize - 1]);
     }
+    /**
+     * Builds query to fetch mulitple items from postgres
+     *
+     * @param {Knex | Knex.Transaction} knexOrTransaction - DB client or transaction
+     * @param {Object} params - An object or any portion of an object of type RecordType
+     * @returns {Object} - Knex querybuilder object
+     */
+    queryBuilderSearch(knexOrTransaction, params) {
+        return knexOrTransaction(this.tableName).where(params);
+    }
     /**
      * Fetches multiple items from Postgres
      *
      * @param {Knex | Knex.Transaction} knexOrTransaction - DB client or transaction
-     * @param {Partial<RecordType>} params - An object or any portion of an object of type RecordType
+     * @param {Object} params - An object or any portion of an object of type RecordType
      * @returns {Promise<RecordType[]>} List of returned records
      */
     async search(knexOrTransaction, params) {
-        const records = await knexOrTransaction(this.tableName)
-            .where(params);
+        const records = await this.queryBuilderSearch(knexOrTransaction, params);
         return records;
     }
     /**
@@ -173,9 +186,7 @@ class BasePgModel {
      * @returns {Promise<number>} The number of rows deleted
      */
     async delete(knexOrTransaction, params) {
-        return await knexOrTransaction(this.tableName)
-            .where(params)
-            .del();
+        return await knexOrTransaction(this.tableName).where(params).del();
     }
     /**
      * Updates the item or items in Postgres
@@ -192,15 +203,15 @@ class BasePgModel {
             .update(updateParams, returning);
     }
     /**
-    * Deletes items from postgres based on params, excluding any cumulus_ids in the excludeCumulusIds
-    * @param {Object} params
-    * @param {Knex | Knex.Transaction} params.knexOrTransaction - DB client or transaction
-    * @param {Partial<RecordType>} params.queryParams - An object or any portion
-    *                                             of an object of type RecordType
-    * @param {[number]} params.excludeCumulusIds - A list of cumulus_ids to exclude from the deletion
-    *                                       request
-    * @returns {Promise<number>} The number of rows deleted
-    */
+     * Deletes items from postgres based on params, excluding any cumulus_ids in the excludeCumulusIds
+     * @param {Object} params
+     * @param {Knex | Knex.Transaction} params.knexOrTransaction - DB client or transaction
+     * @param {Partial<RecordType>} params.queryParams - An object or any portion
+     *                                             of an object of type RecordType
+     * @param {[number]} params.excludeCumulusIds - A list of cumulus_ids to exclude from the deletion
+     *                                       request
+     * @returns {Promise<number>} The number of rows deleted
+     */
     async deleteExcluding({ knexOrTransaction, excludeCumulusIds = [], queryParams, }) {
         return await knexOrTransaction(this.tableName)
             .where(queryParams)

package/dist/models/execution.d.ts

@@ -3,6 +3,7 @@ import { BasePgModel } from './base';
 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[]>;
     upsert(knexOrTrx: Knex | Knex.Transaction, execution: PostgresExecution): Promise<any[]>;
     /**

package/dist/models/execution.js

@@ -67,4 +67,5 @@ class ExecutionPgModel extends base_1.BasePgModel {
     }
 }
 exports.ExecutionPgModel = ExecutionPgModel;
+ExecutionPgModel.nonActiveStatuses = ['completed', 'failed', 'unknown'];
 //# sourceMappingURL=execution.js.map

package/dist/models/granule.d.ts

@@ -1,7 +1,7 @@
 import { Knex } from 'knex';
 import { PostgresGranule, PostgresGranuleRecord, PostgresGranuleUniqueColumns } from '../types/granule';
 import { BasePgModel } from './base';
-import { GranulesExecutionsPgModel } from './granules-executions';
+import { ExecutionPgModel } from './execution';
 interface RecordSelect {
     cumulus_id: number;
 }
@@ -37,7 +37,16 @@ export default class GranulePgModel extends BasePgModel<PostgresGranule, Postgre
      * @returns {Promise<PostgresGranuleRecord>} The returned record
      */
     get(knexOrTransaction: Knex | Knex.Transaction, params: PostgresGranuleUniqueColumns | RecordSelect): Promise<PostgresGranuleRecord>;
-    upsert(knexOrTrx: Knex | Knex.Transaction, granule: PostgresGranule, executionCumulusId?: number, granulesExecutionsPgModel?: GranulesExecutionsPgModel): Promise<any[]>;
+    _buildExclusionClause(executionPgModel: ExecutionPgModel, executionCumulusId: number, knexOrTrx: Knex | Knex.Transaction, status: 'queued' | 'running'): Knex.QueryBuilder<any, {
+        _base: any;
+        _hasSelection: false;
+        _keys: never;
+        _aliases: {};
+        _single: false;
+        _intersectProps: {};
+        _unionProps: never;
+    }[]>;
+    upsert(knexOrTrx: Knex | Knex.Transaction, granule: PostgresGranule, executionCumulusId?: number, executionPgModel?: ExecutionPgModel): Promise<any[]>;
     /**
      * Get granules from the granule cumulus_id
      *

package/dist/models/granule.js

@@ -4,7 +4,7 @@ exports.GranulePgModel = void 0;
 const errors_1 = require("@cumulus/errors");
 const tables_1 = require("../tables");
 const base_1 = require("./base");
-const granules_executions_1 = require("./granules-executions");
+const execution_1 = require("./execution");
 const timestamp_1 = require("../lib/timestamp");
 const sort_1 = require("../lib/sort");
 function isRecordSelect(param) {
@@ -27,9 +27,7 @@ class GranulePgModel extends base_1.BasePgModel {
      * @returns {Promise<number>} The number of rows deleted
      */
     async delete(knexOrTransaction, params) {
-        return await knexOrTransaction(this.tableName)
-            .where(params)
-            .del();
+        return await knexOrTransaction(this.tableName).where(params).del();
     }
     async deleteExcluding() {
         throw new Error('deleteExcluding not implemented on granule class');
@@ -70,7 +68,16 @@ class GranulePgModel extends base_1.BasePgModel {
         }
         return super.get(knexOrTransaction, params);
     }
-    async upsert(knexOrTrx, granule, executionCumulusId, granulesExecutionsPgModel = new granules_executions_1.GranulesExecutionsPgModel()) {
+    _buildExclusionClause(executionPgModel, executionCumulusId, knexOrTrx, status) {
+        const queryBuilder = executionPgModel.queryBuilderSearch(knexOrTrx, {
+            cumulus_id: executionCumulusId,
+        });
+        if (status === 'running') {
+            queryBuilder.whereIn('status', execution_1.ExecutionPgModel.nonActiveStatuses);
+        }
+        return queryBuilder;
+    }
+    async upsert(knexOrTrx, granule, executionCumulusId, executionPgModel = new execution_1.ExecutionPgModel()) {
         if (!granule.created_at) {
             throw new Error(`To upsert granule record must have 'created_at' set: ${JSON.stringify(granule)}`);
         }
@@ -86,13 +93,14 @@ class GranulePgModel extends base_1.BasePgModel {
             })
                 .where(knexOrTrx.raw(`${this.tableName}.created_at <= to_timestamp(${(0, timestamp_1.translateDateToUTC)(granule.created_at)})`));
             // In reality, the only place where executionCumulusId should be
-            // undefined is from the data migrations
+            // undefined is from the data migrations OR a queued granule from reingest
             if (executionCumulusId) {
-                // Only do the upsert if there IS NOT already a record associating
-                // the granule to this execution. If there IS already a record
-                // linking this granule to this execution, then this upsert query
-                // will not affect any rows.
-                upsertQuery.whereNotExists(granulesExecutionsPgModel.search(knexOrTrx, { execution_cumulus_id: executionCumulusId }));
+                const exclusionClause = this._buildExclusionClause(executionPgModel, executionCumulusId, knexOrTrx, granule.status);
+                // Only do the upsert if there is no execution that matches the exclusionClause
+                // For running granules, this means the execution does not exist in a state other
+                // than 'running'.  For queued granules, this means that the execution does not
+                // exist at all
+                upsertQuery.whereNotExists(exclusionClause);
             }
             upsertQuery.returning('*');
             return await upsertQuery;

package/dist/translate/executions.js

@@ -95,8 +95,8 @@ const translateApiExecutionToPostgresExecution = async (dynamoRecord, knex, coll
         updated_at: dynamoRecord.updatedAt ? new Date(dynamoRecord.updatedAt) : undefined,
     };
     if (dynamoRecord.collectionId !== undefined) {
-        const collectionNameVersionArray = dynamoRecord.collectionId.split('___');
-        translatedRecord.collection_cumulus_id = await collectionPgModel.getRecordCumulusId(knex, { name: collectionNameVersionArray[0], version: collectionNameVersionArray[1] });
+        const { name, version } = (0, Collections_1.deconstructCollectionId)(dynamoRecord.collectionId);
+        translatedRecord.collection_cumulus_id = await collectionPgModel.getRecordCumulusId(knex, { name, version });
     }
     // If we have a parentArn, try a lookup in Postgres. If there's a match, set the parent_cumulus_id
     if (dynamoRecord.parentArn !== undefined) {

package/dist/translate/providers.js

@@ -22,7 +22,7 @@ const translatePostgresProviderToApiProvider = (record) => {
         createdAt: record.created_at.getTime(),
         updatedAt: record.updated_at.getTime(),
         username: record.username,
-        password: record.username,
+        password: record.password,
         allowedRedirects: record.allowed_redirects,
     };
     if (record.username || record.password) {

package/dist/translate/rules.d.ts

@@ -13,5 +13,15 @@ export declare const translatePostgresRuleToApiRule: (pgRule: PostgresRuleRecord
  * @param {Object} providerPgModel - Instance of the provider database model
  * @returns {Object} A rule record
  */
+export declare const translateApiRuleToPostgresRuleRaw: (record: RuleRecord, dbClient: Knex, collectionPgModel?: CollectionPgModel, providerPgModel?: ProviderPgModel) => Promise<PostgresRule>;
+/**
+ * Generate a Postgres rule record from a DynamoDB record and remove nil properties.
+ *
+ * @param {Object} record - A rule
+ * @param {Object} dbClient - Knex client for reading from RDS database
+ * @param {Object} collectionPgModel - Instance of the collection database model
+ * @param {Object} providerPgModel - Instance of the provider database model
+ * @returns {Object} A rule record
+ */
 export declare const translateApiRuleToPostgresRule: (record: RuleRecord, dbClient: Knex, collectionPgModel?: CollectionPgModel, providerPgModel?: ProviderPgModel) => Promise<PostgresRule>;
 //# sourceMappingURL=rules.d.ts.map

package/dist/translate/rules.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.translateApiRuleToPostgresRule = exports.translatePostgresRuleToApiRule = void 0;
+exports.translateApiRuleToPostgresRule = exports.translateApiRuleToPostgresRuleRaw = exports.translatePostgresRuleToApiRule = void 0;
 const util_1 = require("@cumulus/common/util");
 const collection_1 = require("../models/collection");
 const provider_1 = require("../models/provider");
@@ -46,25 +46,36 @@ exports.translatePostgresRuleToApiRule = translatePostgresRuleToApiRule;
  * @param {Object} providerPgModel - Instance of the provider database model
  * @returns {Object} A rule record
  */
+const translateApiRuleToPostgresRuleRaw = async (record, dbClient, collectionPgModel = new collection_1.CollectionPgModel(), providerPgModel = new provider_1.ProviderPgModel()) => ({
+    name: record.name,
+    workflow: record.workflow,
+    provider_cumulus_id: record.provider ? await providerPgModel.getRecordCumulusId(dbClient, { name: record.provider }) : undefined,
+    collection_cumulus_id: record.collection ? await collectionPgModel.getRecordCumulusId(dbClient, { name: record.collection.name, version: record.collection.version }) : undefined,
+    meta: record.meta,
+    payload: record.payload,
+    queue_url: record.queueUrl,
+    arn: record.rule.arn,
+    type: record.rule.type,
+    value: record.rule.value,
+    log_event_arn: record.rule.logEventArn,
+    enabled: (record.state === undefined) || (record.state === 'ENABLED'),
+    tags: (record.tags ? JSON.stringify(record.tags) : undefined),
+    execution_name_prefix: record.executionNamePrefix,
+    created_at: (record.createdAt ? new Date(record.createdAt) : undefined),
+    updated_at: (record.updatedAt ? new Date(record.updatedAt) : undefined),
+});
+exports.translateApiRuleToPostgresRuleRaw = translateApiRuleToPostgresRuleRaw;
+/**
+ * Generate a Postgres rule record from a DynamoDB record and remove nil properties.
+ *
+ * @param {Object} record - A rule
+ * @param {Object} dbClient - Knex client for reading from RDS database
+ * @param {Object} collectionPgModel - Instance of the collection database model
+ * @param {Object} providerPgModel - Instance of the provider database model
+ * @returns {Object} A rule record
+ */
 const translateApiRuleToPostgresRule = async (record, dbClient, collectionPgModel = new collection_1.CollectionPgModel(), providerPgModel = new provider_1.ProviderPgModel()) => {
-    const ruleRecord = {
-        name: record.name,
-        workflow: record.workflow,
-        provider_cumulus_id: record.provider ? await providerPgModel.getRecordCumulusId(dbClient, { name: record.provider }) : undefined,
-        collection_cumulus_id: record.collection ? await collectionPgModel.getRecordCumulusId(dbClient, { name: record.collection.name, version: record.collection.version }) : undefined,
-        meta: record.meta,
-        payload: record.payload,
-        queue_url: record.queueUrl,
-        arn: record.rule.arn,
-        type: record.rule.type,
-        value: record.rule.value,
-        log_event_arn: record.rule.logEventArn,
-        enabled: (record.state === undefined) || (record.state === 'ENABLED'),
-        tags: (record.tags ? JSON.stringify(record.tags) : undefined),
-        execution_name_prefix: record.executionNamePrefix,
-        created_at: (record.createdAt ? new Date(record.createdAt) : undefined),
-        updated_at: (record.updatedAt ? new Date(record.updatedAt) : undefined),
-    };
+    const ruleRecord = await (0, exports.translateApiRuleToPostgresRuleRaw)(record, dbClient, collectionPgModel, providerPgModel);
     return (0, util_1.removeNilProperties)(ruleRecord);
 };
 exports.translateApiRuleToPostgresRule = translateApiRuleToPostgresRule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/db",
-  "version": "10.1.1-alpha.0",
+  "version": "11.0.0",
   "description": "Utilities for working with the Cumulus DB",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -29,21 +29,22 @@
     "node": ">=12.18.0"
   },
   "dependencies": {
-    "@cumulus/aws-client": "10.0.0",
-    "@cumulus/common": "10.0.0",
-    "@cumulus/errors": "10.0.0",
-    "@cumulus/logger": "10.0.0",
-    "@cumulus/message": "10.0.0",
-    "@cumulus/types": "10.0.0",
+    "@cumulus/aws-client": "11.0.0",
+    "@cumulus/common": "11.0.0",
+    "@cumulus/errors": "11.0.0",
+    "@cumulus/logger": "11.0.0",
+    "@cumulus/message": "11.0.0",
+    "@cumulus/types": "11.0.0",
     "crypto-random-string": "^3.2.0",
     "is-valid-hostname": "0.0.1",
     "knex": "0.95.15",
-    "lodash": "^4.17.20",
+    "lodash": "^4.17.21",
     "pg": "^8.3.0",
     "snake-camel": "^1.0.6",
     "uuid": "8.3.2"
   },
   "devDependencies": {
     "@types/uuid": "^8.0.0"
-  }
+  },
+  "gitHead": "e922ad12fd94affa6cd60a97a184a465a756c50b"
 }