@izara_project/izara-market-library-service-schemas 1.0.18 → 1.0.20

package/src/TemplateManager/src/flowSchema/UploadS3Case/confirmReservedAfterUpload/functionYaml/data.js

@@ -0,0 +1,102 @@
+/*
+Copyright (C) 2021 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 templatePath = path.join(__dirname, "./template.ejs")
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../MainLibs/src/Utils")
+const { HANDLER, defaultIamRolePerAction, createIamRole, RESOURCE_CLASSES, SQS_RESOURCE, SNS_RESOURCE, resourceNames, shortNameHandler, SOURCE_PATH, SAVE_FILE_NAME, awaitingMultipleStepsRole, externalResourceSns, externalResourceName, DYNAMO_RESOURCE, LAMBDA_RESOURCE } = require('../../../../libs/Consts');
+
+/**
+ * receive objectSchema
+ *
+ * @param {Object} flowSchema
+ * @return {{ templatePath, templateData, setting } }
+ */
+
+function data(_izContext, srcPath) {
+  return [createSourceParams(_izContext, srcPath)]
+}
+
+function createSourceParams(_izContext, srcPath) {
+  let functionName = "ConfirmNewReserved";
+  let handlerType = upperCase(HANDLER.hdrSqs);
+  let additionalResourcePermission = defaultIamRolePerAction();
+
+  additionalResourcePermission.push(
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.sqs]: [
+          SQS_RESOURCE.receiveMessage,
+          SQS_RESOURCE.sendMessage,
+          SQS_RESOURCE.deleteMessage,
+          SQS_RESOURCE.getQueueAttributes
+        ]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.sqs, functionName + handlerType),
+        resourceNames(RESOURCE_CLASSES.sqs, functionName + "DLQ"),
+      ]
+    ),
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.dynamoDbTable]: [
+          DYNAMO_RESOURCE.query,
+          DYNAMO_RESOURCE.deleteItem,
+          DYNAMO_RESOURCE.updateItem,
+          DYNAMO_RESOURCE.putItem
+        ]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.dynamoDbTable, "ReservedDataMain"),
+      ]
+    ),
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.lambda]: [LAMBDA_RESOURCE.invokeFunction],
+        [RESOURCE_CLASSES.sns]: [SNS_RESOURCE.publish]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.lambda, "ImportBatchMainGetHdrInv"),
+        resourceNames(RESOURCE_CLASSES.sns, "InImportBatchMainUpdate")
+      ]
+    )
+  )
+
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      handlerType,
+      functionNameConfig: functionName + upperCase(handlerType),
+      resourceLocation: SOURCE_PATH.resourceLocationWebSocket,
+      additionalResourcePermission,
+      functionNameConfig: upperCase(functionName) + upperCase(shortNameHandler(handlerType)),
+    },
+    setting: {
+      saveFileName: upperCase(SAVE_FILE_NAME.flowSchema),
+      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
+      fileExtension: ".yml",
+      isAppend: true
+    }
+  }
+}
+
+module.exports = data

package/src/TemplateManager/src/flowSchema/UploadS3Case/confirmReservedAfterUpload/functionYaml/template.ejs

@@ -0,0 +1,30 @@
+<%_ const join = require('path').join; _%>
+<%- firstLetterUpperCase(functionNameConfig) %>:
+  handler: <%- join(resourceLocation, `${functionName}_${firstLetterUpperCase(handlerType)}.main`)%>
+  name: ${self:custom.iz_resourcePrefix}<%- functionName %><%- firstLetterUpperCase(handlerType) %>
+  events:
+    - sqs:
+        arn: arn:aws:sqs:${self:custom.iz_region}:${self:custom.iz_accountId}:${self:custom.iz_resourcePrefix}<%- functionName %><%- firstLetterUpperCase(handlerType) %>
+        batchSize: 10
+        filterPatterns: #**** need to update serverless framwork upper v.2.69.1
+        - body: {"MessageAttributes":{"callingFlow":{"Value":["${self:custom.iz_resourcePrefix}<%- firstLetterUpperCase(functionName) %><%- firstLetterUpperCase(handlerType) %>"]}}} # functionName of callingFlow
+        - body: {"MessageAttributes":{"callingFlow":{"Value":[{"exists":false}]}}}
+  iamRoleStatements:
+    <%_ additionalResourcePermission.forEach(resourcePermission => { _%>
+    - Effect: <%- resourcePermission.effect %>
+      Action:
+        <%_ Object.keys(resourcePermission.action).forEach(resourcePerAction => { _%>
+        <%_ resourcePermission.action[resourcePerAction].forEach(permission => { _%>
+        - <%- resourcePerAction %>:<%- permission %>
+        <%_ }) _%>
+        <%_ }) _%>
+      Resource:
+        <%_ resourcePermission.resource.forEach(resource => { _%>
+        - "<%- resource %>"
+        <%_ }) _%>
+    <%_}) _%>
+    #<#<%- functionName %><%- handlerType %>IamRole#>
+    #<#/<%- functionName %><%- handlerType %>IamRole#>
+<%_ function firstLetterUpperCase(text){
+  return text.charAt(0).toUpperCase() + text.slice(1)
+} _%>

