@outliant/sunrise-utils 1.0.10 → 1.1.0

package/CHANGELOG.md

@@ -4,9 +4,25 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [1.1.0](https://github.com/outliant/sunrise-utils/compare/1.0.11...1.1.0)
+
+- chore: support task age color #860q9c397 [`50d79a7`](https://github.com/outliant/sunrise-utils/commit/50d79a78e309c70d7eac0f5533686bd65c1167a7)
+
+#### [1.0.11](https://github.com/outliant/sunrise-utils/compare/1.0.10...1.0.11)
+
+> 31 March 2023
+
+- (task/additional date filters #860q65z6h [`#4`](https://github.com/outliant/sunrise-utils/pull/4)
+- chore: add last n  days [`bb2f94a`](https://github.com/outliant/sunrise-utils/commit/bb2f94aade4ed11845ca29cf7f9b970cac51ae42)
+- chore: add new filters for task [`3fa42e5`](https://github.com/outliant/sunrise-utils/commit/3fa42e52bc6076dfd35272b91558d9696729cfbf)
+- chore(release): 1.0.11 [`8795194`](https://github.com/outliant/sunrise-utils/commit/879519458081a5c38786c9ba344748883a026796)
+
 #### [1.0.10](https://github.com/outliant/sunrise-utils/compare/1.0.9...1.0.10)
 
+> 30 March 2023
+
 - chore: added created and updated on project list columns #860qbm263 [`8f664f1`](https://github.com/outliant/sunrise-utils/commit/8f664f117644d97e5338f11c0f4e1a4396375b07)
+- chore(release): 1.0.10 [`08ef0d6`](https://github.com/outliant/sunrise-utils/commit/08ef0d6b47ff16e853249d21d5d0b0a962caf44b)
 
 #### [1.0.9](https://github.com/outliant/sunrise-utils/compare/1.0.8...1.0.9)
 

package/helpers/projectFilter/projectFieldFilter.js

@@ -55,6 +55,10 @@ module.exports = (filter) => {
       return module.exports.isAfterIncludeParam(filter);
     case 'between':
       return module.exports.isBetween(filter);
+    case 'next_n_days':
+      return module.exports.nextNDays(filter);
+    case 'last_n_days':
+      return module.exports.lastNDays(filter);
     default:
       return null;
   }
@@ -495,6 +499,111 @@ module.exports.isAfter = (filter) => {
   return null;
 };
 
+module.exports.nextNDays = (filter) => {
+  if (!!filter.field_id) {
+    if (isNaN(filter.value)) {
+      return null;
+    }
+
+    const today = moment()
+      .startOf('day');
+
+    const nextNDays = moment()
+      .add(filter.value, 'd')
+      .endOf('day');
+
+    const res = {
+      bool: {
+        must: [
+          {
+            nested: {
+              path: 'fields',
+              query: {
+                bool: {
+                  must: [
+                    {
+                      term: {
+                        'fields.id': {
+                          value: filter.field_id
+                        }
+                      }
+                    },
+                    {
+                      range: {
+                        'fields.number': {
+                          gt: today.valueOf(),
+                          lt: nextNDays.valueOf()
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        ]
+      }
+    };
+
+    return res;
+  }
+
+  return null;
+};
+
+module.exports.lastNDays = (filter) => {
+  if (!!filter.field_id) {
+    if (isNaN(filter.value)) {
+      return null;
+    }
+
+    const today = moment()
+      .startOf('day');
+
+    const lastNDays = moment()
+      .subtract(filter.value, 'd')
+      .endOf('day');
+
+    const res = {
+      bool: {
+        must: [
+          {
+            nested: {
+              path: 'fields',
+              query: {
+                bool: {
+                  must: [
+                    {
+                      term: {
+                        'fields.id': {
+                          value: filter.field_id
+                        }
+                      }
+                    },
+                    {
+                      range: {
+                        'fields.number': {
+                          lt: today.valueOf(),
+                          gt: lastNDays.valueOf()
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        ]
+      }
+    };
+
+    console.log(JSON.stringify(res, null, 2));
+    return res;
+  }
+
+  return null;
+};
+
 module.exports.isBeforeIncludeParam = (filter) => {
   if (!!filter.field_id) {
     let param;

package/helpers/task.js

@@ -0,0 +1,17 @@
+module.exports.taskAgeColorRangeMap = {
+  green: {
+    min: 0,
+    max: 5
+  },
+  yellow: {
+    min: 6,
+    max: 10
+  },
+  red: {
+    min: 11,
+    max: 30
+  },
+  black: {
+    min: 31
+  }
+};

package/helpers/taskFilter/buildAgeColorFilter.js

@@ -0,0 +1,45 @@
+const { taskAgeColorRangeMap } = require('../task');
+
+module.exports = (filter) => {
+  switch (filter.condition) {
+    case 'is_equal':
+      return module.exports.isEqual(filter);
+    default:
+      return null;
+  }
+};
+
+module.exports.isEqual = (filter) => {
+  const range = taskAgeColorRangeMap[filter.value];
+  if (!range) {
+    return null;
+  }
+
+  return {
+    script: {
+      script: {
+        source: `
+          try {
+            def now = new Date().getTime();
+            def readyDate = doc['ready_at'].value.millis;
+
+            long elapsedDays = (now - readyDate)/(1000 * 3600 * 24);
+            boolean valid = elapsedDays >= params.min;
+
+            if (params.containsKey('max')) {
+              valid = valid && elapsedDays <= params.max;
+            }
+
+            return valid;
+          } catch(Exception err){
+            return false;
+          }`,
+        lang: 'painless',
+        params: {
+          min: range.min,
+          max: range.max
+        }
+      }
+    }
+  };
+};

package/helpers/taskFilter/index.js

@@ -5,6 +5,7 @@ const buildRegionFilter = require('./regionFilter');
 const buildTaskFieldFilter = require('./taskFieldFilter');
 const buildCriticalPathFilter = require('./criticalPathFilter');
 const buildOnHoldFilter = require('./onHoldFilter');
+const buildAgeColorFilter = require('./buildAgeColorFilter');
 const buildProjectFieldFilter = require('../projectFilter/projectFieldFilter');
 
 module.exports.taskStatusOptions = [
@@ -30,6 +31,25 @@ module.exports.taskStatusOptions = [
   }
 ];
 
+module.exports.taskAgeColorOptions = [
+  {
+    label: 'Green',
+    value: 'green'
+  },
+  {
+    label: 'Yellow',
+    value: 'yellow'
+  },
+  {
+    label: 'Red',
+    value: 'red'
+  },
+  {
+    label: 'Black',
+    value: 'black'
+  }
+];
+
 module.exports.defaultCustomColumns = [
   {
     name: 'Owner',
@@ -196,6 +216,8 @@ module.exports.buildTaskPipelineFilter = (filter) => {
     // Always expected as is_equal condition
     case 'path_age':
       return buildPathAgeFilter(filter);
+    case 'task_age':
+      return buildAgeColorFilter(filter);
     // Always expected as is_equal condition with array of task template ids
     case 'task_templates':
       let value = filter.value;

package/helpers/taskFilter/taskFieldFilter.js

@@ -28,12 +28,15 @@ module.exports = (filter) => {
       return module.exports.isAfterIncludeParam(filter);
     case 'between':
       return module.exports.isBetween(filter);
+    case 'next_n_days':
+      return module.exports.nextNDays(filter);
+    case 'last_n_days':
+      return module.exports.lastNDays(filter);
     default:
       return null;
   }
 };
 
-
 module.exports.containsAny = (filter) => {
   /**
    * Field type is for custom columns
@@ -291,6 +294,61 @@ module.exports.isAfter = (filter) => {
   };
 };
 
+module.exports.nextNDays = (filter) => {
+  if (isNaN(filter.value)) {
+    return null;
+  }
+
+  const today = moment()
+    .startOf('day');
+
+  const nextNDays = moment()
+    .add(filter.value, 'd')
+    .endOf('day');
+
+  return {
+    range: {
+      [filter.type]: {
+        gt: today.valueOf(),
+        lt: nextNDays.valueOf()
+      }
+    }
+  };
+};
+
+module.exports.lastNDays = (filter) => {
+  if (isNaN(filter.value)) {
+    return null;
+  }
+
+  const today = moment()
+    .startOf('day');
+
+  const lastNDays = moment()
+    .subtract(filter.value, 'd')
+    .endOf('day');
+
+  const info = {
+    today: {
+      format: today.format('YYYY-MM-DD'),
+      value: today.valueOf()
+    },
+    lastNDays: {
+      format: lastNDays.format('YYYY-MM-DD'),
+      value: lastNDays.valueOf()
+    }
+  };
+
+  return {
+    range: {
+      [filter.type]: {
+        lt: today.valueOf(),
+        gt: lastNDays.valueOf()
+      }
+    }
+  };
+};
+
 module.exports.isBeforeIncludeParam = (filter) => {
   let param;
 

package/index.d.ts

@@ -41,6 +41,7 @@ declare namespace Utils {
 
   namespace taskPipeline {
     export const taskStatusOptions: FilterConditionOption[];
+    export const taskAgeColorOptions: FilterConditionOption[];
     export const defaultCustomColumns: Column[];
     export function buildFilter(filter: Filter): any;
     export function buildFiltersQuery(
@@ -51,6 +52,8 @@ declare namespace Utils {
       searchFields?: string[]
     ): any;
     export function buildSortScript(query?: Query, customSort?: any[]): any;
+    export function getTaskAge(task: any): any;
+    export function getTaskAgeColor(task: any): any;
   }
 
   namespace projectPipeline {

package/lib/fieldConditions.js

@@ -165,6 +165,14 @@ module.exports.conditions = {
     {
       label: 'Is Not Empty',
       value: 'is_not_empty'
+    },
+    {
+      label: 'In The Next N Days',
+      value: 'next_n_days'
+    },
+    {
+      label: 'In The Last N Days',
+      value: 'last_n_days'
     }
   ]
 };

package/lib/taskPipeline.js

@@ -1,16 +1,21 @@
 const { validate: isUuid } = require('uuid');
+const moment = require('moment');
+
 const {
   taskStatusOptions,
+  taskAgeColorOptions,
   defaultCustomColumns,
   defaultTaskFilter,
   buildTaskPipelineFilter
 } = require('../helpers/taskFilter');
 const searchFilter = require('../helpers/searchFilter');
 const sortScript = require('../helpers/sortScript');
+const taskHelper = require('../helpers/task');
 
 class TaskPipeline {
   taskStatusOptions = taskStatusOptions;
   defaultCustomColumns = defaultCustomColumns;
+  taskAgeColorOptions = taskAgeColorOptions;
   buildFilter = buildTaskPipelineFilter;
 
   buildFiltersQuery(
@@ -127,6 +132,37 @@ class TaskPipeline {
 
     return taskPipelinesSort;
   }
+
+  getTaskAge(task) {
+    if (!task.is_complete && task.is_ready && task.ready_at) {
+      return moment().diff(moment(task.ready_at), 'days');
+    }
+
+    return null;
+  }
+
+  getTaskAgeColor(task) {
+    const taskAge = this.getTaskAge(task);
+
+    if (taskAge === null) {
+      return null;
+    }
+
+    let ageColor = null;
+
+    Object.keys(taskHelper.taskAgeColorRangeMap).forEach((color) => {
+      const range = taskHelper.taskAgeColorRangeMap[color];
+      const isValid =
+        taskAge >= range.min &&
+        (!range.max || (range.max && taskAge <= range.max));
+
+      if (!ageColor && isValid) {
+        ageColor = color;
+      }
+    });
+
+    return ageColor;
+  }
 }
 
 module.exports = new TaskPipeline();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@outliant/sunrise-utils",
   "description": "Helper functions for project Sunrise",
-  "version": "1.0.10",
+  "version": "1.1.0",
   "license": "ISC",
   "author": "Outliant",
   "main": "index.js",

package/test/helpers/taskFilter/index.spec.js

@@ -137,6 +137,28 @@ describe('taskFilter', function () {
       done();
     });
 
+    it('should handle task_age filter', (done) => {
+      const filter = taskFilter.buildTaskPipelineFilter({
+        condition: 'is_equal',
+        field_id: '',
+        field_type: 'select',
+        type: 'task_age',
+        value: 'red'
+      });
+
+      expect(filter).to.be.deep.equal({
+        script: {
+          script: {
+            source:
+              "\n          try {\n            def now = new Date().getTime();\n            def readyDate = doc['ready_at'].value.millis;\n\n            long elapsedDays = (now - readyDate)/(1000 * 3600 * 24);\n            boolean valid = elapsedDays >= params.min;\n\n            if (params.containsKey('max')) {\n              valid = valid && elapsedDays <= params.max;\n            }\n\n            return valid;\n          } catch(Exception err){\n            return false;\n          }",
+            lang: 'painless',
+            params: { min: 11, max: 30 }
+          }
+        }
+      });
+      done();
+    });
+
     it('should handle task_templates array filter', (done) => {
       const filter = taskFilter.buildTaskPipelineFilter({
         condition: 'is_equal',

package/test/lib/taskPipeline.spec.js

@@ -2,6 +2,7 @@
 
 /* eslint-env node, mocha */
 const { expect } = require('chai');
+const moment = require('moment');
 
 // To test
 const taskPipeline = require('../../lib/taskPipeline');
@@ -377,4 +378,124 @@ describe('taskPipeline', function () {
       done();
     });
   });
+
+  describe('getTaskAge', () => {
+    it('should calculate task age', (done) => {
+      const task = {
+        is_complete: false,
+        is_ready: true,
+        ready_at: moment().subtract(2, 'days').valueOf()
+      };
+
+      const age = taskPipeline.getTaskAge(task);
+
+      expect(age).to.equal(2);
+      done();
+    });
+
+    it('should return null if task is completed', (done) => {
+      const task = {
+        is_complete: true,
+        is_ready: true,
+        ready_at: moment().subtract(2, 'days').valueOf()
+      };
+
+      const age = taskPipeline.getTaskAge(task);
+
+      expect(age).to.equal(null);
+      done();
+    });
+
+    it('should return null if task is blocked', (done) => {
+      const task = {
+        is_complete: false,
+        is_ready: false,
+        ready_at: null
+      };
+
+      const age = taskPipeline.getTaskAge(task);
+
+      expect(age).to.equal(null);
+      done();
+    });
+  });
+
+  describe('getTaskAgeColor', () => {
+    it('should calculate task age color green', (done) => {
+      const testNumbers = [0, 1, 2, 3, 4, 5];
+      for (let i = 0; i < testNumbers.length; i++) {
+        const testNumber = testNumbers[i];
+        const task = {
+          is_complete: false,
+          is_ready: true,
+          ready_at: moment().subtract(testNumber, 'days').valueOf()
+        };
+        const color = taskPipeline.getTaskAgeColor(task);
+
+        expect(color).to.equal('green');
+      }
+      done();
+    });
+
+    it('should calculate task age color yellow', (done) => {
+      const testNumbers = [6, 7, 8, 9, 10];
+      for (let i = 0; i < testNumbers.length; i++) {
+        const testNumber = testNumbers[i];
+        const task = {
+          is_complete: false,
+          is_ready: true,
+          ready_at: moment().subtract(testNumber, 'days').valueOf()
+        };
+        const color = taskPipeline.getTaskAgeColor(task);
+
+        expect(color).to.equal('yellow');
+      }
+      done();
+    });
+
+    it('should calculate task age color red', (done) => {
+      const testNumbers = [11, 12, 15, 20, 25, 30];
+      for (let i = 0; i < testNumbers.length; i++) {
+        const testNumber = testNumbers[i];
+        const task = {
+          is_complete: false,
+          is_ready: true,
+          ready_at: moment().subtract(testNumber, 'days').valueOf()
+        };
+        const color = taskPipeline.getTaskAgeColor(task);
+
+        expect(color).to.equal('red');
+      }
+      done();
+    });
+
+    it('should calculate task age color black', (done) => {
+      const testNumbers = [31, 40, 55, 360];
+      for (let i = 0; i < testNumbers.length; i++) {
+        const testNumber = testNumbers[i];
+        const task = {
+          is_complete: false,
+          is_ready: true,
+          ready_at: moment().subtract(testNumber, 'days').valueOf()
+        };
+        const color = taskPipeline.getTaskAgeColor(task);
+
+        expect(color).to.equal('black');
+      }
+      done();
+    });
+
+    it('should return null if task is not ready', (done) => {
+      const task = {
+        is_complete: true,
+        is_ready: true,
+        ready_at: moment().subtract(2, 'days')
+      };
+
+      const age = taskPipeline.getTaskAgeColor(task);
+
+      expect(age).to.equal(null);
+      done();
+    });
+  });
 });