@izara_project/izara-market-library-service-schemas 1.0.62 → 1.0.64

package/src/reStructure/TemplateData/relationshipPerAction/changeRelationship/action/sns-in-sqs/data.js

@@ -0,0 +1,77 @@
+/*
+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,
+} = require('@izara_project/izara-core-library-service-schemas/src/Consts');
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../MainLibs/index.js").utils;
+const { SOURCE_PATH, SAVE_FILE_NAME, FUNCTION_NAME } = require("../../../../../../MainLibs/index.js").consts;
+const snsTemplatePath = path.join(__dirname, "./snsTemplate.ejs")
+const sqsTemplatePath = path.join(__dirname, "./sqsTemplate.ejs")
+
+/**
+ * create data for dynamoDbYaml tempalte from objectSchema
+ *
+ * @param {Object} _izContext
+ * @param {String} saveFilePath
+ * @returns {Object[]}              - data of multiple dynamoDb template
+ */
+
+function createRelationshipSnsInSqs(_izContext, srcPath) {
+  let resultForCreateRelationshipSnsAndSqs = [];
+  const setting = {
+    initialData: "Resources:\n",
+    savePath: path.join(srcPath, SOURCE_PATH.resourceYaml),
+    saveFileName: SAVE_FILE_NAME.snsInSqsYaml,
+    fileExtension: ".yml",
+    isAppend: true
+  }
+  const createRelationshipQueueNames = [
+    {
+      queueName: upperCase(FUNCTION_NAME.changeRel)
+    },
+    {
+      queueName: upperCase(FUNCTION_NAME.changeRel) + upperCase(HANDLER.hdrDsq)
+    }
+  ]
+  for (let createRelationshipQueueName of createRelationshipQueueNames) {
+    if (createRelationshipQueueName.queueName.includes("HdrDsq")) {
+      resultForCreateRelationshipSnsAndSqs.push({
+        templatePath: sqsTemplatePath,
+        templateData: createRelationshipQueueName,
+        setting: setting
+      }
+      )
+    } else {
+      resultForCreateRelationshipSnsAndSqs.push(
+        {
+          templatePath: snsTemplatePath,
+          templateData: createRelationshipQueueName,
+          setting: setting
+        }
+      )
+    }
+  }
+  return resultForCreateRelationshipSnsAndSqs
+}
+
+module.exports = createRelationshipSnsInSqs

package/src/reStructure/TemplateData/relationshipPerAction/changeRelationship/action/sns-in-sqs/snsTemplate.ejs

@@ -0,0 +1,59 @@
+##===== [Create topic in]
+  In<%- queueName %>:
+    Type: AWS::SNS::Topic
+    Properties:
+      DisplayName: "SNS Message in"
+      TopicName: ${self:custom.iz_serviceTag}_${self:custom.iz_stage}_<%- queueName %>_In
+##===== SNS Subscription
+##===== [Topic In]
+  SubscriptionIn<%- queueName %>:
+    Type: AWS::SNS::Subscription
+    Properties:
+      TopicArn: !Ref In<%- queueName %>
+      Endpoint: "arn:aws:sqs:${self:custom.iz_region}:${self:custom.iz_accountId}:${self:custom.iz_resourcePrefix}<%- queueName %>HdrSqs"
+      Protocol: "sqs"
+##===== [Queue]
+  <%- queueName %>HdrSqs:
+    Type: "AWS::SQS::Queue"
+    Properties:
+      QueueName: ${self:custom.iz_resourcePrefix}<%- queueName %>HdrSqs
+      RedrivePolicy:
+        deadLetterTargetArn:
+        # !GetAtt
+          Fn::GetAtt:
+            - <%- queueName %>HdrSqsDLQ
+            - Arn
+        maxReceiveCount: 3
+      VisibilityTimeout: 120
+##==== [QueueDLQ]
+  <%- queueName %>HdrSqsDLQ:
+    Type: AWS::SQS::Queue
+    Properties:
+      QueueName: ${self:custom.iz_resourcePrefix}<%- queueName %>HdrSqsDLQ
+##==== [QueuePolicy]
+  <%- queueName %>HdrSqsPolicy:
+    Type: AWS::SQS::QueuePolicy
+    Properties:
+      PolicyDocument:
+        Version: "2012-10-17"
+        Statement:
+          - Sid: "allow-sns-messages"
+            Effect: Allow
+            Principal: "*"
+            Resource:
+            # !GetAtt
+              Fn::GetAtt:
+                - <%- queueName %>HdrSqs
+                - Arn
+            Action: "SQS:SendMessage"
+      Queues:
+        - Ref: <%- queueName %>HdrSqs
+  #<#<%- 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/changeRelationship/action/sns-in-sqs/sqsTemplate.ejs

