@izara_project/izara-market-library-service-schemas 1.0.4 → 1.0.6

package/src/TemplateManager/src/CreateRelationship/createRelationship/mainFunction/template.ejs

@@ -0,0 +1,340 @@
+/*
+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.createRelationship = async (
+  _izContext,
+  requestParams,
+  callingFlowConfig = {},
+  //(<additionalParams>)
+  //(</additionalParams>)
+) => {
+
+
+  try {
+    _izContext.logger.debug('createRelationship _izContext: ', _izContext);
+    _izContext.logger.debug('createRelationship requestParams: ', requestParams);
+    _izContext.logger.debug('createRelationship callingFlowConfig: ', callingFlowConfig);
+
+
+    const {
+      objects,
+      relType,
+      relationshipProperties
+      //(<requestparamCreateRel>)
+      //(</requestparamCreateRel>)
+    } = requestParams;
+
+    let errorsFound = [];
+
+    //(<beforeValidateCreateRel>)
+    //(</beforeValidateCreateRel>)
+    // 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, objects[0].objType, objects[0].identifiers);
+    await validateIdentifiersExists(_izContext, objects[1].objType, objects[1].identifiers);
+    // finished validate object and identifiers
+
+    //(<afterValidateCreateRel>)
+    //(</afterValidateCreateRel>)
+
+    //(<beforeGetRelCreateRel>)
+    //(</beforeGetRelCreateRel>)
+
+    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);
+              }
+            }));
+          }
+        })
+      );
+      //(<afterGetRelCreateRel>)
+      //(</afterGetRelCreateRel>)
+      _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.properties.hasOwnProperty(propKey)) {
+          errorsFound.push(`property:${propKey} not exists in relationshipSchema`);
+        }
+      }
+
+      // validate canCreate properties relationship
+      for (const [propName, propSetting] of Object.entries(relationshipSchema.properties)) {
+        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 createRelCompleteMsg = {
+        objects: objects,
+        relType: relType,
+        relationshipProperties: relationshipProperties,
+        //(<inCreateRelCompleteMsgCrateRel>)
+        //(</inCreateRelCompleteMsgCrateRel>)
+        status: 'error',
+        errorFounds: errorsFound
+      };
+
+      // if have callingFlow will send to message complete
+      if (callingFlowConfig[callingFlowSharedLib.consts.CALLINGFLOW_PROPERTYNAME]) {
+        _izContext.logger.debug("HAVE CallingFlow");
+
+        createRelCompleteMsg = callingFlowSharedLib.addPassBackPropertiesToSnsResponseMessageObject(callingFlowConfig, createRelCompleteMsg);
+        let messageAttributes = callingFlowSharedLib.addCallingFlowToSnsResponseMessageAttributes(callingFlowConfig, {});
+
+        let messageParams = {
+          Message: JSON.stringify(createRelCompleteMsg),
+          MessageAttributes: sns.createStringMessageAttributes(_izContext, messageAttributes),
+          TopicArn: await snsSharedLib.snsTopicArn(_izContext, TOPIC_NAME_GENERATE_CODE.outCreateRelComplete),
+        };
+
+        _izContext.logger.debug("messageParams OutCreateRelationshipComplete ::::::: ", messageParams);
+        await sns.publishAsync(_izContext, messageParams);
+      }
+
+      return createRelCompleteMsg;
+    }
+
+
+    // before create awaitingStepId per graph storageResource
+    const linkTypeId = createLinkTypeId(_izContext, [objects[0].objType, objects[1].objType], relType);
+
+    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.createRel // prefix, use constant further
+          )
+        );
+      }
+    }
+
+    /*
+      if have storageResource.storageType === "dynamoDB" will create relationship here
+    */
+
+
+    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.createRel // prefix, use constant further
+        )
+      );
+
+      // prepare message body
+      let updateRelMessageBody = {
+        objects: objects,
+        relType: relType,
+        relationshipProperties
+        //(<inUpdateRelMessageBodyCreateRel>)
+        //(</inUpdateRelMessageBodyCreateRel>)
+      }
+      _izContext.logger.debug('createRelMessageBody: ', 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.createRelComplete),
+                  {
+                    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.inCreateRel, 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 {
+      objects,
+      relType,
+      relationshipProperties,
+      errorFounds: errorsFound
+    };
+
+
+  } catch (err) {
+    _izContext.logger.error('error updateRelationship: ', err)
+    throw (err)
+  }
+}

