@cumulus/message 10.1.1 → 11.1.0

package/PDRs.js

@@ -1,6 +1,16 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPdrPercentCompletion = exports.getMessagePdrStats = exports.getMessagePdrFailedExecutions = exports.getMessagePdrCompletedExecutions = exports.getMessagePdrRunningExecutions = exports.getMessagePdrName = exports.getMessagePdrPANMessage = exports.getMessagePdrPANSent = exports.messageHasPdr = exports.getMessagePdr = void 0;
+exports.generatePdrApiRecordFromMessage = exports.getPdrPercentCompletion = exports.getMessagePdrStats = exports.getMessagePdrFailedExecutions = exports.getMessagePdrCompletedExecutions = exports.getMessagePdrRunningExecutions = exports.getMessagePdrName = exports.getMessagePdrPANMessage = exports.getMessagePdrPANSent = exports.messageHasPdr = exports.getMessagePdr = void 0;
+const errors_1 = require("@cumulus/errors");
+const logger_1 = __importDefault(require("@cumulus/logger"));
+const Collections_1 = require("./Collections");
+const Executions_1 = require("./Executions");
+const Providers_1 = require("./Providers");
+const workflows_1 = require("./workflows");
+const logger = new logger_1.default({ sender: '@cumulus/message/PDRs' });
 /**
  * Get the PDR object from a workflow message, if any.
  *
@@ -54,7 +64,7 @@ exports.getMessagePdrName = getMessagePdrName;
 /**
  * Get the number of running executions for a PDR, if any.
  *
- * @param {MessageWithOptionalPdrStats} message - A workflow message
+ * @param {MessageWithOptionalPayloadPdr} message - A workflow message
  * @returns {number} Number of running executions
  *
  * @alias module:PDRs
@@ -64,7 +74,7 @@ exports.getMessagePdrRunningExecutions = getMessagePdrRunningExecutions;
 /**
  * Get the number of completed executions for a PDR, if any.
  *
- * @param {MessageWithOptionalPdrStats} message - A workflow message
+ * @param {MessageWithOptionalPayloadPdr} message - A workflow message
  * @returns {number} Number of completed executions
  *
  * @alias module:PDRs
@@ -74,7 +84,7 @@ exports.getMessagePdrCompletedExecutions = getMessagePdrCompletedExecutions;
 /**
  * Get the number of failed executions for a PDR, if any.
  *
- * @param {MessageWithOptionalPdrStats} message - A workflow message
+ * @param {MessageWithOptionalPayloadPdr} message - A workflow message
  * @returns {number} Number of failed executions
  *
  * @alias module:PDRs
@@ -122,4 +132,63 @@ const getPdrPercentCompletion = (stats) => {
     return progress;
 };
 exports.getPdrPercentCompletion = getPdrPercentCompletion;
+/**
+ * Generate a PDR record for the API from the message.
+ *
+ * @param {MessageWithOptionalPayloadPdr} message - A workflow message object
+ * @param {string} [updatedAt] - Optional updated timestamp to apply to record
+ * @returns {ExecutionRecord} An PDR API record
+ *
+ * @alias module:Executions
+ */
+const generatePdrApiRecordFromMessage = (message, updatedAt = Date.now()) => {
+    const pdr = (0, exports.getMessagePdr)(message);
+    // We got a message with no PDR (OK)
+    if (!pdr) {
+        logger.info('No PDRs to process on the message');
+        return undefined;
+    }
+    // We got a message with a PDR but no name to identify it (Not OK)
+    if (!pdr.name) {
+        throw new errors_1.CumulusMessageError(`Could not find name on PDR object ${JSON.stringify(pdr)}`);
+    }
+    const collectionId = (0, Collections_1.getCollectionIdFromMessage)(message);
+    if (!collectionId) {
+        throw new errors_1.CumulusMessageError('meta.collection required to generate a PDR record');
+    }
+    const providerId = (0, Providers_1.getMessageProviderId)(message);
+    if (!providerId) {
+        throw new errors_1.CumulusMessageError('meta.provider required to generate a PDR record');
+    }
+    const status = (0, workflows_1.getMetaStatus)(message);
+    if (!status) {
+        throw new errors_1.CumulusMessageError('meta.status required to generate a PDR record');
+    }
+    const arn = (0, Executions_1.getMessageExecutionArn)(message);
+    if (!arn) {
+        throw new errors_1.CumulusMessageError('cumulus_meta.state_machine and cumulus_meta.execution_name required to generate a PDR record');
+    }
+    const execution = (0, Executions_1.getExecutionUrlFromArn)(arn);
+    const stats = (0, exports.getMessagePdrStats)(message);
+    const progress = (0, exports.getPdrPercentCompletion)(stats);
+    const now = Date.now();
+    const workflowStartTime = (0, workflows_1.getMessageWorkflowStartTime)(message);
+    const record = {
+        pdrName: pdr.name,
+        collectionId,
+        status,
+        provider: providerId,
+        progress,
+        execution,
+        PANSent: (0, exports.getMessagePdrPANSent)(message),
+        PANmessage: (0, exports.getMessagePdrPANMessage)(message),
+        stats,
+        createdAt: (0, workflows_1.getMessageWorkflowStartTime)(message),
+        timestamp: now,
+        updatedAt,
+        duration: (0, workflows_1.getWorkflowDuration)(workflowStartTime, now),
+    };
+    return record;
+};
+exports.generatePdrApiRecordFromMessage = generatePdrApiRecordFromMessage;
 //# sourceMappingURL=PDRs.js.map

