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

package/src/TemplateData/perActionEndpoint/yaml/sqs/data.js

@@ -0,0 +1,237 @@
+/*
+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/>.
+*/
+
+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 { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } =
+  require('../../../../../MainLibs/src/Consts.js').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 {
+  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('../../../../../MainLibs/src/Consts.js').consts;
+
+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.hdrSqs)) {
+        // 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.hdrSqs)) {
+        // 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 objectType = objectSchema.objectType;
+  let groupBy = objectSchema?.shortNameObjectType
+    ? objectSchema.shortNameObjectType
+    : 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.hdrSqs));
+
+  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;
+      }
+    }
+  }
+
+  if (tableForGetItem.length) {
+    additionalResourcePermission.push(
+      createIamRole(
+        {
+          [RESOURCE_CLASSES.dynamoDbTable]: [
+            DEFAULT_LAMBDA_ROLE_PER_ACTION[action].dynamoDbPermission
+          ]
+        },
+        tableForGetItem
+      )
+    );
+  }
+
+  additionalResourcePermission.push(
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.sqs]: [
+          SQS_RESOURCE.deleteMessage,
+          SQS_RESOURCE.getQueueAttributes,
+          SQS_RESOURCE.receiveMessage,
+          SQS_RESOURCE.sendMessage,
+          SQS_RESOURCE.deleteMessageBatch,
+          SQS_RESOURCE.getQueueUrl
+        ],
+        [RESOURCE_CLASSES.sns]: ['Publish', 'Subscribe']
+      },
+      [
+        resourceNames(
+          RESOURCE_CLASSES.sqs,
+          functionName + upperCase(HANDLER.hdrSqs)
+        ),
+        resourceNames(
+          RESOURCE_CLASSES.sqs,
+          functionName + upperCase(HANDLER.hdrSqs) + 'DLQ'
+        ),
+        resourceNames(RESOURCE_CLASSES.sns, 'In' + functionName),
+        resourceNames(RESOURCE_CLASSES.sns, 'Out' + functionName)
+      ]
+    )
+  );
+  if (action == ACTIONS.update) {
+    additionalResourcePermission.push(awaitingMultipleStepsRole());
+    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(awaitingMultipleStepsRole());
+    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))
+    //     ]
+    //   )
+    // )
+  } else if (action === ACTIONS.get) {
+    additionalResourcePermission.push(
+      createIamRole(
+        {
+          [RESOURCE_CLASSES.sns]: [SNS_RESOURCE.publish]
+        },
+        [resourceNames(RESOURCE_CLASSES.sns, 'OutGetNodeComplete')]
+      )
+    );
+  }
+
+  // console.log("additionalResourcePermissionBeforeReturn", additionalResourcePermission)
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName: functionName,
+      actionHandler: actionHandler,
+      resourceLocation: SOURCE_PATH.resourceLocationPerAction,
+      handlerType: HANDLER.hdrSqs,
+      additionalResourcePermission,
+      functionNameConfig,
+      objectType,
+      roleName: groupBy
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
+      saveFileName: SAVE_FILE_NAME.functionPerActionYaml,
+      fileExtension: '.yml',
+      isAppend: true
+    }
+  };
+}
+
+module.exports = data;

package/src/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/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
+  #<#<%- functionName %><%- handlerType %>FunctionSetting#>
+  #<#/<%- functionName %><%- handlerType %>FunctionSetting#>
+  role: <%- firstLetterUpperCase(roleName) %>Role
+<%_ 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/perActionEndpoint/yaml/wbs/data.js

@@ -0,0 +1,204 @@
+/*
+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/>.
+*/
+
+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('../../../../../MainLibs/src/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('../../../../../MainLibs/src/Consts');
+
+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/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/TemplateData/perActionEndpoint/yaml/wbs/template.ejs

@@ -0,0 +1,29 @@
+<%_ 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:
+    - websocket:
+        route: <%- objectType -%><%- firstLetterUpperCase(actionHandler) %>
+  iamRoleStatements:
+    <%_ additionalResourcePermission.forEach(resourcePermission => { _%>
+    - Effect: <%- resourcePermission.effect %>
+      Action:
+        <%_ Object.keys(resourcePermission.action).forEach(resourcePerAction => { _%>
+        <%_ resourcePermission.action[resourcePerAction].forEach(permission => { _%>
+        - <%- resourcePerAction %>:<%- permission %>
+        <%_ }) _%>
+        <%_ }) _%>
+      Resource:
+        <%_ resourcePermission.resource.forEach(resource => { _%>
+        - "<%- resource %>"
+        <%_ }) _%>
+    <%_}) _%>
+    #<#<%- 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/TemplateData/perActionEndpoint/yaml/webSocketConnect/data.js

@@ -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/>.
+*/
+
+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/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/TemplateData/processLogical/generateTemplateData.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/>.
+*/
+
+// Import required modules
+import { join } from 'path';
+import { getObjectSchema } from '@izara_project/izara-core-library-service-schemas';
+const { getAllLocalObjectSchemasWithHierarchy } = getObjectSchema;
+
+// processLogical
+import createProcessLogicalHandler from './handler/data.js';
+import createProcessLogicalMainFunction from './mainFunction/data.js';
+import createProcessLogicalFunctionYaml from './yaml/data.js';
+
+/**
+ * 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 [];
+  }
+}
+
+export default generateCodeWithTemplate;