New testing helpers using `using`, replace old console mocking functions. #11177

phryneas · 2023-08-29T13:11:59Z

This PR introduces three new internal test helpers to make use of the new "Explicit Resource Management" feature with using and await using that has made it into TypeScript 5.2.

using obj = withCleanup(object, cleanup): T & Disposable

to create disposable objects and the two helpers

using consoleSpy = spyOnConsole("log", "info", ...)
using consoleSpy = spyOnConsole.takeSnapshots("log", "info", ...)

that mock console methods until disposed on scope exit.

To make sure that Disposable and AsyncDisposable objects are always initialized with using, I added a lint rule.

It also @deprecates the old mocking helper functions withErrorSpy, withWarningSpy and withLogSpy and removes all usage of them from our code.

The PR removes a most usages of manual console mocking, but not all of them (a few last one would require bigger test refactors).

This might look like a small change, but the withCleanup pattern will allow us to write more self-contained test without the use of beforeEach, afterEach etc.
Those helpers seemed nice for setting up tests, but as the tests grew, made it really hard to reason about our tests later on.

Checklist:

If this PR contains changes to the library itself (not necessary for e.g. docs updates), please include a changeset (see CONTRIBUTING.md)
If this PR is a new feature, please reference an issue where a consensus about the design was reached (not necessary for small changes)
Make sure all of the significant new logic is covered by tests

changeset-bot · 2023-08-29T13:12:02Z

⚠️ No Changeset found

Latest commit: 5e05938

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

github-actions · 2023-08-29T13:13:43Z

size-limit report 📦

Path	Size
dist/apollo-client.min.cjs	37.28 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs"	43.75 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production)	42.32 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js"	32.52 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production)	31.27 KB (0%)
import { ApolloProvider } from "dist/react/index.js"	1.21 KB (0%)
import { ApolloProvider } from "dist/react/index.js" (production)	1.2 KB (0%)
import { useQuery } from "dist/react/index.js"	4.27 KB (0%)
import { useQuery } from "dist/react/index.js" (production)	4.08 KB (0%)
import { useLazyQuery } from "dist/react/index.js"	4.58 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production)	4.4 KB (0%)
import { useMutation } from "dist/react/index.js"	2.52 KB (0%)
import { useMutation } from "dist/react/index.js" (production)	2.51 KB (0%)
import { useSubscription } from "dist/react/index.js"	2.24 KB (0%)
import { useSubscription } from "dist/react/index.js" (production)	2.2 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js"	4.76 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" (production)	4.19 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js"	4.28 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" (production)	3.7 KB (0%)
import { useReadQuery } from "dist/react/index.js"	2.96 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production)	2.91 KB (0%)
import { useFragment } from "dist/react/index.js"	2.08 KB (0%)
import { useFragment } from "dist/react/index.js" (production)	2.03 KB (0%)

netlify · 2023-08-29T13:16:06Z

✅ Deploy Preview for apollo-client-docs ready!

Name	Link
🔨 Latest commit	`4a49723`
🔍 Latest deploy log	https://app.netlify.com/sites/apollo-client-docs/deploys/64f995fb4cd6010008f7aa55
😎 Deploy Preview	https://deploy-preview-11177--apollo-client-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

phryneas · 2023-09-08T11:21:20Z

src/__tests__/local-state/__snapshots__/export.ts.snap

