@amityco/ts-sdk 0.0.1-be4fc2f.0 → 0.0.1-bef76fa.0

package/src/channel/observers/liveChannels.ts

@@ -0,0 +1,191 @@
+/* eslint-disable no-use-before-define */
+import { getResolver } from '~/core/model';
+import { pullFromCache, pushToCache } from '~/cache/api';
+import { getActiveClient } from '~/client/api';
+import {
+  createQuery,
+  runQuery,
+  queryOptions,
+  filterByPropEquality,
+  filterByChannelMembership,
+  sortByLastCreated,
+  sortByDisplayName,
+  sortByFirstCreated,
+} from '~/core/query';
+
+import {
+  COLLECTION_DEFAULT_CACHING_POLICY,
+  COLLECTION_DEFAULT_PAGINATION_LIMIT,
+  ENABLE_CACHE_MESSAGE,
+} from '~/utils/constants';
+
+import {
+  onChannelCreated,
+  onChannelDeleted,
+  onChannelMemberRead,
+  onChannelUpdated,
+} from '../events';
+import { queryChannels } from '../api';
+
+/**
+ * ```js
+ * import { liveChannels } from '@amityco/ts-sdk'
+ *
+ * let channels = []
+ * const unsub = liveChannels({
+ *   displayName: Amity.Channel['displayName'],
+ * }, response => merge(channels, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.Channel}s
+ *
+ * @param params for querying channels
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the channels
+ *
+ * @category Channel Live Collection
+ */
+export const liveChannels = (
+  params: Amity.ChannelLiveCollection,
+  callback: Amity.LiveCollectionCallback<Amity.Channel>,
+  config?: Amity.LiveCollectionConfig,
+) => {
+  const { log, cache, userId } = getActiveClient();
+
+  if (!cache) {
+    console.log(ENABLE_CACHE_MESSAGE);
+  }
+
+  const timestamp = Date.now();
+  log(`liveChannels(tmpid: ${timestamp}) > listen`);
+
+  const { limit: queryLimit, ...queryParams } = params;
+
+  const limit = queryLimit ?? COLLECTION_DEFAULT_PAGINATION_LIMIT;
+  const { policy = COLLECTION_DEFAULT_CACHING_POLICY } = config ?? {};
+
+  const disposers: Amity.Unsubscriber[] = [];
+  const cacheKey = ['channel', 'collection', {}];
+
+  const responder = (data: Amity.ChannelLiveCollectionCache) => {
+    let channels: Amity.Channel[] =
+      data.data
+        .map(channelId => pullFromCache<Amity.Channel>(['channel', 'get', channelId])!)
+        .filter(Boolean)
+        .map(({ data }) => data) ?? [];
+
+    channels = filterByPropEquality(channels, 'isDeleted', params.isDeleted);
+    channels = filterByPropEquality(channels, 'displayName', params.displayName);
+
+    if (params.types) {
+      channels = channels.filter(c => params.types?.includes(c.type));
+    }
+
+    if (params.tags) {
+      channels = channels.filter(c => c.tags?.some(t => params.tags?.includes(t)));
+    }
+
+    if (params.excludeTags) {
+      channels = channels.filter(c => !c.tags?.some(t => params.excludeTags?.includes(t)));
+    }
+
+    // userId is required to be able to filter channel by current active user
+    if (params.membership && userId) {
+      channels = filterByChannelMembership(channels, params.membership, userId);
+    }
+
+    const sortBy = params.sortBy || 'lastCreated';
+
+    if (sortBy === 'lastCreated' || sortBy === 'firstCreated') {
+      channels = channels.sort(sortBy === 'lastCreated' ? sortByLastCreated : sortByFirstCreated);
+    }
+
+    /*
+     * The server returns channels with empty | null displayName's first before
+     * returning sorted list of channels with displayNames
+     *
+     * This section needs to be updated as displayNames can be null as well
+     */
+    if (sortBy === 'displayName') {
+      channels = channels
+        // this needs to be aligned with the backend data type
+        .map(c => (c.displayName ? c : { ...c, displayName: '' }))
+        // @ts-ignore
+        .sort(sortByDisplayName);
+    }
+
+    callback({
+      onNextPage: onFetch,
+      data: channels,
+      hasNextPage: !!data.params?.page,
+      loading: data.loading,
+      error: data.error,
+    });
+  };
+
+  const realtimeRouter = (channel: Amity.Channel, action: Amity.ChannelActionType) => {
+    const collection = pullFromCache<Amity.ChannelLiveCollectionCache>(cacheKey)?.data;
+    if (!collection) return;
+
+    if (action === 'onCreate') {
+      collection.data = [...new Set([channel.channelId, ...collection.data])];
+      /*
+       * if the filter isDeleted is set, only collection item must be updated and not
+       * the collection
+       */
+    } else if (action === 'onDelete' && !params.isDeleted) {
+      collection.data = collection.data.filter(c => c !== channel.channelId);
+    }
+
+    pushToCache(cacheKey, collection);
+    responder(collection);
+  };
+
+  const onFetch = () => {
+    const collection = pullFromCache<Amity.ChannelLiveCollectionCache>(cacheKey)?.data;
+
+    const channels = collection?.data ?? [];
+
+    if (channels.length > 0 && !collection?.params.page) return;
+
+    const query = createQuery(queryChannels, {
+      ...queryParams,
+      page: collection?.params.page ?? { limit },
+    });
+
+    runQuery(
+      query,
+      ({ data: result, error, loading, nextPage: page }) => {
+        const data = {
+          loading,
+          error,
+          params: { page },
+          data: channels,
+        };
+
+        if (result) {
+          data.data = [...new Set([...channels, ...result.map(getResolver('channel'))])];
+        }
+
+        pushToCache(cacheKey, data);
+
+        responder(data);
+      },
+      queryOptions(policy),
+    );
+  };
+
+  disposers.push(
+    onChannelCreated(channel => realtimeRouter(channel, 'onCreate')),
+    onChannelDeleted(channel => realtimeRouter(channel, 'onDelete')),
+    onChannelUpdated(channel => realtimeRouter(channel, 'onUpdate')),
+    onChannelMemberRead(channel => realtimeRouter(channel, 'onRead')),
+  );
+
+  onFetch();
+
+  return () => {
+    log(`liveChannels(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};

package/src/channel/observers/observeChannel.ts

@@ -1,17 +1,18 @@
-import { createQuery, runQuery } from '~/core/query/query'
+import { createQuery, runQuery } from '~/core/query/query';
 
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { getChannel } from '../api'
+import { getChannel } from '../api';
 
 import {
   onChannelUpdated,
   onChannelDeleted,
   onChannelJoined,
   onChannelLeft,
-  onMemberAdded,
-  onMemberRemoved,
-} from '../events'
+  onChannelMemberAdded,
+  onChannelMemberRemoved,
+  onChannelMemberRead,
+} from '../events';
 
 /**
  * ```js
@@ -29,52 +30,47 @@ import {
  *
  * @category Channel Observer
  */
-export const observeChannel = <
-  Events extends ['onFetch', 'onUpdate', 'onDelete', 'onJoin', 'onLeft', 'onMemberAdded', 'onMemberRemoved']
->(
+export const observeChannel = <Events extends [Exclude<Amity.ChannelActionType, 'onCreate'>]>(
   channelId: string,
-  callback: Amity.ObjectListener<Amity.QueryResult<Amity.Channel>, Events>
+  callback: Amity.ObjectListener<Amity.Snapshot<Amity.Channel>, Events>,
 ): Amity.Unsubscriber => {
-  const { log } = getActiveClient()
+  const { log } = getActiveClient();
 
-  const timestamp = Date.now()
-  log(`observeChannel(tmpid: ${timestamp}) > listen`)
+  const timestamp = Date.now();
+  log(`observeChannel(tmpid: ${timestamp}) > listen`);
 
   // wrapper function to make sure
-  const router = (
-    result: Amity.QueryResult<Amity.Channel>,
-    action: Events[number]
-  ) => {
+  const router = (result: Amity.Snapshot<Amity.Channel>, action: Events[number]) => {
     // filter function
-    if (result.data?.channelId !== channelId) return
+    if (result.data?.channelId !== channelId) return;
 
-    if (callback instanceof Function)
-      return callback(result)
+    if (callback instanceof Function) return callback(result);
 
-    if (action !== 'onFetch')
-      callback.onEvent?.(action, result)
+    if (action !== 'onFetch') callback.onEvent?.(action, result);
 
-    callback[action]?.(result)
-  }
+    callback[action]?.(result);
+  };
 
-  const disposers: Amity.Unsubscriber[] = []
+  const disposers: Amity.Unsubscriber[] = [];
 
   disposers.push(
-    onChannelUpdated(data => router({ data }, 'onUpdate')),
-    onChannelDeleted(data => router({ data }, 'onDelete')),
-    onChannelJoined(data => router({ data }, 'onJoin')),
-    onChannelLeft(data => router({ data }, 'onLeft')),
-    onMemberAdded(data => router({ data }, 'onMemberAdded')),
-    onMemberRemoved(data => router({ data }, 'onMemberRemoved')),
-  )
+    onChannelUpdated(data => router({ data, loading: false, origin: 'event' }, 'onUpdate')),
+    onChannelDeleted(data => router({ data, loading: false, origin: 'event' }, 'onDelete')),
+    onChannelJoined(data => router({ data, loading: false, origin: 'event' }, 'onJoin')),
+    onChannelLeft(data => router({ data, loading: false, origin: 'event' }, 'onLeft')),
+    onChannelMemberAdded(data =>
+      router({ data, loading: false, origin: 'event' }, 'onMemberAdded'),
+    ),
+    onChannelMemberRemoved(data =>
+      router({ data, loading: false, origin: 'event' }, 'onMemberRemoved'),
+    ),
+    onChannelMemberRead(data => router({ data, loading: false, origin: 'event' }, 'onRead')),
+  );
 
-  runQuery(
-    createQuery(getChannel, channelId),
-    result => result.data && router(result, 'onFetch'),
-  )
+  runQuery(createQuery(getChannel, channelId), result => result.data && router(result, 'onFetch'));
 
   return () => {
-    log(`observeChannel(tmpid: ${timestamp}) > dispose`)
-    disposers.forEach(fn => fn())
-  }
-}
+    log(`observeChannel(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};

package/src/channel/observers/observeChannels.ts

@@ -0,0 +1,61 @@
+import { getActiveClient } from '~/client/api';
+
+import {
+  onChannelCreated,
+  onChannelUpdated,
+  onChannelDeleted,
+  onChannelJoined,
+  onChannelLeft,
+  onChannelMemberAdded,
+  onChannelMemberRemoved,
+  onChannelMemberRead,
+} from '../events';
+
+/**
+ * ```js
+ * import { observeChannels } from '@amityco/ts-sdk'
+ *
+ * let channels = []
+ * const unsub = observeChannels(channel => merge(channels, channel))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.Channel} for a current user
+ *
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the channels
+ *
+ * @category Channel Observer
+ */
+export const observeChannels = (
+  callback: Amity.ObjectListener<Amity.Channel, [Exclude<Amity.ChannelActionType, 'onFetch'>]>,
+): Amity.Unsubscriber => {
+  const { log } = getActiveClient();
+
+  const timestamp = Date.now();
+  log(`observeChannels(tmpid: ${timestamp}) > listen`);
+
+  const disposers: Amity.Unsubscriber[] = [];
+
+  const router = (channel: Amity.Channel, action: Exclude<Amity.ChannelActionType, 'onFetch'>) => {
+    if (callback instanceof Function) return callback(channel);
+
+    callback.onEvent?.(action, channel);
+    callback[action]?.(channel);
+  };
+
+  disposers.push(
+    onChannelCreated(data => router(data, 'onCreate')),
+    onChannelUpdated(data => router(data, 'onUpdate')),
+    onChannelDeleted(data => router(data, 'onDelete')),
+    onChannelJoined(data => router(data, 'onJoin')),
+    onChannelLeft(data => router(data, 'onLeft')),
+    onChannelMemberAdded(data => router(data, 'onMemberAdded')),
+    onChannelMemberRemoved(data => router(data, 'onMemberRemoved')),
+    onChannelMemberRead(data => router(data, 'onRead')),
+  );
+
+  return () => {
+    log(`observeChannels(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};

package/src/channel/observers/tests/liveChannelMembers.test.ts

@@ -0,0 +1,232 @@
+import { disableCache, enableCache } from '~/cache/api';
+import { prepareMembershipPayload } from '~/group/utils';
+import {
+  client,
+  connectClient,
+  disconnectClient,
+  channelUser1,
+  channelUser7,
+  channelUserQueryResponse,
+  channelUserQueryResponsePage3,
+  channelUserQueryResponsePage2,
+  channel11,
+  pause,
+  user11,
+  user14,
+  channelUserModel3,
+  channelUserModel,
+} from '~/utils/tests';
+
+import { liveChannelMembers } from '../liveChannelMembers';
+import { prepareChannelPayload } from '../../utils';
+
+const getSnapshot = () => {
+  return {
+    data: [] as Amity.MembershipRaw<'channel'>[],
+    loading: true,
+    error: undefined as any,
+  };
+};
+
+describe('liveChannelMembers', () => {
+  beforeAll(async () => {
+    await connectClient();
+  });
+
+  afterAll(async () => {
+    await disconnectClient();
+  });
+
+  beforeEach(enableCache);
+
+  afterEach(disableCache);
+
+  const { channelId } = channel11;
+
+  test('it should return channel members collection', async () => {
+    // mock response of queryChannels and validate
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(channelUserQueryResponse);
+
+    liveChannelMembers({ channelId }, callback);
+    await pause();
+
+    // check if cache data returned (should be empty)
+    expect(callback).toHaveBeenNthCalledWith(1, expect.objectContaining(getSnapshot()));
+
+    const snapshot = getSnapshot();
+    snapshot.data = channelUserModel;
+    snapshot.loading = false;
+
+    expect(callback).toHaveBeenNthCalledWith(2, expect.objectContaining(snapshot));
+  });
+
+  const filters: [string, Amity.ChannelMembersLiveCollection, Amity.Membership<'channel'>[]][] = [
+    [
+      'roles',
+      { channelId, roles: channelUserQueryResponsePage3.data.channelUsers[0].roles },
+      [channelUserModel3[0]],
+    ],
+    ['searched term', { channelId, search: 'use' }, [channelUserModel3[0]]],
+    ['member', { channelId, memberships: ['member'] }, [channelUserModel3[0]]],
+    ['muted members', { channelId, memberships: ['muted'] }, [channelUserModel3[1]]],
+    ['banned members', { channelId, memberships: ['banned'] }, [channelUserModel3[1]]],
+  ];
+
+  test.each(filters)('it should filter channelUsers by %s', async (filter, params, expected) => {
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(channelUserQueryResponsePage3);
+
+    liveChannelMembers(params, callback);
+    await pause();
+
+    const snapshot = getSnapshot();
+    // check if cache data returned (should be empty)
+    expect(callback).toHaveBeenNthCalledWith(1, expect.objectContaining(snapshot));
+
+    snapshot.loading = false;
+    snapshot.data = expected;
+
+    expect(callback).toHaveBeenNthCalledWith(2, expect.objectContaining(snapshot));
+  });
+
+  test('it should return method to fetch next page', async () => {
+    const callback = jest.fn();
+    client.http.get = jest
+      .fn()
+      .mockResolvedValue(channelUserQueryResponse)
+      .mockResolvedValueOnce(channelUserQueryResponsePage2);
+
+    liveChannelMembers({ channelId }, callback);
+    await pause();
+
+    expect(callback).toHaveBeenCalled();
+    expect(callback.mock.lastCall).toHaveLength(1);
+
+    const { onNextPage, hasNextPage } = callback.mock.lastCall[0];
+
+    expect(hasNextPage).toBe(true);
+    expect(onNextPage).toBeTruthy();
+
+    onNextPage();
+    await pause();
+
+    const payload = prepareMembershipPayload(
+      prepareChannelPayload(channelUserQueryResponse.data),
+      'channelUsers',
+    );
+
+    const payload2 = prepareMembershipPayload(
+      prepareChannelPayload(channelUserQueryResponsePage2.data),
+      'channelUsers',
+    );
+
+    const snapshot = getSnapshot();
+    snapshot.loading = false;
+    snapshot.data = [...payload2.channelUsers, ...payload.channelUsers];
+
+    expect(callback).toHaveBeenNthCalledWith(4, expect.objectContaining(snapshot));
+  });
+
+  const events: [string, keyof Amity.Events, Amity.MembershipRaw<'channel'>, Amity.User][] = [
+    [
+      'it should add new member to collection onMemberAdded',
+      'v3.channel.didAddUsers',
+      channelUser7,
+      user14,
+    ],
+    [
+      'it should remove channel memeber from collection onMemberRemoved',
+      'v3.channel.didRemoveUsers',
+      channelUser1,
+      user11,
+    ],
+    [
+      'it should update channel memeber membership on onChannelMemberBanned',
+      'v3.channel.didBan',
+      { ...channelUser1, membership: 'banned', isBanned: true },
+      user11,
+    ],
+    [
+      'it should update channel memeber membership on onChannelMemberUnbanned',
+      'v3.channel.didUnban',
+      { ...channelUser1, membership: 'none', isBanned: false },
+      user11,
+    ],
+    [
+      'it should update channel memeber `readToSegment` on onMemberRead',
+      'v3.channel.didMarkSeen',
+      { ...channelUser1, readToSegment: channelUser1.readToSegment + 1 },
+      user11,
+    ],
+  ];
+
+  test.each(events)('%s', async (test, event, channelUser, user) => {
+    const snapshot = getSnapshot();
+
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(channelUserQueryResponse);
+
+    liveChannelMembers({ channelId }, callback);
+    await pause();
+
+    client.emitter.emit(event, {
+      channels: [channel11],
+      channelUsers: [channelUser],
+      users: [user],
+      files: [],
+    });
+
+    const channelUserModel = { ...channelUser, user };
+
+    const payload = prepareMembershipPayload(
+      prepareChannelPayload(channelUserQueryResponse.data),
+      'channelUsers',
+    );
+
+    snapshot.loading = false;
+
+    // get data based on event
+    switch (event) {
+      case 'v3.channel.didAddUsers':
+        snapshot.data = [channelUserModel, ...payload.channelUsers];
+        break;
+
+      case 'v3.channel.didBan': {
+        const bannedUserIdx = payload.channelUsers.findIndex(
+          u => u.userId === channelUserModel.userId,
+        );
+        payload.channelUsers[bannedUserIdx] = channelUserModel;
+
+        snapshot.data = payload.channelUsers;
+        break;
+      }
+
+      case 'v3.channel.didUnban': {
+        const unbannedUserIdx = payload.channelUsers.findIndex(
+          u => u.userId === channelUserModel.userId,
+        );
+        payload.channelUsers[unbannedUserIdx] = channelUserModel;
+
+        snapshot.data = payload.channelUsers;
+        break;
+      }
+
+      case 'v3.channel.didMarkSeen': {
+        const readUserIdx = payload.channelUsers.findIndex(
+          u => u.userId === channelUserModel.userId,
+        );
+        payload.channelUsers[readUserIdx] = channelUserModel;
+
+        snapshot.data = payload.channelUsers;
+        break;
+      }
+
+      default:
+        // delete payload
+        snapshot.data = payload.channelUsers.filter(u => u.userId !== channelUserModel.userId);
+    }
+
+    expect(callback).toHaveBeenNthCalledWith(3, expect.objectContaining(snapshot));
+  });
+});