@amityco/ts-sdk 0.0.1-beta.41.1 → 0.0.1-beta.42.2

package/src/post/api/tests/queryPosts.test.ts

@@ -65,6 +65,36 @@ describe('queryPosts', () => {
 
     disableCache();
   });
+
+  test('it should set isDeleted to undefined if includeDeleted is true', async () => {
+    const mockFn = jest.fn();
+    client.http.get = mockFn.mockResolvedValue(postQueryResponse);
+
+    await queryPosts({ ...params, includeDeleted: true });
+
+    expect(mockFn.mock.lastCall).toHaveLength(2);
+    expect(mockFn.mock.lastCall[1].params.isDeleted).toBeUndefined();
+  });
+
+  test('it should set isDeleted to false if includeDeleted is false', async () => {
+    const mockFn = jest.fn();
+    client.http.get = mockFn.mockResolvedValue(postQueryResponse);
+
+    await queryPosts({ ...params, includeDeleted: false });
+
+    expect(mockFn.mock.lastCall).toHaveLength(2);
+    expect(mockFn.mock.lastCall[1].params.isDeleted).toBe(false);
+  });
+
+  test('it should set isDeleted to undefined if includeDeleted is undefined', async () => {
+    const mockFn = jest.fn();
+    client.http.get = mockFn.mockResolvedValue(postQueryResponse);
+
+    await queryPosts({ ...params, includeDeleted: true });
+
+    expect(mockFn.mock.lastCall).toHaveLength(2);
+    expect(mockFn.mock.lastCall[1].params.isDeleted).toBeUndefined();
+  });
 });
 
 describe('queryPosts.locally', () => {

package/src/post/observers/livePosts.ts

@@ -1,13 +1,14 @@
 /* eslint-disable no-use-before-define */
 import { getResolver } from '~/core/model';
 import { getActiveClient } from '~/client/api';
-import { pushToCache, pullFromCache } from '~/cache/api';
+import { dropFromCache, pullFromCache, pushToCache } from '~/cache/api';
+
 import {
   createQuery,
-  runQuery,
-  queryOptions,
-  filterByPropEquality,
   filterByFeedType,
+  filterByPropEquality,
+  queryOptions,
+  runQuery,
   sortByFirstCreated,
   sortByLastCreated,
 } from '~/core/query';
@@ -18,16 +19,17 @@ import {
   ENABLE_CACHE_MESSAGE,
 } from '~/utils/constants';
 
+import { CACHE_SHORTEN_LIFESPAN } from '~/cache/utils';
 import {
-  onPostCreated,
-  onPostUpdated,
-  onPostDeleted,
   onPostApproved,
+  onPostCreated,
   onPostDeclined,
+  onPostDeleted,
   onPostFlagged,
-  onPostUnflagged,
   onPostReactionAdded,
   onPostReactionRemoved,
+  onPostUnflagged,
+  onPostUpdated,
 } from '../events';
 import { queryPosts } from '../api';
 
@@ -84,11 +86,13 @@ export const livePosts = (
         .filter(Boolean)
         .map(({ data }) => data) ?? [];
 
-    posts = filterByPropEquality(posts, 'isDeleted', params.isDeleted);
-
     const sortBy = params.sortBy ? params.sortBy : 'lastCreated';
     posts = posts.sort(sortBy === 'lastCreated' ? sortByLastCreated : sortByFirstCreated);
 
+    if (params.includeDeleted === false) {
+      posts = filterByPropEquality(posts, 'isDeleted', false);
+    }
+
     if (params.tags) {
       posts = posts.filter(p => p.tags?.some(t => params.tags?.includes(t)));
     }
@@ -157,7 +161,7 @@ export const livePosts = (
 
         responder(data);
       },
-      queryOptions(policy),
+      queryOptions(policy, CACHE_SHORTEN_LIFESPAN),
     );
   };
 
@@ -179,5 +183,6 @@ export const livePosts = (
   return () => {
     log(`livePosts(tmpid: ${timestamp}) > dispose`);
     disposers.forEach(fn => fn());
+    dropFromCache(cacheKey);
   };
 };

package/src/post/observers/tests/livePosts.test.ts

@@ -65,8 +65,7 @@ describe('livePosts', () => {
   });
 
   const filters: [string, Amity.PostLiveCollection, number?][] = [
-    ['not deleted', { ...params, isDeleted: false }],
-    ['deleted', { ...params, isDeleted: true }, 1],
+    ['not deleted', { ...params, includeDeleted: false }],
     ['tags', { ...params, tags: ['test_tag'] }, 1],
   ];
 
@@ -153,7 +152,7 @@ describe('livePosts', () => {
       'it should remove post in collection onDelete',
       'post.deleted',
       { ...post11, isDeleted: true },
-      { ...params, isDeleted: false },
+      { ...params, includeDeleted: false },
     ],
     ['it should remove post in collection onDeclined', 'post.declined', post11, params],
   ];
@@ -266,10 +265,10 @@ describe('livePosts', () => {
     const callback = jest.fn();
     client.http.get = jest.fn().mockResolvedValue(postQueryResponsePage2);
 
-    livePosts({ ...params, isDeleted: true }, callback);
+    livePosts({ ...params, includeDeleted: true }, callback);
 
     await pause();
-    const payload = postQueryResponsePage2.data.posts.filter(p => p.isDeleted);
+    const payload = postQueryResponsePage2.data.posts;
     const snapshot = getSnapshot();
 
     snapshot.data = payload;

package/src/reaction/api/tests/addReaction.test.ts

@@ -1,3 +1,4 @@
+import { ASCApiError } from '~/core/errors';
 import { disableCache, enableCache, pullFromCache, pushToCache } from '~/cache/api';
 
 import { onMessageUpdated } from '~/message/events';
@@ -9,6 +10,7 @@ import { UNSYNCED_OBJECT_CACHED_AT_VALUE } from '~/utils/constants';
 const cacheKey = ['message', 'get', message.messageId];
 
 describe('addReaction', () => {
+  // integration_test_id: 6252e6ed-afd7-460f-a285-f95650ec513a
   test('it should add a reaction', async () => {
     client.http.post = jest.fn().mockResolvedValue({ data: { addedId: 'reactionId' } });
 
@@ -17,6 +19,17 @@ describe('addReaction', () => {
     expect(success).toEqual(true);
   });
 
+  // integration_test_id: ddc6da15-cfa3-4f54-ad52-be50c2841d6e
+  test('it should throw 400400 when resource not found', async () => {
+    client.http.post = jest
+      .fn()
+      .mockRejectedValueOnce(
+        new ASCApiError('not found!', Amity.ServerError.ITEM_NOT_FOUND, Amity.ErrorLevel.ERROR),
+      );
+
+    await expect(addReaction('message', message.messageId, 'like')).rejects.toThrow();
+  });
+
   test('it should update cache after adding reaction', async () => {
     enableCache();
 

package/src/reaction/api/tests/removeReaction.test.ts

@@ -1,3 +1,4 @@
+import { ASCApiError } from '~/core/errors';
 import { disableCache, enableCache, pullFromCache, pushToCache } from '~/cache/api';
 
 import { onMessageUpdated } from '~/message/events';
@@ -15,6 +16,7 @@ const message = {
 const cacheKey = ['message', 'get', message.messageId];
 
 describe('removeReaction', () => {
+  // integration_test_id: dda62dbf-7649-4f1e-b264-0f79984ae1c8
   test('it should remove a reaction', async () => {
     client.http.delete = jest.fn().mockResolvedValue({ data: { removedId: 'reactionId' } });
 
@@ -23,6 +25,17 @@ describe('removeReaction', () => {
     expect(success).toEqual(true);
   });
 
+  // integration_test_id: b5ab2716-044c-488a-839e-4a7517e58ca9
+  test('it should throw 400400 when resource not found', async () => {
+    client.http.delete = jest
+      .fn()
+      .mockRejectedValueOnce(
+        new ASCApiError('not found!', Amity.ServerError.ITEM_NOT_FOUND, Amity.ErrorLevel.ERROR),
+      );
+
+    await expect(removeReaction('message', message.messageId, 'like')).rejects.toThrow();
+  });
+
   test('it should update cache after adding reaction', async () => {
     enableCache();
 

package/src/subChannel/api/querySubChannels.ts

@@ -29,13 +29,14 @@ export const querySubChannels = async (
   const client = getActiveClient();
   client.log('channel/querySubChannels', query);
 
-  const { page = { limit: 10 }, channelId, ...params } = convertQueryParams(query);
+  const { page = { limit: 10 }, channelId, includeDeleted, ...params } = convertQueryParams(query);
 
   const response = await client.http.get<Amity.SubChannelPayload & Amity.Pagination>(
     `/api/v5/message-feeds/channel/${channelId}`,
     {
       params: {
         ...params,
+        isDeleted: includeDeleted === false ? false : undefined,
         options: {
           token: toToken(page, 'skiplimit'),
         },

package/src/subChannel/observers/liveSubChannels.ts

@@ -2,9 +2,9 @@
 import { getActiveClient } from '~/client/api';
 import {
   createQuery,
-  runQuery,
-  queryOptions,
   filterByPropEquality,
+  queryOptions,
+  runQuery,
   sortByLastActivity,
 } from '~/core/query';
 import {
@@ -14,6 +14,7 @@ import {
 } from '~/utils/constants';
 import { onSubChannelFetched } from '~/subChannel/events/onSubChannelFetched';
 import { isCollectionOutdated, merge } from '~/utils';
+import { CACHE_SHORTEN_LIFESPAN } from '~/cache/utils';
 import { onSubChannelCreated, onSubChannelDeleted, onSubChannelUpdated } from '../events';
 import { querySubChannels } from '../api';
 
@@ -58,8 +59,8 @@ export const liveSubChannels = (
   const responder = (data: Amity.SubChannelLiveCollectionCache) => {
     let subChannels: Amity.SubChannel[] = data.data;
 
-    if (params.isDeleted !== undefined) {
-      subChannels = filterByPropEquality(subChannels, 'isDeleted', params.isDeleted);
+    if (params.includeDeleted === false) {
+      subChannels = filterByPropEquality(subChannels, 'isDeleted', false);
     }
 
     subChannels.sort(sortByLastActivity);
@@ -117,7 +118,7 @@ export const liveSubChannels = (
 
         responder(snapshot);
       },
-      queryOptions(policy),
+      queryOptions(policy, CACHE_SHORTEN_LIFESPAN),
     );
   };
 

package/src/subChannel/observers/tests/liveSubChannels.test.ts

@@ -68,7 +68,7 @@ describe('liveSubChannels', () => {
       },
     });
 
-    liveSubChannels({ channelId: rawSubChannel.channelPublicId, isDeleted: false }, callback);
+    liveSubChannels({ channelId: rawSubChannel.channelPublicId, includeDeleted: false }, callback);
     await pause();
 
     expect(callback).toHaveBeenCalledTimes(2);
@@ -178,7 +178,10 @@ describe('liveSubChannels', () => {
       const callback = jest.fn();
       client.http.get = jest.fn().mockResolvedValue(response);
 
-      liveSubChannels({ channelId: rawSubChannel.channelPublicId, isDeleted: false }, callback);
+      liveSubChannels(
+        { channelId: rawSubChannel.channelPublicId, includeDeleted: false },
+        callback,
+      );
       await pause();
       if (event === 'local.message-feed.fetched') {
         pushToCache(

package/src/utils/constants.ts

@@ -6,5 +6,6 @@ export const LIVE_OBJECT_ENABLE_CACHE_MESSAGE =
 export const UNSYNCED_OBJECT_CACHED_AT_MESSAGE =
   'Observing unsynced object is not supported by Live Object.';
 export const UNSYNCED_OBJECT_CACHED_AT_VALUE = -5;
-export const MINUTE = 60 * 1000;
+export const SECOND = 1000;
+export const MINUTE = 60 * SECOND;
 export const ACCESS_TOKEN_WATCHER_INTERVAL = 10 * MINUTE;

package/src/utils/liveObject.ts

@@ -8,10 +8,7 @@ import { hasUpdates } from '~/core/model';
 import { createQuery, runQuery } from '~/core/query';
 import { ASCApiError } from '~/core/errors';
 
-export const liveObject = <
-  T extends Exclude<Amity.Models[Amity.Domain], Amity.Reaction | Amity.FollowCount>,
-  K extends keyof T,
->(
+export const liveObject = <T extends Amity.Models[Amity.Domain], K extends keyof T>(
   id: T[K],
   callback: Amity.LiveObjectCallback<T>,
   key: K,

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

@@ -0,0 +1,268 @@
+import { createComment, queryComments } from '~/comment/api';
+import { file11 } from './file';
+import { post11, post12 } from './post';
+import { user11, user12 } from './user';
+
+export function generateComment(params?: Partial<Amity.Comment>): Amity.Comment {
+  return {
+    path: '',
+    referenceType: 'post',
+    dataType: 'text',
+    dataTypes: ['text'],
+    rootId: 'test',
+    data: {
+      text: 'yellow new world',
+    },
+    childrenNumber: 0,
+    isDeleted: false,
+    editedAt: '2022-10-31T05:57:45.661Z',
+    updatedAt: '2022-10-31T05:57:45.670Z',
+    createdAt: '2022-10-31T05:57:45.661Z',
+    segmentNumber: 2,
+    commentId: 'comment11',
+    userId: 'test',
+    referenceId: 'postId11',
+    flagCount: 0,
+    hashFlag: null,
+    children: [],
+    mentionees: [],
+    reactions: {},
+    reactionsCount: 0,
+    attachments: [],
+    ...params,
+  };
+}
+
+export const comment11: Amity.Comment = generateComment();
+
+export const imageComment11: Amity.Comment = generateComment({
+  dataTypes: ['image'],
+  data: { text: '' },
+  attachments: [
+    {
+      type: 'image',
+      fileId: file11.fileId,
+    },
+  ],
+});
+
+export const textImageComment11: Amity.Comment = generateComment({
+  dataTypes: ['image', 'text'],
+  data: { text: 'test' },
+  attachments: [
+    {
+      type: 'image',
+      fileId: file11.fileId,
+    },
+  ],
+});
+
+export const textMentionComment11: Amity.Comment = generateComment({
+  mentionees: [
+    {
+      type: 'user',
+      userIds: [user11._id, user12._id],
+    },
+  ],
+});
+
+export const comment12: Amity.Comment = generateComment({
+  commentId: 'comment12',
+  parentId: comment11.commentId,
+});
+
+export const imageComment12: Amity.Comment = generateComment({
+  ...imageComment11,
+  commentId: comment12.commentId,
+});
+
+export const textImageComment12: Amity.Comment = generateComment({
+  ...textImageComment11,
+  commentId: comment12.commentId,
+});
+
+export const textCommentPayload: Amity.CommentPayload = {
+  comments: [comment11],
+  users: [user11],
+  commentChildren: [],
+  files: [],
+};
+
+export const comment12Payload: Amity.CommentPayload = {
+  comments: [comment12, imageComment12, textImageComment12],
+  users: [user11],
+  commentChildren: [],
+  files: [file11],
+};
+
+export const imageCommentPayload: Amity.CommentPayload = {
+  comments: [imageComment11],
+  users: [user11],
+  commentChildren: [],
+  files: [file11],
+};
+
+export const textImageCommentPayload: Amity.CommentPayload = {
+  comments: [textImageComment11],
+  users: [user11, user12],
+  commentChildren: [],
+  files: [file11],
+};
+
+export const textCommentMentionPayload: Amity.CommentPayload = {
+  comments: [textMentionComment11],
+  commentChildren: [],
+  users: [user11],
+  files: [],
+};
+
+export const postPayload: Amity.ProcessedPostPayload = {
+  posts: [post11],
+  users: [user11],
+  files: [file11],
+  comments: [comment11],
+  communityUsers: [],
+  categories: [],
+  communities: [],
+  feeds: [],
+  postChildren: [],
+};
+
+export const textAndImageCommentMixedPayload: Amity.CommentPayload = {
+  comments: [comment11, imageComment11, textImageComment11],
+  users: [user11],
+  commentChildren: [],
+  files: [file11],
+};
+
+export const deletedCommentPayload: Amity.CommentPayload = {
+  comments: [
+    {
+      ...comment11,
+      isDeleted: true,
+    },
+    {
+      ...imageComment11,
+      isDeleted: true,
+    },
+    {
+      ...textImageComment11,
+      isDeleted: true,
+    },
+  ],
+  users: [user11],
+  commentChildren: [],
+  files: [file11],
+};
+
+// Response - BE
+export const textCommentResponse = {
+  data: {
+    ...textCommentPayload,
+    files: [],
+    commentChildren: [],
+    paging: {},
+  },
+};
+
+export const imageCommentResponse = {
+  data: {
+    ...imageCommentPayload,
+    files: [],
+    commentChildren: [],
+    paging: {},
+  },
+};
+
+export const textImageCommentResponse = {
+  data: {
+    ...textImageCommentPayload,
+    files: [],
+    commentChildren: [],
+    paging: {},
+  },
+};
+
+export const textMentionCommentResponse = {
+  data: {
+    ...textCommentMentionPayload,
+    files: [],
+    commentChildren: [],
+    paging: {},
+  },
+};
+
+export const textCommentParentIdResponse = {
+  data: {
+    ...comment12Payload,
+    files: [],
+    commentChildren: [],
+    paging: {},
+  },
+};
+
+export const deletedCommentResponse = {
+  data: {
+    ...deletedCommentPayload,
+    files: [],
+    commentChildren: [],
+    paging: {},
+  },
+};
+
+// Payload Query
+export const textCommentRequestPayload: Parameters<typeof createComment>[0] = {
+  referenceId: post11.postId,
+  referenceType: 'post',
+  data: {
+    text: 'test',
+  },
+};
+
+export const textCommentParentIdRequestPayload: Parameters<typeof createComment>[0] = {
+  referenceId: post11.postId,
+  referenceType: 'post',
+  parentId: comment11.commentId,
+  data: {
+    text: 'test',
+  },
+};
+
+export const imageCommentRequestPayload: Parameters<typeof createComment>[0] = {
+  referenceId: post11.postId,
+  referenceType: 'post',
+  attachments: [
+    {
+      type: 'image',
+      fileId: file11.fileId,
+    },
+  ],
+};
+
+export const textImageCommentRequestPayload: Parameters<typeof createComment>[0] = {
+  referenceId: post11.postId,
+  referenceType: 'post',
+  data: {
+    text: 'test',
+  },
+  attachments: [
+    {
+      type: 'image',
+      fileId: file11.fileId,
+    },
+  ],
+};
+
+export const textCommentWithMentionRequestPayload: Parameters<typeof createComment>[0] = {
+  referenceId: post11.postId,
+  referenceType: 'post',
+  data: {
+    text: 'test',
+  },
+  mentionees: [
+    {
+      type: 'user',
+      userIds: [user11._id, user12._id],
+    },
+  ],
+};

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

@@ -6,6 +6,7 @@ export * from './role';
 export * from './file';
 
 export * from './post';
+export * from './comment';
 
 export * from './poll';
 export * from './follow';