@amityco/ts-sdk 6.35.3-f8f74ab5.0 → 6.35.3

package/src/commentRepository/internalApi/getCommentByIds.ts

@@ -0,0 +1,65 @@
+import { getActiveClient } from '~/client/api';
+
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { checkIfShouldGoesToTombstone } from '~/cache/utils';
+import { pushToTombstone } from '~/cache/api/pushToTombstone';
+
+export const getCommentByIds = async (
+  commentIds: Amity.InternalComment['commentId'][],
+): Promise<Amity.Cached<Amity.InternalComment[]>> => {
+  const client = getActiveClient();
+  client.log('comment/getCommentByIds', commentIds);
+
+  const encodedCommentIds = commentIds.map(commentId => encodeURIComponent(commentId));
+
+  let data: Amity.CommentPayload;
+
+  try {
+    // API-FIX: endpoint should not be /list, parameters should be querystring.
+    const response = await client.http.get<Amity.CommentPayload>(`/api/v3/comments/list`, {
+      params: { commentIds: encodedCommentIds },
+    });
+
+    data = response.data;
+  } catch (error) {
+    commentIds.forEach(commentId => {
+      if (checkIfShouldGoesToTombstone((error as Amity.ErrorResponse)?.code)) {
+        pushToTombstone('comment', commentId);
+      }
+    });
+
+    throw error;
+  }
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  return {
+    data: data.comments,
+    cachedAt,
+  };
+};
+
+getCommentByIds.locally = (
+  commentIds: Amity.InternalComment['commentId'][],
+): Amity.Cached<Amity.InternalComment[]> | undefined => {
+  const client = getActiveClient();
+  client.log('comment/getCommentByIds.locally', commentIds);
+
+  if (!client.cache) return;
+
+  const cached = commentIds
+    .map(commentId => pullFromCache<Amity.InternalComment>(['comment', 'get', commentId])!)
+    .filter(Boolean);
+
+  const comments = cached.map(({ data }) => data);
+  const oldest = cached.sort((a, b) => (a.cachedAt! < b.cachedAt! ? -1 : 1))?.[0];
+
+  if (cached?.length < commentIds.length) return;
+
+  return {
+    data: comments,
+    cachedAt: oldest.cachedAt,
+  };
+};

package/src/commentRepository/internalApi/hardDeleteComment.ts

@@ -0,0 +1,14 @@
+import { getActiveClient } from '~/client/api';
+
+import { deleteComment } from './deleteComment';
+
+export const hardDeleteComment = async (
+  commentId: Amity.InternalComment['commentId'],
+): Promise<Amity.InternalComment> => {
+  const client = getActiveClient();
+  client.log('comment/hardDeleteComment', commentId);
+
+  const hardDeleted = deleteComment(commentId, true);
+
+  return hardDeleted;
+};

package/src/commentRepository/internalApi/index.ts

@@ -0,0 +1,12 @@
+export * from './getCommentByIds';
+
+export * from './createComment';
+export * from './updateComment';
+
+export * from './deleteComment';
+export * from './softDeleteComment';
+export * from './hardDeleteComment';
+
+export * from './flagComment';
+export * from './unflagComment';
+export * from './isCommentFlaggedByMe';

package/src/commentRepository/internalApi/isCommentFlaggedByMe.ts

@@ -0,0 +1,14 @@
+import { getActiveClient } from '~/client/api/activeClient';
+
+export const isCommentFlaggedByMe = async (
+  commentId: Amity.InternalComment['commentId'],
+): Promise<boolean> => {
+  const client = getActiveClient();
+  client.log('comment/isCommentFlaggedByMe', commentId);
+
+  const {
+    data: { result },
+  } = await client.http.get(`/api/v3/comments/${commentId}/isflagbyme`);
+
+  return result;
+};

package/src/commentRepository/internalApi/queryComments.ts

