feat(events): update bulkToggleEventMark to return updatedEventIds

Author: Dobrunia

src/models/eventsFactory.js

@@ -934,7 +934,7 @@ class EventsFactory extends Factory {
    *
    * @param {string[]} eventIds - original event ids
    * @param {string} mark - 'resolved' | 'ignored' | 'starred'
-   * @returns {Promise<{ updatedCount: number, failedEventIds: string[] }>}
+   * @returns {Promise<{ updatedCount: number, updatedEventIds: string[], failedEventIds: string[] }>}
    */
   async bulkToggleEventMark(eventIds, mark) {
     if (mark !== 'resolved' && mark !== 'ignored' && mark !== 'starred') {
@@ -962,6 +962,7 @@ class EventsFactory extends Factory {
     if (validObjectIds.length === 0) {
       return {
         updatedCount: 0,
+        updatedEventIds: [],
         failedEventIds,
       };
     }
@@ -982,6 +983,7 @@ class EventsFactory extends Factory {
     const markKey = `marks.${mark}`;
     const allHaveMark = found.length > 0 && found.every(doc => doc.marks && doc.marks[mark]);
     const ops = [];
+    const updatedEventIds = [];
 
     for (const doc of found) {
       const hasMark = doc.marks && doc.marks[mark];
@@ -1001,11 +1003,13 @@ class EventsFactory extends Factory {
           update,
         },
       });
+      updatedEventIds.push(doc._id.toString());
     }
 
     if (ops.length === 0) {
       return {
         updatedCount: 0,
+        updatedEventIds: [],
         failedEventIds,
       };
     }
@@ -1014,6 +1018,7 @@ class EventsFactory extends Factory {
 
     return {
       updatedCount: bulkResult.modifiedCount + bulkResult.upsertedCount,
+      updatedEventIds,
       failedEventIds,
     };
   }

src/typeDefs/event.ts

@@ -461,6 +461,11 @@ type BulkToggleEventMarksResult {
   """
   updatedCount: Int!
 
+  """
+  Original event ids actually toggled in this operation
+  """
+  updatedEventIds: [ID!]!
+
   """
   Event ids that were not updated (invalid id or not found)
   """

test/models/eventsFactory-bulk-toggle.test.ts

@@ -78,6 +78,7 @@ describe('EventsFactory.bulkToggleEventMark', () => {
     const result = await factory.bulkToggleEventMark([ id.toString() ], 'starred');
 
     expect(result.updatedCount).toBe(1);
+    expect(result.updatedEventIds).toEqual([ id.toString() ]);
     const ops = collectionMock.bulkWrite.mock.calls[0][0];
 
     expect(ops).toHaveLength(1);
@@ -130,6 +131,7 @@ describe('EventsFactory.bulkToggleEventMark', () => {
     const result = await factory.bulkToggleEventMark([ 'not-a-valid-id' ], 'resolved');
 
     expect(result.updatedCount).toBe(0);
+    expect(result.updatedEventIds).toEqual([]);
     expect(result.failedEventIds).toContain('not-a-valid-id');
     expect(collectionMock.bulkWrite).not.toHaveBeenCalled();
   });
@@ -145,6 +147,7 @@ describe('EventsFactory.bulkToggleEventMark', () => {
     const result = await factory.bulkToggleEventMark([ missing.toString() ], 'ignored');
 
     expect(result.updatedCount).toBe(0);
+    expect(result.updatedEventIds).toEqual([]);
     expect(result.failedEventIds).toContain(missing.toString());
     expect(collectionMock.bulkWrite).not.toHaveBeenCalled();
   });
@@ -169,6 +172,7 @@ describe('EventsFactory.bulkToggleEventMark', () => {
     const result = await factory.bulkToggleEventMark([ a.toString(), b.toString() ], 'ignored');
 
     expect(result.updatedCount).toBe(1);
+    expect(result.updatedEventIds).toEqual([ b.toString() ]);
     const ops = collectionMock.bulkWrite.mock.calls[0][0];
 
     expect(ops).toHaveLength(1);
@@ -200,6 +204,7 @@ describe('EventsFactory.bulkToggleEventMark', () => {
     const result = await factory.bulkToggleEventMark([ a.toString(), b.toString() ], 'resolved');
 
     expect(result.updatedCount).toBe(2);
+    expect(result.updatedEventIds).toEqual([ a.toString(), b.toString() ]);
     const ops = collectionMock.bulkWrite.mock.calls[0][0];
 
     expect(ops).toHaveLength(2);
@@ -227,6 +232,7 @@ describe('EventsFactory.bulkToggleEventMark', () => {
     const result = await factory.bulkToggleEventMark([ a.toString(), b.toString() ], 'ignored');
 
     expect(result.updatedCount).toBe(1);
+    expect(result.updatedEventIds).toEqual([ b.toString() ]);
     const ops = collectionMock.bulkWrite.mock.calls[0][0];
 
     expect(ops).toHaveLength(1);

test/resolvers/event-bulk-toggle-marks.test.ts

@@ -15,7 +15,7 @@ const eventResolvers = require('../../src/resolvers/event') as {
       o: unknown,
       args: { projectId: string; eventIds: string[]; mark: string },
       ctx: unknown
-    ) => Promise<{ updatedCount: number; failedEventIds: string[] }>;
+    ) => Promise<{ updatedCount: number; updatedEventIds: string[]; failedEventIds: string[] }>;
   };
 };
 
@@ -62,7 +62,7 @@ describe('Mutation.bulkToggleEventMarks', () => {
   });
 
   it('should call factory with original event ids and return its result', async () => {
-    const payload = { updatedCount: 2, failedEventIds: [ 'x' ] };
+    const payload = { updatedCount: 2, updatedEventIds: [ 'a', 'b' ], failedEventIds: [ 'x' ] };
 
     bulkToggleEventMark.mockResolvedValue(payload);
 
@@ -85,7 +85,7 @@ describe('Mutation.bulkToggleEventMarks', () => {
   });
 
   it('should allow starred mark for bulk toggle', async () => {
-    const payload = { updatedCount: 1, failedEventIds: [] };
+    const payload = { updatedCount: 1, updatedEventIds: [ '507f1f77bcf86cd799439011' ], failedEventIds: [] };
 
     bulkToggleEventMark.mockResolvedValue(payload);