@izara_project/izara-market-library-service-schemas 1.0.23 → 1.0.25

package/src/reStructure/TemplateData/relationshipPerAction/create/complete/functionYaml/template.ejs

@@ -0,0 +1,20 @@
+<%_ const join = require('path').join; _%>
+<%- firstLetterUpperCase(functionNameConfig) %>:
+  handler: <%- join(resourceLocation, `${firstLetterUpperCase(functionName)}_${firstLetterUpperCase(handlerType)}.main`)%>
+  name: ${self:custom.iz_resourcePrefix}<%- firstLetterUpperCase(functionName) %>
+  events:
+    - sqs:
+        arn: arn:aws:sqs:${self:custom.iz_region}:${self:custom.iz_accountId}:${self:custom.iz_resourcePrefix}<%- firstLetterUpperCase(functionName) %>
+        batchSize: 10
+        filterPatterns: #**** need to update serverless framwork upper v.2.69.1
+          - body: {"MessageAttributes":{"callingFlow":{"Value":["${self:custom.iz_resourcePrefix}<%-firstLetterUpperCase(functionName) %>"]}}} # functionName of callingFlow
+          - body: {"MessageAttributes":{"callingFlow":{"Value":[{"exists":false}]}}}
+  role: <%- roleName %>Role
+    #<#<%- functionName %><%- handlerType %>IamRole#>
+    #<#/<%- functionName %><%- handlerType %>IamRole#>
+<%_ function firstLetterUpperCase(text){
+  return text.charAt(0).toUpperCase() + text.slice(1)
+} _%>
+<%_ function firstLetterLowerCase(str) {
+  return str.charAt(0).toLowerCase() + str.slice(1)
+} _%>

package/src/reStructure/TemplateData/relationshipPerAction/create/complete/handler/sqs/data.js

