Add `wrangler.toml` support in `pages deploy` by CarmenPopoviciu · Pull Request #5377 · cloudflare/workers-sdk

CarmenPopoviciu · 2024-03-26T08:04:25Z

What this PR solves / how to test

This PR adds wrangler.toml support in pages deploy

♫♫♫

Starlight, star bright
First star I see tonight
Starlight, star bright
Make everything alright

♫♫♫

Author has addressed the following

Tests
- TODO (before merge)
- Included
- Not necessary because:
Changeset (Changeset guidelines)
- TODO (before merge)
- Included
- Not necessary because:
Public documentation
- TODO (before merge)
- Cloudflare docs PR(s): https://github.com/cloudflare/cloudflare-docs/pull/...
- Not necessary because: not necessary at this stage of the work

Test Plan 🚀

Apart from unit/integration/fixtures tests, this PR was manually tested based on the following test plan:

pages deploy [<directory>] should still work correctly, for Pages projects without a config file

npx wrangler pages deploy public

pages deploy should pick up configuration from wrangler.toml, if file exists and pages_build_output_dir is specified

# wrangler.toml

pages_build_output_dir = "./public"
name = "pages-with-config-file-app"
compatibility_date = "2024-01-01"

[vars]
VAR1 = "holiday"
VAR2 = "celebrate"

// /functions/celebrate.ts

return new Response(
  `[/celebrate]:\n` +
   `🎵 🎵 🎵\n` +
   `You can turn this world around\n` +
   `And bring back all of those happy days\n` +
   `Put your troubles down\n` +
   `It's time to ${context.env.VAR2}\n` +
   `🎵 🎵 🎵`
);

npx wrangler pages deploy

pages deploy [<directory>] should warn and ignore the wrangler.toml file, if it exists but pages_build_output_dir is not specified

# wrangler.toml

name = "pages-with-config-file-app"
compatibility_date = "2024-01-01"

[vars]
VAR1 = "holiday"
VAR2 = "celebrate"

// /functions/celebrate.ts

return new Response(
  `[/celebrate]:\n` +
   `🎵 🎵 🎵\n` +
   `You can turn this world around\n` +
   `And bring back all of those happy days\n` +
   `Put your troubles down\n` +
   `It's time to ${context.env.VAR2}\n` +
   `🎵 🎵 🎵`
);

npx wrangler pages deploy

pages deploy with valid wrangler.toml should deploy to new projects

# wrangler.toml

pages_build_output_dir = "./public"
name = "pages-with-config-file-app"
compatibility_date = "2024-01-01"

[vars]
VAR1 = "holiday"
VAR2 = "celebrate"

// /functions/celebrate.ts

return new Response(
  `[/celebrate]:\n` +
   `🎵 🎵 🎵\n` +
   `You can turn this world around\n` +
   `And bring back all of those happy days\n` +
   `Put your troubles down\n` +
   `It's time to ${context.env.VAR2}\n` +
   `🎵 🎵 🎵`
);

npx wrangler pages deploy

pages deploy with valid wrangler.toml should deploy to existing projects

# wrangler.toml

pages_build_output_dir = "./public"
name = "pages-with-config-file-app"
compatibility_date = "2024-01-01"

[vars]
VAR1 = "holiday"
VAR2 = "celebrate"

// /functions/celebrate.ts

return new Response(
  `[/celebrate]:\n` +
   `🎵 🎵 🎵\n` +
   `You can turn this world around\n` +
   `And bring back all of those happy days\n` +
   `Put your troubles down\n` +
   `It's time to ${context.env.VAR2}\n` +
   `🎵 🎵 🎵`
);

npx wrangler pages deploy

pages deploy should fail if no [<directory>] argument was passed and configuration file does not specify pages_build_output_dir

# wrangler.toml

name = "pages-functions-with-config-file-app"
compatibility_date = "2024-01-01"

npx wrangler pages deploy

pages deploy should fail if configuration file is not valid

# wrangler.toml

pages_build_output_dir = "./public"
name = "pages-functions-with-config-file-app"
compatibility_date = "2024-01-01"

[vars]
VAR1 = "holiday"
VAR2 = "celebrate"

[kv_namespaces]
namespace_origin = "invalid"

[env.staging]
[env.staging.vars]
VAR1 = "test"

npx wrangler pages deploy

pages deploy should always deploy to the Pages project specified by the top-level name configuration field, regardless of the corresponding env-level configuration

