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

package/src/IntTestConfig.js

@@ -0,0 +1,23 @@
+/*
+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/>.
+*/
+
+export const IntTestConfig = {
+  TemplateAndData: {
+    IntTest: './TemplateData/IntTest/generateTemplateData.js'
+  },
+  Plugin: {}
+};

package/src/SchemaConfig.js

@@ -0,0 +1,23 @@
+/*
+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/>.
+*/
+
+export const schemaConfig = {
+  TemplateAndData: {
+    propertyValue: './TemplateData/propertyValueSchema/generateTemplateData.js'
+  },
+  Plugin: {}
+};

package/src/SourceManager/CreateSource.js

@@ -0,0 +1,226 @@
+/*
+Copyright(C) 2021 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 fs from 'fs';
+import ejs from 'ejs';
+import { join } from 'path';
+import beautify from 'js-beautify/js/index.js';
+
+const beautifySetting = {
+  indent_size: '2',
+  indent_char: ' ',
+  max_preserve_newlines: '0',
+  // "preserve_newlines": true,
+  keep_array_indentation: true,
+  indent_scripts: 'separate',
+  brace_style: ['preserve-inline', 'none'],
+  space_before_conditional: true
+};
+
+const TAG_CLASSES = {
+  doubleTag: 'doubleTag',
+  singleTag: 'singleTag',
+  nameTag: 'nameTag',
+  anyTag: 'anyTag',
+  anyDoubleTag: 'anyDoubleTag',
+  ymlDoubleTag: 'ymlDoubleTag',
+  ymlAnyDoubleTag: 'ymlAnyDoubleTag'
+};
+
+function tagList(tagClass = TAG_CLASSES.singleTag, tagName) {
+  return {
+    // return regex depend on tagClass
+    [TAG_CLASSES.singleTag]: new RegExp(`\/\/\\(<${tagName}>\\)`, 'gm'), // match //(<tagName>)
+    [TAG_CLASSES.doubleTag]: new RegExp(
+      `\/\/\\(<${tagName}>\\)([\\s\\S]*?)\/\/\\(<\\/${tagName}>\\)`,
+      'gm'
+    ), // get data between tag -> //(<tagName>) data //(</tagName>)
+    [TAG_CLASSES.nameTag]: new RegExp(`__${tagName}`, 'gm'), // match //(<tagName>)
+    [TAG_CLASSES.anyTag]: new RegExp(`\/\/\\(<([^>]+)>\\)`, 'g'), // match //(<anyname>)
+    [TAG_CLASSES.anyDoubleTag]: new RegExp(
+      '\/\/\\(<(\\w+)>\\)([\\s\\S]*?)\/\/\\(<\/\\1>\\)',
+      'gm'
+    ),
+    [TAG_CLASSES.ymlDoubleTag]: new RegExp(
+      `\#<#${tagName}#>([\\s\\S]*?)#<#\/${tagName}#>`,
+      'gm'
+    ), // match #<#tag#> #<#/tag#>
+    [TAG_CLASSES.ymlAnyDoubleTag]: new RegExp(
+      `\#<#(\\w+)#>([\\s\\S]*?)#<#\/\\1#>`,
+      'gm'
+    ) // get tagName from  doubleTag #<#tagName#> #<#/tagName#>
+  }[tagClass];
+}
+
+/**
+ *
+ * @param {string} template
+ * @param {object} data
+ * @returns
+ */
+function generateDataFromTemplate(template, data) {
+  let dataToSave = ejs.compile(template)(data);
+  return dataToSave;
+}
+
+/**
+ * generate code from template and data then save generated data
+ *
+ * @param {string} template
+ * @param {object} data
+ * @param {object} setting
+ * @param {string} setting.savePath
+ * @param {string} [setting.hookPath]
+ * @param {string} setting.saveFileName
+ * @param {string} setting.fileExtension
+ * @param {boolean} setting.isAppend
+ * @param {string} setting.initialData // initialData can use when isAppend = true
+ * @returns
+ */
+async function createSource(
+  template,
+  data,
+  {
+    savePath,
+    hookPath,
+    saveFileName,
+    fileExtension,
+    initialData,
+    isAppend = false,
+    checkCreateSourcePass = false,
+    generateHookFile = true
+  }
+) {
+  try {
+    if (checkCreateSourcePass) {
+      try {
+        generateDataFromTemplate(template, data);
+        return [true, {}];
+      } catch (errors) {
+        return [false, errors];
+      }
+    }
+
+    let dataToSave = generateDataFromTemplate(template, data);
+
+    let anyDoubleTagClass;
+    let doubleTagClass;
+
+    if (fileExtension === '.js') {
+      anyDoubleTagClass = TAG_CLASSES.anyDoubleTag;
+      doubleTagClass = TAG_CLASSES.doubleTag;
+    } else if (fileExtension === '.yml') {
+      anyDoubleTagClass = TAG_CLASSES.ymlAnyDoubleTag;
+      doubleTagClass = TAG_CLASSES.ymlDoubleTag;
+    }
+    let hookDataPath = hookPath ? hookPath : join(savePath, '../hook/');
+
+    if (!fs.existsSync(savePath)) fs.mkdirSync(savePath, { recursive: true });
+    if (generateHookFile)
+      if (!fs.existsSync(hookDataPath))
+        fs.mkdirSync(hookDataPath, { recursive: true });
+
+    // check saveFileName for Hook exists
+    if (
+      fs.existsSync(`${hookDataPath}${saveFileName}${fileExtension}`.trim())
+    ) {
+      const hookData = fs.readFileSync(
+        `${hookDataPath}${saveFileName}${fileExtension}`,
+        'utf8'
+      );
+
+      //replace data in tag from hook file to actual file
+      let dataAfterHook = dataToSave.replace(
+        tagList(anyDoubleTagClass),
+        (match, tagName, content) => {
+          let hookRegex = tagList(doubleTagClass, tagName);
+          let replaceData = hookData.match(hookRegex);
+
+          if (replaceData) {
+            return replaceData;
+          } else {
+            return match;
+          }
+        }
+      );
+
+      dataAfterHook =
+        fileExtension === '.js'
+          ? beautify(dataAfterHook, beautifySetting)
+          : dataAfterHook;
+      if (isAppend) {
+        if (
+          !fs.existsSync(`${savePath}${saveFileName}${fileExtension}`) &&
+          initialData
+        ) {
+          fs.writeFileSync(
+            `${savePath}${saveFileName}${fileExtension}`.trim(),
+            initialData + dataAfterHook + '\n\n',
+            'utf8'
+          );
+        } else {
+          fs.appendFileSync(
+            `${savePath}${saveFileName}${fileExtension}`.trim(),
+            dataAfterHook + '\n\n',
+            'utf8'
+          );
+        }
+      } else {
+        fs.writeFileSync(
+          `${savePath}${saveFileName}${fileExtension}`.trim(),
+          dataAfterHook,
+          'utf8'
+        );
+      }
+    } else {
+      dataToSave =
+        fileExtension === '.js'
+          ? beautify(dataToSave, beautifySetting)
+          : dataToSave;
+      if (isAppend) {
+        if (
+          !fs.existsSync(`${savePath}${saveFileName}${fileExtension}`) &&
+          initialData
+        ) {
+          fs.writeFileSync(
+            `${savePath}${saveFileName}${fileExtension}`.trim(),
+            initialData + dataToSave + '\n\n',
+            'utf8'
+          );
+        } else {
+          fs.appendFileSync(
+            `${savePath}${saveFileName}${fileExtension}`.trim(),
+            dataToSave + '\n\n',
+            'utf8'
+          );
+        }
+      } else {
+        fs.writeFileSync(
+          `${savePath}${saveFileName}${fileExtension}`.trim(),
+          dataToSave,
+          'utf8'
+        );
+      }
+    }
+
+    return;
+  } catch (err) {
+    console.log('error createSource: ', err); // generate
+    throw err;
+  }
+}
+export default createSource;

