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

correctly test for error equality on jest #11937

Merged
merged 8 commits into from
Jul 11, 2024

Conversation

phryneas
Copy link
Member

@phryneas phryneas commented Jul 9, 2024

I noticed this when working on tests for subscription errors - jest is extremely lax when comparing errors:

https://github.com/jestjs/jest/blob/c04d13d7abd22e47b0997f6027886aed225c9ce4/packages/expect-utils/src/jasmineUtils.ts#L91-L94

  if (a instanceof Error && b instanceof Error) {
    return a.message == b.message;
  }

This means that we probably have hundreds of assertions that do nothing and might just as well be wrong.

This was the code I used to make it work correctly to work on that one test - I imagine before we can merge this we'll have to adjust dozens of tests (or fix bugs that have been hidden by this).

Copy link

changeset-bot bot commented Jul 9, 2024

🦋 Changeset detected

Latest commit: 35856d6

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

Copy link
Contributor

github-actions bot commented Jul 9, 2024

size-limit report 📦

Path Size
dist/apollo-client.min.cjs 39.26 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" 48 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production) 45.53 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" 34.38 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production) 32.23 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.24 KB (0%)
import { useQuery } from "dist/react/index.js" (production) 4.31 KB (0%)
import { useLazyQuery } from "dist/react/index.js" 5.71 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production) 4.79 KB (0%)
import { useMutation } from "dist/react/index.js" 3.62 KB (0%)
import { useMutation } from "dist/react/index.js" (production) 2.85 KB (0%)
import { useSubscription } from "dist/react/index.js" 4.42 KB (0%)
import { useSubscription } from "dist/react/index.js" (production) 3.46 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" 5.5 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" (production) 4.16 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" 5 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" (production) 3.65 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" 5.07 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" (production) 3.72 KB (0%)
import { useReadQuery } from "dist/react/index.js" 3.39 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production) 3.34 KB (0%)
import { useFragment } from "dist/react/index.js" 2.32 KB (0%)
import { useFragment } from "dist/react/index.js" (production) 2.27 KB (0%)

Copy link

netlify bot commented Jul 9, 2024

Deploy Preview for apollo-client-docs ready!

Name Link
🔨 Latest commit 35856d6
🔍 Latest deploy log https://app.netlify.com/sites/apollo-client-docs/deploys/668fcb90b0e0c3000762802f
😎 Deploy Preview https://deploy-preview-11937--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.

Comment on lines +9 to +11
+ if (val.name === 'ApolloError' || val.name === 'GraphQLError') {
+ return null
+ }
Copy link
Member Author

Choose a reason for hiding this comment

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

Without this escape hatch, all these errors will only log [ApolloError: message], so we end up with error messages like Got: [ApolloError: message], expected: [ApolloError: message], with no idea on what's actually wrong.

Comment on lines +72 to +74
e instanceof Error ?
GraphQLError.prototype.toJSON.apply(e)
: (e as any),
Copy link
Member Author

Choose a reason for hiding this comment

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

@alessbell this is probably relevant to you - until now, the ApolloError would be wrapped by another ApolloError inside of ObservableQuery. The link chain should return "plain" errors, they get wrapped later.

@@ -1060,15 +1062,14 @@ describe("useMutation Hook", () => {

expect(fetchResult).toEqual({
data: undefined,
// Not sure why we unwrap errors here.
Copy link
Member Author

@phryneas phryneas Jul 10, 2024

Choose a reason for hiding this comment

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

Spoiler: we never did 😅

@phryneas phryneas marked this pull request as ready for review July 10, 2024 13:53
Copy link
Member

@jerelmiller jerelmiller left a comment

Choose a reason for hiding this comment

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

Really great find! Glad this will give us more confidence in our tests.

@phryneas phryneas added the auto-cleanup 🤖 label Jul 11, 2024
@phryneas phryneas merged commit 78332be into release-3.11 Jul 11, 2024
42 checks passed
@phryneas phryneas deleted the pr/correctly-test-errors branch July 11, 2024 12:16
@github-actions github-actions bot mentioned this pull request Jul 11, 2024
@github-actions github-actions bot mentioned this pull request Jul 22, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants