feat: update "project.terms" type to string

ref issue #614

Author: maxceem

docs/swagger.yaml

@@ -4939,8 +4939,7 @@ definitions:
       terms:
         type: array
         items:
-          type: number
-          format: integer
+          type: string
       external:
         type: object
         description: 'READ-ONLY, OPTIONAL. Refernce to external task/issue.'
@@ -5070,8 +5069,7 @@ definitions:
       terms:
         type: array
         items:
-          type: number
-          format: integer
+          type: string
       name:
         type: string
         description: project name
@@ -5254,7 +5252,7 @@ definitions:
       type:
         type: string
         description: The attachment type, one of 'link' or 'file'
-        enum: 
+        enum:
          - link
          - file
       tags:
@@ -6133,7 +6131,7 @@ definitions:
     type: array
     items:
       $ref: '#/definitions/Milestone'
-      
+
   MilestoneTemplateRequest:
     title: Milestone template request object
     type: object

migrations/20212201_project_terms_update_type.sql

@@ -0,0 +1,7 @@
+-- UPDATE EXISTING projects table
+--     modify column `terms`
+
+-- drop existent column first to avoid any issues during type convertion as we don't need the data if there is any
+ALTER TABLE projects DROP COLUMN "terms";
+-- now create a column with a new type
+ALTER TABLE projects ADD COLUMN "terms" character varying(255)[] NOT NULL DEFAULT ARRAY[]::character varying[]::character varying(255)[];

src/events/projects/index.js

@@ -102,7 +102,7 @@ const projectPayloadSchema = Joi.object().keys({
   id: Joi.number().integer().positive().required(),
   createdAt: Joi.date().required(),
   updatedAt: Joi.date().required(),
-  terms: Joi.array().items(Joi.number().positive()).optional(),
+  terms: Joi.array().items(Joi.string()).optional(),
   name: Joi.string().required(),
   description: Joi.string().allow(null).allow('').optional(),
   type: Joi.string().max(45).required(),

src/models/project.js

@@ -16,7 +16,7 @@ module.exports = function defineProject(sequelize, DataTypes) {
     estimatedPrice: { type: DataTypes.DECIMAL(10, 2), allowNull: true },
     actualPrice: { type: DataTypes.DECIMAL(10, 2), allowNull: true },
     terms: {
-      type: DataTypes.ARRAY(DataTypes.INTEGER),
+      type: DataTypes.ARRAY(DataTypes.STRING),
       allowNull: false,
       defaultValue: [],
     },

src/routes/projects/create.js

@@ -45,7 +45,7 @@ const createProjectValidations = {
     })).optional().allow(null),
     estimatedPrice: Joi.number().precision(2).positive().optional()
       .allow(null),
-    terms: Joi.array().items(Joi.number().positive()).optional(),
+    terms: Joi.array().items(Joi.string()).optional(),
     external: Joi.object().keys({
       id: Joi.string(),
       type: Joi.any().valid('github', 'jira', 'asana', 'other'),

src/routes/projects/update.js

@@ -46,7 +46,7 @@ const updateProjectValdiations = {
     status: Joi.any().valid(_.values(PROJECT_STATUS)),
     estimatedPrice: Joi.number().precision(2).positive().allow(null),
     actualPrice: Joi.number().precision(2).positive(),
-    terms: Joi.array().items(Joi.number().positive()),
+    terms: Joi.array().items(Joi.string()),
     external: Joi.object().keys({
       id: Joi.string(),
       type: Joi.any().valid('github', 'jira', 'asana', 'other'),

src/routes/projects/update.spec.js

@@ -983,7 +983,7 @@ describe('Project', () => {
             Authorization: `Bearer ${testUtil.jwts.admin}`,
           })
           .send({
-            terms: [1, 2, 3],
+            terms: ['1', '2', '3'],
           })
           .expect(200)
           .end((err) => {
@@ -996,7 +996,7 @@ describe('Project', () => {
                 createEventSpy.calledWith(BUS_API_EVENT.PROJECT_UPDATED, sinon.match({
                   resource: 'project',
                   id: project1.id,
-                  terms: [1, 2, 3],
+                  terms: ['1', '2', '3'],
                   updatedBy: testUtil.userIds.admin,
                 })).should.be.true;
 

src/utils/es-config.js

@@ -320,7 +320,7 @@ MAPPINGS[ES_PROJECT_INDEX] = {
       index: 'not_analyzed',
     },
     terms: {
-      type: 'integer',
+      type: 'string',
     },
     type: {
       type: 'string',