package/src/TemplateManager/src/CreateRelationship/createRelationship/perAction/HdrApi/data.js

@@ -0,0 +1,58 @@
+/*
+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 } = 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) {
+  let functionName = "createRelationship";
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: upperCase(functionName) + "_" + upperCase(HANDLER.hdrApi),
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+
+module.exports = data;

package/src/TemplateManager/src/CreateRelationship/createRelationship/perAction/HdrApi/template.ejs

@@ -0,0 +1,120 @@
+/*
+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-shared/src/CallingFlowSharedLib')
+const {
+  validateSchemaMiddleware
+} = require('@izara_project/izara-market-library-service-schemas/src/GenerateCodeLibs/src/GenerateCodeLibs');
+
+const <%- functionName %> = require('./<%- firstLetterUpperCase(functionName) %>_Main');
+// validate event params in middleware before into function
+let validatorSchema = {
+  type: "object",
+  required: ["objects", "relId", "relType", "relationshipProperties"],
+  properties: {
+    objects: {
+      type: "array",
+      minItems: 2,
+      maxItems: 2,
+      Items: {
+        type: "object",
+        required: ["objType", "identifiers"],
+        properties: {
+          objType: {
+            type: "object",
+            required: ["serviceTag", "objectType"],
+            properties: {
+              serviceTag: izara.validatorSchema.stringNotEmpty(),
+              objectType: izara.validatorSchema.stringNotEmpty()
+            }
+          },
+          identifiers: {
+            type: "object",
+            minproperties: 1
+          }
+        }
+      }
+    },
+    relType: {
+      type: "object",
+      required: ["relationshipTag", "serviceTag"],
+      properties: {
+        relationshipTag: izara.validatorSchema.stringNotEmpty(),
+        serviceTag: {
+          type: 'string',
+          pattern: "^[a-zA-Z0-9_-]+$",
+          enum: [process.env.iz_serviceTag]
+        }
+      }
+    },
+    relId: izara.validatorSchema.stringNotEmpty(),
+    relationshipProperties: {
+      type: "object",
+      minProperties: 1
+    }
+  }
+};
+
+
+//(<globalVarible>
+//</globalVarible>)
+
+// validate event params in middleware before into main function
+validatorSchema = callingFlowSharedLib.addOptionalCallingFlowToValidatorSchema(validatorSchema);
+middleware.setValidatorSchema(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) => {
+  event._izContext.logger.debug('Event:', event);
+  try {
+    // invoke LambdaFunction
+    let lambdaFunctionResponse = await <%- functionName %>.<%- functionName %>(
+      event._izContext,       // correlationId/logger/integrationTestDetail/uniqueRequestId/userId
+      {
+        objects: event.objects,
+        relType: event.relType,
+        relId: event.relId,
+        relationshipProperties: event.relationshipProperties
+      }
+    );
+
+    // return error to client
+    if (lambdaFunctionResponse instanceof Error) {
+      return (izara.response.failure(lambdaFunctionResponse));
+    }
+
+    // return success to client
+    return (izara.response.success(lambdaFunctionResponse));
+
+  } catch (err) {
+    event._izContext.logger.error('Error, <%- functionName %>HdrApi: ', err);
+    return (izara.response.failure(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/TemplateManager/src/CreateRelationship/createRelationship/perAction/HdrDsq/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")
+
+/**
+ * create data for hdrInv template
+ *
+ * @return {{ templatePath, templateData, setting } }
+ */
+function data(_izContext, srcPath) {
+  const createSourceParams = createParamForCreateSource(srcPath)
+  return [createSourceParams];
+}
+
+
+function createParamForCreateSource(srcPath) {
+  let functionName = FUNCTION_NAME.createRel
+  let queueName = functionName + upperCase(HANDLER.hdrDsq)
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      queueName
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.relationshipPerAction),
+      saveFileName: upperCase(functionName) + "_" + upperCase(HANDLER.hdrDsq),
+      fileExtension: '.js',
+      isAppend: false
+    }
+  }
+}
+
+
+module.exports = data;