@@ -3,13 +3,6 @@
 exports[`@client @export tests should NOT refetch if an @export variable has not changed, the current fetch policy is not cache-only, and the query includes fields that need to be resolved remotely 1`] = `


This snapshot was confusing me to no end, but it seems that for some reason, delayed console.log calls from other tests has spilled over into these ones.

On main, calling these tests individually, they had very different snapshots from just running the whole test file.

That seems to have somehow surfaced during this refactor.

phryneas · 2023-09-08T11:23:32Z

src/__tests__/client.ts

-    (resolve, reject) => {
+  it("should warn if server returns wrong data", async () => {
+    using _consoleSpies = spyOnConsole.takeSnapshots("error");
+    await new Promise((resolve, reject) => {


I'm not incredibly happy about this way of removing itAsync, but in this case, we need a way of holding _consoleSpies in scope until the test is finished. This was the "least code changes" way of doing so.

I don't expect this pattern to be necessary in future code, as we have generally moved away from itAsync.

phryneas · 2023-09-08T11:30:25Z

src/testing/internal/disposables/spyOnConsole.ts

+  jest.SpyInstance<void, any[], any>
+>;
+
+/** @internal */


By the way, I've started using these @internal annotations because it might make sense to bring Api Extractor into the picture at some point, which would help us keep a good overview of changes in our public type surface.

src/testing/internal/disposables/withCleanup.ts

alessbell

@phryneas and I walked through this in details offline - very excited to begin using these utilities (pun unavoidable in my defense) 🎉🎉

example testing helpers with using

dd24ff7

phryneas added 10 commits September 7, 2023 11:20

Merge branch 'main' into pr/tests-using

4a49723

eslint rule, broken modules

65e3171

working local eslint rule

353b5dc

swap out many cases of manual console mocking

162e9da

make lint rule more solid

1d6cd24

format

7f90db6

rename variables

b7b6dec

recreate export snapshots without tests bleeding into each other

5f2654f

restore snapshotting behaviour

6ae0eab

remove accidentally commited file

fc7f293

phryneas commented Sep 8, 2023

View reviewed changes

phryneas changed the title ~~example testing helpers with using~~ New testing helpers using using, replace old console mocking functions. Sep 8, 2023

migrate more usages

51cc9da

phryneas self-assigned this Sep 8, 2023

phryneas requested review from jerelmiller and alessbell September 8, 2023 12:18

phryneas marked this pull request as ready for review September 8, 2023 12:18

SimenB mentioned this pull request Sep 8, 2023

[Feature]: Add support for 'using' keyword to dispose mocks/spies jestjs/jest#14294

Closed

phryneas commented Sep 13, 2023

View reviewed changes

src/testing/internal/disposables/withCleanup.ts Outdated Show resolved Hide resolved

Update src/testing/internal/disposables/withCleanup.ts

812d3dc

alessbell approved these changes Sep 13, 2023

View reviewed changes

Merge branch 'main' into pr/tests-using

5e05938

phryneas merged commit dc4baed into main Sep 14, 2023
8 checks passed

phryneas deleted the pr/tests-using branch September 14, 2023 13:41

github-actions bot locked as resolved and limited conversation to collaborators Oct 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New testing helpers using `using`, replace old console mocking functions. #11177

New testing helpers using `using`, replace old console mocking functions. #11177

phryneas commented Aug 29, 2023 •

edited

Loading

changeset-bot bot commented Aug 29, 2023 •

edited

Loading

github-actions bot commented Aug 29, 2023 •

edited

Loading

netlify bot commented Aug 29, 2023 •

edited

Loading

phryneas Sep 8, 2023

phryneas Sep 8, 2023

phryneas Sep 8, 2023

alessbell left a comment

		@@ -3,13 +3,6 @@
		exports[`@client @export tests should NOT refetch if an @export variable has not changed, the current fetch policy is not cache-only, and the query includes fields that need to be resolved remotely 1`] = `

New testing helpers using using, replace old console mocking functions. #11177

New testing helpers using using, replace old console mocking functions. #11177

Conversation

phryneas commented Aug 29, 2023 • edited Loading

Checklist:

changeset-bot bot commented Aug 29, 2023 • edited Loading

⚠️ No Changeset found

github-actions bot commented Aug 29, 2023 • edited Loading

size-limit report 📦

netlify bot commented Aug 29, 2023 • edited Loading

✅ Deploy Preview for apollo-client-docs ready!

phryneas Sep 8, 2023

Choose a reason for hiding this comment

phryneas Sep 8, 2023

Choose a reason for hiding this comment

phryneas Sep 8, 2023

Choose a reason for hiding this comment

alessbell left a comment

Choose a reason for hiding this comment

New testing helpers using `using`, replace old console mocking functions. #11177

New testing helpers using `using`, replace old console mocking functions. #11177

phryneas commented Aug 29, 2023 •

edited

Loading

changeset-bot bot commented Aug 29, 2023 •

edited

Loading

github-actions bot commented Aug 29, 2023 •

edited

Loading

netlify bot commented Aug 29, 2023 •

edited

Loading