package/src/TemplateConfig.js

@@ -0,0 +1,55 @@
+/*
+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/>.
+*/
+
+export const templateConfig = {
+  TemplateAndData: {
+    // ** PerActionEndpoint **
+    // perActionEndpoint: './TemplateData/perActionEndpoint/generateTemplateData.js',
+
+    // ** endpoint per service **
+    endpointPerServiceConfig:
+      './TemplateData/EndpointPerService/generateTemplateData.js',
+
+    // ** perActionComplete **
+    perActionComplete: './TemplateData/perActionComplete/generateTemplateData.js',
+
+    // ** Resource YAML **
+    resourceYaml: './TemplateData/resourceYaml/generateTemplateData.js',
+
+    // ** External Service **
+    externalService: './TemplateData/externalService/generateTemplateData.js',
+
+    // ** Relationship Per Action **
+    relationshipPerAction: './TemplateData/relationshipPerAction/generateTemplateData.js',
+
+    // ** Find Data **
+    findData: './TemplateData/findData/generateTemplateData.js',
+
+    // ** Process Logical **
+    processLogical: './TemplateData/processLogical/generateTemplateData.js',
+
+    // ** Process Logical Paginate **
+    processLogicalPaginate: './TemplateData/processLogicalPagination/generateTemplateData.js',
+
+    // ** flowSchema **
+    flowSchema: './TemplateData/flowSchema/generateTemplateData.js',
+
+    // ** Auth **
+    auth: './TemplateData/Auth/generateTemplateData.js'
+  },
+  Plugin: {}
+};

