Merge pull request #42 from nasa/CUMULUS-2203-update-to-Core3

CHANGELOG.md

@@ -6,10 +6,22 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic
 Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [v2.0.0] 2020-10-19
+
+### BREAKING CHANGES
+
+- **CUMULUS-2203**
+  - Updated CumulusMessageWithPayload exported to
+    CumulusMessageWithAssignedPayload.  This change explicitly updates this type
+    to allow for a `null` payload value, as well as explicitly allows for a
+    `replace` key for compatibility with `@cumulus/types` > 3.0.0
+
 ## [v1.3.2] 2020-10-13
 
 ### Fixed
 
+- **CUMULUS_2203**
+
 - Fixed issue causing spawned CMA process to left running/in the node event
   queue, resulting in AWS being unwilling/unable to clean up the instance. This resulted in lambdas with a memory leak/resource issues to not be
   reclaimed/restarted by AWS.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/cumulus-message-adapter-js",
-  "version": "1.3.2",
+  "version": "2.0.0",
   "description": "Cumulus message adapter",
   "main": "dist/index.js",
   "files": [
@@ -67,7 +67,7 @@
   },
   "dependencies": {
     "@types/aws-lambda": "^8.10.58",
-    "@cumulus/types": "2.0.1",
+    "@cumulus/types": "3.0.0",
     "execa": "^4.0.0",
     "lookpath": "1.0.3"
   }

src/cma.ts

