@amityco/ts-sdk 7.10.1-86aa7706.0 → 7.10.1-9fe9d33d.0

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

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

@@ -0,0 +1,237 @@
+import { pullFromCache, pushToCache, queryCache } from '~/cache/api';
+import { getActiveClient } from '../../api/activeClient';
+import { fireEvent } from '~/core/events';
+import { markChannelsAsReadBySegment } from '~/channelRepository/api/markChannelsAsReadBySegment';
+
+export class MessageReadReceiptSyncEngine {
+  private client: Amity.Client;
+
+  private isActive = true;
+
+  private MAX_RETRY = 3;
+
+  private JOB_QUEUE_SIZE = 120;
+
+  private jobQueue: Amity.ReadReceiptSyncJob[] = [];
+
+  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 readReceipts = this.getReadReceipts();
+    if (readReceipts) {
+      this.markReadApi(readReceipts);
+    }
+  }
+
+  private getUnsyncJobs(): void {
+    // Get all read receipts that has latestSyncSegment < latestSegment
+    const readReceipts = queryCache<Amity.ReadReceipt>(['readReceipt'])?.filter(({ data }) => {
+      return data.latestSyncSegment < data.latestSegment;
+    });
+
+    // Enqueue unsync read receipts to the job queue
+    readReceipts?.forEach(({ data: readReceipt }) => {
+      this.enqueueReadReceipt(readReceipt.channelId, readReceipt.latestSegment);
+    });
+  }
+
+  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;
+
+    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(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 markChannelsAsReadBySegment(syncJobsPayload);
+
+    if (response) {
+      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;
+
+        const updatedJob = {
+          ...syncJobs[i],
+          syncState: Amity.ReadReceiptSyncState.CREATED,
+          retryCount: syncJobs[i].retryCount + 1,
+        };
+
+        this.enqueueJob(updatedJob);
+      }
+    }
+  }
+
+  private startObservingReadReceiptQueue(): void {
+    if (this.client.useLegacyUnreadCount) {
+      this.isActive = true;
+      this.startSyncReadReceipt();
+    }
+  }
+
+  private stopObservingReadReceiptQueue(): void {
+    this.isActive = false;
+
+    this.jobQueue.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(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 (
+      typeof channelUnread?.readToSegment === 'number' &&
+      channelUnread &&
+      segment > channelUnread.readToSegment
+    ) {
+      channelUnread.readToSegment = segment;
+      channelUnread.unreadCount = Math.max(channelUnread.lastSegment - segment, 0);
+
+      pushToCache(cacheKey, channelUnread);
+      fireEvent('local.channelUnread.updated', [channelUnread]);
+    }
+
+    // Step 2: Enqueue the read receipt
+    this.enqueueReadReceipt(channelId, segment);
+  }
+
+  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 the job to queue
+    if (!readReceipt) {
+      const readReceiptChannel: Amity.ReadReceipt = {
+        channelId,
+        latestSegment: segment,
+        latestSyncSegment: 0,
+      };
+      pushToCache(['readReceipt', channelId], readReceiptChannel);
+    } else if (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(channelId);
+
+    if (syncJob === null || syncJob.syncState === Amity.ReadReceiptSyncState.SYNCING) {
+      syncJob = {
+        channelId,
+        segment,
+        syncState: Amity.ReadReceiptSyncState.CREATED,
+        retryCount: 0,
+      };
+
+      this.enqueueJob(syncJob);
+    } else if (syncJob.segment < segment) {
+      syncJob.segment = segment;
+    }
+  }
+
+  private getSyncJob(channelId: string): Amity.ReadReceiptSyncJob | null {
+    const { jobQueue } = this;
+    const targetJob = jobQueue.find(job => job.channelId === channelId);
+    return targetJob || null;
+  }
+
+  private enqueueJob(syncJob: Amity.ReadReceiptSyncJob) {
+    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);
+    }
+  }
+}
+
+let instance: MessageReadReceiptSyncEngine | null = null;
+
+export default {
+  getInstance: () => {
+    if (!instance) instance = new MessageReadReceiptSyncEngine();
+
+    return instance;
+  },
+};

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