package/PDRs.js.map

@@ -1 +1 @@
-{"version":3,"file":"PDRs.js","sourceRoot":"","sources":["src/PDRs.ts"],"names":[],"mappings":";;;AA8BA;;;;;;;GAOG;AACI,MAAM,aAAa,GAAG,CAC3B,OAAsC,EACrB,EAAE,WAAC,OAAA,MAAA,OAAO,CAAC,OAAO,0CAAE,GAAG,CAAA,EAAA,CAAC;AAF9B,QAAA,aAAa,iBAEiB;AAE3C;;;;;;;GAOG;AACI,MAAM,aAAa,GAAG,CAC3B,OAAsC,EAC7B,EAAE,CAAC,IAAA,qBAAa,EAAC,OAAO,CAAC,KAAK,SAAS,CAAC;AAFtC,QAAA,aAAa,iBAEyB;AAEnD;;;;;;;GAOG;AACI,MAAM,oBAAoB,GAAG,CAClC,OAAsC,EAC7B,EAAE,eAAC,OAAA,MAAA,MAAA,IAAA,qBAAa,EAAC,OAAO,CAAC,0CAAE,OAAO,mCAAI,KAAK,CAAA,EAAA,CAAC;AAF1C,QAAA,oBAAoB,wBAEsB;AAEvD;;;;;;;GAOG;AACI,MAAM,uBAAuB,GAAG,CACrC,OAAsC,EAC9B,EAAE,eAAC,OAAA,MAAA,MAAA,IAAA,qBAAa,EAAC,OAAO,CAAC,0CAAE,UAAU,mCAAI,KAAK,CAAA,EAAA,CAAC;AAF5C,QAAA,uBAAuB,2BAEqB;AAEzD;;;;;;;GAOG;AACI,MAAM,iBAAiB,GAAG,CAC/B,OAAsC,EAClB,EAAE,WAAC,OAAA,MAAA,IAAA,qBAAa,EAAC,OAAO,CAAC,0CAAE,IAAI,CAAA,EAAA,CAAC;AAFzC,QAAA,iBAAiB,qBAEwB;AAEtD;;;;;;;GAOG;AACI,MAAM,8BAA8B,GAAG,CAC5C,OAAoC,EAC5B,EAAE,WAAC,OAAA,CAAC,MAAA,OAAO,CAAC,OAAO,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,MAAM,CAAA,EAAA,CAAC;AAFvC,QAAA,8BAA8B,kCAES;AAEpD;;;;;;;GAOG;AACI,MAAM,gCAAgC,GAAG,CAC9C,OAAoC,EAC5B,EAAE,WAAC,OAAA,CAAC,MAAA,OAAO,CAAC,OAAO,CAAC,SAAS,mCAAI,EAAE,CAAC,CAAC,MAAM,CAAA,EAAA,CAAC;AAFzC,QAAA,gCAAgC,oCAES;AAEtD;;;;;;;GAOG;AACI,MAAM,6BAA6B,GAAG,CAC3C,OAAoC,EAC5B,EAAE,WAAC,OAAA,CAAC,MAAA,OAAO,CAAC,OAAO,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC,MAAM,CAAA,EAAA,CAAC;AAFtC,QAAA,6BAA6B,iCAES;AAEnD;;;;;;;;GAQG;AACI,MAAM,kBAAkB,GAAG,CAChC,OAAoC,EAC1B,EAAE;IACZ,MAAM,UAAU,GAAG,IAAA,sCAA8B,EAAC,OAAO,CAAC,CAAC;IAC3D,MAAM,SAAS,GAAG,IAAA,wCAAgC,EAAC,OAAO,CAAC,CAAC;IAC5D,MAAM,MAAM,GAAG,IAAA,qCAA6B,EAAC,OAAO,CAAC,CAAC;IACtD,MAAM,KAAK,GAAG;QACZ,UAAU;QACV,SAAS;QACT,MAAM;QACN,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,MAAM;KACvC,CAAC;IACF,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAbW,QAAA,kBAAkB,sBAa7B;AAEF;;;;;;;GAOG;AACI,MAAM,uBAAuB,GAAG,CACrC,KAAe,EACP,EAAE;IACV,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,KAAK,CAAC,UAAU,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE;QAC3C,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;KACnE;SAAM,IAAI,KAAK,CAAC,UAAU,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE;QACpD,QAAQ,GAAG,GAAG,CAAC;KAChB;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAVW,QAAA,uBAAuB,2BAUlC"}
+{"version":3,"file":"PDRs.js","sourceRoot":"","sources":["src/PDRs.ts"],"names":[],"mappings":";;;;;;AAAA,4CAEyB;AACzB,6DAAqC;AAIrC,+CAA2D;AAC3D,6CAGsB;AACtB,2CAEqB;AACrB,2CAIqB;AAErB,MAAM,MAAM,GAAG,IAAI,gBAAM,CAAC,EAAE,MAAM,EAAE,uBAAuB,EAAE,CAAC,CAAC;AAwB/D;;;;;;;GAOG;AACI,MAAM,aAAa,GAAG,CAC3B,OAAsC,EACrB,EAAE,WAAC,OAAA,MAAA,OAAO,CAAC,OAAO,0CAAE,GAAG,CAAA,EAAA,CAAC;AAF9B,QAAA,aAAa,iBAEiB;AAE3C;;;;;;;GAOG;AACI,MAAM,aAAa,GAAG,CAC3B,OAAsC,EAC7B,EAAE,CAAC,IAAA,qBAAa,EAAC,OAAO,CAAC,KAAK,SAAS,CAAC;AAFtC,QAAA,aAAa,iBAEyB;AAEnD;;;;;;;GAOG;AACI,MAAM,oBAAoB,GAAG,CAClC,OAAsC,EAC7B,EAAE,eAAC,OAAA,MAAA,MAAA,IAAA,qBAAa,EAAC,OAAO,CAAC,0CAAE,OAAO,mCAAI,KAAK,CAAA,EAAA,CAAC;AAF1C,QAAA,oBAAoB,wBAEsB;AAEvD;;;;;;;GAOG;AACI,MAAM,uBAAuB,GAAG,CACrC,OAAsC,EAC9B,EAAE,eAAC,OAAA,MAAA,MAAA,IAAA,qBAAa,EAAC,OAAO,CAAC,0CAAE,UAAU,mCAAI,KAAK,CAAA,EAAA,CAAC;AAF5C,QAAA,uBAAuB,2BAEqB;AAEzD;;;;;;;GAOG;AACI,MAAM,iBAAiB,GAAG,CAC/B,OAAsC,EAClB,EAAE,WAAC,OAAA,MAAA,IAAA,qBAAa,EAAC,OAAO,CAAC,0CAAE,IAAI,CAAA,EAAA,CAAC;AAFzC,QAAA,iBAAiB,qBAEwB;AAEtD;;;;;;;GAOG;AACI,MAAM,8BAA8B,GAAG,CAC5C,OAAsC,EAC9B,EAAE,WAAC,OAAA,CAAC,MAAA,OAAO,CAAC,OAAO,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,MAAM,CAAA,EAAA,CAAC;AAFvC,QAAA,8BAA8B,kCAES;AAEpD;;;;;;;GAOG;AACI,MAAM,gCAAgC,GAAG,CAC9C,OAAsC,EAC9B,EAAE,WAAC,OAAA,CAAC,MAAA,OAAO,CAAC,OAAO,CAAC,SAAS,mCAAI,EAAE,CAAC,CAAC,MAAM,CAAA,EAAA,CAAC;AAFzC,QAAA,gCAAgC,oCAES;AAEtD;;;;;;;GAOG;AACI,MAAM,6BAA6B,GAAG,CAC3C,OAAsC,EAC9B,EAAE,WAAC,OAAA,CAAC,MAAA,OAAO,CAAC,OAAO,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC,MAAM,CAAA,EAAA,CAAC;AAFtC,QAAA,6BAA6B,iCAES;AAEnD;;;;;;;;GAQG;AACI,MAAM,kBAAkB,GAAG,CAChC,OAAsC,EAC5B,EAAE;IACZ,MAAM,UAAU,GAAG,IAAA,sCAA8B,EAAC,OAAO,CAAC,CAAC;IAC3D,MAAM,SAAS,GAAG,IAAA,wCAAgC,EAAC,OAAO,CAAC,CAAC;IAC5D,MAAM,MAAM,GAAG,IAAA,qCAA6B,EAAC,OAAO,CAAC,CAAC;IACtD,MAAM,KAAK,GAAG;QACZ,UAAU;QACV,SAAS;QACT,MAAM;QACN,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,MAAM;KACvC,CAAC;IACF,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAbW,QAAA,kBAAkB,sBAa7B;AAEF;;;;;;;GAOG;AACI,MAAM,uBAAuB,GAAG,CACrC,KAAe,EACP,EAAE;IACV,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,KAAK,CAAC,UAAU,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE;QAC3C,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;KACnE;SAAM,IAAI,KAAK,CAAC,UAAU,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE;QACpD,QAAQ,GAAG,GAAG,CAAC;KAChB;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAVW,QAAA,uBAAuB,2BAUlC;AAEF;;;;;;;;GAQG;AACI,MAAM,+BAA+B,GAAG,CAC7C,OAAsC,EACtC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,EACF,EAAE;IACtB,MAAM,GAAG,GAAG,IAAA,qBAAa,EAAC,OAAO,CAAC,CAAC;IAEnC,oCAAoC;IACpC,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;QACjD,OAAO,SAAS,CAAC;KAClB;IAED,kEAAkE;IAClE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE;QACb,MAAM,IAAI,4BAAmB,CAAC,qCAAqC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;KAC3F;IAED,MAAM,YAAY,GAAG,IAAA,wCAA0B,EAAC,OAAO,CAAC,CAAC;IACzD,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,4BAAmB,CAAC,mDAAmD,CAAC,CAAC;KACpF;IAED,MAAM,UAAU,GAAG,IAAA,gCAAoB,EAAC,OAAO,CAAC,CAAC;IACjD,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,4BAAmB,CAAC,iDAAiD,CAAC,CAAC;KAClF;IAED,MAAM,MAAM,GAAG,IAAA,yBAAa,EAAC,OAAO,CAAC,CAAC;IACtC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,4BAAmB,CAAC,+CAA+C,CAAC,CAAC;KAChF;IAED,MAAM,GAAG,GAAG,IAAA,mCAAsB,EAAC,OAAO,CAAC,CAAC;IAC5C,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,IAAI,4BAAmB,CAAC,8FAA8F,CAAC,CAAC;KAC/H;IACD,MAAM,SAAS,GAAG,IAAA,mCAAsB,EAAC,GAAG,CAAC,CAAC;IAE9C,MAAM,KAAK,GAAG,IAAA,0BAAkB,EAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,QAAQ,GAAG,IAAA,+BAAuB,EAAC,KAAK,CAAC,CAAC;IAChD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,MAAM,iBAAiB,GAAG,IAAA,uCAA2B,EAAC,OAAO,CAAC,CAAC;IAE/D,MAAM,MAAM,GAAG;QACb,OAAO,EAAE,GAAG,CAAC,IAAI;QACjB,YAAY;QACZ,MAAM;QACN,QAAQ,EAAE,UAAU;QACpB,QAAQ;QACR,SAAS;QACT,OAAO,EAAE,IAAA,4BAAoB,EAAC,OAAO,CAAC;QACtC,UAAU,EAAE,IAAA,+BAAuB,EAAC,OAAO,CAAC;QAC5C,KAAK;QACL,SAAS,EAAE,IAAA,uCAA2B,EAAC,OAAO,CAAC;QAC/C,SAAS,EAAE,GAAG;QACd,SAAS;QACT,QAAQ,EAAE,IAAA,+BAAmB,EAAC,iBAAiB,EAAE,GAAG,CAAC;KACtD,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AA5DW,QAAA,+BAA+B,mCA4D1C"}

