@izara_project/izara-core-generate-service-code 1.0.45 → 1.0.47

package/src/generators/fromObjectSchema/relationship/moveRelationship/action/mainFunction/main.js

@@ -0,0 +1,61 @@
+/*
+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/>.
+*/
+
+import path from 'path';
+import { fileURLToPath } from 'url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+import consts from '#libs/Consts.js';
+import utils from '#libs/Utils.js';
+const { SOURCE_PATH, FUNCTION_NAME } = consts;
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } =
+  utils;
+
+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.moveRel;
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      upperFunctionName: upperCase(functionName)
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: `${upperCase(FUNCTION_NAME.moveRel)}_Main`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  };
+}
+
+export default data;

package/src/generators/fromObjectSchema/relationship/moveRelationship/action/mainFunction/template.ejs

@@ -0,0 +1,388 @@
+/*
+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/>.
+*/
+
+
+import { objectHash as hash, identifierUuid } from '@izara_project/izara-shared-core';
+
+import callingFlowSharedLib from '@izara_project/izara-core-library-calling-flow';
+import lambdaSharedLib from "@izara_project/izara-core-library-lambda";
+import snsSharedLib from "@izara_project/izara-core-library-sns";
+import asyncFlowSharedLib from "@izara_project/izara-core-library-asynchronous-flow";
+import dynamodbSharedLib from "@izara_project/izara-core-library-dynamodb";
+
+import { sns, lambda } from "@izara_project/izara-core-library-external-request";
+
+import { getObjectSchema, utils, serviceConfig, consts, relSchemaLib, identifiersObject } from '@izara_project/izara-core-library-service-schemas'
+const { findLinksByObjTypes } = relSchemaLib;
+
+const {
+  getRelationshipSchemaWithCache,
+  getObjSchemaS3WithHierarchy
+} = getObjectSchema
+
+const {
+  createLinkTypeId
+} = utils;
+
+const {
+  getGraphServiceTagWithCache
+} = serviceConfig;
+
+const {
+  PREFIX,
+  TOPIC_NAME_GENERATE_CODE,
+  TOPIC_NAME_GRAPH_HANDLER
+} = consts;
+
+import { consts as coreConsts } from '@izara_project/izara-core-library-core';
+
+//(<optionalRequire>)
+//(</optionalRequire>)
+
+/**
+ * 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
+ */
+export default async function moveRelationship(
+  _izContext,
+  requestParams,
+  callingFlowConfig = {},
+  //(<additionalParams>)
+  //(</additionalParams>)
+) {
+  try {
+    _izContext.logger.debug('moveRelationship _izContext: ', _izContext);
+    _izContext.logger.debug('moveRelationship requestParams: ', requestParams);
+    _izContext.logger.debug('moveRelationship callingFlowConfig: ', callingFlowConfig);
+
+    const {
+      firstObject,
+      secondObject,
+      relType,
+      relationshipDirection,
+      relationshipProperties,
+      moveObject
+      //(<requestParamMoveRel>)
+      //(</requestParamMoveRel>)
+    } = requestParams;
+
+    const parentFlowId = identifierUuid();
+    let errorsFound = [];
+
+    //(<beforeValidateMoveRel>)
+    //(</beforeValidateMoveRel>).
+    // 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
+
+    //(<afterValidateMoveRel>)
+    //(</afterValidateMoveRel>)
+
+    const relationshipSchema = await getRelationshipSchemaWithCache(_izContext, relType);
+    _izContext.logger.debug("relationshipSchema: ", relationshipSchema);
+
+    if (!relationshipSchema.hasOwnProperty("moveBy") || relationshipSchema.moveBy === "none") {
+      errorsFound.push(`relationship: ${relType.relationshipTag} can't move`);
+    } else if (relationshipSchema.moveBy === "user") {
+      if (callingFlowConfig) {
+        if (callingFlowConfig.callingFlow !== "ImportDataTestExternalUpdateRelationshipHdrSqs") {
+          errorsFound.push(`moveBy is user but it's not user process with importData`);
+        }
+      }
+    }
+
+    const links = await findLinksByObjTypes(_izContext, [firstObject.objType, secondObject.objType], relationshipSchema.links)
+    _izContext.logger.debug("links", links)
+
+    const firstObjectHie = await getObjectSchema.getObjSchemaS3WithHierarchy(_izContext, firstObject.objType);
+    const secondObjectHie = await getObjectSchema.getObjSchemaS3WithHierarchy(_izContext, secondObject.objType);
+
+    if (!links.length) {
+      errorsFound.push(`not found link between ${JSON.stringify({ firstObject: firstObject.objType })} ${JSON.stringify({ secondObject: secondObject.objType })}`)
+    };
+
+    let checkCorrectLink = false;
+    for (let link of links) {
+      const { serviceTag: fromServiceTag, objectType: fromObjectType } = link.from.objType;
+      const { serviceTag: toServiceTag, objectType: toObjType } = link.to.objType;
+
+      const { serviceTag: firstServiceTag, objectType: firstObjectType } = firstObjectHie.extendObjType || firstObject.objType
+      const { serviceTag: secondServiceTag, objectType: secondObjectType } = secondObjectHie.extendObjType || secondObject.objType
+
+      const matchFromTo = fromServiceTag === firstServiceTag && fromObjectType === firstObjectType &&
+        toServiceTag === secondServiceTag && toObjType === secondObjectType;
+
+      const matchToFrom = fromServiceTag === secondServiceTag && fromObjectType === secondObjectType &&
+        toServiceTag === firstServiceTag && toObjType === firstObjectType;
+
+      if ((relationshipDirection === "from" && matchFromTo) ||
+        (relationshipDirection === "to" && matchToFrom)) {
+        checkCorrectLink = true
+        break;
+      }
+    };
+
+    if (checkCorrectLink == false) {
+      errorsFound.push(`Wrong Relationship Direction`)
+    };
+
+    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 } = firstObjectHie.extendObjType || firstObject.objType;
+          const { serviceTag: secondServiceTag, objectType: secondObjectType } = secondObjectHie.extendObjType || 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);
+              }
+            }));
+          }
+        })
+      );
+      //(<afterGetRelMoveRel>)
+      //(</afterGetRelMoveRel>)
+      _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`);
+        }
+      }
+
+    } else {
+      errorsFound.push(`relationshipSchema not exists`);
+    }
+
+
+    // if found errors will stop processing
+    if (errorsFound.length) {
+
+      let moveRelCompleteMsg = {
+        firstObject,
+        secondObject,
+        relType,
+        relationshipProperties,
+        relationshipDirection,
+        moveObject,
+        //(<inMoveCompleteMsg>)
+        //(</inMoveCompleteMsg>)
+        status: 'error',
+        errorsFound: errorsFound,
+        parentFlowId: parentFlowId
+      };
+
+      // if have callingFlow will send to message complete
+      if (callingFlowConfig[callingFlowSharedLib.consts.CALLINGFLOW_PROPERTYNAME]) {
+        _izContext.logger.debug("HAVE CallingFlow");
+
+        moveRelCompleteMsg = callingFlowSharedLib.addPassBackPropertiesToSnsResponseMessageObject(callingFlowConfig, moveRelCompleteMsg);
+        let messageAttributes = callingFlowSharedLib.addCallingFlowToSnsResponseMessageAttributes(callingFlowConfig, {});
+
+        let messageParams = {
+          Message: JSON.stringify(moveRelCompleteMsg),
+          MessageAttributes: sns.createStringMessageAttributes(_izContext, messageAttributes),
+          TopicArn: await snsSharedLib.snsTopicArnByFlowSchema(_izContext, TOPIC_NAME_GENERATE_CODE.outMoveRelationshipComplete),
+        };
+
+        _izContext.logger.debug("messageParams OutCreateRelationshipComplete ::::::: ", messageParams);
+        await sns.publishAsync(_izContext, messageParams);
+      }
+
+      return moveRelCompleteMsg;
+    }
+
+
+    // 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(
+            parentFlowId, // hash id
+            PREFIX.changeRel // prefix, use constant further
+          )
+        );
+      }
+    }
+
+    if (awaitingStepIds.length) {
+      // save awaiting
+      await asyncFlowSharedLib.createAwaitingMultipleSteps(
+        _izContext,
+        awaitingStepIds, // awaitingStepIds
+        asyncFlowSharedLib.createPendingStepId( // pendingStepId
+          hash({
+            linkTypeId,
+            correlationId: _izContext.correlationIds.get("id"),
+            callingFlowProperties: callingFlowConfig.callingFlowProperties || {},
+            firstObject,
+            secondObject,
+            relType,
+            relationshipDirection,
+            relationshipProperties,
+            moveObject
+          }), // hash id
+          PREFIX.changeRel // prefix, use constant further
+        )
+      );
+
+      // prepare message body
+      let moveRelMessageBody = {
+        firstObject,
+        secondObject,
+        relType,
+        relationshipDirection,
+        relationshipProperties,
+        moveObject,
+        parentFlowId: parentFlowId,
+        //(<messageBodyMoveRel>)
+        //(</messageBodyMoveRel>)
+
+        // assign originTimestamp if not exists in relationshipProperties
+      }
+      _izContext.logger.debug('changeRelMessageBody: ', moveRelMessageBody);
+
+      await Promise.all(
+        targetGraphStorageResources.map(async (storageResource) => {
+          if (storageResource.storageType === consts.STORAGE_TYPES.graph) {
+
+            moveRelMessageBody = callingFlowSharedLib.addCallingFlowToSnsRequestMessageObject(
+              moveRelMessageBody,
+              callingFlowSharedLib.addParentCallingFlowConfig(
+                callingFlowConfig, // receive parent callingFlowConfig.
+                callingFlowSharedLib.createCallingFlowConfig( // calling flow own service
+                  //(<callingFlowProperties>)
+                  await lambdaSharedLib.lambdaFunctionName(_izContext, TOPIC_NAME_GENERATE_CODE.moveRelationshipComplete),
+                  //(</callingFlowProperties>)
+                  {
+                    graphServiceTag: storageResource.graphServiceTag
+                  }
+                )
+              )
+            );
+            _izContext.logger.debug("messageObject before send message:", moveRelMessageBody)
+
+            let messageToInChangeRelationship = {
+              Message: JSON.stringify(moveRelMessageBody),
+              TopicArn: await snsSharedLib.snsTopicArnByFlowSchema(_izContext, TOPIC_NAME_GRAPH_HANDLER.inMoveRelationship, storageResource.graphServiceTag),
+            };
+            _izContext.logger.debug("RequestParams before send to sqs messageToInUpdateRelationship ::::::: ", messageToInChangeRelationship);
+            await sns.publishAsync(_izContext, messageToInChangeRelationship);
+          }
+        })
+      )
+    }
+
+    return {
+      firstObject,
+      secondObject,
+      relType,
+      relationshipDirection,
+      relationshipProperties,
+      moveObject,
+      status: "complete"
+    };
+
+
+  } catch (err) {
+    _izContext.logger.error('error ChangeRelationship: ', err)
+    throw (err)
+  }
+}

package/src/generators/fromObjectSchema/relationship/moveRelationship/action/sns-in-sqs/snsTemplate.ejs

@@ -0,0 +1,56 @@
+##===== [Create topic in]
+  In<%- queueName %>:
+    Type: AWS::SNS::Topic
+    Properties:
+      DisplayName: "SNS Message in"
+      TopicName: ${self:custom.iz_serviceTag}_${self:custom.iz_stage}_<%- queueName %>_In
+##===== 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
+  #<#<%- queueName %>QueueSetting#>
+  #<#/<%- queueName %>QueueSetting#>
+
+<%_ function firstLetterLowerCase(str) {
+  return str.charAt(0).toLowerCase() + str.slice(1)
+} _%>

package/src/generators/fromObjectSchema/relationship/moveRelationship/action/sns-in-sqs/sqsTemplate.ejs

@@ -0,0 +1,40 @@
+#------- 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 %>
+  #<#<%- queueName %>QueueSetting#>
+  #<#/<%- queueName %>QueueSetting#>
+
+<%_ function firstLetterLowerCase(str) {
+  return str.charAt(0).toLowerCase() + str.slice(1)
+} _%>

package/src/generators/fromObjectSchema/relationship/moveRelationship/complete/functionYaml/template.ejs

@@ -0,0 +1,16 @@
+<%- functionNameConfig %>:
+  handler: <%- handlerPathUpperFunctionName %>
+  name: ${self:custom.iz_resourcePrefix}<%- upperFunctionName %>
+  role: <%- roleName %>Role
+  #<#<%- functionName %><%- upperHandlerType %>FunctionSetting#>
+  #<#/<%- functionName %><%- upperHandlerType %>FunctionSetting#>
+  events:
+    - sqs:
+        arn: arn:aws:sqs:${self:custom.iz_region}:${self:custom.iz_accountId}:${self:custom.iz_resourcePrefix}<%- upperFunctionName %>
+        batchSize: 10
+        filterPatterns: #**** need to update serverless framework upper v.2.69.1
+          - body: {"MessageAttributes":{"callingFlow":{"Value":["${self:custom.iz_resourcePrefix}<%- upperFunctionName %>"]}}} # functionName of callingFlow
+          - body: {"MessageAttributes":{"callingFlow":{"Value":[{"exists":false}]}}}
+<%_ function firstLetterLowerCase(str) {
+  return str.charAt(0).toLowerCase() + str.slice(1)
+} _%>