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

package/src/generators/fromObjectSchema/endpoint/yaml.js

@@ -0,0 +1,308 @@
+/*
+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/>.
+*/
+
+// yaml data.js
+import path from 'path';
+import { fileURLToPath } from 'url';
+import fs from 'fs';
+import yaml from 'yaml';
+import { objectHash as hash } from '@izara_project/izara-shared-core';
+import consts from '#libs/Consts.js';
+import utils from '#libs/Utils.js';
+import libs from '#libs/Libs.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const {
+  ACTIONS,
+  HANDLER,
+  STORAGE_TYPES,
+  RESOURCE_CLASSES,
+  SOURCE_PATH,
+  SAVE_FILE_NAME,
+  DYNAMO_RESOURCE,
+  SNS_RESOURCE,
+  FUNCTION_NAME,
+  SOURCE_GENERATE_IAM_ROLE,
+  SQS_RESOURCE
+} = consts;
+
+const {
+  createIamRole,
+  resourceNames,
+  defaultIamRolePerAction,
+  awaitingMultipleStepsRole,
+  shortNameHandler,
+  getStorageResourceFromObjectSchemas,
+  externalResourceYaml
+} = libs;
+
+const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } =
+  utils;
+
+const templatePath = path.join(__dirname, 'yamlTemplate.ejs');
+
+const HTTP_METHOD = {
+  create: 'put',
+  update: 'post',
+  get: 'post',
+  delete: 'delete'
+};
+
+/**
+ * Generates yaml source params for a given action and handler
+ * @param {Object} _izContext - Context object with logger
+ * @param {Array} allObjSchemas - All object schemas
+ * @param {string} appPath - Source path
+ * @param {string} action - Action name (create/update/get/delete)
+ * @param {string} handler - Handler type (hdrApi/hdrSqs/hdrDsq/hdrInv)
+ * @param {string|null} functionNameConfig - Override for yaml key (null = derive from action+handler)
+ * @param {string} handlerSuffix - Suffix for fnName across all fields (e.g. 'BeforeLogical')
+ * @returns {Promise<Array>} Array containing source param object
+ */
+async function data(
+  _izContext,
+  allObjSchemas,
+  appPath,
+  action,
+  handler,
+  handlerSuffix = '',
+  flowTags = []
+) {
+  // ── Resolve names ─────────────────────────────────────────────────────────
+  const shortName = shortNameHandler(handler) || handler;
+
+  const fnName = upperCase(action) + handlerSuffix + upperCase(handler);
+  const fnConfig = upperCase(action) + handlerSuffix + upperCase(shortName);
+  const fileName = upperCase(action) + handlerSuffix + '_' + upperCase(handler);
+
+  // ── IAM base permissions ──────────────────────────────────────────────────
+  const additionalResourcePermission = defaultIamRolePerAction();
+
+  // ── DynamoDB permissions ──────────────────────────────────────────────────
+  const { resourceDynamoTableName } = await getStorageResourceFromObjectSchemas(
+    _izContext,
+    allObjSchemas
+  );
+  if (resourceDynamoTableName.length) {
+    additionalResourcePermission.push(
+      createIamRole(
+        { [RESOURCE_CLASSES.dynamoDbTable]: Object.values(DYNAMO_RESOURCE) },
+        resourceDynamoTableName.map(tableName =>
+          resourceNames(RESOURCE_CLASSES.dynamoDbTable, upperCase(tableName))
+        )
+      )
+    );
+  }
+
+  // ── Event ─────────────────────────────────────────────────────────────────
+  let event;
+  if (handler === HANDLER.hdrSqs || handler === HANDLER.hdrDsq) {
+    event = resourceNames(RESOURCE_CLASSES.sqs, fnName);
+  }
+
+  // ── Awaiting + SNS out permissions ────────────────────────────────────────
+  additionalResourcePermission.push(
+    awaitingMultipleStepsRole(),
+    createIamRole({ [RESOURCE_CLASSES.sns]: SNS_RESOURCE.publish }, [
+      resourceNames(
+        RESOURCE_CLASSES.sns,
+        upperCase(FUNCTION_NAME.createObjectComplete) + '_Out'
+      ),
+      resourceNames(
+        RESOURCE_CLASSES.sns,
+        upperCase(FUNCTION_NAME.updateNodeComplete) + '_Out'
+      ),
+      resourceNames(
+        RESOURCE_CLASSES.sns,
+        upperCase(FUNCTION_NAME.deleteNodeComplete) + '_Out'
+      ),
+      resourceNames(
+        RESOURCE_CLASSES.sns,
+        upperCase(FUNCTION_NAME.getNodeComplete) + '_Out'
+      )
+    ])
+  );
+
+  // ── SQS permissions ───────────────────────────────────────────────────────
+  if (handler === HANDLER.hdrSqs || handler === HANDLER.hdrDsq) {
+    additionalResourcePermission.push(
+      createIamRole(
+        {
+          [RESOURCE_CLASSES.sqs]: [
+            SQS_RESOURCE.receiveMessage,
+            SQS_RESOURCE.sendMessage,
+            SQS_RESOURCE.deleteMessage,
+            SQS_RESOURCE.getQueueAttributes
+          ]
+        },
+        [
+          resourceNames(RESOURCE_CLASSES.sqs, fnName),
+          resourceNames(RESOURCE_CLASSES.sqs, fnName + 'DLQ')
+        ]
+      )
+    );
+
+    if (flowTags.length > 0) {
+      const resourceTopicIn = flowTags.map(tag =>
+        resourceNames(RESOURCE_CLASSES.sns, upperCase(tag) + '_In')
+      );
+      const resourceTopicOut = flowTags.map(tag =>
+        resourceNames(RESOURCE_CLASSES.sns, upperCase(tag) + '_Out')
+      );
+
+      additionalResourcePermission.push(
+        createIamRole(
+          {
+            [RESOURCE_CLASSES.sns]: SNS_RESOURCE.publish
+          },
+          resourceTopicIn
+        )
+      );
+
+      additionalResourcePermission.push(
+        createIamRole(
+          {
+            [RESOURCE_CLASSES.sns]: SNS_RESOURCE.subscribe
+          },
+          resourceTopicOut
+        )
+      );
+    }
+  }
+
+  // ── Service config ────────────────────────────────────────────────────────
+  const configPath = path.join(appPath, '../config/serverless.config.yml');
+
+  // console.debug('###### configPath:', configPath);
+  const ownServiceTag = yaml.parse(fs.readFileSync(configPath, 'utf8'))
+    .main_config.iz_serviceTag;
+
+  // ── Parent tables + external topics ──────────────────────────────────────
+  const parentTables = [];
+  const seenExternalTags = new Set();
+  const externalTopicComponents = [];
+
+  for (const objectSchema of allObjSchemas) {
+    for (const storageResource of Object.values(
+      objectSchema.storageResources
+    )) {
+      if (storageResource.storageType === STORAGE_TYPES.dynamoDB) {
+        if (
+          objectSchema.hasOwnProperty('extendObjType') &&
+          storageResource.serviceTag &&
+          storageResource.serviceTag !== ownServiceTag
+        ) {
+          parentTables.push({
+            tableName: upperCase(storageResource.tableName),
+            serviceTag: upperCase(storageResource.serviceTag)
+          });
+        }
+      }
+      if (storageResource.storageType === STORAGE_TYPES.externalTopic) {
+        const uniqueTag = hash({
+          accountId: storageResource.accountId,
+          region: storageResource.region,
+          serviceTag: storageResource.serviceTag,
+          stage: storageResource.stage
+        });
+        if (!seenExternalTags.has(uniqueTag)) {
+          seenExternalTags.add(uniqueTag);
+          externalTopicComponents.push({
+            accountId: storageResource.accountId,
+            region: storageResource.region,
+            serviceTag: storageResource.serviceTag,
+            stage: storageResource.stage
+          });
+        }
+      }
+    }
+  }
+
+  if (parentTables.length) {
+    additionalResourcePermission.push(
+      createIamRole(
+        { [RESOURCE_CLASSES.dynamoDbTable]: Object.values(DYNAMO_RESOURCE) },
+        parentTables.map(t =>
+          externalResourceYaml(
+            RESOURCE_CLASSES.dynamoDbAcrossService,
+            upperCase(t.tableName),
+            t.serviceTag
+          )
+        )
+      )
+    );
+  }
+
+  // ── Resource APIs ─────────────────────────────────────────────────────────
+  const resourceApis =
+    handler === HANDLER.hdrApi
+      ? allObjSchemas.map(objectSchema => ({
+        event: lowerCase(objectSchema.objectType),
+        method: HTTP_METHOD[action]
+      }))
+      : [];
+
+  // ── External topic SNS permissions (create only) ──────────────────────────
+  if (action === ACTIONS.create && externalTopicComponents.length) {
+    externalTopicComponents.forEach(
+      ({ region, accountId, serviceTag, stage }) => {
+        additionalResourcePermission.push(
+          createIamRole({ [RESOURCE_CLASSES.sns]: [SNS_RESOURCE.publish] }, [
+            `arn:aws:sns:${region}:${accountId}:${serviceTag}_${stage}_Create_In`
+          ])
+        );
+      }
+    );
+  }
+
+  return [
+    {
+      templatePath,
+      templateData: {
+        functionNameConfig: fnConfig,
+        handlerPath: path.join(
+          SOURCE_PATH.resourceLocationHandlerEndpointPerService,
+          `${fileName}.main`
+        ),
+        resourcePrefix: '${self:custom.iz_resourcePrefix}',
+        functionName: fnName,
+        roleName: upperCase(SOURCE_GENERATE_IAM_ROLE.PerActionEndpoint),
+        hookTagSetting: `${fnName}FunctionSetting`,
+        handlerType: handler,
+        event,
+        additionalResourcePermission,
+        resourceApis: resourceApis.map(api => ({
+          path: `/${ownServiceTag}/${api.event}/${action}`,
+          pathWithUser: `/${ownServiceTag}/${api.event}/${action}/{targetUserId}`,
+          method: api.method,
+          hookTagApp: `${upperCase(api.event)}${upperCase(handler)}AppLevelAuthorizer`,
+          hookTagUser: `${upperCase(api.event)}${upperCase(handler)}UserLevelAuthorizer`
+        }))
+      },
+      setting: {
+        savePath: path.join(appPath, SOURCE_PATH.appYaml),
+        saveFileName: SAVE_FILE_NAME.functionPerActionYaml,
+        fileExtension: '.yml',
+        isAppend: true
+      }
+    }
+  ];
+}
+
+export default data;