@@ -0,0 +1,54 @@
+import { getActiveClient } from '~/client/api';
+import { pushToCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { getResolver } from '~/core/model';
+import { inferIsDeleted } from '~/utils/inferIsDeleted';
+import { convertToInternalComment } from '../utils/convertToInternalComment';
+
+export const queryComments = async (
+  query: Amity.QueryComments,
+): Promise<Amity.Cached<Amity.PageToken<Amity.InternalComment>>> => {
+  const client = getActiveClient();
+  client.log('comment/queryComments', query);
+
+  const { limit = 10, includeDeleted, ...params } = query;
+
+  const options = {
+    type: params.sortBy || query.limit ? 'pagination' : undefined,
+    limit: query.limit,
+    token: query.page,
+  };
+  // const filterByParentId = query.parentId !== undefined
+
+  // API-FIX: parameters should be querystring. (1)
+  // API-FIX: backend should answer Amity.Response (2)
+  // const { data } = await client.http.get<Amity.Response<Amity.PagedResponse<Amity.CommentPayload>>>(
+  const { data } = await client.http.get<Amity.CommentPayload & Amity.Pagination>(
+    `/api/v3/comments`,
+    {
+      params: {
+        ...params,
+        isDeleted: inferIsDeleted(includeDeleted),
+        //      filterByParentId, API-FIX: backend does not support this boolean LOL. what the hell seriously.
+        options,
+      },
+    },
+  );
+
+  // API-FIX: backend should answer Amity.Response (2)
+  // const { paging, comments } = unwrapPayload(data)
+  const { paging, ...payload } = data;
+  const processedData = convertToInternalComment(payload);
+  const { comments } = processedData;
+
+  const cachedAt = client.cache && Date.now();
+
+  if (client.cache) {
+    ingestInCache(processedData as Amity.CommentPayload, { cachedAt });
+
+    const cacheKey = ['comment', 'query', { ...params, options: { limit } } as Amity.Serializable];
+    pushToCache(cacheKey, { comments: comments.map(getResolver('comment')), paging });
+  }
+
+  return { data: comments, cachedAt, paging };
+};

package/src/commentRepository/internalApi/softDeleteComment.ts

@@ -0,0 +1,14 @@
+import { getActiveClient } from '~/client/api';
+
+import { deleteComment } from './deleteComment';
+
+export const softDeleteComment = async (
+  commentId: Amity.InternalComment['commentId'],
+): Promise<Amity.InternalComment> => {
+  const client = getActiveClient();
+  client.log('comment/softDeleteComment', commentId);
+
+  const softDeleted = deleteComment(commentId);
+
+  return softDeleted;
+};

package/src/commentRepository/internalApi/tests/createComment.test.ts

@@ -0,0 +1,114 @@
+import { getActiveClient } from '~/client/api';
+import {
+  client,
+  connectClient,
+  disconnectClient,
+  comment11,
+  imageComment11,
+  textImageComment11,
+  textMentionComment11,
+  comment12,
+  post11,
+  imageCommentResponse,
+  textCommentParentIdResponse,
+  textCommentResponse,
+  textImageCommentResponse,
+  textMentionCommentResponse,
+  imageCommentRequestPayload,
+  textCommentParentIdRequestPayload,
+  textCommentRequestPayload,
+  textCommentWithMentionRequestPayload,
+  textImageCommentRequestPayload,
+} from '~/utils/tests';
+import { ASCApiError } from '~/core/errors';
+import { createComment } from '../createComment';
+
+const getPostResponse = {
+  data: post11,
+  cachedAt: 1673337034544,
+};
+
+jest.mock('~/postRepository/api/getPost', () => ({
+  getPost: jest.fn(() => Promise.resolve(getPostResponse)),
+}));
+
+describe('createComment', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  // integration_test_id: 2f83eabc-46db-43d8-89c6-1b5339d6a273
+  it('creates a text comment and returns the new valid comment', async () => {
+    client.http.post = jest.fn().mockResolvedValueOnce(textCommentResponse);
+
+    const newComment = await createComment(textCommentRequestPayload);
+
+    expect(getActiveClient().http.post).toHaveBeenCalledWith(
+      '/api/v3/comments',
+      textCommentRequestPayload,
+    );
+    expect(newComment.data).toEqual(comment11);
+  });
+
+  // integration_test_id: 81e7d5bc-6881-4f9b-b8d4-deb5fe67200c
+  it('creates a image comment and returns the new valid comment', async () => {
+    client.http.post = jest.fn().mockResolvedValueOnce(imageCommentResponse);
+
+    const newComment = await createComment(imageCommentRequestPayload);
+
+    expect(getActiveClient().http.post).toHaveBeenCalledWith(
+      '/api/v3/comments',
+      imageCommentRequestPayload,
+    );
+    expect(newComment.data).toEqual(imageComment11);
+  });
+
+  // integration_test_id: 015838a8-3267-4253-920a-9ae83197cf22
+  it('creates an image + text comment and returns the new valid comment', async () => {
+    client.http.post = jest.fn().mockResolvedValueOnce(textImageCommentResponse);
+
+    const newComment = await createComment(textImageCommentRequestPayload);
+
+    expect(getActiveClient().http.post).toHaveBeenCalledWith(
+      '/api/v3/comments',
+      textImageCommentRequestPayload,
+    );
+    expect(newComment.data).toEqual(textImageComment11);
+  });
+
+  // integration_test_id: c2285355-f3b6-4e22-926b-11bcf0393161
+  it('creates text comment with mention and returns the new valid comment', async () => {
+    client.http.post = jest.fn().mockResolvedValueOnce(textMentionCommentResponse);
+
+    const newComment = await createComment(textCommentWithMentionRequestPayload);
+
+    expect(getActiveClient().http.post).toHaveBeenCalledWith(
+      '/api/v3/comments',
+      textCommentWithMentionRequestPayload,
+    );
+    expect(newComment.data).toEqual(textMentionComment11);
+  });
+
+  // integration_test_id: cb1bfe11-c11a-4324-aeb5-03370da820ad
+  it('creates text comment with parent_id and returns the new valid comment', async () => {
+    client.http.post = jest.fn().mockResolvedValueOnce(textCommentParentIdResponse);
+
+    const newComment = await createComment(textCommentParentIdRequestPayload);
+
+    expect(getActiveClient().http.post).toHaveBeenCalledWith(
+      '/api/v3/comments',
+      textCommentParentIdRequestPayload,
+    );
+    expect(newComment.data).toEqual(comment12);
+  });
+
+  // integration_test_id: 7f411488-abba-46d1-8707-a1d8adbd7242
+  it('creates text comment with invalid parent_id and returns 400400 error', async () => {
+    client.http.post = jest
+      .fn()
+      .mockRejectedValueOnce(
+        new ASCApiError('not found!', Amity.ServerError.ITEM_NOT_FOUND, Amity.ErrorLevel.ERROR),
+      );
+
+    await expect(createComment(textCommentParentIdRequestPayload)).rejects.toThrow();
+  });
+});