# wrangler.toml

pages_build_output_dir = "./public"
name = "pages-functions-with-config-file-app"
compatibility_date = "2024-01-01"

[env.production]
name = "pages-functions-with-config-file-app-production"

npx wrangler pages deploy

pages deploy should fail if top-level name configuration field is not specified, irrespective of the targeted environment, and whether that environment's configuration specififes the name field

# wrangler.toml

pages_build_output_dir = "./public"
compatibility_date = "2024-01-01"

[env.production]
name = "pages-functions-with-config-file-app"

npx wrangler pages deploy --branch=main

pages deploy --branch=<name_of_production_branch> should apply production specific configuration when deploying to the production environment, if [env.production] is specified in wrangler.toml

#wrangler.toml

pages_build_output_dir = "./public"
name = "pages-functions-with-config-file-app"
compatibility_date = "2024-01-01"

[vars]
VAR1 = "holiday"
VAR2 = "celebrate"

[env.preview]
[env.preview.vars]
VAR1 = "🌤️ holiday 🌤️"
VAR2 = "🤸🏻 celebrate 🤸🏻"

[env.production]
[env.production.vars]
VAR1 = "🏖️ holiday 🏖️"
VAR2 = "🥳 celebrate 🥳"

npx wrangler pages deploy --branch=main

pages deploy --branch=<name_of_production_branch> should fallback to top-level configuration when deploying to the production environment, if [env.production] is not specified in wrangler.toml

# wrangler.toml

pages_build_output_dir = "./public"
name = "pages-functions-with-config-file-app"
compatibility_date = "2024-01-01"

[vars]
VAR1 = "holiday"
VAR2 = "🪩 celebrate 🪩"

npx wrangler pages deploy --branch=staging

pages deploy --branch=<name_of_non_prod_branch> should apply preview specific configuration when deploying to the preview environment, if [env.preview] is specified in wrangler.toml

# wrangler.toml

pages_build_output_dir = "./public"
name = "pages-functions-with-config-file-app"
compatibility_date = "2024-01-01"

[vars]
VAR1 = "holiday"
VAR2 = "celebrate"

[env.preview]
[env.preview.vars]
VAR1 = "🌤️ holiday 🌤️"
VAR2 = "🤸🏻 celebrate 🤸🏻"

[env.production]
[env.production.vars]
VAR1 = "🏖️ holiday 🏖️"
VAR2 = "🥳 celebrate 🥳"

npx wrangler pages deploy --branch=staging

pages deploy --branch=<name_of_non_prod_branch> should fallback to top-level configuration when deploying to the preview environment, if [env.preview] is not specified in wrangler.toml

# wrangler.toml

pages_build_output_dir = "./public"
name = "pages-functions-with-config-file-app"
compatibility_date = "2024-01-01"

[vars]
VAR1 = "holiday"
VAR2 = "🪩 celebrate 🪩"

npx wrangler pages deploy --branch=staging

pages deploy should apply inheritable environment config specified in wrangler.toml, specific to the environment targeted by the deployment

pages deploy should apply non-inheritable environment config specified in wrangler.toml, specific to the environment targeted by the deployment

pages deploy should override wrangler.toml config with cmd line args

# wrangler.toml

pages_build_output_dir = "./dist"
name = "pages-functions-app"
compatibility_date = "2024-01-01"

npx wrangler pages deploy public --project-name=pages-functions-with-config-file-app

pages deploy should allow existing Pages projects to opt in using a config file

deploy new project without wrangler.toml

npx wrangler pages deploy public --project-name=pages-functions-with-config-file-app

add wrangler.toml file and re-deploy

# wrangler.toml

pages_build_output_dir = "./public"
name = "pages-functions-with-config-file-app"
compatibility_date = "2024-01-01"

[vars]
VAR1 = "holiday"
VAR2 = "celebrate"

npx wrangler pages deploy

pages deploy should allow existing Pages projects to opt out of using a config file

changeset-bot · 2024-03-26T08:04:28Z

🦋 Changeset detected

Latest commit: 2bde607

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 · 2024-03-26T08:07:00Z

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/8541501264/npm-package-wrangler-5377

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

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

Or you can use npx with this latest build directly:

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

Additional artifacts:

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

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

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

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

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

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

wrangler@3.44.0 includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	3.20240329.0
`workerd`	1.20240329.0	1.20240329.0
`workerd --version`	1.20240329.0	2024-03-29

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