@@ -15,14 +15,14 @@ import {
 import {
   CMAMessage,
   CumulusMessageAdapterError,
-  CumulusMessageWithPayload,
+  CumulusMessageWithAssignedPayload,
   InvokeCumulusMessageAdapterResult,
   LoadNestedEventInput
 } from './types';
 
 import {
   isCMAMessage,
-  isCumulusMessageWithPayload,
+  isCumulusMessageWithAssignedPayload,
   isLoadNestedEventInput
 } from './typeGuards';
 
@@ -114,7 +114,7 @@ function safeSetEnv(VARNAME: string, value?: string): void {
  * @returns {undefined} - no return values
  */
 function setCumulusEnvironment(
-  cumulusMessage: CumulusMessageWithPayload,
+  cumulusMessage: CumulusMessageWithAssignedPayload,
   context: Context
 ): void {
   safeSetEnv('EXECUTIONS', getExecutions(cumulusMessage));
@@ -137,7 +137,7 @@ function setCumulusEnvironment(
 async function getCmaOutput(
   readLine: readline.ReadLine,
   errorObj: CumulusMessageAdapterError
-): Promise<CumulusMessageWithPayload | LoadNestedEventInput | CumulusRemoteMessage> {
+): Promise<CumulusMessageWithAssignedPayload | LoadNestedEventInput | CumulusRemoteMessage> {
   return new Promise((resolve, reject) => {
     let buffer = '';
     readLine.resume();
@@ -174,7 +174,7 @@ export async function runCumulusTask(
   cumulusMessage: CumulusMessage | CumulusRemoteMessage | CMAMessage,
   context: Context,
   schemas: string | null = null
-): Promise<CumulusMessage | CumulusRemoteMessage> {
+): Promise<CumulusMessageWithAssignedPayload | CumulusRemoteMessage> {
   const { cmaProcess, errorObj } = await invokeCumulusMessageAdapter();
   const cmaStdin = cmaProcess.stdin;
   const rl = readline.createInterface({
@@ -189,7 +189,7 @@ export async function runCumulusTask(
     }));
     cmaStdin.write('\n<EOC>\n');
     const loadAndUpdateRemoteEventOutput = await getCmaOutput(rl, errorObj);
-    if (!isCumulusMessageWithPayload(loadAndUpdateRemoteEventOutput)) {
+    if (!isCumulusMessageWithAssignedPayload(loadAndUpdateRemoteEventOutput)) {
       throw new Error(`Invalid output typing recieved from
       loadAndUpdateRemoteEvent ${JSON.stringify(loadAndUpdateRemoteEventOutput)}`);
     }
@@ -233,7 +233,9 @@ export async function runCumulusTask(
       console.log(`CMA process failed to kill on task failure: ${JSON.stringify(e)}`);
     }
     if (error?.name?.includes('WorkflowError') && (!isCMAMessage(cumulusMessage))) {
-      return { ...cumulusMessage, payload: null, exception: error.name };
+      return {
+        ...cumulusMessage, payload: null, exception: error.name
+      } as CumulusMessageWithAssignedPayload;
     }
     throw error;
   }

src/index.ts

@@ -3,3 +3,5 @@ export {
   invokeCumulusMessageAdapter,
   runCumulusTask
 } from './cma';
+
+export * from './types';

src/message.ts

@@ -1,4 +1,4 @@
-import { CumulusMessageWithPayload } from './types';
+import { CumulusMessageWithAssignedPayload } from './types';
 
 const GRANULE_LOG_LIMIT = 500;
 /**
@@ -12,7 +12,7 @@ const GRANULE_LOG_LIMIT = 500;
  * @returns {Array<string>} - An array of granule ids
  */
 export const getMessageGranules = (
-  message: CumulusMessageWithPayload,
+  message: CumulusMessageWithAssignedPayload,
   granuleLimit: number = GRANULE_LOG_LIMIT
 ): string[] => {
   const granules = message?.payload?.granules || message?.meta?.input_granules;
@@ -30,7 +30,7 @@ export const getMessageGranules = (
  * @returns {string | undefined} - The cumulus stack name.
  */
 export const getStackName = (
-  message: CumulusMessageWithPayload
+  message: CumulusMessageWithAssignedPayload
 ): string | undefined => message?.meta?.stack;
 
 /**
@@ -40,7 +40,7 @@ export const getStackName = (
  * @returns {string | undefined} - the parent execution.
  */
 export const getParentArn = (
-  message: CumulusMessageWithPayload
+  message: CumulusMessageWithAssignedPayload
 ): string | undefined => message?.cumulus_meta?.parentExecutionArn;
 
 /**
@@ -50,7 +50,7 @@ export const getParentArn = (
 * @returns {string | undefined} current execution name.
 */
 export const getExecutions = (
-  message: CumulusMessageWithPayload
+  message: CumulusMessageWithAssignedPayload
 ): string | undefined => message?.cumulus_meta?.execution_name;
 
 /**
@@ -60,5 +60,5 @@ export const getExecutions = (
  * @returns {string} asyncOperationId or null
  */
 export const getAsyncOperationId = (
-  message: CumulusMessageWithPayload
+  message: CumulusMessageWithAssignedPayload
 ): string | undefined => message?.cumulus_meta?.asyncOperationId;

src/typeGuards.ts

@@ -1,28 +1,28 @@
 import { CumulusMessage, CumulusRemoteMessage } from '@cumulus/types/message';
 import {
   LoadNestedEventInput,
-  CumulusMessageWithPayload,
+  CumulusMessageWithAssignedPayload,
   CMAMessage
 } from './types';
 
 // eslint-disable-next-line require-jsdoc
-export function isCumulusMessageWithPayload(
+export function isCumulusMessageWithAssignedPayload(
   message:
   CumulusMessage |
   CumulusRemoteMessage |
-  CumulusMessageWithPayload |
+  CumulusMessageWithAssignedPayload |
   LoadNestedEventInput
-): message is CumulusMessageWithPayload {
+): message is CumulusMessageWithAssignedPayload {
   return (
-    (message as CumulusMessageWithPayload)?.payload !== undefined
+    (message as CumulusMessageWithAssignedPayload)?.payload !== undefined
     && (message as LoadNestedEventInput)?.input === undefined
     && (message as LoadNestedEventInput)?.config === undefined
   );
 }
 
 // eslint-disable-next-line require-jsdoc
 export function isLoadNestedEventInput(
-  message: CumulusMessageWithPayload | LoadNestedEventInput | CumulusRemoteMessage
+  message: CumulusMessageWithAssignedPayload | LoadNestedEventInput | CumulusRemoteMessage
 ): message is LoadNestedEventInput {
   return (
     (message as LoadNestedEventInput).input !== undefined

src/types.ts

@@ -13,14 +13,18 @@ export interface LoadNestedEventInput {
   config: unknown,
   messageConfig?: unknown
 }
-export interface CumulusMessageWithPayload extends CumulusMessage {
+export interface CumulusMessageWithAssignedPayload extends CumulusMessage {
   payload: {
     granules?: { granuleId: string }[]
-  }
+    [key: string]: unknown
+  } | null,
   meta: {
+    workflow_name: string
+    [key: string]: unknown
     stack?: string,
     input_granules?: { granuleId: string }[]
   }
+  replace?: ReplaceConfig
 }
 export interface CMAMessage {
   cma: {