fix(wrangler): Show feedback on Pages Function upload failure #5819

CarmenPopoviciu · 2024-05-14T11:44:29Z

What this PR solves / how to test

Today, if uploading a Pages Function, or deploying a Pages project fails for whatever reason, there’s no feedback shown to the user. Worse yet, the shown message is misleading, saying the deployment was successful, when in fact it was not:

This PR ensures that moving forward, we provide users with:

the correct feedback with respect to their Pages deployment
the appropriate messaging depending on the status of their project's deployment status
the appropriate logs in case of a deployment failure

Fixes #3966 and WC-2090.

Before

After

success

failure

failure with log level set to debug

unknown deployment status

Author has addressed the following

Tests
- TODO (before merge)
- Included
- Not necessary because:
E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
- I don't know
- Required / Maybe required
- Not required because: no e2e tests changes were made
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: bug fix

changeset-bot · 2024-05-14T11:44:33Z

🦋 Changeset detected

Latest commit: 4cf2706

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

packages/wrangler/src/pages/deploy.tsx

GregBrimble

Thanks Carmen! Once you've got a sleep and cap added in to that loop, pretty much ready to merge, imo!

packages/wrangler/src/pages/deploy.tsx

github-actions · 2024-05-14T18:51:56Z

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/9099454586/npm-package-wrangler-5819

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

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

Or you can use npx with this latest build directly:

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

Additional artifacts:

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

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

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

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

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

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

wrangler@3.56.0 includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	3.20240512.0
`workerd`	1.20240512.0	1.20240512.0
`workerd --version`	1.20240512.0	2024-05-12

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

packages/wrangler/src/pages/deploy.tsx

WalshyDev · 2024-05-15T13:21:31Z

packages/wrangler/src/pages/deploy.tsx

