@amityco/ts-sdk 0.0.1-cb052d5.0 → 0.0.1-cb5cdb1.0

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

@@ -0,0 +1,471 @@
+import { disableCache, enableCache } from '~/cache/api';
+import {
+  channel1,
+  channel2,
+  channelQueryResponse,
+  channelQueryResponsePage2,
+  channelRaw1,
+  channelRaw2,
+  client,
+  connectClient,
+  disconnectClient,
+  generateRawChannel,
+  generateRawMessage,
+  mockPage,
+  pause,
+  rawChannelUser,
+  rawChannelUser2,
+  user11,
+} from '~/utils/tests';
+import { liveChannels } from '../liveChannels';
+import { convertFromRaw, prepareChannelPayload } from '../../utils';
+
+const getSnapshot = (params?: Record<string, any>) => {
+  return {
+    data: [] as Amity.Channel[],
+    loading: true,
+    error: undefined as any,
+    ...params,
+  };
+};
+
+const convertFromRawParams = {
+  defaultSubChannelHasUnreadMention: false,
+  defaultSubChannelUnreadCount: 0,
+  localLastMentionSegment: 0,
+  localReadToSegment: 0,
+};
+
+describe('liveChannels', () => {
+  beforeAll(async () => {
+    await connectClient();
+  });
+
+  afterAll(async () => {
+    await disconnectClient();
+  });
+
+  beforeEach(enableCache);
+
+  afterEach(disableCache);
+
+  test('it should return channel collection', async () => {
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(channelQueryResponse);
+
+    liveChannels({}, callback);
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+    expect(callback).toHaveBeenNthCalledWith(1, expect.objectContaining(getSnapshot()));
+    expect(callback).toHaveBeenNthCalledWith(
+      2,
+      expect.objectContaining(
+        getSnapshot({
+          data: prepareChannelPayload(channelQueryResponse.data).channels,
+          loading: false,
+        }),
+      ),
+    );
+  });
+
+  test('it should return data from cache', async () => {
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(channelQueryResponse);
+
+    liveChannels({}, () => undefined);
+    await pause();
+    liveChannels({}, callback);
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+    expect(callback).toHaveBeenNthCalledWith(
+      1,
+      expect.objectContaining(
+        getSnapshot({
+          data: prepareChannelPayload(channelQueryResponse.data).channels,
+        }),
+      ),
+    );
+    expect(callback).toHaveBeenNthCalledWith(
+      2,
+      expect.objectContaining(
+        getSnapshot({
+          data: prepareChannelPayload(channelQueryResponse.data).channels,
+          loading: false,
+        }),
+      ),
+    );
+  });
+
+  const rawDeletedChannel = generateRawChannel({
+    channelId: 'deleted-channel-id',
+    isDeleted: true,
+  });
+  const deletedChannel = convertFromRaw(rawDeletedChannel, convertFromRawParams);
+  const rawTaggedChannel = generateRawChannel({
+    channelId: 'tagged-channel-id',
+    tags: ['tag1', 'tag2'],
+  });
+  const taggedChannel = convertFromRaw(rawTaggedChannel, convertFromRawParams);
+  const rawTaggedChannel2 = generateRawChannel({
+    channelId: 'tagged-channel-id-2',
+    tags: ['tag2'],
+  });
+  const taggedChannel2 = convertFromRaw(rawTaggedChannel2, convertFromRawParams);
+
+  const filters: [string, Amity.ChannelLiveCollection, Amity.Channel[]][] = [
+    ['deleted', { isDeleted: false }, [channel1, taggedChannel, taggedChannel2]],
+    ['tagged', { tags: ['tag2'] }, [taggedChannel, taggedChannel2]],
+    ['out excluded tags', { excludeTags: ['tag1'] }, [channel1, deletedChannel, taggedChannel2]],
+    ['member', { membership: 'member' }, [channel1]],
+    ['not member', { membership: 'notMember' }, [deletedChannel, taggedChannel, taggedChannel2]],
+    [
+      'all membership',
+      { membership: 'all' },
+      [channel1, deletedChannel, taggedChannel, taggedChannel2],
+    ],
+  ];
+
+  test.each(filters)('it should filter by %s channels', async (filter, params, expected) => {
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue({
+      data: {
+        channels: [channelRaw1, rawDeletedChannel, rawTaggedChannel, rawTaggedChannel2],
+        channelUsers: [rawChannelUser],
+        files: [],
+        users: [user11],
+        ...mockPage,
+      },
+    });
+
+    liveChannels(params, callback);
+
+    expect(callback).toHaveBeenCalledTimes(1);
+    // check if cache data returned (should be empty)
+    expect(callback).toHaveBeenCalledWith(expect.objectContaining(getSnapshot()));
+
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+    expect(callback).toHaveBeenCalledWith(
+      expect.objectContaining(
+        getSnapshot({
+          loading: false,
+          data: expected,
+        }),
+      ),
+    );
+  });
+
+  test('it should return method to fetch next page', async () => {
+    const callback = jest.fn();
+    client.http.get = jest
+      .fn()
+      .mockResolvedValue(channelQueryResponse)
+      .mockResolvedValueOnce(channelQueryResponsePage2);
+
+    liveChannels({}, 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();
+
+    // 4 -> because 1 local & server call each per call (2)
+    expect(callback).toHaveBeenCalledTimes(4);
+    expect(callback).toHaveBeenNthCalledWith(
+      4,
+      expect.objectContaining(
+        getSnapshot({
+          loading: false,
+          data: [
+            ...prepareChannelPayload(channelQueryResponsePage2.data).channels,
+            ...prepareChannelPayload(channelQueryResponse.data).channels,
+          ],
+        }),
+      ),
+    );
+  });
+
+  describe('events', () => {
+    const rawNewChannel = generateRawChannel({ channelId: 'new-channel-id' });
+
+    const cases: [string, keyof Amity.Events, Amity.RawChannel, Amity.Channel[]][] = [
+      [
+        'it should add new channel to collection onCreate',
+        'channel.created',
+        rawNewChannel,
+        [convertFromRaw(rawNewChannel, convertFromRawParams), channel1, channel2],
+      ],
+      [
+        'it should add new channel to collection onJoin',
+        'channel.joined',
+        rawNewChannel,
+        [convertFromRaw(rawNewChannel, convertFromRawParams), channel1, channel2],
+      ],
+      [
+        'it should update channel in collection onUpdate',
+        'channel.updated',
+        channelRaw1,
+        [channel1, channel2],
+      ],
+      [
+        'it should update channel in collection onMuted',
+        'channel.setMuted',
+        { ...channelRaw1, isMuted: true },
+        [{ ...channel1, isMuted: true }, channel2],
+      ],
+      [
+        'it should remove channel from collection onDelete',
+        'channel.deleted',
+        { ...channelRaw1, isDeleted: true },
+        [channel2],
+      ],
+      [
+        'it should remove channel from collection onLeft',
+        'channel.left',
+        { ...channelRaw1, isDeleted: true },
+        [channel2],
+      ],
+    ];
+
+    test.each(cases)('%s', async (test, event, rawChannel, expected) => {
+      const callback = jest.fn();
+      client.http.get = jest.fn().mockResolvedValue(channelQueryResponse);
+
+      liveChannels({ isDeleted: false }, callback);
+      await pause();
+      client.emitter.emit(event, {
+        channels: [rawChannel],
+        channelUsers: [rawChannelUser],
+        users: [],
+        files: [],
+      });
+      await pause();
+
+      expect(callback).toHaveBeenNthCalledWith(
+        3,
+        expect.objectContaining(
+          getSnapshot({
+            data: expected,
+            loading: false,
+          }),
+        ),
+      );
+    });
+
+    it('should add the channel to collection if user is added to the channel and member filter is applied', async () => {
+      const callback = jest.fn();
+      client.http.get = jest.fn().mockResolvedValue({
+        data: {
+          channels: [channelRaw2],
+          channelUsers: [rawChannelUser2],
+          files: [],
+          users: [user11],
+          ...mockPage,
+        },
+      });
+
+      liveChannels({ membership: 'member' }, callback);
+      await pause();
+      client.emitter.emit('channel.membersAdded', {
+        channels: [channelRaw1],
+        channelUsers: [rawChannelUser],
+        users: [user11],
+        files: [],
+      });
+      await pause();
+
+      expect(callback).toHaveBeenNthCalledWith(
+        3,
+        expect.objectContaining(getSnapshot({ data: [channel1, channel2], loading: false })),
+      );
+    });
+
+    it('should add the channel to collection if user is removed from the channel and nonMember filter is applied', async () => {
+      const callback = jest.fn();
+      client.http.get = jest.fn().mockResolvedValue({
+        data: {
+          channels: [channelRaw2],
+          channelUsers: [],
+          files: [],
+          users: [user11],
+          ...mockPage,
+        },
+      });
+
+      liveChannels({ membership: 'notMember' }, callback);
+      await pause();
+      client.emitter.emit('channel.membersRemoved', {
+        channels: [channelRaw1],
+        channelUsers: [{ ...rawChannelUser, membership: 'none' }],
+        users: [user11],
+        files: [],
+      });
+      await pause();
+
+      expect(callback).toHaveBeenNthCalledWith(
+        3,
+        expect.objectContaining(getSnapshot({ data: [channel1, channel2], loading: false })),
+      );
+    });
+
+    it('should add the channel to collection if tag is added to the channel and tags is applied', async () => {
+      const callback = jest.fn();
+      client.http.get = jest.fn().mockResolvedValue({
+        data: {
+          channels: [channelRaw2],
+          channelUsers: [rawChannelUser2],
+          files: [],
+          users: [user11],
+          ...mockPage,
+        },
+      });
+
+      liveChannels({ tags: ['tag1'] }, callback);
+      await pause();
+      client.emitter.emit('channel.updated', {
+        channels: [{ ...channelRaw1, tags: ['tag1'] }],
+        channelUsers: [rawChannelUser],
+        users: [user11],
+        files: [],
+      });
+      await pause();
+
+      expect(callback).toHaveBeenNthCalledWith(
+        3,
+        expect.objectContaining(
+          getSnapshot({ data: [{ ...channel1, tags: ['tag1'] }, channel2], loading: false }),
+        ),
+      );
+    });
+
+    test.each([
+      [
+        'should remove the channel from the collection if user is removed from the channel and member filter is applied',
+        'channel.membersRemoved',
+      ],
+      [
+        'should remove the channel from the collection if user is left from the channel and member filter is applied',
+        'channel.left',
+      ],
+    ] as [string, keyof Amity.Events][])('%s', async (test, event) => {
+      const callback = jest.fn();
+      client.http.get = jest.fn().mockResolvedValue({
+        data: {
+          channels: [channelRaw1, channelRaw2],
+          channelUsers: [rawChannelUser, rawChannelUser2],
+          files: [],
+          users: [user11],
+          ...mockPage,
+        },
+      });
+
+      liveChannels({ membership: 'member' }, callback);
+      await pause();
+      client.emitter.emit(event, {
+        channels: [channelRaw1],
+        channelUsers: [{ ...rawChannelUser, membership: 'none' }],
+        users: [user11],
+        files: [],
+      });
+      await pause();
+
+      expect(callback).toHaveBeenNthCalledWith(
+        3,
+        expect.objectContaining(getSnapshot({ data: [channel2], loading: false })),
+      );
+    });
+
+    test.each([
+      [
+        'should remove the channel from the collection if user is added to the channel and notMember filter is applied',
+        'channel.membersAdded',
+      ],
+      [
+        'should remove the channel from the collection if user is joined to the channel and notMember filter is applied',
+        'channel.joined',
+      ],
+    ] as [string, keyof Amity.Events][])('%s', async (test, event) => {
+      const callback = jest.fn();
+      client.http.get = jest.fn().mockResolvedValue({
+        data: {
+          channels: [channelRaw1, channelRaw2],
+          channelUsers: [],
+          files: [],
+          users: [user11],
+          ...mockPage,
+        },
+      });
+
+      liveChannels({ membership: 'notMember' }, callback);
+      await pause();
+      client.emitter.emit('channel.membersAdded', {
+        channels: [channelRaw1],
+        channelUsers: [rawChannelUser],
+        users: [user11],
+        files: [],
+      });
+      await pause();
+
+      expect(callback).toHaveBeenNthCalledWith(
+        3,
+        expect.objectContaining(getSnapshot({ data: [channel2], loading: false })),
+      );
+    });
+  });
+
+  it('should increase the unread count once message is created', async () => {
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue({
+      data: {
+        channels: [channelRaw1],
+        channelUsers: [rawChannelUser],
+        files: [],
+        users: [user11],
+        ...mockPage,
+      },
+    });
+
+    liveChannels({}, callback);
+    await pause();
+    client.emitter.emit('message.created', {
+      messages: [
+        generateRawMessage({
+          channelPublicId: channelRaw1.channelId,
+          messageFeedId: channelRaw1._id,
+          segment: channelRaw1.messageCount + 1,
+        }),
+      ],
+      files: [],
+      users: [],
+    });
+    await pause(500);
+
+    expect(callback).toHaveBeenNthCalledWith(
+      3,
+      expect.objectContaining(
+        getSnapshot({
+          data: [
+            {
+              ...channel1,
+              defaultSubChannelUnreadCount: 1,
+              lastActivity: expect.anything(),
+              messageCount: channel1.messageCount + 1,
+              updatedAt: expect.anything(),
+            },
+          ],
+          loading: false,
+        }),
+      ),
+    );
+  });
+});

package/src/channel/utils/index.ts

@@ -0,0 +1,57 @@
+import { pullFromCache } from '~/cache/api';
+import { withUsers } from '~/group/utils';
+
+export function convertFromRaw(
+  { _id, ...rest }: Amity.RawChannel,
+  params: Pick<
+    Amity.Channel,
+    | 'defaultSubChannelHasUnreadMention'
+    | 'defaultSubChannelUnreadCount'
+    | 'localLastMentionSegment'
+    | 'localReadToSegment'
+  >,
+): Amity.Channel {
+  return {
+    ...rest,
+    ...params,
+    defaultSubChannelId: _id,
+  };
+}
+
+function getSegmentParams(rawChannel: Amity.RawChannel) {
+  let cached;
+
+  try {
+    cached = pullFromCache<Amity.Channel>(['channel', 'get', rawChannel.channelId]);
+    // eslint-disable-next-line no-empty
+  } catch {}
+
+  if (cached) {
+    return {
+      defaultSubChannelHasUnreadMention: cached.data.defaultSubChannelHasUnreadMention,
+      defaultSubChannelUnreadCount: cached.data.defaultSubChannelUnreadCount,
+      localReadToSegment: cached.data.localReadToSegment,
+      localLastMentionSegment: cached.data.localLastMentionSegment,
+    };
+  }
+
+  return {
+    defaultSubChannelHasUnreadMention: false,
+    defaultSubChannelUnreadCount: 0,
+    // @ts-ignore
+    localReadToSegment: rawChannel.messageCount > 0 ? rawChannel.messageCount - 1 : 0,
+    localLastMentionSegment: 0,
+  };
+}
+
+export const prepareChannelPayload = (
+  rawPayload: Amity.ChannelPayload,
+): Amity.ProcessedChannelPayload => {
+  const channels: Amity.Channel[] = rawPayload.channels.map(channel =>
+    convertFromRaw(channel, getSegmentParams(channel)),
+  );
+
+  const channelUsers: Amity.Membership<'channel'>[] = withUsers(rawPayload.channelUsers);
+
+  return { ...rawPayload, channels, channelUsers };
+};

package/src/channel/utils/tests/prepareChannelPayload.test.ts

@@ -0,0 +1,120 @@
+import {
+  connectClient,
+  disconnectClient,
+  channel1,
+  channel2,
+  channelRaw1,
+  channelRaw2,
+  rawChannelUser,
+  rawChannelUser2,
+} from '~/utils/tests';
+
+import { prepareChannelPayload } from '..';
+
+beforeAll(async () => {
+  await connectClient();
+});
+
+afterAll(async () => {
+  await disconnectClient();
+});
+
+const responseSchema = {
+  channels: [],
+  channelUsers: [],
+  files: [],
+  users: [],
+};
+
+const tests = [
+  {
+    id: 1,
+    desc: 'hasMention: false, unreadCount: 0, if channelUsers is empty',
+    before: {
+      ...responseSchema,
+      channels: [channelRaw1],
+    },
+    after: {
+      ...responseSchema,
+      channels: [channel1],
+    },
+  },
+  {
+    id: 2,
+    desc: 'hasMention: false, if channelUser.readToSegment >= channelUser.lastMentionedSegment',
+    before: {
+      ...responseSchema,
+      channels: [channelRaw1],
+      channelUsers: [rawChannelUser],
+    },
+    after: {
+      ...responseSchema,
+      channels: [channel1],
+      channelUsers: [rawChannelUser],
+    },
+  },
+  {
+    id: 3,
+    desc: 'unreadCount: 0, if channelUser.readToSegment = channel.messageCount',
+    before: {
+      ...responseSchema,
+      channels: [channelRaw1],
+      channelUsers: [rawChannelUser],
+    },
+    after: {
+      ...responseSchema,
+      channels: [channel1],
+      channelUsers: [rawChannelUser],
+    },
+  },
+  {
+    id: 4,
+    desc: 'hasMention: true, if channelUser.readToSegment < channelUser.lastMentionedSegment',
+    before: {
+      ...responseSchema,
+      channels: [channelRaw2],
+      channelUsers: [rawChannelUser2],
+    },
+    after: {
+      ...responseSchema,
+      channels: [channel2],
+      channelUsers: [rawChannelUser2],
+    },
+  },
+  {
+    id: 5,
+    desc: 'unreadCount: > 0, if channelUser.readToSegment < channel.messageCount',
+    before: {
+      ...responseSchema,
+      channels: [channelRaw2],
+      channelUsers: [rawChannelUser2],
+    },
+    after: {
+      ...responseSchema,
+      channels: [channel2],
+      channelUsers: [rawChannelUser2],
+    },
+  },
+  {
+    id: 4,
+    desc: 'hasMention: true, unreadCount: > 0, if 4 / 5 ',
+    before: {
+      ...responseSchema,
+      channels: [channelRaw2],
+      channelUsers: [rawChannelUser2],
+    },
+    after: {
+      ...responseSchema,
+      channels: [channel2],
+      channelUsers: [rawChannelUser2],
+    },
+  },
+];
+
+xdescribe('channel/utils/prepareChannelPayload', () => {
+  tests.forEach(({ id, desc, before, after }) => {
+    test(`${id} - ${desc}`, () => {
+      expect(prepareChannelPayload(before)).toEqual(after);
+    });
+  });
+});