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.

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

Conversation

jerelmiller
Copy link
Member

According to the multipart HTTP subscription protocol, fatal tranport errors follow the GraphQL error format which require extensions to be a map as its value instead of an array. This PR fixes this by using GraphQLFormattedError as its type.

Copy link

changeset-bot bot commented Jan 29, 2025

🦋 Changeset detected

Latest commit: c300e0d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@apollo/client Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@svc-apollo-docs
Copy link

svc-apollo-docs commented Jan 29, 2025

✅ Docs preview has no changes

The preview was not built because there were no changes.

Build ID: 3c41a81872723f523097e726

Copy link

pkg-pr-new bot commented Jan 29, 2025

npm i https://pkg.pr.new/@apollo/client@12321

commit: c300e0d

Copy link

netlify bot commented Jan 29, 2025

Deploy Preview for apollo-client-docs ready!

Name Link
🔨 Latest commit c300e0d
🔍 Latest deploy log https://app.netlify.com/sites/apollo-client-docs/deploys/679ba7bd922a780008b833a9
😎 Deploy Preview https://deploy-preview-12321--apollo-client-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

github-actions bot commented Jan 29, 2025

size-limit report 📦

Path Size
dist/apollo-client.min.cjs 40.67 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" 50.08 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production) 47.19 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" 36.18 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production) 33.58 KB (0%)
import { ApolloProvider } from "dist/react/index.js" 1.26 KB (0%)
import { ApolloProvider } from "dist/react/index.js" (production) 1.24 KB (0%)
import { useQuery } from "dist/react/index.js" 5.21 KB (0%)
import { useQuery } from "dist/react/index.js" (production) 4.29 KB (0%)
import { useLazyQuery } from "dist/react/index.js" 5.7 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production) 4.78 KB (0%)
import { useMutation } from "dist/react/index.js" 3.62 KB (0%)
import { useMutation } from "dist/react/index.js" (production) 2.84 KB (0%)
import { useSubscription } from "dist/react/index.js" 4.42 KB (0%)
import { useSubscription } from "dist/react/index.js" (production) 3.48 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" 5.51 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" (production) 4.17 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" 5.01 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" (production) 3.66 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" 5.09 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" (production) 3.74 KB (0%)
import { useReadQuery } from "dist/react/index.js" 3.41 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production) 3.35 KB (0%)
import { useFragment } from "dist/react/index.js" 2.36 KB (0%)
import { useFragment } from "dist/react/index.js" (production) 2.31 KB (0%)

message: string;
extensions?: GraphQLErrorExtensions[];
}>;
public protocolErrors: ReadonlyArray<GraphQLFormattedError>;
Copy link
Member Author

@jerelmiller jerelmiller Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The multipart spec mentions that these errors will "never include locations or path". I believe this is why this custom object was used here.

Do we want to use Omit<GraphQLFormattedError, 'location' | 'path'> (or some variant of this) to convey that, or leave this as-is? FWIW, GraphQLFormattedError marks these fields as optional anyways.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's leave it as it is for consistency, as you say they are optional.

@jerelmiller jerelmiller force-pushed the jerel/fix-protocol-errors-type branch from e88e841 to 789cabf Compare January 29, 2025 19:08
Copy link
Member

@phryneas phryneas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks reasonable to me. Good catch!

@github-actions github-actions bot added the auto-cleanup 🤖 label Jan 30, 2025
@jerelmiller jerelmiller merged commit daa4f33 into main Jan 30, 2025
46 checks passed
@jerelmiller jerelmiller deleted the jerel/fix-protocol-errors-type branch January 30, 2025 16:33
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants