@amityco/ts-sdk 0.0.1-beta.30 → 0.0.1-beta.31

package/src/post/api/deletePost.ts

@@ -1,8 +1,9 @@
 import { getActiveClient } from '~/client/api';
 
-import { getCommunity } from '~/community/api';
-import { dropFromCache, upsertInCache } from '~/cache/api';
 import { fireEvent } from '~/core/events';
+import { upsertInCache } from '~/cache/api';
+import { getCommunity } from '~/community/api';
+import { pushToTombstone } from '~/cache/api/pushToTombstone';
 
 import { getPost } from './getPost';
 
@@ -53,7 +54,7 @@ export const deletePost = async (
 
   if (permanent) {
     setTimeout(() => {
-      dropFromCache(['post', 'get', postId], true);
+      pushToTombstone('post', postId);
     }, 0);
   } else {
     upsertInCache(['post', 'get', postId], { isDeleted: true });

package/src/post/api/getPost.ts

@@ -1,7 +1,10 @@
 import { getActiveClient } from '~/client/api';
 
-import { pullFromCache, dropFromCache } from '~/cache/api';
+import { pullFromCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import { isInTombstone } from '~/cache/api/isInTombstone';
+import { checkIfShouldGoesToTombstone } from '~/cache/utils';
+import { pushToTombstone } from '~/cache/api/pushToTombstone';
 
 /**
  * ```js
@@ -21,6 +24,8 @@ export const getPost = async (postId: Amity.Post['postId']): Promise<Amity.Cache
   const client = getActiveClient();
   client.log('post/getPost', postId);
 
+  isInTombstone('post', postId);
+
   let data: Amity.PostPayload;
 
   try {
@@ -28,11 +33,10 @@ export const getPost = async (postId: Amity.Post['postId']): Promise<Amity.Cache
     const response = await client.http.get<Amity.PostPayload>(
       `/api/v3/posts/${encodeURIComponent(postId)}`,
     );
-
     data = response.data;
   } catch (error) {
-    if ((error as Amity.ErrorResponse)?.code === Amity.ServerError.ITEM_NOT_FOUND) {
-      dropFromCache(['post', 'get', postId], true);
+    if (checkIfShouldGoesToTombstone((error as Amity.ErrorResponse)?.code)) {
+      pushToTombstone('post', postId);
     }
 
     throw error;

package/src/post/api/updatePost.ts

@@ -22,7 +22,12 @@ import { fireEvent } from '~/core/events';
  */
 export const updatePost = async (
   postId: Amity.Post['postId'],
-  patch: Patch<Amity.Post, 'data' | 'metadata' | 'mentionees' | 'tags'>,
+  patch: Patch<Amity.Post, 'data' | 'metadata' | 'mentionees' | 'tags'> & {
+    attachments?: {
+      type: 'image' | 'file' | 'video';
+      fileId: Amity.File['fileId'];
+    }[];
+  },
 ): Promise<Amity.Cached<Amity.Post>> => {
   const client = getActiveClient();
   client.log('user/updatePost', patch);

package/src/user/api/getUser.ts

@@ -1,7 +1,12 @@
 import { getActiveClient } from '~/client/api';
 
-import { pullFromCache } from '~/cache/api';
+import { pullFromCache, dropFromCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
+
+import { isInTombstone } from '~/cache/api/isInTombstone';
+import { checkIfShouldGoesToTombstone } from '~/cache/utils';
+import { pushToTombstone } from '~/cache/api/pushToTombstone';
 
 /**
  * ```js
@@ -17,20 +22,43 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
  * @category User API
  * @async
  */
-export const getUser = async (userId: Amity.User['userId']): Promise<Amity.Cached<Amity.User>> => {
+export const getUser = async (
+  userId: Amity.User['userId'],
+  isLive = false,
+): Promise<Amity.Cached<Amity.User>> => {
   const client = getActiveClient();
   client.log('user/getUser', userId);
 
-  // API-FIX: endpoint should not be /list, parameters should be querystring.
-  const { data } = await client.http.get<Amity.UserPayload>(
-    `/api/v3/users/${encodeURIComponent(userId)}`,
-  );
+  if (!isLive) {
+    console.log('getUser will be deprecated on 25th November 2022, please use liveUser instead.');
+  }
+
+  isInTombstone('user', userId);
+
+  let data: Amity.UserPayload;
+
+  try {
+    // API-FIX: endpoint should not be /list, parameters should be querystring.
+    const response = await client.http.get<Amity.UserPayload>(
+      `/api/v3/users/${encodeURIComponent(userId)}`,
+    );
+
+    data = response.data;
+  } catch (error) {
+    if (checkIfShouldGoesToTombstone((error as Amity.ErrorResponse)?.code)) {
+      pushToTombstone('user', userId);
+    }
+
+    throw error;
+  }
 
   const cachedAt = client.cache && Date.now();
   if (client.cache) ingestInCache(data, { cachedAt });
 
   const { users } = data;
 
+  fireEvent('user.fetched', data);
+
   return {
     data: users.find(user => user.userId === userId)!,
     cachedAt,

package/src/user/api/getUsers.ts

@@ -2,6 +2,7 @@ import { getActiveClient } from '~/client/api';
 
 import { pullFromCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
 
 /**
  * ```js
@@ -33,6 +34,8 @@ export const getUsers = async (
   const cachedAt = client.cache && Date.now();
   if (client.cache) ingestInCache(data, { cachedAt });
 
+  fireEvent('user.fetched', data);
+
   return {
     data: data.users,
     cachedAt,

package/src/user/api/queryUsers.ts

@@ -5,6 +5,7 @@ import { toPage, toToken } from '~/core/query';
 import { pullFromCache, pushToCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { getResolver } from '~/core/model';
+import { fireEvent } from '~/core/events';
 
 /**
  * ```js
@@ -60,6 +61,8 @@ export const queryUsers = async (
     pushToCache(cacheKey, { users: users.map(getResolver('user')), paging });
   }
 
+  fireEvent('user.fetched', data);
+
   const prevPage = toPage(paging.previous);
   const nextPage = toPage(paging.next);
 

package/src/user/api/updateUser.ts

@@ -1,5 +1,6 @@
 import { getActiveClient } from '~/client/api';
 
+import { fireEvent } from '~/core/events';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
@@ -45,6 +46,8 @@ export const updateUser = async (
 
   const { users } = data;
 
+  fireEvent('user.updated', data);
+
   return {
     data: users.find(user => user.userId === userId)!,
     cachedAt,

package/src/user/events/index.ts

@@ -1,3 +1,4 @@
+export * from './onUserFetched';
 export * from './onUserUpdated';
 export * from './onUserDeleted';
 

package/src/user/events/onUserFetched.ts

@@ -0,0 +1,19 @@
+import { createUserEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onUserFetched } from '@amityco/ts-sdk'
+ * const dispose = onUserFetched(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.User} has been fetched
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export const onUserFetched = (callback: Amity.Listener<Amity.User>) =>
+  createUserEventSubscriber('user.fetched', callback);

package/src/user/observers/index.ts

@@ -1 +1,2 @@
+export { liveUser } from './liveUser';
 export { observeUser } from './observeUser';

package/src/user/observers/liveUser.ts

@@ -0,0 +1,89 @@
+import { getActiveClient } from '~/client/api';
+import { createQuery, runQuery } from '~/core/query';
+
+import { LIVE_OBJECT_ENABLE_CACHE_MESSAGE } from '~/utils/constants';
+
+import {
+  onUserFetched,
+  onUserDeleted,
+  onUserUpdated,
+  onUserFlagCleared,
+  onUserFlagged,
+  onUserUnflagged,
+} from '../events';
+import { getUser } from '../api';
+
+/**
+ * ```js
+ * import { liveUser } from '@amityco/ts-sdk'
+ *
+ * let users = []
+ * const unsub = liveUser(userId, response => merge(users, response.data))
+ * ```
+ *
+ * Observe all mutation on a given {@link Amity.User}
+ *
+ * @param userId the ID of the user to observe
+ * @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 users
+ *
+ * @category Message Live Object
+ */
+export const liveUser = (
+  userId: Amity.User['userId'],
+  callback: Amity.LiveObjectCallback<Amity.User>,
+): Amity.Unsubscriber => {
+  const { log, cache } = getActiveClient();
+  let user: Amity.User;
+
+  if (!cache) {
+    console.log(LIVE_OBJECT_ENABLE_CACHE_MESSAGE);
+  }
+
+  const timestamp = Date.now();
+  log(`liveUser(tmpid: ${timestamp}) > listen`);
+
+  const disposers: Amity.Unsubscriber[] = [];
+
+  const dispatcher = (data: Amity.LiveObject<Amity.User>) => {
+    // we check updatedAt to see if the current snapshot is new so
+    // we won't send old data back, only fresh new data
+    if (user && data.data?.updatedAt === user?.updatedAt && data.origin !== 'server') return;
+
+    callback(data);
+    user = data.data;
+  };
+
+  const realtimeRouter = (user: Amity.User, action: Amity.UserActionType) => {
+    dispatcher({ loading: false, data: user, origin: 'event' });
+  };
+
+  const onFetch = () => {
+    const query = createQuery(getUser, userId, true);
+
+    runQuery(query, ({ loading, data, error, origin }) => {
+      dispatcher({ loading, data, origin, error });
+
+      if (error) {
+        // Terminate observe functionality on error
+        disposers.forEach(fn => fn());
+      }
+    });
+  };
+
+  disposers.push(
+    onUserFetched(user => realtimeRouter(user, 'onFetch')),
+    onUserUpdated(user => realtimeRouter(user, 'onUpdate')),
+    onUserDeleted(user => realtimeRouter(user, 'onDelete')),
+    onUserFlagged(user => realtimeRouter(user, 'onFlagged')),
+    onUserUnflagged(user => realtimeRouter(user, 'onUnflagged')),
+    onUserFlagCleared(user => realtimeRouter(user, 'onFlagCleared')),
+  );
+
+  onFetch();
+
+  return () => {
+    log(`liveUser(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};

package/src/user/observers/observeUser.ts

@@ -37,6 +37,8 @@ export const observeUser = <
   const timestamp = Date.now();
   log(`observeUser(tmpid: ${timestamp}) > listen`);
 
+  console.log('observeUser will be deprecated on 25th November 2022, please use liveUser instead.');
+
   // wrapper function to make sure
   const router = (result: Amity.Snapshot<Amity.User>, action: Events[number]) => {
     // filter function

package/src/user/tests/api/getUser.test.ts

@@ -0,0 +1,112 @@
+import { ASCApiError } from '~/core/errors';
+import { disableCache, enableCache, pushToCache } from '~/cache/api';
+import { client, user11 } from '~/utils/tests';
+
+import { pushToTombstone } from '~/cache/api/pushToTombstone';
+import { isInTombstone } from '~/cache/api/isInTombstone';
+
+import { getUser } from '../../api/getUser';
+
+const user = user11;
+const getResolvedUserValue = () => ({
+  data: {
+    users: [user],
+    files: [],
+  },
+});
+
+describe('getUser', () => {
+  test('should return user data', async () => {
+    client.http.get = jest.fn().mockResolvedValue(getResolvedUserValue());
+
+    const { data } = await getUser(user.userId);
+
+    expect(data).toStrictEqual(user);
+  });
+
+  test('it should update cache after fetch from server', async () => {
+    enableCache();
+    client.http.get = jest.fn().mockResolvedValue(getResolvedUserValue());
+    await getUser(user.userId);
+
+    expect(getUser.locally(user.userId)).toBeDefined();
+
+    disableCache();
+  });
+
+  test('should return an error', async () => {
+    client.http.get = jest.fn().mockRejectedValueOnce(new Error('error'));
+
+    await expect(getUser(user.userId)).rejects.toThrow('error');
+  });
+
+  test('should return an error if user in cache but api throws not found', async () => {
+    enableCache();
+    pushToCache(['user', 'get', user.userId], user, { cachedAt: Date.now() });
+
+    client.http.get = jest
+
+      .fn()
+      .mockRejectedValueOnce(
+        new ASCApiError('not found!', Amity.ServerError.ITEM_NOT_FOUND, Amity.ErrorLevel.ERROR),
+      );
+
+    await expect(getUser(user.userId)).rejects.toThrow();
+
+    expect(getUser.locally(user.userId)).toBeUndefined();
+    disableCache();
+  });
+});
+
+describe('getUser locally', () => {
+  test('should return data from cache', () => {
+    enableCache();
+
+    const cachedAt = Date.now();
+
+    pushToCache(['user', 'get', user.userId], user, { cachedAt });
+
+    const data = getUser.locally(user.userId);
+
+    expect(data).toBeDefined();
+    expect(data?.data).toEqual(user);
+    expect(data?.cachedAt).toEqual(cachedAt);
+
+    disableCache();
+  });
+
+  test('should return undefined if user not in cache', () => {
+    expect(getUser.locally('non-existent-user')).toBeUndefined();
+  });
+
+  test('should return undefined if cache not enabled', () => {
+    expect(getUser.locally(user.userId)).toBeUndefined();
+  });
+});
+
+describe('getUser tombostone', () => {
+  test('it should add user to tombostone if 404', async () => {
+    enableCache();
+    client.http.get = jest
+      .fn()
+      .mockRejectedValueOnce(
+        new ASCApiError('not found!', Amity.ServerError.ITEM_NOT_FOUND, Amity.ErrorLevel.ERROR),
+      );
+
+    await expect(getUser(user.userId)).rejects.toThrow();
+    expect(() => {
+      isInTombstone('user', user.userId);
+    }).toThrow();
+
+    disableCache();
+  });
+
+  test('it should throw error if user not found in tombostone', async () => {
+    enableCache();
+
+    pushToTombstone('user', user.userId);
+    await expect(getUser(user.userId)).rejects.toThrow();
+
+    disableCache();
+  });
+});

package/src/user/tests/observers/liveUser.test.ts

@@ -0,0 +1,224 @@
+import { ASCApiError } from '~/core/errors';
+import { disableCache, enableCache } from '~/cache/api';
+import { LIVE_OBJECT_ENABLE_CACHE_MESSAGE } from '~/utils/constants';
+
+import { liveUser } from '../../observers/liveUser';
+
+import {
+  pause,
+  client,
+  connectClient,
+  disconnectClient,
+  userQueryResponse,
+  user11 as defaultUser,
+} from '~/utils/tests';
+
+const getSnapshot = () => {
+  return {
+    loading: true,
+    error: undefined as any,
+    data: undefined as undefined | Amity.User,
+  };
+};
+
+describe('liveUser', () => {
+  beforeAll(async () => {
+    await connectClient();
+  });
+
+  afterAll(async () => {
+    await disconnectClient();
+  });
+
+  beforeEach(async () => {
+    enableCache();
+  });
+
+  afterEach(disableCache);
+
+  test('it should show user if cache not enabled', () => {
+    /*
+     * NOTE: at the time of writing this test cache is diabled by default, but
+     * there is a proposal to enable cache by default. So I'm disabling cache
+     * here to ensure cache is disabled
+     */
+    disableCache();
+
+    const callback = jest.fn();
+    jest.spyOn(global.console, 'log');
+    client.http.get = jest.fn();
+
+    // call liveUser check if mocked console get's called with the correct
+    // user
+    client.use();
+    liveUser(defaultUser.userId, callback);
+
+    expect(console.log).toBeCalledWith(LIVE_OBJECT_ENABLE_CACHE_MESSAGE);
+  });
+
+  test('it should return user live object', async () => {
+    const snapshot = getSnapshot();
+
+    // mock response of queryUsers and validate
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(userQueryResponse);
+
+    liveUser(defaultUser.userId, callback);
+
+    expect(callback).toHaveBeenCalledTimes(1);
+
+    // check if cache data returned (should be empty)
+    expect(callback).toHaveBeenCalledWith(expect.objectContaining(snapshot));
+
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+
+    snapshot.loading = false;
+    snapshot.data = defaultUser;
+
+    expect(callback).toHaveBeenCalledWith(expect.objectContaining(snapshot));
+  });
+
+  test('it should return error on api failure', async () => {
+    const snapshot = getSnapshot();
+    const error = new ASCApiError(
+      'server error!',
+      Amity.ServerError.ITEM_NOT_FOUND,
+      Amity.ErrorLevel.ERROR,
+    );
+
+    // mock response of queryUsers and validate
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockRejectedValue(error);
+
+    liveUser(defaultUser.userId, callback);
+
+    expect(callback).toHaveBeenCalledTimes(1);
+
+    // check if cache data returned (should be empty)
+    expect(callback).toHaveBeenCalledWith(expect.objectContaining(snapshot));
+
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+
+    snapshot.error = error;
+    snapshot.loading = false;
+    expect(callback).toHaveBeenLastCalledWith(expect.objectContaining(snapshot));
+  });
+
+  test('it should terminate updates on api failure', async () => {
+    const snapshot = getSnapshot();
+    const error = new ASCApiError(
+      'server error!',
+      Amity.ServerError.ITEM_NOT_FOUND,
+      Amity.ErrorLevel.ERROR,
+    );
+
+    // mock response of queryUsers and validate
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockRejectedValue(error);
+
+    liveUser(defaultUser.userId, callback);
+
+    expect(callback).toHaveBeenCalledTimes(1);
+
+    // check if cache data returned (should be empty)
+    expect(callback).toHaveBeenCalledWith(expect.objectContaining(snapshot));
+
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+
+    snapshot.error = error;
+    snapshot.loading = false;
+    expect(callback).toHaveBeenLastCalledWith(expect.objectContaining(snapshot));
+
+    const updatedAt = new Date(defaultUser?.updatedAt ?? new Date());
+    updatedAt.setDate(updatedAt.getDate() + 7);
+
+    const updatedUser = {
+      ...defaultUser,
+      updatedAt: updatedAt.toISOString(),
+    };
+    client.emitter.emit('user.updated', { users: [updatedUser], files: [] });
+
+    delete snapshot.error;
+    snapshot.loading = false;
+    snapshot.data = updatedUser;
+    expect(callback).not.toHaveBeenNthCalledWith(3, expect.objectContaining(snapshot));
+  });
+
+  test('it should not return updates on obtain once!', async () => {
+    const snapshot = getSnapshot();
+
+    // mock response of queryUsers and validate
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(userQueryResponse);
+
+    const unsub = liveUser(defaultUser.userId, callback);
+
+    expect(callback).toHaveBeenCalledTimes(1);
+
+    // check if cache data returned (should be empty)
+    expect(callback).toHaveBeenCalledWith(expect.objectContaining(snapshot));
+
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+
+    unsub();
+
+    const updatedAt = new Date(defaultUser?.updatedAt ?? new Date());
+    updatedAt.setDate(updatedAt.getDate() + 7);
+
+    const updatedUser = {
+      ...defaultUser,
+      updatedAt: updatedAt.toISOString(),
+    };
+    client.emitter.emit('user.updated', { users: [updatedUser], files: [] });
+
+    delete snapshot.error;
+    snapshot.loading = false;
+    snapshot.data = updatedUser;
+    expect(callback).not.toHaveBeenNthCalledWith(3, expect.objectContaining(snapshot));
+  });
+
+  const events: [string, keyof Amity.Events][] = [
+    ['it should return updated user on onFetch', 'user.fetched'],
+    ['it should return updated user on onUpdate', 'user.updated'],
+    ['it should return updated user on onDelete', 'user.deleted'],
+    ['it should return updated user on onFlagged', 'user.flagged'],
+    ['it should return updated user on onUnflagged', 'user.unflagged'],
+    ['it should return updated user on onFlagCleared', 'user.flagCleared'],
+  ];
+
+  test.each(events)('%s', async (test, event) => {
+    const snapshot = getSnapshot();
+
+    // mock response of queryUsers and validate
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(userQueryResponse);
+
+    liveUser(defaultUser.userId, callback);
+
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(2);
+
+    const updatedAt = new Date(defaultUser?.updatedAt ?? new Date());
+    updatedAt.setDate(updatedAt.getDate() + 7);
+
+    const updatedUser = {
+      ...defaultUser,
+      updatedAt: updatedAt.toISOString(),
+    };
+    client.emitter.emit(event, { users: [updatedUser], files: [] });
+
+    delete snapshot.error;
+    snapshot.loading = false;
+    snapshot.data = updatedUser;
+    expect(callback).toHaveBeenNthCalledWith(3, expect.objectContaining(snapshot));
+  });
+});

package/src/utils/constants.ts

@@ -1,3 +1,8 @@
 export const COLLECTION_DEFAULT_PAGINATION_LIMIT = 5;
 export const COLLECTION_DEFAULT_CACHING_POLICY: Amity.QueryPolicy = 'cache_then_server';
 export const ENABLE_CACHE_MESSAGE = 'For using Live Collection feature you need to enable Cache!';
+export const LIVE_OBJECT_ENABLE_CACHE_MESSAGE =
+  'For using Live Object feature you need to enable Cache!';
+export const UNSYNCED_OBJECT_CACHED_AT_MESSAGE =
+  'Observing unsynced object is not supported by Live Object.';
+export const UNSYNCED_OBJECT_CACHED_AT_VALUE = -5;