@cumulus/common
Version:
Common utilities used across tasks
101 lines • 4 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
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.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getSfEventMessageObject = exports.getSfEventDetailValue = exports.getSfEventStatus = exports.isFailedSfStatus = exports.isTerminalSfStatus = exports.isSfExecutionEvent = void 0;
const log = __importStar(require("./log"));
const util_1 = require("./util");
/**
* Determine if Cloudwatch event is a Step Function event
*
* @param {AwsCloudWatchEvent} event - A Cloudwatch event
* @returns {boolean} True if event is a Step Function event
*/
const isSfExecutionEvent = (event) => event.source === 'aws.states';
exports.isSfExecutionEvent = isSfExecutionEvent;
/**
* Determine if Step Function is in a terminal state.
*
* @param {string} status - A Step Function execution status from a Cloudwatch event
* @returns {boolean} True if Step Function is in terminal state.
*/
exports.isTerminalSfStatus = (0, util_1.isOneOf)([
'ABORTED',
'SUCCEEDED',
'FAILED',
'TIMED_OUT',
]);
/**
* Determine if Step Function is in a failed state.
*
* @param {Object} status - A Step Function execution status from a Cloudwatch event
* @returns {boolean} True if Step Function is in failed state.
*/
exports.isFailedSfStatus = (0, util_1.isOneOf)([
'ABORTED',
'FAILED',
'TIMED_OUT',
]);
/**
* Get Step Function status from Cloudwatch event.
*
* @param {AwsCloudWatchEvent} event - A Cloudwatch event
* @returns {string|undefined} Step Function execution status
*/
const getSfEventStatus = (event) => event?.detail?.status;
exports.getSfEventStatus = getSfEventStatus;
/**
* Get the Step Function output message from a Cloudwatch Event
*
* @param {AwsCloudWatchEvent} event - A Cloudwatch event
* @param {string} field - Field to pull from 'detail', i.e. 'input' or 'output'
* @param {string} [defaultValue] - A default value for the message, if none exists
* @returns {string|undefined} Output message from Step Function
*/
const getSfEventDetailValue = (event, field, defaultValue) => event?.detail?.[field] ?? defaultValue;
exports.getSfEventDetailValue = getSfEventDetailValue;
/**
* Get the Step Function output message from a Cloudwatch Event
*
* @param {Object} event - A Cloudwatch event
* @param {string} messageSource - 'input' or 'output' from Step Function
* @param {string} defaultValue - defaultValue to fetch if no event message object is found
* @returns {unknown} Message object from Step Function
*/
const getSfEventMessageObject = (event, messageSource, defaultValue) => {
const message = (0, exports.getSfEventDetailValue)(event, messageSource, defaultValue);
if (message === undefined) {
log.error('Unable to find message');
return undefined;
}
try {
return JSON.parse(message);
}
catch (error) {
log.error(`Could not parse '${message}'`);
return undefined;
}
};
exports.getSfEventMessageObject = getSfEventMessageObject;
//# sourceMappingURL=cloudwatch-event.js.map