@izara_project/izara-core-generate-service-code 1.0.73 → 1.0.75

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@izara_project/izara-core-generate-service-code",
-  "version": "1.0.73",
+  "version": "1.0.75",
   "description": "Code for locally generating per service files",
   "homepage": "https://bitbucket.org/izara-core-support-services/izara-core-support-services-generate-service-code#readme",
   "repository": {

package/src/emit/coreFunction/emitCoreFunctionArtifacts.js

@@ -1,6 +1,8 @@
 import ejsLib from 'ejs';
 import { readFile } from 'node:fs/promises';
 
+import { customFlowNextSteps } from '../custom/customFlows.js';
+
 const TEMPLATE_URL = new URL('./templates/', import.meta.url);
 const APP_ROOT = 'app/sls_yaml/generatedCode/source';
 const SRC_ROOT = 'app/src/generatedCode/CoreFunctions';
@@ -94,6 +96,7 @@ export async function emitCoreFunctionArtifacts({ project, objects = [], relatio
     objects, 
     relationships,
     flows,
+    customFlowNextSteps: customFlowNextSteps(flows),
     objectGraphServiceTags,
     relationshipGraphServiceTags,
     crud,

package/src/emit/coreFunction/templates/InitialSetupConfig.ejs

@@ -50,9 +50,9 @@ const externalServices = {
 const tableConfigs = {
   prod: {
     Config: {},
-    <% dynamoTableNames.forEach(tableName => { -%>
-    <%= tableName %>: {}
-    <% }); -%>
+<% dynamoTableNames.forEach(tableName => { -%>
+    <%= tableName %>: {},
+<% }); -%>
     // <#InitialSetupConfig_ExtraProdTableConfigs#>
     // <#/InitialSetupConfig_ExtraProdTableConfigs#>
   },
@@ -61,11 +61,11 @@ const tableConfigs = {
       clearDataWhenRefresh: true,
       rawSource: false
     },
-    <% dynamoTableNames.forEach(tableName => { -%>
+<% dynamoTableNames.forEach(tableName => { -%>
     <%= tableName %>: {
       clearDataWhenRefresh: true
-    }
-    <% }); -%>
+    },
+<% }); -%>
     // <#InitialSetupConfig_ExtraTestTableConfigs#>
     // <#/InitialSetupConfig_ExtraTestTableConfigs#>
   }
@@ -91,31 +91,31 @@ const tableConfigs = {
   });
 -%>
 const snsTopicSubscriptions = [
-  <% if (relSubs.length > 0) { -%>
+<% if (relSubs.length > 0) { -%>
   // ------------------------------------------------------------
   // Relationship Subscriptions
   // ------------------------------------------------------------
-  <% relSubs.forEach(function(sub, idx) { -%>
+<% relSubs.forEach(function(sub, idx) { -%>
   {
     serviceTag: '<%= sub.serviceTag %>',
     topicName: '<%= sub.topicName %>',
     sqsEndpoint: '<%= sub.sqsEndpoint %>'
   },
-  <% }); -%>
-  <% } -%>
-  <% if (nodeSubs.length > 0) { -%>
+<% }); -%>
+<% } -%>
+<% if (nodeSubs.length > 0) { -%>
 
   // ------------------------------------------------------------
   // Node Subscriptions
   // ------------------------------------------------------------
-  <% nodeSubs.forEach(function(sub, idx) { -%>
+<% nodeSubs.forEach(function(sub, idx) { -%>
   {
     serviceTag: '<%= sub.serviceTag %>',
     topicName: '<%= sub.topicName %>',
     sqsEndpoint: '<%= sub.sqsEndpoint %>'
   },
-  <% }); -%>
-  <% } -%>
+<% }); -%>
+<% } -%>
 
   //(<additionalSubscription>)
   //(</additionalSubscription>)
@@ -126,11 +126,11 @@ const snsTopicSubscriptions = [
 // ============================================================
 function roleConfigs() {
   const externalLambdaRole = [
-    <% if (crud && objectGraphServiceTags && objectGraphServiceTags.length > 0) { -%>
+<% if (crud && objectGraphServiceTags && objectGraphServiceTags.length > 0) { -%>
     {
       roleName: 'FlowObjects',
       statement: [
-        <% objectGraphServiceTags.forEach(function(tag, idx) { -%>
+<% objectGraphServiceTags.forEach(function(tag, idx) { -%>
         {
           Sid: 'FlowObjectsInvokeGetNode<%= tag %>',
           Effect: 'Allow',
@@ -149,7 +149,7 @@ function roleConfigs() {
             `arn:aws:sns:${process.env.iz_region}:${process.env.iz_accountId}:${snsSharedLib.snsTopicNameByFlowSchema(_izContext, 'CreateNode_In', '<%= tag %>')}`
           ]
         },
-        <% }); -%>
+<% }); -%>
         //(<createFlowObjectsRole>)
         //(</createFlowObjectsRole>)
       ]
@@ -158,7 +158,7 @@ function roleConfigs() {
     {
       roleName: 'ProcFindData',
       statement: [
-        <% objectGraphServiceTags.forEach(function(tag, idx) { -%>
+<% objectGraphServiceTags.forEach(function(tag, idx) { -%>
         {
           Sid: 'ProcFindDataInvokeGetNode<%= tag %>',
           Effect: 'Allow',
@@ -167,18 +167,17 @@ function roleConfigs() {
             `arn:aws:lambda:${process.env.iz_region}:${process.env.iz_accountId}:function:${lambdaSharedLib.lambdaFunctionName(_izContext, 'GetNodeHdrInv', '<%= tag %>')}`
           ]
         }
-        <% }); -%>
+<% }); -%>
         //(<createProcFindDataRole>)
         //(</createProcFindDataRole>)
       ]
     },
-    <% } -%>
-
-    <% if (hasRelationships && relationshipGraphServiceTags && relationshipGraphServiceTags.length > 0) { -%>
+<% } -%>
+<% if (hasRelationships && relationshipGraphServiceTags && relationshipGraphServiceTags.length > 0) { -%>
     {
       roleName: 'FlowRelationship',
       statement: [
-        <% relationshipGraphServiceTags.forEach(function(tag, idx) { -%>
+<% relationshipGraphServiceTags.forEach(function(tag, idx) { -%>
         {
           Sid: 'FlowRelationshipInvokeGetRelationship<%= tag %>',
           Effect: 'Allow',
@@ -200,13 +199,14 @@ function roleConfigs() {
             `arn:aws:sns:${process.env.iz_region}:${process.env.iz_accountId}:${snsSharedLib.snsTopicNameByFlowSchema(_izContext, 'MoveRelationship_In', '<%= tag %>')}`
           ]
         }
-        <% }); -%>
+<% }); -%>
         //(<createFlowRelationshipRole>)
         //(</createFlowRelationshipRole>)
       ]
-    }
-    <% } -%>
-    <% s3Flows.forEach(function(flow) { -%> {
+    },
+<% } -%>
+<% s3Flows.forEach(function(flow) { -%>
+    {
       roleName: '<%= flow.roleName %>',
       statement: [
         {
@@ -229,7 +229,79 @@ function roleConfigs() {
         //(<create<%= flow.roleName %>Role>)
         //(</create<%= flow.roleName %>Role>)
       ]
-    } <% }); %>
+    },
+<% }); -%>
+<%
+  let nextStepsFlows = [];
+  if (typeof customFlowNextSteps !== 'undefined' && customFlowNextSteps) {
+    nextStepsFlows = customFlowNextSteps;
+  }
+  for (let flowIdx = 0; flowIdx < nextStepsFlows.length; flowIdx++) {
+    const flow = nextStepsFlows[flowIdx];
+    const snsTopicItems = [];
+    const lambdaInvItems = [];
+    for (const s of flow.nextSteps) {
+      if (s.targetType === 'extTopic' || s.targetType === 'ownTopic') {
+        snsTopicItems.push(s);
+      } else if (s.targetType === 'lambdaSyncInv') {
+        lambdaInvItems.push(s);
+      }
+    }
+-%>
+    {
+      roleName: '<%= flow.roleName %>',
+      statement: [
+<%   if (snsTopicItems.length > 0) { -%>
+        {
+          Sid: '<%= flow.roleName %>PublishNextStepsTopics',
+          Effect: 'Allow',
+          Action: ['sns:Publish'],
+          Resource: [
+<%
+      for (let idx = 0; idx < snsTopicItems.length; idx++) {
+        const item = snsTopicItems[idx];
+        let tagArg = '';
+        if (item.serviceTag) {
+          tagArg = `, '${item.serviceTag}'`;
+        }
+        let comma = '';
+        if (idx < snsTopicItems.length - 1) {
+          comma = ',';
+        }
+-%>
+            `arn:aws:sns:${process.env.iz_region}:${process.env.iz_accountId}:${snsSharedLib.snsTopicNameByFlowSchema(_izContext, '<%- item.topic %>'<%- tagArg %>)}`<%= comma %>
+<%    } -%>
+          ]
+        }<% if (lambdaInvItems.length > 0) { %>,<% } %>
+<%   } -%>
+<%   if (lambdaInvItems.length > 0) { -%>
+        {
+          Sid: '<%= flow.roleName %>InvokeNextStepsFunctions',
+          Effect: 'Allow',
+          Action: ['lambda:InvokeFunction'],
+          Resource: [
+<%
+      for (let idx = 0; idx < lambdaInvItems.length; idx++) {
+        const item = lambdaInvItems[idx];
+        let tagArg = '';
+        if (item.serviceTag) {
+          tagArg = `, '${item.serviceTag}'`;
+        }
+        let comma = '';
+        if (idx < lambdaInvItems.length - 1) {
+          comma = ',';
+        }
+-%>
+            `arn:aws:lambda:${process.env.iz_region}:${process.env.iz_accountId}:function:${lambdaSharedLib.lambdaFunctionName(_izContext, '<%- item.topic %>'<%- tagArg %>)}`<%= comma %>
+<%    } -%>
+          ]
+        }
+<%   } -%>
+        //(<create<%= flow.roleName %>Role>)
+        //(</create<%= flow.roleName %>Role>)
+      ]
+    }<% if (flowIdx < nextStepsFlows.length - 1) { %>,<% } %>
+<% } -%>
     //(<additionalRole>)
     //(</additionalRole>)
   ];

package/src/emit/coreFunction/templates/InitialSetupRunner_uploadSchema.ejs

@@ -8,6 +8,7 @@ const SERVICE_TAG = {
   MEDIA: 'Media'
 };
 
+//(<ignoreExternalServices>)
 const ignoreExternalServices = {
   [SERVICE_TAG.TRANSLATIONS]: false,
   [SERVICE_TAG.GRAPH_HANDLER]: false,
@@ -15,6 +16,7 @@ const ignoreExternalServices = {
   [SERVICE_TAG.TRANSLATE_IDS]: false,
   [SERVICE_TAG.MEDIA]: false
 };
+//(</ignoreExternalServices>)
 
 export default async function uploadSchema(_izContext) {
   console.log('======== UploadSchema ========');

package/src/emit/coreFunction/templates/UploadSchema_Main.ejs

@@ -25,6 +25,7 @@ const SERVICE_TAG = {
   MEDIA: 'Media'
 };
 
+//(<ignoreExternalServices>)
 const ignoreExternalServices = {
   [SERVICE_TAG.TRANSLATIONS]: false,
   [SERVICE_TAG.GRAPH_HANDLER]: false,
@@ -32,6 +33,7 @@ const ignoreExternalServices = {
   [SERVICE_TAG.TRANSLATE_IDS]: false,
   [SERVICE_TAG.MEDIA]: false
 };
+//(</ignoreExternalServices>)
 
 const uploadSchema = async (_izContext) => {
   try {

package/src/emit/crud/emitCrudApplicationArtifacts.js

@@ -234,11 +234,11 @@ async function emitAction(action, objects, flows, serviceTag) {
   artifacts.push(
     {
       path: `${source}/${complete}_Main.js`,
-      content: await render('FlowEndpointComplete_Main.ejs', { action })
+      content: await render(`${action}Complete_Main.ejs`, { action })
     },
     {
       path: `${source}/${complete}_HdrSqs.js`,
-      content: await renderShared('FlowHandler_HdrSqs.ejs', {
+      content: await render(`${action}Complete_HdrSqs.ejs`, {
         ...shared,
         mainFileName: `${complete}_Main`,
         functionName: complete,

package/src/emit/crud/emitDynamicCrudFlowSchemas.js

@@ -23,7 +23,10 @@ export function emitDynamicCrudFlowSchemas({ objects, flows = [] }) {
   }
 
   return ACTIONS.map((action, index) => {
-    const flow = _createDynamicFlow(action, _hasBeforeLogicalStep(flows, action));
+    const flow = _createDynamicFlow(
+      action,
+      _hasBeforeLogicalStep(flows, action)
+    );
     return {
       path: dynamicCrudFlowSchemaPaths[index],
       content: renderDynamicCrudFlowSchema(action, flow)
@@ -36,6 +39,23 @@ function _createDynamicFlow(action, hasBeforeLogicalStep) {
   const flowSteps = [
     {
       stepName: 'start',
+      ...(hasBeforeLogicalStep
+        ? {
+            nextSteps: [
+              {
+                stepName: 'BeforeLogical'
+              }
+            ]
+          }
+        : outputTopic
+        ? {
+            nextSteps: [
+              {
+                stepName: 'Complete'
+              }
+            ]
+          }
+        : {}),
       properties: [],
       messageAttributes: MESSAGE_ATTRIBUTES,
       ...(outputTopic
@@ -53,6 +73,16 @@ function _createDynamicFlow(action, hasBeforeLogicalStep) {
     flowSteps.push({
       stepName: 'BeforeLogical',
       event: ['extTopic'],
+      previousSteps: [
+        {
+          stepName: 'start'
+        }
+      ],
+      nextSteps: [
+        {
+          stepName: 'Complete'
+        }
+      ],
       properties: [],
       messageAttributes: MESSAGE_ATTRIBUTES
     });
@@ -62,7 +92,18 @@ function _createDynamicFlow(action, hasBeforeLogicalStep) {
     flowSteps.push({
       stepName: 'Complete',
       event: ['extTopic'],
-      properties: [],
+      previousSteps: [
+        {
+          stepName: hasBeforeLogicalStep ? 'BeforeLogical' : 'start'
+        }
+      ],
+      properties: [
+        'returnValue',
+        'parentFlowId',
+        'status',
+        'errorsFound',
+        'graphServiceTag'
+      ],
       messageAttributes: MESSAGE_ATTRIBUTES
     });
   }

package/src/emit/crud/templates/CreateComplete_HdrSqs.ejs

@@ -0,0 +1,99 @@
+import { middlewareHandler as middleware } from '@izara_project/izara-middleware';
+import { recordHandlerSharedLib } from '@izara_project/izara-core-library-record-handler';
+import Logger from '@izara_project/izara-core-library-logger';
+import callingFlowSharedLib from '@izara_project/izara-core-library-calling-flow';
+import CreateComplete from './CreateComplete_Main.js';
+
+//(<optionalRequire>)
+//(</optionalRequire>)
+
+// validate event properties in body.Message of sqs event
+let perRecordsValidatorSchema = {
+  type: 'object',
+  properties: {
+    returnValue: {
+      type: 'object'
+    },
+    parentFlowId: {
+      type: 'string'
+    },
+    status: {
+      type: 'string'
+    },
+    errorsFound: {
+      type: 'array'
+    },
+    graphServiceTag: {
+      type: 'string'
+    }
+  },
+  required: [
+    'returnValue',
+    'parentFlowId',
+    'status',
+    'errorsFound',
+    'graphServiceTag'
+  ]
+  //(<validatorSchema>)
+  //(</validatorSchema>)
+};
+
+let messageAttributeValidatorSchema = null;
+middleware.setValidatorSchema(recordHandlerSharedLib.baseValidatorSchema());
+
+export const main = middleware.wrap(async (event, context) => {
+  try {
+    let recordPromises = [];
+
+    // loop each record and send to mainFunction
+    await Promise.all(
+      event.Records.map(async (record) => {
+        let passOnProperties = [];
+        record._izContext.logger.debug('record ReceiveMsgOutHdrSqs', record);
+
+        //validate message (and MessageAttributes)
+        await recordHandlerSharedLib.validateRecord(
+          record, // one record will send to mainFunction
+          'CreateCompleteHdrSqs', // queue name that need to retry or send to dlq
+          perRecordsValidatorSchema, // schema for record.Message
+          messageAttributeValidatorSchema
+        );
+
+        // add argument (to invoke lambda) to passOnProperties[]
+        passOnProperties.push(record.body.Message);
+        passOnProperties.push(
+          callingFlowSharedLib.addPassBackPropertiesToPassOnProperties(
+            record.body.Message
+          )
+        );
+        //(<additionalParams>)
+        //(</additionalParams>)
+        record._izContext.logger.debug(
+          'passOnProperties in handler',
+          passOnProperties
+        );
+
+        // call recordHandlerSharedLib.recordHandler with 3 parameters and return promise(resolve)
+        let recordPromise = recordHandlerSharedLib.recordHandler(
+          record, // one record will send to mainFunction
+          CreateComplete, // mainFunction that need to invoke.
+          'CreateCompleteHdrSqs', // queue name that need to retry or send to dlq
+          passOnProperties // all parameters that mainFunction needed.
+        );
+        record._izContext.logger.debug('after recordPromise in handler');
+        recordPromises.push(recordPromise); // push promise to recordPromises
+      })
+    );
+    try {
+      await Promise.all(recordPromises);
+      return event.Records;
+    } catch {
+      Logger.debug(
+        'Promise.all(recordPromises) in handler threw error (at least one record did no resolve)'
+      );
+    }
+  } catch (error) {
+    Logger.error('Unhandled Error, CreateComplete_HdrSqs: ', error);
+    throw error;
+  }
+});

package/src/emit/crud/templates/CreateComplete_Main.ejs

@@ -0,0 +1,188 @@
+import asyncFlowSharedLib from '@izara_project/izara-core-library-asynchronous-flow';
+import callingFlowSharedLib from '@izara_project/izara-core-library-calling-flow';
+import dynamodbSharedLib from '@izara_project/izara-core-library-dynamodb';
+import snsSharedLib from '@izara_project/izara-core-library-sns';
+import { sns } from '@izara_project/izara-core-library-external-request';
+import { consts } from '@izara_project/izara-core-library-service-schemas';
+import { NoRetryError } from '@izara_project/izara-core-library-core';
+
+//(<optionalRequire>)
+//(</optionalRequire>)
+
+const { TOPIC_NAME_GENERATE_CODE } = consts;
+const PREFIX = { ASYNC: 'CreateAsyncEndpoint' };
+
+function empty(value) {
+  return (
+    value == null ||
+    (typeof value === 'object' && Object.keys(value).length === 0)
+  );
+}
+
+function validateInput(returnValue, status, graphServiceTag, errorsFound) {
+  if (!returnValue?.queryResult)
+    errorsFound.push(
+      'message is not have property queryResult, should be not happen'
+    );
+  if (!returnValue?.requestParams?.objType)
+    errorsFound.push(
+      'message is not have property objType, should be not happen'
+    );
+  if (!returnValue?.requestParams?.objInstanceFull)
+    errorsFound.push(
+      'message is not have property objInstance, should be not objInstance'
+    );
+  if (status === 'error' && errorsFound.length === 0)
+    errorsFound.push(
+      '[invalid]status is error not have errorsFound form graphService'
+    );
+  if (status === 'complete' && errorsFound.length > 0)
+    errorsFound.push(
+      '[Invalid] status is complete should be not have errorsFound'
+    );
+  if (graphServiceTag == null)
+    errorsFound.push('[Invalid] graphServerTag is not empty string');
+}
+
+export default async function CreateComplete(
+  _izContext,
+  requestParams,
+  passBackProperties
+  //(<additionalParams>)
+  //(</additionalParams>)
+) {
+  try {
+    _izContext.logger.debug('[CreateComplete] started', {
+      requestParams
+    });
+    const {
+      returnValue,
+      status,
+      errorsFound = [],
+      graphServiceTag,
+      parentFlowId
+    } = requestParams;
+    if (empty(returnValue?.requestParams))
+      throw new NoRetryError('message not an object');
+    validateInput(returnValue, status, graphServiceTag, errorsFound);
+    if (errorsFound.length > 0) errorsFound.push(errorsFound.join(','));
+
+    const awaitingStepId = await asyncFlowSharedLib.createAwaitingStepId(
+      parentFlowId,
+      PREFIX.ASYNC
+    );
+    const pending =
+      await asyncFlowSharedLib.findPendingStepAwaitingMultipleSteps(
+        _izContext,
+        awaitingStepId
+      );
+    _izContext.logger.debug('[CreateComplete] awaiting step', {
+      awaitingStepId,
+      pending
+    });
+    if (!pending) {
+      _izContext.logger.warn(
+        `No pending step found for awaitingStepId: ${awaitingStepId}`
+      );
+      return { returnValue, status, errorsFound };
+    }
+    const result =
+      await asyncFlowSharedLib.checkAllAwaitingStepsFinishedWithReturnParams(
+        _izContext,
+        pending.pendingStepId,
+        awaitingStepId,
+        errorsFound
+      );
+    _izContext.logger.debug(
+      '[CreateComplete] all awaiting steps result',
+      {
+        isComplete: result.isComplete,
+        awaitingStepId,
+        pendingStepId: pending.pendingStepId
+      }
+    );
+
+    if (result.isComplete) {
+      const nodeResultKey = `returnCreatedNode`;
+      const fallbackNodeResultKey = `returnCreateNode`;
+      const nodeResult =
+        returnValue.queryResult[nodeResultKey] ??
+        returnValue.queryResult[fallbackNodeResultKey] ??
+        {};
+      const node = nodeResult.createNodeResult ?? nodeResult;
+      const existsNode =
+        node.existsNode && Object.keys(node.existsNode).length
+          ? {
+              objType: returnValue.requestParams.objType,
+              objInstanceFull: node.existsNode.objInstanceFull
+            }
+          : null;
+      if (status === 'complete') {
+        await Promise.all(
+          (pending.listOfRecords ?? []).flatMap((records) =>
+            Object.values(records).map(async (record) =>
+              dynamodbSharedLib.putItem(
+                _izContext,
+                await dynamodbSharedLib.tableName(
+                  _izContext,
+                  record.tableName,
+                  record.serviceTag
+                ),
+                {
+                  ...record.objInstanceFull.identifiers,
+                  ...record.objInstanceFull.fields
+                }
+              )
+            )
+          )
+        );
+      }
+      const message =
+        callingFlowSharedLib.addParentPassBackPropertiesToSnsResponseMessageObject(
+          passBackProperties,
+          {
+            objType: returnValue.requestParams.objType,
+            objInstanceFull: node.objInstanceFull,
+            relationships: node.relationships,
+            parentFlowId: parentFlowId || returnValue?.parentFlowId,
+            existsNode,
+            status,
+            errorsFound
+          }
+        );
+      const messageAttributes =
+        callingFlowSharedLib.addParentPassBackCallingFlowToSnsResponseMessageAttributes(
+          passBackProperties,
+          {}
+        );
+      const topicArn = snsSharedLib.snsTopicArnByFlowSchema(
+        _izContext,
+        TOPIC_NAME_GENERATE_CODE.outCreateNodeComplete
+      );
+      _izContext.logger.debug('[CreateComplete] publishing to SNS', {
+        TopicArn: topicArn,
+        message
+      });
+      await sns.publishAsync(_izContext, {
+        Message: JSON.stringify(message),
+        MessageAttributes: sns.createStringMessageAttributes(
+          _izContext,
+          messageAttributes
+        ),
+        TopicArn: topicArn
+      });
+      //(<afterSendMessage>)
+      //(</afterSendMessage>)
+    }
+    await asyncFlowSharedLib.removeAwaitingMultipleStep(
+      _izContext,
+      awaitingStepId,
+      pending.pendingStepId,
+      errorsFound
+    );
+    return { returnValue, status, errorsFound };
+  } catch (error) {
+    _izContext.logger.error('[CreateComplete] error:', error);
+    throw error;
+  }
+}