@izara_project/izara-market-library-service-schemas 1.0.62 → 1.0.64

package/src/reStructure/TemplateData/relationshipPerAction/changeRelationship/action/handler/sqs/template.ejs

@@ -0,0 +1,181 @@
+/*
+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-core-library-calling-flow');
+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-core-library-record-handler');
+
+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',
+  'oldReltypeAndDirection',
+  'newRelType',
+  ],
+  properties: {
+    firstObject: {
+      type: 'object',
+      required: ['objType', 'identifiers'],
+      properties: {
+        objType: {
+          type: 'object',
+          required: ['objectType', 'serviceTag'],
+          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: ['objectType', 'serviceTag'],
+          properties: {
+            serviceTag: izara.validatorSchema.stringNotEmpty(),
+            objectType: izara.validatorSchema.stringNotEmpty(),
+          }
+        },
+        identifiers: {
+          type: "object",
+          minProperties: 1
+        },
+      }
+    },
+    oldReltypeAndDirection: {
+      type: 'object',
+      required: ['relType', 'relationshipDirection'],
+      properties: {
+        relType: {
+          type: 'object',
+          required: ['serviceTag', 'relationshipTag'],
+          properties: {
+            serviceTag: izara.validatorSchema.stringNotEmpty(),
+            relationshipTag: izara.validatorSchema.stringNotEmpty(),
+          }
+        },
+        relationshipProperties: {
+          type: 'object',
+        },
+        relationshipDirection: {
+          type: 'string',
+          enum: ['from', 'to']
+
+        },
+      }
+    },
+    newRelType: {
+      type: 'object',
+      required: ['serviceTag', 'relationshipTag'],
+      properties: {
+        serviceTag: izara.validatorSchema.stringNotEmpty(),
+        relationshipTag: izara.validatorSchema.stringNotEmpty(),
+      }
+    },
+    settings: {
+      type: 'object'
+    }
+  }
+};
+
+
+//(<globalVariable>
+  //</globalVariable>)
+
+  // 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
+          "<%-firstLetterUpperCase(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.
+          "<%-firstLetterUpperCase(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/changeRelationship/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.changeRel
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: `${upperCase(FUNCTION_NAME.changeRel)}_Main`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+
+module.exports = data;

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

@@ -0,0 +1,382 @@
+/*
+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('@izara_project/izara-shared-core').objectHash;
+
+const callingFlowSharedLib = require('@izara_project/izara-core-library-calling-flow');
+const lambdaSharedLib = require("@izara_project/izara-core-library-lambda");
+const snsSharedLib = require("@izara_project/izara-core-library-sns");
+const dynamodbSharedLib = require("@izara_project/izara-core-library-dynamodb");
+const asyncFlowSharedLib = require("@izara_project/izara-core-library-asynchronous-flow");
+
+const sns = require("@izara_project/izara-core-library-external-request/src/resources/Sns");
+
+const identifiersObject = require('@izara_project/izara-core-library-service-schemas/src/IdentifiersObject');
+
+// const NoRetryError = require('@izara_project/izara-core-library-core/src/NoRetryError');
+
+const { findLinksByObjTypes } = require("@izara_project/izara-core-library-service-schemas/src/libs/RelSchemaLib");
+
+
+
+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');
+const coreConsts = require('@izara_project/izara-core-library-core/src/Consts');
+
+//(<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
+ */
+module.exports.<%- functionName %> = async (
+  _izContext,
+  requestParams,
+  callingFlowConfig = {},
+  //(<additionalParams>)
+  //(</additionalParams>)
+) => {
+  try {
+    _izContext.logger.debug('<%- functionName %> _izContext: ', _izContext);
+    _izContext.logger.debug('<%- functionName %> requestParams: ', requestParams);
+    _izContext.logger.debug('<%- functionName %> callingFlowConfig: ', callingFlowConfig);
+
+    let originTimestamp = Date.now();
+    let changedByUserId = _izContext.correlationIds.get(coreConsts.BASE_USER_ID)
+    const {
+      firstObject,
+      secondObject,
+      oldReltypeAndDirection,
+      newRelType,
+      //(<requestParamCreateRel>)
+      //(</requestParamCreateRel>)
+    } = requestParams;
+
+    let errorsFound = [];
+
+    //(<beforeValidateChangeRel>)
+    //(</beforeValidateChangeRel>).
+    // 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
+
+    //(<afterValidateChangeRel>)
+    //(</afterValidateChangeRel>)
+
+    const relationshipSchema = await getRelationshipSchemaWithCache(_izContext, newRelType);
+    _izContext.logger.debug("relationshipSchema: ", relationshipSchema);
+
+    const links = await findLinksByObjTypes(_izContext, [firstObject.objType, secondObject.objType], relationshipSchema.links)
+    _izContext.logger.debug("links", links)
+    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 } = firstObject.objType
+      const { serviceTag: secondServiceTag, objectType: secondObjectType } = secondObject.objType
+
+      const matchFromTo = fromServiceTag === firstServiceTag && fromObjectType === firstObjectType &&
+        toServiceTag === secondServiceTag && toObjType === secondObjectType;
+
+      const matchToFrom = fromServiceTag === secondServiceTag && fromObjectType === secondObjectType &&
+        toServiceTag === firstServiceTag && toObjType === firstObjectType;
+
+      if ((oldReltypeAndDirection.relationshipDirection === "from" && matchFromTo) ||
+        (oldReltypeAndDirection.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 } = 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);
+              }
+            }));
+          }
+        })
+      );
+      //(<afterGetRelChangeRel>)
+      //(</afterGetRelChangeRel>)
+      _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 oldReltypeAndDirection.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 changeRelCompleteMsg = {
+        fromObject: firstObject,
+        toObject: secondObject,
+        oldReltypeAndDirection,
+        newRelType,
+        originTimestamp,
+        changedByUserId,
+        //(<inChangeRelCompleteMsg>)
+        //(</inChangeRelCompleteMsg>)
+        status: 'error',
+        errorsFound: errorsFound
+      };
+
+      // if have callingFlow will send to message complete
+      if (callingFlowConfig[callingFlowSharedLib.consts.CALLINGFLOW_PROPERTYNAME]) {
+        _izContext.logger.debug("HAVE CallingFlow");
+
+        changeRelCompleteMsg = callingFlowSharedLib.addPassBackPropertiesToSnsResponseMessageObject(callingFlowConfig, changeRelCompleteMsg);
+        let messageAttributes = callingFlowSharedLib.addCallingFlowToSnsResponseMessageAttributes(callingFlowConfig, {});
+
+        let messageParams = {
+          Message: JSON.stringify(changeRelCompleteMsg),
+          MessageAttributes: sns.createStringMessageAttributes(_izContext, messageAttributes),
+          TopicArn: await snsSharedLib.snsTopicArnByFlowSchema(_izContext, TOPIC_NAME_GENERATE_CODE.outCreateRelComplete),
+        };
+
+        _izContext.logger.debug("messageParams OutCreateRelationshipComplete ::::::: ", messageParams);
+        await sns.publishAsync(_izContext, messageParams);
+      }
+
+      return changeRelCompleteMsg;
+    }
+
+
+    // before create awaitingStepId per graph storageResource
+    const linkTypeId = createLinkTypeId(_izContext, firstObject.objType, secondObject.objType, newRelType, oldReltypeAndDirection.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,
+              graphServiceTag: targetStorageResource.graphServiceTag,
+              callingFlowProperties: callingFlowConfig.callingFlowProperties || {},
+              firstObject,
+              secondObject,
+              oldReltypeAndDirection,
+              newRelType,
+            }), // 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,
+            oldReltypeAndDirection,
+            newRelType,
+          }), // hash id
+          PREFIX.changeRel // prefix, use constant further
+        )
+      );
+
+      // prepare message body
+      let changeRelMessageBody = {
+        fromObject: firstObject,
+        toObject: secondObject,
+        oldReltypeAndDirection,
+        newRelType,
+        originTimestamp,
+        changedByUserId,
+        //(<messageBodyChangeRel>)
+        //(</messageBodyChangeRel>)
+
+        // assign originTimestamp if not exists in relationshipProperties
+      }
+      _izContext.logger.debug('changeRelMessageBody: ', changeRelMessageBody);
+
+      await Promise.all(
+        targetGraphStorageResources.map(async (storageResource) => {
+          if (storageResource.storageType === consts.STORAGE_TYPES.graph) {
+
+            changeRelMessageBody = callingFlowSharedLib.addCallingFlowToSnsRequestMessageObject(
+              changeRelMessageBody,
+              callingFlowSharedLib.addParentCallingFlowConfig(
+                callingFlowConfig, // receive parent callingFlowConfig.
+                callingFlowSharedLib.createCallingFlowConfig( // calling flow own service
+                  //(<callingFlowProperties>)
+                  await lambdaSharedLib.lambdaFunctionName(_izContext, TOPIC_NAME_GENERATE_CODE.changeRelationshipComplete),
+                  //(</callingFlowProperties>)
+                  {
+                    graphServiceTag: storageResource.graphServiceTag
+                  }
+                )
+              )
+            );
+            _izContext.logger.debug("messageObject before send message:", changeRelMessageBody)
+
+            let messageToInChangeRelationship = {
+              Message: JSON.stringify(changeRelMessageBody),
+              TopicArn: await snsSharedLib.snsTopicArnByFlowSchema(_izContext, TOPIC_NAME_GRAPH_HANDLER.inChangeRelationship, storageResource.graphServiceTag),
+            };
+            _izContext.logger.debug("RequestParams before send to sqs messageToInUpdateRelationship ::::::: ", messageToInChangeRelationship);
+            await sns.publishAsync(_izContext, messageToInChangeRelationship);
+          }
+        })
+      )
+    }
+
+    return {
+      fromObject: firstObject,
+      toObject: secondObject,
+      oldReltypeAndDirection,
+      newRelType,
+      originTimestamp,
+      changedByUserId,
+      status: "complete"
+    };
+
+
+  } catch (err) {
+    _izContext.logger.error('error ChangeRelationship: ', err)
+    throw (err)
+  }
+}