@izara_project/izara-market-library-service-schemas 1.0.1 → 1.0.2

package/src/TemplateManager/src/MainResourcesYaml/TemplateAndData/DynamoDbMain/Data/MainDynamoDbYamlData.js

@@ -0,0 +1,153 @@
+/*
+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 {
+//   HANDLER,
+// STORAGE_TYPES
+// } = require('@izara_project/izara-core-library-service-schemas/src/Consts');
+
+
+const STORAGE_TYPES = {
+  dynamoDB: "dynamoDB",
+  graph: "graph"
+}
+
+
+// ---------- End Per Lambda Handler IamRole Data ----------
+
+
+
+/**
+ * create data for dynamoDbYaml tempalte from objectSchema
+ * return array of dynamoDb data
+ * because one objectSchema can create multiple dynamoDb table
+ *
+ * @param {Object} _izContext
+ * @param {Object} objectSchema
+ * @returns {Object[]}              - data of multiple dynamoDb template
+ */
+function dataForMainDynamoDbYamlFromObjectSchema(_izContext, objectSchema) {
+  let dynamoDbYamlTemplateData = [];
+
+  // store detail for create dynamoDb table
+  let identifiersDetail = {};
+
+  // add identifiersDetail for dynamoDb storage
+  for (let identifier of objectSchema.identifiers) {
+    if (identifier.type === "partitionKey" || identifier.type === "sortKey") {
+      identifiersDetail[identifier.type] = {};
+
+      if (identifier.name) {
+        Object.assign(
+          identifiersDetail[identifier.type],
+          {
+            AttributeName: identifier.name,
+            AttributeType: "S"
+          }
+        );
+      } else {
+        let fieldNameType = objectSchema.fieldNames[identifier.fieldName].type;
+        let attributeType;
+
+        if (fieldNameType === "string") {
+          attributeType = "S"
+        } else if (fieldNameType === "number") {
+          attributeType = "N"
+        }
+
+        Object.assign(
+          identifiersDetail[identifier.type],
+          {
+            AttributeName: identifier.fieldName,
+            AttributeType: attributeType
+          }
+        );
+      }
+    }
+  }
+
+  if (!identifiersDetail.hasOwnProperty("partitionKey")) {
+    return [];
+  }
+
+
+  // start create dynamoDb template data
+  for (let storageResource of Object.values(objectSchema.storageResources)) {
+    if (storageResource.storageType === STORAGE_TYPES.dynamoDB) {
+      let templateData = {
+        tableName: storageResource.tableName,
+        attributes: []
+      };
+
+
+      if (storageResource.hasOwnProperty("groupByPartitionKeyField")) {
+        templateData.attributes.push(
+          {
+            keyType: "partitionKey",
+            AttributeName: storageResource.groupByPartitionKeyField,
+            AttributeType: "S"
+          }
+        );
+      } else {
+        for (let identifierType in identifiersDetail) {
+          templateData.attributes.push(
+            {
+              keyType: identifierType,
+              AttributeName: identifiersDetail[identifierType].AttributeName,
+              AttributeType: identifiersDetail[identifierType].AttributeType
+            }
+          );
+        }
+      }
+      dynamoDbYamlTemplateData.push(templateData);
+    }
+  }
+
+  return dynamoDbYamlTemplateData
+}
+
+
+// return array of table data
+// because one relSchema can create multiple dynamoDb table
+function dataForMainDynamoDbYamlFromRelSchema(_izContext, relSchema) {
+  let relTag = Object.keys(relSchema)[0];
+  let relData = relSchema[relTag];
+
+  for (let parents of relData.parents) {
+    let parentObjectType = parent.objType.objectType;
+
+
+  }
+
+  return
+}
+
+
+module.exports = {
+  dynamoDbMainYamlFromObjectSchema: {
+    templatePath: path.join(__dirname, '../Template/DynamoDb.ejs'),
+    templateDataFunction: dataForMainDynamoDbYamlFromObjectSchema
+  },
+  dynamoDbMainYamlFromRelSchema: {
+    templatePath: path.join(__dirname, '../Template/DynamoDb.ejs'),
+    templateDataFunction: dataForMainDynamoDbYamlFromRelSchema
+  },
+}

