feat: graduate `--x-include-runtime` #8166

emily-shen · 2025-02-17T15:09:02Z

TODO: rebase on /vnext for inclusion in wrangler v4

Might be best to review commit by commit

DEVX-1615 improve logging output: d33b18a, 1b0d071
DEVX-1611 remove --x-include-runtime and consolidate type output into one file: 2b99075
DEVX-1612 prompt users to rerun wrangler types during dev: 4872cb9

This PR will turn on runtime type generation by default for wrangler types.

The --experimental-include-runtime flag will be superseded by include-runtime and include-env, both of which are true by default.

Also, the runtime types will be generated in the same file as the env types, at the location specified by path (worker-configuration.d.ts by default).

Before:

After:

Tests
- TODO (before merge)
- Tests included
- Tests not necessary because:
Wrangler E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
- I don't know
- Required
- Not required because: covered by unit tests
Public documentation
- TODO (before merge)
- Cloudflare docs PR(s): [wrangler] Update instructions for accessing runtime types cloudflare-docs#20082
- Documentation not necessary because:

changeset-bot · 2025-02-17T15:09:06Z

🦋 Changeset detected

Latest commit: 24d8152

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

This PR includes changesets to release 2 packages

Name	Type
wrangler	Minor
@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

github-actions · 2025-02-17T15:13:14Z

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/13439225900/npm-package-wrangler-8166

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

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

Or you can use npx with this latest build directly:

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

Additional artifacts:

cloudflare-workers-bindings-extension:

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

create-cloudflare:

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

@cloudflare/kv-asset-handler:

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

miniflare:

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

@cloudflare/pages-shared:

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

@cloudflare/unenv-preset:

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

@cloudflare/vite-plugin:

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

@cloudflare/vitest-pool-workers:

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

@cloudflare/workers-editor-shared:

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

@cloudflare/workers-shared:

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

@cloudflare/workflows-shared:

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

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.20250204.1
`workerd`	1.20250214.0	1.20250214.0
`workerd --version`	1.20250214.0	2025-02-14

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

fixtures/type-generation/tests/type-generation.file-comment.test.ts

emily-shen · 2025-02-18T13:45:30Z

.changeset/nasty-kiwis-talk.md

@@ -0,0 +1,9 @@
+---
+"wrangler": minor


major? pretty sure there's nothing breaking. inclusion in v4 is mostly for politeness as there's a fair amount of CI usage

vicb · 2025-02-20T14:28:36Z

.changeset/nasty-kiwis-talk.md

+
+`wrangler types` will now produce one file that contains both `Env` types and runtime types based on your compatibility date and flags. This is located at `worker-configuration.d.ts` by default.
+
+This behaviour was previously gated behind `--experimental-include-runtime`. That flag is no longer necessary and has been removed. It has been replaced by `--include-runtime` and `include-env`, both of which are set to `true` by default.


Suggested change

This behaviour was previously gated behind `--experimental-include-runtime`. That flag is no longer necessary and has been removed. It has been replaced by `--include-runtime` and `include-env`, both of which are set to `true` by default.

This behaviour was previously gated behind `--experimental-include-runtime`. That flag is no longer necessary and has been removed. It has been replaced by `--include-runtime` and `--include-env`, both of which are set to `true` by default.

vicb · 2025-02-20T14:30:14Z

fixtures/type-generation/tests/type-generation.file-comment.test.ts