@@ -0,0 +1,21 @@
+import { onSessionStateChange } from '~/client/events/onSessionStateChange';
+import ReadReceiptSyncEngine from '~/client/utils/ReadReceiptSync/readReceiptSyncEngine';
+
+export default () => {
+  const readReceiptSyncEngine = ReadReceiptSyncEngine.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/SessionWatcher.ts

@@ -0,0 +1,35 @@
+type SessionStateCallback = (state: Amity.SessionStates) => void;
+
+class SessionWatcher {
+  private _sessionState: Amity.SessionStates = Amity.SessionStates.NOT_LOGGED_IN;
+
+  private _listener = new Map<SessionStateCallback, SessionStateCallback>();
+
+  onSessionStateChange(callback: SessionStateCallback) {
+    this._listener.set(callback, callback);
+    return () => {
+      this._listener.delete(callback);
+    };
+  }
+
+  setSessionState(state: Amity.SessionStates) {
+    if (this._sessionState === state) return;
+    this._sessionState = state;
+    this._listener.forEach(cb => cb(state));
+  }
+
+  destroy() {
+    this._listener.clear();
+  }
+}
+
+let instance: SessionWatcher;
+
+export default {
+  getInstance: () => {
+    if (!instance) {
+      instance = new SessionWatcher();
+    }
+    return instance;
+  },
+};

package/src/client/utils/endpoints.ts

@@ -0,0 +1,15 @@
+export const API_REGIONS = {
+  EU: 'eu',
+  SG: 'sg',
+  US: 'us',
+} as const;
+
+const URLS = {
+  http: 'https://apix.{region}.amity.co',
+  upload: 'https://upload.{region}.amity.co',
+  mqtt: 'wss://sse.{region}.amity.co:443/mqtt',
+} as const;
+
+export function computeUrl(type: keyof typeof URLS, region: string) {
+  return URLS[type].replace('{region}', region);
+}

package/src/client/utils/hasPermission/checkChannelPermission.ts

@@ -0,0 +1,22 @@
+import { pullFromCache } from '~/cache/api';
+import { checkUserPermission } from './checkUserPermission';
+
+export const checkChannelPermission = (
+  userId: Amity.User['userId'] | undefined,
+  permission: string,
+  channelId: Amity.Channel['channelId'],
+) => {
+  if (!userId) return false;
+
+  const member = pullFromCache<Amity.Membership<'channel'>>([
+    'channelUsers',
+    'get',
+    `${channelId}#${userId}`,
+  ])?.data;
+
+  if (!member) return false;
+
+  if (member.permissions.some(x => x === permission)) return true;
+
+  return checkUserPermission(userId, permission);
+};

package/src/client/utils/hasPermission/checkCommunityPermission.ts

@@ -0,0 +1,22 @@
+import { pullFromCache } from '~/cache/api';
+import { checkUserPermission } from './checkUserPermission';
+
+export const checkCommunityPermission = (
+  userId: Amity.User['userId'] | undefined,
+  permission: string,
+  communityId: Amity.Community['communityId'],
+) => {
+  if (!userId) return false;
+
+  const member = pullFromCache<Amity.Membership<'community'>>([
+    'communityUsers',
+    'get',
+    `${communityId}#${userId}`,
+  ])?.data;
+
+  if (!member) return false;
+
+  if (member.permissions.some(x => x === permission)) return true;
+
+  return checkUserPermission(userId, permission);
+};

package/src/client/utils/hasPermission/checkUserPermission.ts

@@ -0,0 +1,12 @@
+import { pullFromCache } from '~/cache/api';
+
+export const checkUserPermission = (
+  userId: Amity.User['userId'] | undefined,
+  permission: string,
+) => {
+  const user = pullFromCache<Amity.User>(['user', 'get', userId])?.data;
+
+  if (!user) return false;
+
+  return user.permissions.some(x => x === permission);
+};

package/src/client/utils/hasPermission/hasPermission.ts

@@ -0,0 +1,18 @@
+import { getActiveClient } from '~/client/api/activeClient';
+import { checkCommunityPermission } from '~/client/utils/hasPermission/checkCommunityPermission';
+import { checkChannelPermission } from '~/client/utils/hasPermission/checkChannelPermission';
+import { checkUserPermission } from '~/client/utils/hasPermission/checkUserPermission';
+
+export const hasPermission = (permission: string) => {
+  const { userId } = getActiveClient();
+
+  return {
+    currentUser: () => checkUserPermission(userId, permission),
+
+    community: (communityId: Amity.Community['communityId']) =>
+      checkCommunityPermission(userId, permission, communityId),
+
+    channel: (channelId: Amity.Channel['channelId']) =>
+      checkChannelPermission(userId, permission, channelId),
+  };
+};

package/src/client/utils/hasPermission/index.ts

@@ -0,0 +1 @@
+export * from './hasPermission';

package/src/client/utils/index.ts

@@ -0,0 +1 @@
+export * from './markerSyncEngine';