@izara_project/izara-market-library-service-schemas 1.0.69 → 1.0.71

package/src/reStructure/TemplateData/flowSchema/triggerCacheComponent/triggerCacheComplete/handler/template.ejs

@@ -0,0 +1,91 @@
+/*
+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 recordHandlerSharedLib = require("@izara_project/izara-core-library-record-handler")
+const Logger = require('@izara_project/izara-core-library-logger');
+const callingFlowSharedLib = require('@izara_project/izara-core-library-calling-flow');
+const <%- functionName %> = require('./<%- functionName %>_Main')
+
+// validate event properties in body.Message of sqs event
+let perRecordsValidatorSchema = {
+  //(<validatorSchema>)
+  //(</validatorSchema>)
+}
+middleware.setValidatorSchema(recordHandlerSharedLib.baseValidatorSchema());
+
+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
+        "<%- queueName %>", // 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)
+      //(<additionalParams>)
+      //(</additionalParams>)
+      passOnProperties.push(callingFlowSharedLib.addCallingFlowToPassOnProperties(record.body.Message));
+      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
+        <%- functionName %>.<%- functionName %>, // mainFunction that need to invoke.
+        "<%- queueName %>", // 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, LambdaFunctionHdrSqs: ', err);
+    throw (err);
+  }
+});

package/src/reStructure/TemplateData/flowSchema/triggerCacheComponent/triggerCacheComplete/mainFunction/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 NoRetryError = require('@izara_project/izara-core-library-core').NoRetryError
+const { SOURCE_PATH, FUNCTION_NAME, HANDLER, SAVE_FILE_NAME } = require('../../../../../../MainLibs/src/Consts');
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase, getLocalConfig } = require("../../../../../../MainLibs/src/Utils")
+const templatePath = path.join(__dirname, "./template.ejs");
+
+
+/**
+ * receive objectSchema
+ * create data for WebScoket handler template
+ *
+ * @param {Object} objectSchema
+ * @return {{templatePath, templateData,setting}}
+ */
+
+function data(_izContext, flowSchema, srcPath) {
+  return [createSourceParams(_izContext, flowSchema, srcPath)]
+}
+
+function createSourceParams(_izContext, flowSchema, srcPath) {
+  let functionName = "TriggerCache" + upperCase(flowSchema.flowTag) + "Complete"
+  let handlerType = upperCase(HANDLER.hdrSqs)
+  let queueName = "TriggerCache" + upperCase(flowSchema.flowTag) + "Complete" + handlerType;
+
+
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      queueName,
+      flowTag: flowSchema.flowTag
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.flowSchema, upperCase(flowSchema.flowTag), 'source/'),
+      saveFileName: `${upperCase(functionName)}_Main`,
+      fileExtension: ".js",
+      isAppend: true
+    }
+  }
+}
+
+module.exports = data;

package/src/reStructure/TemplateData/flowSchema/triggerCacheComponent/triggerCacheComplete/mainFunction/template.ejs

