@izara_project/izara-market-library-service-schemas 1.0.31 → 1.0.32

package/src/reStructure/TemplateData/flowSchema/externalTopic/sqs/functionYaml/data.js

@@ -0,0 +1,83 @@
+/*
+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 { FLOW_SCHEMA_HOOK_STATE, HANDLER } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+const { firstLetterUpperCase: upperCase } = require("../../../../../../MainLibs/src/Utils");
+const {
+  SOURCE_PATH,
+  defaultIamRolePerAction,
+  createIamRole,
+  RESOURCE_CLASSES,
+  SNS_RESOURCE,
+  resourceNames,
+  DYNAMO_RESOURCE,
+  SAVE_FILE_NAME,
+  FUNCTION_NAME,
+  shortNameHandler,
+  externalResourceYaml,
+  SOURCE_GENERATE_IAM_ROLE
+} = require("../../../../../../MainLibs/src/Consts");
+
+const templatePath = path.join(__dirname, "template.ejs");
+const hookTemplate = path.join(__dirname, "./hookTemplate.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 = upperCase(flowSchema.flowTag);
+  let handlerType = upperCase(HANDLER.hdrSqs);
+  let externalTopicName = FUNCTION_NAME.flowSchemaExternalTopic + 'Out';
+  let externalTopicShortName = 'ExtTopicOut';
+  let functionConfig = upperCase(flowSchema.flowTag) + externalTopicShortName + upperCase(shortNameHandler(handlerType));
+  let additionalResourcePermission = defaultIamRolePerAction();
+  const handler = HANDLER.hdrSqs; // Using hdrSqs as the default handler
+  const action = flowSchema.flowTag || 'defaultAction'; // Using flowTag as the action name
+  const event = resourceNames(RESOURCE_CLASSES.sqs, upperCase(action) + upperCase(handler));
+
+  return {
+    templatePath: templatePath,
+    templateData: {
+      resourceLocation: SOURCE_PATH.resourceLocationWebSocket,
+      event,
+      functionName,
+      handlerType,
+      functionNameConfig: functionConfig,
+      roleName: SOURCE_GENERATE_IAM_ROLE.ExternalTopicRole,
+      externalTopicName
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
+      saveFileName: upperCase(SAVE_FILE_NAME.flowSchema),
+      fileExtension: ".yml",
+      isAppend: true
+    }
+  }
+}
+
+module.exports = data;

package/src/reStructure/TemplateData/flowSchema/externalTopic/sqs/functionYaml/template.ejs

@@ -0,0 +1,17 @@
+<%_ const join = require('path').join _%>
+<%- firstLetterUpperCase(functionNameConfig) %>:
+  handler: <%- join(resourceLocation, functionName, `${firstLetterUpperCase(externalTopicName)}_${firstLetterUpperCase(handlerType)}.main`) %>
+  name: ${self:custom.iz_resourcePrefix}<%- firstLetterUpperCase(functionNameConfig) %>
+  events:
+    - sqs:
+        arn: <%- event %>
+        batchSize: 10
+  role: <%- firstLetterUpperCase(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/flowSchema/externalTopic/sqs/handler/data.js

@@ -0,0 +1,65 @@
+/*
+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 { FLOW_SCHEMA_HOOK_STATE, HANDLER } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+
+const { SOURCE_PATH, FUNCTION_NAME } = require("../../../../../../MainLibs/src/Consts");
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../MainLibs/src/Utils");
+const templatePath = path.join(__dirname, "template.ejs")
+
+/**
+ * receive objectSchema
+ * create data for SQS handler template
+ *
+ * @param {Object} objectSchema
+ * @return {{templatePath, templateData,setting}}
+ */
+function data(_izContext, flowSchema, srcPath) {
+  return [createParamsForCreateSource(_izContext, flowSchema, srcPath)]
+}
+
+function createParamsForCreateSource(_izContext, flowSchema, srcPath) {
+  const flowStepInSplitKey = Object.keys(flowSchema.flowSteps)[0].split('_');
+  if (flowStepInSplitKey.length < 4) {
+    _izContext.logger.error(`flowStepInSplitKey.length < 4: ${flowStepInSplitKey.length} ${flowSchema.flowTag}`);
+    return null;
+  }
+  const ExternalTopicName = FUNCTION_NAME.flowSchemaExternalTopic + 'Out';
+  let queueName = (flowStepInSplitKey[2]) + (flowStepInSplitKey[3]) + 'Out';
+  let functionName = upperCase(FUNCTION_NAME.flowSchemaExternalTopic)
+  let handlerType = upperCase(HANDLER.hdrSqs);
+  return {
+    templatePath: templatePath,
+    templateData: {
+      queueName,
+      fileName: ExternalTopicName + 'Out_Main',
+      functionMain: ExternalTopicName + 'Out',
+      handler: HANDLER.hdrSqs,
+      firstLetterUpperCase: upperCase,
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.webSocket, flowSchema.flowTag + '/'),
+      saveFileName: `${functionName}Out_${handlerType}`,
+      fileExtension: ".js",
+      isAppend: false
+    }
+  }
+}
+module.exports = data

