@izara_project/izara-market-library-service-schemas 1.0.4 → 1.0.6

package/src/TemplateManager/src/TranslateIdReq/TranslateIds/functionYaml/HdrSqs/data.js

@@ -0,0 +1,116 @@
+/*
+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 fs = require('fs');
+
+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, FUNCTION_NAME, externalResourceName } = require("../../../../libs/Consts");
+
+const templatePath = path.join(__dirname, '../../../../PerActionEndpoint/FunctionYaml/HdrDsq/template.ejs');
+
+function defaultIamRolePerAction() {
+  let defaultIamRole = [];
+
+  defaultIamRole.push(
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.s3]: ["GetObject", "GetObjectVersion"],
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.s3, "object-schema/perServiceSchemas/*"),
+        resourceNames(RESOURCE_CLASSES.s3, "object-schema/serviceConfig/ServiceNameConfig.json"),
+        resourceNames(RESOURCE_CLASSES.s3, "object-schema/serviceConfig/GraphServerTags.json")
+      ]
+    ),
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.s3]: ["ListBucket"]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.s3, "object-schema")
+      ]
+    )
+  )
+  return defaultIamRole
+}
+
+/**
+ * create data for function yaml for translateIds HdrSqs
+ */
+
+function data(_izContext, srcPath) {
+  return [createTranslateIdFunctionYmlHdrSqs(srcPath)]
+}
+
+function createTranslateIdFunctionYmlHdrSqs(srcPath) {
+  const functionName = FUNCTION_NAME.translateId;
+  const handlerType = HANDLER.hdrSqs;
+  let additionalResourcePermission = defaultIamRolePerAction();
+  additionalResourcePermission.push(
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.sqs]: [
+          SQS_RESOURCE.deleteMessage,
+          SQS_RESOURCE.getQueueAttributes,
+          SQS_RESOURCE.receiveMessage,
+          SQS_RESOURCE.sendMessage,
+          SQS_RESOURCE.getQueueUrl
+        ],
+        [RESOURCE_CLASSES.sns]:
+          [
+            "Publish", "Subscribe"
+          ]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.sqs, upperCase(functionName) + upperCase(handlerType)),
+        resourceNames(RESOURCE_CLASSES.sqs, upperCase(functionName) + upperCase(handlerType) + "DLQ"),
+        resourceNames(RESOURCE_CLASSES.sns, "In" + upperCase(functionName)),
+        resourceNames(RESOURCE_CLASSES.sns, "Out" + upperCase(functionName)),
+      ]
+    ),
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.dynamoDbTable]: ["GetItem", "UpdateItem"]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.dynamoDbTable, "TranslateIdsCacheMain")
+      ]
+    )
+  )
+
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      handlerType,
+      resourceLocation: SOURCE_PATH.resourceLocationTranslateId,
+      additionalResourcePermission
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
+      saveFileName: SAVE_FILE_NAME.translateId,
+      fileExtension: '.yml',
+      isAppend: true
+    }
+  }
+};
+
+module.exports = data;

