@cumulus/message 9.7.0 → 9.9.1

package/StepFunctions.js

@@ -14,7 +14,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };
@@ -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
@@ -47,13 +55,13 @@ const log = new logger_1.default({
  * @async
  * @alias module:StepFunctions
  */
-exports.pullStepFunctionEvent = async (event) => {
+const pullStepFunctionEvent = async (event) => {
     if (!event.replace)
         return event;
     const remoteMsg = await s3Utils.getJsonS3Object(event.replace.Bucket, event.replace.Key);
     let returnEvent = remoteMsg;
     if (event.replace.TargetPath) {
-        const replaceNodeSearch = jsonpath_plus_1.JSONPath({
+        const replaceNodeSearch = (0, jsonpath_plus_1.JSONPath)({
             path: event.replace.TargetPath,
             json: event,
             resultType: 'all',
@@ -69,6 +77,7 @@ exports.pullStepFunctionEvent = async (event) => {
     }
     return returnEvent;
 };
+exports.pullStepFunctionEvent = pullStepFunctionEvent;
 /**
  * Parse step message with CMA keys and replace specified key in event with contents
  * of S3 remote message
@@ -80,7 +89,7 @@ exports.pullStepFunctionEvent = async (event) => {
  * @async
  * @alias module:StepFunctions
  */
-exports.parseStepMessage = async (stepMessage, stepName) => {
+const parseStepMessage = async (stepMessage, stepName) => {
     let parsedMessage;
     if (stepMessage.cma) {
         const flattenedMessage = { ...stepMessage, ...stepMessage.cma, ...stepMessage.cma.event };
@@ -94,8 +103,120 @@ exports.parseStepMessage = async (stepMessage, stepName) => {
     if (parsedMessage.replace) {
         // Message was too large and output was written to S3
         log.info(`Retrieving ${stepName} output from ${JSON.stringify(parsedMessage.replace)}`);
-        parsedMessage = await exports.pullStepFunctionEvent(parsedMessage);
+        parsedMessage = await (0, exports.pullStepFunctionEvent)(parsedMessage);
     }
     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;AACU,QAAA,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,wBAAQ,CAAC;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;AAEF;;;;;;;;;;GAUG;AACU,QAAA,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,6BAAqB,CAAC,aAAa,CAAC,CAAC;KAC5D;IACD,OAA+B,aAAa,CAAC;AAC/C,CAAC,CAAC"}
+{"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": "9.7.0",
+  "version": "9.9.1",
   "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": "9.7.0",
-    "@cumulus/common": "9.7.0",
-    "@cumulus/errors": "9.7.0",
-    "@cumulus/logger": "9.7.0",
-    "@cumulus/types": "9.7.0",
+    "@cumulus/aws-client": "9.9.1",
+    "@cumulus/common": "9.9.1",
+    "@cumulus/errors": "9.9.1",
+    "@cumulus/logger": "9.9.1",
+    "@cumulus/types": "9.9.1",
     "jsonpath-plus": "^3.0.0",
     "lodash": "^4.17.20",
     "uuid": "^8.2.0"
@@ -50,5 +50,5 @@
   "devDependencies": {
     "@types/uuid": "^8.0.0"
   },
-  "gitHead": "08fb2c1d9113e7be465316f950d4ac9272bd3141"
+  "gitHead": "7a6a8ce08bf67e5174c1523b4af2e00e1a3c58cc"
 }

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/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;
+  }
+};

package/src/StepFunctions.ts

@@ -8,14 +8,41 @@
  * const StepFunctions = require('@cumulus/message/StepFunctions');
  */
 
+import { EventBridgeEvent } from 'aws-lambda';
 import { JSONPath } from 'jsonpath-plus';
+import get from 'lodash/get';
+import set from 'lodash/set';
+
+import { getExecutionHistory } from '@cumulus/aws-client/StepFunctions';
+import { getStepExitedEvent, getTaskExitedEventOutput } from '@cumulus/common/execution-history';
+import { Message } from '@cumulus/types';
 import * as s3Utils from '@cumulus/aws-client/S3';
 import Logger from '@cumulus/logger';
-import { Message } from '@cumulus/types';
+
+import { getMessageExecutionArn } from './Executions';
 
 const log = new Logger({
   sender: '@cumulus/message/StepFunctions',
 });
+type ExecutionStatus = ('ABORTED' | 'RUNNING' | 'TIMED_OUT' | 'SUCCEEDED' | 'FAILED');
+
+type ExecutionStatusToWorkflowStatusMap = {
+  [K in ExecutionStatus]: Message.WorkflowStatus;
+};
+
+const executionStatusToWorkflowStatus = (
+  executionStatus: ExecutionStatus
+): Message.WorkflowStatus => {
+  const statusMap: ExecutionStatusToWorkflowStatusMap = {
+    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
@@ -91,3 +118,133 @@ export const parseStepMessage = async (
   }
   return <Message.CumulusMessage>parsedMessage;
 };
+
+/**
+ * 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 const getFailedStepName = (
+  events: AWS.StepFunctions.HistoryEvent[],
+  failedStepEvent: { id: number }
+) => {
+  try {
+    const previousEvents = events.slice(0, failedStepEvent.id - 1);
+    const startEvents = previousEvents.filter(
+      (e) => e.type === 'TaskStateEntered'
+    );
+    const stateName = startEvents.pop()?.stateEnteredEventDetails?.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';
+};
+
+/**
+ * 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 const lastFailedEventStep = (
+  events: AWS.StepFunctions.HistoryEvent[]
+): AWS.StepFunctions.HistoryEvent | undefined => {
+  const failures = events.filter((event) =>
+    ['LambdaFunctionFailed', 'ActivityFailed'].includes(event.type));
+  return failures.pop();
+};
+
+/**
+ * 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 const getFailedExecutionMessage = async (
+  inputCumulusMessage: Message.CumulusMessage,
+  getExecutionHistoryFunction: typeof getExecutionHistory = getExecutionHistory
+) => {
+  const amendedCumulusMessage = { ...inputCumulusMessage };
+
+  try {
+    const executionArn = getMessageExecutionArn(amendedCumulusMessage);
+    if (!executionArn) { throw new Error('No execution arn found'); }
+    const { events } = await getExecutionHistoryFunction({ executionArn });
+
+    const lastFailedEvent = lastFailedEventStep(events);
+    if (!lastFailedEvent) {
+      log.warn(`No failed step events found in execution ${executionArn}`);
+      return amendedCumulusMessage;
+    }
+    const failedExecutionStepName = getFailedStepName(events, lastFailedEvent);
+    const failedStepExitedEvent = 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(getTaskExitedEventOutput(failedStepExitedEvent) || '{}');
+    taskExitedEventOutput.exception = {
+      ...taskExitedEventOutput.exception,
+      failedExecutionStepName,
+    };
+    return await parseStepMessage(taskExitedEventOutput, failedExecutionStepName);
+  } catch (error) {
+    log.error('getFailedExecution failed to retrieve failure:', error);
+    return amendedCumulusMessage;
+  }
+};
+
+export const getCumulusMessageFromExecutionEvent = async (executionEvent: EventBridgeEvent<'Step Functions Execution Status Change', { [key: string]: string }>) => {
+  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(get(executionEvent, 'detail.input', '{}'));
+    cumulusMessage = await getFailedExecutionMessage(inputMessage);
+  }
+
+  const fullCumulusMessage = (await pullStepFunctionEvent(
+    cumulusMessage
+  )) as Message.CumulusMessage;
+
+  const workflowStatus = executionStatusToWorkflowStatus(
+    executionEvent.detail.status as ExecutionStatus
+  );
+  set(fullCumulusMessage, 'meta.status', workflowStatus);
+
+  set(
+    fullCumulusMessage,
+    'cumulus_meta.workflow_stop_time',
+    executionEvent.detail.stopDate
+  );
+
+  return fullCumulusMessage;
+};