petebacondarwin · 2024-03-26T15:47:26Z

@CarmenPopoviciu - just realised that we can't error when wrangler.toml has no pages_output_dir field because that would break the flow of projects that currently have a wrangler.toml in place for other purpose (such as getPlatformProxy()). Instead we should warn and continue, ignoring the wrangler.toml config.

codecov · 2024-03-27T19:31:25Z

Codecov Report

Attention: Patch coverage is 67.81609% with 28 lines in your changes are missing coverage. Please review.

Project coverage is 72.28%. Comparing base (489b9c5) to head (2bde607).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5377   +/-   ##
=======================================
  Coverage   72.28%   72.28%           
=======================================
  Files         331      331           
  Lines       17004    17062   +58     
  Branches     4328     4352   +24     
=======================================
+ Hits        12291    12333   +42     
- Misses       4713     4729   +16

Files	Coverage Δ
packages/wrangler/src/config/index.ts	`88.65% <100.00%> (+0.05%)`	⬆️
packages/wrangler/src/pages/dev.ts	`29.81% <100.00%> (ø)`
packages/wrangler/src/api/pages/deploy.tsx	`88.88% <96.00%> (+2.52%)`	⬆️
packages/wrangler/src/config/validation-pages.ts	`97.91% <83.33%> (+0.24%)`	⬆️
packages/wrangler/src/pages/deploy.tsx	`49.57% <50.94%> (+1.89%)`	⬆️

... and 1 file with indirect coverage changes

CarmenPopoviciu · 2024-03-28T08:59:00Z

@dario-piotrowicz we kept this as a warning, but I changed the message based on our conversation. Let me know what you think of it <3

CarmenPopoviciu · 2024-03-28T18:22:28Z

+	const accountId = await requireAuth(configCache);

-	projectName ??= config.project_name;
+	let projectName =


// TODO @CarmenPopoviciu
if the project specified by wrangler.toml's name does not exist, pages deploy will fail, because we're attempting to get the project here. In combination with the name field being mandatory, and Pages toml validation throwing an err if field is missing, this basically puts us in the position where we can not deploy new Pages projects with a wrangler.toml file, only existing ones.

We should instead warn that the project doesn't exist and offer users the option of us creating the project for them, like we do for projects without a config file

fixed, YAY 🎉 😍 ! Will add some comprehensive tests tomorrow and link here

turns out writing tests for interactive pages deploy is not as trivial as I thought, mainly because we're doing some funky prompting that is hard to mock. Will address this as a followup

penalosa

One nit, but LGTM!

hrueger · 2024-04-04T08:23:37Z

Hi all,
very excited for this feature 😃🎉 Is that expected to already work? I tried it yesterday right after the release and while it did guide me through updating the wrangler.toml file accordingly, created the project and uploaded the content just fine, it did not set my bindings...

