@izara_project/izara-core-generate-service-code 1.0.1 → 1.0.3

package/src/TemplateData/flowSchema/externalTopic/Complete/mainFunction/template.ejs

@@ -0,0 +1,58 @@
+/*
+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 />.
+*/
+
+
+
+//(<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
+ */
+
+export default async function <%- functionName %>(
+  _izContext,
+  requestParams,
+  callingFlowConfig = {},
+  //(<additionalParams>)
+  //(</additionalParams>)
+) {
+
+  try {
+    _izContext.logger.debug("<%- functionName %> _izContext", _izContext)
+    _izContext.logger.debug("<%- functionName %> requestParams", requestParams)
+    _izContext.logger.debug("<%- functionName %> callingFlowConfig", callingFlowConfig)
+
+    //(<endpointHookMainFunction>)
+    //(</endpointHookMainFunction>)
+
+  } catch (err) {
+    _izContext.logger.error('error WebSocketInvoke: ', err)
+    throw (err)
+  }
+}

package/src/TemplateData/flowSchema/externalTopic/Process/functionYaml/data.js

@@ -0,0 +1,163 @@
+/*
+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/>.
+*/
+
+import path from 'path';
+import { fileURLToPath } from 'url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+import { NoRetryError } from '@izara_project/izara-core-library-core';
+import { getObjectSchema } from '@izara_project/izara-core-library-service-schemas';
+
+import consts from '../../../../../libs/Consts.js';
+import utils from '../../../../../libs/Utils.js';
+import libs from '../../../../../libs/Libs.js'
+
+const {
+  HANDLER,
+  STORAGE_TYPES,
+  SOURCE_PATH,
+  RESOURCE_CLASSES,
+  SNS_RESOURCE,
+  DYNAMO_RESOURCE,
+  SAVE_FILE_NAME,
+  SQS_RESOURCE,
+  LAMBDA_RESOURCE
+} = consts;
+
+const { firstLetterUpperCase: upperCase } = utils;
+
+const {
+  shortNameHandler,
+  resourceNames,
+  defaultIamRolePerAction,
+  createIamRole
+} = libs;
+
+const templatePath = path.join(__dirname, 'template.ejs');
+
+/**
+ * receive objectSchema
+ * create data for WebScoket handler template
+ *
+ * @param {Object} objectSchema
+ * @return {{templatePath, templateData,setting}}
+ */
+
+async function data(_izContext, flowSchema, srcPath) {
+  return [await createSourceParams(_izContext, flowSchema, srcPath)];
+}
+
+async function createSourceParams(_izContext, flowSchema, srcPath) {
+  let functionName = 'Process' + upperCase(flowSchema.flowTag);
+  let handlerType = upperCase(HANDLER.hdrSqs);
+  let additionalResourcePermission = defaultIamRolePerAction();
+  let route = upperCase(flowSchema.flowTag);
+  let queueName = 'Process' + upperCase(flowSchema.flowTag) + handlerType;
+  let topicIn = route + '_In';
+  additionalResourcePermission.push(
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.sqs]: Object.values(SQS_RESOURCE)
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.sqs, queueName),
+        resourceNames(RESOURCE_CLASSES.sqs, queueName + 'DLQ')
+      ]
+    )
+  );
+
+  if (Object.keys(flowSchema.flowSteps).includes('In')) {
+    additionalResourcePermission.push(
+      createIamRole(
+        {
+          [RESOURCE_CLASSES.sns]: [SNS_RESOURCE.publish]
+        },
+        [resourceNames(RESOURCE_CLASSES.sns, topicIn)]
+      )
+    );
+  }
+
+  if (flowSchema.statusType === 'storedCache') {
+    let tableStoredCache = [];
+    let objectSchema = await getObjectSchema
+      .getLocalObjectSchemas(
+        _izContext,
+        [flowSchema.objType.objectType],
+        path.join(srcPath, './schemas')
+      )
+      .then(res => res.records[0]);
+    if (!objectSchema) {
+      throw new NoRetryError('ObjectSchema not found');
+    }
+    for (const storageResource of Object.values(
+      objectSchema.storageResources
+    )) {
+      if (storageResource.storageType === STORAGE_TYPES.dynamoDB) {
+        if (!tableStoredCache.includes(storageResource.tableName)) {
+          tableStoredCache.push(storageResource.tableName);
+        }
+      }
+    }
+
+    additionalResourcePermission.push(
+      createIamRole(
+        {
+          [RESOURCE_CLASSES.dynamoDbTable]: Object.values(DYNAMO_RESOURCE)
+        },
+        tableStoredCache.map(tableName =>
+          resourceNames(RESOURCE_CLASSES.dynamoDbTable, tableName)
+        )
+      )
+    );
+  } else if (flowSchema.statusType === 'statusField') {
+    additionalResourcePermission.push(
+      createIamRole(
+        {
+          [RESOURCE_CLASSES.lambda]: Object.values(LAMBDA_RESOURCE)
+        },
+        [resourceNames(RESOURCE_CLASSES.lambda, 'CreateHdrInv')]
+      )
+    );
+  }
+
+  return {
+    templatePath: templatePath,
+    templateData: {
+      resourceLocation: path.join(
+        SOURCE_PATH.resourceLocationFlowSchema,
+        upperCase(flowSchema.flowTag),
+        'source/'
+      ),
+      functionName,
+      handlerType,
+      additionalResourcePermission,
+      route,
+      functionNameConfig:
+        upperCase(functionName) + upperCase(shortNameHandler(handlerType)),
+      roleName: upperCase(flowSchema.flowTag),
+      queueName
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
+      saveFileName: upperCase(SAVE_FILE_NAME.flowSchema),
+      fileExtension: '.yml',
+      isAppend: true
+    }
+  };
+}
+
+export default data;