package/src/TemplateData/Auth/generateAuthYml/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/>.
+*/
+
+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';
+const { SOURCE_PATH } = 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, srcPath) {
+  return {
+    templatePath: templatePath,
+    templateData: {},
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
+      saveFileName: 'Authorizer',
+      fileExtension: '.yml',
+      isAppend: true
+    }
+  };
+}
+
+export default data;

package/src/TemplateData/Auth/generateAuthYml/template.ejs

@@ -0,0 +1,16 @@
+authorizerServiceSchema:
+  type: request
+  functionArn: ${self:custom.iz_authorizerServiceSchemaV2}
+  identitySource:
+    - $request.header.Authorization
+    - $context.routeKey
+  resultTtlInSeconds: 300
+
+authorizerIdentifiers:
+  type: request
+  functionArn: ${self:custom.iz_authorizerServiceSchemaV2}
+  identitySource:
+    - $request.header.Authorization
+    - $context.routeKey
+    - $request.querystring.identifiers
+  resultTtlInSeconds: 300

package/src/TemplateData/Auth/generateTemplateData.js

@@ -0,0 +1,48 @@
+/*
+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 { join } from 'path';
+// Import handlers and generators
+import generateAuth from './generateAuthYml/data.js';
+
+// Import code libs generator
+// const createGenerateCodeLibs = require('./libs/data');
+
+/**
+ * Generates code from templates based on object schemas
+ * @param {Object} _izContext - Context object
+ * @param {string} objSchemaPath - Path to object schema
+ * @returns {Promise<Array>} - Array of parameter objects for code generation
+ */
+async function generateCodeWithTemplate(_izContext, objSchemaPath) {
+  try {
+    const saveFilePath = join(objSchemaPath, `../`);
+    let authYamlFile = generateAuth(_izContext, saveFilePath);
+
+    const createSourceParams = [authYamlFile];
+
+    return createSourceParams;
+  } catch (error) {
+    _izContext.logger.error(
+      'Error generating code with template endpointPerService:',
+      error
+    );
+    return [];
+  }
+}
+
+export default generateCodeWithTemplate;