package/README.md

@@ -20,6 +20,9 @@ Utilities for building and parsing Cumulus workflow messages.
 <dd><p>Utility functions for generating execution information or parsing execution information
 from a Cumulus message</p>
 </dd>
+<dt><a href="#module_Granules">Granules</a></dt>
+<dd><p>Utility functions for parsing granule information from a Cumulus message</p>
+</dd>
 <dt><a href="#module_Queue">Queue</a></dt>
 <dd><p>Utility functions for parsing queue information from a Cumulus message</p>
 </dd>
@@ -34,7 +37,7 @@ from a Cumulus message</p>
 <dt><a href="#exp_module_Collections--constructCollectionId">constructCollectionId(name, version)</a> ⇒ <code>string</code> ⏏</dt>
 <dd><p>Returns the collection ID.</p>
 </dd>
-<dt><a href="#deconstructCollectionId">deconstructCollectionId(collectionId)</a> ⇒ <code>Object</code></dt>
+<dt><a href="#exp_module_Collections--deconstructCollectionId">deconstructCollectionId(collectionId)</a> ⇒ <code>Object</code> ⏏</dt>
 <dd><p>Returns the name and version of a collection based on
 the collectionId used in elasticsearch indexing</p>
 </dd>
@@ -48,18 +51,6 @@ the collectionId used in elasticsearch indexing</p>
 <dd><p>Unwrap dead letter Cumulus message, which may be wrapped in a
 States cloudwatch event, which is wrapped in an SQS message.</p>
 </dd>