PS: pages_build_output_diris missing in the json schema from the json schema store which makes usage with the Even Better Toml extension in VSCode a bit annoying 😉 (probably linked to #3166)

petebacondarwin · 2024-04-04T09:29:21Z

Hey @hrueger - thanks for your interest in trying this out!

We had not released all the pieces of the backend to this last night.
The announcement (look out for a CF blog post!) later today.
Once that is out, then it should all start working.

Please do give it a full work out and report any problems you have to us as GH issues, so that we can follow up and fix.

petebacondarwin · 2024-04-04T09:30:54Z

Good call on the json schema - we'll look into fixing that up.

CarmenPopoviciu requested review from a team as code owners March 26, 2024 08:04

CarmenPopoviciu commented Mar 26, 2024

View reviewed changes

Comment thread packages/wrangler/src/pages/deploy.tsx Outdated

CarmenPopoviciu commented Mar 26, 2024

View reviewed changes

Comment thread packages/wrangler/src/pages/deploy.tsx Outdated

CarmenPopoviciu commented Mar 26, 2024

View reviewed changes

Comment thread packages/wrangler/src/pages/deploy.tsx Outdated

penalosa reviewed Mar 26, 2024

View reviewed changes

Comment thread packages/wrangler/src/api/pages/deploy.tsx Outdated

Comment thread packages/wrangler/src/pages/deploy.tsx Outdated

Comment thread packages/wrangler/src/pages/deploy.tsx Outdated

Comment thread packages/wrangler/src/pages/deploy.tsx Outdated

CarmenPopoviciu force-pushed the carmen/pages-config-deploy branch 3 times, most recently from 8f8be4c to 05c9235 Compare March 27, 2024 19:12

CarmenPopoviciu commented Mar 28, 2024

View reviewed changes

CarmenPopoviciu force-pushed the carmen/pages-config-deploy branch from 05c9235 to 81b21ec Compare March 28, 2024 16:22

CarmenPopoviciu commented Mar 28, 2024

View reviewed changes

CarmenPopoviciu force-pushed the carmen/pages-config-deploy branch from 81b21ec to 73bef08 Compare April 1, 2024 18:06

CarmenPopoviciu changed the title ~~[WIP] Add wrangler.toml support in pages deploy~~ Add wrangler.toml support in pages deploy Apr 1, 2024

CarmenPopoviciu commented Apr 1, 2024

View reviewed changes

Comment thread packages/wrangler/src/api/pages/deploy.tsx Outdated

CarmenPopoviciu commented Apr 1, 2024

View reviewed changes

Comment thread packages/wrangler/src/config/index.ts Outdated

CarmenPopoviciu commented Apr 1, 2024

View reviewed changes

Comment thread packages/wrangler/src/__tests__/pages/deploy.test.ts Outdated

CarmenPopoviciu commented Apr 1, 2024

View reviewed changes

Comment thread packages/wrangler/src/__tests__/pages/deploy.test.ts Outdated

CarmenPopoviciu added the ldw-exempt PRs marked with this label can be included in releases during LDW. label Apr 1, 2024

CarmenPopoviciu force-pushed the carmen/pages-config-deploy branch from 73bef08 to e1902e3 Compare April 1, 2024 18:56

penalosa reviewed Apr 2, 2024

View reviewed changes

Comment thread packages/wrangler/src/pages/dev.ts

Comment thread packages/wrangler/src/api/pages/deploy.tsx Outdated

Comment thread packages/wrangler/src/config/index.ts Outdated

Comment thread packages/wrangler/src/config/index.ts Outdated

CarmenPopoviciu force-pushed the carmen/pages-config-deploy branch 2 times, most recently from 2c587bb to e945b6d Compare April 3, 2024 13:06

penalosa approved these changes Apr 3, 2024

View reviewed changes

Comment thread packages/wrangler/src/api/pages/deploy.tsx Outdated

petebacondarwin reviewed Apr 3, 2024

View reviewed changes

[WIP] Add wrangler.toml support in pages deploy

56039c2

CarmenPopoviciu added 2 commits April 3, 2024 17:35

PR review fixes

678e38b

PR review fixes 2

2bde607

CarmenPopoviciu force-pushed the carmen/pages-config-deploy branch from e945b6d to 2bde607 Compare April 3, 2024 15:35

CarmenPopoviciu merged commit 5d68744 into main Apr 3, 2024

CarmenPopoviciu deleted the carmen/pages-config-deploy branch April 3, 2024 16:24

workers-devprod mentioned this pull request Apr 3, 2024

Version Packages #5485

Merged

hrueger mentioned this pull request Apr 4, 2024

🐛 BUG (Pages): R2 Jurisdiction in wrangler.toml produces failed deployments #5513

Closed

Conversation

CarmenPopoviciu commented Mar 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR solves / how to test

Author has addressed the following

Test Plan 🚀

Uh oh!

changeset-bot Bot commented Mar 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Uh oh!

github-actions Bot commented Mar 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

petebacondarwin commented Mar 26, 2024

Uh oh!

codecov Bot commented Mar 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

CarmenPopoviciu Mar 28, 2024

Choose a reason for hiding this comment

Uh oh!

CarmenPopoviciu Mar 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CarmenPopoviciu Apr 1, 2024

Choose a reason for hiding this comment

Uh oh!

CarmenPopoviciu Apr 3, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

penalosa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hrueger commented Apr 4, 2024

Uh oh!

petebacondarwin commented Apr 4, 2024

Uh oh!

petebacondarwin commented Apr 4, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

CarmenPopoviciu commented Mar 26, 2024 •

edited

Loading

changeset-bot Bot commented Mar 26, 2024 •

edited

Loading

github-actions Bot commented Mar 26, 2024 •

edited

Loading

codecov Bot commented Mar 27, 2024 •

edited

Loading

CarmenPopoviciu Mar 28, 2024 •

edited

Loading