Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix type of extensions in protocolErrors #12321

Merged
merged 6 commits into from
Jan 30, 2025
Merged

Fix type of extensions in protocolErrors #12321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
371a918
Change type of protocolErrors to GraphQLFormattedError
jerelmiller Jan 29, 2025
616d9bd
Update tests failing due to change in type
jerelmiller Jan 29, 2025
d9a945f
Add changeset
jerelmiller Jan 29, 2025
1ba2988
Fix failing graphqlSubscriptions tests
jerelmiller Jan 29, 2025
789cabf
Update API report
jerelmiller Jan 29, 2025
c300e0d
Merge branch 'main' into jerel/fix-protocol-errors-type
jerelmiller Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions .api-reports/api-report-core.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,10 +200,7 @@ export class ApolloError extends Error {
// (undocumented)
networkError: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand All @@ -219,10 +216,7 @@ interface ApolloErrorOptions {
// (undocumented)
networkError?: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors?: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand Down
10 changes: 2 additions & 8 deletions .api-reports/api-report-errors.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,7 @@ export class ApolloError extends Error {
// (undocumented)
networkError: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand All @@ -50,10 +47,7 @@ export interface ApolloErrorOptions {
// (undocumented)
networkError?: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors?: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand Down
6 changes: 1 addition & 5 deletions .api-reports/api-report-link_error.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@

import type { DocumentNode } from 'graphql';
import type { FormattedExecutionResult } from 'graphql';
import type { GraphQLErrorExtensions } from 'graphql';
import type { GraphQLFormattedError } from 'graphql';
import { Observable } from 'zen-observable-ts';
import type { Observer } from 'zen-observable-ts';
Expand Down Expand Up @@ -86,10 +85,7 @@ export interface ErrorResponse {
networkError?: NetworkError;
// (undocumented)
operation: Operation;
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors?: ReadonlyArray<GraphQLFormattedError>;
// (undocumented)
response?: FormattedExecutionResult;
}
Expand Down
10 changes: 2 additions & 8 deletions .api-reports/api-report-react.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,10 +257,7 @@ class ApolloError extends Error {
// (undocumented)
networkError: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand All @@ -276,10 +273,7 @@ interface ApolloErrorOptions {
// (undocumented)
networkError?: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors?: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand Down
10 changes: 2 additions & 8 deletions .api-reports/api-report-react_components.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,10 +235,7 @@ class ApolloError extends Error {
// (undocumented)
networkError: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand All @@ -254,10 +251,7 @@ interface ApolloErrorOptions {
// (undocumented)
networkError?: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors?: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand Down
10 changes: 2 additions & 8 deletions .api-reports/api-report-react_context.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,10 +255,7 @@ class ApolloError extends Error {
// (undocumented)
networkError: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand All @@ -274,10 +271,7 @@ interface ApolloErrorOptions {
// (undocumented)
networkError?: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors?: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand Down
10 changes: 2 additions & 8 deletions .api-reports/api-report-react_hoc.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,10 +234,7 @@ class ApolloError extends Error {
// (undocumented)
networkError: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand All @@ -253,10 +250,7 @@ interface ApolloErrorOptions {
// (undocumented)
networkError?: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors?: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand Down
10 changes: 2 additions & 8 deletions .api-reports/api-report-react_hooks.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,10 +233,7 @@ class ApolloError extends Error {
// (undocumented)
networkError: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand All @@ -252,10 +249,7 @@ interface ApolloErrorOptions {
// (undocumented)
networkError?: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors?: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand Down
10 changes: 2 additions & 8 deletions .api-reports/api-report-react_internal.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,10 +233,7 @@ class ApolloError extends Error {
// (undocumented)
networkError: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand All @@ -252,10 +249,7 @@ interface ApolloErrorOptions {
// (undocumented)
networkError?: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors?: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand Down
10 changes: 2 additions & 8 deletions .api-reports/api-report-react_ssr.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,10 +234,7 @@ class ApolloError extends Error {
// (undocumented)
networkError: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand All @@ -253,10 +250,7 @@ interface ApolloErrorOptions {
// (undocumented)
networkError?: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors?: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand Down
10 changes: 2 additions & 8 deletions .api-reports/api-report-testing.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,10 +234,7 @@ class ApolloError extends Error {
// (undocumented)
networkError: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand All @@ -253,10 +250,7 @@ interface ApolloErrorOptions {
// (undocumented)
networkError?: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors?: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand Down
10 changes: 2 additions & 8 deletions .api-reports/api-report-testing_core.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,10 +233,7 @@ class ApolloError extends Error {
// (undocumented)
networkError: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand All @@ -252,10 +249,7 @@ interface ApolloErrorOptions {
// (undocumented)
networkError?: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors?: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand Down
10 changes: 2 additions & 8 deletions .api-reports/api-report-utilities.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,10 +248,7 @@ class ApolloError extends Error {
// (undocumented)
networkError: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand All @@ -267,10 +264,7 @@ interface ApolloErrorOptions {
// (undocumented)
networkError?: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors?: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand Down
10 changes: 2 additions & 8 deletions .api-reports/api-report.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,10 +223,7 @@ export class ApolloError extends Error {
// (undocumented)
networkError: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand All @@ -242,10 +239,7 @@ interface ApolloErrorOptions {
// (undocumented)
networkError?: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
protocolErrors?: ReadonlyArray<GraphQLFormattedError>;
}

// @public (undocumented)
Expand Down
5 changes: 5 additions & 0 deletions .changeset/curvy-seahorses-walk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@apollo/client": patch
---

Fix type of `extensions` in `protocolErrors` for `ApolloError` and the `onError` link. According to the [multipart HTTP subscription protocol](https://www.apollographql.com/docs/graphos/routing/operations/subscriptions/multipart-protocol), fatal tranport errors follow the [GraphQL error format](https://spec.graphql.org/draft/#sec-Errors.Error-Result-Format) which require `extensions` to be a map as its value instead of an array.
16 changes: 6 additions & 10 deletions src/__tests__/__snapshots__/graphqlSubscriptions.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,9 @@ ApolloError {
exports[`GraphQL Subscriptions should throw an error if the result has protocolErrors on it 1`] = `
ApolloError {
"cause": Object {
"extensions": Array [
Object {
"code": "WEBSOCKET_MESSAGE_ERROR",
},
],
"extensions": Object {
"code": "WEBSOCKET_MESSAGE_ERROR",
},
"message": "cannot read message from websocket",
},
"clientErrors": Array [],
Expand All @@ -55,11 +53,9 @@ ApolloError {
"networkError": null,
"protocolErrors": Array [
Object {
"extensions": Array [
Object {
"code": "WEBSOCKET_MESSAGE_ERROR",
},
],
"extensions": Object {
"code": "WEBSOCKET_MESSAGE_ERROR",
},
"message": "cannot read message from websocket",
},
],
Expand Down
Loading