package/src/TemplateManager/src/flowSchema/UploadS3Case/confirmReservedAfterUpload/handler/data.js

@@ -0,0 +1,58 @@
+/*
+Copyright (C) 2021 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 templatePath = path.join(__dirname, "./template.ejs")
+const { firstLetterUpperCase: upperCase } = require("../../../../../../MainLibs/src/Utils")
+const { HANDLER, SOURCE_PATH } = require('../../../../libs/Consts');
+
+/**
+ * receive objectSchema
+ *
+ * @param {Object} flowSchema
+ * @return {{ templatePath, templateData, setting } }
+ */
+
+function data(_izContext, srcPath) {
+  return [createSourceParams(_izContext, srcPath)]
+}
+
+function createSourceParams(_izContext, srcPath) {
+  let functionName = "ConfirmNewReserved";
+  let handlerType = upperCase(HANDLER.hdrSqs);
+
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      handlerType,
+    },
+    setting: {
+      saveFileName: `${functionName}_${handlerType}`,
+      savePath: path.join(srcPath, SOURCE_PATH.webSocket),
+      fileExtension: ".js",
+      isAppend: true
+    }
+  }
+}
+
+module.exports = data

package/src/TemplateManager/src/flowSchema/UploadS3Case/confirmReservedAfterUpload/handler/template.ejs

@@ -0,0 +1,126 @@
+/*
+Copyright (C) 2021 Sven Mason <http://izara.io>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+'use strict';
+
+// const AWS = require('aws-sdk');
+// const sqs = new AWS.SQS({ apiVersion: '2012-11-05' });
+
+const izara = require("@izara_project/izara-middleware");
+const middleware = izara.middlewareHandler;
+const recordHandlerSharedLib = require("@izara_project/izara-shared").recordHandlerSharedLib;
+const Logger = require('@izara_project/izara-core-library-logger');
+const izaraShared = require('@izara_project/izara-shared');
+const callingFlowSharedLib = izaraShared.callingFlowSharedLib;
+
+const confirmNewReserved = require('./ConfirmNewReserved_Main')
+
+// validate event properties in body.Message of sqs event
+middleware.setValidatorSchema(recordHandlerSharedLib.baseValidatorSchema());
+
+// set schema for record.body.Message
+let perRecordsValidatorSchema = {
+  type: "object",
+  required: [
+    'returnMessage',
+    'errorsFound',
+    'passStatus'
+  ],
+  properties: {
+    returnMessage: {
+      type: "object"
+    },
+    errorsFound: {
+      type: "array"
+    },
+    passStatus: {
+      type: 'boolean'
+    }
+  }
+};
+
+// set schema for record.body.MessageAttributes
+// const messageAttributeValidatorSchema = {
+//   type: "object",
+//   required: ['msgAtrrParam1', 'msgAtrrParam2'],
+//   properties: {
+//     msgAtrrParam1: {
+//       type: "string"
+//     },
+//     msgAtrrParam2: {
+//       type: "object"
+//     }
+//   }
+// };
+
+perRecordsValidatorSchema = callingFlowSharedLib.addOptionalPassBackPropertiesToValidatorSchema(perRecordsValidatorSchema)
+
+module.exports.main = middleware.wrap(async (event, context, callback) => {
+
+  try {
+
+    let recordPromises = [];
+
+    // loop each record and send to mainFunction
+    await Promise.all(event.Records.map(async record => { // promise.all for map() function
+
+      let passOnProperties = []
+      record._izContext.logger.debug('record ReceiveMsgOutHdrSqs', record);
+
+      // validate message (and MessageAttributes)
+      await recordHandlerSharedLib.validateRecord(
+        record,                             // one record will send to mainFunction
+        "ConfirmNewReservedHdrSqs",         // 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.returnMessage)
+      passOnProperties.push(record.body.Message.errorsFound)
+      passOnProperties.push(record.body.Message.passStatus)
+      passOnProperties.push(callingFlowSharedLib.addPassBackPropertiesToPassOnProperties(record.body.Message))
+      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
+        confirmNewReserved.confirmNewReserved,  // mainFunction that need to invoke.
+        "ConfirmNewReservedHdrSqs",             // 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 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, ConfirmNewReservedHdrSqs: ', err);
+    throw (err);
+  }
+});

package/src/TemplateManager/src/flowSchema/UploadS3Case/confirmReservedAfterUpload/mainFunction/data.js

@@ -0,0 +1,51 @@
+/*
+Copyright (C) 2021 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 templatePath = path.join(__dirname, "./template.ejs")
+
+const { SOURCE_PATH } = require("../../../../libs/Consts");
+
+/**
+ * receive objectSchema
+ *
+ * @param {Object} flowSchema
+ * @return {{ templatePath, templateData, setting } }
+ */
+
+function data(_izContext, flowSchema, srcPath) {
+  return [createSourceParams(_izContext, flowSchema, srcPath)]
+}
+
+function createSourceParams(_izContext, srcPath) {
+  let functionName = "ConfirmNewReserved"
+  return {
+    templatePath: templatePath,
+    templateData: {},
+    setting: {
+      saveFileName: `${functionName}_Main`,
+      savePath: path.join(srcPath, SOURCE_PATH.webSocket),
+      fileExtension: ".js",
+      isAppend: false
+    }
+  }
+}
+
+module.exports = data