-<dt><a href="#exp_module_Granules--getMessageGranules">getMessageGranules(message)</a> ⇒ <code>Array.&lt;Object&gt;</code> | <code>undefined</code> ⏏</dt>
-<dd><p>Get granules from payload?.granules of a workflow message.</p>
-</dd>
-<dt><a href="#exp_module_Granules--messageHasGranules">messageHasGranules(message)</a> ⇒ <code>boolean</code> ⏏</dt>
-<dd><p>Determine if message has a granules object.</p>
-</dd>
-<dt><a href="#exp_module_Granules--getGranuleStatus">getGranuleStatus(workflowStatus, granule)</a> ⇒ <code>string</code> ⏏</dt>
-<dd><p>Determine the status of a granule.</p>
-</dd>
-<dt><a href="#exp_module_Granules--getGranuleQueryFields">getGranuleQueryFields(message)</a> ⇒ <code>unknown</code> | <code>undefined</code> ⏏</dt>
-<dd><p>Get the query fields of a granule, if any</p>
-</dd>
 <dt><a href="#exp_module_PDRs--getMessagePdr">getMessagePdr(message)</a> ⇒ <code>undefined</code> | <code>Object</code> ⏏</dt>
 <dd><p>Get the PDR object from a workflow message, if any.</p>
 </dd>