package/src/TemplateManager/src/MainResourcesYaml/TemplateAndData/DynamoDbMain/Template/DynamoDb.ejs

@@ -0,0 +1,31 @@
+  <%- tableName %>Table:
+    Type: "AWS::DynamoDB::Table"
+    Properties:
+      TableName: ${self:custom.iz_resourcePrefix}<%- tableName %>
+      AttributeDefinitions:
+        <%_ attributes.forEach((attribute) => { -%>
+        - AttributeName: <%- attribute["AttributeName"] %>
+          AttributeType: <%- attribute["AttributeType"] %>
+        <%_ }) _%>
+      KeySchema:
+        <%_ attributes.forEach((attribute) => { -%>
+        <%_ if(attribute.keyType === 'partitionKey') { -%>
+        - AttributeName: <%- attribute["AttributeName"] %>
+          KeyType: HASH
+        <%_ } -%>
+        <%_ if(attribute.keyType === 'sortKey') {  -%>
+        - AttributeName: <%- attribute["AttributeName"] %>
+          KeyType: RANGE
+        <%_ } -%>
+        <%_ }) _%>
+      ProvisionedThroughput:
+        ReadCapacityUnits: 1
+        WriteCapacityUnits: 1
+      #<#<%- firstLetterUpperCase(tableName) %>DynamoDbSetting#>
+      #<#/<%- firstLetterUpperCase(tableName) %>DynamoDbSetting#>
+<%_ 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/MainResourcesYaml/TemplateAndData/DynamoDbMain/Template/DynamoDb.exampleData.js

@@ -0,0 +1,12 @@
+// example template data for dynamoDb
+const templateData = {
+  tableName: "xx",
+  attributes: [
+    {
+      keyType: "xx", // partitionKey || sortKey
+      AttributeName: "", // any
+      AttributeType: "" // S, N, B
+    },
+    //...
+  ]
+}

package/src/TemplateManager/src/PerActionEndpoint/CreateSourceData.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 schemaConsts = require('@izara_project/izara-core-library-service-schemas/src/Consts');
+
+const consts = require('../libs/Consts')
+
+
+const lambdaYaml = require("./TemplateAndData/ResourceYaml/Lambda/Data/LambdaYamlData")
+
+
+/**
+ * receive objectSchema
+ *
+ * return array of object for function createSource
+ * eg:
+ *     [
+ *       { // main function
+ *          templatePath:"path of template",
+ *          data: "data of template",
+ *          setting: "setting of createSourceFunction"
+ *       },
+ *       // ... data of hdr, resource ...etc.
+ *     ]
+ *
+ *
+ *
+ * @param {Object} _izContext
+ * @param {Object} objectSchema
+ */
+module.exports.createSourceDataObjectSchema = (_izContext, objectSchema, saveFilePath) => {
+
+  let resultsForCreateSource = [];
+  /*
+     receive objectSchema
+
+     check setting of overwrite main function
+     if not exists will create new main function
+
+     check overWriteHandlers
+     create handler depend on overWriteHandlers setting or default setting
+       - create lambda Yaml depend on handler
+       - add dynamodb iam role to lambda iam role
+  */
+
+  // create main function per action
+  for (let action of Object.values(consts.ACTIONS)) {
+    console.log("action: ", action);
+
+    let overWriteMainFunction = (objectSchema.overwriteGeneratedMainFunction && Array.isArray(objectSchema.overwriteGeneratedMainFunction))
+      ? objectSchema.overwriteGeneratedMainFunction : [];
+
+    // avoid generate main function
+    if (overWriteMainFunction.includes(action)) {
+      continue;
+    }
+
+    // -> start generate main function Per action here
+  }
+
+
+  // create handler and iam role of handler per action
+  for (let [action, handlerList] of Object.entries(consts.DEFAULT_HANDLER_PER_ACTION)) {
+
+    let useHandler = (objectSchema.overWriteHandlers && objectSchema.overWriteHandlers[action])
+      ? objectSchema.overWriteHandlers[action]
+      : handlerList;
+
+    console.log("useHandler: ", useHandler);
+
+
+    // start to create handler
+    // if overWriteHandlers[action] is empty array will not create handler
+    for (let hdr of useHandler) {
+      // -> create handler here
+
+      // -> create iam role of handler here
+      resultsForCreateSource.push({
+        templatePath: lambdaYaml[hdr].templatePath,
+        templateData: lambdaYaml[hdr].templateDataFunction(_izContext, objectSchema, action),
+        setting: {
+          savePath: path.join(saveFilePath, consts.SOURCE_PATH.appYaml),
+          saveFileName: 'generate-function',
+          fileExtension: '.yml',
+          isAppend: true
+        }
+      });
+
+      // -> create sns sqs here
+      // -> ideas for below
+      // resultsForCreateSource.push({
+      //   templatePath: "xx",
+      //   templateData: "xx",
+      //   setting: {
+      //     savePath: path.join(saveFilePath, config.SOURCE_PATH.appYaml),
+      //     saveFileName: 'sns-in-sqs',
+      //     fileExtension: '.yml',
+      //     isAppend: true
+      //   }
+      // });
+
+    }
+  }
+
+
+
+  // create resource for handler
+
+  // create resource for all handler, eg: dynamo
+
+
+  return resultsForCreateSource;
+}