package/src/TemplateManager/src/TranslateIdReq/TranslateIds/handler/HdrDsq/data.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/>.
+*/
+
+'use strict';
+const path = require('path');
+const fs = require('fs');
+
+const { ACTIONS, HANDLER } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase, firstLetterUpperCase } = require("../../../../../../MainLibs/src/Utils")
+const { DEFAULT_HANDLER_PER_ACTION, SOURCE_PATH, SAVE_FILE_NAME, FUNCTION_NAME } = require("../../../../libs/Consts");
+
+
+const templatePath = path.join(__dirname, "./template.ejs")
+
+/**
+ * create data for TranslateId Handler Dsq
+ * @return {{templatePath, templateData, setting}}
+ */
+
+function createTranslateIdHandlerDsq(_izContext, srcPath) {
+  let createSourceParams = createSourceParamsTranslateIdHandlerDsq(srcPath)
+  return [createSourceParams]
+}
+
+function createSourceParamsTranslateIdHandlerDsq(srcPath) {
+  const handlerType = HANDLER.hdrDsq
+  const functionName = FUNCTION_NAME.translateId
+  const queueName = upperCase(functionName) + upperCase(handlerType)
+  return {
+    templatePath: templatePath,
+    templateData: {
+      queueName,
+      functionName,
+      handlerType
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.translateIdsRequestFile),
+      saveFileName: `${SAVE_FILE_NAME.translateId}_${upperCase(handlerType)}`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+};
+
+module.exports = createTranslateIdHandlerDsq;

package/src/TemplateManager/src/TranslateIdReq/TranslateIds/handler/HdrDsq/template.ejs

@@ -0,0 +1,157 @@
+/*
+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 izara = require("@izara_project/izara-middleware");
+const middleware = izara.middlewareHandler;
+const callingFlowSharedLib = require('@izara_project/izara-shared/src/CallingFlowSharedLib');
+const recordHandlerSharedLib = require('@izara_project/izara-shared').recordHandlerSharedLib;
+const {
+  validateSchemaMiddleware
+} = require('@izara_project/izara-market-library-service-schemas/src/GenerateCodeLibs/src/GenerateCodeLibs');
+const Logger = require('@izara_project/izara-core-library-logger');
+const translateIdsRequest = require('./TranslateIdsRequest_Main')
+const perRecordsValidatorSchema = {
+  type: "object",
+  required: [
+    "fromObjType",
+    // "fromTypeId",
+    "toObjType",
+    // "toTypeId",
+    "relType",
+  ],
+  properties: {
+    fromObjType: {
+      type: "object",
+      required: ["objectType", "serviceTag"],
+      properties: {
+        objectType: izara.validatorSchema.stringNotEmpty(),
+        serviceTag: izara.validatorSchema.stringNotEmpty(),
+      },
+    },
+    fromTypeId: {
+      type: "string",
+    },
+    concatinateIdentifier: {
+      type: "string",
+    },
+    fromTable: {
+      type: "string",
+    },
+    fromPartitionKeyId: {
+      type: "string",
+    },
+    fromPartitionKeyFieldName: {
+      type: "string",
+    },
+    fromDataFieldName: {
+      type: "string",
+    },
+    toObjType: {
+      type: "object",
+      required: ["objectType", "serviceTag"],
+      properties: {
+        objectType: izara.validatorSchema.stringNotEmpty(),
+        serviceTag: izara.validatorSchema.stringNotEmpty(),
+      },
+    },
+    toTypeId: {
+      type: "string",
+    },
+    relType: {
+      type: "object",
+      required: ["relationshipTag", "serviceTag"],
+      properties: {
+        relationshipTag: izara.validatorSchema.stringNotEmpty(),
+        serviceTag: izara.validatorSchema.stringNotEmpty(),
+      }
+    },
+    invocationCount: {
+      type: "number",
+      default: 0,
+    },
+    callingFlow: {
+      type: "string",
+      default: "",
+    },
+  },
+};
+//(<globalVarible>)
+//(</globalVarible>)
+module.exports.main = middleware.wrap(async (event, context, callback) => {
+
+  try {
+    let recordPromises = []; // final return
+
+    // 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 LambdaFunctionHdrDsq after reform', record);
+
+      let passOnProperties = []
+
+      // --- validate message (and MessageAttributes)
+      await recordHandlerSharedLib.validateRecord(
+        record, // one record will send to mainFunction
+        "TranslateIdsRequestHdrDsq", // 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.fromObjType)
+      passOnProperties.push(record.body.Message.fromTypeId)
+      passOnProperties.push(record.body.Message.concatinateIdentifier)
+      passOnProperties.push(record.body.Message.fromTable)
+      passOnProperties.push(record.body.Message.fromPartitionKeyId)
+      passOnProperties.push(record.body.Message.fromPartitionKeyFieldName)
+      passOnProperties.push(record.body.Message.fromDataFieldName)
+      passOnProperties.push(record.body.Message.toObjType)
+      passOnProperties.push(record.body.Message.toTypeId)
+      passOnProperties.push(record.body.Message.relType)
+      passOnProperties.push(record.body.Message.callingFlow)
+      //(<afterSendParamIntoTranslateIdMainByHandlerDsq>)
+      //(</afterSendParamIntoTranslateIdMainByHandlerDsq>)
+
+      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
+        translateIdsRequest.translateIdsRequest, // mainFunction that need to invoke.
+        "TranslateIdsRequestHdrDsq", // 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
+    })) //end record
+
+    Logger.debug('before Promise.all(recordPromises) in handler');
+    try {
+      await Promise.all(recordPromises); // await all promises
+      return event.Records // return all for local test
+    } 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, TranslateIdsRequestHdrDsq:', err);
+    throw (err)
+  }
+})

package/src/TemplateManager/src/TranslateIdReq/TranslateIds/handler/HdrSqs/data.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/>.
+*/
+
+'use strict';
+const path = require('path');
+const fs = require('fs');
+
+const { ACTIONS, HANDLER } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase, firstLetterUpperCase } = require("../../../../../../MainLibs/src/Utils")
+const { DEFAULT_HANDLER_PER_ACTION, SOURCE_PATH, SAVE_FILE_NAME, FUNCTION_NAME } = require("../../../../libs/Consts");
+const templatePath = path.join(__dirname, './template.ejs');
+
+/**
+ * create data for sqs template
+ *
+ * @return {{templatePath,templateData,setting}}
+ */
+
+function data(_izContext, srcPath) {
+  const createSourceParams = createTranslateIdsHandlerSqs(srcPath);
+  return [createSourceParams]
+}
+
+function createTranslateIdsHandlerSqs(srcPath) {
+  const functionName = FUNCTION_NAME.translateId;
+  const handler = HANDLER.hdrSqs;
+  const queueName = upperCase(functionName) + upperCase(handler)
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      handler,
+      queueName
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.translateIdsRequestFile),
+      saveFileName: `${SAVE_FILE_NAME.translateId}_${upperCase(handler)}`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+};
+
+module.exports = data;