package/src/commentRepository/internalApi/tests/deleteComment.test.ts

@@ -0,0 +1,60 @@
+import {
+  client,
+  comment11,
+  connectClient,
+  disconnectClient,
+  emptyPostPayload,
+  generateComment,
+  generatePost,
+  textCommentResponse,
+  user11,
+} from '~/utils/tests';
+import { ASCApiError } from '~/core/errors';
+import { deleteComment } from '../deleteComment';
+
+const commentId = 'comment11';
+const commentData = generateComment({ commentId });
+
+const singlePostResponse = {
+  data: {
+    ...emptyPostPayload,
+    posts: [generatePost({ comments: [commentId], commentsCount: 1 })],
+    comments: [commentData],
+    users: [user11],
+  } as Amity.ProcessedPostPayload,
+};
+
+describe('deleteComment', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  // integration_test_id: ff01df65-2cc0-4fd8-8c3e-a12cea5a359b
+  test('should return success for soft and hard delete', async () => {
+    client.http.get = jest.fn().mockImplementation(url => {
+      if (url === '/api/v3/comments/comment11') return textCommentResponse;
+      // /api/v3/posts/postId11
+      return singlePostResponse;
+    });
+    client.http.delete = jest.fn().mockResolvedValueOnce({ success: true });
+
+    const result = await deleteComment(commentId);
+    expect(result.isDeleted).toEqual(true);
+    expect(result.commentId).toEqual(commentId);
+  });
+
+  // integration_test_id: 322954d6-bc89-40ae-bd18-691ee0c60105
+  test('should return error for deletion not successful', async () => {
+    client.http.get = jest.fn().mockImplementation(url => {
+      if (url === '/api/v3/comments/comment11') return textCommentResponse;
+      // /api/v3/posts/postId11
+      return singlePostResponse;
+    });
+    client.http.delete = jest
+      .fn()
+      .mockRejectedValueOnce(
+        new ASCApiError('not found!', Amity.ServerError.ITEM_NOT_FOUND, Amity.ErrorLevel.ERROR),
+      );
+
+    await expect(deleteComment(commentId)).rejects.toThrow();
+  });
+});

package/src/commentRepository/internalApi/tests/getCommentByIds.test.ts