package/src/reStructure/TemplateData/flowSchema/externalTopic/sqs/handler/template copy.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 { middlewareHandler, consts } = require("@izara_project/izara-middleware");
+const callingFlowSharedLib = require('@izara_project/izara-core-library-calling-flow');
+const Logger = require('@izara_project/izara-core-library-logger');
+const {validateSchemaPerRecord} = require('@izara_project/izara-market-library-service-schemas/src/GenerateCodeLibs/src/GenerateCodeLibs')
+const recordHandlerSharedLib = require('@izara_project/izara-core-library-record-handler');
+
+const { <%- action %>Main } =require('./<%- firstLetterUpperCase(action) %>_Main.js')
+
+//(<globalVarible>
+//</globalVarible>)
+
+//validate event params in middleware before into main function
+middleware.setValidatorSchema(
+  recordHandlerSharedLib.baseValidatorSchema(),
+  //(<middlewareSettings>)
+  //(</middlewareSettings>)
+)
+/*
+const perRecordsValidatorSchema = {
+  type: "object",
+  required: [],
+  properties: {},
+ }
+ */
+  //(<globalValidatorSchema>)
+  //(</globalValidatorSchema>)
+
+// if need to validate authorizer or additional params , add code to hook tag below
+
+module.exports.main = middlewareHandler.wrap(async (event,context, callback) => {
+
+  try {
+
+    let recordPromises = [];
+
+    await Promise.all(event.Records.map(async record => {
+      record._izContext.logger.debug('record RecieveMsgOutHdrSqs', record);
+
+      let passOnProperties = [];
+
+      const OBJTYPE = {
+        objectType: record.body.Message.objectType,
+        serviceTag: process.env.iz_serviceTag
+      }
+
+      await validateSchemaPerRecord(
+        record,
+        "<%- firstLetterUpperCase(action) %><%- firstLetterUpperCase(handler) %>",
+        OBJTYPE,
+        "<%- action %>"
+        //(<validateSchemaSetting>)
+        //(</validateSchemaSetting>)
+      )
+
+      //for validate additional params
+      /*
+      await recordHandlerSharedLib.validateRecord(
+        record,
+        "<%- firstLetterUpperCase(action) %><%- firstLetterUpperCase(handler) %>",
+        perRecordsValidatorSchema
+      );
+        */
+      //(<afterGenerateValidatorSchema>)
+      //(</afterGenerateValidatorSchema>)
+
+      //(<additionalParams>)
+      //(</additionalParams>)
+
+      passOnProperties.push(record.body.Message);
+      passOnProperties.push(callingFlowSharedLib.addCallingFlowToPassOnProperties(record.body.Message));
+      record._izContext.logger.debug('passOnProperties in handler', passOnProperties);
+
+      let recordPromise = recordHandlerSharedLib.recordHandler(
+        record,
+        <%- action %>Main,          // mainFunction
+        '<%- firstLetterUpperCase(queueName) %>',             // queueName
+        passOnProperties
+      );
+      record._izContext.logger.debug('after record Promise in handler');
+      recordPromises.push(recordPromise);
+    }))
+
+    Logger.debug('before Promise.all(recordPromise) in handler');
+    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)');
+    }
+    Logger.debug('after Promise.all(recordPromises) in handler');
+
+  } catch (err) {
+    Logger.debug('unhandled error <%- firstLetterUpperCase(action) %><%- firstLetterUpperCase(handler) %>')
+    throw err
+  }
+}
+)
+
+
+
+<%_ 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/flowSchema/externalTopic/sqs/handler/template.ejs