package/src/TemplateManager/src/PerActionEndpoint/TemplateAndData/MainFunction/MainFunctionTemplate/Create.js

@@ -0,0 +1,18 @@
+/*
+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';

package/src/TemplateManager/src/PerActionEndpoint/TemplateAndData/MainFunction/MainFunctionTemplate/Delete.js

@@ -0,0 +1,18 @@
+/*
+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';

package/src/TemplateManager/src/PerActionEndpoint/TemplateAndData/MainFunction/MainFunctionTemplate/Get.js

@@ -0,0 +1,18 @@
+/*
+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';

package/src/TemplateManager/src/PerActionEndpoint/TemplateAndData/MainFunction/MainFunctionTemplate/Update.js

@@ -0,0 +1,18 @@
+/*
+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';

package/src/TemplateManager/src/PerActionEndpoint/TemplateAndData/ResourceYaml/Lambda/Data/LambdaYamlData.js

@@ -0,0 +1,166 @@
+/*
+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 {
+//   HANDLER
+// } = require('@izara_project/izara-core-library-service-schemas/src/Consts');
+
+const {
+  createIamRole,
+  resourceNames,
+  RESOURCE_CLASSES,
+  DEFAULT_HANDLER_PER_ACTION
+} = require("../../../../../libs/Consts");
+
+const {
+  firstLetterLowerCase,
+  firstLetterUpperCase
+} = require("../../../../../../../MainLibs/src/Utils");
+
+const defaultGeneratedLambdaLocation = "src/generatedCode/lambdaPerObjectType/source/"
+
+const HANDLER = { // mock
+  hdrApi: "hdrApi",
+  hdrInv: "hdrInv",
+  hdrDsq: "hdrDsq",
+  hdrSqs: "hdrSqs"
+}
+
+const STORAGE_TYPES = {
+  dynamoDB: "dynamoDB",
+  graph: "graph"
+}
+
+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
+}
+
+// ---------- Per Lambda Handler IamRole Data ----------
+
+function lambdaIamRoleForHdrInv(_izContext, objectSchema, action) {
+  console.log("lambdaIamRoleForHdrInv");
+  console.log("action: ", action);
+
+  // add lambda role
+
+  let additionalResourcePermission = defaultIamRolePerAction();
+
+  let hasGraphStorage = false;
+  for (let storageResource of Object.values(objectSchema.storageResources)) {
+    if (storageResource.storageType === STORAGE_TYPES.dynamoDB) {
+      // add IamRole for dynamodb depend on tableName in storageResources of objectSchema
+      additionalResourcePermission.push(
+        createIamRole(
+          { [RESOURCE_CLASSES.dynamoDbTable]: [DEFAULT_HANDLER_PER_ACTION[action].dynamoDbPermission] },
+          [resourceNames(RESOURCE_CLASSES.dynamoDbTable, storageResource.tableName)]
+        )
+      );
+    } else if (storageResource.storageType === STORAGE_TYPES.graph) {
+      // find graph serviceName from graphServerTag or *GetNodeHdrInv ?
+
+      if (hasGraphStorage) {
+        continue;
+      } else {
+        hasGraphStorage = true;
+      }
+
+      additionalResourcePermission.push(
+        createIamRole(
+          { [RESOURCE_CLASSES.lambda]: ["InvokeFunction"] },
+          [resourceNames(RESOURCE_CLASSES.lambda, "*GetNodeHdrInv")]
+        )
+      );
+    }
+  }
+
+  // finished add lambda role
+
+
+  return {
+    resourceName: `${objectSchema.objectType}${firstLetterUpperCase(action)}`,
+    handlerType: HANDLER.hdrInv,
+    resourceLocation: `${path.join(defaultGeneratedLambdaLocation, objectSchema.objectType)}`,
+    additionalResourcePermission
+  }
+}
+
+function lambdaIamRoleForHdrApi(_izContext, objectSchema, action) {
+  console.log("lambdaIamRoleForHdrApi");
+  console.log("action: ", action);
+
+}
+
+
+function lambdaIamRoleForHdrSqs(_izContext, objectSchema, action) {
+  console.log("lambdaIamRoleForHdrSqs");
+  console.log("action: ", action);
+}
+
+
+function lambdaIamRoleForHdrDsq(_izContext, objectSchema, action) {
+  console.log("lambdaIamRoleForHdrDsq");
+  console.log("action: ", action);
+
+}
+
+// ---------- End Per Lambda Handler IamRole Data ----------
+module.exports = {
+  [HANDLER.hdrInv]: {
+    templatePath: path.join(__dirname, "../Template/HdrInv.ejs"),
+    templateDataFunction: lambdaIamRoleForHdrInv
+  },
+  [HANDLER.hdrApi]: {
+    templatePath: path.join(__dirname, "../Template/HdrApi.ejs"),
+    templateDataFunction: lambdaIamRoleForHdrApi
+  },
+  [HANDLER.hdrSqs]: {
+    templatePath: path.join(__dirname, "../Template/HdrSqs.ejs"),
+    templateDataFunction: lambdaIamRoleForHdrSqs
+  },
+  [HANDLER.hdrDsq]: {
+    templatePath: path.join(__dirname, "../Template/HdrDsq.ejs"),
+    templateDataFunction: lambdaIamRoleForHdrDsq
+  }
+}

package/src/TemplateManager/src/PerActionEndpoint/TemplateAndData/ResourceYaml/Lambda/Template/HdrInv.ejs

@@ -0,0 +1,26 @@
+<%_ const join = require('path').join; _%>
+<%- firstLetterUpperCase(resourceName) %><%- firstLetterUpperCase(handlerType) %>:
+  handler: <%- join(resourceLocation, `${firstLetterUpperCase(resourceName)}_${firstLetterUpperCase(handlerType)}.main`)%>
+  name: ${self:custom.iz_resourcePrefix}<%- firstLetterUpperCase(resourceName) %><%- firstLetterUpperCase(handlerType) %>
+  iamRoleStatements:
+    <%_ additionalResourcePermission.forEach(resourcePermission => { _%>
+    - Effect: <%- resourcePermission.effect %>
+      Action:
+        <%_ Object.keys(resourcePermission.action).forEach(resourcePerAction => { _%>
+        <%_ resourcePermission.action[resourcePerAction].forEach(permission => { _%>
+        - <%- resourcePerAction %>:<%- permission %>
+        <%_}) _%>
+        <%_ }) _%>
+      Resource:
+        <%_ resourcePermission.resource.forEach(resource => { _%>
+        - <%- resource %>
+        <%_ }) _%>
+    <%_}) _%>
+    #<#<%- resourceName %><%- handlerType %>IamRole#>
+    #<#/<%- resourceName %><%- handlerType %>IamRole#>
+<%_ 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/PerActionEndpoint/TemplateAndData/ResourceYaml/Lambda/Template/HdrInv.exampleData.js

@@ -0,0 +1,15 @@
+// example template data
+const templateData = {
+  resourceName: "xx",
+  handlerType: "xx",
+  resourceLocation: "xx",
+  additionalResourcePermission: [
+    {
+      effect: "xx",
+      action: {
+        sqs: ["sendMessage", "receiveMessage"],
+      },
+      resource: ["aws:sqs", "..."]
+    }
+  ]
+}