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

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

@@ -0,0 +1,64 @@
+/*
+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,
+  // getAllLocalRelationshipSchemas,
+  getAllLocalRelationshipSchema,
+  getAllLocalFlowSchemas
+} = require('@izara_project/izara-core-library-service-schemas/src/GetObjectSchema');
+
+// processLogicalPaginate
+const createProcessLogicalPaginateHandlerDsq = require('./handler/dsq/data');
+const createProcessLogicalPaginateHandlerSqs = require('./handler/sqs/data');
+const createProcessLogicalPaginateMainFunction = require('./mainFunction/data');
+const createProcessLogicalPaginateFunctionYamlHdrDsq = require('./yaml/dsq/data');
+const createProcessLogicalPaginateFunctionYamlHdrSqs = require('./yaml/sqs/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 all the required components
+    const createSourceParams = [
+      createProcessLogicalPaginateHandlerDsq(_izContext, saveFilePath),
+      createProcessLogicalPaginateHandlerSqs(_izContext, saveFilePath),
+      createProcessLogicalPaginateMainFunction(_izContext, saveFilePath),
+      await createProcessLogicalPaginateFunctionYamlHdrDsq(_izContext, allObjSchemas, saveFilePath),
+      await createProcessLogicalPaginateFunctionYamlHdrSqs(_izContext, allObjSchemas, saveFilePath)
+    ];
+
+    return createSourceParams;
+  } catch (error) {
+    _izContext.logger.error('Error generating code with template:', error);
+    return [];
+  }
+}
+
+module.exports = generateCodeWithTemplate;

package/src/reStructure/TemplateData/processLogicalPagination/handler/dsq/data.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/>.
+*/
+
+'use strict';
+
+const path = require('path');
+const { SOURCE_PATH, FUNCTION_NAME, HANDLER } = require("../../../../../MainLibs/src/Consts");
+const { firstLetterUpperCase: upperCase } = require('../../../../../MainLibs/src/Utils');
+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: `${upperCase(FUNCTION_NAME.paginateProcessLogical)}_${upperCase(HANDLER.hdrDsq)}`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+module.exports = data;

package/src/reStructure/TemplateData/processLogicalPagination/handler/dsq/template.ejs

@@ -0,0 +1,163 @@
+/*
+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 paginateProcessLogical = require('./PaginateProcessLogical_Main');
+
+// validate event properties in body.Message of sqs event
+middleware.setValidatorSchema(recordHandlerSharedLib.baseValidatorSchema(
+  {
+    type: "object",
+    required: ['body', 'messageAttributes'],
+    properties: {
+      body: {
+        type: 'object',
+      },
+      messageAttributes: {
+        type: 'object'
+      }
+    }
+  }
+));
+
+// set schema for record.body.Message
+const perRecordsValidatorSchema = {
+  type: "object",
+  required: [
+    'logicalResultId',
+    'tableName',
+    'partitionKeyFieldName',
+    'sortKeyFieldName',
+    'startKey',
+    'overwriteUniqueRequestId'
+  ],
+  properties: {
+    logicalResultId: {
+      type: "string"
+    },
+    tableName: {
+      type: "string"
+    },
+    partitionKeyFieldName: {
+      type: "string"
+    },
+    sortKeyFieldName: {
+      type: "string"
+    },
+    comparison: {
+      type: "string",
+      default: ""
+    },
+    startKey: {
+      type: "object"
+    },
+    overwriteUniqueRequestId: {
+      type: "string"
+    },
+    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
+
+      // --- reforming record.body for Dsq request
+      record = recordHandlerSharedLib.reformatDsqMessage(record._izContext, record);
+      record._izContext.logger.debug('record PaginateProcessLogicalHdrDsq after reform', record);
+
+      let passOnProperties = []
+
+
+      // validate message (and MessageAttributes)
+      await recordHandlerSharedLib.validateRecord(
+        record, // one record will send to mainFunction
+        "PaginateProcessLogicalHdrDsq", // 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.logicalResultId)
+      passOnProperties.push(record.body.Message.tableName)
+      passOnProperties.push(record.body.Message.partitionKeyFieldName)
+      passOnProperties.push(record.body.Message.sortKeyFieldName)
+      passOnProperties.push(record.body.Message.comparison)
+      passOnProperties.push(record.body.Message.startKey)
+      passOnProperties.push(record.body.Message.overwriteUniqueRequestId)
+      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
+        paginateProcessLogical.paginateProcessLogical, // mainFunction that need to invoke.
+        "PaginateProcessLogicalHdrDsq", // 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, PaginateProcessLogicalHdrDsq: ', err);
+    throw (err);
+  }
+});

package/src/reStructure/TemplateData/processLogicalPagination/handler/sqs/data.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/>.
+*/
+
+'use strict';
+
+const path = require('path');
+const { SOURCE_PATH, FUNCTION_NAME, HANDLER } = require("../../../../../MainLibs/src/Consts");
+const { firstLetterUpperCase: upperCase } = require('../../../../../MainLibs/src/Utils');
+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: `${upperCase(FUNCTION_NAME.paginateProcessLogical)}_${upperCase(HANDLER.hdrSqs)}`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+module.exports = data;

package/src/reStructure/TemplateData/processLogicalPagination/handler/sqs/template.ejs

@@ -0,0 +1,146 @@
+/*
+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 paginateProcessLogical = require('./PaginateProcessLogical_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: [
+    'logicalResultId',
+    'tableName',
+    'partitionKeyFieldName',
+    'sortKeyFieldName'
+  ],
+  properties: {
+    logicalResultId: {
+      type: "string"
+    },
+    tableName: {
+      type: "string"
+    },
+    partitionKeyFieldName: {
+      type: "string"
+    },
+    sortKeyFieldName: {
+      type: "string"
+    },
+    comparison: {
+      type: "string",
+      default: ""
+    },
+    startKey: {
+      type: "object",
+      default: {}
+    },
+    overwriteUniqueRequestId: {
+      type: "string",
+      default: ""
+    },
+    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
+        "PaginateProcessLogicalHdrSqs", // 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.logicalResultId)
+      passOnProperties.push(record.body.Message.tableName)
+      passOnProperties.push(record.body.Message.partitionKeyFieldName)
+      passOnProperties.push(record.body.Message.sortKeyFieldName)
+      passOnProperties.push(record.body.Message.comparison)
+      passOnProperties.push(record.body.Message.startKey)
+      passOnProperties.push(record.body.Message.overwriteUniqueRequestId)
+      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
+        paginateProcessLogical.paginateProcessLogical, // mainFunction that need to invoke.
+        "PaginateProcessLogicalHdrSqs", // 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, PaginateProcessLogicalHdrSqs: ', err);
+    throw (err);
+  }
+});

package/src/reStructure/TemplateData/processLogicalPagination/mainFunction/data.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/>.
+*/
+
+'use strict';
+
+const path = require('path');
+const { SOURCE_PATH, FUNCTION_NAME, HANDLER } = require("../../../../MainLibs/src/Consts");
+const { firstLetterUpperCase: upperCase } = require('../../../../MainLibs/src/Utils');
+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: `${upperCase(FUNCTION_NAME.paginateProcessLogical)}_Main`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+module.exports = data;