refactor: rename OwnMessageReceiptsTracker to MessageReceiptsTracker

Author: MartinCupela

src/channel.ts

@@ -1,6 +1,6 @@
 import { ChannelState } from './channel_state';
 import { MessageComposer } from './messageComposer';
-import { OwnMessageReceiptsTracker } from './messageDelivery';
+import { MessageReceiptsTracker } from './messageDelivery';
 import {
   generateChannelTempCid,
   logChatPromiseExecution,
@@ -111,7 +111,7 @@ export class Channel {
   disconnected: boolean;
   push_preferences?: PushPreference;
   public readonly messageComposer: MessageComposer;
-  public readonly ownMessageReceiptsTracker: OwnMessageReceiptsTracker;
+  public readonly messageReceiptsTracker: MessageReceiptsTracker;
 
   /**
    * constructor - Create a channel
@@ -161,7 +161,7 @@ export class Channel {
       compositionContext: this,
     });
 
-    this.ownMessageReceiptsTracker = new OwnMessageReceiptsTracker({
+    this.messageReceiptsTracker = new MessageReceiptsTracker({
       locateMessage: (timestampMs) => {
         const msg = this.state.findMessageByTimestamp(timestampMs);
         return msg && { timestampMs, msgId: msg.id };
@@ -1903,7 +1903,7 @@ export class Channel {
             user: event.user,
             unread_messages: 0,
           };
-          this.ownMessageReceiptsTracker.onMessageRead({
+          this.messageReceiptsTracker.onMessageRead({
             user: event.user,
             readAt: event.created_at,
             lastReadMessageId: event.last_read_message_id,
@@ -1931,7 +1931,7 @@ export class Channel {
             user: event.user,
           };
 
-          this.ownMessageReceiptsTracker.onMessageDelivered({
+          this.messageReceiptsTracker.onMessageDelivered({
             user: event.user,
             deliveredAt: event.created_at,
             lastDeliveredMessageId: event.last_delivered_message_id,
@@ -2346,7 +2346,7 @@ export class Channel {
         }
       }
 
-      this.ownMessageReceiptsTracker.ingestInitial(state.read);
+      this.messageReceiptsTracker.ingestInitial(state.read);
     }
 
     return {

src/messageDelivery/OwnMessageReceiptsTracker.ts renamed to src/messageDelivery/MessageReceiptsTracker.ts

@@ -75,7 +75,7 @@ export type OwnMessageReceiptsTrackerOptions = {
 };
 
 /**
- * OwnMessageReceiptsTracker
+ * MessageReceiptsTracker
  * --------------------------------
  * Tracks **other participants’** delivery/read progress toward **own (outgoing) messages**
  * within a **single timeline** (one channel/thread).
@@ -92,7 +92,7 @@ export type OwnMessageReceiptsTrackerOptions = {
  *
  * Construction
  * ------------
- * `new OwnMessageReceiptsTracker({locateMessage})`
+ * `new MessageReceiptsTracker({locateMessage})`
  * - `locateMessage(timestamp) => MsgRef | null` must resolve a message ref representation - `{ timestamp, msgId }`.
  *   - If `locateMessage` returns `null`, the event is ignored (message unknown locally).
  *
@@ -131,7 +131,7 @@ export type OwnMessageReceiptsTrackerOptions = {
  *   equal-timestamp plateau (upper-bound insertion), preserving intuitive arrival order.
  * - This tracker models **others’ progress toward own messages**;
  */
-export class OwnMessageReceiptsTracker {
+export class MessageReceiptsTracker {
   private byUser = new Map<UserId, UserProgress>();
   private readSorted: UserProgress[] = []; // asc by lastReadRef
   private deliveredSorted: UserProgress[] = []; // asc by lastDeliveredRef

src/messageDelivery/index.ts

@@ -1,2 +1,2 @@
 export * from './MessageDeliveryReporter';
-export * from './OwnMessageReceiptsTracker';
+export * from './MessageReceiptsTracker';

test/unit/MessageDeliveryReporter.test.ts renamed to test/unit/messageDelivery/MessageDeliveryReporter.test.ts

@@ -1,6 +1,6 @@
 import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
 import { getClientWithUser } from './test-utils/getClient';
-import type { Channel, Event, EventAPIResponse, StreamChat } from '../../src';
+import type { Channel, Event, EventAPIResponse, StreamChat } from '../../../src';
 
 const channelType = 'messaging';
 const channelId = 'channelId';

test/unit/OwnMessageReceiptsTracker.test.ts renamed to test/unit/messageDelivery/MessageReceiptsTracker.test.ts

@@ -1,10 +1,10 @@
 import { describe, it, expect, beforeEach, vi } from 'vitest';
 import {
-  OwnMessageReceiptsTracker,
+  MessageReceiptsTracker,
   type MsgRef,
   ReadResponse,
   UserResponse,
-} from '../../src/';
+} from '../../../src';
 
 const ownUserId = 'author';
 const U = (id: string): UserResponse => ({ id, name: id }); // matches UserResponse shape for the service
@@ -35,11 +35,11 @@ const ids = (users: any[]) => users.map((u) => u.id);
 
 // ----------------------------------------------------------------
 
-describe('OwnMessageDeliveryReadTracker', () => {
-  let tracker: OwnMessageReceiptsTracker;
+describe('MessageDeliveryReadTracker', () => {
+  let tracker: MessageReceiptsTracker;
 
   beforeEach(() => {
-    tracker = new OwnMessageReceiptsTracker({ locateMessage: makeLocator() });
+    tracker = new MessageReceiptsTracker({ locateMessage: makeLocator() });
   });
 
   describe('ingestInitial', () => {
@@ -129,7 +129,7 @@ describe('OwnMessageDeliveryReadTracker', () => {
       // re-init with a locator that knows only m1..m3 (m4 is unknown)
       const locator = (ts?: number) =>
         ts && ts <= 3000 ? { timestampMs: ts, msgId: byTs.get(ts)!.id } : null;
-      tracker = new OwnMessageReceiptsTracker({ locateMessage: locator });
+      tracker = new MessageReceiptsTracker({ locateMessage: locator });
 
       const dave = U('dave');
       tracker.onMessageRead({ user: dave, readAt: iso(4000) }); // unknown -> ignored
@@ -144,7 +144,7 @@ describe('OwnMessageDeliveryReadTracker', () => {
 
     it('prevents search for message if last read message id is provided', () => {
       const locator = vi.fn().mockImplementation(() => {});
-      tracker = new OwnMessageReceiptsTracker({ locateMessage: locator });
+      tracker = new MessageReceiptsTracker({ locateMessage: locator });
       const user = U('frank');
       tracker.onMessageRead({ user, readAt: iso(3000), lastReadMessageId: 'X' }); // unknown -> ignored
       expect(locator).not.toHaveBeenCalled();
@@ -203,7 +203,7 @@ describe('OwnMessageDeliveryReadTracker', () => {
     it('ignores delivered events with unknown timestamps (locator returns null)', () => {
       const locator = (t?: number) =>
         t && t <= 2000 ? { timestampMs: t, msgId: byTs.get(t)!.id } : null;
-      tracker = new OwnMessageReceiptsTracker({ locateMessage: locator });
+      tracker = new MessageReceiptsTracker({ locateMessage: locator });
 
       const frank = U('frank');
       tracker.onMessageDelivered({ user: frank, deliveredAt: iso(3000) }); // unknown -> ignored
@@ -216,7 +216,7 @@ describe('OwnMessageDeliveryReadTracker', () => {
 
     it('prevents search for message if last read message id is provided', () => {
       const locator = vi.fn().mockImplementation(() => {});
-      tracker = new OwnMessageReceiptsTracker({ locateMessage: locator });
+      tracker = new MessageReceiptsTracker({ locateMessage: locator });
       const user = U('frank');
       tracker.onMessageDelivered({
         user,