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

package/src/reStructure/TemplateData/relationshipPerAction/delete/action/mainFunction/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, firstLetterUpperCase } = 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
+ *
+ * @param {Object} objectSchema
+ * @return {{ templatePath, templateData, setting } }
+ */
+function data(_izContext, srcPath) {
+  const createSourceParams = createParamForCreateSource(srcPath)
+  return [createSourceParams];
+}
+
+
+function createParamForCreateSource(srcPath) {
+  let functionName = FUNCTION_NAME.deleteRel
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: `${upperCase(FUNCTION_NAME.deleteRel)}_Main`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+
+module.exports = data;

package/src/reStructure/TemplateData/relationshipPerAction/delete/action/mainFunction/template.ejs

@@ -0,0 +1,337 @@
+/*
+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 hash = require("object-hash");
+
+const callingFlowSharedLib = require('@izara_project/izara-shared/src/CallingFlowSharedLib');
+const lambdaSharedLib = require('@izara_project/izara-shared/src/LambdaSharedLib');
+
+const snsSharedLib = require('@izara_project/izara-shared/src/SnsSharedLib');
+const sns = require("@izara_project/izara-core-library-external-request/src/resources/Sns");
+
+const asyncFlowSharedLib = require('@izara_project/izara-shared/src/AsyncFlowSharedLib');
+
+// const NoRetryError = require('@izara_project/izara-core-library-core/src/NoRetryError');
+
+const {
+  getRelationshipSchemaWithCache,
+  getObjSchemaS3WithHierarchy
+} = require('@izara_project/izara-core-library-service-schemas/src/GetObjectSchema');
+
+const {
+  createLinkTypeId
+} = require('@izara_project/izara-core-library-service-schemas/src/Utils');
+
+const {
+  getGraphServiceTagWithCache
+} = require('@izara_project/izara-core-library-service-schemas/src/ServiceConfig');
+
+const consts = require('@izara_project/izara-core-library-service-schemas/src/Consts');
+const {
+  PREFIX,
+  TOPIC_NAME_GENERATE_CODE,
+  TOPIC_NAME_GRAPH_HANDLER
+} = require('@izara_project/izara-market-library-service-schemas/src/GenerateCodeLibs/src/Consts')
+
+/**
+ * update relationship endpoint
+ *
+ * @param {Object} _izContext
+ * @param {CorrelationIds} _izContext.correlationIds - property of _izContext
+ * @param {Logger} _izContext.logger                 - property of _izContext
+ * @param {Object} requestParams                     - request params
+ * @param {Object} callingFlowConfig
+ *
+ * @returns {object} description of return value
+ */
+module.exports.deleteRelationship = async (
+  _izContext,
+  requestParams,
+  callingFlowConfig = {},
+  //(<additionalParams>)
+  //(</additionalParams>)
+) => {
+
+
+  try {
+    _izContext.logger.debug('deleteRelationship _izContext: ', _izContext);
+    _izContext.logger.debug('deleteRelationship requestParams: ', requestParams);
+    _izContext.logger.debug('deleteRelationship callingFlowConfig: ', callingFlowConfig);
+
+
+    const {
+      firstObject,
+      secondObject,
+      relType,
+      relationshipProperties,
+      relationshipDirection
+      //(<requestparamDeleteRel>)
+      //(</requestparamDeleteRel>)
+    } = requestParams;
+
+    let errorsFound = [];
+
+    //(<beforeValidateDeleteRel>)
+    //(</beforeValidateDeleteRel>)
+    // validate object and identifiers
+    async function validateIdentifiersExists(_izContext, objType, identifiersObject) {
+
+      const objTypeString = `objType:{ serviceTag:${objType.serviceTag}, objectType:${objType.objectType} }`;
+      const objectSchema = await getObjSchemaS3WithHierarchy(_izContext, objType);
+
+      if (!objectSchema) {
+        errorsFound.push(`validateIdentifiers, not found schema of ${objTypeString}`);
+      }
+
+      for (const schemaIdentifier of objectSchema.identifiers) {
+        let identifierNames = schemaIdentifier.fieldNames || [schemaIdentifier.fieldName];
+        for (const identifierName of identifierNames) {
+          if (!identifiersObject.hasOwnProperty(identifierName)) {
+            errorsFound.push(`validateIdentifiers, ${objTypeString} property:${identifierName} not exists`);
+          } else {
+            if (
+              typeof (identifiersObject[identifierName]) !== "string" &&
+              typeof (identifiersObject[identifierName]) !== "number"
+            ) {
+              errorsFound.push(`validateIdentifiers, ${objTypeString} property:${identifierName} should be string or number`);
+            }
+          }
+        }
+      }
+    }
+
+    await validateIdentifiersExists(_izContext, firstObject.objType, firstObject.identifiers);
+    await validateIdentifiersExists(_izContext, secondObject.objType, secondObject.identifiers);
+    // finished validate object and identifiers
+
+    //(<afterValidateDeleteRel>)
+    //(</afterValidateDeleteRel>)
+
+    //(<beforeDeleteRel>)
+    //(</beforeDeleteRel>)
+
+    const relationshipSchema = await getRelationshipSchemaWithCache(_izContext, relType);
+    _izContext.logger.debug("relationshipSchema: ", relationshipSchema);
+
+    let targetStorageResources = [];
+
+    if (relationshipSchema) {
+      // find targetStorageResources and validate each storageResources
+      await Promise.all(
+        relationshipSchema.links.map(async ({ from, to, storageResourceTags }) => {
+          const { serviceTag: fromServiceTag, objectType: fromObjectType } = from.objType
+          const { serviceTag: toServiceTag, objectType: toObjectType } = to.objType
+
+          const { serviceTag: firstServiceTag, objectType: firstObjectType } = firstObject.objType;
+          const { serviceTag: secondServiceTag, objectType: secondObjectType } = secondObject.objType;
+
+          // find exists link
+          if (
+            (
+              (firstServiceTag === fromServiceTag && firstObjectType === fromObjectType) &&
+              (secondServiceTag === toServiceTag && secondObjectType === toObjectType)
+            ) ||
+            (
+              (firstServiceTag === toServiceTag && firstObjectType === toObjectType) &&
+              (secondServiceTag === fromServiceTag && secondObjectType === fromObjectType)
+            )
+          ) {
+
+            // check founded storageResource of link and collect used storageResources
+            await Promise.all(storageResourceTags.map(async storageResourceTag => {
+              const usedStorageResource = relationshipSchema.storageResources[storageResourceTag];
+
+              if (usedStorageResource.storageType === consts.STORAGE_TYPES.graph) {
+                const graphServiceTag = await getGraphServiceTagWithCache(_izContext, usedStorageResource.graphServerTag);
+                if (!graphServiceTag) {
+                  errorsFound.push(`storageResourceTag:${storageResourceTag} invalid, not found graph serviceTag from graphServerTag:${usedStorageResource.graphServerTag}`)
+                }
+
+                targetStorageResources.push({
+                  ...usedStorageResource,
+                  graphServiceTag: graphServiceTag
+                });
+              } else {
+                targetStorageResources.push(usedStorageResource);
+              }
+            }));
+          }
+        })
+      );
+      //(<afterDeleteRel>)
+      //(</afterDeleteRel>)
+      _izContext.logger.debug("targetStorageResources: ", targetStorageResources);
+
+      if (!targetStorageResources.length) {
+        errorsFound.push(`Not found link from relationship schema`);
+      }
+
+
+      // validate properties exists with schema
+      for (const propKey in relationshipProperties) {
+        if (!relationshipSchema.fieldNames.hasOwnProperty(propKey)) {
+          errorsFound.push(`property:${propKey} not exists in relationshipSchema`);
+        }
+      }
+
+      // validate canCreate properties relationship
+      for (const [propName, propSetting] of Object.entries(relationshipSchema.fieldNames)) {
+        if (propSetting.requiredOnCreate === true) {
+          if (!relationshipProperties.hasOwnProperty(propName)) {
+            errorsFound.push(`Missing requiredOnCreate property:${propKey}`);
+          }
+        }
+
+        if (!propSetting.optionalOnCreate && !propSetting.requiredOnCreate && relationshipProperties.hasOwnProperty(propName)) {
+          errorsFound.push(`property:${propName} cannot create`);
+        }
+      }
+
+    } else {
+      errorsFound.push(`relationshipSchema not exists`);
+    }
+
+
+    // if found errors will stop processing
+    if (errorsFound.length) {
+
+      let deleteRelCompleteMsg = {
+        firstObject: firstObject,
+        secondObject: secondObject,
+        relType: relType,
+        relationshipProperties: relationshipProperties,
+        relationshipDirection: relationshipDirection,
+        //(<inDeleteRelCompleteMsg>)
+        //(</inDeleteRelCompleteMsg>)
+        status: 'error',
+        errorFounds: errorsFound
+      };
+
+      // if have callingFlow will send to message complete
+      if (callingFlowConfig[callingFlowSharedLib.consts.CALLINGFLOW_PROPERTYNAME]) {
+        _izContext.logger.debug("HAVE CallingFlow");
+
+        deleteRelCompleteMsg = callingFlowSharedLib.addPassBackPropertiesToSnsResponseMessageObject(callingFlowConfig, deleteRelCompleteMsg);
+        let messageAttributes = callingFlowSharedLib.addCallingFlowToSnsResponseMessageAttributes(callingFlowConfig, {});
+
+        let messageParams = {
+          Message: JSON.stringify(deleteRelCompleteMsg),
+          MessageAttributes: sns.createStringMessageAttributes(_izContext, messageAttributes),
+          TopicArn: await snsSharedLib.snsTopicArn(_izContext, TOPIC_NAME_GENERATE_CODE.outDeleteRelComplete),
+        };
+
+        _izContext.logger.debug("messageParams OutCreateRelationshipComplete ::::::: ", messageParams);
+        await sns.publishAsync(_izContext, messageParams);
+      }
+
+      return deleteRelCompleteMsg;
+    }
+
+
+    // before create awaitingStepId per graph storageResource
+    const linkTypeId = createLinkTypeId(_izContext, firstObject.objType, secondObject.objType, relType, relationshipDirection);
+
+    let usedGraphServiceTag = []; // collect used graph serviceTag, use to check duplicate graph serviceTag across graph serverTag
+    let targetGraphStorageResources = []; // collect used graph storageResources, filtered duplicate graphServiceTag from graphServerTag out
+    let awaitingStepIds = [];
+
+    for (const targetStorageResource of targetStorageResources) {
+      if (targetStorageResource.storageType === consts.STORAGE_TYPES.graph &&
+        !usedGraphServiceTag.includes(targetStorageResource.graphServiceTag)
+      ) {
+        usedGraphServiceTag.push(targetStorageResource.graphServiceTag);
+        targetGraphStorageResources.push(targetStorageResource);
+
+        // awaitingStepId per graphServiceTag
+        awaitingStepIds.push(
+          asyncFlowSharedLib.createAwaitingStepId(
+            hash({ linkTypeId, relationshipProperties, graphServiceTag: targetStorageResource.graphServiceTag }), // hash id
+            PREFIX.deleteRel // prefix, use constant further
+          )
+        );
+      }
+    }
+
+    if (awaitingStepIds.length) {
+      // save awaiting
+      await asyncFlowSharedLib.createAwaitingMultipleSteps(
+        _izContext,
+        awaitingStepIds, // awaitingStepIds
+        asyncFlowSharedLib.createPendingStepId( // pendingStepId
+          hash({ linkTypeId, relationshipProperties, correlationId: _izContext.correlationIds.get("id") }), // hash id
+          PREFIX.deleteRel // prefix, use constant further
+        )
+      );
+
+      // prepare message body
+      let deleteRelMessageBody = {
+        firstObject: firstObject,
+        secondObject: secondObject,
+        relType: relType,
+        relationshipProperties: relationshipProperties,
+        relationshipDirection: relationshipDirection,
+        //(<inDeleteRelMessageBody>)
+        //(</inDeleteRelMessageBody>)
+      }
+      _izContext.logger.debug('deleteRelMessageBody: ', deleteRelMessageBody);
+
+      await Promise.all(
+        targetGraphStorageResources.map(async (storageResource) => {
+          if (storageResource.storageType === consts.STORAGE_TYPES.graph) {
+
+            deleteRelMessageBody = callingFlowSharedLib.addCallingFlowToSnsRequestMessageObject(
+              deleteRelMessageBody,
+              callingFlowSharedLib.addParentCallingFlowConfig(
+                callingFlowConfig, // receive parent callingFlowConfig.
+                callingFlowSharedLib.createCallingFlowConfig( // callinfflow own service
+                  await lambdaSharedLib.lambdaFunctionName(_izContext, TOPIC_NAME_GENERATE_CODE.deleteRelComplete), {}
+                )
+              )
+            );
+            _izContext.logger.debug("messageObject before send message:", deleteRelMessageBody)
+
+            let messageToInUpdateRelationship = {
+              Message: JSON.stringify(deleteRelMessageBody),
+              TopicArn: await snsSharedLib.snsTopicArn(_izContext, TOPIC_NAME_GRAPH_HANDLER.inDeleteRel, storageResource.graphServiceTag),
+            };
+            _izContext.logger.debug("RequestParams before send to sqs messageToInUpdateRelationship ::::::: ", messageToInUpdateRelationship);
+            await sns.publishAsync(_izContext, messageToInUpdateRelationship);
+          }
+        })
+      )
+
+    } else {
+      // if relationshipSchema stored in dynamoDB only will send message to outComplete
+    }
+
+    return {
+      firstObject,
+      secondObject,
+      relType,
+      relationshipProperties,
+      relationshipDirection,
+      errorsFound
+    };
+
+
+  } catch (err) {
+    _izContext.logger.error('error deleteRelationship: ', err)
+    throw (err)
+  }
+}

package/src/reStructure/TemplateData/relationshipPerAction/delete/action/sns-in-sqs/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 {
+  HANDLER,
+} = require('@izara_project/izara-core-library-service-schemas/src/Consts');
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../MainLibs/index.js").utils;
+const { SOURCE_PATH, SAVE_FILE_NAME, FUNCTION_NAME } = require("../../../../../../MainLibs/index.js").consts;
+const snsTemplatePath = path.join(__dirname, "./snsTemplate.ejs")
+const sqsTemplatePath = path.join(__dirname, "./sqsTemplate.ejs")
+
+/**
+ * create data for dynamoDbYaml tempalte from objectSchema
+ *
+ * @param {Object} _izContext
+ * @param {String} saveFilePath
+ * @returns {Object[]}              - data of multiple dynamoDb template
+ */
+
+function createRelationshipSnsInSqs(_izContext, srcPath) {
+  let resultForCreateRelationshipSnsAndSqs = [];
+  const setting = {
+    initialData: "Resources:\n",
+    savePath: path.join(srcPath, SOURCE_PATH.resourceYaml),
+    saveFileName: SAVE_FILE_NAME.snsInSqsYaml,
+    fileExtension: ".yml",
+    isAppend: true
+  }
+  const createRelationshipQueueNames = [
+    {
+      queueName: upperCase(FUNCTION_NAME.deleteRel)
+    },
+    {
+      queueName: upperCase(FUNCTION_NAME.deleteRel) + upperCase(HANDLER.hdrDsq)
+    }
+  ]
+  for (let createRelationshipQueueName of createRelationshipQueueNames) {
+    if (createRelationshipQueueName.queueName.includes("HdrDsq")) {
+      resultForCreateRelationshipSnsAndSqs.push({
+        templatePath: sqsTemplatePath,
+        templateData: createRelationshipQueueName,
+        setting: setting
+      }
+      )
+    } else {
+      resultForCreateRelationshipSnsAndSqs.push(
+        {
+          templatePath: snsTemplatePath,
+          templateData: createRelationshipQueueName,
+          setting: setting
+        }
+      )
+    }
+  }
+  return resultForCreateRelationshipSnsAndSqs
+}
+
+module.exports = createRelationshipSnsInSqs

package/src/reStructure/TemplateData/relationshipPerAction/delete/action/sns-in-sqs/snsTemplate.ejs

@@ -0,0 +1,59 @@
+##===== [Create topic in]
+  In<%- queueName %>:
+    Type: AWS::SNS::Topic
+    Properties:
+      DisplayName: "SNS Message in"
+      TopicName: ${self:custom.iz_resourcePrefix}In<%- queueName %>
+##===== SNS Subscription
+##===== [Topic In]
+  SubscriptionIn<%- queueName %>:
+    Type: AWS::SNS::Subscription
+    Properties:
+      TopicArn: !Ref In<%- queueName %>
+      Endpoint: "arn:aws:sqs:${self:custom.iz_region}:${self:custom.iz_accountId}:${self:custom.iz_resourcePrefix}<%- queueName %>HdrSqs"
+      Protocol: "sqs"
+##===== [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/relationshipPerAction/delete/action/sns-in-sqs/sqsTemplate.ejs

@@ -0,0 +1,43 @@
+#------- queue ---------
+  <%- queueName %>:
+    Type: "AWS::SQS::Queue"
+    Properties:
+      QueueName: ${self:custom.iz_resourcePrefix}<%- queueName %>
+      RedrivePolicy:
+        deadLetterTargetArn: #!GetAtt
+          Fn::GetAtt:
+            - <%- queueName %>DLQ
+            - Arn
+        maxReceiveCount: 3
+      VisibilityTimeout: 120
+
+  <%- queueName %>DLQ:
+    Type: AWS::SQS::Queue
+    Properties:
+      QueueName: ${self:custom.iz_resourcePrefix}<%- queueName %>DLQ
+
+  <%- queueName %>Policy:
+    Type: AWS::SQS::QueuePolicy
+    Properties:
+      PolicyDocument:
+        Version: "2012-10-17"
+        Statement:
+          - Sid: "allow-sns-messages"
+            Effect: Allow
+            Principal: "*"
+            Resource: #!GetAtt
+              Fn::GetAtt:
+                - <%- queueName %>
+                - Arn
+            Action: "SQS:SendMessage"
+      Queues:
+        - Ref: <%- queueName %>
+  #<#<%- 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)
+} _%>