@@ -90,6 +81,9 @@ States cloudwatch event, which is wrapped in an SQS message.</p>
 <dt><a href="#exp_module_PDRs--getPdrPercentCompletion">getPdrPercentCompletion(stats)</a> ⇒ <code>number</code> ⏏</dt>
 <dd><p>Get the percent completion of PDR executions</p>
 </dd>
+<dt><a href="#exp_module_Executions--generatePdrApiRecordFromMessage">generatePdrApiRecordFromMessage(message, [updatedAt])</a> ⇒ <code>ExecutionRecord</code> ⏏</dt>
+<dd><p>Generate a PDR record for the API from the message.</p>
+</dd>
 <dt><a href="#exp_module_Providers--getMessageProvider">getMessageProvider(message)</a> ⇒ <code>MessageProvider</code> | <code>string</code> ⏏</dt>
 <dd><p>Get the provider from a workflow message, if any.</p>
 </dd>
@@ -119,6 +113,9 @@ update the status of any granules/PDRs that don&#39;t exist in the initial execu
 input.</p>
 <p>Falls back to overall execution input.</p>
 </dd>
+<dt><a href="#parseException">parseException(exception)</a> ⇒ <code>string</code></dt>
+<dd><p>Ensures that the exception is returned as an object</p>
+</dd>
 <dt><a href="#exp_module_workflows--getMetaStatus">getMetaStatus(message)</a> ⇒ <code>Message.WorkflowStatus</code> | <code>undefined</code> ⏏</dt>
 <dd><p>Get the status of a workflow message, if any.</p>
 </dd>