package/src/TemplateManager/src/TranslateIdReq/TranslateIds/handler/HdrSqs/template.ejs

@@ -0,0 +1,175 @@
+/*
+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 izara = require("@izara_project/izara-middleware");
+const middleware = izara.middlewareHandler;
+const callingFlowSharedLib = require('@izara_project/izara-shared/src/CallingFlowSharedLib')
+const {
+  validateSchemaMiddleware
+} = require('@izara_project/izara-market-library-service-schemas/src/GenerateCodeLibs/src/GenerateCodeLibs');
+const Logger = require('@izara_project/izara-core-library-logger');
+const recordHandlerSharedLib = require('@izara_project/izara-shared').recordHandlerSharedLib
+
+const <%- functionName %> = require('./<%- firstLetterUpperCase(functionName) %>_Main');
+
+middleware.setValidatorSchema(recordHandlerSharedLib.baseValidatorSchema());
+
+// validate event params in middleware before send into main function
+let validatorSchema = {
+  type: "object",
+  required: [
+    "fromObjType",
+    // "fromTypeId",
+    "toObjType",
+    // "toTypeId",
+    "relType",
+  ],
+  properties: {
+    fromObjType: {
+      type: "object",
+      required: ["objectType", "serviceTag"],
+      properties: {
+        objectType: izara.validatorSchema.stringNotEmpty(),
+        serviceTag: izara.validatorSchema.stringNotEmpty(),
+      },
+    },
+    fromTypeId: {
+      type: "string",
+    },
+    concatinateIdentifier: {
+      type: "string",
+    },
+    fromTable: {
+      type: "string",
+    },
+    fromPartitionKeyId: {
+      type: "string",
+    },
+    fromPartitionKeyFieldName: {
+      type: "string",
+    },
+    fromDataFieldName: {
+      type: "string",
+    },
+    toObjType: {
+      type: "object",
+      required: ["objectType", "serviceTag"],
+      properties: {
+        objectType: izara.validatorSchema.stringNotEmpty(),
+        serviceTag: izara.validatorSchema.stringNotEmpty(),
+      },
+    },
+    toTypeId: {
+      type: "string",
+    },
+    relType: {
+      type: "object",
+      required: ["relationshipTag", "serviceTag"],
+      properties: {
+        relationshipTag: izara.validatorSchema.stringNotEmpty(),
+        serviceTag: izara.validatorSchema.stringNotEmpty(),
+      }
+    },
+    invocationCount: {
+      type: "number",
+      default: 0,
+    },
+    callingFlow: {
+      type: "string",
+      default: "",
+    },
+  },
+};
+
+//(<globalVarible>)
+//(</globalVarible>)
+
+//validate event params in middleware
+validatorSchema = callingFlowSharedLib.addOptionalCallingFlowToValidatorSchema(validatorSchema);
+
+//(<afterValidate>)
+//(</afterValidate>)
+
+module.exports.main = middleware.wrap(async (event, context, callback) => {
+  try {
+    let recordPromises = []; // final return
+
+    // loop each record and send to mainFunction
+    await Promise.all(event.Records.map(async record => { // promise.all for map() function
+
+      let passOnProperties = []
+
+      // --- validate message (and MessageAttributes)
+      await recordHandlerSharedLib.validateRecord(
+        record, // one record will send to mainFunction
+        "<%-firstLetterUpperCase(queueName) %>",                       // queue name that need to retry or send to dlq
+        validatorSchema, // 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.fromObjType)
+      passOnProperties.push(record.body.Message.fromTypeId)
+      passOnProperties.push(record.body.Message.concatinateIdentifier)
+      passOnProperties.push(record.body.Message.fromTable)
+      passOnProperties.push(record.body.Message.fromPartitionKeyId)
+      passOnProperties.push(record.body.Message.fromPartitionKeyFieldName)
+      passOnProperties.push(record.body.Message.fromDataFieldName)
+      passOnProperties.push(record.body.Message.toObjType)
+      passOnProperties.push(record.body.Message.toTypeId)
+      passOnProperties.push(record.body.Message.relType)
+      passOnProperties.push(record.body.Message.callingFlow)
+      //(<afterPutParamIntoMainFunction>)
+      //(</afterPutParamIntoMainFunction>)
+
+      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 %>.<%- functionName %>,     // mainFunction that need to invoke.
+        "<%-firstLetterUpperCase(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
+      })) //end record
+
+      Logger.debug('before Promise.all(recordPromises) in handler');
+      try {
+        await Promise.all(recordPromises); // await all promises
+        return event.Records // return all for local test
+      } 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, <%- firstLetterUpperCase(functionName) %>:', err);
+    throw (err);
+  }
+})
+
+
+
+
+<%_ function firstLetterUpperCase(text) {
+  return text.charAt(0).toUpperCase() + text.slice(1)
+} _%>
+<%_ function firstLetterLowerCase(str) {
+  return str.charAt(0).toLowerCase() + str.slice(1)
+} _%>

package/src/TemplateManager/src/TranslateIdReq/TranslateIds/mainFunction/data.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/>.
+*/
+
+'use strict';
+const path = require('path');
+const fs = require('fs');
+
+const { ACTIONS, HANDLER } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+const { createGetDataDetails } = require('../../../../../GenerateCodeLibs/src/GenerateCodeLibs')
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase, firstLetterUpperCase } = require("../../../../../MainLibs/src/Utils")
+const { DEFAULT_HANDLER_PER_ACTION, SOURCE_PATH, SAVE_FILE_NAME, FUNCTION_NAME } = require("../../../libs/Consts");
+
+
+const templatePath = path.join(__dirname, "./template.ejs")
+
+
+/**
+ * receive objectSchema
+ * create data for TranslateedMain
+ *
+ * @param {object} objectSchema
+ * @return {{templatePath, templateData, setting}}
+ */
+
+async function createTranslateIdRequestMainFunction(_izContext, objectSchema, srcPath) {
+  return [await createSourceParams(_izContext, objectSchema, srcPath)];
+}
+
+async function createSourceParams(_izContext, objectSchema, srcPath) {
+  let functionName = FUNCTION_NAME.translateId
+  let getDataDetail = await createGetDataDetails(_izContext, objectSchema);
+  return {
+    templatePath: templatePath,
+    templateData: {
+      getDataDetail: JSON.stringify(getDataDetail),
+      functionName
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.translateIdsRequestFile),
+      saveFileName: `${SAVE_FILE_NAME.translateId}_Main`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+module.exports = createTranslateIdRequestMainFunction