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

package/src/TemplateData/perActionComplete/delete/sns-out/data.js

@@ -0,0 +1,67 @@
+/*
+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 { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = utils;
+
+const { SOURCE_PATH, SAVE_FILE_NAME, FUNCTION_NAME } = consts;
+
+const templatePath = path.join(
+  __dirname,
+  '../../../resourceYaml/sns-out/template.ejs'
+);
+// /ResourceYaml/sns-out/template.ejs
+// /OutPerActionComplete/OutUpdateComplete/sns-out/data.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 data(_izContext, srcPath) {
+  const createSourceParams = createParamsForCreateSource(_izContext, srcPath);
+  return [createSourceParams];
+}
+
+function createParamsForCreateSource(_izContext, srcPath) {
+  let queueName = FUNCTION_NAME.deleteNodeComplete;
+  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
+    }
+  };
+}
+
+export default data;

package/src/TemplateData/perActionComplete/delete/yaml/data.js

@@ -0,0 +1,108 @@
+/*
+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';
+import libs from '../../../../libs/Libs.js'
+
+const {
+  HANDLER,
+  RESOURCE_CLASSES,
+  SOURCE_PATH,
+  FUNCTION_NAME,
+  SAVE_FILE_NAME,
+  SQS_RESOURCE,
+  SNS_RESOURCE,
+  SHORT_FUNCTION_NAME,
+  SOURCE_GENERATE_IAM_ROLE
+} = consts;
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = utils;
+
+const {
+  awaitingMultipleStepsRole,
+  defaultIamRolePerAction,
+  createIamRole,
+  resourceNames
+} = libs;
+
+const templatePath = path.join(__dirname, 'template.ejs');
+
+function data(_izContext, srcPath) {
+  return [createFunctionYamlOutUpdateComplete(_izContext, srcPath)];
+}
+
+function createFunctionYamlOutUpdateComplete(_izContext, srcPath) {
+  let functionName = upperCase(FUNCTION_NAME.deleteNodeComplete);
+  let functionNameConfig = upperCase(
+    SHORT_FUNCTION_NAME(FUNCTION_NAME.deleteNodeComplete)
+  );
+  let additionalResourcePermission = defaultIamRolePerAction();
+  let handlerType = upperCase(HANDLER.hdrSqs);
+
+  additionalResourcePermission.push(
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.sqs]: [
+          SQS_RESOURCE.deleteMessage,
+          SQS_RESOURCE.deleteMessageBatch,
+          SQS_RESOURCE.getQueueAttributes,
+          SQS_RESOURCE.getQueueUrl,
+          SQS_RESOURCE.receiveMessage,
+          SQS_RESOURCE.sendMessage
+        ]
+      },
+      [
+        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')
+      ]
+    )
+  );
+
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      handlerType,
+      additionalResourcePermission,
+      resourceLocation: SOURCE_PATH.resourceLocationOutPerActionComplete,
+      functionNameConfig,
+      roleName: SOURCE_GENERATE_IAM_ROLE.ObjectCompleteRole
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
+      saveFileName: SAVE_FILE_NAME.functionPerActionYaml,
+      fileExtension: '.yml',
+      isAppend: true
+    }
+  };
+}
+
+export default data;

package/src/TemplateData/perActionComplete/delete/yaml/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) %>
+  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}<%- 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}]}}}
+<%_ 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/perActionComplete/generateTemplateData.js

@@ -0,0 +1,162 @@
+/*
+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 required modules
+import { join } from 'path';
+import createHandler from './create/handler/data.js';
+import createMainFunction from './create/mainFunction/data.js';
+import createSnsInSqs from './create/sns-in-sqs/data.js';
+import createSnsOut from './create/sns-out/data.js';
+import createFunctionYaml from './create/yaml/data.js';
+import deleteHandler from './delete/handler/data.js';
+import deleteMainFunction from './delete/mainFunction/data.js';
+import deleteSnsInSqs from './delete/sns-in-sqs/data.js';
+import deleteSnsOut from './delete/sns-out/data.js';
+import deleteFunctionYaml from './delete/yaml/data.js';
+import getSnsOut from './get/sns-out/data.js';
+import updateHandler from './update/handler/data.js';
+import updateMainFunction from './update/mainFunction/data.js';
+import updateSnsInSqs from './update/sns-in-sqs/data.js';
+import updateSnsOut from './update/sns-out/data.js';
+import updateFunctionYaml from './update/yaml/data.js';
+
+// Action imports
+const actions = {
+  create: {
+    handler: createHandler,
+    mainFunction: createMainFunction,
+    snsInSqs: createSnsInSqs,
+    snsOut: createSnsOut,
+    functionYaml: createFunctionYaml
+  },
+  delete: {
+    handler: deleteHandler,
+    mainFunction: deleteMainFunction,
+    snsInSqs: deleteSnsInSqs,
+    snsOut: deleteSnsOut,
+    functionYaml: deleteFunctionYaml
+  },
+  get: {
+    snsOut: getSnsOut
+  },
+  update: {
+    handler: updateHandler,
+    mainFunction: updateMainFunction,
+    snsInSqs: updateSnsInSqs,
+    snsOut: updateSnsOut,
+    functionYaml: updateFunctionYaml
+  }
+};
+
+/**
+ * Generates code with templates for different actions
+ * @param {Object} _izContext - Context object
+ * @param {string} objSchemaPath - Path to the schema
+ * @returns {Array} Array of generated code parameters
+ */
+async function generateCodeWithTemplate(_izContext, objSchemaPath) {
+  try {
+    const saveFilePath = join(objSchemaPath, '../');
+    let createSourceParams = [];
+
+    // Process update action
+    const updateComponents = await Promise.all(
+      [
+        actions.update.functionYaml,
+        actions.update.handler,
+        actions.update.mainFunction,
+        actions.update.snsInSqs,
+        actions.update.snsOut
+      ].map(async component => {
+        try {
+          return await component(_izContext, saveFilePath);
+        } catch (error) {
+          console.error(`Error processing update component: ${error.message}`);
+          return [];
+        }
+      })
+    );
+
+    // Process create action
+    const createComponents = await Promise.all(
+      [
+        actions.create.functionYaml,
+        actions.create.snsInSqs,
+        actions.create.snsOut,
+        actions.create.handler,
+        actions.create.mainFunction
+      ].map(async component => {
+        try {
+          return await component(_izContext, saveFilePath);
+        } catch (error) {
+          console.error(`Error processing create component: ${error.message}`);
+          return [];
+        }
+      })
+    );
+
+    // Process delete action
+    const deleteComponents = await Promise.all(
+      [
+        actions.delete.functionYaml,
+        actions.delete.handler,
+        actions.delete.mainFunction,
+        actions.delete.snsOut,
+        actions.delete.snsInSqs
+      ].map(async component => {
+        try {
+          return await component(_izContext, saveFilePath);
+        } catch (error) {
+          console.error(`Error processing delete component: ${error.message}`);
+          return [];
+        }
+      })
+    );
+
+    // process get action
+    const getComponent = await Promise.all(
+      [actions.get.snsOut].map(async component => {
+        try {
+          return await component(_izContext, saveFilePath);
+        } catch (err) {
+          console.error(`Error processing get component: ${err.message}`);
+          return [];
+        }
+      })
+    );
+
+    // Combine all components
+    createSourceParams = [
+      ...updateComponents.flat(),
+      ...createComponents.flat(),
+      ...deleteComponents.flat(),
+      ...getComponent.flat()
+    ];
+
+    // console.log('createSourceParams:', JSON.stringify(createSourceParams, null, 2));
+
+    return createSourceParams;
+  } catch (error) {
+    _izContext.logger.error(
+      'Error generating code with template perActionComplete:',
+      error
+    );
+    return [];
+  }
+}
+
+export default generateCodeWithTemplate;

