@amityco/ts-sdk 0.0.1-be4fc2f.0 → 0.0.1-bef76fa.0

package/src/user/events/onUserFlagged.ts

@@ -1,4 +1,4 @@
-import { createUserEventSubscriber } from './utils'
+import { createUserEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -8,7 +8,7 @@ import { createUserEventSubscriber } from './utils'
  * })
  * ```
  *
- * Fired when any {@link Amity.User} have been updated
+ * Fired when a {@link Amity.User} has been flagged
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening
@@ -16,4 +16,4 @@ import { createUserEventSubscriber } from './utils'
  * @category User Events
  */
 export const onUserFlagged = (callback: Amity.Listener<Amity.User>) =>
-  createUserEventSubscriber('user.flagged', callback)
+  createUserEventSubscriber('user.flagged', callback);

package/src/user/events/onUserUnflagged.ts

@@ -1,4 +1,4 @@
-import { createUserEventSubscriber } from './utils'
+import { createUserEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -8,7 +8,7 @@ import { createUserEventSubscriber } from './utils'
  * })
  * ```
  *
- * Fired when any {@link Amity.User} have been updated
+ * Fired when a flag has been removed from a {@link Amity.User}
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening
@@ -16,4 +16,4 @@ import { createUserEventSubscriber } from './utils'
  * @category User Events
  */
 export const onUserUnflagged = (callback: Amity.Listener<Amity.User>) =>
-  createUserEventSubscriber('user.unflagged', callback)
+  createUserEventSubscriber('user.unflagged', callback);

package/src/user/events/onUserUpdated.ts

@@ -1,4 +1,4 @@
-import { createUserEventSubscriber } from './utils'
+import { createUserEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -8,7 +8,7 @@ import { createUserEventSubscriber } from './utils'
  * })
  * ```
  *
- * Fired when any {@link Amity.User} have been updated
+ * Fired when a {@link Amity.User} has been updated
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening
@@ -16,4 +16,4 @@ import { createUserEventSubscriber } from './utils'
  * @category User Events
  */
 export const onUserUpdated = (callback: Amity.Listener<Amity.User>) =>
-  createUserEventSubscriber('user.updated', callback)
+  createUserEventSubscriber('user.updated', callback);

package/src/user/events/utils.ts

@@ -1,24 +1,21 @@
-import { getActiveClient } from '~/client/api'
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
-import { createEventSubscriber } from '~/core/events'
+import { getActiveClient } from '~/client/api/activeClient';
+import { createEventSubscriber } from '~/core/events';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 export const createUserEventSubscriber = (
   event: keyof Amity.MqttUserMessageEvents,
-  callback: Amity.Listener<Amity.User>
+  callback: Amity.Listener<Amity.User>,
 ) => {
-  const client = getActiveClient()
+  const client = getActiveClient();
 
   const filter = (payload: Amity.UserPayload) => {
-    decoratePayload(payload)
-    ingestInCache(payload)
-    callback(payload.users[0])
-  }
+    if (client.cache) {
+      ingestInCache(payload);
+    }
+
+    callback(payload.users[0]);
+  };
 
-  return createEventSubscriber(
-    client,
-    event,
-    event,
-    filter
-  )
-}
+  return createEventSubscriber(client, event, event, filter);
+};

package/src/user/observers/index.ts

@@ -1 +1,2 @@
-export { observeUser } from './observeUser'
+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

@@ -1,14 +1,15 @@
-import { createQuery, runQuery } from '~/core/query/query'
+import { createQuery, runQuery } from '~/core/query/query';
 
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { getUser } from '../api'
+import { getUser } from '../api';
 import {
   onUserUpdated,
+  onUserDeleted,
   onUserFlagged,
   onUserUnflagged,
   onUserFlagCleared,
-} from '../events'
+} from '../events';
 
 /**
  * ```js
