fix(playground-preview-worker,edge-preview-authenticated-proxy): ensure no body is passed when constructing a GET or HEAD request to the preview worker by edmundhung · Pull Request #7793 · cloudflare/workers-sdk

edmundhung · 2025-01-16T11:25:31Z

This PR fixes the following error we see after releasing the change on #7639.

Error: Request with a GET or HEAD method cannot have a body.

The implementation has been updated in both playground-preview-worker and edge-preview-authenticated-proxy, which are used by the worker playground and the dashboard.

Note: This change itself will not affect how playground and dashboard works as the behavior is opt-in. We will have to un-revert #7639 and we should be able to verify this on the preview playground.

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 · 2025-01-16T11:25:35Z

🦋 Changeset detected

Latest commit: 795620c

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

This PR includes changesets to release 2 packages

Name	Type
edge-preview-authenticated-proxy	Patch
playground-preview-worker	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

github-actions · 2025-01-16T11:28:07Z

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/12929815285/npm-package-wrangler-7793

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

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

Or you can use npx with this latest build directly:

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

Additional artifacts:

cloudflare-workers-bindings-extension:

wget https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12929815285/npm-package-cloudflare-workers-bindings-extension-7793 -O ./cloudflare-workers-bindings-extension.0.0.0-v7ffe58091.vsix && code --install-extension ./cloudflare-workers-bindings-extension.0.0.0-v7ffe58091.vsix

create-cloudflare:

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

@cloudflare/kv-asset-handler:

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

miniflare:

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

@cloudflare/pages-shared:

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

@cloudflare/unenv-preset:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12929815285/npm-package-cloudflare-unenv-preset-7793

@cloudflare/vite-plugin:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12929815285/npm-package-cloudflare-vite-plugin-7793

@cloudflare/vitest-pool-workers:

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

@cloudflare/workers-editor-shared:

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

@cloudflare/workers-shared:

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

@cloudflare/workflows-shared:

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

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

wrangler@3.105.0 includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	3.20241230.2
`workerd`	1.20241230.0	1.20241230.0
`workerd --version`	1.20241230.0	2024-12-30

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

CarmenPopoviciu · 2025-01-21T07:51:33Z

 		expect(await resp.text()).toEqual("PUT");
 	});