@@ -28,7 +28,7 @@ describe("`wrangler types` - file comment", () => {
 			"packages",
 			"wrangler"
 		);
-		execSync(`npx ${wranglerPath} types ${args}`, {
+		execSync(`npx ${wranglerPath} types ${args} --include-runtime=false`, {


Should the describe l8 be updated? or should we not pass --include-runtime=false ?

vicb · 2025-02-20T14:34:26Z

packages/wrangler/e2e/types.test.ts

+		const file = (await readFile(path.join(helper.tmpPath, "./types.d.ts")))
+			.toString()


Looks like this can be updated at multiple places

Suggested change

const file = (await readFile(path.join(helper.tmpPath, "./types.d.ts")))

.toString()

const file = (await readFile(path.join(helper.tmpPath, "./types.d.ts"), "utf8"))

vicb · 2025-02-20T14:37:01Z

packages/wrangler/e2e/types.test.ts

+			`"// Generated by Wrangler by running \`wrangler types ./types.d.ts\` (hash: e82ba4d7b995dd9ca6fb0332d81f889b)"`
+		);
+		expect(file[1]).match(
+			/\/\/ Runtime types generated with workerd@1\.\d+\.\d \d\d\d\d-\d\d-\d\d ([a-z_]+,?)*/


Suggested change

/\/\/ Runtime types generated with workerd@1\.\d+\.\d \d\d\d\d-\d\d-\d\d ([a-z_]+,?)*/

/\/\/ Runtime types generated with workerd@1\.\d+\.\d \d+-\d+-\d+ ([a-z_]+,?)*/

or \d{4} / \d{2} but + is consistent with the first d+

vicb · 2025-02-20T14:37:31Z

packages/wrangler/e2e/types.test.ts

-		const output = await helper.run(
-			`wrangler types --x-include-runtime="./types.d.ts"`
-		);
+		const file2 = (await readFile(typesPath)).toString();


vicb · 2025-02-20T14:39:33Z

packages/wrangler/src/type-generation/helpers.ts

+	if (!entry.file.endsWith(".ts")) {
+		return;
+	}
+	let maybeExistingTypesFile: string[];


Suggested change

let maybeExistingTypesFile: string[];

let maybeExistingTypesFileLines: string[];

vicb · 2025-02-20T14:40:43Z

packages/wrangler/src/type-generation/helpers.ts

+import type { Config } from "../config";
+import type { Entry } from "../deployment-bundle/entry";
+
+export const checkTypesDiff = async (config: Config, entry: Entry) => {


Add a comment about what this fn does?

vicb · 2025-02-20T14:41:52Z

packages/wrangler/src/type-generation/helpers.ts

+	try {
+		const { envHeader } = await generateEnvTypes(
+			config,
+			{ strictVars: previousStrictVars === "false" ? false : true },


Suggested change

{ strictVars: previousStrictVars === "false" ? false : true },

{ strictVars: previousStrictVars !== "false" },

vicb · 2025-02-20T14:45:33Z

packages/wrangler/src/type-generation/runtime/log-runtime-types-message.ts

+				`Since you have the \`nodejs_compat\` flag, you should install Node.js types by running "npm i --save-dev @types/node${isWorkersTypesInstalled ? '@20.8.3".\nFor more details: https://developers.cloudflare.com/workers/languages/typescript/#known-issues' : '".'}`
+			)


Something like the following might improve readibility?

Suggested change

`Since you have the \`nodejs_compat\` flag, you should install Node.js types by running "npm i --save-dev @types/node${isWorkersTypesInstalled ? '@20.8.3".\nFor more details: https://developers.cloudflare.com/workers/languages/typescript/#known-issues' : '".'}`

)

`Since you have the \`nodejs_compat\` flag, you should install Node.js types by running "npm i --save-dev ${isWorkersTypesInstalled ? "@types/node@20.8.3.\nFor more details: https://developers.cloudflare.com/workers/languages/typescript/#known-issues' : '@types/node.'}`

)

vicb · 2025-02-20T19:44:55Z

packages/wrangler/src/type-generation/runtime/index.ts


 	try {
-		const existingTypes = await readFile(outFile, "utf8");
-		if (existingTypes.split("\n")[0] === header) {
+		const file = (await readFile(outFile, "utf8")).split("\n");


Suggested change

const file = (await readFile(outFile, "utf8")).split("\n");

const lines = (await readFile(outFile, "utf8")).split("\n");

emily-shen force-pushed the emily/dynamic-typegen-ga branch from 56b09dc to 3d88fea Compare February 17, 2025 18:05

github-advanced-security bot found potential problems Feb 17, 2025

View reviewed changes

fixtures/type-generation/tests/type-generation.file-comment.test.ts Dismissed Show dismissed Hide dismissed

emily-shen force-pushed the emily/dynamic-typegen-ga branch from 3d88fea to 68d6130 Compare February 18, 2025 12:22

workers-devprod added the e2e Run wrangler e2e tests on a PR label Feb 18, 2025

emily-shen force-pushed the emily/dynamic-typegen-ga branch 3 times, most recently from c86cbf3 to 88426fa Compare February 18, 2025 13:42

emily-shen marked this pull request as ready for review February 18, 2025 13:44

emily-shen requested a review from a team as a code owner February 18, 2025 13:44

emily-shen commented Feb 18, 2025

View reviewed changes

emily-shen force-pushed the emily/dynamic-typegen-ga branch 4 times, most recently from a7df791 to c931fe0 Compare February 19, 2025 10:31

emily-shen added the v4 wrangler version 4 label Feb 19, 2025

emily-shen force-pushed the emily/dynamic-typegen-ga branch from 9a873ab to 4872cb9 Compare February 20, 2025 14:23

vicb reviewed Feb 20, 2025

View reviewed changes

emily-shen changed the base branch from main to next February 20, 2025 15:22

emily-shen changed the base branch from next to main February 20, 2025 15:23

add docs link to --help output

440dc33

emily-shen added 6 commits February 20, 2025 15:24

output env and runtime in one file

d3c8d5d

cleanup runtime log output

0a72f5c

fix and add tests

481422a

changeset

1dc6f3a

change command description

9744261

check and prompt update

2ef9aa4

emily-shen force-pushed the emily/dynamic-typegen-ga branch from 4872cb9 to 2ef9aa4 Compare February 20, 2025 15:24

emily-shen requested review from a team as code owners February 20, 2025 15:24

workers-devprod added the c3-e2e label Feb 20, 2025

emily-shen changed the base branch from main to next February 20, 2025 15:24

fixup after rebase on /vnext

24d8152

vicb reviewed Feb 20, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: graduate `--x-include-runtime` #8166

feat: graduate `--x-include-runtime` #8166

emily-shen commented Feb 17, 2025 •

edited

Loading

changeset-bot bot commented Feb 17, 2025 •

edited

Loading

github-actions bot commented Feb 17, 2025 •

edited

Loading

emily-shen Feb 18, 2025 •

edited

Loading

vicb Feb 20, 2025

vicb Feb 20, 2025

vicb Feb 20, 2025

vicb Feb 20, 2025

vicb Feb 20, 2025

vicb Feb 20, 2025

vicb Feb 20, 2025

vicb Feb 20, 2025

vicb Feb 20, 2025

vicb Feb 20, 2025


		`wrangler types` will now produce one file that contains both `Env` types and runtime types based on your compatibility date and flags. This is located at `worker-configuration.d.ts` by default.

		This behaviour was previously gated behind `--experimental-include-runtime`. That flag is no longer necessary and has been removed. It has been replaced by `--include-runtime` and `include-env`, both of which are set to `true` by default.

		const file = (await readFile(path.join(helper.tmpPath, "./types.d.ts")))
		.toString()

	/\/\/ Runtime types generated with workerd@1\.\d+\.\d \d\d\d\d-\d\d-\d\d ([a-z_]+,?)*/
	/\/\/ Runtime types generated with workerd@1\.\d+\.\d \d+-\d+-\d+ ([a-z_]+,?)*/

	let maybeExistingTypesFile: string[];
	let maybeExistingTypesFileLines: string[];

	{ strictVars: previousStrictVars === "false" ? false : true },
	{ strictVars: previousStrictVars !== "false" },

		`Since you have the \`nodejs_compat\` flag, you should install Node.js types by running "npm i --save-dev @types/node${isWorkersTypesInstalled ? '@20.8.3".\nFor more details: https://developers.cloudflare.com/workers/languages/typescript/#known-issues' : '".'}`
		)

	const file = (await readFile(outFile, "utf8")).split("\n");
	const lines = (await readFile(outFile, "utf8")).split("\n");

feat: graduate --x-include-runtime #8166

Are you sure you want to change the base?

feat: graduate --x-include-runtime #8166

Conversation

emily-shen commented Feb 17, 2025 • edited Loading

changeset-bot bot commented Feb 17, 2025 • edited Loading

🦋 Changeset detected

github-actions bot commented Feb 17, 2025 • edited Loading

emily-shen Feb 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

feat: graduate `--x-include-runtime` #8166

feat: graduate `--x-include-runtime` #8166

emily-shen commented Feb 17, 2025 •

edited

Loading

changeset-bot bot commented Feb 17, 2025 •

edited

Loading

github-actions bot commented Feb 17, 2025 •

edited

Loading

emily-shen Feb 18, 2025 •

edited

Loading