@izara_project/izara-market-library-service-schemas 1.0.3 → 1.0.5

package/src/TemplateManager/src/UpdateRelationshipSchema/updateRelationship/functionYaml/HdrSqs/data.js

@@ -0,0 +1,131 @@
+/*
+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 fs = require('fs');
+
+const { ACTIONS, HANDLER, STORAGE_TYPES } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } = require("../../../../../../MainLibs/src/Utils")
+const { DEFAULT_HANDLER_PER_ACTION, createIamRole, resourceNames, RESOURCE_CLASSES, DEFAULT_LAMBDA_ROLE_PER_ACTION, SQS_RESOURCE, SOURCE_PATH, SAVE_FILE_NAME, FUNCTION_NAME } = require("../../../../libs/Consts");
+
+const templatePath = path.join(__dirname, '../../../../PerActionEndpoint/FunctionYaml/HdrSqs/template.ejs')
+
+function defaultIamRolePerAction() {
+
+  let defaultIamRole = [];
+
+
+  defaultIamRole.push(
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.s3]: ["GetObject", "GetObjectVersion"],
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.s3, "object-schema/perServiceSchemas/*"),
+        resourceNames(RESOURCE_CLASSES.s3, "object-schema/serviceConfig/ServiceNameConfig.json"),
+        resourceNames(RESOURCE_CLASSES.s3, "object-schema/serviceConfig/GraphServerTags.json"),
+      ]
+    )
+  );
+
+  defaultIamRole.push(
+    createIamRole(
+      { [RESOURCE_CLASSES.s3]: ["ListBucket"] },
+      [
+        resourceNames(RESOURCE_CLASSES.s3, "object-schema"),
+      ]
+    )
+  );
+
+  return defaultIamRole
+}
+
+/**
+ * receive objectSchema
+ * create data for updateRelationshipSchema
+ *
+ * @param {Object} objectSchema
+ * @return {{ templatePath, templateData, setting } }
+ */
+
+function data(_izContext, srcPath) {
+  let createSourceArray = [];
+  const createSourceParam = createParamForCreateSource(srcPath);
+  createSourceArray.push(createSourceParam);
+  // console.log("createSourceArrayInUpdaterelationShipSchemahdrSqs", createSourceArray)
+  return createSourceArray
+}
+
+
+function createParamForCreateSource(srcPath) {
+
+  let handlerType = HANDLER.hdrSqs
+  let functionName = FUNCTION_NAME.updateRel
+  let additionalResourcePermission = defaultIamRolePerAction();
+
+  additionalResourcePermission.push(
+    createIamRole(
+      {
+        [RESOURCE_CLASSES.sqs]: [
+          SQS_RESOURCE.deleteMessage,
+          SQS_RESOURCE.getQueueAttributes,
+          SQS_RESOURCE.receiveMessage,
+          SQS_RESOURCE.sendMessage,
+          SQS_RESOURCE.getQueueUrl,
+          SQS_RESOURCE.deleteMessageBatch
+        ], [RESOURCE_CLASSES.sns]:
+          ["Publish", "Subscribe"]
+      },
+      [
+        resourceNames(RESOURCE_CLASSES.sqs, upperCase(functionName) + upperCase(HANDLER.hdrSqs)),
+        resourceNames(RESOURCE_CLASSES.sqs, upperCase(functionName) + upperCase(HANDLER.hdrSqs) + "DLQ"),
+        resourceNames(RESOURCE_CLASSES.sns, "In" + upperCase(functionName) + upperCase(HANDLER.hdrSqs)),
+        resourceNames(RESOURCE_CLASSES.sns, "Out" + upperCase(functionName) + upperCase(HANDLER.hdrSqs))
+      ]
+    ),
+  )
+  additionalResourcePermission.push(
+    createIamRole(
+      { [RESOURCE_CLASSES.dynamoDbTable]: ["PutItem"] },
+      [
+        resourceNames(RESOURCE_CLASSES.dynamoDbTable, "AwaitingMultipleSteps"),
+        resourceNames(RESOURCE_CLASSES.dynamoDbTable, "AwaitingMultipleStepByPending")
+      ]
+    ))
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      handlerType,
+      additionalResourcePermission,
+      resourceLocation: SOURCE_PATH.resourceLocationRelationshipPerAction
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
+      saveFileName: SAVE_FILE_NAME.functionRelationshipYaml,
+      fileExtension: '.yml',
+      isAppend: true
+    }
+
+  }
+}
+
+
+
+module.exports = data;

package/src/TemplateManager/src/UpdateRelationshipSchema/updateRelationship/mainFunction/data.js

