feat(packages/react): support operation name

gqty-dev · Nov 27, 2022 · d46ef12 · d46ef12
1 parent 1fbba64
commit d46ef12
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 2 deletions.
diff --git a/.changeset/purple-mugs-travel.md b/.changeset/purple-mugs-travel.md
@@ -0,0 +1,5 @@
+---
+'@gqty/react': minor
+---
+
+feat(packages/react): support GraphQL operation names
diff --git a/packages/react/src/mutation/useMutation.ts b/packages/react/src/mutation/useMutation.ts
@@ -39,6 +39,8 @@ export interface UseMutationOptions<TData> {
    * @default false
    */
   nonSerializableVariables?: boolean;
+  /** Optional operation name for this mutation request. */
+  operationName?: string;
 }
 
 export interface UseMutationState<TData> {
@@ -215,6 +217,7 @@ export function createUseMutation<
           noCache: optsRef.current.noCache,
           refetch: true,
           nonSerializableVariables: optsRef.current.nonSerializableVariables,
+          operationName: optsRef.current.operationName,
         }).then(
           async (data) => {
             const refetchingQueries = callRefetchQueries();

diff --git a/packages/react/src/query/useQuery.ts b/packages/react/src/query/useQuery.ts
@@ -24,6 +24,7 @@ export interface UseQueryOptions<
   suspense?: boolean;
   staleWhileRevalidate?: boolean | object | number | string | null;
   onError?: OnErrorHandler;
+  operationName?: string;
   prepare?: (helpers: UseQueryPrepareHelpers<GeneratedSchema>) => void;
 }
 
@@ -80,6 +81,7 @@ export function createUseQuery<
     staleWhileRevalidate = defaultStaleWhileRevalidate,
     onError,
     prepare,
+    operationName,
   }: UseQueryOptions<GeneratedSchema> = {}): UseQueryReturnValue<GeneratedSchema> {
     const [$state] = React.useState<Writeable<UseQueryState>>(() => {
       const state: Writeable<UseQueryState> = {
@@ -101,6 +103,18 @@ export function createUseQuery<
       updateOnFetchPromise: true,
     });
 
+    const removeOperationNameInterceptor = React.useMemo(() => {
+      const interceptor = interceptorManager.createInterceptor();
+
+      interceptor.selectionAddListeners.add((selection) => {
+        selection.operationName = operationName;
+      });
+
+      return () => {
+        interceptorManager.removeInterceptor(interceptor);
+      };
+    }, [operationName]);
+
     if (prepare) {
       try {
         prepare(prepareHelpers);
@@ -112,6 +126,8 @@ export function createUseQuery<
       }
     }
 
+    useIsomorphicLayoutEffect(removeOperationNameInterceptor);
+
     useIsomorphicLayoutEffect(() => {
       return scheduler.errors.subscribeErrors((ev) => {
         switch (ev.type) {

diff --git a/packages/react/src/subscription/useSubscription.ts b/packages/react/src/subscription/useSubscription.ts
@@ -13,7 +13,11 @@ export interface UseSubscription<
     subscription: object;
   }
 > {
-  (): GeneratedSchema['subscription'];
+  (opts?: UseSubscriptionOptions): GeneratedSchema['subscription'];
+}
+
+export interface UseSubscriptionOptions {
+  operationName?: string;
 }
 
 export function createUseSubscription<
@@ -36,7 +40,7 @@ export function createUseSubscription<
     client.subscription;
 
   const useSubscription: UseSubscription<GeneratedSchema> =
-    function useSubscription() {
+    function useSubscription(opts?: UseSubscriptionOptions) {
       const forceUpdate = useForceUpdate({
         doTimeout: true,
       });
@@ -46,6 +50,10 @@ export function createUseSubscription<
 
       Promise.resolve(interceptor).then(removeInterceptor);
 
+      interceptor.selectionAddListeners.add((selection) => {
+        selection.operationName = opts?.operationName;
+      });
+
       interceptor.selectionAddListeners.add((selection) => {
         if (selection.type === 2) hookSelections.add(selection);
       });

diff --git a/packages/react/test/useQuery.test.tsx b/packages/react/test/useQuery.test.tsx
@@ -44,3 +44,27 @@ test('Basic Suspense', async () => {
 
   expect(result.current).toBe('hello world');
 });
+
+it.only('should fetches with operation name', async () => {
+  let fetchedQuery: string | undefined;
+  const { useQuery } = await createReactTestClient(undefined, (query) => {
+    fetchedQuery = query;
+    return { data: { hello: 'hello world' } };
+  });
+
+  const { result, waitForNextUpdate } = renderHook(() => {
+    const query = useQuery({
+      operationName: 'TestQuery',
+      suspense: true,
+    });
+
+    return query.hello;
+  });
+
+  expect(result.current).toBe(undefined);
+
+  await waitForNextUpdate();
+
+  expect(fetchedQuery).toBe('query TestQuery{hello}');
+  expect(result.current).toBe('hello world');
+});