Merge pull request #634 from codex-team/feat/events-assignee-filter

feat(api): add assignee filter to project daily events search

Author: Dobrunia

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hawk.api",
-  "version": "1.4.9",
+  "version": "1.4.11",
   "main": "index.ts",
   "license": "BUSL-1.1",
   "scripts": {

src/models/eventsFactory.js

@@ -203,10 +203,11 @@ class EventsFactory extends Factory {
    *
    * @param {Number} limit - events count limitations
    * @param {DailyEventsCursor} paginationCursor - object that contains boundary values of the last event in the previous portion
-   * @param {'BY_DATE' | 'BY_COUNT'} sort - events sort order
-   * @param {EventsFilters} filters - marks by which events should be filtered
+   * @param {'BY_DATE' | 'BY_COUNT' | 'BY_AFFECTED_USERS'} sort - events sort order
+   * @param {EventsFilters} filters - marks by which events should be filtered (resolved, starred, ignored only; assignee is separate)
    * @param {String} search - Search query
-   * @param {String} release - release name
+   * @param {String|undefined} release - release name
+   * @param {String|undefined} assignee - user id or __filter_unassigned__ / __filter_any_assignee__
    *
    * @return {DaylyEventsPortionSchema}
    */
@@ -216,7 +217,8 @@ class EventsFactory extends Factory {
     sort = 'BY_DATE',
     filters = {},
     search = '',
-    release
+    release,
+    assignee
   ) {
     if (typeof search !== 'string') {
       throw new Error('Search parameter must be a string');
@@ -334,10 +336,12 @@ class EventsFactory extends Factory {
       }
       : {};
 
+    const markFilters = ['resolved', 'starred', 'ignored'];
     const matchFilter = filters
       ? Object.fromEntries(
         Object
           .entries(filters)
+          .filter(([ mark ]) => markFilters.includes(mark))
           .map(([mark, exists]) => [`event.marks.${mark}`, { $exists: exists } ])
       )
       : {};
@@ -361,6 +365,44 @@ class EventsFactory extends Factory {
       }
       : {};
 
+    /**
+     * Sentinel values from garage assignee filter (not user ids)
+     */
+    const FILTER_UNASSIGNED = '__filter_unassigned__';
+    const FILTER_ANY_ASSIGNEE = '__filter_any_assignee__';
+
+    const assigneeFilter = (() => {
+      if (!assignee) {
+        return {};
+      }
+      if (assignee === FILTER_UNASSIGNED) {
+        /**
+         * Use $and so this does not collide with searchFilter’s top-level $or in $match spread
+         */
+        return {
+          $and: [
+            {
+              $or: [
+                { 'event.assignee': { $exists: false } },
+                { 'event.assignee': null },
+                { 'event.assignee': '' },
+              ],
+            },
+          ],
+        };
+      }
+      if (assignee === FILTER_ANY_ASSIGNEE) {
+        return {
+          'event.assignee': {
+            $exists: true,
+            $nin: [null, ''],
+          },
+        };
+      }
+
+      return { 'event.assignee': String(assignee) };
+    })();
+
     pipeline.push(
       /**
        * Left outer join original event on groupHash field
@@ -398,6 +440,7 @@ class EventsFactory extends Factory {
           ...matchFilter,
           ...searchFilter,
           ...releaseFilter,
+          ...assigneeFilter,
         },
       },
       { $limit: limit + 1 },

src/resolvers/project.js

@@ -571,19 +571,21 @@ module.exports = {
     },
 
     /**
-     * Returns recent Events grouped by day
+     * Returns a paginated portion of daily-grouped events
      *
-     * @param {ProjectDBScheme} project - result of parent resolver
-     * @param {Number} limit - limit for events count
-     * @param {DailyEventsCursor} cursor - object with boundary values of the first event in the next portion
-     * @param {'BY_DATE' | 'BY_COUNT'} sort - events sort order
-     * @param {EventsFilters} filters - marks by which events should be filtered
-     * @param {String} release - release name
-     * @param {String} search - search query
-     *
-     * @return {Promise<RecentEventSchema[]>}
+     * @param {ProjectDBScheme} project - parent resolver result
+     * @param {object} args - GraphQL arguments
+     * @param {number} args.limit - max rows in portion
+     * @param {object|null} args.nextCursor - pagination cursor
+     * @param {string} args.sort - BY_DATE | BY_COUNT | BY_AFFECTED_USERS (mapped in factory)
+     * @param {object} args.filters - mark filters only: resolved, starred, ignored (assignee uses args.assignee)
+     * @param {string} args.search - search query
+     * @param {string|undefined} args.release - optional release label filter
+     * @param {string|undefined} args.assignee - user id or __filter_unassigned__ / __filter_any_assignee__
+     * @param {object} context - GraphQL context
+     * @returns {Promise<object>} dailyEventsPortion payload from factory
      */
-    async dailyEventsPortion(project, { limit, nextCursor, sort, filters, search, release }, context) {
+    async dailyEventsPortion(project, { limit, nextCursor, sort, filters, search, release, assignee }, context) {
       if (search) {
         if (search.length > MAX_SEARCH_QUERY_LENGTH) {
           search = search.slice(0, MAX_SEARCH_QUERY_LENGTH);
@@ -592,7 +594,15 @@ module.exports = {
 
       const factory = getEventsFactory(context, project._id);
 
-      const dailyEventsPortion = await factory.findDailyEventsPortion(limit, nextCursor, sort, filters, search, release);
+      const dailyEventsPortion = await factory.findDailyEventsPortion(
+        limit,
+        nextCursor,
+        sort,
+        filters,
+        search,
+        release,
+        assignee
+      );
 
       return dailyEventsPortion;
     },

src/typeDefs/project.ts

@@ -347,6 +347,11 @@ type Project {
     Release label to filter events by payload.release
     """
     release: String
+
+    """
+    Filter by assignee: workspace user id, or sentinels __filter_unassigned__ (no assignee) / __filter_any_assignee__ (has assignee)
+    """
+    assignee: ID
   ): DailyEventsPortion
 
   """

test/resolvers/project-daily-events-portion.test.ts

@@ -0,0 +1,121 @@
+import '../../src/env-test';
+
+jest.mock('../../src/integrations/github/service', () => require('../__mocks__/github-service'));
+
+jest.mock('../../src/resolvers/helpers/eventsFactory', () => ({
+  __esModule: true,
+  default: jest.fn(),
+}));
+
+// @ts-expect-error - CommonJS module, TypeScript can't infer types properly
+import projectResolverModule from '../../src/resolvers/project';
+import getEventsFactory from '../../src/resolvers/helpers/eventsFactory';
+
+const projectResolver = projectResolverModule as {
+  Project: {
+    dailyEventsPortion: (...args: unknown[]) => Promise<unknown>;
+  };
+};
+
+describe('Project resolver dailyEventsPortion', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should pass assignee filter to events factory', async () => {
+    const findDailyEventsPortion = jest.fn().mockResolvedValue({
+      nextCursor: null,
+      dailyEvents: [],
+    });
+    (getEventsFactory as unknown as jest.Mock).mockReturnValue({
+      findDailyEventsPortion,
+    });
+
+    const project = { _id: 'project-1' };
+    const args = {
+      limit: 50,
+      nextCursor: null,
+      sort: 'BY_DATE',
+      filters: { ignored: true },
+      search: 'TypeError',
+      release: '1.0.0',
+      assignee: 'user-123',
+    };
+
+    await projectResolver.Project.dailyEventsPortion(project, args, {});
+
+    expect(findDailyEventsPortion).toHaveBeenCalledWith(
+      50,
+      null,
+      'BY_DATE',
+      { ignored: true },
+      'TypeError',
+      '1.0.0',
+      'user-123'
+    );
+  });
+
+  it('should pass assignee sentinel for unassigned filter to factory', async () => {
+    const findDailyEventsPortion = jest.fn().mockResolvedValue({
+      nextCursor: null,
+      dailyEvents: [],
+    });
+    (getEventsFactory as unknown as jest.Mock).mockReturnValue({
+      findDailyEventsPortion,
+    });
+
+    const project = { _id: 'project-1' };
+    const args = {
+      limit: 50,
+      nextCursor: null,
+      sort: 'BY_DATE',
+      filters: {},
+      search: '',
+      assignee: '__filter_unassigned__',
+    };
+
+    await projectResolver.Project.dailyEventsPortion(project, args, {});
+
+    expect(findDailyEventsPortion).toHaveBeenCalledWith(
+      50,
+      null,
+      'BY_DATE',
+      {},
+      '',
+      undefined,
+      '__filter_unassigned__'
+    );
+  });
+
+  it('should call factory with undefined assignee when assignee argument is omitted', async () => {
+    const findDailyEventsPortion = jest.fn().mockResolvedValue({
+      nextCursor: null,
+      dailyEvents: [],
+    });
+    (getEventsFactory as unknown as jest.Mock).mockReturnValue({
+      findDailyEventsPortion,
+    });
+
+    const project = { _id: 'project-1' };
+    const args = {
+      limit: 10,
+      nextCursor: null,
+      sort: 'BY_DATE',
+      filters: {},
+      search: '',
+      release: undefined,
+    };
+
+    await projectResolver.Project.dailyEventsPortion(project, args, {});
+
+    expect(findDailyEventsPortion).toHaveBeenCalledWith(
+      10,
+      null,
+      'BY_DATE',
+      {},
+      '',
+      undefined,
+      undefined
+    );
+  });
+});