Fix relative project root #7285

penalosa · 2024-11-18T17:38:06Z

#6971 introduced a small regression in the getEntry() function that meant that Entry.directory was always process.cwd() rather than relative to the found wrangler.toml file. This PR fixes the regression & adds a regression test that fails on main but passes prior to #6971.

Tests
- TODO (before merge)
- Tests included
- Tests not necessary because:
E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
- I don't know
- Required
- Not required because:
Public documentation
- TODO (before merge)
- Cloudflare docs PR(s):
- Documentation not necessary because: bugfix

changeset-bot · 2024-11-18T17:38:10Z

🦋 Changeset detected

Latest commit: 79d10d0

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

This PR includes changesets to release 2 packages

Name	Type
wrangler	Patch
@cloudflare/vitest-pool-workers	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

CarmenPopoviciu · 2024-11-18T17:44:00Z

packages/wrangler/src/__tests__/get-entry.test.ts

+		JSON.stringify(entry).replaceAll(process.cwd(), "/tmp/dir")
+	);
+}
+describe("getEntry()", () => {


🙏 🙇 ♥️

github-actions · 2024-11-18T18:08:09Z

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/11934954997/npm-package-wrangler-7285

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

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

Or you can use npx with this latest build directly:

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

Additional artifacts:

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

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

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

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

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

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

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

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11934954997/npm-package-cloudflare-workflows-shared-7285

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.20241106.0
`workerd`	1.20241106.1	1.20241106.1
`workerd --version`	1.20241106.1	2024-11-06

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

petebacondarwin · 2024-11-18T18:21:06Z

packages/wrangler/src/deployment-bundle/entry.ts

@@ -53,7 +53,9 @@ export async function getEntry(
 	const directory = process.cwd();
 	const entryPoint = config.site?.["entry-point"];

-	let paths: { absolutePath: string; relativePath: string } | undefined;
+	let paths:
+		| { absolutePath: string; relativePath: string; directory?: string }


Suggested change

| { absolutePath: string; relativePath: string; directory?: string }

| { absolutePath: string; relativePath: string; projectRoot?: string }

petebacondarwin · 2024-11-18T18:22:06Z

packages/wrangler/src/deployment-bundle/resolve-entry.ts

@@ -16,11 +16,12 @@ export function resolveEntryWithMain(
 ): {
 	absolutePath: string;
 	relativePath: string;
+	directory: string;


Can we call this projectRoot? Will simplify code elsewhere and is more descriptive than directory which could be a directory of anything.

petebacondarwin · 2024-11-18T18:25:07Z

packages/wrangler/src/__tests__/get-entry.test.ts

+describe("getEntry()", () => {
+	runInTempDir();
+	mockConsoleMethods();
+	it.each([


I love that you added these tests, but if I am honest, using it.each() here actually obscures what the tests are doing and doesn't save much boilerplate compared to writing out a bunch of separate it clauses, given how simple the test code is.

penalosa · 2024-11-19T13:57:22Z

@petebacondarwin I've renamed directory to projectRoot in the Entry type & SDW types, which should clarify things across the codebase. This is a breaking change to the SDW interface, which is fine because that's currently exposed as an experimental API

petebacondarwin

Cripes that rename had more blast radius than I thought!
Thanks.

A few unused imports to remove?

GregBrimble · 2024-11-19T14:48:41Z

Haven't tested, but this maybe fixes [break autolink] #5481?

penalosa · 2024-11-19T15:16:32Z

#5481

It shouldn't I don't think—that looks older than this regression? Taking a look

penalosa · 2024-11-19T15:17:42Z

@GregBrimble it looks like it might be a workspaces thing? #5481 (comment)

penalosa requested a review from a team as a code owner November 18, 2024 17:38

penalosa added the regression Break in existing functionality as a result of a recent change label Nov 18, 2024

CarmenPopoviciu approved these changes Nov 18, 2024

View reviewed changes

CarmenPopoviciu reviewed Nov 18, 2024

View reviewed changes

Fix relative project root

577f4b9

penalosa force-pushed the penalosa/relative-dot-wrangler branch from 865d102 to 577f4b9 Compare November 18, 2024 18:18

petebacondarwin reviewed Nov 18, 2024

View reviewed changes

Create sixty-news-relax.md

d94a80a

penalosa requested review from CarmenPopoviciu and petebacondarwin November 19, 2024 14:00

penalosa added 2 commits November 19, 2024 14:28

Make tests clearer

1f0d1ae

rename directory to projectRoot

d875dc0

penalosa requested a review from a team as a code owner November 19, 2024 14:28

petebacondarwin approved these changes Nov 19, 2024

View reviewed changes

penalosa added 2 commits November 19, 2024 16:14

fix windows

c1ceac2

windows?

61353fe

petebacondarwin approved these changes Nov 20, 2024

View reviewed changes

different template

17af36f

penalosa requested a review from a team as a code owner November 20, 2024 13:36

penalosa added the e2e Run e2e tests on a PR label Nov 20, 2024

penalosa added 2 commits November 20, 2024 13:47

- only

512b9a9

fix

79d10d0

penalosa merged commit fa21312 into main Nov 20, 2024
32 checks passed

penalosa deleted the penalosa/relative-dot-wrangler branch November 20, 2024 16:57

workers-devprod mentioned this pull request Nov 20, 2024

Version Packages #7294

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix relative project root #7285

Fix relative project root #7285

penalosa commented Nov 18, 2024

changeset-bot bot commented Nov 18, 2024 •

edited

Loading

CarmenPopoviciu Nov 18, 2024

github-actions bot commented Nov 18, 2024 •

edited

Loading

petebacondarwin Nov 18, 2024

petebacondarwin Nov 18, 2024

petebacondarwin Nov 18, 2024

penalosa commented Nov 19, 2024

petebacondarwin left a comment

GregBrimble commented Nov 19, 2024 •

edited

Loading

penalosa commented Nov 19, 2024

penalosa commented Nov 19, 2024

	\| { absolutePath: string; relativePath: string; directory?: string }
	\| { absolutePath: string; relativePath: string; projectRoot?: string }

Fix relative project root #7285

Fix relative project root #7285

Conversation

penalosa commented Nov 18, 2024

changeset-bot bot commented Nov 18, 2024 • edited Loading

🦋 Changeset detected

CarmenPopoviciu Nov 18, 2024

Choose a reason for hiding this comment

github-actions bot commented Nov 18, 2024 • edited Loading

petebacondarwin Nov 18, 2024

Choose a reason for hiding this comment

petebacondarwin Nov 18, 2024

Choose a reason for hiding this comment

petebacondarwin Nov 18, 2024

Choose a reason for hiding this comment

penalosa commented Nov 19, 2024

petebacondarwin left a comment

Choose a reason for hiding this comment

GregBrimble commented Nov 19, 2024 • edited Loading

penalosa commented Nov 19, 2024

penalosa commented Nov 19, 2024

changeset-bot bot commented Nov 18, 2024 •

edited

Loading

github-actions bot commented Nov 18, 2024 •

edited

Loading

GregBrimble commented Nov 19, 2024 •

edited

Loading