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

package/src/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/>.
+*/
+
+import path from 'path';
+import { fileURLToPath } from 'url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+import { consts, utils } from '../../../../MainLibs/index.js';
+
+const { SOURCE_PATH, FUNCTION_NAME, HANDLER } = consts;
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } =
+  utils;
+
+const templatePath = path.join(__dirname, 'template.ejs');
+/**
+ * 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
+    }
+  };
+}
+
+export default data;

package/src/TemplateData/processLogical/handler/template.ejs

@@ -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 { middlewareHandler as middleware } from "@izara_project/izara-middleware";
+import Logger from '@izara_project/izara-core-library-logger';
+import { recordHandlerSharedLib } from "@izara_project/izara-core-library-record-handler";
+import callingFlowSharedLib from '@izara_project/izara-core-library-calling-flow';
+
+import processLogical from './ProcessLogical_Main.js';
+
+
+// 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"
+//     }
+//   }
+// };
+
+export const 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,  // 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/TemplateData/processLogical/mainFunction/data.js

@@ -0,0 +1,49 @@
+/*
+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 '../../../../MainLibs/index.js';
+
+const { SOURCE_PATH } = 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
+    }
+  };
+}
+
+export default data;

package/src/TemplateData/processLogical/mainFunction/template.ejs

@@ -0,0 +1,424 @@
+/*
+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 dynamodbSharedLib from '@izara_project/izara-core-library-dynamodb';
+import snsSharedLib from '@izara_project/izara-core-library-sns';
+import logicalResultsSharedLib from '@izara_project/izara-core-library-logical-result';
+import { sns } from '@izara_project/izara-core-library-external-request';
+
+import { getObjectSchema, serviceConfig, consts, utils } from '@izara_project/izara-core-library-service-schemas';
+const { STORAGE_TYPES } = consts;
+const { getUsedFieldNamesOfIdentifiers } = utils;
+
+
+//(<additionalModule>)
+//(</additionalModule>)
+
+/**
+ * performs the logical operation/filter/search in the element, saves into LogicalResultsData table
+ * @param {Object} _izContext
+ * @param {Object} objType - contain objectType and serviceTag
+ * @param {Object} element - logical element
+ * @param {Object} element.type - "logical"
+ * @param {string} element.logicalType - contain "identifier" | "partitionKey"
+ * @param {string} [element.partitionKey] - value of fieldNames that is partitionKey. send if logicalType is "partitionKey"
+ * @param {string} [element.sortKey] - value of fieldNames that is sortKey. send if logicalType is "partitionKey"
+ * @param {string} [element.comparison] - use for query in queryElements.sortKeyCondition. send if logicalType is "partitionKey"
+ * @param {Object} [element.identifiers] - object that have identifier. send if logicalType is "identifier"
+ *
+ * @returns {string} description of return value
+ */
+
+export default async function processLogical(
+  _izContext,
+  objType,
+  element,
+  callingFlow
+) {
+
+  try {
+
+    _izContext.logger.debug('----- ProcessLogical event params -----', {
+      objType: objType,
+      element: element,
+      callingFlow: callingFlow
+    });
+
+    let removeAttributes = ["paginateProcessLogicalUniqueRequestId"];
+
+    //(<removeAttributes>)
+    //(</removeAttributes>)
+
+    // Check/Create logicalResultsMain
+    let [logicalResultsMainStatus, logicalResultId, logicalResultMain] = await logicalResultsSharedLib.checkLogicalMainStatus(
+      _izContext,
+      element, // for create logicalResultId
+      objType,
+      callingFlow,
+      removeAttributes
+    );
+    _izContext.logger.debug("After check logicalMainStatus: ", {
+      logicalResultsMainStatus: logicalResultsMainStatus,
+      logicalResultId: logicalResultId,
+      logicalResultMain: logicalResultMain
+    });
+
+    if (logicalResultsMainStatus !== "process") {
+      _izContext.logger.debug(`logicalResultsMainStatus status isn't process :${logicalResultsMainStatus}`);
+      return;
+    }
+
+    let errorsFound = [];
+
+    let standardErrorParams = [
+      _izContext,
+      logicalResultId,
+      logicalResultMain.logicalElement,
+      logicalResultMain.objType,
+      "error"
+    ];
+
+    if (element.logicalType === "identifier") {
+      _izContext.logger.debug("logicalType: ", element.logicalType)
+
+      if (!element.hasOwnProperty("identifiers")) {
+        errorsFound.push("element don't have identifier")
+      }
+
+      if (typeof element.identifiers !== "object") {
+        errorsFound.push("type of element isn't object")
+      }
+
+      const objectSchemas = await getObjectSchema.getObjSchemaS3WithHierarchy(_izContext, objType);
+      _izContext.logger.debug("objectSchemas: ", objectSchemas)
+
+      let identifiersFieldName = null;
+      let graphServerTag = null;
+      let fieldNameFindStorageTags = null;
+
+      const storageResources = objectSchemas.storageResources;
+      const fieldNames = objectSchemas.fieldNames;
+
+      for (const schemasIdentifier of objectSchemas.identifiers) {
+
+        if (schemasIdentifier.type === "identifier" || schemasIdentifier.type === "partitionKey") {
+
+          identifiersFieldName = schemasIdentifier.fieldName ?
+            schemasIdentifier.fieldName :
+            schemasIdentifier.name
+
+          if (identifiersFieldName == schemasIdentifier.name) {
+            fieldNameFindStorageTags = schemasIdentifier.fieldNames[0];
+          } else {
+            fieldNameFindStorageTags = identifiersFieldName;
+          }
+
+          let storageResourceTags = fieldNames[fieldNameFindStorageTags].storageResourceTags; // array
+          _izContext.logger.debug(`storageResourceTags of fieldNameForFindGraph ${fieldNameFindStorageTags}: `, storageResourceTags)
+
+          for (const storageResourceTag of storageResourceTags) {
+            _izContext.logger.debug("check storageResourceTag: ", storageResourceTag)
+
+            if (Object.keys(storageResources).includes(storageResourceTag) &&
+              storageResources[storageResourceTag].storageType === STORAGE_TYPES.graph) {
+              graphServerTag = storageResources[storageResourceTag].graphServerTag;
+              _izContext.logger.debug("found graphServerTag: ", graphServerTag)
+              break;
+            }
+          }
+        }
+      }
+
+      if (!graphServerTag) {
+        errorsFound.push("can't get graphServerTag")
+      }
+
+      const identifiersNames = getUsedFieldNamesOfIdentifiers(_izContext, objectSchemas.identifiers);
+      _izContext.logger.debug("identifiersNames: ", identifiersNames);
+
+      for (const identifierName of identifiersNames) {
+        if (!element.identifiers.hasOwnProperty(identifierName)) {
+          errorsFound.push(`Missing property: ${identifierName} in element`);
+        }
+      }
+
+      if (errorsFound.length > 0) {
+        _izContext.logger.debug("Have errorsFound: ", errorsFound)
+        standardErrorParams.push(errorsFound)
+        await logicalResultsSharedLib.completeLogicalResultsMain(...standardErrorParams);
+        return errorsFound;
+      }
+
+      const graphHandlerServiceTag = await serviceConfig.getGraphServiceTagWithCache(
+        _izContext,
+        graphServerTag
+      );
+
+      if (!graphHandlerServiceTag) {
+        _izContext.logger.debug("can't get graphServerTag")
+        errorsFound.push("can't get graphServerTag")
+        standardErrorParams.push(errorsFound)
+        await logicalResultsSharedLib.completeLogicalResultsMain(...standardErrorParams);
+        return;
+      }
+
+      let getNodeByIdentifiers = await graphSharedLib.getNodeV2(
+        _izContext,
+        graphHandlerServiceTag,
+        objType,
+        {
+          identifiers: element.identifiers
+        },
+      );
+      _izContext.logger.debug("getNodeByIdentifiers: ", getNodeByIdentifiers)
+
+      if (!getNodeByIdentifiers) {
+        errorsFound.push(`can not get node by identifiers`);
+        standardErrorParams.push(errorsFound)
+        await logicalResultsSharedLib.completeLogicalResultsMain(...standardErrorParams);
+        return;
+      }
+
+      await logicalResultsSharedLib.saveLogicalData(
+        _izContext,
+        logicalResultId,
+        objType,
+        element.identifiers
+      )
+
+      await logicalResultsSharedLib.completeLogicalResultsMain(
+        _izContext,
+        logicalResultId,
+        element,
+        objType,
+        "complete",
+        [],
+        callingFlow
+      )
+
+    } else if (element.logicalType === "partitionKey") {
+      _izContext.logger.debug("logicalType: ", element.logicalType)
+
+      if (!element.hasOwnProperty("partitionKey")) {
+        errorsFound.push("element don't have partitionKey")
+      }
+
+      if (element.comparison && !searchResultSharedLib.consts.POSSIBLE_COMPARISON_SORTID.includes(element.comparison)) {
+        errorsFound.push("comparison isn't possible comparison")
+      }
+
+      const objectSchemas = await getObjectSchema.getObjSchemaS3WithHierarchy(_izContext, objType);
+      _izContext.logger.debug("objectSchemas: ", objectSchemas)
+
+      let identifiersFieldName = null;
+      let tableName = null;
+      let fieldNameFindStorageTags = null; // AKA partitionKeyFieldName
+      let sortKeyFieldName = null;
+      let haveSortKey = false;
+
+      const storageResources = objectSchemas.storageResources;
+      const fieldNames = objectSchemas.fieldNames;
+
+      for (const schemasIdentifier of objectSchemas.identifiers) {
+
+        if (schemasIdentifier.type === "partitionKey") {
+
+          identifiersFieldName = schemasIdentifier.fieldName ?
+            schemasIdentifier.fieldName :
+            schemasIdentifier.name
+
+          if (identifiersFieldName == schemasIdentifier.name) {
+            fieldNameFindStorageTags = schemasIdentifier.fieldNames[0];
+          } else {
+            fieldNameFindStorageTags = identifiersFieldName;
+          }
+
+          let storageResourceTags = fieldNames[fieldNameFindStorageTags].storageResourceTags; // array
+          _izContext.logger.debug(`storageResourceTags of fieldNameForFindGraph ${fieldNameFindStorageTags}: `, storageResourceTags)
+
+          for (const storageResourceTag of storageResourceTags) {
+            _izContext.logger.debug("check storageResourceTag: ", storageResourceTag)
+
+            if (Object.keys(storageResources).includes(storageResourceTag) &&
+              storageResources[storageResourceTag].storageType === STORAGE_TYPES.dynamoDB
+            ) {
+              tableName = storageResources[storageResourceTag].tableName;
+              _izContext.logger.debug("found tableName: ", tableName)
+              break;
+            }
+          }
+        }
+
+        if (schemasIdentifier.type === "sortKey") {
+          haveSortKey = true;
+
+          sortKeyFieldName = schemasIdentifier.fieldName ?
+            schemasIdentifier.fieldName :
+            schemasIdentifier.name
+          _izContext.logger.debug("have sortKeyFieldName: ", sortKeyFieldName)
+        }
+      }
+
+      if (!tableName) {
+        errorsFound.push("can't get tableName")
+      }
+
+      if (errorsFound.length > 0) {
+        _izContext.logger.debug("Have errorsFound: ", errorsFound)
+        standardErrorParams.push(errorsFound)
+        await logicalResultsSharedLib.completeLogicalResultsMain(...standardErrorParams);
+        return;
+      }
+
+      if (element.hasOwnProperty("sortKey")) {
+
+        if (!sortKeyFieldName) {
+          _izContext.logger.debug("element have sortKey but can't find sortKey in object schemas")
+          errorsFound.push("element have sortKey but can't find sortKey in object schemas")
+          standardErrorParams.push(errorsFound)
+          await logicalResultsSharedLib.completeLogicalResultsMain(...standardErrorParams);
+          return;
+        }
+
+        let comparison = "equals";
+
+        if (element.comparison && element.comparison !== "equals") {
+          comparison = element.comparison;
+
+          let sentMessageToPaginateProcessLogical = {
+            Message: JSON.stringify({
+              logicalResultId: logicalResultId,
+              tableName: tableName,
+              partitionKeyFieldName: fieldNameFindStorageTags,
+              sortKeyFieldName: sortKeyFieldName,
+              comparison: comparison,
+              callingFlow: callingFlow
+            }),
+            TopicArn: await snsSharedLib.snsTopicArnByFlowSchema(_izContext, "InPaginateProcessLogical")
+          };
+          _izContext.logger.debug('Request params before send to topic InPaginateProcessLogical: ', sentMessageToPaginateProcessLogical);
+
+          let resSNS = await sns.publishAsync(_izContext, sentMessageToPaginateProcessLogical);
+          _izContext.logger.debug('resSNS send to topic ProcessSortResult finish!', resSNS);
+
+          return "Send message to InPaginateProcessLogical";
+
+        } else {
+
+          let queryDatas = await dynamodbSharedLib.query(
+            _izContext,
+            await dynamodbSharedLib.tableName(_izContext, tableName),
+            {
+              [fieldNameFindStorageTags]: element.partitionKey
+            },
+            {
+              sortKeyCondition: {
+                comparison: comparison,
+                name: sortKeyFieldName,
+                value: element.sortKey
+              }
+            }
+          )
+          _izContext.logger.debug("queryDatas result: ", queryDatas)
+
+          if (queryDatas.Items.length == 0) {
+            _izContext.logger.debug(`can't find data in table ${tableName} by query`)
+            errorsFound.push(`can't find data in table ${tableName} by query`)
+            standardErrorParams.push(errorsFound)
+            await logicalResultsSharedLib.completeLogicalResultsMain(...standardErrorParams);
+            return errorsFound;
+          }
+
+          for (const objInstanceBase of queryDatas.Items) {
+
+            await logicalResultsSharedLib.saveLogicalData(
+              _izContext,
+              logicalResultId,
+              logicalResultMain.objType,
+              objInstanceBase
+            )
+          }
+        }
+
+      } else { // element don't have sortKey
+
+        if (haveSortKey) {
+          _izContext.logger.debug("identifiers have sortKey: query dynamo")
+
+          let sentMessageToPaginateProcessLogical = {
+            Message: JSON.stringify({
+              logicalResultId: logicalResultId,
+              tableName: tableName,
+              partitionKeyFieldName: fieldNameFindStorageTags,
+              sortKeyFieldName: sortKeyFieldName,
+              callingFlow: callingFlow
+            }),
+            TopicArn: await snsSharedLib.snsTopicArnByFlowSchema(_izContext, "InPaginateProcessLogical")
+          };
+          _izContext.logger.debug('Request params before send to topic InPaginateProcessLogical: ', sentMessageToPaginateProcessLogical);
+
+          let resSNS = await sns.publishAsync(_izContext, sentMessageToPaginateProcessLogical);
+          _izContext.logger.debug('resSNS send to topic ProcessSortResult finish!', resSNS);
+
+          return "Send message to InPaginateProcessLogical";
+
+        } else {
+          _izContext.logger.debug("identifiers don't have sortKey: save dataId")
+
+          await logicalResultsSharedLib.saveLogicalData(
+            _izContext,
+            logicalResultId,
+            objType,
+            {
+              [fieldNameFindStorageTags]: element.partitionKey
+            }
+          )
+        }
+      }
+
+      // complete processLogical and send message Out
+      await logicalResultsSharedLib.completeLogicalResultsMain(
+        _izContext,
+        logicalResultId,
+        element,
+        objType,
+        "complete",
+        [],
+        callingFlow
+      )
+
+    }
+    //(<additionalProcessLogical>)
+    //(</additionalProcessLogical>)
+
+    else {
+      _izContext.logger.debug("unrecognised logicalType");
+      errorsFound.push("unrecognised logicalType")
+      standardErrorParams.push(errorsFound)
+      await logicalResultsSharedLib.completeLogicalResultsMain(...standardErrorParams);
+      return;
+    }
+
+    return "Function ProcessLogical is Finished"
+
+  } catch (err) {
+    _izContext.logger.error('error ProcessLogicalMain: ', err);
+    throw (err)
+  }
+}