Remove optimistic layer at same time as final mutation update.

apollographql · May 12, 2021 · 8bba37f · 8bba37f
1 parent a205504
commit 8bba37f
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/src/cache/core/cache.ts b/src/cache/core/cache.ts
@@ -23,6 +23,8 @@ export type BatchOptions<C extends ApolloCache<any>> = {
   // the same as passing null.
   optimistic: string | boolean;
 
+  removeOptimistic?: string;
+
   // If you want to find out which watched queries were invalidated during
   // this batch operation, pass this optional callback function. Returning
   // false from the callback will prevent broadcasting this result.

diff --git a/src/cache/inmemory/inMemoryCache.ts b/src/cache/inmemory/inMemoryCache.ts
@@ -339,6 +339,7 @@ export class InMemoryCache extends ApolloCache<NormalizedCacheObject> {
     const {
       transaction,
       optimistic = true,
+      removeOptimistic,
     } = options;
 
     const perform = (layer?: EntityStore) => {
@@ -397,6 +398,10 @@ export class InMemoryCache extends ApolloCache<NormalizedCacheObject> {
       perform();
     }
 
+    if (typeof removeOptimistic === "string") {
+      this.optimisticData = this.optimisticData.removeLayer(removeOptimistic);
+    }
+
     // Note: if this.txCount > 0, then alreadyDirty.size === 0, so this code
     // takes the else branch and calls this.broadcastWatches(options), which
     // does nothing when this.txCount > 0.

diff --git a/src/core/QueryManager.ts b/src/core/QueryManager.ts
@@ -232,6 +232,7 @@ export class QueryManager<TStore> {
                 result,
                 document: mutation,
                 variables,
+                removeOptimistic: !!optimisticResponse,
                 errorPolicy,
                 context,
                 updateQueries,
@@ -311,6 +312,7 @@ export class QueryManager<TStore> {
       context?: TContext;
       updateQueries: UpdateQueries<TData>;
       update?: MutationUpdaterFunction<TData, TVariables, TContext, TCache>;
+      removeOptimistic: boolean;
       onQueryUpdated?: OnQueryUpdated;
     },
     cache = this.cache,
@@ -382,6 +384,10 @@ export class QueryManager<TStore> {
         // Write the final mutation.result to the root layer of the cache.
         optimistic: false,
 
+        removeOptimistic: mutation.removeOptimistic
+          ? mutation.mutationId
+          : void 0,
+
         onWatchUpdated: mutation.onQueryUpdated && ((watch, diff) => {
           if (watch.watcher instanceof QueryInfo) {
             const oq = watch.watcher.observableQuery;
@@ -420,6 +426,7 @@ export class QueryManager<TStore> {
       try {
         this.markMutationResult<TData, TVariables, TContext, TCache>({
           ...mutation,
+          removeOptimistic: false,
           result: { data },
         }, cache);
       } catch (error) {