@@ -0,0 +1,130 @@
+/*
+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 { middlewareHandler } = require("@izara_project/izara-middleware");
+const recordHandlerSharedLib = require("@izara_project/izara-core-library-record-handler")
+const Logger = require('@izara_project/izara-core-library-logger');
+
+const { <%- functionMain %> } =require('./<%- firstLetterUpperCase(fileName) %>.js')
+
+// validate event properties in body.Message of sqs event
+middlewareHandler.setValidatorSchema(recordHandlerSharedLib.baseValidatorSchema());
+// set schema for record.body.Message
+// const perRecordsValidatorSchema = {
+//   type: "object",
+//   required: ['param1', 'param2', 'param3', 'param4',],
+//   properties: {
+//     param1: {
+//       type: 'object',
+//       default: {}
+//     },
+//     param2: {
+//       type: 'string',
+//       default: true,
+//       pattern: "^[a-zA-Z0-9_-]+$",
+//     },
+//     param3: {
+//       type: 'array',
+//       items: { // items in array
+//         type: "object", // string
+//         properties: {
+//           "c": {
+//             type: "string"
+//           },
+//           "d": {
+//             type: "number"
+//           }
+//         },
+//       }
+//     },
+//     param4: {
+//       type: 'number',
+//     }
+//   }
+// };
+
+// set schema for record.body.MessageAttributes
+const messageAttributeValidatorSchema = {
+  type: "object",
+  required: ['msgAtrrParam1', 'msgAtrrParam2'],
+  properties: {
+    msgAtrrParam1: {
+      type: "string"
+    },
+    msgAtrrParam2: {
+      type: "object"
+    }
+  }
+};
+
+module.exports.main = middlewareHandler.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
+        "<%- firstLetterUpperCase(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)
+      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
+        <%- functionMain %>,  // mainFunction that need to invoke.
+        '<%- firstLetterUpperCase(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, <%- functionMain%>: ', err);
+    throw (err);
+  }
+});

package/src/reStructure/TemplateData/flowSchema/externalTopic/sqs/mainFunction/data.js

@@ -0,0 +1,61 @@
+/*
+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 { SOURCE_PATH, FUNCTION_NAME, HANDLER } = require("../../../../../../MainLibs/src/Consts");
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../MainLibs/src/Utils");
+const templatePath = path.join(__dirname, "template.ejs");
+const getObjectSchema = require('@izara_project/izara-core-library-service-schemas/src/GetObjectSchema')
+
+/**
+ * receive objectSchema
+ * create data for Sqs Main template
+ *
+ * @param {Object} objectSchema
+ * @return {{templatePath, templateData,setting}}
+ */
+
+
+function data(_izContext, flowSchema, srcPath) {
+  return [createParamsForCreateSource(_izContext, flowSchema, srcPath)]
+}
+
+function createParamsForCreateSource(_izContext, flowSchema, srcPath) {
+  let functionName = upperCase(FUNCTION_NAME.flowSchemaExternalTopic)
+  let snsTopicIn = Object.keys(flowSchema.flowSteps)
+  let snsTopicInWithoutUnderscore = snsTopicIn[0].replace(/_/g, '')
+  let handlerType = upperCase(HANDLER.hdrSqs);
+  // let objectSchema = await getObjectSchema.getObjectSchemaCombineFieldNamesWithCache(_izContext, flowSchema.objType)
+  // let fieldNames = Object.keys(objectSchema.fieldNames)
+  return {
+    templatePath: templatePath,
+    templateData: {
+      snsTopicIn: snsTopicInWithoutUnderscore,
+      externalTopicOutMain: FUNCTION_NAME.flowSchemaExternalTopic + 'Out',
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.webSocket, flowSchema.flowTag + '/'),
+      saveFileName: `${functionName}Out_Main`,
+      fileExtension: ".js",
+      isAppend: false
+    }
+  }
+}
+module.exports = data

package/src/reStructure/TemplateData/flowSchema/externalTopic/sqs/mainFunction/template.ejs

@@ -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 hash = require("object-hash");
+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 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 utils = require('@izara_project/izara-market-library-service-schemas/src/MainLibs/src/Utils')
+const NoRetryError = require('@izara_project/izara-core-library-core').NoRetryError
+const { v4: uuidv4 } = require('uuid')
+const coreConsts = require("@izara_project/izara-core-library-core/src/Consts");
+const { TOPIC_NAME_GENERATE_CODE } = require('@izara_project/izara-market-library-service-schemas/src/GenerateCodeLibs/src/Consts')
+/**
+ *
+ *
+ * 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.<%- externalTopicOutMain%>Main = async (
+  _izContext,
+  requestParams,
+  callingFlowConfig = {},
+  //(<additionalParams>)
+  //(</additionalParams>)
+) => {
+
+  try {
+
+    //(<additionalParams>)
+    //(</additionalParams>)
+
+  } catch (err) {
+    _izContext.logger.error('error WebSocketInvoke: ', err)
+    throw (err)
+  }
+}