Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more helpful error messages when validating compatibility date #7002

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

GregBrimble
Copy link
Member

What this PR solves / how to test

Fixes WC-2854.

image

image

Author has addressed the following

  • 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: no e2e coverage
  • Changeset (Changeset guidelines)
    • TODO (before merge)
    • Changeset included
    • Changeset not necessary because:
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Documentation not necessary because: just adding better errors :)

@GregBrimble GregBrimble requested a review from a team as a code owner October 17, 2024 04:49
Copy link

changeset-bot bot commented Oct 17, 2024

🦋 Changeset detected

Latest commit: 6eea915

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

Copy link
Contributor

github-actions bot commented Oct 17, 2024

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/11391598061/npm-package-wrangler-7002

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11391598061/npm-package-wrangler-7002 dev path/to/script.js
Additional artifacts:
npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11391598061/npm-package-create-cloudflare-7002 --no-auto-update
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11391598061/npm-package-cloudflare-kv-asset-handler-7002
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11391598061/npm-package-miniflare-7002
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11391598061/npm-package-cloudflare-pages-shared-7002
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11391598061/npm-package-cloudflare-vitest-pool-workers-7002
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11391598061/npm-package-cloudflare-workers-editor-shared-7002
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11391598061/npm-package-cloudflare-workers-shared-7002

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.20241011.0
workerd 1.20241011.1 1.20241011.1
workerd --version 1.20241011.1 2024-10-11

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

"wrangler": patch
---

feat: More helpful error messages when validating compatibility date
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
feat: More helpful error messages when validating compatibility date
fix: More helpful error messages when validating compatibility date

return !isNaN(data.getTime());
};

const validateCompatibilityDate: ValidatorFn = (diagnostics, field, value) => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's make sure we surface all errors on first throw, as opposed to one per cmd run. See my comment here. It makes for a much better UX and it's something we're pushing for since recently.

validateAssetsConfig is a good example of how'd like things to work

value.includes("—") // em-dash
) {
diagnostics.errors.push(
`Hyphens (-) should be used rather than en-dashes (—) or em-dashes (–) in the "${field}" field.`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`Hyphens (-) should be used rather than en-dashes (—) or em-dashes (–) in the "${field}" field.`
`"${field}" field should use hyphens (-) rather than en-dashes (—) or em-dashes (–).`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Review
Development

Successfully merging this pull request may close these issues.

2 participants