@@ -0,0 +1,65 @@
+/*
+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 fs = require('fs');
+
+const { ACTIONS, HANDLER } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+const { createGetDataDetails } = require('../../../../../GenerateCodeLibs/src/GenerateCodeLibs')
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase, firstLetterUpperCase } = require("../../../../../MainLibs/src/Utils")
+const { DEFAULT_HANDLER_PER_ACTION, SOURCE_PATH } = require("../../../libs/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)
+
+
+  // console.log("createSourceArrayInUpdateRelationshipHdrInv", createSourceArray)
+  return [createSourceParams];
+}
+
+
+function createParamForCreateSource(srcPath) {
+  const functionName = "updateRelationship"
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName: upperCase(functionName)
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: `${upperCase(functionName)}_Main`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+
+
+module.exports = data;

package/src/TemplateManager/src/UpdateRelationshipSchema/updateRelationship/mainFunction/request.json

@@ -0,0 +1 @@
+{}

package/src/TemplateManager/src/UpdateRelationshipSchema/updateRelationship/mainFunction/template.ejs

@@ -0,0 +1,331 @@
+/*
+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 { validateObject } = require('@izara_project/izara-core-library-core/src/Validator')
+
+const {
+  getRelationshipSchemaWithCache,
+  getObjSchemaS3WithHierarchy
+} = require('@izara_project/izara-core-library-service-schemas/src/GetObjectSchema');
+
+
+const {
+  createObjectTypeId,
+  createRelationshipTypeId,
+  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 { NoRetryError } = require("@izara_project/izara-core-library-core");
+
+const {
+  PREFIX,
+  TOPIC_NAME_GRAPH_HANDLER,
+  TOPIC_NAME_GENERATE_CODE
+} = 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.updateRelationship = async (
+  _izContext,
+  requestParams,
+  callingFlowConfig = {},
+  //(<additionalParams>)
+  //(</additionalParams>)
+) => {
+
+
+  try {
+    _izContext.logger.debug('updateRelationship _izContext: ', _izContext);
+    _izContext.logger.debug('updateRelationship requestParams: ', requestParams);
+    _izContext.logger.debug('updateRelationship callingFlowConfig: ', callingFlowConfig);
+
+
+    const {
+      objects,
+      relType,
+      relId,
+      relationshipProperties
+      //(<requestparamUpdateRel>)
+      //(</requestparamUpdateRel>)
+    } = requestParams;
+
+    let errorsFound = [];
+
+    //(<beforeValidateUpdateRel>)
+    //(</beforeValidateUpdateRel>)
+    // 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 identifierName = schemaIdentifier.fieldName || schemaIdentifier.name;
+
+        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, objects[0].objType, objects[0].identifiers);
+    await validateIdentifiersExists(_izContext, objects[1].objType, objects[1].identifiers);
+    // finished validate object and identifiers
+
+    //(<afterValidateUpdateRel>)
+    //(</afterValidateUpdateRel>)
+
+    //(<beforeGetRelUpdateRel>)
+    //(</beforeGetRelUpdateRel>)
+    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 } = objects[0].objType;
+          const { serviceTag: secondServiceTag, objectType: secondObjectType } = objects[1].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);
+              }
+            }));
+          }
+        })
+      );
+      //(<afterGetRelUpdateRel>)
+      //(</afterGetRelUpdateRel>)
+      _izContext.logger.debug("targetStorageResources: ", targetStorageResources);
+
+      if (!targetStorageResources.length) {
+        errorsFound.push(`Not found link from relationship schema`);
+      }
+
+
+      // validate canUpdate properties relationship
+      for (const [propKey, propValue] of Object.entries(relationshipProperties)) {
+        _izContext.logger.debug("propKey: ", propKey);
+        _izContext.logger.debug("propValue: ", propValue);
+
+        if (relationshipSchema.properties[propKey]) {
+          if (relationshipSchema.properties[propKey].canUpdate !== true) {
+            errorsFound.push(`property:${propKey} cannot update`);
+          }
+        } else {
+          errorsFound.push(`property:${propKey} not exists in relationshipSchema`);
+        }
+      }
+
+    } else {
+      errorsFound.push(`relationshipSchema not exists`);
+    }
+
+
+    // if found errors will stop processing
+    if (errorsFound.length) {
+
+      let updateCompleteMsg = {
+        relId: relId,
+        relType: relType,
+        status: 'error',
+        errorFounds: errorsFound
+        //(<inUpdateCompleteMsgUpdateRel>)
+        //(</inUpdateCompleteMsgUpdateRel>)
+      };
+
+      // if have callingFlow will send to message complete
+      if (callingFlowConfig[callingFlowSharedLib.consts.CALLINGFLOW_PROPERTYNAME]) {
+        _izContext.logger.debug("HAVE CallingFlow");
+
+        updateCompleteMsg = callingFlowSharedLib.addPassBackPropertiesToSnsResponseMessageObject(callingFlowConfig, updateCompleteMsg);
+        let messageAttributes = callingFlowSharedLib.addCallingFlowToSnsResponseMessageAttributes(callingFlowConfig, {});
+
+        let messageParams = {
+          Message: JSON.stringify(updateCompleteMsg),
+          MessageAttributes: sns.createStringMessageAttributes(_izContext, messageAttributes),
+          TopicArn: await snsSharedLib.snsTopicArn(_izContext, TOPIC_NAME_GENERATE_CODE.outUpdateRelComplete),
+        };
+
+        _izContext.logger.debug("messageParams OutUpdateRelationshipComplete ::::::: ", messageParams);
+        await sns.publishAsync(_izContext, messageParams);
+      }
+
+      return updateCompleteMsg;
+    }
+
+
+    // before create awaitingStepId per graph storageResource
+    const linkTypeId = createLinkTypeId(_izContext, [objects[0].objType, objects[1].objType], relType);
+
+    let usedGraphServiceTag = [];            // collect used graph serviceName, use to check duplicate graph serviceName 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, relId, relationshipProperties, graphServiceTag: targetStorageResource.graphServiceTag }), // hash id
+            PREFIX.updateRel // prefix, use constant further
+          )
+        );
+      }
+    }
+
+    if (awaitingStepIds.length) {
+      // save awaiting
+      await asyncFlowSharedLib.createAwaitingMultipleSteps(
+        _izContext,
+        awaitingStepIds, // awaitingStepIds
+        asyncFlowSharedLib.createPendingStepId( // pendingStepId
+          hash({ linkTypeId, relId, relationshipProperties, correlationId: _izContext.correlationIds.get("id") }), // hash id
+          PREFIX.updateRel // prefix, use constant further
+        )
+      );
+
+      // prepare message body
+      let updateRelMessageBody = {
+        objects: objects,
+        relId,
+        relType: relType,
+        relationshipProperties
+        //(<inUpdateRelMessageBodyUpdateRel>)
+        //(</inUpdateRelMessageBodyUpdateRel>)
+      }
+      _izContext.logger.debug('updateRelMessageBody: ', updateRelMessageBody);
+
+      await Promise.all(
+        targetGraphStorageResources.map(async (storageResource) => {
+          if (storageResource.storageType === consts.STORAGE_TYPES.graph) {
+
+            updateRelMessageBody = callingFlowSharedLib.addCallingFlowToSnsRequestMessageObject(
+              updateRelMessageBody,
+              callingFlowSharedLib.addParentCallingFlowConfig(
+                callingFlowConfig, // receive parent callingFlowConfig.
+                callingFlowSharedLib.createCallingFlowConfig(   // callinfflow own service
+                  await lambdaSharedLib.lambdaFunctionName(_izContext, TOPIC_NAME_GENERATE_CODE.updateRelComplete),
+                  {
+                    graphServiceTag: storageResource.graphServiceTag
+                  }
+                )
+              )
+            );
+            _izContext.logger.debug("messageObject before send message:", updateRelMessageBody)
+
+            let messageToInUpdateRelationship = {
+              Message: JSON.stringify(updateRelMessageBody),
+              TopicArn: await snsSharedLib.snsTopicArn(_izContext, TOPIC_NAME_GRAPH_HANDLER.inUpdateRel, 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 {
+      relId: relId,
+      relType: relType,
+      errorFounds: errorsFound
+    };
+
+  } catch (err) {
+    _izContext.logger.error('error updateRelationship: ', err)
+    throw (err)
+  }
+}

package/src/TemplateManager/src/UpdateRelationshipSchema/updateRelationship/perAction/HdrApi/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 fs = require('fs');
+
+const { ACTIONS, HANDLER } = require('@izara_project/izara-core-library-service-schemas/src/Consts')
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase, firstLetterUpperCase } = require("../../../../../../MainLibs/src/Utils")
+const { DEFAULT_HANDLER_PER_ACTION, SOURCE_PATH, FUNCTION_NAME } = require("../../../../libs/Consts");
+
+const templatePath = path.join(__dirname, "./template.ejs")
+
+/**
+ * receive objectSchema
+ * create data for hdrInv template
+ *
+ * @return {{ templatePath, templateData, setting } }
+ */
+function data(_izContext, srcPath) {
+  const createSourceParams = createParamForCreateSource(srcPath)
+  return [createSourceParams];
+}
+
+
+function createParamForCreateSource(srcPath) {
+  const functionName = FUNCTION_NAME.updateRel;
+  const handler = HANDLER.hdrApi
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: `${upperCase(functionName)}_${upperCase(handler)}`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+
+module.exports = data;

package/src/TemplateManager/src/UpdateRelationshipSchema/updateRelationship/perAction/HdrApi/request.json

@@ -0,0 +1,7 @@
+{
+  "objectType": "objectType",
+  "action": "get",
+  "mainFunction": "xxx",
+  "mainFunctionFile": "directoryOfMainFunction",
+  "isCreateMainByDev": "boolean"
+}