Upgrade `@cloudflare/vitest-pool-workers` to Vitest v2+ #6232

penalosa · 2024-07-09T10:51:31Z

What this PR solves / how to test

Fixes #6215

Author has addressed the following

Tests
- TODO (before merge)
- Included
- Tests not necessary because: The existing (extensive) Vitest tests are enough to validate that the upgrade works
E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
- I don't know
- Required / Maybe required
- Not required because: e2e does not cover vitest
Changeset (Changeset guidelines)
- TODO (before merge)
- Changeset included
- Not necessary because:
Public documentation
- TODO (before merge)
- Cloudflare docs PR(s): @cloudflare/vitest-pool-workers now requires Vitest v2 cloudflare-docs#16827
- Not necessary because:

changeset-bot · 2024-07-09T10:51:34Z

🦋 Changeset detected

Latest commit: acc0f99

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

This PR includes changesets to release 1 package

Name	Type
@cloudflare/vitest-pool-workers	Minor

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

github-actions · 2024-07-09T10:53:58Z

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10852453045/npm-package-wrangler-6232

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/6232/npm-package-wrangler-6232

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10852453045/npm-package-wrangler-6232 dev path/to/script.js

Additional artifacts:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10852453045/npm-package-create-cloudflare-6232 --no-auto-update

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10852453045/npm-package-cloudflare-kv-asset-handler-6232

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10852453045/npm-package-miniflare-6232

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10852453045/npm-package-cloudflare-pages-shared-6232

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10852453045/npm-package-cloudflare-vitest-pool-workers-6232

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10852453045/npm-package-cloudflare-workers-editor-shared-6232

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10852453045/npm-package-cloudflare-workers-shared-6232

Note that these links will no longer work once the GitHub Actions artifact expires.

[email protected] includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	3.20240909.0
`workerd`	1.20240909.0	1.20240909.0
`workerd --version`	1.20240909.0	2024-09-09

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

webbertakken · 2024-07-23T18:52:40Z

You can reference the automatically updated head of this PR with:
npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/6232/npm-package-wrangler-6232

This ends up with an error for now

npm error code ERESOLVE
npm error ERESOLVE could not resolve
npm error
npm error While resolving: @cloudflare/[email protected]
npm error Found: [email protected]
npm error node_modules/vitest
npm error   peerOptional vitest@"*" from [email protected]
npm error   node_modules/eslint-plugin-vitest
npm error     dev eslint-plugin-vitest@"^0.5.4" from the root project
npm error   peerOptional vitest@">= 0.32" from @testing-library/[email protected]
npm error   node_modules/@testing-library/jest-dom
npm error     dev @testing-library/jest-dom@"^6.4.6" from the root project
npm error   2 more (@vitest/coverage-v8, the root project)
npm error
npm error Could not resolve dependency:
npm error peer vitest@"1.3.x - 1.5.x" from @cloudflare/[email protected]
npm error node_modules/@cloudflare/vitest-pool-workers
npm error   dev @cloudflare/vitest-pool-workers@"^0.4.14" from the root project
npm error
npm error Conflicting peer dependency: [email protected]
npm error node_modules/vitest
npm error   peer vitest@"1.3.x - 1.5.x" from @cloudflare/[email protected]
npm error   node_modules/@cloudflare/vitest-pool-workers
npm error     dev @cloudflare/vitest-pool-workers@"^0.4.14" from the root project
npm error
npm error Fix the upstream dependency conflict, or retry
npm error this command with --force or --legacy-peer-deps
npm error to accept an incorrect (and potentially broken) dependency resolution.

Codex- · 2024-09-02T03:01:00Z

I'd love to test these changes but have found that trying to reference the PR release for vitest-pool-workers does not resolve 🤔

danawoodman · 2024-09-10T19:57:05Z

Do we have any ETA of when this will be ready to use?

penalosa · 2024-09-13T00:25:00Z

