@izara_project/izara-market-library-service-schemas 1.0.26 → 1.0.28

package/src/reStructure/TemplateData/relationshipPerAction/get/action/functionYaml/sqs/data.js

@@ -0,0 +1,131 @@
+/*
+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 { ACTIONS, HANDLER, STORAGE_TYPES } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../../MainLibs/index.js").utils;
+const {
+  createIamRole,
+  resourceNames,
+  RESOURCE_CLASSES,
+  SQS_RESOURCE,
+  SOURCE_PATH,
+  SAVE_FILE_NAME,
+  FUNCTION_NAME,
+  SNS_RESOURCE,
+  defaultIamRolePerAction,
+  awaitingMultipleStepsRole,
+  shortNameHandler,
+  SHORT_FUNCTION_NAME,
+  SOURCE_GENERATE_IAM_ROLE,
+  checkDynamoTypeRelationship,
+  createDynamoDbComponentByLinks,
+  DYNAMO_RESOURCE
+} = require("../../../../../../../MainLibs/index.js").consts;
+
+const templatePath = path.join(__dirname, './template.ejs')
+
+/**
+ * receive objectSchema
+ * create data for updateRelationshipSchema
+ *
+ * @param {Object} objectSchema
+ * @return {{ templatePath, templateData, setting } }
+ */
+
+function data(_izContext, allObjectRelationships, srcPath) {
+  let createSourceArray = [];
+  const createSourceParam = createParamForCreateSource(allObjectRelationships, srcPath);
+  createSourceArray.push(createSourceParam);
+  // console.log("createSourceArrayInUpdaterelationShipSchemahdrSqs", createSourceArray)
+  return createSourceArray
+}
+
+
+function createParamForCreateSource(allObjectRelationships, srcPath) {
+
+  let handlerType = HANDLER.hdrSqs
+  let functionName = FUNCTION_NAME.getRel
+  let additionalResourcePermission = defaultIamRolePerAction();
+
+  additionalResourcePermission.push(
+    // createIamRole(
+    //   { [RESOURCE_CLASSES.lambda]: ["InvokeFunction"] },
+    //   [resourceNames(RESOURCE_CLASSES.lambda, "*GetNodeHdrInv")]),
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.sqs]: [
+          SQS_RESOURCE.deleteMessage,
+          SQS_RESOURCE.getQueueAttributes,
+          SQS_RESOURCE.receiveMessage,
+          SQS_RESOURCE.sendMessage,
+          SQS_RESOURCE.getQueueUrl,
+          SQS_RESOURCE.deleteMessageBatch
+        ], [RESOURCE_CLASSES.sns]:
+          [SNS_RESOURCE.publish, SNS_RESOURCE.subscribe]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.sqs, upperCase(functionName) + upperCase(HANDLER.hdrSqs)),
+        resourceNames(RESOURCE_CLASSES.sqs, upperCase(functionName) + upperCase(HANDLER.hdrSqs) + "DLQ"),
+        resourceNames(RESOURCE_CLASSES.sns, "In" + upperCase(functionName) + upperCase(HANDLER.hdrSqs)),
+        resourceNames(RESOURCE_CLASSES.sns, "Out" + upperCase(functionName) + upperCase(HANDLER.hdrSqs)),
+        resourceNames(RESOURCE_CLASSES.sns, "Out" + upperCase(FUNCTION_NAME.getRelComplete))
+      ]
+    ),
+  )
+  additionalResourcePermission.push(awaitingMultipleStepsRole())
+
+  for (const relationship of allObjectRelationships) {
+    let [relationshipTag, links] = checkDynamoTypeRelationship(relationship)
+    for (const link of links) {
+      let dynamoComponent = createDynamoDbComponentByLinks(link, relationshipTag)
+      additionalResourcePermission.push(
+        createIamRole(
+          {
+            [RESOURCE_CLASSES.dynamoDbTable]: [DYNAMO_RESOURCE.updateItem]
+          },
+          [
+            resourceNames(RESOURCE_CLASSES.dynamoDbTable, upperCase(dynamoComponent.tableNameFrom)),
+            resourceNames(RESOURCE_CLASSES.dynamoDbTable, upperCase(dynamoComponent.tableNameTo))
+          ]
+        )
+      )
+    }
+  }
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      handlerType,
+      additionalResourcePermission,
+      resourceLocation: SOURCE_PATH.resourceLocationRelationshipPerAction,
+      functionNameConfig: upperCase(SHORT_FUNCTION_NAME.getRel) + upperCase(shortNameHandler(handlerType)),
+      roleName: SOURCE_GENERATE_IAM_ROLE.RelationshipRole
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
+      saveFileName: SAVE_FILE_NAME.functionRelationshipYaml,
+      fileExtension: '.yml',
+      isAppend: true
+    }
+  }
+}
+
+module.exports = data;

