@izara_project/izara-market-library-service-schemas 1.0.22 → 1.0.24

package/src/reStructure/TemplateData/perActionEndpoint/yaml/sqs/request.json

@@ -0,0 +1,19 @@
+{
+  "functionName": "xxx",
+  "handler": "hdrSqs",
+  "event": {
+    "sqs": {
+      "arn": "queueName"
+    },
+    "iamRoleStatement": {
+      "Effect": "Allow",
+      "Action": {
+        "xxx": [
+          "yyy",
+          "xxx"
+        ]
+      },
+      "Resource": "xxxx"
+    }
+  }
+}

package/src/reStructure/TemplateData/perActionEndpoint/yaml/sqs/template.ejs

@@ -0,0 +1,17 @@
+<%_ const join = require('path').join; _%>
+<%- firstLetterUpperCase(functionNameConfig) %>:
+  handler: <%- join(resourceLocation, `${firstLetterUpperCase(functionName)}_${firstLetterUpperCase(handlerType)}.main`)%>
+  name: ${self:custom.iz_resourcePrefix}<%- firstLetterUpperCase(functionName) %><%- firstLetterUpperCase(handlerType) %>
+  events:
+    - sqs:
+        arn: arn:aws:sqs:${self:custom.iz_region}:${self:custom.iz_accountId}:${self:custom.iz_resourcePrefix}<%- firstLetterUpperCase(functionName) %><%- firstLetterUpperCase(handlerType) %>
+        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/perActionEndpoint/yaml/wbs/data.js

@@ -0,0 +1,170 @@
+/*
+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("../#utils");
+const { DEFAULT_HANDLER_PER_ACTION, createIamRole, resourceNames, RESOURCE_CLASSES, DEFAULT_LAMBDA_ROLE_PER_ACTION, SQS_RESOURCE, SOURCE_PATH, SAVE_FILE_NAME, SNS_RESOURCE, FUNCTION_NAME, DYNAMO_RESOURCE, defaultIamRolePerAction, awaitingMultipleStepsRole, shortNameHandler } = require("../#const");
+
+const templatePath = path.join(__dirname, "./template.ejs")
+
+/**
+ * receive objectSchema
+ * create data for hdrInv template
+ *
+ * @param {Object} objectSchema
+ * @return {{ templatePath, templateData, setting } }
+ */
+function data(_izContext, objectSchema, srcPath) {
+  let createSourceArray = [];
+  for (const action of Object.values(ACTIONS)) {
+    if (objectSchema.overWriteHandlers?.[action]) {
+      // if have overWriteHander of action check hdrApi inside
+      if (objectSchema.overWriteHandlers[action].includes(HANDLER.hdrWbs)) {
+        // create template data
+        const createSourceParam = createParamForCreateSource(objectSchema, action, srcPath)
+        createSourceArray.push(createSourceParam)
+      }
+    } else {
+      // if not have overWriteHander of action will use default handler
+      const defaultHandler = DEFAULT_HANDLER_PER_ACTION[action]
+      if (defaultHandler.includes(HANDLER.hdrWbs)) {
+        // create template data and object for create source
+        const createSourceParam = createParamForCreateSource(objectSchema, action, srcPath)
+        createSourceArray.push(createSourceParam)
+      }
+    }
+  }
+  return createSourceArray;
+}
+
+
+
+function createParamForCreateSource(objectSchema, action, srcPath) {
+  let objectType = objectSchema.objectType;
+  let actionHandler = action;
+  let functionName = upperCase(objectType) + upperCase(actionHandler);
+  let additionalResourcePermission = defaultIamRolePerAction();
+  let tableForGetItem = [];
+  let hasGraphStorage = false;
+  let functionNameObjectType = objectSchema?.shortNameObjectType ? objectSchema.shortNameObjectType : objectSchema.objectType
+  let functionNameConfig = upperCase(functionNameObjectType) + upperCase(action) + upperCase(shortNameHandler(HANDLER.hdrWbs))
+
+  for (let storageResource of Object.values(objectSchema.storageResources)) {
+    if (storageResource.storageType === STORAGE_TYPES.dynamoDB) {
+      // add IamRole for dynamodb depend on tableName in storageResources of objectSchema
+      tableForGetItem.push(resourceNames(RESOURCE_CLASSES.dynamoDbTable, storageResource.tableName));
+
+    } else if (storageResource.storageType === STORAGE_TYPES.graph) {
+      // find graph serviceName from graphServerTag or *GetNodeHdrInv ?
+
+      if (hasGraphStorage) {
+        continue;
+      } else {
+        hasGraphStorage = true;
+      }
+    }
+  }
+  additionalResourcePermission.push(awaitingMultipleStepsRole())
+
+  additionalResourcePermission.push(
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.dynamoDbTable]: [
+          DYNAMO_RESOURCE.getItem,
+          DYNAMO_RESOURCE.putItem,
+          DYNAMO_RESOURCE.deleteItem
+        ]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.dynamoDbTable, "WebSocketTask")
+      ]
+    )
+  )
+
+  additionalResourcePermission.push(
+    createIamRole(
+      {
+        ["execute-api"]: ["ManageConnections"]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.webSocket)
+      ]
+    )
+  )
+
+
+  if (action == ACTIONS.update) {
+    additionalResourcePermission.push(
+      createIamRole(
+        {
+          [RESOURCE_CLASSES.sns]: [SNS_RESOURCE.publish]
+        },
+        [
+          resourceNames(RESOURCE_CLASSES.sns, "Out" + upperCase(FUNCTION_NAME.updateNodeComplete))
+        ]
+      )
+    )
+  } else if (action == ACTIONS.create) {
+    additionalResourcePermission.push(
+      createIamRole(
+        {
+          [RESOURCE_CLASSES.sns]: [SNS_RESOURCE.publish]
+        },
+        [
+          resourceNames(RESOURCE_CLASSES.sns, "Out" + upperCase(FUNCTION_NAME.createObjectComplete))
+        ]
+      )
+    )
+  } else if (action == ACTIONS.delete) {
+    // additionalResourcePermission.push(
+    //   createIamRole(
+    //     {
+    //       [RESOURCE_CLASSES.sns]: [SNS_RESOURCE.publish]
+    //     },
+    //     [
+    //       resourceNames(RESOURCE_CLASSES.sns, "Out" + upperCase(FUNCTION_NAME.createObjectComplete))
+    //     ]
+    //   )
+    // )
+  }
+
+  // console.log("additionalResourcePermissionBeforeReturn", additionalResourcePermission)
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName: functionName,
+      actionHandler: actionHandler,
+      resourceLocation: SOURCE_PATH.resourceLocationPerAction,
+      handlerType: HANDLER.hdrWbs,
+      additionalResourcePermission,
+      functionNameConfig,
+      objectType,
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
+      saveFileName: SAVE_FILE_NAME.functionPerActionYaml,
+      fileExtension: '.yml',
+      isAppend: true
+    }
+  }
+}
+
+module.exports = data;