package/src/TemplateManager/src/flowSchema/UploadS3Case/confirmReservedAfterUpload/mainFunction/template.ejs

@@ -0,0 +1,121 @@
+/*
+Copyright (C) 2021 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 izaraShared = require('@izara_project/izara-shared');
+const dynamodbSharedLib = izaraShared.dynamodbSharedLib;
+const snsSharedLib = izaraShared.snsSharedLib;
+const sns = require('@izara_project/izara-core-library-external-request').sns
+const consts = require('@izara_project/izara-market-library-service-schemas/src/GenerateCodeLibs/src/Consts')
+const { getNestObject } = require('../../libs/source/ImportDataLib')
+/**
+ * description of function.
+ * @param {Object} _izContext
+ * @param {CorrelationIds} _izContext.correlationIds - property of _izContext
+ * @param {Logger} _izContext.logger - property of _izContext
+ * @param {Logger} _izContext.logger - property of _izContext
+ * @param {Object} returnMessage - limitValue or limitFound
+ * @param {Array} errorsFound - array
+ * @param {boolean} passStatus - true || false
+ * @param {Object} passBackProperties - identifier
+
+ *
+ * @returns {object} returnResponse
+ */
+
+module.exports.confirmNewReserved = async (
+  _izContext,
+  returnMessage,
+  errorsFound,
+  passStatus,
+  passBackProperties
+
+) => {
+  try {
+    _izContext.logger.debug('----- confirmNewReserved event params', {
+      _izContext: _izContext,
+      returnMessage: returnMessage,
+      errorsFound: errorsFound,
+      passStatus: passStatus,
+      passBackProperties: passBackProperties
+    })
+
+    let servicePendingId = passBackProperties.passBackProperties.identifier.servicePendingId;
+    let reservedDataId = passBackProperties.passBackProperties.identifier.reservedDataId;
+    let userId = passBackProperties.passBackProperties.identifier.userId;
+    let realFileSize = passBackProperties.passBackProperties.identifier.realFileSize;
+
+    let uniqueIdentify = getNestObject(
+      _izContext,
+      returnMessage.limitFound,
+      ["runningTotal", "uniqueIdentify", "usedTimestampId"]
+    );
+
+    // confirmUsage
+    let confirmUsageMessage = {
+      userId: userId,
+      limitTag: consts.LIMIT_TAG.uploadData,
+      uniqueIdentify: uniqueIdentify,
+    }
+
+    let sendMessageToConfirmUsage = {
+      Message: JSON.stringify(confirmUsageMessage),
+      TopicArn: await snsSharedLib.snsTopicArn(_izContext, 'InConfirmUsage', consts.EXTERNAL_SERVICE_NAME.accountLimits)
+    };
+    _izContext.logger.debug("sendMessageToConfirmUsage", sendMessageToConfirmUsage);
+    await sns.publishAsync(_izContext, sendMessageToConfirmUsage);
+
+    // update reservedDataValue as real size in ReservedDataMain table
+    await dynamodbSharedLib.updateItem(
+      _izContext,
+      await dynamodbSharedLib.tableName(_izContext, 'ReservedDataMain'),
+      {
+        servicePendingId: servicePendingId,
+        reservedDataId: reservedDataId
+      },
+      {
+        reservedValue: realFileSize
+      }
+    )
+
+    // update importBatchMainTable
+    let sendMessageToUpdateImportBatchStatus = {
+      objInstanceFull: {
+        identifiers: {
+          importBatchId: servicePendingId
+        },
+        fields: {
+          importBatchStatus: 'uploadComplete'
+        }
+      }
+    }
+
+    let sendMessageToUpdateImportBatch = {
+      Message: JSON.stringify(sendMessageToUpdateImportBatchStatus),
+      TopicArn: await snsSharedLib.snsTopicArn(_izContext, `InImportBatchMainUpdate`)
+    };
+    _izContext.logger.debug("sendMessageToUpdateImportBatch", sendMessageToUpdateImportBatch);
+    await sns.publishAsync(_izContext, sendMessageToUpdateImportBatch);
+
+    return { returnResponse: 'success' }
+
+  } catch (err) {
+    _izContext.logger.debug('error ConfirmNewReservedMain: ', err)
+    throw (err)
+  }
+}