package/src/reStructure/TemplateData/relationshipPerAction/get/action/functionYaml/sqs/template.ejs

@@ -0,0 +1,17 @@
+<%_ const join = require('path').join; _%>
+<%- firstLetterUpperCase(functionNameConfig) %>:
+  handler: <%- join(resourceLocation, `${firstLetterUpperCase(functionName)}_${firstLetterUpperCase(handlerType)}.main`)%>
+  name: ${self:custom.iz_resourcePrefix}<%- firstLetterUpperCase(functionName) %><%- firstLetterUpperCase(handlerType) %>
+  events:
+    - sqs:
+        arn: arn:aws:sqs:${self:custom.iz_region}:${self:custom.iz_accountId}:${self:custom.iz_resourcePrefix}<%- firstLetterUpperCase(functionName) %><%- firstLetterUpperCase(handlerType) %>
+        batchSize: 10
+  role: <%- roleName %>Role
+    #<#<%- functionName %><%- handlerType %>IamRole#>
+    #<#/<%- functionName %><%- handlerType %>IamRole#>
+<%_ function firstLetterUpperCase(text){
+  return text.charAt(0).toUpperCase() + text.slice(1)
+} _%>
+<%_ function firstLetterLowerCase(str) {
+  return str.charAt(0).toLowerCase() + str.slice(1)
+} _%>

package/src/reStructure/TemplateData/relationshipPerAction/get/action/handler/api/data.js

