fix: propagate stopTimerRefreshBoundaryMs to all reminder timers on ReminderManager config update (#1568)

Author: MartinCupela

src/reminders/ReminderManager.ts

@@ -1,4 +1,5 @@
 import { Reminder } from './Reminder';
+import { DEFAULT_STOP_REFRESH_BOUNDARY_MS } from './ReminderTimer';
 import { StateStore } from '../store';
 import { ReminderPaginator } from '../pagination';
 import { WithSubscriptions } from '../utils/WithSubscriptions';
@@ -26,6 +27,7 @@ export const DEFAULT_REMINDER_MANAGER_CONFIG: ReminderManagerConfig = {
     8 * oneHour,
     oneDay,
   ],
+  stopTimerRefreshBoundaryMs: DEFAULT_STOP_REFRESH_BOUNDARY_MS,
 };
 
 const isReminderExistsError = (error: Error) =>
@@ -51,12 +53,12 @@ export type ReminderManagerState = {
 
 export type ReminderManagerConfig = {
   scheduledOffsetsMs: number[];
-  stopTimerRefreshBoundaryMs?: number;
+  stopTimerRefreshBoundaryMs: number;
 };
 
 export type ReminderManagerOptions = {
   client: StreamChat;
-  config?: ReminderManagerConfig;
+  config?: Partial<ReminderManagerConfig>;
 };
 
 export class ReminderManager extends WithSubscriptions {
@@ -71,13 +73,25 @@ export class ReminderManager extends WithSubscriptions {
     this.configState = new StateStore({
       scheduledOffsetsMs:
         config?.scheduledOffsetsMs ?? DEFAULT_REMINDER_MANAGER_CONFIG.scheduledOffsetsMs,
+      stopTimerRefreshBoundaryMs:
+        config?.stopTimerRefreshBoundaryMs ??
+        DEFAULT_REMINDER_MANAGER_CONFIG.stopTimerRefreshBoundaryMs,
     });
     this.state = new StateStore({ reminders: new Map<MessageId, Reminder>() });
     this.paginator = new ReminderPaginator(client);
   }
 
   // Config API START //
   updateConfig(config: Partial<ReminderManagerConfig>) {
+    if (
+      typeof config.stopTimerRefreshBoundaryMs === 'number' &&
+      config.stopTimerRefreshBoundaryMs !== this.stopTimerRefreshBoundaryMs
+    ) {
+      this.reminders.forEach((reminder) => {
+        reminder.timer.stopRefreshBoundaryMs =
+          config?.stopTimerRefreshBoundaryMs as number;
+      });
+    }
     this.configState.partialNext(config);
   }
 

test/unit/reminders/ReminderManager.test.ts

@@ -5,12 +5,11 @@ import {
   Reminder,
   ReminderManager,
   ReminderResponse,
-  ReminderTimer,
+  ReminderState,
   StreamChat,
 } from '../../../src';
 import { describe, expect, it, vi } from 'vitest';
 import { PaginationQueryReturnValue } from '../../../src/pagination';
-import { sleep } from '../../../src/utils';
 
 const baseData = {
   channel_cid: 'channel_cid',
@@ -71,19 +70,40 @@ describe('ReminderManager', () => {
       const manager = new ReminderManager({ client, config });
       // @ts-expect-error accessing private property
       expect(manager.client).toBe(client);
-      expect(manager.configState.getLatestValue()).toEqual(config);
+      expect(manager.configState.getLatestValue()).toEqual({
+        ...DEFAULT_REMINDER_MANAGER_CONFIG,
+        ...config,
+      });
       expect(manager.state.getLatestValue()).toEqual({ reminders: new Map() });
     });
   });
 
   describe('config state API', () => {
-    it('updates config object', () => {
+    it('updates scheduledOffsetsMs', () => {
       const client = new StreamChat('api-key');
       const manager = new ReminderManager({ client });
       const config = { scheduledOffsetsMs: [1, 2, 3] };
       manager.updateConfig(config);
       expect(manager.scheduledOffsetsMs).toEqual(config.scheduledOffsetsMs);
     });
+
+    it('updates stopTimerRefreshBoundaryMs for every timer', () => {
+      const client = new StreamChat('api-key');
+      const manager = new ReminderManager({ client });
+      const scheduleOffsetMs = 62 * 1000;
+      const reminderResponse = generateReminderResponse({ scheduleOffsetMs });
+      manager.upsertToState({ data: reminderResponse });
+
+      expect(manager.stopTimerRefreshBoundaryMs).toBe(DEFAULT_STOP_REFRESH_BOUNDARY_MS);
+      const config = { stopTimerRefreshBoundaryMs: 1 };
+      manager.updateConfig(config);
+      expect(manager.stopTimerRefreshBoundaryMs).toEqual(
+        config.stopTimerRefreshBoundaryMs,
+      );
+      expect(
+        manager.reminders.get(reminderResponse.message_id)?.timer.stopRefreshBoundaryMs,
+      ).toBe(1);
+    });
   });
 
   describe('state API', () => {
@@ -305,10 +325,10 @@ describe('ReminderManager', () => {
       const remindAtDate = new Date('1970-01-01');
       const { timeLeftMs, ...state } = manager.reminders
         .get(reminderResponse.message_id)
-        ?.state.getLatestValue();
+        ?.state.getLatestValue() as ReminderState;
       expect({
         ...state,
-        timeLeftMs: Math.round(timeLeftMs / 1000),
+        timeLeftMs: Math.round((timeLeftMs ?? 0) / 1000),
       }).toEqual({
         ...reminderResponse,
         created_at: new Date(reminderResponse.created_at),