@cumulus/db 15.0.3 → 16.0.0

package/dist/index.d.ts

@@ -21,13 +21,13 @@ export { translateApiFiletoPostgresFile, translatePostgresFileToApiFile, } from
 export { translateApiCollectionToPostgresCollection, translatePostgresCollectionToApiCollection, } from './translate/collections';
 export { translateApiProviderToPostgresProvider, translatePostgresProviderToApiProvider, } from './translate/providers';
 export { translatePostgresRuleToApiRule, translateApiRuleToPostgresRule, translateApiRuleToPostgresRuleRaw, } from './translate/rules';
-export { translateApiExecutionToPostgresExecution, translatePostgresExecutionToApiExecution, } from './translate/executions';
+export { translateApiExecutionToPostgresExecution, translateApiExecutionToPostgresExecutionWithoutNilsRemoved, translatePostgresExecutionToApiExecution, } from './translate/executions';
 export { translateApiGranuleToPostgresGranule, translateApiGranuleToPostgresGranuleWithoutNilsRemoved, translatePostgresGranuleToApiGranule, translatePostgresGranuleResultToApiGranule, } from './translate/granules';
 export { translateApiPdrToPostgresPdr, translatePostgresPdrToApiPdr, } from './translate/pdr';
 export { getCollectionsByGranuleIds, } from './lib/collection';
 export { executionArnsFromGranuleIdsAndWorkflowNames, newestExecutionArnFromGranuleIdWorkflowName, getWorkflowNameIntersectFromGranuleIds, getApiExecutionCumulusIds, getApiGranuleExecutionCumulusIdsByExecution, getExecutionInfoByGranuleCumulusId, } from './lib/execution';
 export { getFilesAndGranuleInfoQuery, } from './lib/file';
-export { getApiGranuleCumulusIds, getApiGranuleExecutionCumulusIds, getGranuleCollectionId, getUniqueGranuleByGranuleId, upsertGranuleWithExecutionJoinRecord, getGranulesByApiPropertiesQuery, getGranulesByGranuleId, } from './lib/granule';
+export { getApiGranuleCumulusIds, getApiGranuleExecutionCumulusIds, getGranuleCollectionId, getUniqueGranuleByGranuleId, getGranuleByUniqueColumns, upsertGranuleWithExecutionJoinRecord, getGranulesByApiPropertiesQuery, getGranulesByGranuleId, getGranuleAndCollection, } from './lib/granule';
 export { QuerySearchClient, } from './lib/QuerySearchClient';
 export { AsyncOperationPgModel } from './models/async_operation';
 export { BasePgModel } from './models/base';

package/dist/index.js

@@ -23,8 +23,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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.translateApiGranuleToPostgresGranuleWithoutNilsRemoved = 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.getGranulesByGranuleId = exports.getGranulesByApiPropertiesQuery = exports.upsertGranuleWithExecutionJoinRecord = exports.getUniqueGranuleByGranuleId = exports.getGranuleCollectionId = exports.getApiGranuleExecutionCumulusIds = void 0;
+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.translateApiGranuleToPostgresGranuleWithoutNilsRemoved = exports.translateApiGranuleToPostgresGranule = exports.translatePostgresExecutionToApiExecution = exports.translateApiExecutionToPostgresExecutionWithoutNilsRemoved = 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.getGranuleAndCollection = exports.getGranulesByGranuleId = exports.getGranulesByApiPropertiesQuery = exports.upsertGranuleWithExecutionJoinRecord = exports.getGranuleByUniqueColumns = exports.getUniqueGranuleByGranuleId = exports.getGranuleCollectionId = exports.getApiGranuleExecutionCumulusIds = exports.getApiGranuleCumulusIds = void 0;
 const path = __importStar(require("path"));
 var knex_1 = require("knex");
 Object.defineProperty(exports, "Knex", { enumerable: true, get: function () { return knex_1.Knex; } });