package/src/reStructure/TemplateData/perActionEndpoint/yaml/wbs/request.json

@@ -0,0 +1,19 @@
+{
+  "functionName": "xxx",
+  "handler": "hdrSqs",
+  "event": {
+    "sqs": {
+      "arn": "queueName"
+    },
+    "iamRoleStatement": {
+      "Effect": "Allow",
+      "Action": {
+        "xxx": [
+          "yyy",
+          "xxx"
+        ]
+      },
+      "Resource": "xxxx"
+    }
+  }
+}

package/src/{TemplateManager/src/TranslateIdReq/TranslateIds/functionYaml/HdrSqs → reStructure/TemplateData/perActionEndpoint/yaml/wbs}/template.ejs

@@ -3,9 +3,8 @@
   handler: <%- join(resourceLocation, `${firstLetterUpperCase(functionName)}_${firstLetterUpperCase(handlerType)}.main`)%>
   name: ${self:custom.iz_resourcePrefix}<%- firstLetterUpperCase(functionName) %><%- firstLetterUpperCase(handlerType) %>
   events:
-    - sqs:
-        arn: arn:aws:sqs:${self:custom.iz_region}:${self:custom.iz_accountId}:${self:custom.iz_resourcePrefix}<%- firstLetterUpperCase(functionName) %><%- firstLetterUpperCase(handlerType) %>
-        batchSize: 10
+    - websocket:
+        route: <%- objectType -%><%- firstLetterUpperCase(actionHandler) %>
   iamRoleStatements:
     <%_ additionalResourcePermission.forEach(resourcePermission => { _%>
     - Effect: <%- resourcePermission.effect %>

package/src/reStructure/TemplateData/perActionEndpoint/yaml/webSocketConnect/data.js

@@ -0,0 +1,59 @@
+/*
+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, SAVE_FILE_NAME, ACTIONS, HANDLER } = require("../#const");
+
+const templatePath = path.join(__dirname, "./template.ejs")
+
+/**
+ * receive objectSchema
+ * create data for websocket connect function yaml template
+ *
+ * @param {Object} objectSchema
+ * @return {{ templatePath, templateData, setting } }
+ */
+
+function data(_izContext, webSocketStatus, srcPath) {
+  let createSourceParam;
+  if (webSocketStatus) {
+    createSourceParam = [createWebSocketConnectYaml(_izContext, srcPath)]
+  } else {
+    createSourceParam = []
+  }
+  return createSourceParam
+}
+
+function createWebSocketConnectYaml(_izContext, srcPath) {
+  let functionName = "WebSocketConnect"
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      resourceLocation: SOURCE_PATH.resourceLocationPerAction
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
+      saveFileName: SAVE_FILE_NAME.functionPerActionYaml,
+      fileExtension: ".yml",
+      isAppend: true
+    }
+  }
+}
+module.exports = data

package/src/reStructure/TemplateData/perActionEndpoint/yaml/webSocketConnect/template.ejs

