feat(datatrak): RN-1343: Task dashboard filter settings

packages/central-server/src/apiV2/GETHandler/GETHandler.js

@@ -58,7 +58,7 @@ export class GETHandler extends CRUDHandler {
   }
 
   async getDbQueryOptions() {
-    const { sort: sortString, distinct = false } = this.req.query;
+    const { sort: sortString, rawSort, distinct = false } = this.req.query;
 
     // set up db query options
     const columns = await this.getProcessedColumns();
@@ -73,7 +73,7 @@ export class GETHandler extends CRUDHandler {
     const { limit, page } = this.getPaginationParameters();
     const offset = limit * page;
 
-    const dbQueryOptions = { multiJoin, columns, sort, distinct, limit, offset };
+    const dbQueryOptions = { multiJoin, columns, sort, rawSort, distinct, limit, offset };
 
     // add any user requested sorting to the start of the sort clause
     if (sortString) {

packages/central-server/src/apiV2/tasks/GETTasks.js

@@ -31,9 +31,13 @@ export class GETTasks extends GETHandler {
     return {
       ...restOfOptions,
       // Strip table prefix from `task_status` and `assignee_name` as these are customColumns
-      sort: sort.map(s =>
-        s.replace('task.task_status', 'task_status').replace('task.assignee_name', 'assignee_name'),
-      ),
+      sort:
+        !restOfOptions.rawSort &&
+        sort?.map(s =>
+          s
+            .replace('task.task_status', 'task_status')
+            .replace('task.assignee_name', 'assignee_name'),
+        ),
       // Appending the multi-join from the Record class so that we can fetch the `task_status` and `assignee_name`
       multiJoin: mergeMultiJoin(multiJoin, this.models.task.DatabaseRecordClass.joins),
     };

packages/datatrak-web-server/package.json

@@ -33,6 +33,7 @@
     "@tupaia/types": "workspace:*",
     "@tupaia/utils": "workspace:*",
     "camelcase-keys": "^6.2.2",
+    "cookie": "^0.6.0",
     "express": "^4.19.2",
     "lodash.groupby": "^4.6.0",
     "lodash.keyby": "^4.6.0",

packages/datatrak-web-server/src/__tests__/TasksRoute.test.ts

@@ -0,0 +1,178 @@
+/*
+ * Tupaia
+ *  Copyright (c) 2017 - 2023 Beyond Essential Systems Pty Ltd
+ */
+import { NextFunction, Request } from 'express';
+import { TasksRoute } from '../routes';
+
+const mockFunc = jest.fn(() => []);
+
+const makeMockRequest = (overwrites: any) => {
+  return {
+    headers: {
+      // defaults to make the tests simpler
+      cookie: 'show_completed_tasks=true;show_cancelled_tasks=true;all_assignees_tasks=true',
+    },
+    query: {},
+    models: {
+      database: {
+        count: () => null,
+      },
+      task: {
+        customColumnSelectors: {},
+        DatabaseRecordClass: { joins: null },
+      },
+    },
+    ctx: {
+      services: {
+        central: {
+          fetchResources: mockFunc,
+          getUser: () => ({ id: 'test' }),
+        },
+      },
+    },
+    ...overwrites,
+  };
+};
+
+const mockResponse: any = {
+  json: jest.fn(),
+  status: jest.fn(),
+};
+
+const mockNext: NextFunction = jest.fn();
+
+class TestableTaskRoute extends TasksRoute {
+  public constructor(params: any) {
+    const req = makeMockRequest(params);
+    // @ts-ignore
+    super(req, mockResponse, mockNext);
+  }
+}
+
+describe('TaskRoute', () => {
+  describe('should format filters correctly', () => {
+    const testData = [
+      [
+        'Default filter settings',
+        {
+          headers: {
+            cookie: 'show_completed_tasks=true;show_cancelled_tasks=true;all_assignees_tasks=true',
+          },
+        },
+        {
+          filter: {},
+        },
+      ],
+      [
+        'Partial text filter',
+        {
+          query: {
+            filters: [
+              {
+                id: 'survey.name',
+                value: 'a',
+              },
+            ],
+          },
+        },
+        {
+          filter: { 'survey.name': { comparator: 'ilike', comparisonValue: 'a%' } },
+        },
+      ],
+      [
+        'Status filter',
+        {
+          query: {
+            filters: [
+              {
+                id: 'task_status',
+                value: 'to_do',
+              },
+            ],
+          },
+        },
+        {
+          filter: {
+            task_status: 'to_do',
+          },
+        },
+      ],
+      [
+        'All completed tasks setting false',
+        {
+          headers: {
+            cookie: 'show_completed_tasks=false;show_cancelled_tasks=true;all_assignees_tasks=true',
+          },
+        },
+        {
+          filter: {
+            task_status: { comparator: 'NOT IN', comparisonValue: ['completed'] },
+          },
+        },
+      ],
+      [
+        'All assignee filter setting false',
+        {
+          headers: {
+            cookie: 'show_completed_tasks=true;show_cancelled_tasks=true;all_assignees_tasks=false',
+          },
+        },
+        {
+          filter: {
+            assignee_id: 'test',
+          },
+        },
+      ],
+      [
+        'All completed tasks setting false and completed status filter',
+        {
+          headers: {
+            cookie: 'show_completed_tasks=false;show_cancelled_tasks=true;all_assignees_tasks=true',
+          },
+          query: {
+            filters: [
+              {
+                id: 'task_status',
+                value: 'completed',
+              },
+            ],
+          },
+        },
+        {
+          filter: {
+            task_status: 'completed',
+          },
+        },
+      ],
+      [
+        'All completed tasks setting false and to_do status filter',
+        {
+          headers: {
+            cookie: 'show_completed_tasks=false;show_cancelled_tasks=true;all_assignees_tasks=true',
+          },
+          query: {
+            filters: [
+              {
+                id: 'task_status',
+                value: 'to_do',
+              },
+            ],
+          },
+        },
+        {
+          filter: {
+            task_status: 'to_do',
+          },
+        },
+      ],
+    ];
+
+    // @ts-ignore
+    it.each(testData)('%s', async (_, filters, result) => {
+      const route = new TestableTaskRoute(filters);
+      await route.buildResponse();
+      expect(mockFunc).toHaveBeenCalledWith('tasks', expect.objectContaining(result));
+    });
+  });
+});