@apollo/client 4.0.0-alpha.4 → 4.0.0-alpha.6

package/core/QueryManager.d.ts

@@ -9,7 +9,7 @@ import type { DefaultOptions } from "./ApolloClient.js";
 import type { LocalState } from "./LocalState.js";
 import { NetworkStatus } from "./networkStatus.js";
 import { ObservableQuery } from "./ObservableQuery.js";
-import type { ApolloQueryResult, DefaultContext, InternalRefetchQueriesInclude, InternalRefetchQueriesMap, InternalRefetchQueriesOptions, MutationUpdaterFunction, OnQueryUpdated, OperationVariables } from "./types.js";
+import type { ApolloQueryResult, DefaultContext, InternalRefetchQueriesInclude, InternalRefetchQueriesMap, InternalRefetchQueriesOptions, MutateResult, MutationUpdaterFunction, OnQueryUpdated, OperationVariables, QueryResult, SubscribeResult } from "./types.js";
 import type { ErrorPolicy, MutationFetchPolicy, MutationOptions, QueryOptions, SubscriptionOptions, WatchQueryFetchPolicy, WatchQueryOptions } from "./watchQueryOptions.js";
 interface MutationStoreValue {
     mutation: DocumentNode;
@@ -89,7 +89,7 @@ export declare class QueryManager {
      */
     stop(): void;
     private cancelPendingFetches;
-    mutate<TData, TVariables extends OperationVariables, TContext extends Record<string, any>, TCache extends ApolloCache>({ mutation, variables, optimisticResponse, updateQueries, refetchQueries, awaitRefetchQueries, update: updateWithProxyFn, onQueryUpdated, fetchPolicy, errorPolicy, keepRootFields, context, }: MutationOptions<TData, TVariables, TContext>): Promise<FetchResult<MaybeMasked<TData>>>;
+    mutate<TData, TVariables extends OperationVariables, TContext extends Record<string, any>, TCache extends ApolloCache>({ mutation, variables, optimisticResponse, updateQueries, refetchQueries, awaitRefetchQueries, update: updateWithProxyFn, onQueryUpdated, fetchPolicy, errorPolicy, keepRootFields, context, }: MutationOptions<TData, TVariables, TContext>): Promise<MutateResult<MaybeMasked<TData>>>;
     markMutationResult<TData, TVariables extends OperationVariables, TContext, TCache extends ApolloCache>(mutation: {
         mutationId: string;
         result: FetchResult<TData>;
@@ -117,13 +117,13 @@ export declare class QueryManager {
         update?: MutationUpdaterFunction<TData, TVariables, TContext, TCache>;
         keepRootFields?: boolean;
     }): boolean;
-    fetchQuery<TData, TVars extends OperationVariables>(queryId: string, options: WatchQueryOptions<TVars, TData>, networkStatus?: NetworkStatus): Promise<ApolloQueryResult<TData>>;
+    fetchQuery<TData, TVars extends OperationVariables>(queryId: string, options: WatchQueryOptions<TVars, TData>, networkStatus?: NetworkStatus): Promise<QueryResult<TData>>;
     transform(document: DocumentNode): DocumentNode;
     private transformCache;
     getDocumentInfo(document: DocumentNode): TransformCacheEntry;
     private getVariables;
     watchQuery<T, TVariables extends OperationVariables = OperationVariables>(options: WatchQueryOptions<TVariables, T>): ObservableQuery<T, TVariables>;
-    query<TData, TVars extends OperationVariables = OperationVariables>(options: QueryOptions<TVars, TData>, queryId?: string): Promise<ApolloQueryResult<MaybeMasked<TData>>>;
+    query<TData, TVars extends OperationVariables = OperationVariables>(options: QueryOptions<TVars, TData>, queryId?: string): Promise<QueryResult<MaybeMasked<TData>>>;
     private queryIdCounter;
     generateQueryId(): string;
     private requestIdCounter;
@@ -132,9 +132,9 @@ export declare class QueryManager {
     generateMutationId(): string;
     clearStore(options?: Cache.ResetOptions): Promise<void>;
     getObservableQueries(include?: InternalRefetchQueriesInclude): Map<string, ObservableQuery<any, OperationVariables>>;
-    reFetchObservableQueries(includeStandby?: boolean): Promise<ApolloQueryResult<any>[]>;
+    reFetchObservableQueries(includeStandby?: boolean): Promise<QueryResult<any>[]>;
     setObservableQuery(observableQuery: ObservableQuery<any, any>): void;
-    startGraphQLSubscription<TData = unknown>(options: SubscriptionOptions): Observable<FetchResult<TData>>;
+    startGraphQLSubscription<TData = unknown>(options: SubscriptionOptions): Observable<SubscribeResult<TData>>;
     stopQuery(queryId: string): void;
     removeQuery(queryId: string): void;
     broadcastQueries(): void;

package/core/QueryManager.js

@@ -1,5 +1,5 @@
 import { Trie } from "@wry/trie";
-import { catchError, concat, EMPTY, from, lastValueFrom, map, mergeMap, mergeWith, Observable, of, share, shareReplay, Subject, tap, } from "rxjs";
+import { catchError, concat, EMPTY, filter, from, lastValueFrom, map, mergeMap, mergeWith, Observable, of, share, shareReplay, Subject, tap, } from "rxjs";
 import { canonicalStringify } from "@apollo/client/cache";
 import { CombinedGraphQLErrors, graphQLResultHasProtocolErrors, UnconventionalError, } from "@apollo/client/errors";
 import { PROTOCOL_ERRORS_SYMBOL } from "@apollo/client/errors";
@@ -11,7 +11,7 @@ import { addNonReactiveToNamedFragments, hasDirectives, isExecutionPatchIncremen
 import { DocumentTransform, getDefaultValues, getGraphQLErrorsFromResult, getOperationDefinition, getOperationName, graphQLResultHasError, hasClientExports, isDocumentNode, isNonEmptyArray, isNonNullObject, makeUniqueId, } from "@apollo/client/utilities";
 import { mergeIncrementalData } from "@apollo/client/utilities";
 import { __DEV__ } from "@apollo/client/utilities/environment";
-import { onAnyEvent } from "@apollo/client/utilities/internal";
+import { onAnyEvent, toQueryResult } from "@apollo/client/utilities/internal";
 import { invariant, newInvariantError, } from "@apollo/client/utilities/invariant";
 import { isNetworkRequestInFlight, NetworkStatus } from "./networkStatus.js";
 import { logMissingFieldErrors, ObservableQuery } from "./ObservableQuery.js";
@@ -88,15 +88,15 @@ export class QueryManager {
         this.queries.forEach((_info, queryId) => {
             this.removeQuery(queryId);
         });
-        this.cancelPendingFetches(newInvariantError(72));
+        this.cancelPendingFetches(newInvariantError(74));
     }
     cancelPendingFetches(error) {
         this.fetchCancelFns.forEach((cancel) => cancel(error));
         this.fetchCancelFns.clear();
     }
     async mutate({ mutation, variables, optimisticResponse, updateQueries, refetchQueries = [], awaitRefetchQueries = false, update: updateWithProxyFn, onQueryUpdated, fetchPolicy = this.defaultOptions.mutate?.fetchPolicy || "network-only", errorPolicy = this.defaultOptions.mutate?.errorPolicy || "none", keepRootFields, context, }) {
-        invariant(mutation, 73);
-        invariant(fetchPolicy === "network-only" || fetchPolicy === "no-cache", 74);
+        invariant(mutation, 75);
+        invariant(fetchPolicy === "network-only" || fetchPolicy === "no-cache", 76);
         const mutationId = this.generateMutationId();
         mutation = this.cache.transformForLink(this.transform(mutation));
         const { hasClientExports } = this.getDocumentInfo(mutation);
@@ -129,9 +129,10 @@ export class QueryManager {
                 ...context,
                 optimisticResponse: isOptimistic ? optimisticResponse : void 0,
             }, variables, {}, false)
-                .pipe(mergeMap((result) => {
-                if (graphQLResultHasError(result) && errorPolicy === "none") {
-                    throw new CombinedGraphQLErrors(getGraphQLErrorsFromResult(result));
+                .pipe(validateDidEmitValue(), mergeMap((result) => {
+                const hasErrors = graphQLResultHasError(result);
+                if (hasErrors && errorPolicy === "none") {
+                    throw new CombinedGraphQLErrors(result);
                 }
                 if (mutationStoreValue) {
                     mutationStoreValue.loading = false;
@@ -141,8 +142,7 @@ export class QueryManager {
                 if (typeof refetchQueries === "function") {
                     refetchQueries = refetchQueries(storeResult);
                 }
-                if (errorPolicy === "ignore" &&
-                    graphQLResultHasError(storeResult)) {
+                if (errorPolicy === "ignore" && hasErrors) {
                     delete storeResult.errors;
                 }
                 return from(this.markMutationResult({
@@ -171,28 +171,40 @@ export class QueryManager {
                     // ExecutionPatchResult has arrived and we have assembled the
                     // multipart response into a single result.
                     if (!("hasNext" in storeResult) || storeResult.hasNext === false) {
-                        resolve({
-                            ...storeResult,
+                        const result = {
                             data: this.maskOperation({
                                 document: mutation,
                                 data: storeResult.data,
                                 fetchPolicy,
                                 id: mutationId,
                             }),
-                        });
+                        };
+                        if (graphQLResultHasError(storeResult)) {
+                            result.error = new CombinedGraphQLErrors(storeResult);
+                        }
+                        if (storeResult.extensions) {
+                            result.extensions = storeResult.extensions;
+                        }
+                        resolve(result);
                     }
                 },
                 error: (err) => {
-                    err = maybeWrapError(err);
+                    const error = maybeWrapError(err);
                     if (mutationStoreValue) {
                         mutationStoreValue.loading = false;
-                        mutationStoreValue.error = err;
+                        mutationStoreValue.error = error;
                     }
                     if (isOptimistic) {
                         this.cache.removeOptimistic(mutationId);
                     }
                     this.broadcastQueries();
-                    reject(err);
+                    if (errorPolicy === "ignore") {
+                        return resolve({ data: undefined });
+                    }
+                    if (errorPolicy === "all") {
+                        return resolve({ data: undefined, error });
+                    }
+                    reject(error);
                 },
             });
         });
@@ -382,7 +394,11 @@ export class QueryManager {
         return true;
     }
     fetchQuery(queryId, options, networkStatus) {
-        return lastValueFrom(this.fetchObservableWithInfo(queryId, options, networkStatus).observable, { defaultValue: undefined });
+        return lastValueFrom(this.fetchObservableWithInfo(queryId, options, networkStatus).observable.pipe(map(toQueryResult)), {
+            // This default is needed when a `standby` fetch policy is used to avoid
+            // an EmptyError from rejecting this promise.
+            defaultValue: { data: undefined },
+        });
     }
     transform(document) {
         return this.documentTransform.transformDocument(document);
@@ -462,24 +478,18 @@ export class QueryManager {
         });
         return observable;
     }
-    // TODO: catch `EmptyError` and rethrow as network error if `complete`
-    // notification is emitted without a value.
     query(options, queryId = this.generateQueryId()) {
-        invariant(options.query, 75);
-        invariant(options.query.kind === "Document", 76);
-        invariant(!options.returnPartialData, 77);
-        invariant(!options.pollInterval, 78);
         const query = this.transform(options.query);
         return this.fetchQuery(queryId, { ...options, query })
-            .then((result) => result && {
-            ...result,
+            .then((value) => ({
+            ...value,
             data: this.maskOperation({
                 document: query,
-                data: result.data,
+                data: value?.data,
                 fetchPolicy: options.fetchPolicy,
                 id: queryId,
             }),
-        })
+        }))
             .finally(() => this.stopQuery(queryId));
     }
     queryIdCounter = 1;
@@ -502,7 +512,7 @@ export class QueryManager {
         // depend on values that previously existed in the data portion of the
         // store. So, we cancel the promises and observers that we have issued
         // so far and not yet resolved (in the case of queries).
-        this.cancelPendingFetches(newInvariantError(79));
+        this.cancelPendingFetches(newInvariantError(77));
         this.queries.forEach((queryInfo) => {
             if (queryInfo.observableQuery) {
                 // Set loading to true so listeners don't trigger unless they want
@@ -590,10 +600,10 @@ export class QueryManager {
                 if (!included) {
                     const queryName = queryNames.get(nameOrQueryString);
                     if (queryName) {
-                        __DEV__ && invariant.warn(80, queryName);
+                        __DEV__ && invariant.warn(78, queryName);
                     }
                     else {
-                        __DEV__ && invariant.warn(81);
+                        __DEV__ && invariant.warn(79);
                     }
                 }
             });
@@ -622,38 +632,48 @@ export class QueryManager {
         const { fetchPolicy, errorPolicy = "none", context = {}, extensions = {}, } = options;
         query = this.transform(query);
         variables = this.getVariables(query, variables);
-        const makeObservable = (variables) => this.getObservableFromLink(query, context, variables, extensions).pipe(map((result) => {
+        const makeObservable = (variables) => this.getObservableFromLink(query, context, variables, extensions).pipe(map((rawResult) => {
             if (fetchPolicy !== "no-cache") {
                 // the subscription interface should handle not sending us results we no longer subscribe to.
                 // XXX I don't think we ever send in an object with errors, but we might in the future...
-                if (shouldWriteResult(result, errorPolicy)) {
+                if (shouldWriteResult(rawResult, errorPolicy)) {
                     this.cache.write({
                         query,
-                        result: result.data,
+                        result: rawResult.data,
                         dataId: "ROOT_SUBSCRIPTION",
                         variables: variables,
                     });
                 }
                 this.broadcastQueries();
             }
-            const hasErrors = graphQLResultHasError(result);
-            const hasProtocolErrors = graphQLResultHasProtocolErrors(result);
-            if (hasErrors && errorPolicy === "none") {
-                throw new CombinedGraphQLErrors(result.errors);
+            const result = {
+                data: rawResult.data ?? undefined,
+            };
+            if (graphQLResultHasError(rawResult)) {
+                result.error = new CombinedGraphQLErrors(rawResult);
+            }
+            else if (graphQLResultHasProtocolErrors(rawResult)) {
+                result.error = rawResult.extensions[PROTOCOL_ERRORS_SYMBOL];
+                // Don't emit protocol errors added by HttpLink
+                delete rawResult.extensions[PROTOCOL_ERRORS_SYMBOL];
             }
-            if (hasProtocolErrors) {
-                // `errorPolicy` is a mechanism for handling GraphQL errors, according
-                // to our documentation, so we throw protocol errors regardless of the
-                // set error policy.
-                throw result.extensions[PROTOCOL_ERRORS_SYMBOL];
+            if (rawResult.extensions &&
+                Object.keys(rawResult.extensions).length) {
+                result.extensions = rawResult.extensions;
+            }
+            if (result.error && errorPolicy === "none") {
+                result.data = undefined;
             }
             if (errorPolicy === "ignore") {
-                delete result.errors;
+                delete result.error;
             }
             return result;
         }), catchError((error) => {
-            throw maybeWrapError(error);
-        }));
+            if (errorPolicy === "ignore") {
+                return of({ data: undefined });
+            }
+            return of({ data: undefined, error: maybeWrapError(error) });
+        }), filter((result) => !!(result.data || result.error)));
         if (this.getDocumentInfo(query).hasClientExports) {
             const observablePromise = this.localState
                 .addExportedVariables(query, variables, context)
@@ -766,7 +786,7 @@ export class QueryManager {
                     queryInfo.resetLastWrite();
                     queryInfo.reset();
                     // Throwing here effectively calls observer.error.
-                    throw new CombinedGraphQLErrors(graphQLErrors);
+                    throw new CombinedGraphQLErrors(result);
                 }
                 // Use linkDocument rather than queryInfo.document so the
                 // operation/fragments used to write the result are the same as the
@@ -787,7 +807,7 @@ export class QueryManager {
                 aqr.data = void 0;
             }
             if (hasErrors && errorPolicy !== "ignore") {
-                aqr.error = new CombinedGraphQLErrors(graphQLErrors);
+                aqr.error = new CombinedGraphQLErrors(result);
                 aqr.networkStatus = NetworkStatus.error;
             }
             return aqr;
@@ -1024,7 +1044,7 @@ export class QueryManager {
                 !isFullyUnmaskedOperation(document) &&
                 !this.noCacheWarningsByQueryId.has(operationId)) {
                 this.noCacheWarningsByQueryId.add(operationId);
-                __DEV__ && invariant.warn(82, getOperationName(document) ??
+                __DEV__ && invariant.warn(80, getOperationName(document) ??
                     `Unnamed ${operationType ?? "operation"}`);
             }
         }
@@ -1114,7 +1134,7 @@ export class QueryManager {
             context,
             fetchPolicy,
             errorPolicy,
-        });
+        }).pipe(validateDidEmitValue());
         switch (fetchPolicy) {
             default:
             case "cache-first": {
@@ -1203,4 +1223,15 @@ function maybeWrapError(error) {
     }
     return new UnconventionalError(error);
 }
+function validateDidEmitValue() {
+    let didEmitValue = false;
+    return tap({
+        next() {
+            didEmitValue = true;
+        },
+        complete() {
+            invariant(didEmitValue, 81);
+        },
+    });
+}
 //# sourceMappingURL=QueryManager.js.map