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

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

@@ -0,0 +1,184 @@
+/*
+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 CorrelationIds = require('@izara_project/izara-core-library-correlation-ids')
+// const Logger = require('@izara_project/izara-core-library-logger');
+// const IntegrationTestDetail = require('@izara_project/izara-core-library-integration-tests')
+const recordHandlerSharedLib = require('@izara_project/izara-shared').recordHandlerSharedLib
+const Logger = require("@izara_project/izara-core-library-logger/src/Logger");
+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 middleware before into function
+let validatorSchema = {
+  type: "object",
+  required: ["firstObject","secondObject", "relType", "relationshipProperties","relationshipDirection","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]
+        }
+      }
+    },
+    relId: izara.validatorSchema.stringNotEmpty(),
+    relationshipProperties: {
+      type: "object",
+      minProperties: 1
+    },
+    relationshipDirection: {
+      type: "string",
+      enum: ['from','to']
+    }
+  }
+};
+
+
+//(<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/update/action/handler/inv/data.js

@@ -0,0 +1,77 @@
+/*
+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("../../../#utils");
+// const { DEFAULT_HANDLER_PER_ACTION, createIamRole, resourceNames, RESOURCE_CLASSES, DEFAULT_LAMBDA_ROLE_PER_ACTION, SQS_RESOURCE, SOURCE_PATH, SAVE_FILE_NAME, FUNCTION_NAME, SNS_RESOURCE, DYNAMO_RESOURCE, defaultIamRolePerAction, awaitingMultipleStepsRole } = require("../../../#const");
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../../MainLibs/index.js").utils;
+const {
+  DEFAULT_HANDLER_PER_ACTION,
+  createIamRole,
+  resourceNames,
+  RESOURCE_CLASSES,
+  DEFAULT_LAMBDA_ROLE_PER_ACTION,
+  SQS_RESOURCE,
+  SOURCE_PATH,
+  SAVE_FILE_NAME,
+  FUNCTION_NAME,
+  SNS_RESOURCE,
+  DYNAMO_RESOURCE,
+  defaultIamRolePerAction,
+  awaitingMultipleStepsRole
+} = 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)
+  // console.log("createSourceArrayInUpdateRelationshipHdrInv", createSourceArray)
+  return [createSourceParams];
+}
+
+
+function createParamForCreateSource(srcPath) {
+  const functionName = FUNCTION_NAME.updateRel;
+  const handler = HANDLER.hdrInv
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      queueName: upperCase(functionName) + upperCase(handler),
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: `${upperCase(functionName)}_${upperCase(handler)}`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+
+
+module.exports = data;

package/src/reStructure/TemplateData/relationshipPerAction/update/action/handler/inv/request.json

@@ -0,0 +1,5 @@
+{
+  "objectType": "objectType",
+  "mainFunction": "xxx",
+  "mainFunctionFile": "directoryOfMainFunction"
+}

package/src/reStructure/TemplateData/relationshipPerAction/update/action/handler/inv/template.ejs

@@ -0,0 +1,145 @@
+/*
+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 CorrelationIds = require('@izara_project/izara-core-library-correlation-ids')
+// const Logger = require('@izara_project/izara-core-library-logger');
+// const IntegrationTestDetail = require('@izara_project/izara-core-library-integration-tests')
+
+const <%- functionName %> = require('./<%- firstLetterUpperCase(functionName) %>_Main');
+
+// validate event params in middlewware before into function.
+let validatorSchema = {
+  type: "object",
+  required: ["firstObject","secondObject", "relType", "relationshipProperties","relationshipDirection","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]
+        }
+      }
+    },
+    relId: izara.validatorSchema.stringNotEmpty(),
+    relationshipProperties: {
+      type: "object",
+      minProperties: 1
+    },
+    relationshipDirection: {
+      type: "string",
+      enum: ['from','to']
+    }
+  }
+};
+
+//(<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);
+  event._izContext.logger.debug('context:',context);
+
+  try {
+    // invoke LambdaFunction
+    let lambdaFunctionResponse = await <%- functionName %>.<%- functionName %>(
+      event._izContext,       // correlationId/logger/integrationTestDetail/uniqueRequestId/userId
+      {
+        firstObject: event.firstObject,
+        secondObject: event.secondObject,
+        relType: event.relType,
+        relationshipDirection: event.relationshipDirection,
+        relationshipProperties: event.relationshipProperties,
+        relId: event.relId
+      },
+      callingFlowSharedLib.addCallingFlowToPassOnProperties(event)
+    //(<afterPutParamIntoMainFunction>)
+    //(</afterPutParamIntoMainFunction>)
+    );
+
+    // 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, <%- firstLetterUpperCase(functionName) %>HdrInv: ', 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/update/action/handler/sqs/data.js

@@ -0,0 +1,74 @@
+/*
+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("../../../#utils");
+// const { DEFAULT_HANDLER_PER_ACTION, createIamRole, resourceNames, RESOURCE_CLASSES, DEFAULT_LAMBDA_ROLE_PER_ACTION, SQS_RESOURCE, SOURCE_PATH, SAVE_FILE_NAME, FUNCTION_NAME, SNS_RESOURCE, DYNAMO_RESOURCE, defaultIamRolePerAction, awaitingMultipleStepsRole } = require("../../../#const");
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../../MainLibs/index.js").utils;
+const {
+  DEFAULT_HANDLER_PER_ACTION,
+  createIamRole,
+  resourceNames,
+  RESOURCE_CLASSES,
+  DEFAULT_LAMBDA_ROLE_PER_ACTION,
+  SQS_RESOURCE,
+  SOURCE_PATH,
+  SAVE_FILE_NAME,
+  FUNCTION_NAME,
+  SNS_RESOURCE,
+  DYNAMO_RESOURCE,
+  defaultIamRolePerAction,
+  awaitingMultipleStepsRole
+} = 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) {
+  const functionName = FUNCTION_NAME.updateRel;
+  const handler = HANDLER.hdrSqs
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      queueName: upperCase(functionName) + upperCase(handler),
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: `${upperCase(functionName)}_${upperCase(handler)}`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+module.exports = data;

package/src/reStructure/TemplateData/relationshipPerAction/update/action/handler/sqs/request.json

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

package/src/reStructure/TemplateData/relationshipPerAction/update/action/handler/sqs/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 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 into function
+let validatorSchema = {
+  type: "object",
+  required: ["firstObject","secondObject", "relType", "relationshipProperties","relationshipDirection","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]
+        }
+      }
+    },
+    relId: izara.validatorSchema.stringNotEmpty(),
+    relationshipProperties: {
+      type: "object",
+      minProperties: 1
+    },
+    relationshipDirection: {
+      type: "string",
+      enum: ['from','to']
+    }
+  }
+};
+
+//(<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) => {
+
+  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
+        "<%- 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)
+} _%>