chore: update ACL message

sendbird · Oct 25, 2022 · 962d694 · 962d694
1 parent 9a925a0
commit 962d694
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 3 deletions.
diff --git a/packages/uikit-chat-hooks/src/common/useUserList.ts b/packages/uikit-chat-hooks/src/common/useUserList.ts
@@ -1,11 +1,13 @@
 import { useCallback, useMemo, useRef, useState } from 'react';
 
-import { Optional, SendbirdChatSDK, SendbirdUser, useAsyncEffect } from '@sendbird/uikit-utils';
+import type { Optional, SendbirdChatSDK, SendbirdUser } from '@sendbird/uikit-utils';
+import { Logger, SBErrorCode, SBErrorMessage, useAsyncEffect } from '@sendbird/uikit-utils';
 
 import type { CustomQueryInterface, UseUserListOptions, UseUserListReturn } from '../types';
 
 const createUserQuery = <User>(sdk: SendbirdChatSDK, queryCreator?: UseUserListOptions<User>['queryCreator']) => {
   if (queryCreator) return queryCreator();
+  // In order to use the API, the option must be turned on in the dashboard.
   return sdk.createApplicationUserListQuery() as unknown as CustomQueryInterface<User>;
 };
 
@@ -57,7 +59,11 @@ export const useUserList = <
   const init = useCallback(async () => {
     query.current = createUserQuery<QueriedUser>(sdk, options?.queryCreator);
     if (query.current?.hasNext) {
-      const users = await query.current?.next();
+      const users = await query.current?.next().catch((err) => {
+        Logger.error(error);
+        if (err.code === SBErrorCode.NON_AUTHORIZED) Logger.warn(SBErrorMessage.ACL);
+        throw error;
+      });
       updateUsers(users, true);
     }
   }, [sdk, options?.queryCreator]);
@@ -88,7 +94,12 @@ export const useUserList = <
 
   const next = useCallback(async () => {
     if (query.current && query.current?.hasNext) {
-      updateUsers(await query.current?.next(), false);
+      const nextUsers = await query.current.next().catch((err) => {
+        Logger.error(error);
+        if (err.code === SBErrorCode.NON_AUTHORIZED) Logger.warn(SBErrorMessage.ACL);
+        throw error;
+      });
+      updateUsers(nextUsers, false);
     }
   }, []);
 

diff --git a/packages/uikit-utils/src/index.ts b/packages/uikit-utils/src/index.ts
@@ -28,6 +28,15 @@ export const NOOP: () => void = () => void 0;
 export const ASYNC_NOOP = async () => void 0;
 export const PASS = <T>(val: T) => val;
 export const toMegabyte = (byte: number) => byte / 1024 / 1024;
+export const isFunction = <T>(param?: T): param is NonNullable<T> => typeof param === 'function';
+export const SBErrorCode = {
+  NON_AUTHORIZED: 400108,
+};
+export const SBErrorMessage = {
+  ACL:
+    "An error occurred because you don't have access to the user list in your application.\n" +
+    'In order to gain access, you can turn on this attribute in the Access Control List settings on Sendbird Dashboard.',
+};
 
 export type {
   FilterByValueType,