@cumulus/db 13.3.3-alpha.1 → 14.0.0

package/dist/index.d.ts

@@ -27,7 +27,7 @@ export { translateApiPdrToPostgresPdr, translatePostgresPdrToApiPdr, } from './t
 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, } from './lib/granule';
+export { getApiGranuleCumulusIds, getApiGranuleExecutionCumulusIds, getGranuleCollectionId, getUniqueGranuleByGranuleId, upsertGranuleWithExecutionJoinRecord, getGranulesByApiPropertiesQuery, getGranulesByGranuleId, } from './lib/granule';
 export { QuerySearchClient, } from './lib/QuerySearchClient';
 export { AsyncOperationPgModel } from './models/async_operation';
 export { BasePgModel } from './models/base';

package/dist/index.js

@@ -24,7 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 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.getGranulesByApiPropertiesQuery = exports.upsertGranuleWithExecutionJoinRecord = exports.getUniqueGranuleByGranuleId = exports.getGranuleCollectionId = exports.getApiGranuleExecutionCumulusIds = 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;
 const path = __importStar(require("path"));
 var knex_1 = require("knex");
 Object.defineProperty(exports, "Knex", { enumerable: true, get: function () { return knex_1.Knex; } });
@@ -101,6 +101,7 @@ Object.defineProperty(exports, "getGranuleCollectionId", { enumerable: true, get
 Object.defineProperty(exports, "getUniqueGranuleByGranuleId", { enumerable: true, get: function () { return granule_1.getUniqueGranuleByGranuleId; } });
 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; } });
 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