+	it.each(["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"])(


❤️ 🙏 🚀

edmundhung · 2025-01-27T10:59:06Z

+		method,
+		headers,
+		body: method === "GET" || method === "HEAD" ? null : request.body,
+		redirect: "manual",


I have checked which properties we can pass here and it looks like only these 4 are relevant. But if you think differently, please let me know 👍🏼

andyjessop · 2025-01-27T11:16:03Z

+		async (method) => {
+			const token = randomBytes(4096).toString("hex");
+			const resp = await worker.fetch(
+				`https://0000.rawhttp.devprod.cloudflare.dev/method`,


What's the reason for testing a remote worker here? Can we just use Miniflare for this?

It is local 👍🏼 . We are running two separate instances through unstable_dev to mimick proxy <-> remote communication:

workers-sdk/packages/edge-preview-authenticated-proxy/tests/index.test.ts

Lines 309 to 379 in 795620c

worker = await unstable_dev(path.join(__dirname, "../src/index.ts"), {

// @ts-expect-error TODO: figure out the right way to get the server to accept host from the request

host: "0000.rawhttp.devprod.cloudflare.dev",

ip: "127.0.0.1",

experimental: {

disableExperimentalWarning: true,

},

});

tmpDir = await fs.realpath(

await fs.mkdtemp(path.join(os.tmpdir(), "preview-tests"))

);

await fs.writeFile(

path.join(tmpDir, "remote.js"),

/*javascript*/ `

export default {

fetch(request) {

const url = new URL(request.url)

if(url.pathname === "/exchange") {

return Response.json({

token: "TEST_TOKEN",

prewarm: "TEST_PREWARM"

})

}

if(url.pathname === "/redirect") {

return Response.redirect("https://example.com", 302)

}

if(url.pathname === "/method") {

return new Response(request.method, {

headers: { "Test-Http-Method": request.method },

})

}

if(url.pathname === "/status") {

return new Response(407)

}

if(url.pathname === "/header") {

return new Response(request.headers.get("X-Custom-Header"))

}

if(url.pathname === "/cookies") {

const headers = new Headers();

headers.append("Set-Cookie", "foo=1");

headers.append("Set-Cookie", "bar=2");

return new Response(undefined, {

headers,

});

}

return Response.json({

url: request.url,

headers: [...request.headers.entries()]

}, { headers: { "Content-Encoding": "identity" } })

}

}

`.trim()

);

await fs.writeFile(

path.join(tmpDir, "wrangler.toml"),

/*toml*/ `

name = "remote-worker"

compatibility_date = "2023-01-01"

`.trim()

);

remote = await unstable_dev(path.join(tmpDir, "remote.js"), {

config: path.join(tmpDir, "wrangler.toml"),

ip: "127.0.0.1",

experimental: { disableExperimentalWarning: true },

});

andyjessop

Looks great, thanks!

edmundhung force-pushed the edmundhung/fix-get-raw-http-request branch from beea6fa to d7dc19c Compare January 16, 2025 14:45

edmundhung marked this pull request as ready for review January 16, 2025 14:49

edmundhung requested a review from a team as a code owner January 16, 2025 14:49

edmundhung added the e2e Run wrangler + vite-plugin e2e tests on a PR label Jan 16, 2025

CarmenPopoviciu reviewed Jan 21, 2025

View reviewed changes

edmundhung added 6 commits January 23, 2025 13:05

chore: add regression test for handling GET raw http request

2c18ba6

fix: proxy GET raw http request with X-CF-Http-Method header

cff63c7

chore: expand the test to cover all supported methods

d26e5ea

add changeset

88c187c

fix HEAD request tests

383b95e

fix missing header prefix

795620c

edmundhung force-pushed the edmundhung/fix-get-raw-http-request branch from d7dc19c to 795620c Compare January 23, 2025 13:05

lrapoport-cf added the caretaking Priority for caretaking label Jan 25, 2025

edmundhung commented Jan 27, 2025

View reviewed changes

andyjessop reviewed Jan 27, 2025

View reviewed changes

andyjessop approved these changes Jan 27, 2025

View reviewed changes

penalosa approved these changes Jan 27, 2025

View reviewed changes

edmundhung merged commit 9941219 into main Jan 27, 2025

edmundhung deleted the edmundhung/fix-get-raw-http-request branch January 27, 2025 12:13

workers-devprod mentioned this pull request Jan 27, 2025

Version Packages #7916

Merged

edmundhung mentioned this pull request Jan 28, 2025

fix(workers-playground): send raw request method through the X-CF-HTTP-Method header #7936

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(playground-preview-worker,edge-preview-authenticated-proxy): ensure no body is passed when constructing a GET or HEAD request to the preview worker#7793

fix(playground-preview-worker,edge-preview-authenticated-proxy): ensure no body is passed when constructing a GET or HEAD request to the preview worker#7793
edmundhung merged 6 commits intomainfrom
edmundhung/fix-get-raw-http-request

edmundhung commented Jan 16, 2025 •

edited

Loading

Uh oh!

changeset-bot Bot commented Jan 16, 2025 •

edited

Loading

Uh oh!

github-actions Bot commented Jan 16, 2025 •

edited

Loading

Uh oh!

CarmenPopoviciu Jan 21, 2025

Uh oh!

edmundhung Jan 27, 2025

Uh oh!

andyjessop Jan 27, 2025

Uh oh!

edmundhung Jan 27, 2025

Uh oh!

andyjessop left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	worker = await unstable_dev(path.join(__dirname, "../src/index.ts"), {
	// @ts-expect-error TODO: figure out the right way to get the server to accept host from the request
	host: "0000.rawhttp.devprod.cloudflare.dev",
	ip: "127.0.0.1",
	experimental: {
	disableExperimentalWarning: true,
	},
	});

	tmpDir = await fs.realpath(
	await fs.mkdtemp(path.join(os.tmpdir(), "preview-tests"))
	);

	await fs.writeFile(
	path.join(tmpDir, "remote.js"),
	/javascript/ `
	export default {
	fetch(request) {
	const url = new URL(request.url)
	if(url.pathname === "/exchange") {
	return Response.json({
	token: "TEST_TOKEN",
	prewarm: "TEST_PREWARM"
	})
	}
	if(url.pathname === "/redirect") {
	return Response.redirect("https://example.com", 302)
	}
	if(url.pathname === "/method") {
	return new Response(request.method, {
	headers: { "Test-Http-Method": request.method },
	})
	}
	if(url.pathname === "/status") {
	return new Response(407)
	}
	if(url.pathname === "/header") {
	return new Response(request.headers.get("X-Custom-Header"))
	}
	if(url.pathname === "/cookies") {
	const headers = new Headers();

	headers.append("Set-Cookie", "foo=1");
	headers.append("Set-Cookie", "bar=2");

	return new Response(undefined, {
	headers,
	});
	}
	return Response.json({
	url: request.url,
	headers: [...request.headers.entries()]
	}, { headers: { "Content-Encoding": "identity" } })
	}
	}
	`.trim()
	);

	await fs.writeFile(
	path.join(tmpDir, "wrangler.toml"),
	/toml/ `
	name = "remote-worker"
	compatibility_date = "2023-01-01"
	`.trim()
	);

	remote = await unstable_dev(path.join(tmpDir, "remote.js"), {
	config: path.join(tmpDir, "wrangler.toml"),
	ip: "127.0.0.1",
	experimental: { disableExperimentalWarning: true },
	});

Conversation

edmundhung commented Jan 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented Jan 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions Bot commented Jan 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CarmenPopoviciu Jan 21, 2025

Choose a reason for hiding this comment

Uh oh!

edmundhung Jan 27, 2025

Choose a reason for hiding this comment

Uh oh!

andyjessop Jan 27, 2025

Choose a reason for hiding this comment

Uh oh!

edmundhung Jan 27, 2025

Choose a reason for hiding this comment

Uh oh!

andyjessop left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

edmundhung commented Jan 16, 2025 •

edited

Loading

changeset-bot Bot commented Jan 16, 2025 •

edited

Loading

github-actions Bot commented Jan 16, 2025 •

edited

Loading