@@ -0,0 +1,43 @@
+#------- 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
+
+  <%- queueName %>DLQ:
+    Type: AWS::SQS::Queue
+    Properties:
+      QueueName: ${self:custom.iz_resourcePrefix}<%- queueName %>DLQ
+
+  <%- 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/changeRelationship/complete/functionYaml/data.js

@@ -0,0 +1,121 @@
+/*
+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, STORAGE_TYPES } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../MainLibs/index.js").utils;
+const {
+  createIamRole,
+  resourceNames,
+  RESOURCE_CLASSES,
+  SQS_RESOURCE,
+  SOURCE_PATH,
+  SAVE_FILE_NAME,
+  FUNCTION_NAME,
+  defaultIamRolePerAction,
+  awaitingMultipleStepsRole,
+  SNS_RESOURCE,
+  shortNameHandler,
+  SHORT_FUNCTION_NAME,
+  SOURCE_GENERATE_IAM_ROLE
+} = require("../../../../../../MainLibs/src/Consts.js");
+
+const templatePath = path.join(__dirname, "./template.ejs")
+
+/**
+ * receive objectSchema
+ * create data for updateRelationshipSchema
+ *
+ * @param {Object} objectSchema
+ * @return {{ templatePath, templateData, setting } }
+ */
+
+function data(_izContext, srcPath) {
+  let createSourceArray = [];
+  const createSourceParam = createParamForCreateSource(srcPath);
+  createSourceArray.push(createSourceParam);
+  return createSourceArray
+}
+
+
+function createParamForCreateSource(srcPath) {
+  let handlerType = upperCase(HANDLER.hdrSqs);
+  let functionName = FUNCTION_NAME.changeRelComplete
+  let additionalResourcePermission = defaultIamRolePerAction();
+
+  additionalResourcePermission.push(
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.sqs]: [
+          SQS_RESOURCE.deleteMessage,
+          SQS_RESOURCE.getQueueAttributes,
+          SQS_RESOURCE.receiveMessage,
+          SQS_RESOURCE.sendMessage,
+          SQS_RESOURCE.deleteMessageBatch,
+          SQS_RESOURCE.getQueueUrl,
+        ],
+
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.sqs, upperCase(functionName)),
+        resourceNames(RESOURCE_CLASSES.sqs, upperCase(functionName) + "DLQ"),
+
+      ],
+    ),
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.sns]:
+          [
+            SNS_RESOURCE.publish, SNS_RESOURCE.subscribe
+          ]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.sns, upperCase(functionName) + "_In"),
+        resourceNames(RESOURCE_CLASSES.sns, upperCase(functionName) + "_Out")
+      ]
+    )
+  )
+
+
+
+  additionalResourcePermission.push(awaitingMultipleStepsRole())
+
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      handlerType,
+      additionalResourcePermission,
+      resourceLocation: SOURCE_PATH.resourceLocationRelationshipPerAction,
+      functionNameConfig: upperCase(SHORT_FUNCTION_NAME.changeRelComplete),
+      roleName: SOURCE_GENERATE_IAM_ROLE.RelationshipCompleteRole
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
+      saveFileName: SAVE_FILE_NAME.functionRelationshipYaml,
+      fileExtension: '.yml',
+      isAppend: true
+    }
+
+  }
+}
+
+
+module.exports = data;

package/src/reStructure/TemplateData/relationshipPerAction/changeRelationship/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 framework 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/changeRelationship/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.changeRelComplete;
+  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/changeRelationship/complete/handler/sqs/template.ejs

@@ -0,0 +1,129 @@
+/*
+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 callingFlowSharedLib = require('@izara_project/izara-core-library-calling-flow');
+const recordHandlerSharedLib = require('@izara_project/izara-core-library-record-handler');
+
+const changeRelationshipComplete = require('./ChangeRelationshipComplete_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',
+    'graphServiceTag'
+  ],
+  properties: {
+    returnValue: {
+      type: 'object',
+    },
+    status: {
+      type: 'string',
+    },
+    errorsFound: {
+      type: 'array',
+      default: []
+    },
+    graphServiceTag: {
+      type: 'string'
+    }
+  }
+};
+
+// 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
+        "ChangeRelationshipComplete",       // 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(record.body.Message.graphServiceTag)
+      passOnProperties.push(callingFlowSharedLib.addPassBackPropertiesToPassOnProperties(record.body.Message)) // is Ok PassBackProperties
+      // passOnProperties.push(callingFlowSharedLib.addCallingFlowToPassOnProperties(record.body.Message)) // is Ok callingFlow
+      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
+        changeRelationshipComplete.changeRelationshipComplete,  // mainFunction that need to invoke.
+        "ChangeRelationshipComplete",                           // 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/changeRelationship/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/src/Consts.js");
+
+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.changeRelComplete;
+  return {
+    templatePath: templatePath,
+    templateData: {
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: `${upperCase(functionName)}_Main`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+module.exports = data;