@@ -16,7 +16,14 @@ export declare const getGranuleCollectionId: (knexOrTransaction: Knex | Knex.Tra
  *   Granules/executions PG model class instance
  * @returns {Promise<PostgresGranuleRecord[]>}
  */
-export declare const upsertGranuleWithExecutionJoinRecord: (knexTransaction: Knex.Transaction, granule: PostgresGranule, executionCumulusId?: number, granulePgModel?: GranulePgModel, granulesExecutionsPgModel?: GranulesExecutionsPgModel) => Promise<PostgresGranuleRecord[]>;
+export declare const upsertGranuleWithExecutionJoinRecord: ({ knexTransaction, granule, executionCumulusId, granulePgModel, granulesExecutionsPgModel, writeConstraints, }: {
+    knexTransaction: Knex.Transaction;
+    granule: PostgresGranule;
+    executionCumulusId?: number | undefined;
+    granulePgModel?: GranulePgModel | undefined;
+    granulesExecutionsPgModel?: GranulesExecutionsPgModel | undefined;
+    writeConstraints?: boolean | undefined;
+}) => Promise<PostgresGranuleRecord[]>;
 /**
  * Get cumulus IDs for list of granules
  *
@@ -64,7 +71,7 @@ export declare const getApiGranuleExecutionCumulusIds: (knexOrTransaction: Knex
  * @param {Object} searchParams
  * @param {string | Array<string>} [searchParams.collectionIds] - Collection ID
  * @param {string | Array<string>} [searchParams.granuleIds] - array of granule IDs
- * @param {string} [searchParams.providerName] - Provider name
+ * @param {string} [searchParams.providerNames] - Provider names
  * @param {UpdatedAtRange} [searchParams.updatedAtRange] - Date range for updated_at column
  * @param {string} [searchParams.status] - Granule status to search by
  * @param {string | Array<string>} [sortByFields] - Field(s) to sort by
@@ -77,4 +84,12 @@ export declare const getGranulesByApiPropertiesQuery: (knex: Knex, { collectionI
     updatedAtRange?: UpdatedAtRange | undefined;
     status?: string | undefined;
 }, sortByFields?: string | string[]) => Knex.QueryBuilder;
+/**
+ * Get granules from table where granule_id matches provided granuleId
+ *
+ * @param {Knex | Knex.Transaction} knexOrTransaction - DB client or transaction
+ * @param {string} granuleId - Granule ID
+ * @returns {Promise<Array<PostgresGranuleRecord>} The returned list of records
+ */
+export declare const getGranulesByGranuleId: (knexOrTransaction: Knex | Knex.Transaction, granuleId: string) => Promise<Array<PostgresGranuleRecord>>;
 //# sourceMappingURL=granule.d.ts.map

package/dist/lib/granule.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.getGranulesByApiPropertiesQuery = exports.getApiGranuleExecutionCumulusIds = exports.getUniqueGranuleByGranuleId = exports.getApiGranuleCumulusIds = exports.upsertGranuleWithExecutionJoinRecord = exports.getGranuleCollectionId = void 0;
+exports.getGranulesByGranuleId = exports.getGranulesByApiPropertiesQuery = exports.getApiGranuleExecutionCumulusIds = 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"));
@@ -28,8 +28,13 @@ exports.getGranuleCollectionId = getGranuleCollectionId;
  *   Granules/executions PG model class instance
  * @returns {Promise<PostgresGranuleRecord[]>}
  */
-const upsertGranuleWithExecutionJoinRecord = async (knexTransaction, granule, executionCumulusId, granulePgModel = new granule_1.GranulePgModel(), granulesExecutionsPgModel = new granules_executions_1.GranulesExecutionsPgModel()) => {
-    const [pgGranule] = await granulePgModel.upsert(knexTransaction, granule, executionCumulusId);
+const upsertGranuleWithExecutionJoinRecord = async ({ knexTransaction, granule, executionCumulusId, granulePgModel = new granule_1.GranulePgModel(), granulesExecutionsPgModel = new granules_executions_1.GranulesExecutionsPgModel(), writeConstraints = true, }) => {
+    const [pgGranule] = await granulePgModel.upsert({
+        knexOrTrx: knexTransaction,
+        granule: granule,
+        executionCumulusId,
+        writeConstraints,
+    });
     // granuleCumulusId could be undefined if the upsert affected no rows due to its
     // conditional logic. In that case, we assume that the execution history for the
     // granule was already written and return early. Execution history cannot be written
@@ -124,7 +129,7 @@ exports.getApiGranuleExecutionCumulusIds = getApiGranuleExecutionCumulusIds;
  * @param {Object} searchParams
  * @param {string | Array<string>} [searchParams.collectionIds] - Collection ID
  * @param {string | Array<string>} [searchParams.granuleIds] - array of granule IDs
- * @param {string} [searchParams.providerName] - Provider name
+ * @param {string} [searchParams.providerNames] - Provider names
  * @param {UpdatedAtRange} [searchParams.updatedAtRange] - Date range for updated_at column
  * @param {string} [searchParams.status] - Granule status to search by
  * @param {string | Array<string>} [sortByFields] - Field(s) to sort by
@@ -177,4 +182,18 @@ const getGranulesByApiPropertiesQuery = (knex, { collectionIds, granuleIds, prov
         .groupBy(`${providersTable}.cumulus_id`);
 };
 exports.getGranulesByApiPropertiesQuery = getGranulesByApiPropertiesQuery;
+/**
+ * Get granules from table where granule_id matches provided granuleId
+ *
+ * @param {Knex | Knex.Transaction} knexOrTransaction - DB client or transaction
+ * @param {string} granuleId - Granule ID
+ * @returns {Promise<Array<PostgresGranuleRecord>} The returned list of records
+ */
+const getGranulesByGranuleId = async (knexOrTransaction, granuleId) => {
+    const { granules: granulesTable, } = TableNames;
+    const records = await knexOrTransaction(granulesTable)
+        .where({ granule_id: granuleId });
+    return records;
+};
+exports.getGranulesByGranuleId = getGranulesByGranuleId;
 //# sourceMappingURL=granule.js.map

package/dist/models/granule.d.ts

@@ -46,7 +46,13 @@ export default class GranulePgModel extends BasePgModel<PostgresGranule, Postgre
         _intersectProps: {};
         _unionProps: never;
     }[]>;
-    upsert(knexOrTrx: Knex | Knex.Transaction, granule: PostgresGranule, executionCumulusId?: number, executionPgModel?: ExecutionPgModel): Promise<any[]>;
+    upsert({ knexOrTrx, granule, executionCumulusId, executionPgModel, writeConstraints, }: {
+        knexOrTrx: Knex | Knex.Transaction;
+        granule: PostgresGranule;
+        executionCumulusId?: number;
+        executionPgModel?: ExecutionPgModel;
+        writeConstraints: boolean;
+    }): Promise<any[]>;
     /**
      * Get granules from the granule cumulus_id
      *

package/dist/models/granule.js

@@ -69,19 +69,19 @@ class GranulePgModel extends base_1.BasePgModel {
         return super.get(knexOrTransaction, params);
     }
     _buildExclusionClause(executionPgModel, executionCumulusId, knexOrTrx, status) {
+        // if granule is queued, search for existing execution entry and
+        // don't allow queued update in case of existing execution entry
         const queryBuilder = executionPgModel.queryBuilderSearch(knexOrTrx, {
             cumulus_id: executionCumulusId,
         });
+        // if granule is running, make sure the execution doesn't exist in a *completed* status
         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)}`);
-        }
-        if (granule.status === 'running' || granule.status === 'queued') {
+    async upsert({ knexOrTrx, granule, executionCumulusId, executionPgModel = new execution_1.ExecutionPgModel(), writeConstraints = true, }) {
+        if (writeConstraints && (granule.status === 'running' || granule.status === 'queued')) {
             const upsertQuery = knexOrTrx(this.tableName)
                 .insert(granule)
                 .onConflict(['granule_id', 'collection_cumulus_id'])
@@ -90,10 +90,15 @@ class GranulePgModel extends base_1.BasePgModel {
                 timestamp: granule.timestamp,
                 updated_at: granule.updated_at,
                 created_at: granule.created_at,
-            })
-                .where(knexOrTrx.raw(`${this.tableName}.created_at <= to_timestamp(${(0, timestamp_1.translateDateToUTC)(granule.created_at)})`));
+            });
+            // If upsert called with optional write constraints
+            if (!granule.created_at) {
+                throw new Error(`Granule upsert called with write constraints but no createdAt set: ${JSON.stringify(granule)}`);
+            }
+            upsertQuery.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 OR a queued granule from reingest
+            // OR a patch API request
             if (executionCumulusId) {
                 const exclusionClause = this._buildExclusionClause(executionPgModel, executionCumulusId, knexOrTrx, granule.status);
                 // Only do the upsert if there is no execution that matches the exclusionClause
@@ -105,12 +110,18 @@ class GranulePgModel extends base_1.BasePgModel {
             upsertQuery.returning('*');
             return await upsertQuery;
         }
-        return await knexOrTrx(this.tableName)
+        const upsertQuery = knexOrTrx(this.tableName)
             .insert(granule)
             .onConflict(['granule_id', 'collection_cumulus_id'])
-            .merge()
-            .where(knexOrTrx.raw(`${this.tableName}.created_at <= to_timestamp(${(0, timestamp_1.translateDateToUTC)(granule.created_at)})`))
-            .returning('*');
+            .merge();
+        if (writeConstraints) {
+            if (!granule.created_at) {
+                throw new Error(`Granule upsert called with write constraints but no created_at set: ${JSON.stringify(granule)}`);
+            }
+            upsertQuery.where(knexOrTrx.raw(`${this.tableName}.created_at <= to_timestamp(${(0, timestamp_1.translateDateToUTC)(granule.created_at)})`));
+        }
+        upsertQuery.returning('*');
+        return await upsertQuery;
     }
     /**
      * Get granules from the granule cumulus_id

package/dist/translate/granules.d.ts

@@ -1,5 +1,5 @@
 import { Knex } from 'knex';
-import { ApiGranule } from '@cumulus/types/api/granules';
+import { ApiGranule, ApiGranuleRecord } from '@cumulus/types/api/granules';
 import { CollectionPgModel } from '../models/collection';
 import { PdrPgModel } from '../models/pdr';
 import { ProviderPgModel } from '../models/provider';
@@ -31,22 +31,22 @@ export declare const translatePostgresGranuleToApiGranule: ({ granulePgRecord, c
     pdrPgModel?: PdrPgModel | undefined;
     providerPgModel?: ProviderPgModel | undefined;
     filePgModel?: FilePgModel | undefined;
-}) => Promise<ApiGranule>;
+}) => Promise<ApiGranuleRecord>;
 /**
  * Generate a Postgres granule record from a DynamoDB record.
  *
  * @param {Object} params
- * @param {AWS.DynamoDB.DocumentClient.AttributeMap} params.dynamoRecord
+ * @param {ApiGranule} params.dynamoRecord
  *   Record from DynamoDB
  * @param {Knex | Knex.Transaction} params.knexOrTransaction
  *   Knex client for reading from RDS database
- * @param {Object} params.collectionPgModel - Instance of the collection database model
- * @param {Object} params.pdrPgModel - Instance of the pdr database model
- * @param {Object} params.providerPgModel - Instance of the provider database model
- * @returns {Object} A granule PG record
+ * @param {CollectionPgModel} params.collectionPgModel - Instance of the collection database model
+ * @param {PdrPgModel} params.pdrPgModel - Instance of the pdr database model
+ * @param {ProviderPgModel} params.providerPgModel - Instance of the provider database model
+ * @returns {PostgresGranule} A granule PG record
  */
 export declare const translateApiGranuleToPostgresGranuleWithoutNilsRemoved: ({ dynamoRecord, knexOrTransaction, collectionPgModel, pdrPgModel, providerPgModel, }: {
-    dynamoRecord: AWS.DynamoDB.DocumentClient.AttributeMap;
+    dynamoRecord: ApiGranule;
     knexOrTransaction: Knex | Knex.Transaction;
     collectionPgModel?: CollectionPgModel | undefined;
     pdrPgModel?: PdrPgModel | undefined;
@@ -57,17 +57,17 @@ export declare const translateApiGranuleToPostgresGranuleWithoutNilsRemoved: ({
  *   any null/undefined properties.
  *
  * @param {Object} params
- * @param {AWS.DynamoDB.DocumentClient.AttributeMap} params.dynamoRecord
+ * @param {ApiGranule} params.dynamoRecord
  *   Record from DynamoDB
  * @param {Knex | Knex.Transaction} params.knexOrTransaction
  *   Knex client for reading from RDS database
- * @param {Object} params.collectionPgModel - Instance of the collection database model
- * @param {Object} params.pdrPgModel - Instance of the pdr database model
- * @param {Object} params.providerPgModel - Instance of the provider database model
- * @returns {Object} A granule PG record with null/undefined properties removed
+ * @param {CollectionPgModel} params.collectionPgModel - Instance of the collection database model
+ * @param {PdrPgModel} params.pdrPgModel - Instance of the pdr database model
+ * @param {ProviderPgModel} params.providerPgModel - Instance of the provider database model
+ * @returns {PostgresGranule} A granule PG record with null/undefined properties removed
  */
 export declare const translateApiGranuleToPostgresGranule: ({ dynamoRecord, knexOrTransaction, collectionPgModel, pdrPgModel, providerPgModel, }: {
-    dynamoRecord: AWS.DynamoDB.DocumentClient.AttributeMap;
+    dynamoRecord: ApiGranule;
     knexOrTransaction: Knex | Knex.Transaction;
     collectionPgModel?: CollectionPgModel | undefined;
     pdrPgModel?: PdrPgModel | undefined;

package/dist/translate/granules.js

@@ -1,9 +1,14 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.translatePostgresGranuleResultToApiGranule = exports.translateApiGranuleToPostgresGranule = exports.translateApiGranuleToPostgresGranuleWithoutNilsRemoved = exports.translatePostgresGranuleToApiGranule = void 0;
 const Collections_1 = require("@cumulus/message/Collections");
 const util_1 = require("@cumulus/common/util");
 const errors_1 = require("@cumulus/errors");
+const isNil_1 = __importDefault(require("lodash/isNil"));
+const isNull_1 = __importDefault(require("lodash/isNull"));
 const collection_1 = require("../models/collection");
 const pdr_1 = require("../models/pdr");
 const provider_1 = require("../models/provider");
@@ -57,7 +62,7 @@ const translatePostgresGranuleToApiGranule = async ({ granulePgRecord, collectio
         endingDateTime: (_c = granulePgRecord.ending_date_time) === null || _c === void 0 ? void 0 : _c.toISOString(),
         error: granulePgRecord.error,
         execution: executionUrls[0] ? executionUrls[0].url : undefined,
-        files: files.length > 0 ? files.map((file) => (0, file_2.translatePostgresFileToApiFile)(file)) : 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(),
         pdrName: pdr ? pdr.name : undefined,
@@ -77,21 +82,63 @@ 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
+ *
+ * @param {Object} params
+ * @param {ApiGranule} apiGranule
+ *   Record from DynamoDB
+ * @returns {undefined}
+ */
+const validateApiToPostgresGranuleObject = (apiGranule) => {
+    if ((0, isNil_1.default)(apiGranule.collectionId)) {
+        throw new errors_1.ValidationError('collectionId cannot be undefined on a granule, granules must have a collection and a granule ID');
+    }
+    if ((0, isNil_1.default)(apiGranule.granuleId)) {
+        throw new errors_1.ValidationError('granuleId cannot be undefined on a granule, granules must have a collection and a granule ID');
+    }
+    if ((0, isNull_1.default)(apiGranule.status)) {
+        throw new errors_1.ValidationError('status cannot be null on a granule, granules must have a collection and a granule ID');
+    }
+};
 /**
  * Generate a Postgres granule record from a DynamoDB record.
  *
  * @param {Object} params
- * @param {AWS.DynamoDB.DocumentClient.AttributeMap} params.dynamoRecord
+ * @param {ApiGranule} params.dynamoRecord
  *   Record from DynamoDB
  * @param {Knex | Knex.Transaction} params.knexOrTransaction
  *   Knex client for reading from RDS database
- * @param {Object} params.collectionPgModel - Instance of the collection database model
- * @param {Object} params.pdrPgModel - Instance of the pdr database model
- * @param {Object} params.providerPgModel - Instance of the provider database model
- * @returns {Object} A granule PG record
+ * @param {CollectionPgModel} params.collectionPgModel - Instance of the collection database model
+ * @param {PdrPgModel} params.pdrPgModel - Instance of the pdr database model
+ * @param {ProviderPgModel} params.providerPgModel - Instance of the provider database model
+ * @returns {PostgresGranule} A granule PG record
  */
 const translateApiGranuleToPostgresGranuleWithoutNilsRemoved = async ({ dynamoRecord, knexOrTransaction, collectionPgModel = new collection_1.CollectionPgModel(), pdrPgModel = new pdr_1.PdrPgModel(), providerPgModel = new provider_1.ProviderPgModel(), }) => {
+    // Invalid Null values should be validated as the primary use in Core
+    // is the non-typescripted API package.
+    validateApiToPostgresGranuleObject(dynamoRecord);
     const { name, version } = (0, Collections_1.deconstructCollectionId)(dynamoRecord.collectionId);
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    let pdr_cumulus_id;
+    if ((0, isNil_1.default)(dynamoRecord.pdrName)) {
+        pdr_cumulus_id = dynamoRecord.pdrName;
+    }
+    else {
+        pdr_cumulus_id = await pdrPgModel.getRecordCumulusId(knexOrTransaction, {
+            name: dynamoRecord.pdrName,
+        });
+    }
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    let provider_cumulus_id;
+    if ((0, isNil_1.default)(dynamoRecord.provider)) {
+        provider_cumulus_id = dynamoRecord.provider;
+    }
+    else {
+        provider_cumulus_id = await providerPgModel.getRecordCumulusId(knexOrTransaction, { name: dynamoRecord.provider });
+    }
     const granuleRecord = {
         granule_id: dynamoRecord.granuleId,
         status: dynamoRecord.status,
@@ -100,30 +147,23 @@ const translateApiGranuleToPostgresGranuleWithoutNilsRemoved = async ({ dynamoRe
         duration: dynamoRecord.duration,
         time_to_archive: dynamoRecord.timeToArchive,
         time_to_process: dynamoRecord.timeToPreprocess,
-        product_volume: dynamoRecord.productVolume,
+        product_volume: (0, isNil_1.default)(dynamoRecord.productVolume)
+            ? dynamoRecord.productVolume
+            : dynamoRecord.productVolume,
         error: dynamoRecord.error,
         cmr_link: dynamoRecord.cmrLink,
-        pdr_cumulus_id: dynamoRecord.pdrName
-            ? await pdrPgModel.getRecordCumulusId(knexOrTransaction, { name: dynamoRecord.pdrName })
-            : undefined,
-        provider_cumulus_id: dynamoRecord.provider ? await providerPgModel.getRecordCumulusId(knexOrTransaction, { name: dynamoRecord.provider }) : undefined,
+        pdr_cumulus_id,
+        provider_cumulus_id,
         query_fields: dynamoRecord.queryFields,
-        beginning_date_time: dynamoRecord.beginningDateTime
-            ? new Date(dynamoRecord.beginningDateTime) : undefined,
-        ending_date_time: dynamoRecord.endingDateTime
-            ? new Date(dynamoRecord.endingDateTime) : undefined,
-        last_update_date_time: dynamoRecord.lastUpdateDateTime
-            ? new Date(dynamoRecord.lastUpdateDateTime) : undefined,
-        processing_end_date_time: dynamoRecord.processingEndDateTime
-            ? new Date(dynamoRecord.processingEndDateTime) : undefined,
-        processing_start_date_time: dynamoRecord.processingStartDateTime
-            ? new Date(dynamoRecord.processingStartDateTime) : undefined,
-        production_date_time: dynamoRecord.productionDateTime
-            ? new Date(dynamoRecord.productionDateTime) : undefined,
-        timestamp: dynamoRecord.timestamp
-            ? new Date(dynamoRecord.timestamp) : undefined,
-        created_at: new Date(dynamoRecord.createdAt),
-        updated_at: new Date(dynamoRecord.updatedAt),
+        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),
     };
     return granuleRecord;
 };
@@ -133,14 +173,14 @@ exports.translateApiGranuleToPostgresGranuleWithoutNilsRemoved = translateApiGra
  *   any null/undefined properties.
  *
  * @param {Object} params
- * @param {AWS.DynamoDB.DocumentClient.AttributeMap} params.dynamoRecord
+ * @param {ApiGranule} params.dynamoRecord
  *   Record from DynamoDB
  * @param {Knex | Knex.Transaction} params.knexOrTransaction
  *   Knex client for reading from RDS database
- * @param {Object} params.collectionPgModel - Instance of the collection database model
- * @param {Object} params.pdrPgModel - Instance of the pdr database model
- * @param {Object} params.providerPgModel - Instance of the provider database model
- * @returns {Object} A granule PG record with null/undefined properties removed
+ * @param {CollectionPgModel} params.collectionPgModel - Instance of the collection database model
+ * @param {PdrPgModel} params.pdrPgModel - Instance of the pdr database model
+ * @param {ProviderPgModel} params.providerPgModel - Instance of the provider database model
+ * @returns {PostgresGranule} A granule PG record with null/undefined properties removed
  */
 const translateApiGranuleToPostgresGranule = async ({ dynamoRecord, knexOrTransaction, collectionPgModel = new collection_1.CollectionPgModel(), pdrPgModel = new pdr_1.PdrPgModel(), providerPgModel = new provider_1.ProviderPgModel(), }) => (0, util_1.removeNilProperties)(await (0, exports.translateApiGranuleToPostgresGranuleWithoutNilsRemoved)({
     dynamoRecord,

package/dist/types/granule.d.ts

@@ -1,33 +1,35 @@
+export declare type GranuleStatus = 'completed' | 'failed' | 'running' | 'queued';
 export interface PostgresGranuleUniqueColumns {
     granule_id: string;
     collection_cumulus_id: number;
 }
 export interface PostgresGranule extends PostgresGranuleUniqueColumns {
-    status: string;
-    cmr_link?: string;
-    error?: object;
-    published?: boolean;
-    duration?: number;
-    product_volume?: number;
-    time_to_process?: number;
-    time_to_archive?: number;
-    provider_cumulus_id?: number;
-    pdr_cumulus_id?: number;
-    created_at?: Date;
-    updated_at?: Date;
-    timestamp?: Date;
-    beginning_date_time?: Date;
-    ending_date_time?: Date;
-    production_date_time?: Date;
-    last_update_date_time?: Date;
-    processing_start_date_time?: Date;
-    processing_end_date_time?: Date;
-    query_fields?: unknown;
+    status?: GranuleStatus;
+    cmr_link?: string | null;
+    error?: object | null;
+    published?: boolean | null;
+    duration?: number | null;
+    product_volume?: string | null;
+    time_to_process?: number | null;
+    time_to_archive?: number | null;
+    provider_cumulus_id?: number | null;
+    pdr_cumulus_id?: number | null;
+    created_at?: Date | null;
+    updated_at?: Date | null;
+    timestamp?: Date | null;
+    beginning_date_time?: Date | null;
+    ending_date_time?: Date | null;
+    production_date_time?: Date | null;
+    last_update_date_time?: Date | null;
+    processing_start_date_time?: Date | null;
+    processing_end_date_time?: Date | null;
+    query_fields?: unknown | null;
 }
 export interface PostgresGranuleRecord extends Omit<PostgresGranule, 'product_volume'> {
     cumulus_id: number;
     product_volume?: string;
     created_at: Date;
     updated_at: Date;
+    status: GranuleStatus;
 }
 //# sourceMappingURL=granule.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/db",
-  "version": "13.3.3-alpha.1",
+  "version": "14.0.0",
   "description": "Utilities for working with the Cumulus DB",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -29,12 +29,12 @@
     "node": ">=14.19.1"
   },
   "dependencies": {
-    "@cumulus/aws-client": "13.3.3-alpha.1",
-    "@cumulus/common": "13.3.3-alpha.1",
-    "@cumulus/errors": "13.3.3-alpha.1",
-    "@cumulus/logger": "13.3.3-alpha.1",
-    "@cumulus/message": "13.3.3-alpha.1",
-    "@cumulus/types": "13.3.3-alpha.1",
+    "@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",
     "crypto-random-string": "^3.2.0",
     "is-valid-hostname": "1.0.2",
     "knex": "0.95.15",
@@ -46,5 +46,5 @@
   "devDependencies": {
     "@types/uuid": "^8.0.0"
   },
-  "gitHead": "090ed401e9e31ba52c070e4a5ab5125aedf90396"
+  "gitHead": "bc0cd0857e007b64e4e8809f7de16a4aeb1e6840"
 }