Merge pull request #1450 from ably/react-callbacks-error-message

fix: throw descriptive error when callbacks used with react
ably · Sep 25, 2023 · fbcd191 · fbcd191
2 parents ec653f1 + 9181064
commit fbcd191
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/src/platform/react-hooks/src/AblyProvider.tsx b/src/platform/react-hooks/src/AblyProvider.tsx
@@ -35,6 +35,10 @@ export const AblyProvider = ({ client, children, id = 'default' }: AblyProviderP
     throw new Error('AblyProvider: the `client` prop is required');
   }
 
+  if (!(client instanceof Ably.Realtime) && !client?.options?.promises) {
+    throw new Error('AblyProvider: the `client` prop must take an instance of Ably.Realtime.Promise');
+  }
+
   const realtime = useMemo(() => client, [client]);
 
   let context = getContext(id);

diff --git a/src/platform/react-hooks/src/fakes/ably.ts b/src/platform/react-hooks/src/fakes/ably.ts
@@ -4,6 +4,7 @@ export class FakeAblySdk {
   public clientId: string;
   public channels: ClientChannelsCollection;
   public connection: Connection;
+  public options = { promises: true };
 
   constructor() {
     this.clientId = Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);