@cumulus/db 20.1.1 → 20.1.3-alpha.0

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

package/dist/migrations/20250425134823_granules_add_producer_granule_id.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.down = exports.up = void 0;
+const up = async (knex) => {
+    if (!await knex.schema.hasColumn('granules', 'producer_granule_id')) {
+        await knex.schema.table('granules', (table) => {
+            table
+                .text('producer_granule_id')
+                .comment('Producer Granule Id');
+        });
+        await knex('granules').update('producer_granule_id', knex.raw('granule_id'));
+        await knex.schema.table('granules', (table) => {
+            table.text('producer_granule_id').notNullable().alter();
+        });
+    }
+    await knex.raw('CREATE INDEX CONCURRENTLY IF NOT EXISTS granules_producer_granule_id_index ON granules(producer_granule_id)');
+};
+exports.up = up;
+const down = async (knex) => {
+    if (await knex.schema.hasColumn('granules', 'producer_granule_id')) {
+        await knex.schema.table('granules', (table) => {
+            table.dropColumn('producer_granule_id');
+        });
+    }
+};
+exports.down = down;
+exports.config = {
+    transaction: false,
+};
+//# sourceMappingURL=20250425134823_granules_add_producer_granule_id.js.map

package/dist/search/BaseSearch.js

@@ -419,9 +419,11 @@ class BaseSearch {
         const getEstimate = shouldEstimateRowcount
             ? this.getEstimatedRowcount({ knex })
             : undefined;
+        const shouldReturnCountOnly = this.dbQueryParameters.countOnly === true;
         try {
             const [countResult, pgRecords] = await Promise.all([
-                getEstimate || countQuery, searchQuery,
+                getEstimate || countQuery,
+                shouldReturnCountOnly ? [] : searchQuery,
             ]);
             const meta = this._metaTemplate();
             meta.limit = this.dbQueryParameters.limit;

package/dist/search/field-mapping.js

@@ -39,6 +39,9 @@ const granuleMapping = {
     processingStartDateTime: (value) => ({
         processing_start_date_time: value,
     }),
+    producerGranuleId: (value) => ({
+        producer_granule_id: value,
+    }),
     productionDateTime: (value) => ({
         production_date_time: value,
     }),

package/dist/search/queries.js

@@ -22,6 +22,7 @@ const reservedWords = [
     'fields',
     'includeFullRecord',
     'searchContext',
+    'countOnly',
 ];
 /**
  * regexp for matching api query string parameter to query type
@@ -211,7 +212,7 @@ const convert = {
  * @returns db query parameters
  */
 const convertQueryStringToDbQueryParameters = (type, queryStringParameters) => {
-    const { limit, page, prefix, infix, fields, estimateTableRowCount, includeFullRecord, } = queryStringParameters;
+    const { limit, page, prefix, infix, fields, estimateTableRowCount, includeFullRecord, countOnly, } = queryStringParameters;
     const dbQueryParameters = {};
     dbQueryParameters.page = Number.parseInt(page ?? '1', 10);
     if (limit !== 'null') {
@@ -226,6 +227,7 @@ const convertQueryStringToDbQueryParameters = (type, queryStringParameters) => {
         dbQueryParameters.fields = fields.split(',');
     dbQueryParameters.estimateTableRowCount = (estimateTableRowCount === 'true');
     dbQueryParameters.includeFullRecord = (includeFullRecord === 'true');
+    dbQueryParameters.countOnly = (countOnly === 'true');
     dbQueryParameters.sort = convertSort(type, queryStringParameters);
     // remove reserved words (that are not fields)
     const fieldParams = (0, omit_1.default)(queryStringParameters, reservedWords);

package/dist/test-utils.js

@@ -90,6 +90,7 @@ const fakeProviderRecordFactory = (params) => ({
 exports.fakeProviderRecordFactory = fakeProviderRecordFactory;
 const fakeGranuleRecordFactory = (params) => ({
     granule_id: (0, crypto_random_string_1.default)({ length: 5 }),
+    producer_granule_id: (0, crypto_random_string_1.default)({ length: 5 }),
     status: 'completed',
     created_at: new Date(),
     ...params,

package/dist/translate/granules.js

@@ -43,6 +43,7 @@ const translatePostgresGranuleToApiGranuleWithoutDbQuery = ({ granulePgRecord, c
     pdrName: pdr ? pdr.name : undefined,
     processingEndDateTime: granulePgRecord.processing_end_date_time?.toISOString(),
     processingStartDateTime: granulePgRecord.processing_start_date_time?.toISOString(),
+    producerGranuleId: granulePgRecord.producer_granule_id,
     productionDateTime: granulePgRecord.production_date_time?.toISOString(),
     productVolume: granulePgRecord.product_volume,
     provider: providerPgRecord ? providerPgRecord.name : undefined,
@@ -118,8 +119,11 @@ const validateApiToPostgresGranuleObject = (apiGranule) => {
     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, isNil_1.default)(apiGranule.producerGranuleId)) {
+        throw new errors_1.ValidationError('producerGranuleId cannot be undefined on a granule, granules must have a producerGranuleId');
+    }
     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');
+        throw new errors_1.ValidationError('status cannot be null on a granule, granules must have a status');
     }
 };
 /**
@@ -162,6 +166,7 @@ const translateApiGranuleToPostgresGranuleWithoutNilsRemoved = async ({ dynamoRe
         granule_id: dynamoRecord.granuleId,
         status: dynamoRecord.status,
         collection_cumulus_id: await collectionPgModel.getRecordCumulusId(knexOrTransaction, { name, version }),
+        producer_granule_id: dynamoRecord.producerGranuleId,
         published: dynamoRecord.published,
         duration: dynamoRecord.duration,
         time_to_archive: dynamoRecord.timeToArchive,

package/dist/types/granule.d.ts

@@ -4,6 +4,7 @@ export interface PostgresGranuleUniqueColumns {
     collection_cumulus_id: number;
 }
 export interface PostgresGranule extends PostgresGranuleUniqueColumns {
+    producer_granule_id: string;
     status?: GranuleStatus;
     cmr_link?: string | null;
     error?: object | null;
@@ -27,6 +28,7 @@ export interface PostgresGranule extends PostgresGranuleUniqueColumns {
 }
 export interface PostgresGranuleRecord extends Omit<PostgresGranule, 'product_volume'> {
     cumulus_id: number;
+    producer_granule_id: string;
     product_volume?: string;
     created_at: Date;
     updated_at: Date;

package/dist/types/search.d.ts

@@ -1,4 +1,5 @@
 export declare type QueryStringParameters = {
+    countOnly?: string;
     field?: string;
     fields?: string;
     infix?: string;
@@ -25,6 +26,7 @@ export declare type SortType = {
 };
 export declare type DbQueryParameters = {
     collate?: string;
+    countOnly?: boolean;
     fields?: string[];
     infix?: string;
     limit?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/db",
-  "version": "20.1.1",
+  "version": "20.1.3-alpha.0",
   "description": "Utilities for working with the Cumulus DB",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -33,12 +33,12 @@
   },
   "dependencies": {
     "@aws-sdk/client-secrets-manager": "^3.621.0",
-    "@cumulus/aws-client": "20.1.1",
-    "@cumulus/common": "20.1.1",
-    "@cumulus/errors": "20.1.1",
-    "@cumulus/logger": "20.1.1",
-    "@cumulus/message": "20.1.1",
-    "@cumulus/types": "20.1.1",
+    "@cumulus/aws-client": "20.1.3-alpha.0",
+    "@cumulus/common": "20.1.3-alpha.0",
+    "@cumulus/errors": "20.1.3-alpha.0",
+    "@cumulus/logger": "20.1.3-alpha.0",
+    "@cumulus/message": "20.1.3-alpha.0",
+    "@cumulus/types": "20.1.3-alpha.0",
     "crypto-random-string": "^3.2.0",
     "is-valid-hostname": "1.0.2",
     "knex": "2.4.1",
@@ -50,5 +50,5 @@
   "devDependencies": {
     "@types/uuid": "^8.0.0"
   },
-  "gitHead": "dde772911627dd96b944a8eca65fdff388848ec6"
+  "gitHead": "7c70abafba784906805f7fac5c4e8b5e53f51c3b"
 }