package/src/TemplateData/perActionComplete/get/handler/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/>.
+*/
+
+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 { HANDLER, SOURCE_PATH, FUNCTION_NAME } = consts;
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = utils;
+
+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.getNodeComplete;
+
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      queueName: upperCase(functionName),
+      functionName
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.outPerActionComplete),
+      saveFileName: `${upperCase(functionName)}_${upperCase(HANDLER.hdrSqs)}`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  };
+}
+
+export default data;

package/src/TemplateData/perActionComplete/get/handler/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/>.
+*/
+
+
+
+import { middlewareHandler as middleware } from "@izara_project/izara-middleware";
+import Logger from '@izara_project/izara-core-library-logger';
+import { recordHandlerSharedLib } from "@izara_project/izara-core-library-record-handler";
+import callingFlowSharedLib from '@izara_project/izara-core-library-calling-flow';
+
+import <%- functionName %> from './<%- firstLetterUpperCase(functionName) %>_Main.js';
+
+// 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
+        "<%- 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.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
+        <%- functionName %>, // 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, updateNodeCompleteHdrSqs: ', err);
+    throw (err);
+  }
+});
+
+<%_ function firstLetterUpperCase(text){
+  return text.charAt(0).toUpperCase()+ text.slice(1)
+} _%>

package/src/TemplateData/perActionComplete/get/mainFunction/data.js

@@ -0,0 +1,53 @@
+/*
+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 { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = utils;
+const { SOURCE_PATH, FUNCTION_NAME } = consts;
+
+const templatePath = path.join(__dirname, 'template.ejs');
+
+/**
+ * receive objectSchema
+ * create data for hdrInv template
+ *
+ * @return {{ templatePath, templateData, setting } }
+ */
+
+function data(_izContext, srcPath) {
+  return [createMainFunctionUpdateComplete(_izContext, srcPath)];
+}
+
+function createMainFunctionUpdateComplete(_izContext, srcPath) {
+  return {
+    templatePath: templatePath,
+    templateData: {},
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.outPerActionComplete),
+      saveFileName: `${upperCase(FUNCTION_NAME.getNodeComplete)}_Main`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  };
+}
+
+export default data;