package/src/TemplateData/flowSchema/externalTopic/Process/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) %><%- firstLetterUpperCase(handlerType) %>
+  role: <%- roleName %>Role
+  #<#<%- functionName %><%- handlerType %>FunctionSetting#>
+  #<#/<%- functionName %><%- handlerType %>FunctionSetting#>
+  events:
+    - sqs:
+        arn: arn:aws:sqs:${self:custom.iz_region}:${self:custom.iz_accountId}:${self:custom.iz_resourcePrefix}<%- queueName %>
+        batchSize: 10
+        filterPatterns: #**** need to update serverless framework upper v.2.69.1
+          - body: {"MessageAttributes":{"callingFlow":{"Value":["${self:custom.iz_resourcePrefix}<%- functionName %>"]}}} # functionName of callingFlow
+          - body: {"MessageAttributes":{"callingFlow":{"Value":[{"exists":false}]}}}
+<%_ function firstLetterUpperCase(text){
+  return text.charAt(0).toUpperCase() + text.slice(1)
+} _%>
+<%_ function firstLetterLowerCase(str) {
+  return str.charAt(0).toLowerCase() + str.slice(1)
+} _%>

package/src/TemplateData/flowSchema/externalTopic/Process/handler/data.js

@@ -0,0 +1,68 @@
+/*
+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/>.
+*/
+
+import path from 'path';
+import { fileURLToPath } from 'url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+import consts from '../../../../../libs/Consts.js';
+import utils from '../../../../../libs/Utils.js';
+
+const { SOURCE_PATH, HANDLER } = consts;
+const { firstLetterUpperCase: upperCase } = utils;
+
+const templatePath = path.join(__dirname, 'template.ejs');
+/**
+ * receive objectSchema
+ * create data for WebScoket handler template
+ *
+ * @param {Object} objectSchema
+ * @return {{templatePath, templateData,setting}}
+ */
+
+async function data(_izContext, flowSchema, srcPath) {
+  return [await createSourceParams(_izContext, flowSchema, srcPath)];
+}
+
+async function createSourceParams(_izContext, flowSchema, srcPath) {
+  let functionName = 'Process' + upperCase(flowSchema.flowTag);
+  let handlerType = upperCase(HANDLER.hdrSqs);
+  let queueName = 'Process' + upperCase(flowSchema.flowTag) + handlerType;
+
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      handlerType,
+      queueName
+    },
+    setting: {
+      savePath: path.join(
+        srcPath,
+        SOURCE_PATH.flowSchema,
+        upperCase(flowSchema.flowTag),
+        'source/'
+      ),
+      saveFileName: `${functionName}_${handlerType}`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  };
+}
+
+export default data;

package/src/TemplateData/flowSchema/externalTopic/Process/handler/template.ejs