@@ -25,48 +26,45 @@ import {
  * Observe all mutation on a given {@link Amity.User}
  * @category User Observer
  */
-export const observeUser = <Events extends ['onFetch', 'onUpdate', 'onFlagged', 'onUnflagged', 'onFlagCleared']>(
+export const observeUser = <
+  Events extends ['onFetch', 'onUpdate', 'onDelete', 'onFlagged', 'onUnflagged', 'onFlagCleared'],
+>(
   userId: string,
-  callback: Amity.ObjectListener<Amity.QueryResult<Amity.User>, Events>,
+  callback: Amity.ObjectListener<Amity.Snapshot<Amity.User>, Events>,
 ): Amity.Unsubscriber => {
-  const { log } = getActiveClient()
+  const { log } = getActiveClient();
 
-  const timestamp = Date.now()
-  log(`observeUser(tmpid: ${timestamp}) > listen`)
+  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.QueryResult<Amity.User>,
-    action: Events[number]
-  ) => {
+  const router = (result: Amity.Snapshot<Amity.User>, action: Events[number]) => {
     // filter function
-    if (result.data?.userId !== userId) return
+    if (result.data?.userId !== userId) return;
 
-    if (callback instanceof Function)
-      return callback(result)
+    if (callback instanceof Function) return callback(result);
 
-    if (action !== 'onFetch')
-      callback.onEvent?.(action, result)
+    if (action !== 'onFetch') callback.onEvent?.(action, result);
 
-    callback[action]?.(result)
-  }
+    callback[action]?.(result);
+  };
 
-  const disposers: Amity.Unsubscriber[] = []
+  const disposers: Amity.Unsubscriber[] = [];
 
   disposers.push(
-    onUserUpdated(data => router({ data }, 'onUpdate')),
-    onUserFlagged(data => router({ data }, 'onFlagged')),
-    onUserUnflagged(data => router({ data }, 'onUnflagged')),
-    onUserFlagCleared(data => router({ data }, 'onFlagCleared'))
-  )
+    onUserUpdated(data => router({ data, loading: false, origin: 'event' }, 'onUpdate')),
+    onUserDeleted(data => router({ data, loading: false, origin: 'event' }, 'onDelete')),
+    onUserFlagged(data => router({ data, loading: false, origin: 'event' }, 'onFlagged')),
+    onUserUnflagged(data => router({ data, loading: false, origin: 'event' }, 'onUnflagged')),
+    onUserFlagCleared(data => router({ data, loading: false, origin: 'event' }, 'onFlagCleared')),
+  );
 
-  runQuery(
-    createQuery(getUser, userId),
-    (result) => result.data && router(result, 'onFetch'),
-  )
+  runQuery(createQuery(getUser, userId), result => result.data && router(result, 'onFetch'));
 
   return () => {
-    log(`observeUser(tmpid: ${timestamp}) > dispose`)
-    disposers.forEach(fn => fn())
-  }
-}
+    log(`observeUser(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};

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

@@ -0,0 +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;

package/src/utils/env.ts

@@ -0,0 +1,12 @@
+/* eslint-disable no-undef */
+const theGlobal =
+  // eslint-disable-next-line no-nested-ternary
+  typeof globalThis === 'object' ? globalThis : typeof global === 'object' ? global : window;
+
+export const { process: safeProcess = {} }: { process: Partial<NodeJS.Process> } = theGlobal;
+
+export function getEnv(): NodeJS.ProcessEnv | undefined {
+  return safeProcess.env ?? {};
+}
+
+export const isProduction = safeProcess.env?.NODE_ENV === 'production';

package/src/utils/tests/client.ts

@@ -0,0 +1,33 @@
+import {
+  createClient,
+  connectClient as sdkConnectClient,
+  disconnectClient as sdkDisconnectClient,
+} from '~/client/api';
+
+import { user11 } from './dummy';
+
+export const client = createClient('key', 'sg');
+
+export const connectClient = async () => {
+  client.mqtt.connect = jest.fn();
+  client.mqtt.subscribe = jest.fn();
+  client.http.post = jest.fn().mockReturnValueOnce({
+    data: {
+      accessToken: 'accessToken',
+      refreshToken: 'refreshToken',
+      users: [user11],
+    },
+  });
+
+  setTimeout(() => {
+    client.ws.emit('connect');
+  }, 500);
+
+  await sdkConnectClient({ userId: 'test' });
+};
+
+export const disconnectClient = async () => {
+  sdkDisconnectClient().then(() => client.ws.emit('disconnect'));
+};
+
+export default {};