@@ -0,0 +1,85 @@
+/*
+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 getObjectSchema = require('@izara_project/izara-core-library-service-schemas/src/GetObjectSchema');
+const dynamodbSharedLib = require('@izara_project/izara-core-library-dynamodb');
+const snsSharedLib = require('@izara_project/izara-core-library-sns');
+const sqsSharedLib = require('@izara_project/izara-core-library-sqs');
+const asyncFlowSharedLib = require('@izara_project/izara-core-library-asynchronous-flow');
+const callingFlowSharedLib = require('@izara_project/izara-core-library-calling-flow');
+const lambdaSharedLib = require('@izara_project/izara-core-library-lambda');
+const externalRequest = require('@izara_project/izara-core-library-external-request');
+const sns = externalRequest.sns
+const sqs = externalRequest.sqs
+const lambda = externalRequest.lambda
+const NoRetryError = require('@izara_project/izara-core-library-core').NoRetryError
+const { createFlowTypeConcat } = require('@izara_project/izara-core-library-service-schemas').utils
+//(<optionalRequire>)
+//(</optionalRequire>)
+/**
+ *
+ *
+ * description of function.
+ * @param {Object} _izContext
+ * @param {CorrelationIds} _izContext.correlationIds - property of _izContext
+ * @param {Logger} _izContext.logger - property of _izContext
+ * @param {Object} requestParams - request params
+ * @param {Object} requestParams.identifiers - identifiers for get data
+ * @param {Object} requestParams.additionalRequest - additionalRequest
+ *
+ *
+ * @returns {object} description of return value
+ */
+
+module.exports.<%- functionName %> = async (
+  _izContext,
+  requestParams,
+  //(<additionalParams>)
+  //(</additionalParams>)
+  callingFlowConfig = {},
+) => {
+
+  try {
+    _izContext.logger.debug("<%- functionName %> _izContext", _izContext)
+    _izContext.logger.debug("<%- functionName %> requestParams", requestParams)
+    _izContext.logger.debug("<%- functionName %> callingFlowConfig", callingFlowConfig)
+
+    let checkTriggerResetedV2 = await triggeredCacheSharedLib.checkTriggerResetedV2(
+      _izContext,
+      {                                    // flowType
+        serviceTag: process.env.iz_serviceTag,
+        flowTag: "<%- flowTag %>"
+      },
+      {                                    // identifiers of objType in flowType
+        trigger1Id: "frame1_1122"
+      },
+      "testUnique001"
+    )
+
+    _izContext.logger.debug("checkTriggerResetedV2: ", checkTriggerResetedV2)
+
+    //(<endpointHook>)
+    //(</endpointHook>)
+
+  } catch (err) {
+    _izContext.logger.error('error WebSocketInvoke: ', err)
+    throw (err)
+  }
+}

package/src/reStructure/TemplateData/flowSchema/triggerCacheComponent/triggerCacheQueue/data.js

@@ -0,0 +1,70 @@
+/*
+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 { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../MainLibs/src/Utils.js");
+const templatePath = path.join(__dirname, './template.ejs');
+const { SOURCE_PATH, SAVE_FILE_NAME, FUNCTION_NAME, HANDLER } = require('../../../../../MainLibs/src/Consts.js');
+
+/**
+ * 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(flowSchema, srcPath) {
+  let resultsForCreateDefaultSnsInSqs = [];
+  let flowTag = upperCase(flowSchema.flowTag)
+  // console.log("create topic by flowSteps", flowSteps)
+  const setting = {
+    initialData: "Resources:\n",
+    savePath: path.join(srcPath, SOURCE_PATH.resourceYaml),
+    saveFileName: SAVE_FILE_NAME.snsInSqsYaml,
+    fileExtension: ".yml",
+    isAppend: true
+  }
+
+  let generateTriggerCacheQueueNames = [
+    {
+      queueName: "ProcessTriggerCache" + upperCase(flowTag) + upperCase(HANDLER.hdrSqs)
+    },
+    {
+      queueName: "CheckTriggerCache" + upperCase(flowTag) + "Complete" + upperCase(HANDLER.hdrSqs)
+    },
+    {
+      queueName: "TriggerCache" + upperCase(flowTag) + "Complete" + upperCase(HANDLER.hdrSqs)
+    }
+  ]
+
+  for (let defaultSnsInSqsData of generateTriggerCacheQueueNames) {
+    resultsForCreateDefaultSnsInSqs.push({
+      templatePath: templatePath,
+      templateData: defaultSnsInSqsData,
+      setting: setting
+    })
+  }
+
+  return resultsForCreateDefaultSnsInSqs;
+}
+
+module.exports = createDataForDefaultSnsInSqs;

package/src/reStructure/TemplateData/flowSchema/triggerCacheComponent/triggerCacheQueue/template.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)
+} _%>