@@ -0,0 +1,10 @@
+WebSocketConnect:
+  handler: src/generatedCode/ObjectTypePerActionEndpoint/source/WebSocketConnect.main
+  name: ${self:custom.iz_resourcePrefix}WebSocketConnect
+  events:
+    - websocket:
+        route: $connect
+    - websocket:
+        route: $disconnect
+#<#<WebSocketConnectIamRole#>
+#<#/<WebSocketConnectIamRole#>

package/src/reStructure/TemplateData/processLogical/generateTemplateData.js

@@ -0,0 +1,57 @@
+/*
+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';
+
+// Import required modules
+const { join } = require('path');
+
+const {
+  getAllLocalObjectSchemasWithHierarchy,
+} = require('@izara_project/izara-core-library-service-schemas/src/GetObjectSchema');
+
+// processLogical
+const createProcessLogicalHandler = require('./handler/data');
+const createProcessLogicalMainFunction = require('./mainFunction/data');
+const createProcessLogicalFunctionYaml = require('./yaml/data');
+
+/**
+ * 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, '../');
+    const allObjSchemas = await getAllLocalObjectSchemasWithHierarchy(_izContext, objSchemaPath);
+
+    // Create process logical resources
+    const processLogicalResources = [
+      createProcessLogicalHandler(_izContext, saveFilePath),
+      createProcessLogicalMainFunction(_izContext, saveFilePath),
+      await createProcessLogicalFunctionYaml(_izContext, allObjSchemas, saveFilePath)
+    ];
+
+    return processLogicalResources;
+  } catch (error) {
+    _izContext.logger.error('Error generating code with template:', error);
+    return [];
+  }
+}
+
+module.exports = generateCodeWithTemplate;

package/src/reStructure/TemplateData/processLogical/handler/data.js

@@ -0,0 +1,50 @@
+/*
+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 templatePath = path.join(__dirname, "./template.ejs")
+
+const { DEFAULT_HANDLER_PER_ACTION, SOURCE_PATH, FUNCTION_NAME, HANDLER } = require("../../../../MainLibs/index.js").consts;
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require('../../../../MainLibs/index.js').utils
+
+/**
+ * receive srcPath
+ * not create data for ProcessLogical Handler template
+ *
+ * @param {string} srcPath
+ * @return {{ templatePath, templateData, setting } }
+ */
+function data(_izContext, srcPath) {
+
+
+  return {
+    templatePath: templatePath,
+    templateData: {
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.processLogical),
+      saveFileName: `${upperCase(FUNCTION_NAME.processLogical)}_${upperCase(HANDLER.hdrSqs)}`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+module.exports = data;

package/src/reStructure/TemplateData/processLogical/handler/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 recordHandlerSharedLib = require("@izara_project/izara-shared").recordHandlerSharedLib;
+const Logger = require('@izara_project/izara-core-library-logger');
+
+const processLogical = require('./ProcessLogical_Main');
+
+// validate event properties in body.Message of sqs event
+middleware.setValidatorSchema(recordHandlerSharedLib.baseValidatorSchema());
+
+// set schema for record.body.Message
+const perRecordsValidatorSchema = {
+  type: "object",
+  required: [
+    'objType',
+    'element'
+  ],
+  properties: {
+    objType: {
+      type: 'object',
+      required: ["serviceTag", "objectType"],
+      properties: {
+        serviceTag: {
+          type: "string",
+          enum: [process.env.iz_serviceTag]
+        },
+        objectType: izara.validatorSchema.stringNotEmpty()
+      }
+    },
+    element: {
+      type: "object"
+    },
+    callingFlow: {
+      type: 'string',
+      default: ''
+    }
+  }
+};
+
+// set schema for record.body.MessageAttributes
+// const messageAttributeValidatorSchema = {
+//   type: "object",
+//   required: ['msgAtrrParam1', 'msgAtrrParam2'],
+//   properties: {
+//     msgAtrrParam1: {
+//       type: "string"
+//     },
+//     msgAtrrParam2: {
+//       type: "object"
+//     }
+//   }
+// };
+
+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
+        "ProcessLogicalHdrSqs",             // 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.objType)
+      passOnProperties.push(record.body.Message.element)
+      passOnProperties.push(record.body.Message.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
+        processLogical.processLogical,  // mainFunction that need to invoke.
+        "ProcessLogicalHdrSqs",         // 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, ProcessLogicalHdrSqs: ', err);
+    throw (err);
+  }
+});

package/src/reStructure/TemplateData/processLogical/mainFunction/data.js

@@ -0,0 +1,47 @@
+/*
+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 } = require("../../../../MainLibs/index.js").consts;
+const templatePath = path.join(__dirname, "./template.ejs");
+
+
+/**
+ * receive srcPath
+ * not create data for ProcessLogical Main template
+ *
+ * @param {Object} srcPath
+ * @return {{ templatePath, templateData, setting } }
+ */
+
+function data(_izContext, srcPath) {
+
+  return {
+    templatePath: templatePath,
+    templateData: {},
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.processLogical),
+      saveFileName: `ProcessLogical_Main`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+module.exports = data;