@amityco/ts-sdk 7.1.0 → 7.1.1-c8d4edca.0

package/src/client/utils/ReadReceiptSync/legacyReadReceiptSyncEngineOnLoginHandler.ts

@@ -0,0 +1,21 @@
+import { onSessionStateChange } from '~/client/events/onSessionStateChange';
+import LegacyReadReceiptSyncEngine from '~/client/utils/ReadReceiptSync/legacyReadReceiptSyncEngine';
+
+export default () => {
+  const readReceiptSyncEngine = LegacyReadReceiptSyncEngine.getInstance();
+  readReceiptSyncEngine.startSyncReadReceipt();
+
+  onSessionStateChange(state => {
+    if (state === Amity.SessionStates.ESTABLISHED) {
+      readReceiptSyncEngine.onSessionEstablished();
+    } else if (state === Amity.SessionStates.TOKEN_EXPIRED) {
+      readReceiptSyncEngine.onTokenExpired();
+    } else {
+      readReceiptSyncEngine.onSessionDestroyed();
+    }
+  });
+
+  return () => {
+    readReceiptSyncEngine.onSessionDestroyed();
+  };
+};

package/src/client/utils/ReadReceiptSync/readReceiptSyncEngine.ts

@@ -1,8 +1,7 @@
 import { pullFromCache, pushToCache, queryCache } from '~/cache/api';
 import { getActiveClient } from '../../api/activeClient';
-import { markAsReadBySegment } from '~/subChannelRepository/api/markAsReadBySegment';
-import { reCalculateChannelUnreadInfo } from '~/marker/utils/reCalculateChannelUnreadInfo';
 import { fireEvent } from '~/core/events';
