Rename mutation reobserveQuery callback to onQueryUpdated.

Previously, options.onDirty (for cache.batch) and options.reobserveQuery
(for mutations) had no obvious relationship, even though one is
implemented in terms of the other.

Now, cache.batch takes an onWatchUpdated callback and mutations take
onQueryUpdated, which I think better represents the similarity (as well as
the crucial difference in argument types) between the callbacks.

Also, the options.onQueryUpdated callback is typically triggered by the
mutation's options.update function, so the "onQueryUpdated" terminology
more accurately reflects the source of the updates.

src/core/QueryManager.ts

@@ -36,7 +36,7 @@ import {
   ApolloQueryResult,
   OperationVariables,
   MutationUpdaterFunction,
-  ReobserveQueryCallback,
+  OnQueryUpdated,
 } from './types';
 import { LocalState } from './LocalState';
 
@@ -139,7 +139,7 @@ export class QueryManager<TStore> {
     refetchQueries = [],
     awaitRefetchQueries = false,
     update: updateWithProxyFn,
-    reobserveQuery,
+    onQueryUpdated,
     errorPolicy = 'none',
     fetchPolicy,
     context,
@@ -236,7 +236,7 @@ export class QueryManager<TStore> {
                 context,
                 updateQueries,
                 update: updateWithProxyFn,
-                reobserveQuery,
+                onQueryUpdated,
               });
             } catch (e) {
               // Likewise, throwing an error from the asyncMap mapping function
@@ -311,7 +311,7 @@ export class QueryManager<TStore> {
       context?: TContext;
       updateQueries: UpdateQueries<TData>;
       update?: MutationUpdaterFunction<TData, TVariables, TContext, TCache>;
-      reobserveQuery?: ReobserveQueryCallback;
+      onQueryUpdated?: OnQueryUpdated;
     },
     cache = this.cache,
   ): Promise<void> {
@@ -382,11 +382,11 @@ export class QueryManager<TStore> {
         // Write the final mutation.result to the root layer of the cache.
         optimistic: false,
 
-        onWatchUpdated: mutation.reobserveQuery && ((watch, diff) => {
+        onWatchUpdated: mutation.onQueryUpdated && ((watch, diff) => {
           if (watch.watcher instanceof QueryInfo) {
             const oq = watch.watcher.observableQuery;
             if (oq) {
-              reobserveResults.push(mutation.reobserveQuery!(oq, diff));
+              reobserveResults.push(mutation.onQueryUpdated!(oq, diff));
               // Prevent the normal cache broadcast of this result.
               return false;
             }

src/core/__tests__/QueryManager/index.ts

@@ -5227,7 +5227,7 @@ describe('QueryManager', () => {
     });
   });
 
-  describe('reobserveQuery', () => {
+  describe('onQueryUpdated', () => {
     const mutation = gql`
       mutation changeAuthorName {
         changeAuthorName(newName: "Jack Smith") {
@@ -5316,7 +5316,7 @@ describe('QueryManager', () => {
               });
             },
 
-            reobserveQuery(obsQuery) {
+            onQueryUpdated(obsQuery) {
               expect(obsQuery.options.query).toBe(query);
               return obsQuery.refetch().then(async () => {
                 // Wait a bit to make sure the mutation really awaited the
@@ -5374,7 +5374,7 @@ describe('QueryManager', () => {
               });
             },
 
-            reobserveQuery(obsQuery) {
+            onQueryUpdated(obsQuery) {
               expect(obsQuery.options.query).toBe(query);
               return obsQuery.refetch();
             },
@@ -5415,7 +5415,7 @@ describe('QueryManager', () => {
               cache.evict({ fieldName: "author" });
             },
 
-            reobserveQuery(obsQuery) {
+            onQueryUpdated(obsQuery) {
               expect(obsQuery.options.query).toBe(query);
               return obsQuery.reobserve({
                 fetchPolicy: "network-only",

src/core/types.ts

@@ -15,7 +15,7 @@ export type DefaultContext = Record<string, any>;
 
 export type QueryListener = (queryInfo: QueryInfo) => void;
 
-export type ReobserveQueryCallback = (
+export type OnQueryUpdated = (
   observableQuery: ObservableQuery,
   diff: Cache.DiffResult<any>,
 ) => void | Promise<any>;

src/core/watchQueryOptions.ts

@@ -8,7 +8,7 @@ import {
   PureQueryOptions,
   OperationVariables,
   MutationUpdaterFunction,
-  ReobserveQueryCallback,
+  OnQueryUpdated,
 } from './types';
 import { ApolloCache } from '../cache';
 
@@ -260,7 +260,7 @@ export interface MutationBaseOptions<
    * A function that will be called for each ObservableQuery affected by
    * this mutation, after the mutation has completed.
    */
-  reobserveQuery?: ReobserveQueryCallback;
+  onQueryUpdated?: OnQueryUpdated;
 
   /**
    * Specifies the {@link ErrorPolicy} to be used for this operation

src/react/hooks/__tests__/useMutation.test.tsx

@@ -747,7 +747,7 @@ describe('useMutation Hook', () => {
   });
 
   describe('refetching queries', () => {
-    itAsync('can pass reobserveQuery to useMutation', (resolve, reject) => {
+    itAsync('can pass onQueryUpdated to useMutation', (resolve, reject) => {
       interface TData {
         todoCount: number;
       }
@@ -791,17 +791,17 @@ describe('useMutation Hook', () => {
         }).setOnError(reject),
       });
 
-      // The goal of this test is to make sure reobserveQuery gets called as
+      // The goal of this test is to make sure onQueryUpdated gets called as
       // part of the createTodo mutation, so we use this reobservePromise to
-      // await the calling of reobserveQuery.
-      interface ReobserveResults {
+      // await the calling of onQueryUpdated.
+      interface OnQueryUpdatedResults {
         obsQuery: ObservableQuery;
         diff: Cache.DiffResult<TData>;
         result: ApolloQueryResult<TData>;
       }
-      let reobserveResolve: (results: ReobserveResults) => any;
-      const reobservePromise = new Promise<ReobserveResults>(resolve => {
-        reobserveResolve = resolve;
+      let resolveOnUpdate: (results: OnQueryUpdatedResults) => any;
+      const onUpdatePromise = new Promise<OnQueryUpdatedResults>(resolve => {
+        resolveOnUpdate = resolve;
       });
       let finishedReobserving = false;
 
@@ -838,10 +838,10 @@ describe('useMutation Hook', () => {
             act(() => {
               createTodo({
                 variables,
-                reobserveQuery(obsQuery, diff) {
+                onQueryUpdated(obsQuery, diff) {
                   return obsQuery.reobserve().then(result => {
                     finishedReobserving = true;
-                    reobserveResolve({ obsQuery, diff, result });
+                    resolveOnUpdate({ obsQuery, diff, result });
                   });
                 },
               });
@@ -888,7 +888,7 @@ describe('useMutation Hook', () => {
         </ApolloProvider>
       );
 
-      return reobservePromise.then(results => {
+      return onUpdatePromise.then(results => {
         expect(finishedReobserving).toBe(true);
 
         expect(results.diff).toEqual({

src/react/types/types.ts

@@ -19,7 +19,7 @@ import {
   ObservableQuery,
   OperationVariables,
   PureQueryOptions,
-  ReobserveQueryCallback,
+  OnQueryUpdated,
   WatchQueryFetchPolicy,
   WatchQueryOptions,
 } from '../../core';
@@ -154,7 +154,7 @@ export interface BaseMutationOptions<
   awaitRefetchQueries?: boolean;
   errorPolicy?: ErrorPolicy;
   update?: MutationUpdaterFunction<TData, TVariables, TContext, TCache>;
-  reobserveQuery?: ReobserveQueryCallback;
+  onQueryUpdated?: OnQueryUpdated;
   client?: ApolloClient<object>;
   notifyOnNetworkStatusChange?: boolean;
   context?: TContext;
@@ -175,7 +175,7 @@ export interface MutationFunctionOptions<
   refetchQueries?: Array<string | PureQueryOptions> | RefetchQueriesFunction;
   awaitRefetchQueries?: boolean;
   update?: MutationUpdaterFunction<TData, TVariables, TContext, TCache>;
-  reobserveQuery?: ReobserveQueryCallback;
+  onQueryUpdated?: OnQueryUpdated;
   context?: TContext;
   fetchPolicy?: WatchQueryFetchPolicy;
 }