Product templates use forms

migrations/20190410_refactor_product_templates.sql

@@ -0,0 +1,6 @@
+--
+-- product_templates
+--
+ALTER TABLE product_templates ALTER COLUMN "template" DROP NOT NULL;
+
+ALTER TABLE product_templates ADD COLUMN "form" json;

postman.json

@@ -1,6 +1,6 @@
 {
 	"info": {
-		"_postman_id": "db83f8a1-5b3f-4276-a371-aa3c3497542d",
+		"_postman_id": "d9ea7b0f-1d2c-4d48-a693-fe7b51b1e2ea",
 		"name": "tc-project-service",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
 	},
@@ -3081,7 +3081,106 @@
 						],
 						"body": {
 							"mode": "raw",
-							"raw": "{\r\n      \"param\": {\r\n        \"name\": \"name 1\",\r\n        \"productKey\": \"productKey 1\",\r\n        \"category\": \"key1\",\r\n        \"icon\": \"http://example.com/icon1.ico\",\r\n        \"brief\": \"brief 1\",\r\n        \"details\": \"details 1\",\r\n        \"aliases\": [\"product key 1\", \"product_key_1\"],\r\n        \"template\": {\r\n          \"template1\": {\r\n            \"name\": \"template 1\",\r\n            \"details\": {\r\n              \"anyDetails\": \"any details 1\"\r\n            },\r\n            \"others\": [\"others 11\", \"others 12\"]\r\n          },\r\n          \"template2\": {\r\n            \"name\": \"template 2\",\r\n            \"details\": {\r\n              \"anyDetails\": \"any details 2\"\r\n            },\r\n            \"others\": [\"others 21\", \"others 22\"]\r\n          }\r\n        }\r\n      }\r\n    }"
+							"raw": "{\r\n  \"param\": {\r\n    \"name\": \"name 1\",\r\n    \"productKey\": \"productKey 1\",\r\n    \"category\": \"key1\",\r\n    \"icon\": \"http://example.com/icon1.ico\",\r\n    \"brief\": \"brief 1\",\r\n    \"details\": \"details 1\",\r\n    \"aliases\": [\"product key 1\", \"product_key_1\"],\r\n    \"template\": {\r\n      \"template1\": {\r\n        \"name\": \"template 1\",\r\n        \"details\": {\r\n          \"anyDetails\": \"any details 1\"\r\n        },\r\n        \"others\": [\"others 11\", \"others 12\"]\r\n      },\r\n      \"template2\": {\r\n        \"name\": \"template 2\",\r\n        \"details\": {\r\n          \"anyDetails\": \"any details 2\"\r\n        },\r\n        \"others\": [\"others 21\", \"others 22\"]\r\n      }\r\n    }\r\n  }\r\n}"
+						},
+						"url": {
+							"raw": "{{api-url}}/v4/projects/metadata/productTemplates",
+							"host": [
+								"{{api-url}}"
+							],
+							"path": [
+								"v4",
+								"projects",
+								"metadata",
+								"productTemplates"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Create product template with form",
+					"request": {
+						"method": "POST",
+						"header": [
+							{
+								"key": "Content-Type",
+								"value": "application/json"
+							},
+							{
+								"key": "Authorization",
+								"value": "Bearer {{jwt-token}}"
+							}
+						],
+						"body": {
+							"mode": "raw",
+							"raw": "{\r\n  \"param\": {\r\n    \"name\": \"name 1\",\r\n    \"productKey\": \"productKey 1\",\r\n    \"category\": \"key1\",\r\n    \"icon\": \"http://example.com/icon1.ico\",\r\n    \"brief\": \"brief 1\",\r\n    \"details\": \"details 1\",\r\n    \"aliases\": [\"product key 1\", \"product_key_1\"],\r\n    \"form\": {\r\n\t\t\"key\": \"dev\",\r\n\t\t\"version\": 1\r\n\t}\r\n  }\r\n}"
+						},
+						"url": {
+							"raw": "{{api-url}}/v4/projects/metadata/productTemplates",
+							"host": [
+								"{{api-url}}"
+							],
+							"path": [
+								"v4",
+								"projects",
+								"metadata",
+								"productTemplates"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Create product template with wrong form key",
+					"request": {
+						"method": "POST",
+						"header": [
+							{
+								"key": "Content-Type",
+								"value": "application/json"
+							},
+							{
+								"key": "Authorization",
+								"value": "Bearer {{jwt-token}}"
+							}
+						],
+						"body": {
+							"mode": "raw",
+							"raw": "{\r\n  \"param\": {\r\n    \"name\": \"name 1\",\r\n    \"productKey\": \"productKey 1\",\r\n    \"category\": \"key1\",\r\n    \"icon\": \"http://example.com/icon1.ico\",\r\n    \"brief\": \"brief 1\",\r\n    \"details\": \"details 1\",\r\n    \"aliases\": [\"product key 1\", \"product_key_1\"],\r\n    \"form\": {\r\n\t\t\"key\": \"wrong-key\"\r\n\t}\r\n  }\r\n}"
+						},
+						"url": {
+							"raw": "{{api-url}}/v4/projects/metadata/productTemplates",
+							"host": [
+								"{{api-url}}"
+							],
+							"path": [
+								"v4",
+								"projects",
+								"metadata",
+								"productTemplates"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Create product template with wrong model version",
+					"request": {
+						"method": "POST",
+						"header": [
+							{
+								"key": "Content-Type",
+								"value": "application/json"
+							},
+							{
+								"key": "Authorization",
+								"value": "Bearer {{jwt-token}}"
+							}
+						],
+						"body": {
+							"mode": "raw",
+							"raw": "{\r\n  \"param\": {\r\n    \"name\": \"name 1\",\r\n    \"productKey\": \"productKey 1\",\r\n    \"category\": \"key1\",\r\n    \"icon\": \"http://example.com/icon1.ico\",\r\n    \"brief\": \"brief 1\",\r\n    \"details\": \"details 1\",\r\n    \"aliases\": [\"product key 1\", \"product_key_1\"],\r\n    \"form\": {\r\n\t\t\"key\": \"dev\",\r\n\t\t\"version\": 1123\r\n\t}\r\n  }\r\n}"
 						},
 						"url": {
 							"raw": "{{api-url}}/v4/projects/metadata/productTemplates",
@@ -3232,6 +3331,117 @@
 						}
 					},
 					"response": []
+				},
+				{
+					"name": "Upgrade a product template with form",
+					"request": {
+						"method": "POST",
+						"header": [
+							{
+								"key": "Content-Type",
+								"value": "application/json",
+								"type": "text"
+							},
+							{
+								"key": "Authorization",
+								"value": "Bearer {{jwt-token}}",
+								"type": "text"
+							}
+						],
+						"body": {
+							"mode": "raw",
+							"raw": "{\r\n  \"param\":{\r\n    \"form\": {\r\n    \t\"key\": \"dev\",\t\r\n    \t\"version\": 2\r\n    }\r\n  }\r\n}"
+						},
+						"url": {
+							"raw": "{{api-url}}/v4/projects/metadata/productTemplates/2/upgrade",
+							"host": [
+								"{{api-url}}"
+							],
+							"path": [
+								"v4",
+								"projects",
+								"metadata",
+								"productTemplates",
+								"2",
+								"upgrade"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Upgrade a product template with wrong model version",
+					"request": {
+						"method": "POST",
+						"header": [
+							{
+								"key": "Content-Type",
+								"value": "application/json",
+								"type": "text"
+							},
+							{
+								"key": "Authorization",
+								"value": "Bearer {{jwt-token}}",
+								"type": "text"
+							}
+						],
+						"body": {
+							"mode": "raw",
+							"raw": "{\r\n  \"param\":{\r\n    \"form\": {\r\n    \t\"key\": \"dev\",\t\r\n    \t\"version\": 1234\r\n    }\r\n  }\r\n}"
+						},
+						"url": {
+							"raw": "{{api-url}}/v4/projects/metadata/productTemplates/1/upgrade",
+							"host": [
+								"{{api-url}}"
+							],
+							"path": [
+								"v4",
+								"projects",
+								"metadata",
+								"productTemplates",
+								"1",
+								"upgrade"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Upgrade a product template without define form",
+					"request": {
+						"method": "POST",
+						"header": [
+							{
+								"key": "Content-Type",
+								"value": "application/json",
+								"type": "text"
+							},
+							{
+								"key": "Authorization",
+								"value": "Bearer {{jwt-token}}",
+								"type": "text"
+							}
+						],
+						"body": {
+							"mode": "raw",
+							"raw": "{\r\n  \"param\":{ \r\n  }\r\n}"
+						},
+						"url": {
+							"raw": "{{api-url}}/v4/projects/metadata/productTemplates/3/upgrade",
+							"host": [
+								"{{api-url}}"
+							],
+							"path": [
+								"v4",
+								"projects",
+								"metadata",
+								"productTemplates",
+								"3",
+								"upgrade"
+							]
+						}
+					},
+					"response": []
 				}
 			]
 		},

src/models/productTemplate.js

@@ -14,7 +14,8 @@ module.exports = (sequelize, DataTypes) => {
     brief: { type: DataTypes.STRING(45), allowNull: false },
     details: { type: DataTypes.STRING(255), allowNull: false },
     aliases: { type: DataTypes.JSON, allowNull: false },
-    template: { type: DataTypes.JSON, allowNull: false },
+    template: { type: DataTypes.JSON, allowNull: true },
+    form: { type: DataTypes.JSON, allowNull: true },
     deletedAt: DataTypes.DATE,
     disabled: { type: DataTypes.BOOLEAN, defaultValue: false },
     hidden: { type: DataTypes.BOOLEAN, defaultValue: false },

src/permissions/index.js

@@ -35,6 +35,7 @@ module.exports = () => {
 
   Authorizer.setPolicy('productTemplate.create', projectAdmin);
   Authorizer.setPolicy('productTemplate.edit', projectAdmin);
+  Authorizer.setPolicy('productTemplate.upgrade', projectAdmin);
   Authorizer.setPolicy('productTemplate.delete', projectAdmin);
   Authorizer.setPolicy('projectTemplate.upgrade', projectAdmin);
   Authorizer.setPolicy('productTemplate.view', true);

src/routes/index.js

@@ -43,14 +43,16 @@ router.route('/v4/projects/metadata/productTemplates')
   .get(require('./productTemplates/list'));
 router.route('/v4/projects/metadata/productTemplates/:templateId(\\d+)')
   .get(require('./productTemplates/get'));
+router.route('/v4/projects/metadata/productTemplates/:templateId(\\d+)/upgrade')
+  .post(require('./productTemplates/upgrade'));
 
 router.route('/v4/projects/metadata/projectTypes')
   .get(require('./projectTypes/list'));
 router.route('/v4/projects/metadata/projectTypes/:key')
   .get(require('./projectTypes/get'));
 
 router.route('/v4/projects/metadata/projectTemplates/:templateId(\\d+)/upgrade')
-.post(require('./projectTemplates/upgrade'));
+  .post(require('./projectTemplates/upgrade'));
 
 router.route('/v4/projects/metadata/orgConfig')
   .get(require('./orgConfig/list'));

src/routes/metadata/list.js

@@ -30,27 +30,39 @@ function getUsedModel() {
     attributes: { exclude: ['deletedAt', 'deletedBy'] },
     raw: true,
   };
-  return models.ProjectTemplate.findAll(query)
-      .then((templates) => {
-        templates.forEach((template) => {
-          const { form, planConfig, priceConfig } = template;
-          if ((form) && (form.key) && (form.version)) {
-            modelUsed.form[form.key] = modelUsed.form[form.key] ? modelUsed.form[form.key] : {};
-            modelUsed.form[form.key][form.version] = true;
-          }
-          if ((priceConfig) && (priceConfig.key) && (priceConfig.version)) {
-            modelUsed.priceConfig[priceConfig.key] = modelUsed.priceConfig[priceConfig.key] ?
-              modelUsed.priceConfig[priceConfig.key] : {};
-            modelUsed.priceConfig[priceConfig.key][priceConfig.version] = true;
-          }
-          if ((planConfig) && (planConfig.key) && (planConfig.version)) {
-            modelUsed.planConfig[planConfig.key] = modelUsed.planConfig[planConfig.key] ?
-              modelUsed.planConfig[planConfig.key] : {};
-            modelUsed.planConfig[planConfig.key][planConfig.version] = true;
-          }
-        });
-        return Promise.resolve(modelUsed);
-      });
+
+  return Promise.all([
+    models.ProjectTemplate.findAll(query),
+    models.ProductTemplate.findAll(query),
+  ]).then(([projectTemplates, productTemplates]) => {
+    projectTemplates.forEach((template) => {
+      const { form, planConfig, priceConfig } = template;
+      if ((form) && (form.key) && (form.version)) {
+        modelUsed.form[form.key] = modelUsed.form[form.key] ? modelUsed.form[form.key] : {};
+        modelUsed.form[form.key][form.version] = true;
+      }
+      if ((priceConfig) && (priceConfig.key) && (priceConfig.version)) {
+        modelUsed.priceConfig[priceConfig.key] = modelUsed.priceConfig[priceConfig.key] ?
+          modelUsed.priceConfig[priceConfig.key] : {};
+        modelUsed.priceConfig[priceConfig.key][priceConfig.version] = true;
+      }
+      if ((planConfig) && (planConfig.key) && (planConfig.version)) {
+        modelUsed.planConfig[planConfig.key] = modelUsed.planConfig[planConfig.key] ?
+          modelUsed.planConfig[planConfig.key] : {};
+        modelUsed.planConfig[planConfig.key][planConfig.version] = true;
+      }
+    });
+
+    productTemplates.forEach((template) => {
+      const { form } = template;
+      if ((form) && (form.key) && (form.version)) {
+        modelUsed.form[form.key] = modelUsed.form[form.key] ? modelUsed.form[form.key] : {};
+        modelUsed.form[form.key][form.version] = true;
+      }
+    });
+
+    return Promise.resolve(modelUsed);
+  });
 }
 
 

src/routes/metadata/list.spec.js

@@ -38,7 +38,8 @@ const productTemplates = [
     brief: 'brief 1',
     details: 'details 1',
     aliases: {},
-    template: {},
+    form: { key: 'productKey 1', version: 1 },
+    template: null,
     createdBy: 1,
     updatedBy: 2,
   },
@@ -107,6 +108,30 @@ const forms = [
     createdBy: 1,
     updatedBy: 1,
   },
+  {
+    key: 'productKey 1',
+    config: {
+      questions: [{
+        id: 'appDefinition',
+        title: 'Sample Project',
+        required: true,
+        description: 'Please answer a few basic questions',
+        subSections: [{
+          id: 'projectName',
+          required: true,
+          validationError: 'Please provide a name for your project',
+          fieldName: 'name',
+          description: '',
+          title: 'Project Name',
+          type: 'project-name',
+        }],
+      }],
+    },
+    version: 2,
+    revision: 1,
+    createdBy: 1,
+    updatedBy: 1,
+  },
 ];
 const priceConfigs = [
   {
@@ -198,7 +223,7 @@ describe('GET all metadata', () => {
           resJson.milestoneTemplates.should.have.length(1);
           resJson.projectTypes.should.have.length(1);
           resJson.productCategories.should.have.length(1);
-          resJson.forms.should.have.length(1);
+          resJson.forms.should.have.length(2);
           resJson.planConfigs.should.have.length(1);
           resJson.priceConfigs.should.have.length(1);
 
@@ -225,7 +250,7 @@ describe('GET all metadata', () => {
           resJson.milestoneTemplates.should.have.length(1);
           resJson.projectTypes.should.have.length(1);
           resJson.productCategories.should.have.length(1);
-          resJson.forms.should.have.length(2);
+          resJson.forms.should.have.length(3);
           resJson.planConfigs.should.have.length(2);
           resJson.priceConfigs.should.have.length(2);
           done();