Skip to content

Commit 5793301

Browse files
phryneasphryneas
authored
Change usages of the GraphQLError type to GraphQLFormattedError. (#11789)
* post-process errors received from responses into GraphQLError instances * adjust types, add test * fixing more types * Clean up Prettier, Size-limit, and Api-Extractor * remove runtime components * add eslint rule * Clean up Prettier, Size-limit, and Api-Extractor * adjust some more * adjustments * change patch level --------- Co-authored-by: phryneas <[email protected]>
1 parent 1b23337 commit 5793301

39 files changed

+442
-345
lines changed

‎.api-reports/api-report-core.api.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ import { disableExperimentalFragmentVariables } from 'graphql-tag';
99
import { disableFragmentWarnings } from 'graphql-tag';
1010
import type { DocumentNode } from 'graphql';
1111
import { enableExperimentalFragmentVariables } from 'graphql-tag';
12-
import type { ExecutionResult } from 'graphql';
1312
import type { FieldNode } from 'graphql';
13+
import type { FormattedExecutionResult } from 'graphql';
1414
import type { FragmentDefinitionNode } from 'graphql';
1515
import { gql } from 'graphql-tag';
16-
import type { GraphQLError } from 'graphql';
1716
import type { GraphQLErrorExtensions } from 'graphql';
17+
import type { GraphQLFormattedError } from 'graphql';
1818
import type { InlineFragmentNode } from 'graphql';
1919
import { InvariantError } from 'ts-invariant';
2020
import { Observable } from 'zen-observable-ts';
@@ -94,7 +94,7 @@ export class ApolloClient<TCacheShape> implements DataProxy {
9494
__actionHookForDevTools(cb: () => any): void;
9595
constructor(options: ApolloClientOptions<TCacheShape>);
9696
// (undocumented)
97-
__requestRaw(payload: GraphQLRequest): Observable<ExecutionResult>;
97+
__requestRaw(payload: GraphQLRequest): Observable<FormattedExecutionResult>;
9898
addResolvers(resolvers: Resolvers | Resolvers[]): void;
9999
// (undocumented)
100100
cache: ApolloCache<TCacheShape>;
@@ -179,17 +179,15 @@ export class ApolloError extends Error {
179179
// Warning: (ae-forgotten-export) The symbol "ApolloErrorOptions" needs to be exported by the entry point index.d.ts
180180
constructor({ graphQLErrors, protocolErrors, clientErrors, networkError, errorMessage, extraInfo, }: ApolloErrorOptions);
181181
cause: ({
182-
message: string;
183-
extensions?: GraphQLErrorExtensions[];
184-
} & Partial<Error>) | null;
182+
readonly message: string;
183+
extensions?: GraphQLErrorExtensions[] | GraphQLFormattedError["extensions"];
184+
} & Omit<Partial<Error> & Partial<GraphQLFormattedError>, "extensions">) | null;
185185
// (undocumented)
186186
clientErrors: ReadonlyArray<Error>;
187187
// (undocumented)
188188
extraInfo: any;
189-
// Warning: (ae-forgotten-export) The symbol "GraphQLErrors" needs to be exported by the entry point index.d.ts
190-
//
191189
// (undocumented)
192-
graphQLErrors: GraphQLErrors;
190+
graphQLErrors: ReadonlyArray<GraphQLFormattedError>;
193191
// (undocumented)
194192
message: string;
195193
// (undocumented)
@@ -212,7 +210,7 @@ interface ApolloErrorOptions {
212210
// (undocumented)
213211
extraInfo?: any;
214212
// (undocumented)
215-
graphQLErrors?: ReadonlyArray<GraphQLError>;
213+
graphQLErrors?: ReadonlyArray<GraphQLFormattedError>;
216214
// (undocumented)
217215
networkError?: Error | ServerParseError | ServerError | null;
218216
// (undocumented)
@@ -266,7 +264,7 @@ export interface ApolloQueryResult<T> {
266264
// (undocumented)
267265
data: T;
268266
error?: ApolloError;
269-
errors?: ReadonlyArray<GraphQLError>;
267+
errors?: ReadonlyArray<GraphQLFormattedError>;
270268
// (undocumented)
271269
loading: boolean;
272270
// (undocumented)
@@ -776,7 +774,7 @@ export interface ExecutionPatchInitialResult<TData = Record<string, any>, TExten
776774
// (undocumented)
777775
data: TData | null | undefined;
778776
// (undocumented)
779-
errors?: ReadonlyArray<GraphQLError>;
777+
errors?: ReadonlyArray<GraphQLFormattedError>;
780778
// (undocumented)
781779
extensions?: TExtensions;
782780
// (undocumented)
@@ -993,9 +991,6 @@ const getInMemoryCacheMemoryInternals: (() => {
993991

994992
export { gql }
995993

996-
// @public (undocumented)
997-
type GraphQLErrors = ReadonlyArray<GraphQLError>;
998-
999994
// @public (undocumented)
1000995
export interface GraphQLRequest<TVariables = Record<string, any>> {
1001996
// (undocumented)
@@ -1080,7 +1075,7 @@ export interface IncrementalPayload<TData, TExtensions> {
10801075
// (undocumented)
10811076
data: TData | null;
10821077
// (undocumented)
1083-
errors?: ReadonlyArray<GraphQLError>;
1078+
errors?: ReadonlyArray<GraphQLFormattedError>;
10841079
// (undocumented)
10851080
extensions?: TExtensions;
10861081
// (undocumented)
@@ -1712,7 +1707,7 @@ class QueryInfo {
17121707
// (undocumented)
17131708
getDiff(): Cache_2.DiffResult<any>;
17141709
// (undocumented)
1715-
graphQLErrors?: ReadonlyArray<GraphQLError>;
1710+
graphQLErrors?: ReadonlyArray<GraphQLFormattedError>;
17161711
// (undocumented)
17171712
init(query: {
17181713
document: DocumentNode;
@@ -2089,11 +2084,15 @@ interface SharedWatchQueryOptions<TVariables extends OperationVariables, TData>
20892084
}
20902085

20912086
// @public (undocumented)
2092-
export interface SingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> extends ExecutionResult<TData, TExtensions> {
2087+
export interface SingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> {
20932088
// (undocumented)
20942089
context?: TContext;
20952090
// (undocumented)
20962091
data?: TData | null;
2092+
// (undocumented)
2093+
errors?: ReadonlyArray<GraphQLFormattedError>;
2094+
// (undocumented)
2095+
extensions?: TExtensions;
20972096
}
20982097

20992098
// @public (undocumented)

‎.api-reports/api-report-errors.api.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,23 @@
44
55
```ts
66

7-
import type { ExecutionResult } from 'graphql';
87
import type { GraphQLError } from 'graphql';
98
import type { GraphQLErrorExtensions } from 'graphql';
9+
import type { GraphQLFormattedError } from 'graphql';
1010

1111
// @public (undocumented)
1212
export class ApolloError extends Error {
1313
constructor({ graphQLErrors, protocolErrors, clientErrors, networkError, errorMessage, extraInfo, }: ApolloErrorOptions);
1414
cause: ({
15-
message: string;
16-
extensions?: GraphQLErrorExtensions[];
17-
} & Partial<Error>) | null;
15+
readonly message: string;
16+
extensions?: GraphQLErrorExtensions[] | GraphQLFormattedError["extensions"];
17+
} & Omit<Partial<Error> & Partial<GraphQLFormattedError>, "extensions">) | null;
1818
// (undocumented)
1919
clientErrors: ReadonlyArray<Error>;
2020
// (undocumented)
2121
extraInfo: any;
2222
// (undocumented)
23-
graphQLErrors: GraphQLErrors;
23+
graphQLErrors: ReadonlyArray<GraphQLFormattedError>;
2424
// (undocumented)
2525
message: string;
2626
// (undocumented)
@@ -46,7 +46,7 @@ export interface ApolloErrorOptions {
4646
// (undocumented)
4747
extraInfo?: any;
4848
// (undocumented)
49-
graphQLErrors?: ReadonlyArray<GraphQLError>;
49+
graphQLErrors?: ReadonlyArray<GraphQLFormattedError>;
5050
// (undocumented)
5151
networkError?: Error | ServerParseError | ServerError | null;
5252
// (undocumented)
@@ -81,7 +81,7 @@ interface ExecutionPatchInitialResult<TData = Record<string, any>, TExtensions =
8181
// (undocumented)
8282
data: TData | null | undefined;
8383
// (undocumented)
84-
errors?: ReadonlyArray<GraphQLError>;
84+
errors?: ReadonlyArray<GraphQLFormattedError>;
8585
// (undocumented)
8686
extensions?: TExtensions;
8787
// (undocumented)
@@ -113,7 +113,7 @@ type FetchResultWithSymbolExtensions<T> = FetchResult<T> & {
113113
extensions: Record<string | symbol, any>;
114114
};
115115

116-
// @public (undocumented)
116+
// @public @deprecated (undocumented)
117117
export type GraphQLErrors = ReadonlyArray<GraphQLError>;
118118

119119
// Warning: (ae-forgotten-export) The symbol "FetchResultWithSymbolExtensions" needs to be exported by the entry point index.d.ts
@@ -126,7 +126,7 @@ interface IncrementalPayload<TData, TExtensions> {
126126
// (undocumented)
127127
data: TData | null;
128128
// (undocumented)
129-
errors?: ReadonlyArray<GraphQLError>;
129+
errors?: ReadonlyArray<GraphQLFormattedError>;
130130
// (undocumented)
131131
extensions?: TExtensions;
132132
// (undocumented)
@@ -166,11 +166,15 @@ type ServerParseError = Error & {
166166
// Warning: (ae-forgotten-export) The symbol "DefaultContext" needs to be exported by the entry point index.d.ts
167167
//
168168
// @public (undocumented)
169-
interface SingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> extends ExecutionResult<TData, TExtensions> {
169+
interface SingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> {
170170
// (undocumented)
171171
context?: TContext;
172172
// (undocumented)
173173
data?: TData | null;
174+
// (undocumented)
175+
errors?: ReadonlyArray<GraphQLFormattedError>;
176+
// (undocumented)
177+
extensions?: TExtensions;
174178
}
175179

176180
// (No @packageDocumentation comment for this package)

‎.api-reports/api-report-link_batch-http.api.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66

77
import type { ASTNode } from 'graphql';
88
import type { DocumentNode } from 'graphql';
9-
import type { ExecutionResult } from 'graphql';
10-
import type { GraphQLError } from 'graphql';
9+
import type { GraphQLFormattedError } from 'graphql';
1110
import { Observable } from 'zen-observable-ts';
1211
import type { Observer } from 'zen-observable-ts';
1312

@@ -117,7 +116,7 @@ interface ExecutionPatchInitialResult<TData = Record<string, any>, TExtensions =
117116
// (undocumented)
118117
data: TData | null | undefined;
119118
// (undocumented)
120-
errors?: ReadonlyArray<GraphQLError>;
119+
errors?: ReadonlyArray<GraphQLFormattedError>;
121120
// (undocumented)
122121
extensions?: TExtensions;
123122
// (undocumented)
@@ -179,7 +178,7 @@ interface IncrementalPayload<TData, TExtensions> {
179178
// (undocumented)
180179
data: TData | null;
181180
// (undocumented)
182-
errors?: ReadonlyArray<GraphQLError>;
181+
errors?: ReadonlyArray<GraphQLFormattedError>;
183182
// (undocumented)
184183
extensions?: TExtensions;
185184
// (undocumented)
@@ -232,11 +231,15 @@ interface Printer {
232231
type RequestHandler = (operation: Operation, forward: NextLink) => Observable<FetchResult> | null;
233232

234233
// @public (undocumented)
235-
interface SingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> extends ExecutionResult<TData, TExtensions> {
234+
interface SingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> {
236235
// (undocumented)
237236
context?: TContext;
238237
// (undocumented)
239238
data?: TData | null;
239+
// (undocumented)
240+
errors?: ReadonlyArray<GraphQLFormattedError>;
241+
// (undocumented)
242+
extensions?: TExtensions;
240243
}
241244

242245
// @public (undocumented)

‎.api-reports/api-report-link_batch.api.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@
55
```ts
66

77
import type { DocumentNode } from 'graphql';
8-
import type { ExecutionResult } from 'graphql';
9-
import type { GraphQLError } from 'graphql';
8+
import type { GraphQLFormattedError } from 'graphql';
109
import { Observable } from 'zen-observable-ts';
1110
import type { Observer } from 'zen-observable-ts';
1211

@@ -107,7 +106,7 @@ interface ExecutionPatchInitialResult<TData = Record<string, any>, TExtensions =
107106
// (undocumented)
108107
data: TData | null | undefined;
109108
// (undocumented)
110-
errors?: ReadonlyArray<GraphQLError>;
109+
errors?: ReadonlyArray<GraphQLFormattedError>;
111110
// (undocumented)
112111
extensions?: TExtensions;
113112
// (undocumented)
@@ -153,7 +152,7 @@ interface IncrementalPayload<TData, TExtensions> {
153152
// (undocumented)
154153
data: TData | null;
155154
// (undocumented)
156-
errors?: ReadonlyArray<GraphQLError>;
155+
errors?: ReadonlyArray<GraphQLFormattedError>;
157156
// (undocumented)
158157
extensions?: TExtensions;
159158
// (undocumented)
@@ -208,11 +207,15 @@ type Path = ReadonlyArray<string | number>;
208207
type RequestHandler = (operation: Operation, forward: NextLink) => Observable<FetchResult> | null;
209208

210209
// @public (undocumented)
211-
interface SingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> extends ExecutionResult<TData, TExtensions> {
210+
interface SingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> {
212211
// (undocumented)
213212
context?: TContext;
214213
// (undocumented)
215214
data?: TData | null;
215+
// (undocumented)
216+
errors?: ReadonlyArray<GraphQLFormattedError>;
217+
// (undocumented)
218+
extensions?: TExtensions;
216219
}
217220

218221
// (No @packageDocumentation comment for this package)

‎.api-reports/api-report-link_context.api.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@
55
```ts
66

77
import type { DocumentNode } from 'graphql';
8-
import type { ExecutionResult } from 'graphql';
9-
import type { GraphQLError } from 'graphql';
8+
import type { GraphQLFormattedError } from 'graphql';
109
import { Observable } from 'zen-observable-ts';
1110
import type { Observer } from 'zen-observable-ts';
1211

@@ -80,7 +79,7 @@ interface ExecutionPatchInitialResult<TData = Record<string, any>, TExtensions =
8079
// (undocumented)
8180
data: TData | null | undefined;
8281
// (undocumented)
83-
errors?: ReadonlyArray<GraphQLError>;
82+
errors?: ReadonlyArray<GraphQLFormattedError>;
8483
// (undocumented)
8584
extensions?: TExtensions;
8685
// (undocumented)
@@ -124,7 +123,7 @@ interface IncrementalPayload<TData, TExtensions> {
124123
// (undocumented)
125124
data: TData | null;
126125
// (undocumented)
127-
errors?: ReadonlyArray<GraphQLError>;
126+
errors?: ReadonlyArray<GraphQLFormattedError>;
128127
// (undocumented)
129128
extensions?: TExtensions;
130129
// (undocumented)
@@ -169,11 +168,15 @@ type RequestHandler = (operation: Operation, forward: NextLink) => Observable<Fe
169168
export function setContext(setter: ContextSetter): ApolloLink;
170169

171170
// @public (undocumented)
172-
interface SingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> extends ExecutionResult<TData, TExtensions> {
171+
interface SingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> {
173172
// (undocumented)
174173
context?: TContext;
175174
// (undocumented)
176175
data?: TData | null;
176+
// (undocumented)
177+
errors?: ReadonlyArray<GraphQLFormattedError>;
178+
// (undocumented)
179+
extensions?: TExtensions;
177180
}
178181

179182
// (No @packageDocumentation comment for this package)

‎.api-reports/api-report-link_core.api.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@
55
```ts
66

77
import type { DocumentNode } from 'graphql';
8-
import type { ExecutionResult } from 'graphql';
9-
import type { GraphQLError } from 'graphql';
8+
import type { GraphQLFormattedError } from 'graphql';
109
import { Observable } from 'zen-observable-ts';
1110
import type { Observer } from 'zen-observable-ts';
1211

@@ -83,7 +82,7 @@ export interface ExecutionPatchInitialResult<TData = Record<string, any>, TExten
8382
// (undocumented)
8483
data: TData | null | undefined;
8584
// (undocumented)
86-
errors?: ReadonlyArray<GraphQLError>;
85+
errors?: ReadonlyArray<GraphQLFormattedError>;
8786
// (undocumented)
8887
extensions?: TExtensions;
8988
// (undocumented)
@@ -126,7 +125,7 @@ export interface IncrementalPayload<TData, TExtensions> {
126125
// (undocumented)
127126
data: TData | null;
128127
// (undocumented)
129-
errors?: ReadonlyArray<GraphQLError>;
128+
errors?: ReadonlyArray<GraphQLFormattedError>;
130129
// (undocumented)
131130
extensions?: TExtensions;
132131
// (undocumented)
@@ -164,11 +163,15 @@ export type Path = ReadonlyArray<string | number>;
164163
export type RequestHandler = (operation: Operation, forward: NextLink) => Observable<FetchResult> | null;
165164

166165
// @public (undocumented)
167-
export interface SingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> extends ExecutionResult<TData, TExtensions> {
166+
export interface SingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> {
168167
// (undocumented)
169168
context?: TContext;
170169
// (undocumented)
171170
data?: TData | null;
171+
// (undocumented)
172+
errors?: ReadonlyArray<GraphQLFormattedError>;
173+
// (undocumented)
174+
extensions?: TExtensions;
172175
}
173176

174177
// @public (undocumented)

0 commit comments

Comments
 (0)