@amityco/ts-sdk 0.0.1-beta.37 → 0.0.1-beta.39

package/src/utils/tests/dummy/stream.ts

@@ -1,86 +1,86 @@
 export const streamResponse = {
   data: {
-    "videoStreamings": [
+    videoStreamings: [
       {
-        streamId: "123",
-        "userId": "123",
-        "thumbnailFileId": "123",
-        "title": "Test Stream",
-        "status": "idle",
-        "isLive": true,
-        "isDeleted": true,
-        "description": "Test Stream Description",
-        "platform": {
-          "name": "x86",
-          "version": "123"
+        streamId: '123',
+        userId: '123',
+        thumbnailFileId: '123',
+        title: 'Test Stream',
+        status: 'idle',
+        isLive: true,
+        isDeleted: true,
+        description: 'Test Stream Description',
+        platform: {
+          name: 'x86',
+          version: '123',
         },
-        "startedAt": "2023-01-17T07:19:06.414Z",
-        "endedAt": "2023-01-17T07:19:06.414Z",
-        "createdAt": "2023-01-17T07:19:06.414Z",
-        "updatedAt": "2023-01-17T07:19:06.414Z",
-        "metadata": {},
-        "resolution": "SD",
-        "streamerUrl": {
-          "url": "https://test-stream.test",
-          "components": {
-            "origin": "origin",
-            "appName": "stream app",
-            "streamName": "stream name",
-            "query": "123"
-          }
+        startedAt: '2023-01-17T07:19:06.414Z',
+        endedAt: '2023-01-17T07:19:06.414Z',
+        createdAt: '2023-01-17T07:19:06.414Z',
+        updatedAt: '2023-01-17T07:19:06.414Z',
+        metadata: {},
+        resolution: 'SD',
+        streamerUrl: {
+          url: 'https://test-stream.test',
+          components: {
+            origin: 'origin',
+            appName: 'stream app',
+            streamName: 'stream name',
+            query: '123',
+          },
         },
-        "recordings": [
+        recordings: [
           {
-            "flv": {
-              "url": "https://test-stream-flv.test",
-              "duration": 0,
-              "startTime": 0,
-              "stopTime": 0
+            flv: {
+              url: 'https://test-stream-flv.test',
+              duration: 0,
+              startTime: 0,
+              stopTime: 0,
+            },
+            mp4: {
+              url: 'https://test-stream-mp4.test',
+              duration: 0,
+              startTime: 0,
+              stopTime: 0,
             },
-            "mp4": {
-              "url": "https://test-stream-mp4.test",
-              "duration": 0,
-              "startTime": 0,
-              "stopTime": 0
+            m3u8: {
+              url: 'https://test-stream-m3u8.test',
+              duration: 0,
+              startTime: 0,
+              stopTime: 0,
             },
-            "m3u8": {
-              "url": "https://test-stream-m3u8.test",
-              "duration": 0,
-              "startTime": 0,
-              "stopTime": 0
-            }
-          }
+          },
         ],
-        "watcherUrl": {
-          "flv": {
-            "url": "https://test-stream-flv.test",
-            "components": {
-              "origin": "1",
-              "appName": "2",
-              "streamName": "3",
-              "query": "4"
-            }
+        watcherUrl: {
+          flv: {
+            url: 'https://test-stream-flv.test',
+            components: {
+              origin: '1',
+              appName: '2',
+              streamName: '3',
+              query: '4',
+            },
           },
-          "hls": {
-            "url": "https://test-stream-hls.test",
-            "components": {
-              "origin": "1",
-              "appName": "2",
-              "streamName": "3",
-              "query": "4"
-            }
+          hls: {
+            url: 'https://test-stream-hls.test',
+            components: {
+              origin: '1',
+              appName: '2',
+              streamName: '3',
+              query: '4',
+            },
+          },
+          rtmp: {
+            url: 'https://test-stream-rtmp.test',
+            components: {
+              origin: '1',
+              appName: '2',
+              streamName: '3',
+              query: '4',
+            },
           },
-          "rtmp": {
-            "url": "https://test-stream-rtmp.test",
-            "components": {
-              "origin": "1",
-              "appName": "2",
-              "streamName": "3",
-              "query": "4"
-            }
-          }
-        }
-      }
+        },
+      },
     ],
-  }
+  },
 };

package/src/utils/tests/dummy/subChannel.ts

@@ -27,25 +27,3 @@ export function generateSubChannel(params?: Record<string, any>): Amity.SubChann
     ...params,
   };
 }
-
-export const createSubChannelError400400 = {
-  status: 'error',
-  message: 'Channel not found.',
-  code: 400400,
-  data: {
-    detail: {
-      channelId: '63d0ccbc5defa46a1cab73a',
-    },
-  },
-};
-
-export const createSubChannelError400301 = {
-  status: 'error',
-  message: 'You are not a member of this channel.',
-  code: 400301,
-  data: {
-    detail: {
-      channelId: '63be2ef7827ef6bfc6798192',
-    },
-  },
-};

package/src/utils/tests/dummy/user.ts

@@ -26,6 +26,17 @@ export const user14: Amity.User = {
   userId: 'user4',
 };
 
+export const user21: Amity.User = {
+  ...user11,
+  displayName: 'displayName',
+  userId: 'user21',
+};
+
+export const user22: Amity.User = {
+  ...user11,
+  userId: 'user22',
+};
+
 export const userQueryResponse = {
   data: {
     users: [user11, user12],
@@ -36,6 +47,52 @@ export const userQueryResponse = {
     },
   },
 };
+
+export const userQueryResponsePage2 = {
+  data: {
+    users: [user21, user22],
+    files: [],
+    paging: {
+      previous: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
+      next: 'eyJiZWZvcmUiOjU1LCJsYXN0IjoxMH0=',
+    },
+  },
+};
+
+export const flaggedUser = {
+  ...user11,
+  userId: 'to-be-flagged',
+  flagCount: 1,
+};
+
+export const flaggedUserQueryResponse = {
+  data: {
+    users: [flaggedUser],
+    files: [],
+  },
+};
+
+export const userUpdateResponse = {
+  data: {
+    users: [
+      {
+        isDeleted: false,
+        displayName: 'updated-display-name',
+        userId: 'test-user',
+        metadata: {},
+        roles: [],
+        permissions: [],
+        flagCount: 0,
+        hashFlag: null,
+        avatarCustomUrl: 'updated-avatarUrl',
+        avatarFileId: null,
+        isGlobalBan: false,
+      },
+    ],
+    files: [],
+  },
+};
+
 export const users = [user11, user12, user13, user14];
 
 // user payload with file

package/src/utils/tests/liveObject.test.ts

@@ -0,0 +1,172 @@
+import { generatePost } from '~/utils/tests/dummy';
+import { pause } from '~/utils/tests/utils';
+import { connectClient, disconnectClient } from '~/utils/tests/client';
+import { disableCache, enableCache } from '~/cache/api';
+import { getFutureDate, getPastDate } from '~/core/model';
+import { LIVE_OBJECT_ENABLE_CACHE_MESSAGE } from '~/utils/constants';
+import { liveObject } from '../liveObject';
+
+describe('liveObject', () => {
+  let post: Amity.Post;
+  let fetcher: jest.Mock;
+  let callback: jest.Mock;
+  let eventCallback: Amity.Listener<Amity.Post>;
+  let eventUnsubscriber: jest.Mock;
+  const onEvent = (fn: Amity.Listener<Amity.Post>) => {
+    eventCallback = fn;
+    eventUnsubscriber = jest.fn();
+
+    return eventUnsubscriber;
+  };
+  let unsubscribe: Amity.Unsubscriber;
+
+  beforeAll(async () => {
+    await connectClient();
+  });
+
+  afterAll(async () => {
+    await disconnectClient();
+  });
+
+  beforeEach(() => {
+    enableCache();
+
+    callback = jest.fn();
+    post = generatePost({ postId: 'my-post-id' });
+    fetcher = jest.fn().mockResolvedValue(post);
+  });
+
+  afterEach(() => {
+    disableCache();
+    unsubscribe();
+  });
+
+  test('it should show message if cache not enabled', () => {
+    /*
+     * NOTE: at the time of writing this test cache is disabled by default, but
+     * there is a proposal to enable cache by default. So I'm disabling cache
+     * here to ensure cache is disabled
+     */
+    disableCache();
+    jest.spyOn(global.console, 'log');
+
+    unsubscribe = liveObject<Amity.Post, 'postId'>(post.postId, callback, 'postId', fetcher, []);
+
+    expect(console.log).toBeCalledWith(LIVE_OBJECT_ENABLE_CACHE_MESSAGE);
+  });
+
+  it('should fetch the model', async () => {
+    unsubscribe = liveObject<Amity.Post, 'postId'>(post.postId, callback, 'postId', fetcher, []);
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+    expect(callback).toHaveBeenNthCalledWith(
+      1,
+      expect.objectContaining({ data: undefined, loading: true }),
+    );
+    expect(callback).toHaveBeenNthCalledWith(
+      2,
+      expect.objectContaining({
+        data: post,
+        loading: false,
+      }),
+    );
+  });
+
+  it('should provide the error if fetch is failed', async () => {
+    const error = new Error('can not fetch');
+
+    unsubscribe = liveObject<Amity.Post, 'postId'>(
+      post.postId,
+      callback,
+      'postId',
+      () => {
+        return Promise.reject(error);
+      },
+      [onEvent],
+    );
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+    expect(callback).toHaveBeenNthCalledWith(
+      1,
+      expect.objectContaining({ data: undefined, loading: true }),
+    );
+    expect(callback).toHaveBeenNthCalledWith(
+      2,
+      expect.objectContaining({
+        data: undefined,
+        error,
+        loading: false,
+      }),
+    );
+    expect(eventUnsubscriber).toHaveBeenCalledTimes(1);
+  });
+
+  it('should update the model on the event', async () => {
+    const update = {
+      ...post,
+      data: { text: 'new-text' },
+      updatedAt: getFutureDate(post.updatedAt),
+    };
+
+    unsubscribe = liveObject<Amity.Post, 'postId'>(post.postId, callback, 'postId', fetcher, [
+      onEvent,
+    ]);
+    await pause();
+    eventCallback(update);
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(3);
+    expect(callback).toHaveBeenNthCalledWith(
+      3,
+      expect.objectContaining({
+        data: update,
+        loading: false,
+      }),
+    );
+  });
+
+  it('should not update the model on the event if the model is already the latest', async () => {
+    const update = {
+      ...post,
+      data: { text: 'new-text' },
+      updatedAt: getPastDate(post.updatedAt),
+    };
+
+    unsubscribe = liveObject<Amity.Post, 'postId'>(post.postId, callback, 'postId', fetcher, [
+      onEvent,
+    ]);
+    await pause();
+    eventCallback(update);
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+  });
+
+  it('should not update the model on the event if the model has different id', async () => {
+    const post2 = generatePost({
+      postId: 'my-post-id-2',
+      updatedAt: getFutureDate(post.updatedAt),
+    });
+
+    unsubscribe = liveObject<Amity.Post, 'postId'>(post.postId, callback, 'postId', fetcher, [
+      onEvent,
+    ]);
+    await pause();
+    eventCallback(post2);
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+  });
+
+  it('should unsubscribe from events on liveObject disposing', async () => {
+    unsubscribe = liveObject<Amity.Post, 'postId'>(post.postId, callback, 'postId', fetcher, [
+      onEvent,
+    ]);
+    await pause();
+    unsubscribe();
+
+    expect(eventUnsubscriber).toHaveBeenCalledTimes(1);
+  });
+});