@@ -0,0 +1,57 @@
+/*
+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 { ACTIONS, HANDLER } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../../MainLibs/index.js").utils;
+const { SOURCE_PATH, FUNCTION_NAME } = require("../../../../../../../MainLibs/index.js").consts;
+
+const templatePath = path.join(__dirname, "./template.ejs")
+
+/**
+ * receive objectSchema
+ * create data for hdrInv template
+ *
+ * @return {{ templatePath, templateData, setting } }
+ */
+function data(_izContext, srcPath) {
+  const createSourceParams = createParamForCreateSource(srcPath)
+  return [createSourceParams];
+}
+
+
+function createParamForCreateSource(srcPath) {
+  let functionName = FUNCTION_NAME.getRel;
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: upperCase(functionName) + "_" + upperCase(HANDLER.hdrApi),
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+
+module.exports = data;

package/src/reStructure/TemplateData/relationshipPerAction/get/action/handler/api/template.ejs

@@ -0,0 +1,138 @@
+/*
+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-core-library-calling-flow');
+const {
+  validateSchemaMiddleware
+} = require('@izara_project/izara-market-library-service-schemas/src/GenerateCodeLibs/src/GenerateCodeLibs');
+
+const <%- functionName %> = require('./<%- firstLetterUpperCase(functionName) %>_Main');
+// validate event params in middleware before into function
+let validatorSchema =  {
+  type: "object",
+  required: ["firstObject", "secondObject", "relType", 'relId'],
+  properties: {
+    firstObject: {
+      type: "object",
+      required: ["objType", "identifiers"],
+      properties: {
+        objType: {
+          type: "object",
+          required: ["serviceTag", "objectType"],
+          properties: {
+            serviceTag: izara.validatorSchema.stringNotEmpty(),
+            objectType: izara.validatorSchema.stringNotEmpty()
+          }
+        },
+        identifiers: {
+          type: "object",
+          minProperties: 1
+        }
+      }
+    },
+    secondObject: {
+      type: "object",
+      required: ["objType", "identifiers"],
+      properties: {
+        objType: {
+          type: "object",
+          required: ["serviceTag", "objectType"],
+          properties: {
+            serviceTag: izara.validatorSchema.stringNotEmpty(),
+            objectType: izara.validatorSchema.stringNotEmpty()
+          }
+        },
+        identifiers: {
+          type: "object",
+          minProperties: 1
+        }
+      }
+    },
+    relType: {
+      type: "object",
+      required: ["relationshipTag", "serviceTag"],
+      properties: {
+        relationshipTag: izara.validatorSchema.stringNotEmpty(),
+        serviceTag: {
+          type: 'string',
+          pattern: "^[a-zA-Z0-9_-]+$",
+          enum: [process.env.iz_serviceTag]
+        },
+      }
+    },
+    relationshipDirection: {
+      type: "string",
+      default: ""
+    },
+    relId: {
+      type: 'string',
+    },
+  }
+};
+
+
+
+//(<globalVarible>
+//</globalVarible>)
+
+// validate event params in middleware before into main function
+validatorSchema = callingFlowSharedLib.addOptionalCallingFlowToValidatorSchema(validatorSchema);
+middleware.setValidatorSchema(validatorSchema)
+// if need to validate authorizer or additional params , add code to hook tag below
+
+//(<afterValidateWith>)
+//(</afterValidateWith>)
+
+
+module.exports.main = middleware.wrap(async (event, context, callback) => {
+  event._izContext.logger.debug('Event:', event);
+  try {
+    // invoke LambdaFunction
+    let lambdaFunctionResponse = await <%- functionName %>.<%- functionName %>(
+      event._izContext,       // correlationId/logger/integrationTestDetail/uniqueRequestId/userId
+      {
+        firstObject: event.firstObject,
+        secondObject: event.secondObject,
+        relType: event.relType,
+        relId: event.relId,
+        relationshipDirection: event.relationshipDirection,
+      },
+      callingFlowSharedLib.addCallingFlowToPassOnProperties(event)
+    );
+
+    // return error to client
+    if (lambdaFunctionResponse instanceof Error) {
+      return (izara.response.failure(lambdaFunctionResponse));
+    }
+
+    // return success to client
+    return (izara.response.success(lambdaFunctionResponse));
+
+  } catch (err) {
+    event._izContext.logger.error('Error, <%- functionName %>HdrApi: ', err);
+    return (izara.response.failure(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/reStructure/TemplateData/relationshipPerAction/get/action/handler/dsq/data.js

@@ -0,0 +1,58 @@
+/*
+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 { ACTIONS, HANDLER } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../../MainLibs/index.js").utils;
+const { SOURCE_PATH, FUNCTION_NAME } = require("../../../../../../../MainLibs/index.js").consts;
+
+const templatePath = path.join(__dirname, "./template.ejs")
+
+/**
+ * create data for hdrInv template
+ *
+ * @return {{ templatePath, templateData, setting } }
+ */
+function data(_izContext, srcPath) {
+  const createSourceParams = createParamForCreateSource(srcPath)
+  return [createSourceParams];
+}
+
+
+function createParamForCreateSource(srcPath) {
+  let functionName = FUNCTION_NAME.getRel
+  let queueName = functionName + upperCase(HANDLER.hdrDsq)
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      queueName,
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: upperCase(functionName) + "_" + upperCase(HANDLER.hdrDsq),
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+
+module.exports = data;

package/src/reStructure/TemplateData/relationshipPerAction/get/action/handler/dsq/template.ejs

@@ -0,0 +1,183 @@
+/*
+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-core-library-calling-flow');
+
+// const CorrelationIds = require('@izara_project/izara-core-library-correlation-ids')
+// const IntegrationTestDetail = require('@izara_project/izara-core-library-integration-tests')
+const Logger = require('@izara_project/izara-core-library-logger');
+const recordHandlerSharedLib = require('@izara_project/izara-core-library-record-handler');
+
+
+const <%- functionName %> = require('./<%- firstLetterUpperCase(functionName) %>_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'
+      }
+    }
+  }
+));
+
+// validate event params in middlewware before into function.
+let validatorSchema = {
+  type: "object",
+  required: ["firstObject", "secondObject", "relType", 'relId'],
+  properties: {
+    firstObject: {
+      type: "object",
+      required: ["objType", "identifiers"],
+      properties: {
+        objType: {
+          type: "object",
+          required: ["serviceTag", "objectType"],
+          properties: {
+            serviceTag: izara.validatorSchema.stringNotEmpty(),
+            objectType: izara.validatorSchema.stringNotEmpty()
+          }
+        },
+        identifiers: {
+          type: "object",
+          minProperties: 1
+        }
+      }
+    },
+    secondObject: {
+      type: "object",
+      required: ["objType", "identifiers"],
+      properties: {
+        objType: {
+          type: "object",
+          required: ["serviceTag", "objectType"],
+          properties: {
+            serviceTag: izara.validatorSchema.stringNotEmpty(),
+            objectType: izara.validatorSchema.stringNotEmpty()
+          }
+        },
+        identifiers: {
+          type: "object",
+          minProperties: 1
+        }
+      }
+    },
+    relType: {
+      type: "object",
+      required: ["relationshipTag", "serviceTag"],
+      properties: {
+        relationshipTag: izara.validatorSchema.stringNotEmpty(),
+        serviceTag: {
+          type: 'string',
+          pattern: "^[a-zA-Z0-9_-]+$",
+          enum: [process.env.iz_serviceTag]
+        },
+      }
+    },
+    relationshipDirection: {
+      type: "string",
+      default: ""
+    },
+    relId: {
+      type: 'string',
+    },
+  }
+};
+
+
+//(<globalVarible>
+  //</globalVarible>)
+
+  // validate event params in middleware before into main function
+  validatorSchema = callingFlowSharedLib.addOptionalCallingFlowToValidatorSchema(validatorSchema);
+  // if need to validate authorizer or additional params , add code to hook tag below
+
+  //(<afterValidateWith>)
+  //(</afterValidateWith>)
+
+
+  module.exports.main = middleware.wrap(async (event, context, callback) => {
+    Logger.debug('event:', event);
+    Logger.debug('context:', context);
+    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
+          "<%- 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)
+        passOnProperties.push(callingFlowSharedLib.addCallingFlowToPassOnProperties(record.body.Message));
+        //(<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.
+          "<%- 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, updateRelationshipHdrDsq:', 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/reStructure/TemplateData/relationshipPerAction/get/action/handler/inv/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 { ACTIONS, HANDLER } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../../MainLibs/index.js").utils;
+const { SOURCE_PATH, FUNCTION_NAME } = require("../../../../../../../MainLibs/index.js").consts;
+
+const templatePath = path.join(__dirname, "./template.ejs")
+
+/**
+ * receive objectSchema
+ * create data for hdrInv template
+ *
+ * @return {{ templatePath, templateData, setting } }
+ */
+function data(_izContext, srcPath) {
+  const createSourceParams = createParamForCreateSource(srcPath)
+  return [createSourceParams];
+}
+
+
+function createParamForCreateSource(srcPath) {
+  let functionName = FUNCTION_NAME.getRel;
+  let handler = HANDLER.hdrInv
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      handler,
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: upperCase(functionName) + "_" + upperCase(handler),
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+
+module.exports = data;