+import { markChannelsAsReadBySegment } from '~/channelRepository/api/markChannelsAsReadBySegment';
 
 export class MessageReadReceiptSyncEngine {
   private client: Amity.Client;
@@ -38,9 +37,10 @@ export class MessageReadReceiptSyncEngine {
   syncReadReceipts(): void {
     if (this.jobQueue.length === 0 || this.isActive === false) return;
 
-    const readReceipt = this.getReadReceipt();
-    if (readReceipt) {
-      this.markReadApi(readReceipt);
+    const readReceipts = this.getReadReceipts();
+    console.log('[New 🌟 readReceipts] Sync read receipts', readReceipts);
+    if (readReceipts) {
+      this.markReadApi(readReceipts);
     }
   }
 
@@ -52,79 +52,64 @@ export class MessageReadReceiptSyncEngine {
 
     // Enqueue unsync read receipts to the job queue
     readReceipts?.forEach(({ data: readReceipt }) => {
-      this.enqueueReadReceipt(readReceipt.subChannelId, readReceipt.latestSegment);
+      this.enqueueReadReceipt(readReceipt.channelId, readReceipt.latestSegment);
     });
   }
 
-  private getReadReceipt(): Amity.ReadReceiptSyncJob | undefined {
-    // Get first read receipt in queue
-    const syncJob = this.jobQueue[0];
+  private getReadReceipts(): Amity.ReadReceiptSyncJob[] | undefined {
+    // get all read receipts from queue, now the queue is empty
+    const syncJob = this.jobQueue.splice(0, this.jobQueue.length);
+    if (syncJob.length === 0) return;
 
-    if (!syncJob) return;
-    // Skip when it's syncing
-    if (syncJob.syncState === Amity.ReadReceiptSyncState.SYNCING) return;
-
-    // Get readReceipt from cache by subChannelId
-    const readReceipt = pullFromCache<Amity.ReadReceipt>([
-      'readReceipt',
-      syncJob.subChannelId,
-    ])?.data;
-
-    if (!readReceipt) return;
-
-    if (readReceipt?.latestSegment > readReceipt?.latestSyncSegment) {
-      syncJob.segment = readReceipt.latestSegment;
-      return syncJob;
-    }
-    // Clear all synced job in job queue
-    this.removeSynedReceipt(readReceipt.subChannelId, readReceipt.latestSegment);
-
-    // Recursion getReadReceipt() until get unsync read receipt or job queue is empty
-    return this.getReadReceipt();
+    return syncJob.filter(job => {
+      const readReceipt = pullFromCache<Amity.ReadReceipt>(['readReceipt', job.channelId])?.data;
+      if (!readReceipt) return false;
+      if (readReceipt.latestSegment > readReceipt.latestSyncSegment) return true;
+      return false;
+    });
   }
 
-  private async markReadApi(syncJob: Amity.ReadReceiptSyncJob): Promise<void> {
-    const newSyncJob = syncJob;
-    newSyncJob.syncState = Amity.ReadReceiptSyncState.SYNCING;
-
-    const { subChannelId, segment } = newSyncJob;
+  private async markReadApi(syncJobs: Amity.ReadReceiptSyncJob[]): Promise<void> {
+    // constuct payload
+    // example: [{ channelId: 'channelId', readToSegment: 2 }]
+    const syncJobsPayload = syncJobs.map(job => {
+      return {
+        channelId: job.channelId,
+        readToSegment: job.segment,
+      };
+    });
 
-    const response = await markAsReadBySegment({ subChannelId, readToSegment: segment });
+    const response = await markChannelsAsReadBySegment(syncJobsPayload);
 
     if (response) {
-      this.removeSynedReceipt(syncJob.subChannelId, syncJob.segment);
-
-      const readReceiptCache = pullFromCache<Amity.ReadReceipt>([
-        'readReceipt',
-        subChannelId,
-      ])?.data;
-
-      pushToCache(['readReceipt', subChannelId], {
-        ...readReceiptCache,
-        latestSyncSegment: segment,
-      });
-    } else if (!response) {
-      if (newSyncJob.retryCount > this.MAX_RETRY) {
-        this.removeJobFromQueue(newSyncJob);
-      } else {
-        newSyncJob.retryCount += 1;
-        newSyncJob.syncState = Amity.ReadReceiptSyncState.CREATED;
+      for (let i = 0; i < syncJobs.length; i += 1) {
+        // update lastestSyncSegment in read receipt cache
+        const cacheKey = ['readReceipt', syncJobs[i].channelId];
+        const readReceiptCache = pullFromCache<Amity.ReadReceipt>(cacheKey)?.data;
+
+        pushToCache(cacheKey, {
+          ...readReceiptCache,
+          latestSyncSegment: syncJobs[i].segment,
+        });
       }
-    }
-  }
+    } else {
+      for (let i = 0; i < syncJobs.length; i += 1) {
+        // push them back to queue if the syncing is failed and retry count is less than max retry
+        if (syncJobs[i].retryCount >= this.MAX_RETRY) return;
 
-  private removeSynedReceipt(subChannelId: string, segment: number) {
-    const syncJobs = this.jobQueue;
+        const updatedJob = {
+          ...syncJobs[i],
+          syncState: Amity.ReadReceiptSyncState.CREATED,
+          retryCount: syncJobs[i].retryCount + 1,
+        };
 
-    syncJobs.forEach(job => {
-      if (job.subChannelId === subChannelId && job.segment <= segment) {
-        this.removeJobFromQueue(job);
+        this.enqueueJob(updatedJob);
       }
-    });
+    }
   }
 
   private startObservingReadReceiptQueue(): void {
-    if (this.client.isUnreadCountEnabled) {
+    if (this.client.useLegacyUnreadCount) {
       this.isActive = true;
       this.startSyncReadReceipt();
     }
@@ -133,8 +118,7 @@ export class MessageReadReceiptSyncEngine {
   private stopObservingReadReceiptQueue(): void {
     this.isActive = false;
 
-    const syncJobs = this.jobQueue;
-    syncJobs.map(job => {
+    this.jobQueue.map(job => {
       if (job.syncState === Amity.ReadReceiptSyncState.SYNCING) {
         return { ...job, syncState: Amity.ReadReceiptSyncState.CREATED };
       }
@@ -170,50 +154,49 @@ export class MessageReadReceiptSyncEngine {
     this.startObservingReadReceiptQueue();
   }
 
-  markRead(subChannelId: string, segment: number): void {
-    // Step 1: Optimistic update of subChannelUnreadInfo.readToSegment to message.segment
-    const cacheKey = ['subChannelUnreadInfo', 'get', subChannelId];
-    const subChannelUnreadInfo = pullFromCache<Amity.SubChannelUnreadInfo>(cacheKey)?.data;
+  markRead(channelId: string, segment: number): void {
+    // Step 1: Optimistic update of channelUnread.readToSegment to message.segment and update unreadCount value
+    const cacheKey = ['channelUnread', 'get', channelId];
+    const channelUnread = pullFromCache<Amity.ChannelUnread>(cacheKey)?.data;
 
-    if (subChannelUnreadInfo && segment > subChannelUnreadInfo.readToSegment) {
-      subChannelUnreadInfo.readToSegment = segment;
-      subChannelUnreadInfo.unreadCount = Math.max(subChannelUnreadInfo.lastSegment - segment, 0);
+    console.log('[New 🌟] Mark read => channel unread', channelUnread);
 
-      const channelUnreadInfo = reCalculateChannelUnreadInfo(subChannelUnreadInfo.channelId);
-      fireEvent('local.channelUnread.updated', channelUnreadInfo);
+    if (channelUnread && segment > channelUnread.readToSegment) {
+      channelUnread.readToSegment = segment;
+      channelUnread.unreadCount = Math.max(channelUnread.lastSegment - segment, 0);
 
-      pushToCache(cacheKey, subChannelUnreadInfo);
-      fireEvent('local.subChannelUnread.updated', subChannelUnreadInfo);
+      pushToCache(cacheKey, channelUnread);
+      fireEvent('local.channelUnread.updated', channelUnread);
     }
 
     // Step 2: Enqueue the read receipt
-    this.enqueueReadReceipt(subChannelId, segment);
+    this.enqueueReadReceipt(channelId, segment);
   }
 
-  private enqueueReadReceipt(subChannelId: string, segment: number): void {
-    const readReceipt = pullFromCache<Amity.ReadReceipt>(['readReceipt', subChannelId])?.data;
+  private enqueueReadReceipt(channelId: string, segment: number): void {
+    const readReceipt = pullFromCache<Amity.ReadReceipt>(['readReceipt', channelId])?.data;
 
-    // Create new read receipt if it's not exists and add job to queue
+    // Create new read receipt if it's not exists and add the job to queue
     if (!readReceipt) {
-      const readReceiptSubChannel: Amity.ReadReceipt = {
-        subChannelId,
+      const readReceiptChannel: Amity.ReadReceipt = {
+        channelId,
         latestSegment: segment,
         latestSyncSegment: 0,
       };
-
-      pushToCache(['readReceipt', subChannelId], readReceiptSubChannel);
+      pushToCache(['readReceipt', channelId], readReceiptChannel);
     } else if (readReceipt.latestSegment < segment) {
-      pushToCache(['readReceipt', subChannelId], { ...readReceipt, latestSegment: segment });
+      // Update latestSegment in read receipt cache
+      pushToCache(['readReceipt', channelId], { ...readReceipt, latestSegment: segment });
     } else if (readReceipt.latestSyncSegment >= segment) {
       // Skip the job when lastSyncSegment > = segment
       return;
     }
 
-    let syncJob: Amity.ReadReceiptSyncJob | null = this.getSyncJob(subChannelId);
+    let syncJob: Amity.ReadReceiptSyncJob | null = this.getSyncJob(channelId);
 
     if (syncJob === null || syncJob.syncState === Amity.ReadReceiptSyncState.SYNCING) {
       syncJob = {
-        subChannelId,
+        channelId,
         segment,
         syncState: Amity.ReadReceiptSyncState.CREATED,
         retryCount: 0,
@@ -225,11 +208,9 @@ export class MessageReadReceiptSyncEngine {
     }
   }
 
-  private getSyncJob(subChannelId: string): Amity.ReadReceiptSyncJob | null {
-    const syncJobs = this.jobQueue;
-
-    const targetJob = syncJobs.find(job => job.subChannelId === subChannelId);
-
+  private getSyncJob(channelId: string): Amity.ReadReceiptSyncJob | null {
+    const { jobQueue } = this;
+    const targetJob = jobQueue.find(job => job.channelId === channelId);
     return targetJob || null;
   }
 
@@ -242,13 +223,6 @@ export class MessageReadReceiptSyncEngine {
       this.jobQueue.push(syncJob);
     }
   }
-
-  private removeJobFromQueue(item: Amity.ReadReceiptSyncJob) {
-    const index = this.jobQueue.indexOf(item);
-    if (index > -1) {
-      this.jobQueue.splice(index, 1);
-    }
-  }
 }
 
 let instance: MessageReadReceiptSyncEngine | null = null;

package/src/core/model/idResolvers.ts

@@ -26,6 +26,8 @@ const idResolvers: Resolvers = {
   channelUnreadInfo: ({ channelId }) => channelId,
   subChannelUnreadInfo: ({ subChannelId }) => subChannelId,
 
+  channelUnread: ({ channelId }) => channelId,
+
   channelMarker: ({ entityId, userId }) => `${entityId}#${userId}`,
   subChannelMarker: ({ entityId, feedId, userId }) => `${entityId}#${feedId}#${userId}`,
   messageMarker: ({ feedId, contentId, creatorId }) => `${feedId}#${contentId}#${creatorId}`,

package/src/marker/events/onChannelUnreadInfoUpdatedLocal.ts

@@ -0,0 +1,29 @@
+import { getActiveClient } from '~/client/api/activeClient';
+import { createEventSubscriber } from '~/core/events';
+
+/**
+ * Internal used only
+ *
+ * Fired when an {@link Amity.userMessageFeedMarkers} has been resolved by Object Rsesolver
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category MessageMarker Events
+ */
+export const onChannelUnreadInfoUpdatedLocal = (
+  callback: Amity.Listener<Amity.Events['local.channelUnreadInfo.updated']>,
+): Amity.Unsubscriber => {
+  const client = getActiveClient();
+
+  const filter = (payload: Amity.Events['local.channelUnreadInfo.updated']) => {
+    callback(payload);
+  };
+
+  return createEventSubscriber(
+    client,
+    'channelMarker/onChannelUnreadInfoUpdatedLocal',
+    'local.channelUnreadInfo.updated',
+    filter,
+  );
+};

package/src/marker/events/onChannelUnreadUpdatedLocal.ts

@@ -22,7 +22,7 @@ export const onChannelUnreadUpdatedLocal = (
 
   return createEventSubscriber(
     client,
-    'channelMarker/onChannelUnreadUpdatedLocal',
+    'channel/onChannelUnreadUpdatedLocal',
     'local.channelUnread.updated',
     filter,
   );

package/src/messageRepository/utils/markReadMessage.ts

@@ -1,8 +1,15 @@
+import { getActiveClient } from '~/client/api/activeClient';
 import ReadReceiptSyncEngine from '~/client/utils/ReadReceiptSync/readReceiptSyncEngine';
+import LegacyReadReceiptSyncEngine from '~/client/utils/ReadReceiptSync/legacyReadReceiptSyncEngine';
 
 export const markReadMessage = (message: Amity.InternalMessage) => {
-  const { subChannelId, channelSegment } = message;
-  const markReadReceiptEngine = ReadReceiptSyncEngine.getInstance();
+  const client = getActiveClient();
 
-  markReadReceiptEngine.markRead(subChannelId, channelSegment);
+  if (client.useLegacyUnreadCount) {
+    const markReadReceiptEngine = ReadReceiptSyncEngine.getInstance();
+    markReadReceiptEngine.markRead(message.channelId, message.channelSegment);
+  } else {
+    const markReadReceiptEngine = LegacyReadReceiptSyncEngine.getInstance();
+    markReadReceiptEngine.markRead(message.subChannelId, message.channelSegment);
+  }
 };