@cumulus/message 10.0.0 → 10.1.1-alpha.0

package/PDRs.d.ts

@@ -1,4 +1,5 @@
 import { Message } from '@cumulus/types';
+import { ApiPdr } from '@cumulus/types/api/pdrs';
 interface PDR {
     name: string;
     PANSent: boolean;
@@ -7,11 +8,6 @@ interface PDR {
 interface MessageWithOptionalPayloadPdr extends Message.CumulusMessage {
     payload: {
         pdr?: PDR;
-    };
-}
-interface MessageWithOptionalPdrStats extends Message.CumulusMessage {
-    payload: {
-        pdr: PDR;
         failed?: unknown[];
         running?: unknown[];
         completed?: unknown[];
@@ -71,30 +67,30 @@ export declare const getMessagePdrName: (message: MessageWithOptionalPayloadPdr)
 /**
  * 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
  */
-export declare const getMessagePdrRunningExecutions: (message: MessageWithOptionalPdrStats) => number;
+export declare const getMessagePdrRunningExecutions: (message: MessageWithOptionalPayloadPdr) => number;
 /**
  * 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
  */
-export declare const getMessagePdrCompletedExecutions: (message: MessageWithOptionalPdrStats) => number;
+export declare const getMessagePdrCompletedExecutions: (message: MessageWithOptionalPayloadPdr) => number;
 /**
  * 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
  */
-export declare const getMessagePdrFailedExecutions: (message: MessageWithOptionalPdrStats) => number;
+export declare const getMessagePdrFailedExecutions: (message: MessageWithOptionalPayloadPdr) => number;
 /**
  * Get the PDR stats from a workflow message, if any.
  *
@@ -104,7 +100,7 @@ export declare const getMessagePdrFailedExecutions: (message: MessageWithOptiona
  *
  * @alias module:PDRs
  */
-export declare const getMessagePdrStats: (message: MessageWithOptionalPdrStats) => PdrStats;
+export declare const getMessagePdrStats: (message: MessageWithOptionalPayloadPdr) => PdrStats;
 /**
  * Get the percent completion of PDR executions
  *
@@ -114,5 +110,15 @@ export declare const getMessagePdrStats: (message: MessageWithOptionalPdrStats)
  * @alias module:PDRs
  */
 export declare const getPdrPercentCompletion: (stats: PdrStats) => number;
+/**
+ * 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
+ */
+export declare const generatePdrApiRecordFromMessage: (message: MessageWithOptionalPayloadPdr, updatedAt?: number) => ApiPdr | undefined;
 export {};
 //# sourceMappingURL=PDRs.d.ts.map

package/PDRs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PDRs.d.ts","sourceRoot":"","sources":["src/PDRs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAEzC,UAAU,GAAG;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,UAAU,6BAA8B,SAAQ,OAAO,CAAC,cAAc;IACpE,OAAO,EAAE;QACP,GAAG,CAAC,EAAE,GAAG,CAAA;KACV,CAAA;CACF;AAED,UAAU,2BAA4B,SAAQ,OAAO,CAAC,cAAc;IAClE,OAAO,EAAE;QACP,GAAG,EAAE,GAAG,CAAA;QACR,MAAM,CAAC,EAAE,OAAO,EAAE,CAAA;QAClB,OAAO,CAAC,EAAE,OAAO,EAAE,CAAA;QACnB,SAAS,CAAC,EAAE,OAAO,EAAE,CAAA;KACtB,CAAA;CACF;AAED,UAAU,QAAQ;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,YACf,6BAA6B,KACrC,GAAG,GAAG,SAAiC,CAAC;AAE3C;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,YACf,6BAA6B,KACrC,OAA+C,CAAC;AAEnD;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,YACtB,6BAA6B,KACrC,OAAmD,CAAC;AAEvD;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,YACzB,6BAA6B,KACrC,MAAqD,CAAC;AAEzD;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,YACnB,6BAA6B,KACrC,MAAM,GAAG,SAAyC,CAAC;AAEtD;;;;;;;GAOG;AACH,eAAO,MAAM,8BAA8B,YAChC,2BAA2B,KACnC,MAAgD,CAAC;AAEpD;;;;;;;GAOG;AACH,eAAO,MAAM,gCAAgC,YAClC,2BAA2B,KACnC,MAAkD,CAAC;AAEtD;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B,YAC/B,2BAA2B,KACnC,MAA+C,CAAC;AAEnD;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,YACpB,2BAA2B,KACnC,QAWF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,UAC3B,QAAQ,KACd,MAQF,CAAC"}
+{"version":3,"file":"PDRs.d.ts","sourceRoot":"","sources":["src/PDRs.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAkBjD,UAAU,GAAG;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,UAAU,6BAA8B,SAAQ,OAAO,CAAC,cAAc;IACpE,OAAO,EAAE;QACP,GAAG,CAAC,EAAE,GAAG,CAAA;QACT,MAAM,CAAC,EAAE,OAAO,EAAE,CAAA;QAClB,OAAO,CAAC,EAAE,OAAO,EAAE,CAAA;QACnB,SAAS,CAAC,EAAE,OAAO,EAAE,CAAA;KACtB,CAAA;CACF;AAED,UAAU,QAAQ;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,YACf,6BAA6B,KACrC,GAAG,GAAG,SAAiC,CAAC;AAE3C;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,YACf,6BAA6B,KACrC,OAA+C,CAAC;AAEnD;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,YACtB,6BAA6B,KACrC,OAAmD,CAAC;AAEvD;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,YACzB,6BAA6B,KACrC,MAAqD,CAAC;AAEzD;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,YACnB,6BAA6B,KACrC,MAAM,GAAG,SAAyC,CAAC;AAEtD;;;;;;;GAOG;AACH,eAAO,MAAM,8BAA8B,YAChC,6BAA6B,KACrC,MAAgD,CAAC;AAEpD;;;;;;;GAOG;AACH,eAAO,MAAM,gCAAgC,YAClC,6BAA6B,KACrC,MAAkD,CAAC;AAEtD;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B,YAC/B,6BAA6B,KACrC,MAA+C,CAAC;AAEnD;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,YACpB,6BAA6B,KACrC,QAWF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,UAC3B,QAAQ,KACd,MAQF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,+BAA+B,YACjC,6BAA6B,yBAErC,MAAM,GAAG,SAyDX,CAAC"}

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/StepFunctions.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Utility functions for working with AWS Step Function events/messages
+ * @module StepFunctions
+ *
+ * @example
+ * const StepFunctions = require('@cumulus/message/StepFunctions');
+ */
+import { EventBridgeEvent } from 'aws-lambda';
+import { getExecutionHistory } from '@cumulus/aws-client/StepFunctions';
 import { Message } from '@cumulus/types';
 /**
  * Given a Step Function event, replace specified key in event with contents
@@ -25,4 +34,51 @@ export declare const pullStepFunctionEvent: (event: {
  * @alias module:StepFunctions
  */
 export declare const parseStepMessage: (stepMessage: Message.CMAMessage, stepName: string) => Promise<Message.CumulusMessage>;
+/**
+ * Searches the Execution step History for the TaskStateEntered pertaining to
+ * the failed task Id.  HistoryEvent ids are numbered sequentially, starting at
+ * one.
+*
+ * @param {HistoryEvent[]} events - Step Function events array
+ * @param {HistoryEvent} failedStepEvent - Step Function's failed event.
+ * @returns {string} name of the current stepfunction task or 'UnknownFailedStepName'.
+ */
+export declare const getFailedStepName: (events: AWS.StepFunctions.HistoryEvent[], failedStepEvent: {
+    id: number;
+}) => string;
+/**
+ * Finds all failed execution events and returns the last one in the list.
+ *
+ * @param {Array<HistoryEventList>} events - array of AWS Stepfunction execution HistoryEvents
+ * @returns {HistoryEvent|[]} - the last lambda or activity that failed in the
+ * event array, or an empty array.
+ */
+export declare const lastFailedEventStep: (events: AWS.StepFunctions.HistoryEvent[]) => AWS.StepFunctions.HistoryEvent | undefined;
+/**
+ * Get message to use for publishing failed execution notifications.
+ *
+ * Try to get the input to the last failed step in the execution so we can
+ * update the status of any granules/PDRs that don't exist in the initial execution
+ * input.
+ *
+ * Falls back to overall execution input.
+ *
+ * @param {Object} inputCumulusMessage - Workflow execution input message
+ * @param {Function} getExecutionHistoryFunction - Testing override for mock/etc of
+ *                                                 StepFunctions.getExecutionHistory
+ * @returns {Object} - CumulusMessage Execution step message or execution input message
+ */
+export declare const getFailedExecutionMessage: (inputCumulusMessage: Message.CumulusMessage, getExecutionHistoryFunction?: typeof getExecutionHistory) => Promise<Message.CumulusMessage | {
+    exception: {
+        failedExecutionStepName: string;
+        error?: string | undefined;
+        cause?: string | undefined;
+    };
+    cumulus_meta: Message.CumulusMeta;
+    meta: Message.Meta;
+    payload: unknown;
+}>;
+export declare const getCumulusMessageFromExecutionEvent: (executionEvent: EventBridgeEvent<"Step Functions Execution Status Change", {
+    [key: string]: string;
+}>) => Promise<Message.CumulusMessage>;
 //# sourceMappingURL=StepFunctions.d.ts.map

package/StepFunctions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StepFunctions.d.ts","sourceRoot":"","sources":["src/StepFunctions.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAMzC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,UACzB;IACL,OAAO,CAAC,EAAE,QAAQ,aAAa,CAAA;CAChC,KACA,QAAQ,OAAO,CAyBjB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,gBACd,QAAQ,UAAU,YACrB,MAAM,oCAkBjB,CAAC"}
+{"version":3,"file":"StepFunctions.d.ts","sourceRoot":"","sources":["src/StepFunctions.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAK9C,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAExE,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AA6BzC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,UACzB;IACL,OAAO,CAAC,EAAE,QAAQ,aAAa,CAAA;CAChC,KACA,QAAQ,OAAO,CAyBjB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,gBACd,QAAQ,UAAU,YACrB,MAAM,oCAkBjB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,WACpB,IAAI,aAAa,CAAC,YAAY,EAAE,mBACvB;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,WAehC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,WACtB,IAAI,aAAa,CAAC,YAAY,EAAE,KACvC,IAAI,aAAa,CAAC,YAAY,GAAG,SAInC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,yBAAyB,wBACf,QAAQ,cAAc,gCACd,0BAA0B;;;;;;;;;EAwCxD,CAAC;AAEF,eAAO,MAAM,mCAAmC;;sCA2B/C,CAAC"}

package/StepFunctions.js

@@ -22,20 +22,28 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseStepMessage = exports.pullStepFunctionEvent = void 0;
-/**
- * Utility functions for working with AWS Step Function events/messages
- * @module StepFunctions
- *
- * @example
- * const StepFunctions = require('@cumulus/message/StepFunctions');
- */
+exports.getCumulusMessageFromExecutionEvent = exports.getFailedExecutionMessage = exports.lastFailedEventStep = exports.getFailedStepName = exports.parseStepMessage = exports.pullStepFunctionEvent = void 0;
 const jsonpath_plus_1 = require("jsonpath-plus");
+const get_1 = __importDefault(require("lodash/get"));
+const set_1 = __importDefault(require("lodash/set"));
+const StepFunctions_1 = require("@cumulus/aws-client/StepFunctions");
+const execution_history_1 = require("@cumulus/common/execution-history");
 const s3Utils = __importStar(require("@cumulus/aws-client/S3"));
 const logger_1 = __importDefault(require("@cumulus/logger"));
+const Executions_1 = require("./Executions");
 const log = new logger_1.default({
     sender: '@cumulus/message/StepFunctions',
 });
+const executionStatusToWorkflowStatus = (executionStatus) => {
+    const statusMap = {
+        ABORTED: 'failed',
+        FAILED: 'failed',
+        RUNNING: 'running',
+        SUCCEEDED: 'completed',
+        TIMED_OUT: 'failed',
+    };
+    return statusMap[executionStatus];
+};
 /**
  * Given a Step Function event, replace specified key in event with contents
  * of S3 remote message
@@ -100,4 +108,115 @@ const parseStepMessage = async (stepMessage, stepName) => {
     return parsedMessage;
 };
 exports.parseStepMessage = parseStepMessage;
+/**
+ * Searches the Execution step History for the TaskStateEntered pertaining to
+ * the failed task Id.  HistoryEvent ids are numbered sequentially, starting at
+ * one.
+*
+ * @param {HistoryEvent[]} events - Step Function events array
+ * @param {HistoryEvent} failedStepEvent - Step Function's failed event.
+ * @returns {string} name of the current stepfunction task or 'UnknownFailedStepName'.
+ */
+const getFailedStepName = (events, failedStepEvent) => {
+    var _a, _b;
+    try {
+        const previousEvents = events.slice(0, failedStepEvent.id - 1);
+        const startEvents = previousEvents.filter((e) => e.type === 'TaskStateEntered');
+        const stateName = (_b = (_a = startEvents.pop()) === null || _a === void 0 ? void 0 : _a.stateEnteredEventDetails) === null || _b === void 0 ? void 0 : _b.name;
+        if (!stateName)
+            throw new Error('TaskStateEntered Event Object did not have `stateEnteredEventDetails.name`');
+        return stateName;
+    }
+    catch (error) {
+        log.info('Failed to determine a failed stepName from execution events.');
+        log.error(error);
+    }
+    return 'UnknownFailedStepName';
+};
+exports.getFailedStepName = getFailedStepName;
+/**
+ * Finds all failed execution events and returns the last one in the list.
+ *
+ * @param {Array<HistoryEventList>} events - array of AWS Stepfunction execution HistoryEvents
+ * @returns {HistoryEvent|[]} - the last lambda or activity that failed in the
+ * event array, or an empty array.
+ */
+const lastFailedEventStep = (events) => {
+    const failures = events.filter((event) => ['LambdaFunctionFailed', 'ActivityFailed'].includes(event.type));
+    return failures.pop();
+};
+exports.lastFailedEventStep = lastFailedEventStep;
+/**
+ * Get message to use for publishing failed execution notifications.
+ *
+ * Try to get the input to the last failed step in the execution so we can
+ * update the status of any granules/PDRs that don't exist in the initial execution
+ * input.
+ *
+ * Falls back to overall execution input.
+ *
+ * @param {Object} inputCumulusMessage - Workflow execution input message
+ * @param {Function} getExecutionHistoryFunction - Testing override for mock/etc of
+ *                                                 StepFunctions.getExecutionHistory
+ * @returns {Object} - CumulusMessage Execution step message or execution input message
+ */
+const getFailedExecutionMessage = async (inputCumulusMessage, getExecutionHistoryFunction = StepFunctions_1.getExecutionHistory) => {
+    const amendedCumulusMessage = { ...inputCumulusMessage };
+    try {
+        const executionArn = (0, Executions_1.getMessageExecutionArn)(amendedCumulusMessage);
+        if (!executionArn) {
+            throw new Error('No execution arn found');
+        }
+        const { events } = await getExecutionHistoryFunction({ executionArn });
+        const lastFailedEvent = (0, exports.lastFailedEventStep)(events);
+        if (!lastFailedEvent) {
+            log.warn(`No failed step events found in execution ${executionArn}`);
+            return amendedCumulusMessage;
+        }
+        const failedExecutionStepName = (0, exports.getFailedStepName)(events, lastFailedEvent);
+        const failedStepExitedEvent = (0, execution_history_1.getStepExitedEvent)(events, lastFailedEvent);
+        if (!failedStepExitedEvent) {
+            log.info(`Could not retrieve output from last failed step in execution ${executionArn}, falling back to execution input`);
+            log.info(`Could not find TaskStateExited event after step ID ${lastFailedEvent.id} for execution ${executionArn}`);
+            return {
+                ...amendedCumulusMessage,
+                exception: {
+                    ...lastFailedEvent.activityFailedEventDetails,
+                    ...lastFailedEvent.lambdaFunctionFailedEventDetails,
+                    failedExecutionStepName,
+                },
+            };
+        }
+        const taskExitedEventOutput = JSON.parse((0, execution_history_1.getTaskExitedEventOutput)(failedStepExitedEvent) || '{}');
+        taskExitedEventOutput.exception = {
+            ...taskExitedEventOutput.exception,
+            failedExecutionStepName,
+        };
+        return await (0, exports.parseStepMessage)(taskExitedEventOutput, failedExecutionStepName);
+    }
+    catch (error) {
+        log.error('getFailedExecution failed to retrieve failure:', error);
+        return amendedCumulusMessage;
+    }
+};
+exports.getFailedExecutionMessage = getFailedExecutionMessage;
+const getCumulusMessageFromExecutionEvent = async (executionEvent) => {
+    let cumulusMessage;
+    if (executionEvent.detail.status === 'RUNNING') {
+        cumulusMessage = JSON.parse(executionEvent.detail.input);
+    }
+    else if (executionEvent.detail.status === 'SUCCEEDED') {
+        cumulusMessage = JSON.parse(executionEvent.detail.output);
+    }
+    else {
+        const inputMessage = JSON.parse((0, get_1.default)(executionEvent, 'detail.input', '{}'));
+        cumulusMessage = await (0, exports.getFailedExecutionMessage)(inputMessage);
+    }
+    const fullCumulusMessage = (await (0, exports.pullStepFunctionEvent)(cumulusMessage));
+    const workflowStatus = executionStatusToWorkflowStatus(executionEvent.detail.status);
+    (0, set_1.default)(fullCumulusMessage, 'meta.status', workflowStatus);
+    (0, set_1.default)(fullCumulusMessage, 'cumulus_meta.workflow_stop_time', executionEvent.detail.stopDate);
+    return fullCumulusMessage;
+};
+exports.getCumulusMessageFromExecutionEvent = getCumulusMessageFromExecutionEvent;
 //# sourceMappingURL=StepFunctions.js.map

package/StepFunctions.js.map

@@ -1 +1 @@
-{"version":3,"file":"StepFunctions.js","sourceRoot":"","sources":["src/StepFunctions.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;AAEb;;;;;;GAMG;AAEH,iDAAyC;AACzC,gEAAkD;AAClD,6DAAqC;AAGrC,MAAM,GAAG,GAAG,IAAI,gBAAM,CAAC;IACrB,MAAM,EAAE,gCAAgC;CACzC,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACI,MAAM,qBAAqB,GAAG,KAAK,EACxC,KAEC,EACiB,EAAE;IACpB,IAAI,CAAC,KAAK,CAAC,OAAO;QAAE,OAAO,KAAK,CAAC;IAEjC,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,eAAe,CAC7C,KAAK,CAAC,OAAO,CAAC,MAAM,EACpB,KAAK,CAAC,OAAO,CAAC,GAAG,CAClB,CAAC;IAEF,IAAI,WAAW,GAAG,SAAS,CAAC;IAC5B,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE;QAC5B,MAAM,iBAAiB,GAAG,IAAA,wBAAQ,EAAC;YACjC,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU;YAC9B,IAAI,EAAE,KAAK;YACX,UAAU,EAAE,KAAK;SAClB,CAAC,CAAC;QACH,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,0BAA0B,KAAK,CAAC,OAAO,CAAC,UAAU,UAAU,CAAC,CAAC;SAC/E;QACD,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE;YAC/B,iBAAiB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;YAC7E,WAAW,GAAG,KAAK,CAAC;YACpB,OAAO,WAAW,CAAC,OAAO,CAAC;SAC5B;KACF;IACD,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AA7BW,QAAA,qBAAqB,yBA6BhC;AAEF;;;;;;;;;;GAUG;AACI,MAAM,gBAAgB,GAAG,KAAK,EACnC,WAA+B,EAC/B,QAAgB,EAChB,EAAE;IACF,IAAI,aAAa,CAAC;IAClB,IAAI,WAAW,CAAC,GAAG,EAAE;QACnB,MAAM,gBAAgB,GAAG,EAAE,GAAG,WAAW,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;QAC1F,OAAO,gBAAgB,CAAC,GAAG,CAAC;QAC5B,OAAO,gBAAgB,CAAC,KAAK,CAAC;QAC9B,aAAa,GAAG,gBAAgB,CAAC;KAClC;SAAM;QACL,aAAa,GAAG,WAAW,CAAC;KAC7B;IAED,IAAI,aAAa,CAAC,OAAO,EAAE;QACzB,qDAAqD;QACrD,GAAG,CAAC,IAAI,CAAC,cAAc,QAAQ,gBAAgB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACxF,aAAa,GAAG,MAAM,IAAA,6BAAqB,EAAC,aAAa,CAAC,CAAC;KAC5D;IACD,OAA+B,aAAa,CAAC;AAC/C,CAAC,CAAC;AApBW,QAAA,gBAAgB,oBAoB3B"}
+{"version":3,"file":"StepFunctions.js","sourceRoot":"","sources":["src/StepFunctions.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;AAWb,iDAAyC;AACzC,qDAA6B;AAC7B,qDAA6B;AAE7B,qEAAwE;AACxE,yEAAiG;AAEjG,gEAAkD;AAClD,6DAAqC;AAErC,6CAAsD;AAEtD,MAAM,GAAG,GAAG,IAAI,gBAAM,CAAC;IACrB,MAAM,EAAE,gCAAgC;CACzC,CAAC,CAAC;AAOH,MAAM,+BAA+B,GAAG,CACtC,eAAgC,EACR,EAAE;IAC1B,MAAM,SAAS,GAAuC;QACpD,OAAO,EAAE,QAAQ;QACjB,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,SAAS;QAClB,SAAS,EAAE,WAAW;QACtB,SAAS,EAAE,QAAQ;KACpB,CAAC;IAEF,OAAO,SAAS,CAAC,eAAe,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACI,MAAM,qBAAqB,GAAG,KAAK,EACxC,KAEC,EACiB,EAAE;IACpB,IAAI,CAAC,KAAK,CAAC,OAAO;QAAE,OAAO,KAAK,CAAC;IAEjC,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,eAAe,CAC7C,KAAK,CAAC,OAAO,CAAC,MAAM,EACpB,KAAK,CAAC,OAAO,CAAC,GAAG,CAClB,CAAC;IAEF,IAAI,WAAW,GAAG,SAAS,CAAC;IAC5B,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE;QAC5B,MAAM,iBAAiB,GAAG,IAAA,wBAAQ,EAAC;YACjC,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU;YAC9B,IAAI,EAAE,KAAK;YACX,UAAU,EAAE,KAAK;SAClB,CAAC,CAAC;QACH,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,0BAA0B,KAAK,CAAC,OAAO,CAAC,UAAU,UAAU,CAAC,CAAC;SAC/E;QACD,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE;YAC/B,iBAAiB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;YAC7E,WAAW,GAAG,KAAK,CAAC;YACpB,OAAO,WAAW,CAAC,OAAO,CAAC;SAC5B;KACF;IACD,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AA7BW,QAAA,qBAAqB,yBA6BhC;AAEF;;;;;;;;;;GAUG;AACI,MAAM,gBAAgB,GAAG,KAAK,EACnC,WAA+B,EAC/B,QAAgB,EAChB,EAAE;IACF,IAAI,aAAa,CAAC;IAClB,IAAI,WAAW,CAAC,GAAG,EAAE;QACnB,MAAM,gBAAgB,GAAG,EAAE,GAAG,WAAW,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;QAC1F,OAAO,gBAAgB,CAAC,GAAG,CAAC;QAC5B,OAAO,gBAAgB,CAAC,KAAK,CAAC;QAC9B,aAAa,GAAG,gBAAgB,CAAC;KAClC;SAAM;QACL,aAAa,GAAG,WAAW,CAAC;KAC7B;IAED,IAAI,aAAa,CAAC,OAAO,EAAE;QACzB,qDAAqD;QACrD,GAAG,CAAC,IAAI,CAAC,cAAc,QAAQ,gBAAgB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACxF,aAAa,GAAG,MAAM,IAAA,6BAAqB,EAAC,aAAa,CAAC,CAAC;KAC5D;IACD,OAA+B,aAAa,CAAC;AAC/C,CAAC,CAAC;AApBW,QAAA,gBAAgB,oBAoB3B;AAEF;;;;;;;;GAQG;AACI,MAAM,iBAAiB,GAAG,CAC/B,MAAwC,EACxC,eAA+B,EAC/B,EAAE;;IACF,IAAI;QACF,MAAM,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QAC/D,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CACvC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,kBAAkB,CACrC,CAAC;QACF,MAAM,SAAS,GAAG,MAAA,MAAA,WAAW,CAAC,GAAG,EAAE,0CAAE,wBAAwB,0CAAE,IAAI,CAAC;QACpE,IAAI,CAAC,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;QAC9G,OAAO,SAAS,CAAC;KAClB;IAAC,OAAO,KAAK,EAAE;QACd,GAAG,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;QACzE,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KAClB;IACD,OAAO,uBAAuB,CAAC;AACjC,CAAC,CAAC;AAjBW,QAAA,iBAAiB,qBAiB5B;AAEF;;;;;;GAMG;AACI,MAAM,mBAAmB,GAAG,CACjC,MAAwC,EACI,EAAE;IAC9C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CACvC,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACnE,OAAO,QAAQ,CAAC,GAAG,EAAE,CAAC;AACxB,CAAC,CAAC;AANW,QAAA,mBAAmB,uBAM9B;AAEF;;;;;;;;;;;;;GAaG;AACI,MAAM,yBAAyB,GAAG,KAAK,EAC5C,mBAA2C,EAC3C,8BAA0D,mCAAmB,EAC7E,EAAE;IACF,MAAM,qBAAqB,GAAG,EAAE,GAAG,mBAAmB,EAAE,CAAC;IAEzD,IAAI;QACF,MAAM,YAAY,GAAG,IAAA,mCAAsB,EAAC,qBAAqB,CAAC,CAAC;QACnE,IAAI,CAAC,YAAY,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;SAAE;QACjE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,2BAA2B,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;QAEvE,MAAM,eAAe,GAAG,IAAA,2BAAmB,EAAC,MAAM,CAAC,CAAC;QACpD,IAAI,CAAC,eAAe,EAAE;YACpB,GAAG,CAAC,IAAI,CAAC,4CAA4C,YAAY,EAAE,CAAC,CAAC;YACrE,OAAO,qBAAqB,CAAC;SAC9B;QACD,MAAM,uBAAuB,GAAG,IAAA,yBAAiB,EAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QAC3E,MAAM,qBAAqB,GAAG,IAAA,sCAAkB,EAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QAE1E,IAAI,CAAC,qBAAqB,EAAE;YAC1B,GAAG,CAAC,IAAI,CAAC,gEAAgE,YAAY,mCAAmC,CAAC,CAAC;YAC1H,GAAG,CAAC,IAAI,CAAC,sDAAsD,eAAe,CAAC,EAAE,kBAAkB,YAAY,EAAE,CAAC,CAAC;YACnH,OAAO;gBACL,GAAG,qBAAqB;gBACxB,SAAS,EAAE;oBACT,GAAG,eAAe,CAAC,0BAA0B;oBAC7C,GAAG,eAAe,CAAC,gCAAgC;oBACnD,uBAAuB;iBAExB;aACF,CAAC;SACH;QACD,MAAM,qBAAqB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,4CAAwB,EAAC,qBAAqB,CAAC,IAAI,IAAI,CAAC,CAAC;QAClG,qBAAqB,CAAC,SAAS,GAAG;YAChC,GAAG,qBAAqB,CAAC,SAAS;YAClC,uBAAuB;SACxB,CAAC;QACF,OAAO,MAAM,IAAA,wBAAgB,EAAC,qBAAqB,EAAE,uBAAuB,CAAC,CAAC;KAC/E;IAAC,OAAO,KAAK,EAAE;QACd,GAAG,CAAC,KAAK,CAAC,gDAAgD,EAAE,KAAK,CAAC,CAAC;QACnE,OAAO,qBAAqB,CAAC;KAC9B;AACH,CAAC,CAAC;AA1CW,QAAA,yBAAyB,6BA0CpC;AAEK,MAAM,mCAAmC,GAAG,KAAK,EAAE,cAAqG,EAAE,EAAE;IACjK,IAAI,cAAc,CAAC;IACnB,IAAI,cAAc,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;QAC9C,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;KAC1D;SAAM,IAAI,cAAc,CAAC,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE;QACvD,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;KAC3D;SAAM;QACL,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,aAAG,EAAC,cAAc,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC,CAAC;QAC3E,cAAc,GAAG,MAAM,IAAA,iCAAyB,EAAC,YAAY,CAAC,CAAC;KAChE;IAED,MAAM,kBAAkB,GAAG,CAAC,MAAM,IAAA,6BAAqB,EACrD,cAAc,CACf,CAA2B,CAAC;IAE7B,MAAM,cAAc,GAAG,+BAA+B,CACpD,cAAc,CAAC,MAAM,CAAC,MAAyB,CAChD,CAAC;IACF,IAAA,aAAG,EAAC,kBAAkB,EAAE,aAAa,EAAE,cAAc,CAAC,CAAC;IAEvD,IAAA,aAAG,EACD,kBAAkB,EAClB,iCAAiC,EACjC,cAAc,CAAC,MAAM,CAAC,QAAQ,CAC/B,CAAC;IAEF,OAAO,kBAAkB,CAAC;AAC5B,CAAC,CAAC;AA3BW,QAAA,mCAAmC,uCA2B9C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/message",
-  "version": "10.0.0",
+  "version": "10.1.1-alpha.0",
   "description": "Utilities for building and parsing Cumulus messages",
   "keywords": [
     "GIBS",
@@ -49,6 +49,5 @@
   },
   "devDependencies": {
     "@types/uuid": "^8.0.0"
-  },
-  "gitHead": "7c6d2d1cd79b57d6943bbc3d898d0cf975b543b1"
+  }
 }

package/src/Build.ts

@@ -10,9 +10,9 @@
  */
 
 import merge from 'lodash/merge';
+
 import { Message } from '@cumulus/types';
 import { v4 as uuidv4 } from 'uuid';
-
 import {
   WorkflowMessageTemplate,
   WorkflowMessageTemplateCumulusMeta,

package/src/Collections.ts

@@ -17,6 +17,8 @@ type CollectionInfo = {
   version: string
 };
 
+export const collectionIdSeparator = '___';
+
 /**
  * Returns the collection ID.
  *
@@ -27,7 +29,7 @@ type CollectionInfo = {
  * @alias module:Collections
  */
 export const constructCollectionId = (name: string, version: string) =>
-  `${name}___${version}`;
+  `${name}${collectionIdSeparator}${version}`;
 
 /**
  * Returns the name and version of a collection based on
@@ -35,12 +37,14 @@ 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;
   let version;
   try {
-    [name, version] = collectionId.split('___');
+    [name, version] = collectionId.split(collectionIdSeparator);
   } catch (error) {
     throw new Error(`invalid collectionId: ${JSON.stringify(collectionId)}`);
   }

package/src/DeadLetterMessage.ts

@@ -0,0 +1,54 @@
+import { SQSRecord, EventBridgeEvent } from 'aws-lambda';
+
+import { parseSQSMessageBody } from '@cumulus/aws-client/SQS';
+import { CumulusMessage } from '@cumulus/types/message';
+import Logger from '@cumulus/logger';
+
+import { getCumulusMessageFromExecutionEvent } from './StepFunctions';
+
+const log = new Logger({ sender: '@cumulus/DeadLetterMessage' });
+
+type StepFunctionEventBridgeEvent = EventBridgeEvent<'Step Functions Execution Status Change', { [key: string]: string }>;
+type UnwrapDeadLetterCumulusMessageReturnType = (
+  StepFunctionEventBridgeEvent
+  | AWS.SQS.Message
+  | SQSRecord
+  | CumulusMessage
+);
+
+/**
+ * Unwrap dead letter Cumulus message, which may be wrapped in a
+ * States cloudwatch event, which is wrapped in an SQS message.
+ *
+ * @param {Object} messageBody - received SQS message
+ * @returns {Object} the cumulus message or nearest available object
+ */
+export const unwrapDeadLetterCumulusMessage = async (
+  messageBody: UnwrapDeadLetterCumulusMessageReturnType
+): Promise<UnwrapDeadLetterCumulusMessageReturnType> => {
+  try {
+    if ('cumulus_meta' in messageBody) {
+      return messageBody;
+    }
+    if ('Body' in messageBody || 'body' in messageBody) {
+      // AWS.SQS.Message/SQS.Record case
+      const unwrappedMessageBody = parseSQSMessageBody(
+        messageBody
+      ) as CumulusMessage;
+      return await unwrapDeadLetterCumulusMessage(unwrappedMessageBody);
+    }
+    if (!('detail' in messageBody)) {
+      // Non-typed catchall
+      return messageBody;
+    }
+    // StepFunctionEventBridgeEvent case
+    const unwrappedMessageBody = await getCumulusMessageFromExecutionEvent(messageBody);
+    return await unwrapDeadLetterCumulusMessage(unwrappedMessageBody);
+  } catch (error) {
+    log.error(
+      'Falling back to storing wrapped message after encountering unwrap error',
+      error
+    );
+    return messageBody;
+  }
+};