packages/vitest-pool-workers/test/console.test.ts

 			expect(result.stdout).toMatch(
-				"stdout | index.test.ts:4:10\nnew describe"


This seems to be a change in the Vitest output to remove line numbers (verified by upgrading Wrangler to Vitest v2+ and seeing the change)

penalosa · 2024-09-13T02:07:55Z

packages/vitest-pool-workers/package.json

+		"@vitest/runner": "2.0.x",
+		"@vitest/snapshot": "2.0.x",
+		"vitest": "2.0.x"


These don't use the catalog because I'm hopeful we can make it a range in future

petebacondarwin · 2024-09-13T10:50:16Z

fixtures/local-mode-tests/tests/logging.test.ts

 import { unstable_dev } from "wrangler";

 let output = "";
 function spyOnConsoleMethod(name: keyof typeof console) {
-	vi.spyOn(console, name).mockImplementation((...args: unknown[]) => {
+	(vi.spyOn(console, name) as Mock).mockImplementation((...args: unknown[]) => {


For reference this is needed because the name variable here does not result in the spyOn() function being narrowed enough for it to generate a sensible return type, resultng in never.

packages/miniflare/src/index.ts

packages/vitest-pool-workers/src/pool/index.ts

packages/vitest-pool-workers/test/global-setup.ts

petebacondarwin mentioned this pull request Jul 16, 2024

🐛 Update vitest-pool-workers to support vitest >= 2.x #6215

Closed

lrapoport-cf added the caretaking Priority for caretaking label Sep 9, 2024

penalosa commented Sep 13, 2024

View reviewed changes

penalosa force-pushed the penalosa/vitest-v2 branch from 0e508f5 to f9a02b7 Compare September 13, 2024 02:04

penalosa commented Sep 13, 2024

View reviewed changes

penalosa marked this pull request as ready for review September 13, 2024 02:58

penalosa requested review from a team as code owners September 13, 2024 02:58

petebacondarwin reviewed Sep 13, 2024

View reviewed changes

petebacondarwin approved these changes Sep 13, 2024

View reviewed changes

packages/miniflare/src/index.ts Outdated Show resolved Hide resolved

packages/vitest-pool-workers/src/pool/index.ts Outdated Show resolved Hide resolved

packages/vitest-pool-workers/test/global-setup.ts Outdated Show resolved Hide resolved

penalosa added 9 commits September 13, 2024 16:57

Initial v2

863349c

more

d6c8540

update lockfile

ea50ff0

More migration

8ee2289

Use pnpm catalog to guarantee vitest version

7268a69

Add changeset

f8e48c9

fs export

5cbea8d

update types to match vitest v2

6ae54a9

address comments

acc0f99

penalosa force-pushed the penalosa/vitest-v2 branch from 4095808 to acc0f99 Compare September 13, 2024 16:08

penalosa added the skip-pr-validation Skip validation of the required PR description format label Sep 13, 2024

penalosa merged commit f3c0400 into main Sep 13, 2024
32 of 36 checks passed

penalosa deleted the penalosa/vitest-v2 branch September 13, 2024 17:05

workers-devprod mentioned this pull request Sep 13, 2024

Version Packages #6694

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade `@cloudflare/vitest-pool-workers` to Vitest v2+ #6232

Upgrade `@cloudflare/vitest-pool-workers` to Vitest v2+ #6232

penalosa commented Jul 9, 2024 •

edited

Loading

changeset-bot bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

webbertakken commented Jul 23, 2024

Codex- commented Sep 2, 2024

danawoodman commented Sep 10, 2024

penalosa Sep 13, 2024

penalosa Sep 13, 2024

petebacondarwin Sep 13, 2024

		expect(result.stdout).toMatch(
		"stdout \| index.test.ts:4:10\nnew describe"

Upgrade @cloudflare/vitest-pool-workers to Vitest v2+ #6232

Upgrade @cloudflare/vitest-pool-workers to Vitest v2+ #6232

Conversation

penalosa commented Jul 9, 2024 • edited Loading

What this PR solves / how to test

Author has addressed the following

changeset-bot bot commented Jul 9, 2024 • edited Loading

🦋 Changeset detected

github-actions bot commented Jul 9, 2024 • edited Loading

webbertakken commented Jul 23, 2024

Codex- commented Sep 2, 2024

danawoodman commented Sep 10, 2024

penalosa Sep 13, 2024

Choose a reason for hiding this comment

penalosa Sep 13, 2024

Choose a reason for hiding this comment

petebacondarwin Sep 13, 2024

Choose a reason for hiding this comment

Upgrade `@cloudflare/vitest-pool-workers` to Vitest v2+ #6232

Upgrade `@cloudflare/vitest-pool-workers` to Vitest v2+ #6232

penalosa commented Jul 9, 2024 •

edited

Loading

changeset-bot bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading