@izara_project/izara-core-generate-service-code 1.0.45 → 1.0.47

package/src/generators/fromFlowSchema/index.js

@@ -0,0 +1,203 @@
+/*
+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 * as eventRegistry from './events/registry.js';
+import * as statusTypeRegistry from './statusTypes/registry.js';
+
+import createWebSocketComponent from './webSocket/index.js';
+import createRegisterComponent from './register/index.js';
+import createWebSocketGenerateCodeLibs from './shared/wsCodeLibs.js';
+import createFlowSchemaEndpointMainFunction from './flowSchemaMainFunction/main.js';
+
+import libs from '#libs/Libs.js';
+
+// Build handler maps from registry export names (key = export alias in registry.js)
+const EVENT_HANDLERS = { ...eventRegistry };
+const STATUS_HANDLERS = { ...statusTypeRegistry };
+
+// 'generatedCode' is intentionally a no-op placeholder
+const NO_OP_EVENTS = new Set(['generatedCode']);
+
+/**
+ * Generates template data from flow schemas.
+ * @param {Object} _izContext
+ * @param {string} appPath
+ * @param {Array}  allLocalFlowSchemas
+ * @param {Object} settings
+ * @returns {Promise<Array>}
+ */
+async function generateTemplateDataFromFlowSchema(
+  _izContext,
+  appPath,
+  allLocalFlowSchemas,
+  settings
+) {
+  try {
+    const startAllMs = Date.now();
+
+    const shouldGenerateWebSocketAndRegister = allLocalFlowSchemas.some(
+      flowSchema =>
+        Array.isArray(flowSchema?.event) &&
+        flowSchema.event.some(e => e === 'ownTopic' || e === 'extTopic')
+    );
+
+    const flowResults = await Promise.all(
+      allLocalFlowSchemas.map(async flowSchema => {
+        const flowStartMs = Date.now();
+        const flowTag = flowSchema?.flowTag ?? '(unknownFlowTag)';
+        const events = Array.isArray(flowSchema?.event) ? flowSchema.event : [];
+
+        console.info(
+          `[FlowSchema:${flowTag}] start events=${JSON.stringify(events)} statusType=${flowSchema?.statusType}`
+        );
+
+        // ── per-flowSchema shared resources ─────────────────────────────────
+        const perFlowParams = [
+          createWebSocketGenerateCodeLibs(_izContext, flowSchema, appPath)
+        ];
+
+        if (!flowSchema.event.includes('s3')) {
+          perFlowParams.push(
+            await createFlowSchemaEndpointMainFunction(
+              _izContext,
+              flowSchema,
+              appPath
+            )
+          );
+        }
+
+        // ── event handlers (driven by registry) ─────────────────────────────
+        const eventPromises = events
+          .filter(event => {
+            if (NO_OP_EVENTS.has(event)) {
+              console.info(`[FlowSchema:${flowTag}] skip no-op event=${event}`);
+              return false;
+            }
+            if (!(event in EVENT_HANDLERS)) {
+              console.warn(
+                `[FlowSchema:${flowTag}] skip unsupported event=${event}`
+              );
+              return false;
+            }
+            return true;
+          })
+          .map(event =>
+            Promise.resolve(
+              EVENT_HANDLERS[event](_izContext, flowSchema, appPath)
+            ).then(result => {
+              console.info(
+                `[FlowSchema:${flowTag}] done event=${event} generated=${Array.isArray(result) ? result.flat(5).length : 0}`
+              );
+              return result;
+            })
+          );
+
+        // ── statusType handler (driven by registry) ──────────────────────────
+        const { statusType, event } = flowSchema;
+        const statusPromise = (() => {
+          if (
+            statusType === 'statusField' &&
+            event.includes('ownTopic') &&
+            event.includes('extTopic')
+          ) {
+            return Promise.resolve(
+              STATUS_HANDLERS.statusField(_izContext, flowSchema, appPath)
+            ).then(result => {
+              console.info(
+                `[FlowSchema:${flowTag}] done statusType=statusField generated=${Array.isArray(result) ? result.flat(5).length : 0}`
+              );
+              return result;
+            });
+          }
+          if (statusType in STATUS_HANDLERS) {
+            return Promise.resolve(
+              STATUS_HANDLERS[statusType](_izContext, flowSchema, appPath)
+            ).then(result => {
+              console.info(
+                `[FlowSchema:${flowTag}] done statusType=${statusType} generated=${Array.isArray(result) ? result.flat(5).length : 0}`
+              );
+              return result;
+            });
+          }
+          if (statusType === 'storedCache' || statusType === 'none') {
+            console.info(
+              `[FlowSchema:${flowTag}] skip statusType=${statusType} (noop)`
+            );
+            return Promise.resolve([]);
+          }
+          if (statusType === 'statusField') {
+            return Promise.resolve([]);
+          }
+          throw new Error('Not supported statusType: ' + statusType);
+        })();
+
+        const results = [
+          ...perFlowParams,
+          ...(await Promise.all([...eventPromises, statusPromise])).flat(5)
+        ];
+
+        const targetFiles = libs.toUniqueFilePaths(results);
+        console.info(
+          `[FlowSchema:${flowTag}] completed generated=${results.length} elapsedMs=${Date.now() - flowStartMs}`
+        );
+        if (targetFiles.length)
+          console.info(`[FlowSchema:${flowTag}] targetFiles: `, targetFiles);
+
+        return results;
+      })
+    );
+
+    const createSourceParams = flowResults.flat(5);
+
+    if (shouldGenerateWebSocketAndRegister) {
+      const [webSocketResults, registerResults] = await Promise.all([
+        Promise.resolve(
+          createWebSocketComponent(_izContext, appPath, allLocalFlowSchemas)
+        ),
+        Promise.resolve(
+          createRegisterComponent(_izContext, allLocalFlowSchemas, appPath)
+        )
+      ]);
+
+      createSourceParams.push(...webSocketResults, ...registerResults);
+
+      const wsAndRegisterFiles = libs.toUniqueFilePaths([
+        ...webSocketResults,
+        ...registerResults
+      ]);
+      console.info(
+        `[FlowSchema:*] completed webSocket+register generated=${webSocketResults.length + registerResults.length}`
+      );
+      if (wsAndRegisterFiles.length)
+        console.info(
+          '[FlowSchema:*] targetFiles (webSocket+register) : ',
+          wsAndRegisterFiles
+        );
+    }
+
+    console.info(
+      `[FlowSchema:*] all completed flows=${allLocalFlowSchemas.length} generated=${createSourceParams.length} elapsedMs=${Date.now() - startAllMs}`
+    );
+
+    return createSourceParams;
+  } catch (error) {
+    console.error('Error in generateTemplateDataFromFlowSchema:', error);
+    throw error;
+  }
+}
+
+export default generateTemplateDataFromFlowSchema;

package/src/generators/fromFlowSchema/register/complete/functionYaml/yaml.js

@@ -0,0 +1,127 @@
+/*
+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 {
+  SOURCE_PATH,
+  RESOURCE_CLASSES,
+  DYNAMO_RESOURCE,
+  SAVE_FILE_NAME,
+  FUNCTION_NAME,
+  SOURCE_GENERATE_IAM_ROLE,
+  SQS_RESOURCE
+} = consts;
+
+const { firstLetterUpperCase: upperCase } = utils;
+
+const {
+  shortNameHandler,
+  defaultIamRolePerAction,
+  createIamRole,
+  resourceNames
+} = libs;
+
+const templatePath = path.join(__dirname, 'template.ejs');
+/**
+ * receive objectSchema
+ * create data for WebSocket handler template
+ *
+ * @param {Object} objectSchema
+ * @return {{templatePath, templateData,setting}}
+ */
+function data(_izContext, srcPath) {
+  const handlerType = upperCase('hdrSqs');
+  const functionName = upperCase(FUNCTION_NAME.flowSchemaRegister);
+  let functionNameConfig =
+    upperCase(functionName) + upperCase(shortNameHandler(handlerType));
+  let additionalResourcePermission = defaultIamRolePerAction();
+
+  additionalResourcePermission.push(
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.sqs]: [
+          SQS_RESOURCE.getQueueAttributes,
+          SQS_RESOURCE.receiveMessage,
+          SQS_RESOURCE.deleteMessage
+        ]
+      },
+      [resourceNames(RESOURCE_CLASSES.sqs, upperCase(functionName))]
+    ),
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.dynamoDbTable]: [
+          DYNAMO_RESOURCE.putItem,
+          DYNAMO_RESOURCE.getItem,
+          DYNAMO_RESOURCE.query,
+          DYNAMO_RESOURCE.deleteItem,
+          DYNAMO_RESOURCE.updateItem
+        ]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.dynamoDbTable, 'WebSocketTask'),
+        resourceNames(RESOURCE_CLASSES.dynamoDbTable, 'RegisterRecords')
+      ]
+    ),
+    createIamRole(
+      {
+        'execute-api': ['ManageConnections']
+      },
+      [resourceNames(RESOURCE_CLASSES.webSocket)]
+    )
+  );
+
+  // console.log("additionalResourcePermission in createObjectS3", JSON.stringify(additionalResourcePermission))
+  return {
+    templatePath: templatePath,
+    templateData: {
+      handlerFilePath: path.join(
+        SOURCE_PATH.resourceLocationFlowSchemaRegister,
+        'source/',
+        `${functionName}_${handlerType}`
+      ),
+
+      resourceLocation: path.join(
+        SOURCE_PATH.resourceLocationFlowSchemaRegister,
+        'source/'
+      ),
+
+      additionalResourcePermission,
+      functionName,
+      handlerType,
+      roleName: SOURCE_GENERATE_IAM_ROLE.RegisterRole,
+      functionNameConfig,
+      upperFunctionName: upperCase(functionName),
+      upperHandlerType: upperCase(handlerType),
+      upperFunctionNameConfig: upperCase(functionNameConfig)
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
+      saveFileName: SAVE_FILE_NAME.flowSchemaYaml,
+      fileExtension: '.yml',
+      isAppend: true
+    }
+  };
+}
+
+export default data;

package/src/generators/fromFlowSchema/register/complete/handler/handler.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 { SOURCE_PATH, FUNCTION_NAME, HANDLER } = consts;
+const { firstLetterUpperCase: upperCase } = 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, srcPath) {
+  let queueName = FUNCTION_NAME.flowSchemaRegister;
+  let functionName = FUNCTION_NAME.flowSchemaRegister + 'Complete';
+  let handlerType = upperCase(HANDLER.hdrSqs);
+  const upperFunctionName = upperCase(functionName);
+  const upperQueueName = upperCase(queueName);
+  return {
+    templatePath: templatePath,
+    templateData: {
+      queueName,
+      functionName: functionName,
+      handler: HANDLER.hdrSqs,
+      firstLetterUpperCase: upperCase,
+      upperFunctionName,
+      upperQueueName
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.flowSchemaRegister, 'source/'),
+      saveFileName: `${upperCase(functionName)}_${handlerType}`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  };
+}
+export default data;

package/src/generators/fromFlowSchema/register/complete/handler/template.ejs

@@ -0,0 +1,85 @@
+/*
+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 } from "@izara_project/izara-middleware";
+import Logger from '@izara_project/izara-core-library-logger';
+import callingFlowSharedLib from '@izara_project/izara-core-library-calling-flow';
+import { recordHandlerSharedLib } from "@izara_project/izara-core-library-record-handler";
+
+import <%- functionName %> from './<%- upperFunctionName %>_Main.js';
+
+// validate event properties in body.Message of sqs event
+middlewareHandler.setValidatorSchema(recordHandlerSharedLib.baseValidatorSchema());
+let perRecordsValidatorSchema = {}
+export const main = middlewareHandler.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.TopicArn)
+      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 %>Main,        // 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, <%- functionName%>: ', err);
+    throw (err);
+  }
+});

package/src/generators/fromFlowSchema/register/dynamoDB/register.js

@@ -0,0 +1,74 @@
+/*
+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 { firstLetterUpperCase: upperCase } = utils;
+
+const { SOURCE_PATH, SAVE_FILE_NAME } = consts;
+
+const templatePath = path.join(
+  __dirname,
+  '../../../resourceYamlComponent/dynamodb/template.ejs'
+);
+
+/**
+ * create param of crateSouce for FindData And processLogical
+ *
+ * @param {Object} _izContext
+ * @param {String} srcPath
+ * @returns {Object[]}
+ */
+const createRegisterTable = (_izContext, srcPath) => {
+  const tableName = 'RegisterRecords';
+
+  return {
+    templatePath: templatePath,
+    templateData: {
+      tableName: tableName,
+      resourceName: tableName,
+
+      attributes: [
+        {
+          keyType: 'partitionKey',
+          AttributeName: 'identifiersTask',
+          AttributeType: 'S'
+        },
+        {
+          keyType: 'sortKey',
+          AttributeName: 'connectionId',
+          AttributeType: 'S'
+        }
+      ],
+
+      upperTableName: upperCase(tableName)
+    },
+    setting: {
+      initialData: 'Resources:\n',
+      savePath: path.join(srcPath, SOURCE_PATH.resourceYaml),
+      saveFileName: SAVE_FILE_NAME.dynamoDbYaml,
+      fileExtension: '.yml',
+      isAppend: true
+    }
+  };
+};
+
+export default createRegisterTable;

package/src/generators/fromFlowSchema/register/index.js

@@ -0,0 +1,50 @@
+import createFlowSchemaRegisterHandlerComplete from './complete/handler/handler.js';
+import createFlowSchemaRegisterMainCompleteFunc from './complete/mainFunction/main.js';
+import createFlowSchemaRegisterHandlerWbsFunc from './wbs/handler/handler.js';
+import createFlowSchemaRegisterMainWbsFunc from './wbs/mainFunction/main.js';
+import createFlowSchemaRegisterMainCompleteFuncYaml from './complete/functionYaml/yaml.js';
+import createFlowSchemaRegisterMainWbsFuncYaml from './wbs/functionYaml/yaml.js';
+import createFlowSchemaRegisterSnsInSqs from './sns-in/snsIn.js';
+import createFlowSchemaRegisterSubscribeOutAll from './subscriptionOutAll/subscriptionOutAll.js';
+import createFlowSchemaRegisterDynamoDb from './dynamoDB/register.js';
+
+/**
+ *
+ * @param {*} _izContext
+ * @param {*} allLocalFlowSchemas
+ * @param {*} saveFilePath
+ * @returns
+ */
+function createFlowSchemaRegisterComponent(
+  _izContext,
+  allLocalFlowSchemas,
+  saveFilePath
+) {
+  const createSourceParams = [
+    createFlowSchemaRegisterHandlerComplete(_izContext, saveFilePath),
+    createFlowSchemaRegisterMainCompleteFunc(
+      _izContext,
+      allLocalFlowSchemas,
+      saveFilePath
+    ),
+    createFlowSchemaRegisterHandlerWbsFunc(_izContext, saveFilePath),
+    createFlowSchemaRegisterMainWbsFunc(_izContext, saveFilePath),
+    createFlowSchemaRegisterMainCompleteFuncYaml(_izContext, saveFilePath),
+    createFlowSchemaRegisterMainWbsFuncYaml(
+      _izContext,
+      allLocalFlowSchemas,
+      saveFilePath
+    ),
+    createFlowSchemaRegisterSnsInSqs(_izContext, saveFilePath),
+    ...createFlowSchemaRegisterSubscribeOutAll(
+      _izContext,
+      allLocalFlowSchemas,
+      saveFilePath
+    ),
+    createFlowSchemaRegisterDynamoDb(_izContext, saveFilePath)
+  ];
+
+  return createSourceParams.flat();
+}
+
+export default createFlowSchemaRegisterComponent;

package/src/generators/fromFlowSchema/register/sns-in/snsIn.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/>.
+*/
+
+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, FUNCTION_NAME } = consts;
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } =
+  utils;
+
+const templatePath = path.join(__dirname, 'template.ejs');
+
+/**
+ * create data for dynamoDbYaml template 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 createDataForSnsIn(_izContext, srcPath) {
+  const queueName = upperCase(FUNCTION_NAME.flowSchemaRegister);
+  const upperQueueName = upperCase(queueName);
+  return {
+    templatePath: templatePath,
+    templateData: {
+      queueName,
+      firstLetterUpperCase: upperCase,
+      upperQueueName
+    },
+    setting: {
+      initialData: 'Resources:\n',
+      savePath: path.join(srcPath, SOURCE_PATH.resourceYaml),
+      saveFileName: SAVE_FILE_NAME.snsInSqsYaml,
+      fileExtension: '.yml',
+      isAppend: true
+    }
+  };
+}
+export default createDataForSnsIn;