@@ -0,0 +1,48 @@
+import { enableCache, pushToCache } from '~/cache/api';
+import { client, comment11, connectClient, disconnectClient, user11 } from '~/utils/tests';
+import { ASCApiError } from '~/core/errors';
+import { getCommentByIds } from '../getCommentByIds';
+
+const apiResponse = {
+  data: {
+    comments: [comment11],
+    commentChildren: [],
+    users: [user11],
+    files: [],
+  },
+};
+
+const commentsListResponse = {
+  data: [comment11],
+};
+
+describe('getCommentByIds', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  test('Should return the comments from backend', async () => {
+    enableCache();
+    client.http.get = jest.fn().mockResolvedValueOnce(apiResponse);
+    const { data } = await getCommentByIds([comment11.commentId]);
+    expect(data).toEqual(commentsListResponse.data);
+  });
+
+  test('Should return comments from locally', () => {
+    pushToCache(['user', 'get', user11.userId], user11);
+    const comments: ReturnType<typeof getCommentByIds.locally> = getCommentByIds.locally([
+      comment11.commentId,
+    ]);
+
+    expect(comments?.data).toEqual(commentsListResponse.data);
+  });
+
+  test('Should return Error: 400400 when getCommentByIds from invalid commentId', async () => {
+    client.http.get = jest
+      .fn()
+      .mockRejectedValueOnce(
+        new ASCApiError('not found!', Amity.ServerError.ITEM_NOT_FOUND, Amity.ErrorLevel.ERROR),
+      );
+
+    await expect(getCommentByIds([comment11.commentId])).rejects.toThrow();
+  });
+});

package/src/commentRepository/internalApi/tests/getComments.test.ts

@@ -0,0 +1,48 @@
+import { enableCache, pushToCache } from '~/cache/api';
+import { client, comment11, connectClient, disconnectClient, user11 } from '~/utils/tests';
+import { ASCApiError } from '~/core/errors';
+import { getCommentByIds } from '../getCommentByIds';
+
+const apiResponse = {
+  data: {
+    comments: [comment11],
+    commentChildren: [],
+    users: [user11],
+    files: [],
+  },
+};
+
+const commentsListResponse = {
+  data: [comment11],
+};
+
+describe('getCommentByIds', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  test('Should return the comments from backend', async () => {
+    enableCache();
+    client.http.get = jest.fn().mockResolvedValueOnce(apiResponse);
+    const { data } = await getCommentByIds([comment11.commentId]);
+    expect(data).toEqual(commentsListResponse.data);
+  });
+
+  test('Should return comments from locally', () => {
+    pushToCache(['user', 'get', user11.userId], user11);
+    const comments: ReturnType<typeof getCommentByIds.locally> = getCommentByIds.locally([
+      comment11.commentId,
+    ]);
+
+    expect(comments?.data).toEqual(commentsListResponse.data);
+  });
+
+  test('Should return Error: 400400 when getCommentByIds from invalid commentId', async () => {
+    client.http.get = jest
+      .fn()
+      .mockRejectedValueOnce(
+        new ASCApiError('not found!', Amity.ServerError.ITEM_NOT_FOUND, Amity.ErrorLevel.ERROR),
+      );
+
+    await expect(getCommentByIds([comment11.commentId])).rejects.toThrow();
+  });
+});

package/src/commentRepository/internalApi/tests/hardDeleteComment.test.ts

@@ -0,0 +1,52 @@
+import {
+  client,
+  connectClient,
+  disconnectClient,
+  generatePost,
+  generateComment,
+} from '~/utils/tests';
+import { disableCache, enableCache } from '~/cache/api';
+
+import { hardDeleteComment } from '../hardDeleteComment';
+
+const getPostResponse = {
+  data: generatePost,
+  cachedAt: 1673337034544,
+};
+
+jest.mock('~/postRepository/api/getPost', () => ({
+  getPost: jest.fn(() => Promise.resolve(getPostResponse)),
+}));
+
+describe('hardDeleteComment', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  beforeEach(enableCache);
+  afterEach(disableCache);
+
+  /*
+   * this is the only test required as the rest should be tested in
+   * deleteComment.test.ts
+   */
+  test('it should call the api with the correct param', async () => {
+    const mockApi = jest.fn().mockResolvedValue({ data: {} });
+    const commentId = 'comment-id';
+    const expected = { params: { permanent: true, commentId } };
+
+    // mock get comment
+    client.http.get = jest.fn().mockResolvedValue({
+      data: {
+        comments: [{ ...generateComment(), commentId: 'comment-id' }],
+        commentChildren: [],
+      },
+    });
+    client.http.delete = mockApi;
+
+    await hardDeleteComment(commentId);
+
+    const recieved = mockApi.mock.lastCall[1];
+
+    expect(recieved).toStrictEqual(expected);
+  });
+});

