@amityco/ts-sdk 7.1.1-e23f973a.0 → 7.2.0

package/src/channelRepository/utils/prepareChannelPayload.ts

@@ -5,9 +5,8 @@ import { getChannelMarkers } from '~/marker/api/getChannelMarkers';
 import { updateChannelMessagePreviewCache } from '~/messagePreview/utils';
 import { getActiveClient } from '~/client/api/activeClient';
 import { pullFromCache } from '~/cache/api/pullFromCache';
-import { getSubChannelsUnreadCount } from './getSubChannelsUnreadCount';
-import { getChannelIsMentioned } from './getChannelIsMentioned';
 import { convertRawUserToInternalUser } from '~/userRepository/utils/convertRawUserToInternalUser';
+import { pushToCache } from '~/cache/api';
 
 export const MARKER_INCLUDED_CHANNEL_TYPE = ['broadcast', 'conversation', 'community'];
 export const isUnreadCountSupport = ({ type }: Pick<Amity.RawChannel, 'type'>) =>
@@ -48,6 +47,48 @@ export const preUpdateChannelCache = (
   });
 };
 
+const updateChannelUnread = ({
+  currentUserId,
+  channels,
+  channelUsers,
+}: {
+  currentUserId: Amity.User['userId'];
+  channels: Amity.RawChannel[];
+  channelUsers: Amity.RawMembership<'channel'>[];
+}) => {
+  for (let i = 0; i < channels.length; i += 1) {
+    const cacheKey = ['channelUnread', 'get', channels[i].channelId];
+    const channelUser = channelUsers.find(
+      channelUser =>
+        channelUser.channelId === channels[i].channelId && channelUser.userId === currentUserId,
+    );
+
+    let unreadCount = 0;
+    let readToSegment = null;
+    let lastMentionedSegment = null;
+    let isMentioned = false;
+
+    if (channelUser) {
+      readToSegment = channelUser.readToSegment;
+      lastMentionedSegment = channelUser.lastMentionedSegment;
+      unreadCount = Math.max(channels[i].messageCount - readToSegment, 0);
+      isMentioned = lastMentionedSegment > readToSegment;
+    }
+
+    const cacheChannelUnread: Amity.ChannelUnread = {
+      channelId: channels[i].channelId,
+      lastSegment: channels[i].messageCount,
+      readToSegment,
+      lastMentionedSegment,
+      unreadCount,
+      isMentioned,
+      isDeleted: channels[i].isDeleted || false,
+    };
+
+    pushToCache(cacheKey, cacheChannelUnread);
+  }
+};
+
 export const prepareChannelPayload = async (
   rawPayload: Amity.ChannelPayload,
   options: { isMessagePreviewUpdated?: boolean } = { isMessagePreviewUpdated: true },
@@ -64,28 +105,38 @@ export const prepareChannelPayload = async (
     updateChannelMessagePreviewCache(rawPayload);
   }
 
-  const markerIds = rawPayload.channels
-    // filter channel by type. Only conversation, community and broadcast type are included.
-    .filter(isUnreadCountSupport)
-    .map(({ channelInternalId }) => channelInternalId);
-
-  if (markerIds.length > 0) {
-    // since the get markers method requires a channel cache to function with the reducer.
-    preUpdateChannelCache(rawPayload, { isMessagePreviewUpdated: options.isMessagePreviewUpdated });
-
-    try {
-      await getChannelMarkers(markerIds);
-    } catch (e) {
-      // empty block (from the spec, allow marker fetch to fail without having to do anything)
+  if (client.useLegacyUnreadCount) {
+    updateChannelUnread({
+      channels: rawPayload.channels,
+      channelUsers: rawPayload.channelUsers,
+      currentUserId: client.userId!,
+    });
+  } else {
+    const markerIds = rawPayload.channels
+      // filter channel by type. Only conversation, community and broadcast type are included.
+      .filter(isUnreadCountSupport)
+      .map(({ channelInternalId }) => channelInternalId);
+
+    if (markerIds.length > 0) {
+      // since the get markers method requires a channel cache to function with the reducer.
+      preUpdateChannelCache(rawPayload, {
+        isMessagePreviewUpdated: options.isMessagePreviewUpdated,
+      });
+
+      try {
+        await getChannelMarkers(markerIds);
+      } catch (e) {
+        // empty block (from the spec, allow marker fetch to fail without having to do anything)
+      }
     }
   }
 
-  // attach marker to channel
+  // convert raw channel to internal channel
   const channels = rawPayload.channels.map(payload =>
     convertFromRaw(payload, { isMessagePreviewUpdated: options.isMessagePreviewUpdated }),
   );
 
-  // user marker to channel users
+  // convert raw channel user to membership (add user object)
   const channelUsers: Amity.Membership<'channel'>[] = rawPayload.channelUsers.map(channelUser => {
     return convertRawMembershipToMembership<'channel'>(channelUser);
   });

package/src/client/api/createClient.ts

@@ -50,7 +50,7 @@ export const createClient = (
     rteEnabled = true,
   }: {
     debugSession?: string;
-    apiEndpoint?: { http?: string; mqtt?: string };
+    apiEndpoint?: { http?: string; mqtt?: string; upload?: string };
     prefixDeviceIdKey?: string;
     rteEnabled?: boolean;
   } = {},
@@ -63,9 +63,11 @@ export const createClient = (
   });
 
   const httpEndpoint = apiEndpoint?.http ?? computeUrl('http', apiRegion);
+  const uploadEndpoint = apiEndpoint?.upload ?? computeUrl('upload', apiRegion);
   const mqttEndpoint = apiEndpoint?.mqtt ?? computeUrl('mqtt', apiRegion);
 
   const http = createHttpTransport(httpEndpoint);
+  const upload = createHttpTransport(uploadEndpoint);
 
   let ws;
   let mqtt;
@@ -86,6 +88,8 @@ export const createClient = (
   const sessionHandler = undefined;
 
   const isUnreadCountEnabled = false;
+  // Legacy unread count is true by default
+  const useLegacyUnreadCount = true;
 
   const client = {
     version: `${VERSION}`,
@@ -103,6 +107,7 @@ export const createClient = (
     http,
     ws,
     mqtt,
+    upload,
     emitter,
 
     /*
@@ -122,6 +127,7 @@ export const createClient = (
     use: () => setActiveClient(client),
 
     isUnreadCountEnabled,
+    useLegacyUnreadCount,
 
     getMarkerSyncConsistentMode,
 

package/src/client/api/enableUnreadCount.ts

@@ -17,6 +17,7 @@ export const enableUnreadCount = () => {
   if (client.isUnreadCountEnabled) return false;
 
   client.isUnreadCountEnabled = true;
+  client.useLegacyUnreadCount = false;
 
   client.emitter.emit('unreadCountEnabled', true);
 

package/src/client/api/login.ts

@@ -11,6 +11,7 @@ import { onUserDeleted } from '~/userRepository/events/onUserDeleted';
 
 import analyticsEngineOnLoginHandler from '~/analytic/utils/analyticsEngineOnLoginHandler';
 import readReceiptSyncEngineOnLoginHandler from '~/client/utils/ReadReceiptSync/readReceiptSyncEngineOnLoginHandler';
+import legacyReadReceiptSyncEngineOnLoginHandler from '~/client/utils/ReadReceiptSync/legacyReadReceiptSyncEngineOnLoginHandler';
 import objectResolverEngineOnLoginHandler from '~/client/utils/ObjectResolver/objectResolverEngineOnLoginHandler';
 import { logout } from './logout';
 
@@ -200,10 +201,13 @@ export const login = async (
 
       markReadEngineOnLoginHandler(),
       analyticsEngineOnLoginHandler(),
-      readReceiptSyncEngineOnLoginHandler(),
       objectResolverEngineOnLoginHandler(),
     );
 
+    if (client.useLegacyUnreadCount) {
+      subscriptions.push(readReceiptSyncEngineOnLoginHandler());
+    } else subscriptions.push(legacyReadReceiptSyncEngineOnLoginHandler());
+
     const markerSyncUnsubscriber = await startMarkerSync();
     subscriptions.push(markerSyncUnsubscriber);
   }

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

@@ -0,0 +1,267 @@
+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';
+
+export class LegacyMessageReadReceiptSyncEngine {
+  private client: Amity.Client;
+
+  private isActive = true;
+
+  private MAX_RETRY = 3;
+
+  private JOB_QUEUE_SIZE = 120;
+
+  private jobQueue: Amity.LegacyReadReceiptSyncJob[] = [];
+
+  private timer: NodeJS.Timer | undefined;
+
+  // Interval for message read receipt sync in seconds
+  private RECEIPT_SYNC_INTERVAL = 1;
+
+  constructor() {
+    this.client = getActiveClient();
+    // Get remaining unsync read receipts from cache
+    this.getUnsyncJobs();
+  }
+
+  //  Call this when client call client.login
+  startSyncReadReceipt() {
+    // Start timer when start receipt sync
+    this.timer = setInterval(() => {
+      this.syncReadReceipts();
+    }, this.RECEIPT_SYNC_INTERVAL * 1000);
+  }
+
+  // Read receipt observer handling
+  syncReadReceipts(): void {
+    if (this.jobQueue.length === 0 || this.isActive === false) return;
+
+    const readReceipt = this.getReadReceipt();
+    if (readReceipt) {
+      this.markReadApi(readReceipt);
+    }
+  }
+
+  private getUnsyncJobs(): void {
+    // Get all read receipts that has latestSyncSegment < latestSegment
+    const readReceipts = queryCache<Amity.LegacyReadReceipt>(['legacyReadReceipt'])?.filter(
+      ({ data }) => {
+        return data.latestSyncSegment < data.latestSegment;
+      },
+    );
+
+    // Enqueue unsync read receipts to the job queue
+    readReceipts?.forEach(({ data: readReceipt }) => {
+      this.enqueueReadReceipt(readReceipt.subChannelId, readReceipt.latestSegment);
+    });
+  }
+
+  private getReadReceipt(): Amity.LegacyReadReceiptSyncJob | undefined {
+    // Get first read receipt in queue
+    const syncJob = this.jobQueue[0];
+
+    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.LegacyReadReceipt>([
+      'legacyReadReceipt',
+      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();
+  }
+
+  private async markReadApi(syncJob: Amity.LegacyReadReceiptSyncJob): Promise<void> {
+    const newSyncJob = syncJob;
+    newSyncJob.syncState = Amity.ReadReceiptSyncState.SYNCING;
+
+    const { subChannelId, segment } = newSyncJob;
+
+    const response = await markAsReadBySegment({ subChannelId, readToSegment: segment });
+
+    if (response) {
+      this.removeSynedReceipt(syncJob.subChannelId, syncJob.segment);
+
+      const readReceiptCache = pullFromCache<Amity.LegacyReadReceipt>([
+        'legacyReadReceipt',
+        subChannelId,
+      ])?.data;
+
+      pushToCache(['legacyReadReceipt', 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;
+      }
+    }
+  }
+
+  private removeSynedReceipt(subChannelId: string, segment: number) {
+    const syncJobs = this.jobQueue;
+
+    syncJobs.forEach(job => {
+      if (job.subChannelId === subChannelId && job.segment <= segment) {
+        this.removeJobFromQueue(job);
+      }
+    });
+  }
+
+  private startObservingReadReceiptQueue(): void {
+    if (this.client.isUnreadCountEnabled) {
+      this.isActive = true;
+      this.startSyncReadReceipt();
+    }
+  }
+
+  private stopObservingReadReceiptQueue(): void {
+    this.isActive = false;
+
+    const syncJobs = this.jobQueue;
+    syncJobs.map(job => {
+      if (job.syncState === Amity.ReadReceiptSyncState.SYNCING) {
+        return { ...job, syncState: Amity.ReadReceiptSyncState.CREATED };
+      }
+
+      return job;
+    });
+
+    if (this.timer) clearInterval(this.timer);
+  }
+
+  // Session Management
+  onSessionEstablished(): void {
+    this.startObservingReadReceiptQueue();
+  }
+
+  onSessionDestroyed(): void {
+    this.stopObservingReadReceiptQueue();
+    this.jobQueue = [];
+  }
+
+  onTokenExpired(): void {
+    this.stopObservingReadReceiptQueue();
+  }
+
+  // Network Connection Management
+  onNetworkOffline(): void {
+    // Stop observing to the read receipt queue.
+    this.stopObservingReadReceiptQueue();
+  }
+
+  onNetworkOnline(): void {
+    // Resume observing to the read receipt queue.
+    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;
+
+    if (subChannelUnreadInfo && segment > subChannelUnreadInfo.readToSegment) {
+      subChannelUnreadInfo.readToSegment = segment;
+      subChannelUnreadInfo.unreadCount = Math.max(subChannelUnreadInfo.lastSegment - segment, 0);
+
+      const channelUnreadInfo = reCalculateChannelUnreadInfo(subChannelUnreadInfo.channelId);
+      fireEvent('local.channelUnreadInfo.updated', channelUnreadInfo);
+
+      pushToCache(cacheKey, subChannelUnreadInfo);
+      fireEvent('local.subChannelUnread.updated', subChannelUnreadInfo);
+    }
+
+    // Step 2: Enqueue the read receipt
+    this.enqueueReadReceipt(subChannelId, segment);
+  }
+
+  private enqueueReadReceipt(subChannelId: string, segment: number): void {
+    const readReceipt = pullFromCache<Amity.LegacyReadReceipt>([
+      'legacyReadReceipt',
+      subChannelId,
+    ])?.data;
+
+    // Create new read receipt if it's not exists and add job to queue
+    if (!readReceipt) {
+      const readReceiptSubChannel: Amity.LegacyReadReceipt = {
+        subChannelId,
+        latestSegment: segment,
+        latestSyncSegment: 0,
+      };
+
+      pushToCache(['legacyReadReceipt', subChannelId], readReceiptSubChannel);
+    } else if (readReceipt.latestSegment < segment) {
+      pushToCache(['legacyReadReceipt', subChannelId], { ...readReceipt, latestSegment: segment });
+    } else if (readReceipt.latestSyncSegment >= segment) {
+      // Skip the job when lastSyncSegment > = segment
+      return;
+    }
+
+    let syncJob: Amity.LegacyReadReceiptSyncJob | null = this.getSyncJob(subChannelId);
+
+    if (syncJob === null || syncJob.syncState === Amity.ReadReceiptSyncState.SYNCING) {
+      syncJob = {
+        subChannelId,
+        segment,
+        syncState: Amity.ReadReceiptSyncState.CREATED,
+        retryCount: 0,
+      };
+
+      this.enqueueJob(syncJob);
+    } else if (syncJob.segment < segment) {
+      syncJob.segment = segment;
+    }
+  }
+
+  private getSyncJob(subChannelId: string): Amity.LegacyReadReceiptSyncJob | null {
+    const syncJobs = this.jobQueue;
+
+    const targetJob = syncJobs.find(job => job.subChannelId === subChannelId);
+
+    return targetJob || null;
+  }
+
+  private enqueueJob(syncJob: Amity.LegacyReadReceiptSyncJob) {
+    if (this.jobQueue.length < this.JOB_QUEUE_SIZE) {
+      this.jobQueue.push(syncJob);
+    } else {
+      // Remove oldest job when queue reach maximum capacity
+      this.jobQueue.shift();
+      this.jobQueue.push(syncJob);
+    }
+  }
+
+  private removeJobFromQueue(item: Amity.LegacyReadReceiptSyncJob) {
+    const index = this.jobQueue.indexOf(item);
+    if (index > -1) {
+      this.jobQueue.splice(index, 1);
+    }
+  }
+}
+
+let instance: LegacyMessageReadReceiptSyncEngine | null = null;
+
+export default {
+  getInstance: () => {
+    if (!instance) instance = new LegacyMessageReadReceiptSyncEngine();
+
+    return instance;
+  },
+};

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();
+  };
+};