@@ -0,0 +1,101 @@
+/*
+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/>.
+*/
+
+
+
+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 <%- functionName %> from './<%- functionName %>_Main.js';
+
+middleware.setValidatorSchema(recordHandlerSharedLib.baseValidatorSchema(
+  {
+    type: "object",
+    required: ['body', 'messageAttributes'],
+    properties: {
+      body: {
+        type: 'object',
+      },
+      messageAttributes: {
+        type: 'object'
+      }
+    }
+  }
+));
+
+// validate event properties in body.Message of sqs event
+let perRecordsValidatorSchema = {
+  //(<validatorSchema>)
+  //(</validatorSchema>)
+}
+
+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 => { // 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 %>, // 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/TemplateData/flowSchema/externalTopic/sns-in-sqs/data.js

@@ -0,0 +1,79 @@
+/*
+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/>.
+*/
+
+import path from 'path';
+import { fileURLToPath } from 'url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+import consts from '../../../../libs/Consts.js';
+import utils from '../../../../libs/Utils.js';
+
+const { SOURCE_PATH, HANDLER, SAVE_FILE_NAME } = consts;
+const { firstLetterUpperCase: upperCase } = utils;
+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 createDataForDefaultSnsInSqs(_izContext, flowSchema, srcPath) {
+  let resultsForCreateDefaultSnsInSqs = [];
+  let flowSteps = Object.keys(flowSchema.flowSteps);
+  const setting = {
+    initialData: 'Resources:\n',
+    savePath: path.join(srcPath, SOURCE_PATH.resourceYaml),
+    saveFileName: SAVE_FILE_NAME.snsInSqsYaml,
+    fileExtension: '.yml',
+    isAppend: true
+  };
+
+  const generatedSnsTopicInForFlowSchema = [];
+
+  if (flowSteps.includes('In')) {
+    generatedSnsTopicInForFlowSchema.push({
+      queueName:
+        'Process' + upperCase(flowSchema.flowTag) + upperCase(HANDLER.hdrSqs)
+    });
+  }
+
+  // if (flowSteps.includes("Out") && flowSchema.outputTopic === true) {
+  //   generatedSnsTopicInForFlowSchema.push(
+  //     {
+  //       queueName: upperCase(flowSchema.flowTag) + "Complete" + upperCase(HANDLER.hdrSqs)
+  //     }
+  //   )
+  // }
+
+  for (let defaultSnsInSqsData of generatedSnsTopicInForFlowSchema) {
+    resultsForCreateDefaultSnsInSqs.push({
+      templatePath: templatePath,
+      templateData: defaultSnsInSqsData,
+      setting: setting
+    });
+  }
+
+  return resultsForCreateDefaultSnsInSqs;
+}
+
+export default createDataForDefaultSnsInSqs;

package/src/TemplateData/flowSchema/externalTopic/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/TemplateData/flowSchema/externalTopic/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/>.
+*/
+
+import path from 'path';
+import { fileURLToPath } from 'url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+import consts from '../../../../libs/Consts.js';
+import utils from '../../../../libs/Utils.js';
+const { SOURCE_PATH, SAVE_FILE_NAME } = consts;
+const { firstLetterUpperCase: upperCase } = utils;
+
+const templatePath = path.join(__dirname, '../../../resourceYaml/sns-out/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 createDataForDefaultSnsInSqs(_izContext, flowSchema, srcPath) {
+  let resultsForCreateDefaultSnsInSqs = [];
+  let flowSteps = Object.keys(flowSchema.flowSteps);
+  const setting = {
+    initialData: 'Resources:\n',
+    savePath: path.join(srcPath, SOURCE_PATH.resourceYaml),
+    saveFileName: SAVE_FILE_NAME.snsOutYaml,
+    fileExtension: '.yml',
+    isAppend: true
+  };
+
+  let topicOut = `${upperCase(flowSchema.flowTag)}`;
+
+  const generatedSnsTopicInForFlowSchema = [];
+  if (flowSteps.includes('Out')) {
+    generatedSnsTopicInForFlowSchema.push({
+      queueName: upperCase(topicOut)
+    });
+  }
+
+  for (let defaultSnsInSqsData of generatedSnsTopicInForFlowSchema) {
+    resultsForCreateDefaultSnsInSqs.push({
+      templatePath: templatePath,
+      templateData: defaultSnsInSqsData,
+      setting: setting
+    });
+  }
+
+  return resultsForCreateDefaultSnsInSqs;
+}
+
+export default createDataForDefaultSnsInSqs;