feat: add onCompleted callback support for useQuery

.changeset/tricky-walls-exercise.md

@@ -0,0 +1,5 @@
+---
+'@shopify/react-graphql': minor
+---
+
+Add onCompleted callback support for useQuery

packages/react-graphql/src/hooks/query.ts

@@ -48,6 +48,7 @@ export default function useQuery<
     notifyOnNetworkStatusChange,
     context,
     ssr = true,
+    onCompleted,
   } = options;
 
   const variables: Variables = options.variables || ({} as any);
@@ -176,6 +177,11 @@ export default function useQuery<
           ) {
             return;
           }
+
+          if (onCompleted && !status.loading && !status.error) {
+            onCompleted(status.data);
+          }
+
           invalidateCurrentResult();
         },
         (error) => {

packages/react-graphql/src/hooks/tests/query.test.tsx

@@ -95,7 +95,7 @@ describe('useQuery', () => {
       );
     });
 
-    it('return loading=false, networkStatus and the data once the query resolved', async () => {
+    it('returns loading=false, networkStatus and the data once the query resolved', async () => {
       function MockQuery({children}) {
         const results = useQuery(petQuery);
         return children(results);
@@ -120,6 +120,26 @@ describe('useQuery', () => {
       );
     });
 
+    it('calls onCompleted function when the query resolved', async () => {
+      const mockedOnCompleted = jest.fn();
+      function MockQuery({children}) {
+        const results = useQuery(petQuery, {
+          onCompleted: mockedOnCompleted,
+        });
+        return children(results);
+      }
+
+      const graphQL = createGraphQL({PetQuery: mockData});
+      const renderPropSpy = jest.fn(() => null);
+
+      await mountWithGraphQL(<MockQuery>{renderPropSpy}</MockQuery>, {
+        graphQL,
+      });
+
+      expect(mockedOnCompleted).toHaveBeenCalledTimes(1);
+      expect(mockedOnCompleted).toHaveBeenCalledWith(mockData);
+    });
+
     it('keeps the same data when the variables stay deep-equal', async () => {
       function MockQuery({
         children,