@@ -192,6 +189,9 @@ const Executions = require('@cumulus/message/Executions');
     * [getMessageCumulusVersion(message)](#exp_module_Executions--getMessageCumulusVersion) ⇒ <code>undefined</code> \| <code>string</code> ⏏
     * [getMessageExecutionOriginalPayload(message)](#exp_module_Executions--getMessageExecutionOriginalPayload) ⇒ <code>unknown</code> \| <code>undefined</code> ⏏
     * [getMessageExecutionFinalPayload(message)](#exp_module_Executions--getMessageExecutionFinalPayload) ⇒ <code>unknown</code> \| <code>undefined</code> ⏏
+    * [generateExecutionApiRecordFromMessage(message, [updatedAt])](#exp_module_Executions--generateExecutionApiRecordFromMessage) ⇒ <code>ExecutionRecord</code> ⏏
+    * _global_
+        * [generatePdrApiRecordFromMessage(message, [updatedAt])](#exp_module_Executions--generatePdrApiRecordFromMessage) ⇒ <code>ExecutionRecord</code> ⏏
 
 <a name="exp_module_Executions--buildExecutionArn"></a>
 
@@ -308,7 +308,7 @@ Get the workflow original payload, if any.
 
 | Param | Type | Description |
 | --- | --- | --- |
-| message | <code>Message.CumulusMessage</code> | A workflow message object |
+| message | <code>MessageWithPayload</code> | A workflow message object |
 
 <a name="exp_module_Executions--getMessageExecutionFinalPayload"></a>
 
@@ -320,7 +320,112 @@ Get the workflow final payload, if any.
 
 | Param | Type | Description |
 | --- | --- | --- |
-| message | <code>Message.CumulusMessage</code> | A workflow message object |
+| message | <code>MessageWithPayload</code> | A workflow message object |
+
+<a name="exp_module_Executions--generateExecutionApiRecordFromMessage"></a>
+
+#### generateExecutionApiRecordFromMessage(message, [updatedAt]) ⇒ <code>ExecutionRecord</code> ⏏
+Generate an execution record for the API from the message.
+
+**Kind**: Exported function  
+**Returns**: <code>ExecutionRecord</code> - An execution API record  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| message | <code>MessageWithPayload</code> | A workflow message object |
+| [updatedAt] | <code>string</code> | Optional updated timestamp to apply to record |
+
+<a name="exp_module_Executions--generatePdrApiRecordFromMessage"></a>
+
+#### generatePdrApiRecordFromMessage(message, [updatedAt]) ⇒ <code>ExecutionRecord</code> ⏏
+Generate a PDR record for the API from the message.
+
+**Kind**: global method of [<code>Executions</code>](#module_Executions)  
+**Returns**: <code>ExecutionRecord</code> - An PDR API record  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| message | <code>MessageWithOptionalPayloadPdr</code> | A workflow message object |
+| [updatedAt] | <code>string</code> | Optional updated timestamp to apply to record |
+
+<a name="module_Granules"></a>
+
+### Granules
+Utility functions for parsing granule information from a Cumulus message
+
+**Example**  
+```js
+const Granules = require('@cumulus/message/Granules');
+```
+
+* [Granules](#module_Granules)
+    * [getMessageGranules(message)](#exp_module_Granules--getMessageGranules) ⇒ <code>Array.&lt;Object&gt;</code> \| <code>undefined</code> ⏏
+    * [messageHasGranules(message)](#exp_module_Granules--messageHasGranules) ⇒ <code>boolean</code> ⏏
+    * [getGranuleStatus(workflowStatus, granule)](#exp_module_Granules--getGranuleStatus) ⇒ <code>string</code> ⏏
+    * [getGranuleQueryFields(message)](#exp_module_Granules--getGranuleQueryFields) ⇒ <code>unknown</code> \| <code>undefined</code> ⏏
+    * [generateGranuleApiRecord(message)](#exp_module_Granules--generateGranuleApiRecord) ⇒ <code>Promise.&lt;ApiGranule&gt;</code> ⏏
+
+<a name="exp_module_Granules--getMessageGranules"></a>
+
+#### getMessageGranules(message) ⇒ <code>Array.&lt;Object&gt;</code> \| <code>undefined</code> ⏏
+Get granules from payload?.granules of a workflow message.
+
+**Kind**: Exported function  
+**Returns**: <code>Array.&lt;Object&gt;</code> \| <code>undefined</code> - An array of granule objects, or
+  undefined if `message.payload.granules` is not set  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| message | <code>MessageWithGranules</code> | A workflow message |
+
+<a name="exp_module_Granules--messageHasGranules"></a>
+
+#### messageHasGranules(message) ⇒ <code>boolean</code> ⏏
+Determine if message has a granules object.
+
+**Kind**: Exported function  
+**Returns**: <code>boolean</code> - true if message has a granules object  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| message | <code>MessageWithOptionalGranules</code> | A workflow message object |
+
+<a name="exp_module_Granules--getGranuleStatus"></a>
+
+#### getGranuleStatus(workflowStatus, granule) ⇒ <code>string</code> ⏏
+Determine the status of a granule.
+
+**Kind**: Exported function  
+**Returns**: <code>string</code> - The granule status  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| workflowStatus | <code>string</code> | The workflow status |
+| granule | <code>MessageGranule</code> | A granule record conforming to the 'api' schema |
+
+<a name="exp_module_Granules--getGranuleQueryFields"></a>
+
+#### getGranuleQueryFields(message) ⇒ <code>unknown</code> \| <code>undefined</code> ⏏
+Get the query fields of a granule, if any
+
+**Kind**: Exported function  
+**Returns**: <code>unknown</code> \| <code>undefined</code> - The granule query fields, if any  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| message | <code>MessageWithGranules</code> | A workflow message |
+
+<a name="exp_module_Granules--generateGranuleApiRecord"></a>
+
+#### generateGranuleApiRecord(message) ⇒ <code>Promise.&lt;ApiGranule&gt;</code> ⏏
+Generate an API granule record
+
+**Kind**: Exported function  
+**Returns**: <code>Promise.&lt;ApiGranule&gt;</code> - The granule API record  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| message | <code>MessageWithGranules</code> | A workflow message |
 
 <a name="module_Queue"></a>
 
@@ -378,19 +483,6 @@ Determine if there is a queue and queue execution limit in the message.
 | --- | --- | --- |
 | message | <code>MessageWithQueueInfo</code> | A workflow message object |
 
-<a name="deconstructCollectionId"></a>
-
-### deconstructCollectionId(collectionId) ⇒ <code>Object</code>
-Returns the name and version of a collection based on
-the collectionId used in elasticsearch indexing
-
-**Kind**: global function  
-**Returns**: <code>Object</code> - name and version as object  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| collectionId | <code>string</code> | collectionId used in elasticsearch index |
-
 <a name="unwrapDeadLetterCumulusMessage"></a>
 
 ### unwrapDeadLetterCumulusMessage(messageBody) ⇒ <code>Object</code>
@@ -451,6 +543,18 @@ Falls back to overall execution input.
 | inputCumulusMessage | <code>Object</code> | Workflow execution input message |
 | getExecutionHistoryFunction | <code>function</code> | Testing override for mock/etc of                                                 StepFunctions.getExecutionHistory |
 
+<a name="parseException"></a>
+
+### parseException(exception) ⇒ <code>string</code>
+Ensures that the exception is returned as an object
+
+**Kind**: global function  
+**Returns**: <code>string</code> - an stringified exception  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| exception | <code>Object</code> \| <code>undefined</code> | the exception |
+
 
 ## About Cumulus
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/message",
-  "version": "10.1.1",
+  "version": "11.1.0",
   "description": "Utilities for building and parsing Cumulus messages",
   "keywords": [
     "GIBS",
@@ -38,11 +38,11 @@
   "author": "Cumulus Authors",
   "license": "Apache-2.0",
   "dependencies": {
-    "@cumulus/aws-client": "10.1.1",
-    "@cumulus/common": "10.1.1",
-    "@cumulus/errors": "10.1.1",
-    "@cumulus/logger": "10.1.1",
-    "@cumulus/types": "10.1.1",
+    "@cumulus/aws-client": "11.1.0",
+    "@cumulus/common": "11.1.0",
+    "@cumulus/errors": "11.1.0",
+    "@cumulus/logger": "11.1.0",
+    "@cumulus/types": "11.1.0",
     "jsonpath-plus": "^3.0.0",
     "lodash": "^4.17.21",
     "uuid": "^8.2.0"
@@ -50,5 +50,5 @@
   "devDependencies": {
     "@types/uuid": "^8.0.0"
   },
-  "gitHead": "b34bda5035263c74c8341b25abfb033226a27387"
+  "gitHead": "a846e319e143684ebc408e35f8b51cc1a7195391"
 }

package/src/Collections.ts

@@ -1,7 +1,8 @@
 'use strict';
 
 import { Message } from '@cumulus/types';
-const collectionIdSeparator = '___';
+
+export const collectionIdSeparator = '___';
 
 /**
  * Utility functions for generating collection information or parsing collection information
@@ -36,6 +37,8 @@ export const constructCollectionId = (name: string, version: string) =>
  *
  * @param {string} collectionId - collectionId used in elasticsearch index
  * @returns {Object} name and version as object
+ *
+ * @alias module:Collections
  */
 export const deconstructCollectionId = (collectionId: string) => {
   let name;

package/src/Executions.ts

@@ -11,9 +11,31 @@
  */
 
 import isString from 'lodash/isString';
+import isNil from 'lodash/isNil';
+import omitBy from 'lodash/omitBy';
+
 import { Message } from '@cumulus/types';
+import { ExecutionRecord } from '@cumulus/types/api/executions';
+
+import {
+  getMessageAsyncOperationId,
+} from './AsyncOperations';
+import {
+  getCollectionIdFromMessage,
+} from './Collections';
+import {
+  getMetaStatus,
+  getMessageWorkflowTasks,
+  getMessageWorkflowStartTime,
+  getMessageWorkflowStopTime,
+  getMessageWorkflowName,
+  getWorkflowDuration,
+} from './workflows';
+import { parseException } from './utils';
 
-import { getMetaStatus } from './workflows';
+interface MessageWithPayload extends Message.CumulusMessage {
+  payload: object
+}
 
 /**
  * Build execution ARN from a state machine ARN and execution name
@@ -152,14 +174,14 @@ export const getMessageCumulusVersion = (
 /**
  * Get the workflow original payload, if any.
  *
- * @param {Message.CumulusMessage} message - A workflow message object
+ * @param {MessageWithPayload} message - A workflow message object
  * @returns {unknown|undefined} The workflow original payload
  *
  * @alias module:Executions
  */
 export const getMessageExecutionOriginalPayload = (
-  message: Message.CumulusMessage
-): unknown | undefined => {
+  message: MessageWithPayload
+) => {
   const status = getMetaStatus(message);
   return status === 'running' ? message.payload : undefined;
 };
@@ -167,14 +189,62 @@ export const getMessageExecutionOriginalPayload = (
 /**
  * Get the workflow final payload, if any.
  *
- * @param {Message.CumulusMessage} message - A workflow message object
+ * @param {MessageWithPayload} message - A workflow message object
  * @returns {unknown|undefined} The workflow final payload
  *
  * @alias module:Executions
  */
 export const getMessageExecutionFinalPayload = (
-  message: Message.CumulusMessage
-): unknown | undefined => {
+  message: MessageWithPayload
+) => {
   const status = getMetaStatus(message);
   return status === 'running' ? undefined : message.payload;
 };
+
+/**
+ * Generate an execution record for the API from the message.
+ *
+ * @param {MessageWithPayload} message - A workflow message object
+ * @param {string} [updatedAt] - Optional updated timestamp to apply to record
+ * @returns {ExecutionRecord} An execution API record
+ *
+ * @alias module:Executions
+ */
+export const generateExecutionApiRecordFromMessage = (
+  message: MessageWithPayload,
+  updatedAt = Date.now()
+): ExecutionRecord => {
+  const arn = getMessageExecutionArn(message);
+  if (isNil(arn)) throw new Error('Unable to determine execution ARN from Cumulus message');
+
+  const status = getMetaStatus(message);
+  if (!status) throw new Error('Unable to determine status from Cumulus message');
+
+  const now = Date.now();
+  const workflowStartTime = getMessageWorkflowStartTime(message);
+  const workflowStopTime = getMessageWorkflowStopTime(message);
+  const collectionId = getCollectionIdFromMessage(message);
+
+  const record: ExecutionRecord = {
+    name: getMessageExecutionName(message),
+    cumulusVersion: getMessageCumulusVersion(message),
+    arn,
+    asyncOperationId: getMessageAsyncOperationId(message),
+    parentArn: getMessageExecutionParentArn(message),
+    execution: getExecutionUrlFromArn(arn),
+    tasks: getMessageWorkflowTasks(message),
+    error: parseException(message.exception),
+    type: getMessageWorkflowName(message),
+    collectionId,
+    status,
+    createdAt: workflowStartTime,
+    timestamp: now,
+    updatedAt,
+    originalPayload: getMessageExecutionOriginalPayload(message),
+    finalPayload: getMessageExecutionFinalPayload(message),
+    duration: getWorkflowDuration(workflowStartTime, workflowStopTime),
+  };
+
+  const updated = <ExecutionRecord>omitBy(record, isNil);
+  return updated;
+};