@@ -74,6 +74,7 @@ Object.defineProperty(exports, "translateApiRuleToPostgresRule", { enumerable: t
 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, "translateApiExecutionToPostgresExecutionWithoutNilsRemoved", { enumerable: true, get: function () { return executions_1.translateApiExecutionToPostgresExecutionWithoutNilsRemoved; } });
 Object.defineProperty(exports, "translatePostgresExecutionToApiExecution", { enumerable: true, get: function () { return executions_1.translatePostgresExecutionToApiExecution; } });
 var granules_1 = require("./translate/granules");
 Object.defineProperty(exports, "translateApiGranuleToPostgresGranule", { enumerable: true, get: function () { return granules_1.translateApiGranuleToPostgresGranule; } });
@@ -99,9 +100,11 @@ Object.defineProperty(exports, "getApiGranuleCumulusIds", { enumerable: true, ge
 Object.defineProperty(exports, "getApiGranuleExecutionCumulusIds", { enumerable: true, get: function () { return granule_1.getApiGranuleExecutionCumulusIds; } });
 Object.defineProperty(exports, "getGranuleCollectionId", { enumerable: true, get: function () { return granule_1.getGranuleCollectionId; } });
 Object.defineProperty(exports, "getUniqueGranuleByGranuleId", { enumerable: true, get: function () { return granule_1.getUniqueGranuleByGranuleId; } });
+Object.defineProperty(exports, "getGranuleByUniqueColumns", { enumerable: true, get: function () { return granule_1.getGranuleByUniqueColumns; } });
 Object.defineProperty(exports, "upsertGranuleWithExecutionJoinRecord", { enumerable: true, get: function () { return granule_1.upsertGranuleWithExecutionJoinRecord; } });
 Object.defineProperty(exports, "getGranulesByApiPropertiesQuery", { enumerable: true, get: function () { return granule_1.getGranulesByApiPropertiesQuery; } });
 Object.defineProperty(exports, "getGranulesByGranuleId", { enumerable: true, get: function () { return granule_1.getGranulesByGranuleId; } });
+Object.defineProperty(exports, "getGranuleAndCollection", { enumerable: true, get: function () { return granule_1.getGranuleAndCollection; } });
 var QuerySearchClient_1 = require("./lib/QuerySearchClient");
 Object.defineProperty(exports, "QuerySearchClient", { enumerable: true, get: function () { return QuerySearchClient_1.QuerySearchClient; } });
 var async_operation_1 = require("./models/async_operation");

package/dist/lib/granule.d.ts

@@ -50,6 +50,17 @@ export declare const getApiGranuleCumulusIds: (knexOrTransaction: Knex | Knex.Tr
  * @returns {Promise<PostgresGranuleRecord>}
  */
 export declare const getUniqueGranuleByGranuleId: (knexOrTransaction: Knex | Knex.Transaction, granuleId: string, granulePgModel?: GranulePgModel) => Promise<PostgresGranuleRecord>;
+/**
+ * Get one Granule for a granule_id and collection_cumulus_id
+ *
+ * @param {Knex | Knex.Transaction} knexOrTransaction -
+ *  DB client or transaction
+ * @param {string} granuleId - a granule.granule_id
+ * @param {number} collectionCumulusId - a granule.collection_cumulus_id
+ * @param {GranulePgModel} granulePgModel - Granule PG model class instance
+ * @returns {Promise<PostgresGranuleRecord>}
+ */
+export declare const getGranuleByUniqueColumns: (knexOrTransaction: Knex | Knex.Transaction, granuleId: string, collectionCumulusId: number, granulePgModel?: GranulePgModel) => Promise<PostgresGranuleRecord>;
 /**
  * Get cumulus IDs for all executions associated to a set of granules
  *
@@ -86,6 +97,19 @@ export declare const getGranulesByApiPropertiesQuery: (knex: Knex, { collectionI
     updatedAtRange?: UpdatedAtRange | undefined;
     status?: string | undefined;
 }, sortByFields?: string | string[]) => Knex.QueryBuilder;
+/**
+ * Get Postgres Granule and Collection objects for a granuleId + collectionId
+ *
+ * @param {Knex | Knex.Transaction} knexOrTransaction -
+ *  DB client or transaction
+ * @param {Object} [collectionPgModel] - Collection PG model class instance
+ * @param {Object} [granulePgModel] - Granule PG model class instance
+ * @param {String} granuleId - primary ID for granule record
+ * @param {String} collectionId - collection ID in 'name___version' format
+ * @returns {Promise<object>} an object containing the Postgres Granule,
+ * Postgres Collection, and an optional "Not Found" error message
+ */
+export declare const getGranuleAndCollection: (knexOrTransaction: Knex | Knex.Transaction, collectionPgModel: CollectionPgModel | undefined, granulePgModel: GranulePgModel | undefined, granuleId: string, collectionId: string) => Promise<object>;
 /**
  * Get granules from table where granule_id matches provided granuleId
  *

package/dist/lib/granule.js

@@ -3,13 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getGranulesByGranuleId = exports.getGranulesByApiPropertiesQuery = exports.getApiGranuleExecutionCumulusIds = exports.getUniqueGranuleByGranuleId = exports.getApiGranuleCumulusIds = exports.upsertGranuleWithExecutionJoinRecord = exports.getGranuleCollectionId = void 0;
+exports.getGranulesByGranuleId = exports.getGranuleAndCollection = exports.getGranulesByApiPropertiesQuery = exports.getApiGranuleExecutionCumulusIds = exports.getGranuleByUniqueColumns = exports.getUniqueGranuleByGranuleId = exports.getApiGranuleCumulusIds = exports.upsertGranuleWithExecutionJoinRecord = exports.getGranuleCollectionId = void 0;
 const Collections_1 = require("@cumulus/message/Collections");
 const errors_1 = require("@cumulus/errors");
 const logger_1 = __importDefault(require("@cumulus/logger"));
 const collection_1 = require("../models/collection");
 const granule_1 = require("../models/granule");
 const granules_executions_1 = require("../models/granules-executions");
+const { deprecate } = require('@cumulus/common/util');
 const { TableNames } = require('../tables');
 const getGranuleCollectionId = async (knexOrTransaction, granule) => {
     const collectionPgModel = new collection_1.CollectionPgModel();
@@ -89,6 +90,7 @@ exports.getApiGranuleCumulusIds = getApiGranuleCumulusIds;
  * @returns {Promise<PostgresGranuleRecord>}
  */
 const getUniqueGranuleByGranuleId = async (knexOrTransaction, granuleId, granulePgModel = new granule_1.GranulePgModel()) => {
+    deprecate('@cumulus/db/getUniqueGranuleByGranuleId', 'RDS-Phase-3', '@cumulus/db/getGranuleByUniqueColumns');
     const logger = new logger_1.default({ sender: '@cumulus/api/granules' });
     const PgGranuleRecords = await granulePgModel.search(knexOrTransaction, {
         granule_id: granuleId,
@@ -103,6 +105,18 @@ const getUniqueGranuleByGranuleId = async (knexOrTransaction, granuleId, granule
     return PgGranuleRecords[0];
 };
 exports.getUniqueGranuleByGranuleId = getUniqueGranuleByGranuleId;
+/**
+ * Get one Granule for a granule_id and collection_cumulus_id
+ *
+ * @param {Knex | Knex.Transaction} knexOrTransaction -
+ *  DB client or transaction
+ * @param {string} granuleId - a granule.granule_id
+ * @param {number} collectionCumulusId - a granule.collection_cumulus_id
+ * @param {GranulePgModel} granulePgModel - Granule PG model class instance
+ * @returns {Promise<PostgresGranuleRecord>}
+ */
+const getGranuleByUniqueColumns = (knexOrTransaction, granuleId, collectionCumulusId, granulePgModel = new granule_1.GranulePgModel()) => granulePgModel.get(knexOrTransaction, { granule_id: granuleId, collection_cumulus_id: collectionCumulusId });
+exports.getGranuleByUniqueColumns = getGranuleByUniqueColumns;
 /**
  * Get cumulus IDs for all executions associated to a set of granules
  *
@@ -182,6 +196,46 @@ const getGranulesByApiPropertiesQuery = (knex, { collectionIds, granuleIds, prov
         .groupBy(`${providersTable}.cumulus_id`);
 };
 exports.getGranulesByApiPropertiesQuery = getGranulesByApiPropertiesQuery;
+/**
+ * Get Postgres Granule and Collection objects for a granuleId + collectionId
+ *
+ * @param {Knex | Knex.Transaction} knexOrTransaction -
+ *  DB client or transaction
+ * @param {Object} [collectionPgModel] - Collection PG model class instance
+ * @param {Object} [granulePgModel] - Granule PG model class instance
+ * @param {String} granuleId - primary ID for granule record
+ * @param {String} collectionId - collection ID in 'name___version' format
+ * @returns {Promise<object>} an object containing the Postgres Granule,
+ * Postgres Collection, and an optional "Not Found" error message
+ */
+const getGranuleAndCollection = async (knexOrTransaction, collectionPgModel = new collection_1.CollectionPgModel(), granulePgModel = new granule_1.GranulePgModel(), granuleId, collectionId) => {
+    let pgGranule;
+    let pgCollection;
+    let notFoundError;
+    try {
+        pgCollection = await collectionPgModel.get(knexOrTransaction, (0, Collections_1.deconstructCollectionId)(collectionId));
+        pgGranule = await granulePgModel.get(knexOrTransaction, { granule_id: granuleId, collection_cumulus_id: pgCollection.cumulus_id });
+    }
+    catch (error) {
+        if (error instanceof errors_1.RecordDoesNotExist) {
+            if (collectionId && pgCollection === undefined) {
+                notFoundError = `No collection found for granuleId ${granuleId} with collectionId ${collectionId}`;
+            }
+            else {
+                notFoundError = 'Granule not found';
+            }
+        }
+        else {
+            throw error;
+        }
+    }
+    return {
+        pgGranule,
+        pgCollection,
+        notFoundError,
+    };
+};
+exports.getGranuleAndCollection = getGranuleAndCollection;
 /**
  * Get granules from table where granule_id matches provided granuleId
  *

package/dist/migrations/20210727104740_alter_async_operations_table_operation_type.js

@@ -18,7 +18,6 @@ const up = async (knex) => {
         'Dead-Letter Processing',
         'Kinesis Replay',
         'Reconciliation Report',
-        'Migration Count Report',
         'Data Migration',
         'SQS Replay',
     ]));
@@ -33,7 +32,6 @@ const down = async (knex) => {
         'Dead-Letter Processing',
         'Kinesis Replay',
         'Reconciliation Report',
-        'Migration Count Report',
         'Data Migration',
     ]));
 };

package/dist/models/async_operation.js

@@ -15,7 +15,7 @@ class AsyncOperationPgModel extends base_1.BasePgModel {
             .insert(asyncOperation)
             .onConflict('id')
             .merge()
-            .returning('cumulus_id');
+            .returning('*');
     }
 }
 exports.AsyncOperationPgModel = AsyncOperationPgModel;

package/dist/models/execution.d.ts

@@ -5,7 +5,7 @@ declare class ExecutionPgModel extends BasePgModel<PostgresExecution, PostgresEx
     constructor();
     static nonActiveStatuses: string[];
     create(knexOrTransaction: Knex | Knex.Transaction, item: PostgresExecution): Promise<unknown[] | Object[]>;
-    upsert(knexOrTrx: Knex | Knex.Transaction, execution: PostgresExecution): Promise<any[]>;
+    upsert(knexOrTrx: Knex | Knex.Transaction, execution: PostgresExecution, writeConstraints?: boolean): Promise<any[]>;
     /**
      * Get executions from the execution cumulus_id
      *

package/dist/models/execution.js

@@ -13,8 +13,8 @@ class ExecutionPgModel extends base_1.BasePgModel {
     create(knexOrTransaction, item) {
         return super.create(knexOrTransaction, item, '*');
     }
-    async upsert(knexOrTrx, execution) {
-        if (execution.status === 'running') {
+    async upsert(knexOrTrx, execution, writeConstraints = true) {
+        if (writeConstraints && execution.status === 'running') {
             return await knexOrTrx(this.tableName)
                 .insert(execution)
                 .onConflict('arn')

package/dist/models/provider.d.ts

@@ -5,8 +5,8 @@ declare class ProviderPgModel extends BasePgModel<PostgresProvider, PostgresProv
     constructor();
     upsert(knexOrTransaction: Knex | Knex.Transaction, provider: PostgresProvider): Knex.QueryBuilder<any, {
         _base: any;
-        _hasSelection: true;
-        _keys: "cumulus_id";
+        _hasSelection: false;
+        _keys: never;
         _aliases: {};
         _single: false;
         _intersectProps: {};

package/dist/models/provider.js

@@ -14,7 +14,7 @@ class ProviderPgModel extends base_1.BasePgModel {
             .insert(provider)
             .onConflict('name')
             .merge()
-            .returning('cumulus_id');
+            .returning('*');
     }
 }
 exports.ProviderPgModel = ProviderPgModel;

package/dist/models/rule.d.ts

@@ -3,10 +3,11 @@ import { BasePgModel } from './base';
 import { PostgresRule, PostgresRuleRecord } from '../types/rule';
 declare class RulePgModel extends BasePgModel<PostgresRule, PostgresRuleRecord> {
     constructor();
+    create(knexOrTransaction: Knex | Knex.Transaction, item: PostgresRule): Promise<unknown[] | Object[]>;
     upsert(knexOrTransaction: Knex | Knex.Transaction, rule: PostgresRule): Knex.QueryBuilder<any, {
         _base: any;
-        _hasSelection: true;
-        _keys: "cumulus_id";
+        _hasSelection: false;
+        _keys: never;
         _aliases: {};
         _single: false;
         _intersectProps: {};

package/dist/models/rule.js

@@ -9,12 +9,15 @@ class RulePgModel extends base_1.BasePgModel {
             tableName: tables_1.TableNames.rules,
         });
     }
+    create(knexOrTransaction, item) {
+        return super.create(knexOrTransaction, item, '*');
+    }
     upsert(knexOrTransaction, rule) {
         return knexOrTransaction(this.tableName)
             .insert(rule)
             .onConflict('name')
             .merge()
-            .returning('cumulus_id');
+            .returning('*');
     }
 }
 exports.RulePgModel = RulePgModel;

package/dist/test-utils.js

@@ -8,6 +8,7 @@ const crypto_random_string_1 = __importDefault(require("crypto-random-string"));
 const uuid_1 = require("uuid");
 const p_retry_1 = __importDefault(require("p-retry"));
 const Executions_1 = require("@cumulus/message/Executions");
+const test_utils_1 = require("@cumulus/common/test-utils");
 const connection_1 = require("./connection");
 const config_1 = require("./config");
 const createTestDatabase = async (knex, dbName, dbUser) => {
@@ -40,7 +41,7 @@ const destroyLocalTestDb = async ({ knex, knexAdmin, testDbName, }) => {
 exports.destroyLocalTestDb = destroyLocalTestDb;
 const fakeRuleRecordFactory = (params) => ({
     name: (0, crypto_random_string_1.default)({ length: 8 }),
-    workflow: 'Random Workflow',
+    workflow: (0, test_utils_1.randomId)('workflow'),
     type: 'onetime',
     enabled: false,
     created_at: new Date(),
@@ -82,6 +83,8 @@ const fakeProviderRecordFactory = (params) => ({
     name: `provider${(0, crypto_random_string_1.default)({ length: 5 })}`,
     host: 'test-bucket',
     protocol: 's3',
+    created_at: new Date(),
+    updated_at: new Date(),
     ...params,
 });
 exports.fakeProviderRecordFactory = fakeProviderRecordFactory;

package/dist/translate/executions.d.ts

@@ -1,16 +1,16 @@
 import { Knex } from 'knex';
-import { ExecutionRecord } from '@cumulus/types/api/executions';
+import { ApiExecution, ApiExecutionRecord } from '@cumulus/types/api/executions';
 import { PostgresExecution, PostgresExecutionRecord } from '../types/execution';
 import { ExecutionPgModel } from '../models/execution';
 import { CollectionPgModel } from '../models/collection';
 import { AsyncOperationPgModel } from '../models/async_operation';
-export declare const translatePostgresExecutionToApiExecution: (executionRecord: PostgresExecutionRecord, knex: Knex, collectionPgModel?: CollectionPgModel, asyncOperationPgModel?: AsyncOperationPgModel, executionPgModel?: ExecutionPgModel) => Promise<ExecutionRecord>;
+export declare const translatePostgresExecutionToApiExecution: (executionRecord: PostgresExecutionRecord, knex: Knex, collectionPgModel?: CollectionPgModel, asyncOperationPgModel?: AsyncOperationPgModel, executionPgModel?: ExecutionPgModel) => Promise<ApiExecutionRecord>;
 /**
- * Translate execution record from Dynamo to RDS.
+ * Translate execution record from API to RDS.
  *
- * @param {AWS.DynamoDB.DocumentClient.AttributeMap} dynamoRecord
- *   Source record from DynamoDB
- * @param {AWS.DynamoDB.DocumentClient.AttributeMap} knex
+ * @param {ApiExecution} apiRecord
+ *   Source record from API
+ * @param {Knex} knex
  *   Knex client
  * @param {Object} collectionPgModel
  *   Instance of the collection database model
@@ -20,5 +20,6 @@ export declare const translatePostgresExecutionToApiExecution: (executionRecord:
  *   Instance of the execution database model
  * @returns {PostgresExecutionRecord} - converted Execution
  */
-export declare const translateApiExecutionToPostgresExecution: (dynamoRecord: ExecutionRecord, knex: Knex, collectionPgModel?: CollectionPgModel, asyncOperationPgModel?: AsyncOperationPgModel, executionPgModel?: ExecutionPgModel) => Promise<PostgresExecution>;
+export declare const translateApiExecutionToPostgresExecutionWithoutNilsRemoved: (apiRecord: ApiExecution, knex: Knex, collectionPgModel?: CollectionPgModel, asyncOperationPgModel?: AsyncOperationPgModel, executionPgModel?: ExecutionPgModel) => Promise<PostgresExecution>;
+export declare const translateApiExecutionToPostgresExecution: (apiRecord: ApiExecution, knex: Knex, collectionPgModel?: CollectionPgModel, asyncOperationPgModel?: AsyncOperationPgModel, executionPgModel?: ExecutionPgModel) => Promise<PostgresExecution>;
 //# sourceMappingURL=executions.d.ts.map

package/dist/translate/executions.js

@@ -3,10 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.translateApiExecutionToPostgresExecution = exports.translatePostgresExecutionToApiExecution = void 0;
+exports.translateApiExecutionToPostgresExecution = exports.translateApiExecutionToPostgresExecutionWithoutNilsRemoved = exports.translatePostgresExecutionToApiExecution = void 0;
+const isNil_1 = __importDefault(require("lodash/isNil"));
+const isNull_1 = __importDefault(require("lodash/isNull"));
 const errors_1 = require("@cumulus/errors");
 const logger_1 = __importDefault(require("@cumulus/logger"));
 const util_1 = require("@cumulus/common/util");
+const errors_2 = require("@cumulus/errors");
 const Collections_1 = require("@cumulus/message/Collections");
 const execution_1 = require("../models/execution");
 const collection_1 = require("../models/collection");
@@ -60,11 +63,30 @@ const translatePostgresExecutionToApiExecution = async (executionRecord, knex, c
 };
 exports.translatePostgresExecutionToApiExecution = translatePostgresExecutionToApiExecution;
 /**
- * Translate execution record from Dynamo to RDS.
+ * Validate translation api record doesn't contain invalid null/undefined values based
+ * on PostgresExecution typings.  Throw if invalid nulls detected
  *
- * @param {AWS.DynamoDB.DocumentClient.AttributeMap} dynamoRecord
- *   Source record from DynamoDB
- * @param {AWS.DynamoDB.DocumentClient.AttributeMap} knex
+ * @param {ApiExecution} apiExecution
+ *   Record from api
+ * @returns {undefined}
+ */
+const validateApiToPostgresExecutionObject = (apiExecution) => {
+    if ((0, isNil_1.default)(apiExecution.arn)) {
+        throw new errors_2.ValidationError('arn cannot be undefined on a execution, executions must have a arn and a name');
+    }
+    if ((0, isNil_1.default)(apiExecution.name)) {
+        throw new errors_2.ValidationError('name cannot be undefined on a execution, executions must have a arn and a name');
+    }
+    if ((0, isNull_1.default)(apiExecution.status)) {
+        throw new errors_2.ValidationError('status cannot be null on a execution, executions must have a arn and a name');
+    }
+};
+/**
+ * Translate execution record from API to RDS.
+ *
+ * @param {ApiExecution} apiRecord
+ *   Source record from API
+ * @param {Knex} knex
  *   Knex client
  * @param {Object} collectionPgModel
  *   Instance of the collection database model
@@ -74,34 +96,38 @@ exports.translatePostgresExecutionToApiExecution = translatePostgresExecutionToA
  *   Instance of the execution database model
  * @returns {PostgresExecutionRecord} - converted Execution
  */
-const translateApiExecutionToPostgresExecution = async (dynamoRecord, knex, collectionPgModel = new collection_1.CollectionPgModel(), asyncOperationPgModel = new async_operation_1.AsyncOperationPgModel(), executionPgModel = new execution_1.ExecutionPgModel()) => {
+const translateApiExecutionToPostgresExecutionWithoutNilsRemoved = async (apiRecord, knex, collectionPgModel = new collection_1.CollectionPgModel(), asyncOperationPgModel = new async_operation_1.AsyncOperationPgModel(), executionPgModel = new execution_1.ExecutionPgModel()) => {
     const logger = new logger_1.default({ sender: '@cumulus/db/translate/executions' });
+    validateApiToPostgresExecutionObject(apiRecord);
     // Map old record to new schema.
     const translatedRecord = {
-        async_operation_cumulus_id: (dynamoRecord.asyncOperationId ? await asyncOperationPgModel.getRecordCumulusId(knex, { id: dynamoRecord.asyncOperationId }) : undefined),
-        status: dynamoRecord.status,
-        arn: dynamoRecord.arn,
-        duration: dynamoRecord.duration,
-        error: dynamoRecord.error,
-        tasks: dynamoRecord.tasks,
-        original_payload: dynamoRecord.originalPayload,
-        final_payload: dynamoRecord.finalPayload,
-        workflow_name: dynamoRecord.type,
-        url: dynamoRecord.execution,
-        cumulus_version: dynamoRecord.cumulusVersion,
-        timestamp: dynamoRecord.timestamp ? new Date(dynamoRecord.timestamp) : undefined,
-        created_at: dynamoRecord.createdAt ? new Date(dynamoRecord.createdAt) : undefined,
-        updated_at: dynamoRecord.updatedAt ? new Date(dynamoRecord.updatedAt) : undefined,
+        async_operation_cumulus_id: (apiRecord.asyncOperationId ? await asyncOperationPgModel.getRecordCumulusId(knex, { id: apiRecord.asyncOperationId }) : ((0, isNull_1.default)(apiRecord.asyncOperationId) ? null : undefined)),
+        status: apiRecord.status,
+        arn: apiRecord.arn,
+        duration: apiRecord.duration,
+        error: apiRecord.error,
+        tasks: apiRecord.tasks,
+        original_payload: apiRecord.originalPayload,
+        final_payload: apiRecord.finalPayload,
+        workflow_name: apiRecord.type,
+        url: apiRecord.execution,
+        cumulus_version: apiRecord.cumulusVersion,
+        timestamp: (0, util_1.returnNullOrUndefinedOrDate)(apiRecord.timestamp),
+        created_at: (0, util_1.returnNullOrUndefinedOrDate)(apiRecord.createdAt),
+        updated_at: (0, util_1.returnNullOrUndefinedOrDate)(apiRecord.updatedAt),
     };
-    if (dynamoRecord.collectionId !== undefined) {
-        const { name, version } = (0, Collections_1.deconstructCollectionId)(dynamoRecord.collectionId);
+    if (!(0, isNil_1.default)(apiRecord.collectionId)) {
+        const { name, version } = (0, Collections_1.deconstructCollectionId)(apiRecord.collectionId);
         translatedRecord.collection_cumulus_id = await collectionPgModel.getRecordCumulusId(knex, { name, version });
     }
+    else if ((0, isNull_1.default)(apiRecord.collectionId)) {
+        translatedRecord.collection_cumulus_id = null;
+    }
     // If we have a parentArn, try a lookup in Postgres. If there's a match, set the parent_cumulus_id
-    if (dynamoRecord.parentArn !== undefined) {
+    if (!(0, isNil_1.default)(apiRecord.parentArn)) {
         let parentId;
         try {
-            parentId = await executionPgModel.getRecordCumulusId(knex, { arn: dynamoRecord.parentArn });
+            parentId = await executionPgModel.getRecordCumulusId(knex, { arn: apiRecord.parentArn });
             if (parentId !== undefined) {
                 translatedRecord.parent_cumulus_id = parentId;
             }
@@ -115,7 +141,12 @@ const translateApiExecutionToPostgresExecution = async (dynamoRecord, knex, coll
             }
         }
     }
-    return (0, util_1.removeNilProperties)(translatedRecord);
+    else if ((0, isNull_1.default)(apiRecord.parentArn)) {
+        translatedRecord.parent_cumulus_id = null;
+    }
+    return translatedRecord;
 };
+exports.translateApiExecutionToPostgresExecutionWithoutNilsRemoved = translateApiExecutionToPostgresExecutionWithoutNilsRemoved;
+const translateApiExecutionToPostgresExecution = async (apiRecord, knex, collectionPgModel = new collection_1.CollectionPgModel(), asyncOperationPgModel = new async_operation_1.AsyncOperationPgModel(), executionPgModel = new execution_1.ExecutionPgModel()) => (0, util_1.removeNilProperties)(await (0, exports.translateApiExecutionToPostgresExecutionWithoutNilsRemoved)(apiRecord, knex, collectionPgModel, asyncOperationPgModel, executionPgModel));
 exports.translateApiExecutionToPostgresExecution = translateApiExecutionToPostgresExecution;
 //# sourceMappingURL=executions.js.map

package/dist/translate/granules.js

@@ -81,7 +81,6 @@ const translatePostgresGranuleToApiGranule = async ({ granulePgRecord, collectio
     return apiGranule;
 };
 exports.translatePostgresGranuleToApiGranule = translatePostgresGranuleToApiGranule;
-const returnNullOrUndefinedOrDate = (dateVal) => ((0, isNil_1.default)(dateVal) ? dateVal : new Date(dateVal));
 /**
  * Validate translation request doesn't contain invalid null files based
  * on onPostgresGranule typings.  Throw if invalid nulls detected
@@ -154,15 +153,15 @@ const translateApiGranuleToPostgresGranuleWithoutNilsRemoved = async ({ dynamoRe
         pdr_cumulus_id,
         provider_cumulus_id,
         query_fields: dynamoRecord.queryFields,
-        beginning_date_time: returnNullOrUndefinedOrDate(dynamoRecord.beginningDateTime),
-        ending_date_time: returnNullOrUndefinedOrDate(dynamoRecord.endingDateTime),
-        last_update_date_time: returnNullOrUndefinedOrDate(dynamoRecord.lastUpdateDateTime),
-        processing_end_date_time: returnNullOrUndefinedOrDate(dynamoRecord.processingEndDateTime),
-        processing_start_date_time: returnNullOrUndefinedOrDate(dynamoRecord.processingStartDateTime),
-        production_date_time: returnNullOrUndefinedOrDate(dynamoRecord.productionDateTime),
-        timestamp: returnNullOrUndefinedOrDate(dynamoRecord.timestamp),
-        created_at: returnNullOrUndefinedOrDate(dynamoRecord.createdAt),
-        updated_at: returnNullOrUndefinedOrDate(dynamoRecord.updatedAt),
+        beginning_date_time: (0, util_1.returnNullOrUndefinedOrDate)(dynamoRecord.beginningDateTime),
+        ending_date_time: (0, util_1.returnNullOrUndefinedOrDate)(dynamoRecord.endingDateTime),
+        last_update_date_time: (0, util_1.returnNullOrUndefinedOrDate)(dynamoRecord.lastUpdateDateTime),
+        processing_end_date_time: (0, util_1.returnNullOrUndefinedOrDate)(dynamoRecord.processingEndDateTime),
+        processing_start_date_time: (0, util_1.returnNullOrUndefinedOrDate)(dynamoRecord.processingStartDateTime),
+        production_date_time: (0, util_1.returnNullOrUndefinedOrDate)(dynamoRecord.productionDateTime),
+        timestamp: (0, util_1.returnNullOrUndefinedOrDate)(dynamoRecord.timestamp),
+        created_at: (0, util_1.returnNullOrUndefinedOrDate)(dynamoRecord.createdAt),
+        updated_at: (0, util_1.returnNullOrUndefinedOrDate)(dynamoRecord.updatedAt),
     };
     return granuleRecord;
 };

package/dist/types/execution.d.ts

@@ -1,21 +1,21 @@
 import { ExecutionRecordStatus } from '@cumulus/types/api/executions';
 export interface PostgresExecution {
     arn: string;
-    async_operation_cumulus_id?: number;
-    collection_cumulus_id?: number;
-    created_at?: Date;
-    cumulus_version?: string;
-    duration?: number;
-    error?: object;
-    final_payload?: object;
-    original_payload?: object;
-    parent_cumulus_id?: number;
-    status: ExecutionRecordStatus;
-    tasks?: object;
-    timestamp?: Date;
-    updated_at?: Date;
-    url?: string;
-    workflow_name?: string;
+    async_operation_cumulus_id?: number | null;
+    collection_cumulus_id?: number | null;
+    created_at?: Date | null;
+    cumulus_version?: string | null;
+    duration?: number | null;
+    error?: object | null;
+    final_payload?: object | null;
+    original_payload?: object | null;
+    parent_cumulus_id?: number | null;
+    status?: ExecutionRecordStatus;
+    tasks?: object | null;
+    timestamp?: Date | null;
+    updated_at?: Date | null;
+    url?: string | null;
+    workflow_name?: string | null;
 }
 export interface PostgresExecutionRecord extends PostgresExecution {
     created_at: Date;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/db",
-  "version": "15.0.3",
+  "version": "16.0.0",
   "description": "Utilities for working with the Cumulus DB",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -29,22 +29,22 @@
     "node": ">=16.19.0"
   },
   "dependencies": {
-    "@cumulus/aws-client": "15.0.3",
-    "@cumulus/common": "15.0.3",
-    "@cumulus/errors": "15.0.3",
-    "@cumulus/logger": "15.0.3",
-    "@cumulus/message": "15.0.3",
-    "@cumulus/types": "15.0.3",
+    "@cumulus/aws-client": "16.0.0",
+    "@cumulus/common": "16.0.0",
+    "@cumulus/errors": "16.0.0",
+    "@cumulus/logger": "16.0.0",
+    "@cumulus/message": "16.0.0",
+    "@cumulus/types": "16.0.0",
     "crypto-random-string": "^3.2.0",
     "is-valid-hostname": "1.0.2",
     "knex": "2.4.1",
     "lodash": "^4.17.21",
-    "pg": "^8.3.0",
+    "pg": "~8.10",
     "snake-camel": "^1.0.6",
     "uuid": "8.3.2"
   },
   "devDependencies": {
     "@types/uuid": "^8.0.0"
   },
-  "gitHead": "5fd5febe740ef96f365d1defc7b9f76ae64c9cc0"
+  "gitHead": "f73d94f869ff8c234db26cb0ec939b50b3de1d19"
 }