+		logger.log(
+			`✨ Deployment complete! However, we couldn't ascertain the final status of your deployment.\n\n` +
+				`⚡️ Visit your deployment at ${deploymentResponse.url}\n` +
+				`⚡️ Check the deployment logs on the Cloudflare dashboard: https://dash.cloudflare.com/${accountId}/pages/view/${projectName}/${deploymentResponse.id}`


There are gonna be no logs here for DU users, they could see a green tick and red triangle but that's it. I probably wouldn't bother linking to dash

true, but given that we couldn't tell whether the deployment was successful or failed from within wrangler, I think there might be some value in linking to Dash. I changed the wording to Check the deployment details on ...

packages/wrangler/src/pages/deployments.tsx

packages/wrangler/src/pages/deploy.tsx

Today, if uploading a Pages Function, or deploying a Pages project fails for whatever reason, there’s no feedback shown to the user. Worse yet, the shown message is misleading, saying the deployment was successful, when in fact it was not: ``` ✨ Deployment complete! ``` This commit ensures that we provide users with: - the correct feedback with respect to their Pages deployment - the appropriate messaging depending on the status of their project's deployment status - the appropriate logs in case of a deployment failure

CarmenPopoviciu · 2024-05-15T17:00:44Z

thanks everyone for reviewing this PR and providing valuable feedback 🙏

wouterds · 2024-05-15T17:56:38Z

Bless you, finally I get a clear error message what's going wrong with my deploy 😌

Edit: this PR gets an honorable mention

CarmenPopoviciu · 2024-05-15T19:14:18Z

whoohooo! much awesomeness! so so happy this PR helps!

mvitorino · 2024-05-17T15:18:56Z

Shouldn't this provide a non-zero return code so ci/cd and other scripts would fail?
I get this:

npm run deploy  && echo "Deployment was successful" || echo "Deployment failed"

> XXXX@0.1.0 deploy
> wrangler pages deploy ./build/client

▲ [WARNING] Warning: Your working directory is a git repo and has uncommitted changes

  To silence this warning, pass in --commit-dirty=true

✨ Compiled Worker successfully
🌍  Uploading... (40/40)

✨ Success! Uploaded 0 files (40 already uploaded) (0.54 sec)

✨ Uploading Functions bundle
🌎 Deploying...
✘ [ERROR] Failed to publish your Function. Got error: Your R2 bucket does not exist (workers.api.error.bucket_not_found)

❌ Deployment failed!
🪵  Logs were written to "/Users/.../Library/Preferences/.wrangler/logs/wrangler-2024-05-17_15-15-33_047.log"
Deployment was successful

CarmenPopoviciu · 2024-05-17T17:04:16Z

ugh...not sure how I missed that 😅. Fix PR is here: #5862

Thx so much for catching that!

CarmenPopoviciu requested review from a team as code owners May 14, 2024 11:44

CarmenPopoviciu requested review from WalshyDev and GregBrimble May 14, 2024 11:44

CarmenPopoviciu commented May 14, 2024

View reviewed changes

packages/wrangler/src/pages/deploy.tsx Outdated Show resolved Hide resolved

CarmenPopoviciu commented May 14, 2024

View reviewed changes

packages/wrangler/src/pages/deploy.tsx Show resolved Hide resolved

CarmenPopoviciu commented May 14, 2024

View reviewed changes

packages/wrangler/src/pages/deploy.tsx Show resolved Hide resolved

CarmenPopoviciu commented May 14, 2024

View reviewed changes

packages/wrangler/src/pages/deploy.tsx Outdated Show resolved Hide resolved

CarmenPopoviciu force-pushed the carmen/fn-upload-failure branch 2 times, most recently from 3b95a95 to d27cbb3 Compare May 14, 2024 12:21

CarmenPopoviciu mentioned this pull request May 14, 2024

🐛 BUG: wrangler logs success for pages deploy even with Functions failures #3966

Closed

GregBrimble approved these changes May 14, 2024

View reviewed changes

WalshyDev approved these changes May 14, 2024

View reviewed changes

packages/wrangler/src/pages/deploy.tsx Outdated Show resolved Hide resolved

packages/wrangler/src/pages/deploy.tsx Outdated Show resolved Hide resolved

CarmenPopoviciu force-pushed the carmen/fn-upload-failure branch 2 times, most recently from a6f2ebc to 85b2070 Compare May 14, 2024 18:42

CarmenPopoviciu force-pushed the carmen/fn-upload-failure branch 4 times, most recently from 04a3438 to b82a877 Compare May 15, 2024 12:40

WalshyDev approved these changes May 15, 2024

View reviewed changes

jahands reviewed May 15, 2024

View reviewed changes

packages/wrangler/src/pages/deploy.tsx Outdated Show resolved Hide resolved

Carmen Popoviciu added 5 commits May 15, 2024 17:02

PR review feedback

dcf4ba9

fix tests

0ecf591

add tests

e2d030c

refactor tests

fc6ce82

CarmenPopoviciu force-pushed the carmen/fn-upload-failure branch from c7d11cf to 4803c0c Compare May 15, 2024 15:12

wouterds mentioned this pull request May 15, 2024

fix(core): simplify cloudflare wasm loading shikijs/shiki#670

Merged

PR review fixes 2

4cf2706

CarmenPopoviciu force-pushed the carmen/fn-upload-failure branch from 4803c0c to 4cf2706 Compare May 15, 2024 16:36

CarmenPopoviciu merged commit 63f7acb into main May 15, 2024
19 checks passed

CarmenPopoviciu deleted the carmen/fn-upload-failure branch May 15, 2024 17:01

workers-devprod mentioned this pull request May 16, 2024

Version Packages #5837

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(wrangler): Show feedback on Pages Function upload failure #5819

fix(wrangler): Show feedback on Pages Function upload failure #5819

CarmenPopoviciu commented May 14, 2024 •

edited

changeset-bot bot commented May 14, 2024 •

edited

GregBrimble left a comment

github-actions bot commented May 14, 2024 •

edited

WalshyDev May 15, 2024

CarmenPopoviciu May 15, 2024

CarmenPopoviciu commented May 15, 2024

wouterds commented May 15, 2024 •

edited

CarmenPopoviciu commented May 15, 2024

mvitorino commented May 17, 2024

CarmenPopoviciu commented May 17, 2024 •

edited

fix(wrangler): Show feedback on Pages Function upload failure #5819

fix(wrangler): Show feedback on Pages Function upload failure #5819

Conversation

CarmenPopoviciu commented May 14, 2024 • edited

What this PR solves / how to test

Author has addressed the following

changeset-bot bot commented May 14, 2024 • edited

🦋 Changeset detected

GregBrimble left a comment

Choose a reason for hiding this comment

github-actions bot commented May 14, 2024 • edited

WalshyDev May 15, 2024

Choose a reason for hiding this comment

CarmenPopoviciu May 15, 2024

Choose a reason for hiding this comment

CarmenPopoviciu commented May 15, 2024

wouterds commented May 15, 2024 • edited

CarmenPopoviciu commented May 15, 2024

mvitorino commented May 17, 2024

CarmenPopoviciu commented May 17, 2024 • edited

CarmenPopoviciu commented May 14, 2024 •

edited

changeset-bot bot commented May 14, 2024 •

edited

github-actions bot commented May 14, 2024 •

edited

wouterds commented May 15, 2024 •

edited

CarmenPopoviciu commented May 17, 2024 •

edited