package/src/commentRepository/internalApi/tests/queryComments.test.ts

@@ -0,0 +1,147 @@
+import {
+  client,
+  comment12,
+  comment12Payload,
+  connectClient,
+  deletedCommentPayload,
+  deletedCommentResponse,
+  disconnectClient,
+  imageCommentPayload,
+  imageCommentResponse,
+  post11,
+  textAndImageCommentMixedPayload,
+  textCommentPayload,
+  textCommentRequestPayload,
+  textCommentResponse,
+} from '~/utils/tests';
+import { ASCApiError } from '~/core/errors';
+
+import { queryComments } from '../queryComments';
+
+type mockParamAndResponse = {
+  query: Amity.QueryComments;
+  response: Amity.InternalComment[];
+};
+
+const queryParams: mockParamAndResponse = {
+  query: {
+    referenceType: 'post',
+    referenceId: post11.postId,
+  },
+  response: textCommentPayload.comments,
+};
+
+const queryImageOnly: mockParamAndResponse = {
+  query: {
+    ...queryParams.query,
+    dataTypes: {
+      values: ['image'],
+      matchType: 'exact',
+    },
+  },
+  response: imageCommentPayload.comments,
+};
+
+const queryImageAny: mockParamAndResponse = {
+  query: {
+    ...queryParams.query,
+    dataTypes: {
+      values: ['image'],
+      matchType: 'any',
+    },
+  },
+  response: textAndImageCommentMixedPayload.comments,
+};
+
+const queryWithParentId: mockParamAndResponse = {
+  query: {
+    ...queryParams.query,
+    parentId: comment12.parentId,
+  },
+  response: comment12Payload.comments,
+};
+
+const deletedComment: mockParamAndResponse = {
+  query: {
+    ...queryParams.query,
+    includeDeleted: true,
+  },
+  response: deletedCommentPayload.comments,
+};
+
+describe('queryComments', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  const testCase: [string, object, Amity.QueryComments, Amity.InternalComment[]][] = [
+    [
+      // integration_test_id: 0be48975-be6d-4199-bec0-af186af444d3
+      'Should return valid comment when user query with valid query',
+      textCommentResponse,
+      queryParams.query,
+      queryParams.response,
+    ],
+    [
+      // integration_test_id: 4550e036-53d0-4f35-b83f-9edc10f1c974
+
+      'Should return only valid image comment types when user query with dataType exact image',
+      imageCommentResponse,
+      queryImageOnly.query,
+      queryImageOnly.response,
+    ],
+    [
+      // integration_test_id: 03056892-251f-4a85-a9bf-f9978c1912e5
+      'Should return only valid deleted comment list when user query with isDeleted=true',
+      deletedCommentResponse,
+      deletedComment.query,
+      deletedComment.response,
+    ],
+    [
+      // integration_test_id: 2f68da78-7738-4371-ae72-b6a4ff043404
+
+      'Should return only valid mixed types comment list when user query with dataType any image',
+      {
+        data: {
+          ...textAndImageCommentMixedPayload,
+          paging: {},
+        },
+      },
+      queryImageAny.query,
+      queryImageAny.response,
+    ],
+    [
+      // integration_test_id: 8207d436-a800-4224-8fb0-a46c05f7d11e
+      'Should return only valid mixed types comment list when user query with parent_id',
+      {
+        data: {
+          ...comment12Payload,
+          paging: {},
+        },
+      },
+      queryWithParentId.query,
+      queryWithParentId.response,
+    ],
+  ];
+
+  test.each(testCase)('%s', async (title, mockResponse, query, expectResult) => {
+    client.http.get = jest.fn().mockResolvedValueOnce(mockResponse);
+    const result = await queryComments(query);
+    expect(result.data).toEqual(expectResult);
+  });
+
+  const errorCase: [string, number, Amity.QueryComments][] = [
+    [
+      // integration_test_id: 2719d77f-177a-401f-864f-ef0f0804cc24
+      'Should return error 400400 when query with wrong post_id', // title
+      Amity.ServerError.ITEM_NOT_FOUND, // errorCode
+      textCommentRequestPayload, // payload
+    ],
+  ];
+
+  test.each(errorCase)('%s', async (title, errorCode, payload) => {
+    client.http.get = jest
+      .fn()
+      .mockRejectedValueOnce(new ASCApiError('not found!', errorCode, Amity.ErrorLevel.ERROR));
+    await expect(queryComments(payload)).rejects.toThrow();
+  });
+});