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

package/src/reStructure/TemplateData/flowSchema/components/upload/confirmReserved/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('../../../../../../../MainLibs/src/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/reStructure/TemplateData/flowSchema/components/upload/confirmReserved/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/reStructure/TemplateData/flowSchema/components/upload/confirmReserved/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('../../../../../../../MainLibs/src/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/reStructure/TemplateData/flowSchema/components/upload/confirmReserved/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)
+} _%>

package/src/reStructure/TemplateData/flowSchema/components/upload/createObject/functionYaml/data.js

@@ -0,0 +1,140 @@
+/*
+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 { FLOW_SCHEMA_HOOK_STATE } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+const { firstLetterUpperCase: upperCase } = require('../../../../../../../MainLibs/src/Utils')
+const {
+  SOURCE_PATH,
+  defaultIamRolePerAction,
+  createIamRole,
+  RESOURCE_CLASSES,
+  SNS_RESOURCE,
+  resourceNames,
+  DYNAMO_RESOURCE,
+  SAVE_FILE_NAME,
+  FUNCTION_NAME,
+  shortNameHandler,
+  externalResourceYaml
+} = require('../../../../../../../MainLibs/src/Consts');
+
+const templatePath = path.join(__dirname, "template.ejs");
+const hookTemplate = path.join(__dirname, "./hookTemplate.ejs");
+/**
+ * receive objectSchema
+ * create data for WebScoket handler template
+ *
+ * @param {Object} objectSchema
+ * @return {{templatePath, templateData,setting}}
+ */
+
+function data(_izContext, flowSchema, srcPath) {
+  return [createSourceParams(_izContext, flowSchema, srcPath)]
+}
+
+function createSourceParams(_izContext, flowSchema, srcPath) {
+  let functionName = upperCase(FUNCTION_NAME.createObjectS3)
+  let handlerType = upperCase("hdrWbs")
+  let additionalResourcePermission = defaultIamRolePerAction();
+  let route = "webSocket"
+
+  additionalResourcePermission.push(
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.sns]: [
+          SNS_RESOURCE.publish
+        ]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.sns, "InImportBatchMainCreate")
+      ]
+    ),
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.dynamoDbTable]: [
+          DYNAMO_RESOURCE.putItem,
+          DYNAMO_RESOURCE.getItem,
+          DYNAMO_RESOURCE.query,
+          DYNAMO_RESOURCE.deleteItem,
+          DYNAMO_RESOURCE.updateItem
+        ]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.dynamoDbTable, "WebSocketTask")
+      ]
+    ),
+    createIamRole(
+      {
+        "execute-api": [
+          "ManageConnections"
+        ]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.webSocket)
+      ]
+    )
+  )
+
+  if (flowSchema?.hook) {
+    for (const [hookName, hookProperties] of Object.entries(flowSchema.hook)) {
+      if (hookName === FLOW_SCHEMA_HOOK_STATE.beforeCreate) {
+        for (const hookFunction of hookProperties.functionList) {
+          if ((hookFunction.event.hasOwnProperty("initialEvent") && (hookFunction.event.initialEvent === true))) {
+            if (hookFunction?.permission) {
+              for (const permission of hookFunction.permission) {
+                additionalResourcePermission.push(
+                  createIamRole(
+                    permission.action,
+                    permission.resource.map(resource =>
+                      externalResourceYaml(
+                        resource.resource,
+                        resource.resourceName,
+                        resource.serviceTag),
+                      permission.effect
+                    )
+                  )
+                )
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+  // console.log("additionalResourcePermission in createObjectS3", JSON.stringify(additionalResourcePermission))
+  return {
+    templatePath: templatePath,
+    templateData: {
+      resourceLocation: SOURCE_PATH.resourceLocationWebSocket,
+      functionName,
+      handlerType,
+      additionalResourcePermission,
+      route,
+      functionNameConfig: upperCase(functionName) + upperCase(shortNameHandler(handlerType))
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
+      saveFileName: upperCase(SAVE_FILE_NAME.flowSchema),
+      fileExtension: ".yml",
+      isAppend: true
+    }
+  }
+}
+
+module.exports = data;

package/src/reStructure/TemplateData/flowSchema/components/upload/createObject/functionYaml/template.ejs

@@ -0,0 +1,37 @@
+<%_ 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:
+    - websocket:
+        route: $connect
+    - websocket:
+        route: $disconnect
+    - websocket:
+        route: $default
+    - websocket:
+        route: <%- route %>
+        # authorizer: ${self:custom.iz_authorizerAppLevel}
+      # identifierResource: 'route.request.header.Auth'
+  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)
+} _%>
+<%_ function firstLetterLowerCase(str) {
+  return str.charAt(0).toLowerCase() + str.slice(1)
+} _%>

package/src/reStructure/TemplateData/flowSchema/components/upload/createObject/handler/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 { FLOW_SCHEMA_HOOK_STATE } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+const { SOURCE_PATH, FUNCTION_NAME } = require('../../../../../../../MainLibs/src/Consts');
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../../MainLibs/src/Utils")
+const templatePath = path.join(__dirname, "template.ejs")
+
+/**
+ * receive objectSchema
+ * create data for WebScoket handler template
+ *
+ * @param {Object} objectSchema
+ * @return {{templatePath, templateData,setting}}
+ */
+
+
+function data(_izContext, flowSchema, srcPath) {
+  return [createParamsForCreateSource(_izContext, flowSchema, srcPath)]
+}
+
+function createParamsForCreateSource(_izContext, flowSchema, srcPath) {
+  let functionName = upperCase(FUNCTION_NAME.createObjectS3)
+  let handlerType = "HdrWbs"
+  let hook = false;
+  let hookFunctionName;
+  let isAsync = false;
+  if (flowSchema?.hook) {
+    for (const [hookName, hookProperties] of Object.entries(flowSchema.hook)) {
+      for (const hookFunction of hookProperties.functionList) {
+        if (hookName === FLOW_SCHEMA_HOOK_STATE.beforeCreate) {
+          if (hookFunction.event?.initialEvent && hookFunction.event.initialEvent === true) {
+            hook = true
+            hookFunctionName = hookFunction.name
+            if (hookFunction.event?.isAsync && hookFunction.event.isAsync === true) {
+              isAsync = true
+            }
+          }
+        }
+      }
+    }
+  }
+  return {
+    templatePath: templatePath,
+    templateData: {
+      hook: hook,
+      hookFunctionName: hookFunctionName,
+      isAsync
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.webSocket),
+      saveFileName: `${functionName}_${handlerType}`,
+      fileExtension: ".js",
+      isAppend: false
+    }
+  }
+}
+module.exports = data

package/src/reStructure/TemplateData/flowSchema/components/upload/createObject/handler/template.ejs

@@ -0,0 +1,120 @@
+/*
+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 izara = require("@izara_project/izara-middleware");
+const middleware = izara.middlewareHandler;
+// const AWS = require('aws-sdk');
+// const api = new AWS.ApiGatewayManagementApi({ endpoint: process.env.iz_webSocketEndpoint });
+const izaraShared = require('@izara_project/izara-shared')
+const dynamodbSharedLib = izaraShared.dynamodbSharedLib
+const callingFlowSharedLib = izaraShared.callingFlowSharedLib;
+const hash = require('object-hash')
+// const coreConsts = require("@izara_project/izara-core-library-core/src/Consts");
+const consts = require('@izara_project/izara-middleware/src/MiddlewareCore/Consts')
+const { postToConnection } = require("../../libs/source/ImportDataLib");
+<% if (hook) { _%>
+const <%- upperCase(hookFunctionName) %> = require("./FlowSchemaHook/HookLogicFunction/source/<%- upperCase(hookFunctionName) %>")
+<% } else { _%>
+const createObject = require('./CreateObjectS3_Main');
+<% } _%>
+module.exports.main = middleware.wrap(async (event, context, callback) => {
+
+  event._izContext.logger.debug('Event:', event);
+
+  try {
+
+    if (event.requestContext) {
+      const route = event.requestContext.routeKey;
+      const connectionId = event.requestContext.connectionId;
+      let correlationId = event._izContext.correlationIds.get(consts.X_CORRELATION_ID)
+
+      switch (route) {
+        case "$connect":
+          console.log("webSocket Connect");
+          break
+        case "$disconnect":
+          console.log("webSocket Disconnect");
+          break
+        case '$default':
+          console.log('Received unknown route:', route);
+          break
+        case 'webSocket':
+          console.log("event in route webSocket", event);
+          let eventParams = JSON.parse(event.body)
+
+          await dynamodbSharedLib.putItem(
+            event._izContext,
+            await dynamodbSharedLib.tableName(event._izContext, "WebSocketTask"),
+            {
+              taskKey: correlationId,
+              connectionId: connectionId,
+            }
+          )
+
+          let callingFlow = eventParams?.callingFlow ? eventParams.callingFlow : {};
+          <% if (hook) { _%>
+            <% if (isAsync) { %>
+              await <%- upperCase(hookFunctionName) %>(
+                event._izContext,
+                eventParams,
+                callingFlowSharedLib.addCallingFlowToPassOnProperties(callingFlow)
+                //(<additionalParams>)
+                  //(</additionalParams>)
+                  )
+                <% } else { %>
+              <%- upperCase(hookFunctionName) %>(
+                event._izContext,
+                eventParams,
+                callingFlowSharedLib.addCallingFlowToPassOnProperties(callingFlow)
+                //(<additionalParams>)
+                //(</additionalParams>)
+              )
+              <% } _%>
+          <% } else { _%>
+          await createObject.createObject(
+            event._izContext,
+            eventParams,
+            callingFlowSharedLib.addCallingFlowToPassOnProperties(callingFlow)
+            //(<additionalParams>)
+            //(</additionalParams>)
+          )
+          <% } _%>
+
+          break
+      }
+    } else {
+      const connId = event.connId;
+      // await postMessage({ message: event.message }, connId);
+      await postToConnection({ message: event.message }, connId);
+    }
+
+    return (izara.response.webSocketSuccess());
+
+  } catch (err) {
+    const connId = event.requestContext.connectionId
+    event._izContext.logger.error('Error, WebSocket: ', err);
+    // await sendErrorMessage({ message: err.message }, connId);
+    await postToConnection({ message: err.message }, connId);
+    return (izara.response.failure(err));
+  }
+});
+<%_ const join = require('path').join _%>
+<%_ function upperCase (text) {
+  return text.charAt(0).toUpperCase() + text.slice(1)
+  } _%>