package/src/TemplateManager/src/flowSchema/UploadS3Case/confirmReservedAfterUpload/queue/data.js

@@ -0,0 +1,64 @@
+/*
+Copyright (C) 2020 Sven Mason <http://izara.io>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+'use strict';
+
+const path = require("path")
+
+const { SOURCE_PATH, SAVE_FILE_NAME } = require('../../../../libs/Consts');
+const { TOPIC_NAME_GENERATE_CODE } = require("../../../../../../GenerateCodeLibs/src/Consts");
+
+const templatePath = path.join(__dirname, './template.ejs');
+
+
+/**
+ * create data for dynamoDbYaml tempalte from objectSchema
+ * return array of dynamoDb data
+ * because one objectSchema can create multiple dynamoDb table
+ *
+ * @param {Object} _izContext
+ * @param {Object} objectSchema
+ * @returns {Object[]}              - data of multiple dynamoDb template
+ */
+
+function data(_izContext, srcPath) {
+  let resultForCreateSqs = [];
+  const WebSocketSqsQueueNames = [];
+  const setting = {
+    initialData: "Resources:\n",
+    savePath: path.join(srcPath, SOURCE_PATH.resourceYaml),
+    saveFileName: SAVE_FILE_NAME.snsInSqsYaml,
+    fileExtension: ".yml",
+    isAppend: true
+  }
+
+  WebSocketSqsQueueNames.push(
+    {
+      queueName: "ConfirmNewReserved"
+    }
+  )
+
+  for (let WebSocketSqsQueueName of WebSocketSqsQueueNames) {
+    resultForCreateSqs.push(({
+      templatePath: templatePath,
+      templateData: WebSocketSqsQueueName,
+      setting: setting
+    }))
+  }
+  return resultForCreateSqs
+}
+module.exports = data;

package/src/TemplateManager/src/flowSchema/UploadS3Case/confirmReservedAfterUpload/queue/template.ejs

@@ -0,0 +1,45 @@
+##===== [Queue]
+  <%- queueName %>HdrSqs:
+    Type: "AWS::SQS::Queue"
+    Properties:
+      QueueName: ${self:custom.iz_resourcePrefix}<%- queueName %>HdrSqs
+      RedrivePolicy:
+        deadLetterTargetArn:
+        # !GetAtt
+          Fn::GetAtt:
+            - <%- queueName %>HdrSqsDLQ
+            - Arn
+        maxReceiveCount: 3
+      VisibilityTimeout: 120
+##==== [QueueDLQ]
+  <%- queueName %>HdrSqsDLQ:
+    Type: AWS::SQS::Queue
+    Properties:
+      QueueName: ${self:custom.iz_resourcePrefix}<%- queueName %>HdrSqsDLQ
+##==== [QueuePolicy]
+  <%- queueName %>HdrSqsPolicy:
+    Type: AWS::SQS::QueuePolicy
+    Properties:
+      PolicyDocument:
+        Version: "2012-10-17"
+        Statement:
+          - Sid: "allow-sns-messages"
+            Effect: Allow
+            Principal: "*"
+            Resource:
+            # !GetAtt
+              Fn::GetAtt:
+                - <%- queueName %>HdrSqs
+                - Arn
+            Action: "SQS:SendMessage"
+      Queues:
+        - Ref: <%- queueName %>HdrSqs
+  #<#<%- firstLetterUpperCase(queueName) %>QueueSetting#>
+  #<#/<%- firstLetterUpperCase(queueName) %>QueueSetting#>
+
+<%_ function firstLetterUpperCase(text){
+  return text.charAt(0).toUpperCase() + text.slice(1)
+} _%>
+<%_ function firstLetterLowerCase(str) {
+  return str.charAt(0).toLowerCase() + str.slice(1)
+} _%>