@@ -0,0 +1,60 @@
+/*
+Copyright (C) 2020 Sven Mason <http://izara.io>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+'use strict';
+const path = require('path');
+
+const { ACTIONS, HANDLER } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../../MainLibs/index.js").utils;
+const { SOURCE_PATH, FUNCTION_NAME } = require("../../../../../../../MainLibs/index.js").consts;
+
+const templatePath = path.join(__dirname, "./template.ejs")
+
+/**
+ * receive objectSchema
+ * create data for hdrInv template
+ *
+ * @return {{ templatePath, templateData, setting } }
+ */
+function data(_izContext, srcPath) {
+  const createSourceParams = createParamForCreateSource(srcPath)
+  return [createSourceParams];
+}
+
+
+function createParamForCreateSource(srcPath) {
+  const functionName = FUNCTION_NAME.createRelComplete;
+  const handler = HANDLER.hdrSqs
+
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName: upperCase(functionName),
+      queueName: upperCase(functionName) + upperCase(handler),
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: `${upperCase(functionName)}_${upperCase(handler)}`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+
+module.exports = data;

package/src/reStructure/TemplateData/relationshipPerAction/create/complete/handler/sqs/template.ejs

@@ -0,0 +1,125 @@
+/*
+Copyright (C) 2020 Sven Mason <http://izara.io>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+'use strict';
+
+// const AWS = require('aws-sdk');
+// const sqs = new AWS.SQS({ apiVersion: '2012-11-05' });
+
+const izara = require("@izara_project/izara-middleware");
+const middleware = izara.middlewareHandler;
+const izaraShared = require('@izara_project/izara-shared');
+const recordHandlerSharedLib = izaraShared.recordHandlerSharedLib
+const callingFlowSharedLib = izaraShared.callingFlowSharedLib;
+
+const createRelationshipComplete = require('./CreateRelationshipComplete_Main');
+const Logger = require('@izara_project/izara-core-library-logger');
+// validate event properties in body.Message of sqs event
+middleware.setValidatorSchema(recordHandlerSharedLib.baseValidatorSchema());
+// set schema for record.body.Message
+let perRecordsValidatorSchema = {
+  type: "object",
+  required: [
+    'returnValue',
+    'status',
+    'errorsFound'
+  ],
+  properties: {
+    returnValue: {
+      type: 'object',
+    },
+    status: {
+      type: 'string',
+    },
+    errorsFound: {
+      type: 'array',
+      default: []
+    }
+  }
+};
+
+// set schema for record.body.MessageAttributes
+// const messageAttributeValidatorSchema = {
+//   type: "object",
+//   required: ['msgAtrrParam1', 'msgAtrrParam2'],
+//   properties: {
+//     msgAtrrParam1: {
+//       type: "string"
+//     },
+//     msgAtrrParam2: {
+//       type: "object"
+//     }
+//   }
+// };
+
+perRecordsValidatorSchema = callingFlowSharedLib.addOptionalPassBackPropertiesToValidatorSchema(perRecordsValidatorSchema); // is Ok passBackProperties
+module.exports.main = middleware.wrap(async (event, context, callback) => {
+
+  try {
+
+    let recordPromises = [];
+
+    // loop each record and send to mainFunction
+    await Promise.all(event.Records.map(async record => { // promise.all for map() function
+
+      let passOnProperties = []
+      record._izContext.logger.debug('record ReceiveMsgOutHdrSqs', record);
+
+      //validate message (and MessageAttributes)
+      await recordHandlerSharedLib.validateRecord(
+        record,                             // one record will send to mainFunction
+        "CreateRelationshipComplete",       // queue name that need to retry or send to dlq
+        perRecordsValidatorSchema,          // schema for record.Message
+        // messageAttributeValidatorSchema  // ----- for msgAttr default is null -> do not send this parameter if not want to validate msgAtt
+      );
+
+      // add argument (to invoke lambda) to passOnProperties[]
+      passOnProperties.push(record.body.Message.returnValue)
+      passOnProperties.push(record.body.Message.status)
+      passOnProperties.push(record.body.Message.errorsFound)
+      passOnProperties.push(callingFlowSharedLib.addPassBackPropertiesToPassOnProperties(record.body.Message)) // is Ok PassBackProperties
+      // passOnProperties.push(callingFlowSharedLib.addCallingFlowToPassOnProperties(record.body.Message)) // is Ok callinfFlow
+      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
+        createRelationshipComplete.createRelationshipComplete,  // mainFunction that need to invoke.
+        "CreateRelationshipComplete",                           // 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
+    }))
+
+    Logger.debug('before Promise.all(recordPromises) in handler');
+    try {
+      // --- main await all promises
+      await Promise.all(recordPromises); // await all promises
+
+      return event.Records // return all for local testing
+
+    } catch {
+      Logger.debug('Promise.all(recordPromises) in handler threw error (at least one record did no resolve)');
+    }
+    Logger.debug('after Promise.all(recordPromises) in handler');
+
+  } catch (err) {
+    Logger.error('Unhandled Error, CreateRelationshipCompleteHdrSqs: ', err);
+    throw (err);
+  }
+});

package/src/reStructure/TemplateData/relationshipPerAction/create/complete/mainFunction/data.js

@@ -0,0 +1,55 @@
+/*
+Copyright (C) 2020 Sven Mason <http://izara.io>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+'use strict';
+const path = require('path');
+
+const { ACTIONS, HANDLER } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase, firstLetterUpperCase } = require("../../../../../../MainLibs/index.js").utils;
+const { SOURCE_PATH, FUNCTION_NAME } = require("../../../../../../MainLibs/index.js").consts;
+
+const templatePath = path.join(__dirname, "./template.ejs")
+
+/**
+ * receive objectSchema
+ * create data for hdrInv template
+ *
+ * @return {{ templatePath, templateData, setting } }
+ */
+function data(_izContext, srcPath) {
+  const createSourceParams = createParamForCreateSource(srcPath)
+  return [createSourceParams];
+}
+
+
+function createParamForCreateSource(srcPath) {
+  const functionName = FUNCTION_NAME.createRelComplete;
+  return {
+    templatePath: templatePath,
+    templateData: {
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: `${upperCase(functionName)}_Main`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+module.exports = data;

package/src/reStructure/TemplateData/relationshipPerAction/create/complete/mainFunction/template.ejs

@@ -0,0 +1,141 @@
+/*
+Copyright (C) 2020 Sven Mason <http://izara.io>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+'use strict';
+const hash = require("object-hash");
+
+const izaraShared = require('@izara_project/izara-shared');
+const callingFlowSharedLib = izaraShared.callingFlowSharedLib;
+const configSharedLib = izaraShared.configSharedLib;
+const snsSharedLib = izaraShared.snsSharedLib;
+const asyncFlowSharedLib = izaraShared.asyncFlowSharedLib;
+const dynamodbSharedLib = izaraShared.dynamodbSharedLib;
+
+const sns = require("@izara_project/izara-core-library-external-request").sns;
+const NoRetryError = require("@izara_project/izara-core-library-core/src/NoRetryError");
+
+const { explodedObjectTypeId, explodedRelationshipTypeId, createLinkTypeId } = require('@izara_project/izara-core-library-service-schemas/src/Utils')
+
+const {
+  TOPIC_NAME_GENERATE_CODE,
+  TOPIC_NAME_GRAPH_HANDLER,
+  PREFIX
+} = require('@izara_project/izara-market-library-service-schemas/src/GenerateCodeLibs/src/Consts')
+
+module.exports.createRelationshipComplete = async (
+  _izContext,
+  returnValue,
+  status,
+  errorsFound,
+  passBackProperties = {},
+
+) => {
+  try {
+    _izContext.logger.debug("Function:createRelationshipComplete", {
+      returnValue: returnValue,
+      status: status,
+      errorsFound: errorsFound,
+      passBackProperties: passBackProperties,
+    });
+
+
+    // start create awaitingStepId
+    const linkTypeId = createLinkTypeId(
+      _izContext,
+      returnValue.firstObject.objType,
+      returnValue.secondObject.objType,
+      returnValue.relType,
+      returnValue.relationshipDirection
+    );
+
+    let awaitingStepId = asyncFlowSharedLib.createAwaitingStepId(
+      hash({
+        linkTypeId,
+        relationshipProperties: returnValue.relationshipProperties,
+        graphServiceTag: passBackProperties.passBackProperties.graphServiceTag
+      }), // hash id
+      PREFIX.createRel // prefix, use constant further
+    )
+
+
+    let createRelPendingObjects = await dynamodbSharedLib.query(
+      _izContext,
+      await dynamodbSharedLib.tableName(_izContext, "AwaitingMultipleSteps"),
+      {
+        awaitingStepId: awaitingStepId
+      }
+    );
+    _izContext.logger.debug("record of createRelPendingObjects ::", createRelPendingObjects);
+
+
+
+    await Promise.all(
+      createRelPendingObjects.Items.map(async ({ pendingStepId }) => {
+        if (await asyncFlowSharedLib.checkAllAwaitingStepsFinished(
+          _izContext,
+          pendingStepId, // task waiting
+          awaitingStepId
+        )) {
+          _izContext.logger.debug("finished all awaitingStep");
+
+          let createCompleteMsg = {
+            firstObject: returnValue.firstObject,
+            secondObject: returnValue.secondObject,
+            relType: returnValue.relType,
+            relationshipProperties: returnValue.relationshipProperties,
+            status: status,
+            errorFounds: errorsFound
+          };
+
+          createCompleteMsg = callingFlowSharedLib.addParentPassBackPropertiesToSnsResponseMessageObject(passBackProperties, createCompleteMsg);
+          _izContext.logger.debug("After addCallingFlowToSnsResponseMessageObject", createCompleteMsg);
+
+          let messageAttributes = callingFlowSharedLib.addParentPassBackCallingFlowToSnsResponseMessageAttributes(passBackProperties, {});
+          _izContext.logger.debug("After addCallingFlowToSnsResponseMessageAttributes", createCompleteMsg);
+
+          let sendMessageToOutCreateRelatonshipComplete = {
+            Message: JSON.stringify(createCompleteMsg),
+            MessageAttributes: sns.createStringMessageAttributes(_izContext, messageAttributes),
+            TopicArn: await snsSharedLib.snsTopicArn(_izContext, TOPIC_NAME_GENERATE_CODE.outCreateRelComplete)
+          };
+          _izContext.logger.debug("Send message to OutCreateRelationshipComplete :::>", sendMessageToOutCreateRelatonshipComplete);
+          await sns.publishAsync(_izContext, sendMessageToOutCreateRelatonshipComplete);
+
+
+          // remove awaitingMultipleStep after finished
+          await asyncFlowSharedLib.removeAwaitingMultipleStep(
+            _izContext,
+            awaitingStepId,
+            pendingStepId,
+          );
+
+        } // check pendingStepId finished
+      }) // end per pendingStep
+    );
+
+
+    return {
+      returnValue,
+      status,
+      errorsFound
+    }
+
+  } catch (err) {
+    _izContext.logger.error('error createRelationshipComplete:', err)
+    throw (err)
+  }
+}

package/src/reStructure/TemplateData/relationshipPerAction/create/complete/sns-in-sqs/data.js

@@ -0,0 +1,71 @@
+/*
+Copyright (C) 2020 Sven Mason <http://izara.io>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+'use strict';
+
+const path = require("path")
+
+// const {
+//   HANDLER,
+// STORAGE_TYPES
+// } = require('@izara_project/izara-core-library-service-schemas/src/Consts');
+
+
+const STORAGE_TYPES = {
+  dynamoDB: "dynamoDB",
+  graph: "graph"
+}
+
+const templatePath = path.join(__dirname, './template.ejs');
+const { SOURCE_PATH, FUNCTION_NAME, SAVE_FILE_NAME } = require('../../../../../../MainLibs/index.js').consts;
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../MainLibs/index.js").utils;
+
+
+/**
+ * create data for dynamoDbYaml tempalte from objectSchema
+ * return array of dynamoDb data
+ * because one objectSchema can create multiple dynamoDb table
+ *
+ * @param {Object} _izContext
+ * @param {String} saveFilePath
+ * @returns {Object[]}              - data of multiple dynamoDb template
+ */
+
+function createDataForDefaultSnsInSqs(_izContext, srcPath) {
+  let createCreateRelationCompleteQueue = [];
+  const createRelationshipCompleteQueues = [
+    {
+      queueName: upperCase(FUNCTION_NAME.createRelComplete)
+    }
+  ]
+  for (let createRelationshipCompleteQueue of createRelationshipCompleteQueues) {
+    createCreateRelationCompleteQueue.push({
+      templatePath: templatePath,
+      templateData: createRelationshipCompleteQueue,
+      setting: {
+        initialData: "Resources:\n",
+        savePath: path.join(srcPath, SOURCE_PATH.resourceYaml),
+        saveFileName: SAVE_FILE_NAME.snsInSqsYaml,
+        fileExtension: ".yml",
+        isAppend: true
+      }
+    })
+  }
+  return createCreateRelationCompleteQueue
+}
+
+module.exports = createDataForDefaultSnsInSqs;

package/src/reStructure/TemplateData/relationshipPerAction/create/complete/sns-in-sqs/template.ejs

@@ -0,0 +1,47 @@
+##===== [Queue]
+  <%- queueName %>:
+    Type: "AWS::SQS::Queue"
+    Properties:
+      QueueName: ${self:custom.iz_resourcePrefix}<%- queueName %>
+      RedrivePolicy:
+        deadLetterTargetArn:
+        # !GetAtt
+          Fn::GetAtt:
+            - <%- queueName %>DLQ
+            - Arn
+        maxReceiveCount: 3
+      VisibilityTimeout: 120
+##==== [QueueDLQ]
+  <%- queueName %>DLQ:
+    Type: AWS::SQS::Queue
+    Properties:
+      QueueName: ${self:custom.iz_resourcePrefix}<%- queueName %>DLQ
+##==== [QueuePolicy]
+  <%- queueName %>Policy:
+    Type: AWS::SQS::QueuePolicy
+    Properties:
+      PolicyDocument:
+        Version: "2012-10-17"
+        Statement:
+          - Sid: "allow-sns-messages"
+            Effect: Allow
+            Principal: "*"
+            Resource:
+            # !GetAtt
+              Fn::GetAtt:
+                - <%- queueName %>
+                - Arn
+            Action: "SQS:SendMessage"
+      Queues:
+        - Ref: <%- queueName %>
+  #<#<%- firstLetterUpperCase(queueName) %>QueueSetting#>
+  #<#/<%- firstLetterUpperCase(queueName) %>QueueSetting#>
+
+
+  <%_ function firstLetterUpperCase(text){
+    return text.charAt(0).toUpperCase() + text.slice(1)
+  } _%>
+  <%_ function firstLetterLowerCase(str) {
+    return str.charAt(0).toLowerCase() + str.slice(1)
+  } _%>
+

package/src/reStructure/TemplateData/relationshipPerAction/create/complete/sns-out/data.js

@@ -0,0 +1,71 @@
+/*
+Copyright (C) 2020 Sven Mason <http://izara.io>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+'use strict';
+
+const path = require("path")
+
+// const {
+//   HANDLER,
+// STORAGE_TYPES
+// } = require('@izara_project/izara-core-library-service-schemas/src/Consts');
+
+
+const STORAGE_TYPES = {
+  dynamoDB: "dynamoDB",
+  graph: "graph"
+}
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../MainLibs/index.js").utils;
+const { SOURCE_PATH, SAVE_FILE_NAME, FUNCTION_NAME } = require("../../../../../../MainLibs/index.js").consts;
+const templatePath = path.join(__dirname, './template.ejs')
+
+/**
+ * create data for dynamoDbYaml tempalte from objectSchema
+ * return array of dynamoDb data
+ * because one objectSchema can create multiple dynamoDb table
+ *
+ * @param {Object} _izContext
+ * @param {String} saveFilePath
+ * @returns {Object[]}              - data of multiple dynamoDb template
+ */
+
+function createDefaultSnsOut(_izContext, srcPath) {
+  const createSourceParams = createParamsForCreateSource(_izContext, srcPath)
+  // console.log("createSourceParamsCreateRelationshipComplete", createSourceParams)
+
+  return [createSourceParams]
+}
+
+function createParamsForCreateSource(_izContext, srcPath) {
+  let queueName = FUNCTION_NAME.createRelComplete;
+  return {
+    templatePath: templatePath,
+    templateData: {
+      queueName: upperCase(queueName)
+    },
+    setting: {
+      initialData: 'Resources:\n',
+      savePath: path.join(srcPath, SOURCE_PATH.resourceYaml),
+      saveFileName: SAVE_FILE_NAME.snsOutYaml,
+      fileExtension: '.yml',
+      isAppend: true
+    }
+  }
+}
+
+module.exports = createDefaultSnsOut

package/src/reStructure/TemplateData/relationshipPerAction/create/complete/sns-out/template.ejs

@@ -0,0 +1,10 @@
+##--------- [Create Topic Out]
+  Out<%- firstLetterUpperCase(queueName) %>:
+    Type: AWS::SNS::Topic
+    Properties:
+      DisplayName: "SNS Message out"
+      TopicName: ${self:custom.iz_resourcePrefix}Out<%- firstLetterUpperCase(queueName) %>
+
+  <%_ function firstLetterUpperCase(text) {
+    return text.charAt(0).toUpperCase() + text.slice(1)
+  } _%>