package/src/TemplateData/EndpointPerService/generateTemplateData.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 { join } from 'path';
+import { NoRetryError } from '@izara_project/izara-core-library-core';
+import { getObjectSchema } from '@izara_project/izara-core-library-service-schemas';
+// Import handlers and generators
+
+import invHandler from './handler/inv/data.js';
+import apiHandler from './handler/api/data.js';
+import sqsHandler from './handler/sqs/data.js';
+import dsqHandler from './handler/dsq/data.js';
+import createMain from './mainFunction/create/data.js';
+import updateMain from './mainFunction/update/data.js';
+import getMain from './mainFunction/get/data.js';
+import deleteMain from './mainFunction/delete/data.js';
+import yamlGenerator from './yaml/data.js';
+
+const modules = {
+  handlers: {
+    invHandler,
+    apiHandler,
+    sqsHandler,
+    dsqHandler
+  },
+  mainFunctions: {
+    createMain,
+    updateMain,
+    getMain,
+    deleteMain
+  },
+  // yamlGenerators: {
+  //   inv: require('./yaml/inv/data'),
+  //   api: require('./yaml/api/data'),
+  //   sqs: require('./yaml/sqs/data'),
+  //   dsq: require('./yaml/dsq/data')
+  // },
+  yamlGenerators: {
+    yamlGenerator
+  }
+};
+
+// Import code libs generator
+// const createGenerateCodeLibs = require('./libs/data');
+
+/**
+ * Generates code from templates based on object schemas
+ * @param {Object} _izContext - Context object
+ * @param {string} objSchemaPath - Path to object schema
+ * @returns {Promise<Array>} - Array of parameter objects for code generation
+ */
+async function generateCodeWithTemplate(_izContext, objSchemaPath) {
+  try {
+    const saveFilePath = join(objSchemaPath, `../`);
+    const allObjSchemas =
+      await getObjectSchema.getAllLocalObjectSchemasWithHierarchy(
+        _izContext,
+        objSchemaPath
+      );
+    // console.log('allObjSchemas: ', allObjSchemas.records);
+    const createSourceParams = [];
+
+    for (const objectSchema of allObjSchemas.records) {
+      try {
+        // Generate handlers
+        const handlerParams = Object.entries(modules.handlers).flatMap(
+          ([type, handlerFn]) => handlerFn(_izContext, saveFilePath)
+        );
+
+        // Generate main functions
+        const functionParams = (
+          await Promise.all(
+            Object.entries(modules.mainFunctions).map(([action, functionFn]) =>
+              functionFn(_izContext, saveFilePath)
+            )
+          )
+        ).flat();
+
+        // Generate code libs
+        // const libsParam = createGenerateCodeLibs(_izContext, saveFilePath);
+
+        createSourceParams.push(...handlerParams, ...functionParams);
+      } catch (error) {
+        _izContext.logger.error(
+          `Error processing schema ${objectSchema.name || 'unknown'}: ${error}`
+        );
+        throw new NoRetryError(error);
+      }
+    }
+    try {
+      // Generate function YAML files
+      const yamlParams = (
+        await Promise.all(
+          Object.entries(modules.yamlGenerators).map(([type, yamlFn]) =>
+            yamlFn(_izContext, allObjSchemas, saveFilePath)
+          )
+        )
+      ).flat();
+      createSourceParams.push(...yamlParams);
+    } catch (error) {
+      _izContext.logger.error(`Error processing schema yaml ${error}`);
+    }
+    return createSourceParams;
+  } catch (error) {
+    _izContext.logger.error(
+      'Error generating code with template endpointPerService:',
+      error
+    );
+    return [];
+  }
+}
+
+export default generateCodeWithTemplate;

package/src/TemplateData/EndpointPerService/handler/api/data.js

@@ -0,0 +1,72 @@
+/*
+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 { ACTIONS, HANDLER, DEFAULT_HANDLER_PER_ACTION, SOURCE_PATH } = consts;
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = utils;
+
+const templatePath = path.join(__dirname, 'template.ejs');
+
+/**
+ * receive objectSchema
+ * create data for hdrApi template
+ *
+ * @param {Object} objectSchema
+ * @return {{ templatePath, templateData, setting } }
+ */
+function data(_izContext, srcPath) {
+  let createSourceArray = [];
+  for (const action of Object.values(ACTIONS)) {
+    const defaultHandlers = DEFAULT_HANDLER_PER_ACTION[action];
+    for (const defaultHandler of defaultHandlers) {
+      if (defaultHandler === HANDLER.hdrApi) {
+        const createSourceParam = createParamForCreateSource(
+          action,
+          defaultHandler,
+          srcPath
+        );
+        createSourceParam && createSourceArray.push(createSourceParam);
+      }
+    }
+  }
+  // console.log("createSourceArray::", JSON.stringify(createSourceArray, null, 2))
+  return createSourceArray;
+}
+
+function createParamForCreateSource(action, handler, srcPath) {
+  return {
+    templatePath: templatePath,
+    templateData: {
+      action: action,
+      handler
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.endpointPerService),
+      saveFileName: `${upperCase(action)}_${upperCase(handler)}`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  };
+}
+
+export default data;

package/src/TemplateData/EndpointPerService/handler/api/request.json

@@ -0,0 +1,7 @@
+{
+  "objectType": "objectType",
+  "action": "get",
+  "mainFunction": "xxx",
+  "mainFunctionFile": "directoryOfMainFunction",
+  "isCreateMainByDev": "boolean"
+}