package/src/generators/fromObjectSchema/endpointComplete/create/handler/handler.js

@@ -0,0 +1,63 @@
+/*
+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 { HANDLER, 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
+ *
+ * @return {{ templatePath, templateData, setting } }
+ */
+function data(_izContext, srcPath) {
+  const createSourceParams = createParamForCreateSource(srcPath);
+  return [createSourceParams];
+}
+
+function createParamForCreateSource(srcPath) {
+  const functionName = FUNCTION_NAME.createObjectComplete;
+
+  return {
+    templatePath: templatePath,
+    templateData: {
+      functionName,
+      queueName: upperCase(functionName),
+      functionName,
+      upperFunctionName: upperCase(functionName)
+    },
+    setting: {
+      savePath: path.join(srcPath, SOURCE_PATH.outPerActionComplete),
+      saveFileName: `${upperCase(functionName)}_${upperCase(HANDLER.hdrSqs)}`,
+      fileExtension: '.js',
+      isAppend: false
+    }
+  };
+}
+
+export default data;

package/src/generators/fromObjectSchema/endpointComplete/create/mainFunction/template.ejs

@@ -0,0 +1,302 @@
+/*
+Copyright (C) 2021 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 asyncFlowSharedLib from '@izara_project/izara-core-library-asynchronous-flow';
+import callingFlowSharedLib from '@izara_project/izara-core-library-calling-flow';
+import dynamodbSharedLib from '@izara_project/izara-core-library-dynamodb';
+import snsSharedLib from '@izara_project/izara-core-library-sns';
+import { sns } from '@izara_project/izara-core-library-external-request';
+import { objectHash as hash } from '@izara_project/izara-shared-core';
+import { consts } from '@izara_project/izara-core-library-service-schemas';
+import { NoRetryError } from '@izara_project/izara-core-library-core';
+
+const { TOPIC_NAME_GENERATE_CODE } = consts;
+const PREFIX = {
+  CREATE_OBJECT_ASYNC: 'createObjectAsyncEndpoint',
+  CREATE_OBJECT_ASYNC_COMPLETE: 'createObjectAsyncEndpointComplete',
+};
+
+//(<optionalRequire>)
+//(</optionalRequire>)
+
+/**
+ * @param {*} returnValue
+ * @param {*} status
+ * @param {*} graphServiceTag
+ * @param {*} errorsFound
+ */
+function validateInput(returnValue, status, graphServiceTag, errorsFound) {
+  if (!Object.prototype.hasOwnProperty.call(returnValue, 'queryResult')) {
+    errorsFound.push(
+      'message is not have property queryResult, should be not happen',
+    );
+  }
+  if (
+    !Object.prototype.hasOwnProperty.call(returnValue.requestParams, 'objType')
+  ) {
+    errorsFound.push(
+      'message is not have property objType, should be not happen',
+    );
+  }
+  if (
+    !Object.prototype.hasOwnProperty.call(
+      returnValue.requestParams,
+      'objInstanceFull',
+    )
+  ) {
+    errorsFound.push(
+      'message is not have property objInstance, should be not objInstance',
+    );
+  }
+
+  if (status == 'error' && errorsFound.length > 0) {
+    errorsFound.push('error before validate');
+  } else if (status == 'error' && errorsFound.length == 0) {
+    errorsFound.push(
+      '[invalid]status is error not have errorsFound form graphService',
+    );
+  }
+  if (status === 'complete' && errorsFound.length > 0) {
+    errorsFound.push(
+      '[Invalid] status is complete should be not have errorsFound',
+    );
+  }
+  if (graphServiceTag == null) {
+    errorsFound.push('[Invalid] graphServerTag is not empty string');
+  }
+}
+
+/**
+ * @param {*} value
+ */
+function isEmpty(value) {
+  if (value == null) return true;
+
+  if (
+    Array.isArray(value) ||
+    typeof value === 'string'
+  ) {
+    return value.length === 0;
+  }
+
+  if (value instanceof Map || value instanceof Set) {
+    return value.size === 0;
+  }
+
+  if (typeof value === 'object') {
+    return Object.keys(value).length === 0;
+  }
+
+  return false;
+}
+
+/**
+ * @param {*} returnValue
+ * @returns {object|null}
+ */
+function buildExistsNode(returnValue) {
+  const { existsNode } = returnValue.queryResult.returnCreateNode;
+  if (!Object.keys(existsNode).length) return null;
+
+  const { objType } = returnValue.requestParams;
+  return {
+    objType: {
+      objectType: objType.objectType,
+      serviceTag: objType.serviceTag,
+    },
+    objInstanceFull: existsNode.objInstanceFull,
+  };
+}
+
+/**
+ * @param {*} returnValue
+ * @param {*} existsNode
+ * @param {*} status
+ * @param {*} errorsFound
+ * @returns {object}
+ */
+function buildMessageObject(returnValue, existsNode, status, errorsFound) {
+  const { objType } = returnValue.requestParams;
+  const { returnCreateNode } = returnValue.queryResult;
+
+  return {
+    objType: {
+      objectType: objType.objectType,
+      serviceTag: objType.serviceTag,
+    },
+    objInstanceFull: returnCreateNode.objInstanceFull,
+    relationships: returnCreateNode.relationships,
+    parentFlowId: returnValue.parentFlowId,
+    existsNode,
+    status,
+    errorsFound,
+  };
+}
+
+/**
+ * @param {*} _izContext
+ * @param {*} passBackProperties
+ * @param {*} messageObject
+ */
+async function sendSnsMessage(_izContext, passBackProperties, messageObject) {
+  const enrichedMessage =
+    callingFlowSharedLib.addParentPassBackPropertiesToSnsResponseMessageObject(
+      passBackProperties,
+      messageObject,
+    );
+  const messageAttributes =
+    callingFlowSharedLib.addParentPassBackCallingFlowToSnsResponseMessageAttributes(
+      passBackProperties,
+      {},
+    );
+
+  const snsPayload = {
+    Message: JSON.stringify(enrichedMessage),
+    MessageAttributes: sns.createStringMessageAttributes(
+      _izContext,
+      messageAttributes,
+    ),
+    TopicArn: await snsSharedLib.snsTopicArnByFlowSchema(
+      _izContext,
+      TOPIC_NAME_GENERATE_CODE.outCreateNodeComplete,
+    ),
+  };
+
+  _izContext.logger.debug(
+    'Send message to OutCreateObjectComplete :::>',
+    snsPayload,
+  );
+  await sns.publishAsync(_izContext, snsPayload);
+}
+
+/**
+ * @param {*} _izContext
+ * @param {*} returnValue
+ * @param {*} status
+ * @param {*} errorsFound
+ * @param {*} graphServiceTag
+ * @param {*} passBackProperties
+ */
+export default async function createObjectComplete(
+  _izContext,
+  returnValue,
+  status,
+  errorsFound,
+  graphServiceTag,
+  passBackProperties,
+) {
+  try {
+    _izContext.logger.debug('function createObjectComplete:', {
+      returnValue,
+      status,
+      errorsFound,
+      graphServiceTag,
+      passBackProperties,
+    });
+
+    if (isEmpty(returnValue.requestParams)) {
+      _izContext.logger.debug('message callingFlowProperties is empty');
+      throw new NoRetryError('message not an object');
+    }
+
+    validateInput(returnValue, status, graphServiceTag, errorsFound);
+
+    if (errorsFound.length > 0) {
+      _izContext.logger.debug('Have error form graphServerTag:', errorsFound);
+      errorsFound.push(errorsFound.join(','));
+    }
+
+    const existsNode = buildExistsNode(returnValue);
+
+    const { requestParams } = returnValue;
+    const awaitingStepId = await asyncFlowSharedLib.createAwaitingStepId(
+      returnValue.parentFlowId,
+      PREFIX.CREATE_OBJECT_ASYNC,
+    );
+    _izContext.logger.debug('awaitingStepId:', awaitingStepId);
+
+    const recordAwaitingSteps = await dynamodbSharedLib.query(
+      _izContext,
+      await dynamodbSharedLib.tableName(_izContext, 'AwaitingMultipleSteps'),
+      { awaitingStepId },
+    );
+    _izContext.logger.debug('record awaitingSteps::', recordAwaitingSteps);
+
+    await Promise.all(
+      recordAwaitingSteps.Items.map(async (recordAwaitingStep) => {
+        if (
+          await asyncFlowSharedLib.checkAllAwaitingStepsFinished(
+            _izContext,
+            recordAwaitingStep.pendingStepId,
+            awaitingStepId,
+            errorsFound,
+          )
+        ) {
+          _izContext.logger.debug('finish all awaitingStep');
+
+          await Promise.all(
+            recordAwaitingStep.listOfRecords.map(async (listOfRecords) => {
+              if (status ===  'complete') {
+              Object.entries(listOfRecords).map(async ([_, record]) => {
+                await dynamodbSharedLib.putItem(
+                  _izContext,
+                  dynamodbSharedLib.tableName(_izContext,
+                    record.tableName,
+                    record.serviceTag
+                  ),
+                  {
+                    ...record.objInstanceFull.identifiers,
+                    ...record.objInstanceFull.fields
+                  }
+                );
+              })
+            }
+            }))
+
+          const messageObject = buildMessageObject(
+            returnValue,
+            existsNode,
+            status,
+            errorsFound,
+          );
+
+          //(<beforeSendMessage>)
+          //(</beforeSendMessage>)
+
+          await sendSnsMessage(_izContext, passBackProperties, messageObject);
+
+          //(<afterSendMessage>)
+          //(</afterSendMessage>)
+        }
+
+        await asyncFlowSharedLib.removeAwaitingMultipleStep(
+          _izContext,
+          awaitingStepId,
+          pendingStepId,
+          errorsFound,
+        );
+      }),
+    );
+
+    //(<beforeReturn>)
+    //(</beforeReturn>)
+    return { returnValue, status, errorsFound };
+  } catch (err) {
+    _izContext.logger.error('createObjectComplete error:', err);
+    throw err;
+  }
+}