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

chore: include banner in output of tests for commands with json/pretty mode #8109

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

emily-shen
Copy link
Contributor

@emily-shen emily-shen commented Feb 12, 2025

The wrangler banner is normally mocked in tests so it isn't included in the console output that we check. However, we do want to test for the absence of the banner when a particular command has a 'json' mode where the output should be json only.

This PR adds/updates tests for d1 and tail commands that have a 'json' option.
There may be some commands that have an implicit guarantee that they output json without a separate flag, but I don't have a good way of identifying those - secret list now has tests for it but there may be others?

This should ensure issues like #7487 and #8101 don't happen again 😅


  • Tests
    • TODO (before merge)
    • Tests included
    • Tests not necessary because: change to tests
  • Wrangler E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required
    • Not required because: only change unit tests
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Documentation not necessary because: test change

@emily-shen emily-shen requested review from a team as code owners February 12, 2025 10:38
Copy link

changeset-bot bot commented Feb 12, 2025

⚠️ No Changeset found

Latest commit: 2404d4a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@emily-shen emily-shen marked this pull request as draft February 12, 2025 10:38
@@ -21,6 +21,9 @@ import type {
import type { RequestInit } from "undici";
import type WebSocket from "ws";

// we want to include the banner to make sure it doesn't show up in
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you mean:

Suggested change
// we want to include the banner to make sure it doesn't show up in
// we want to include the banner to make sure it shows up in

Copy link
Contributor

Choose a reason for hiding this comment

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

Also I have no clue about what "json mode" is?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i've update the comments and PR description, but tldr we want to test for the absence of the banner, so we need to enable banner printing in the first place

Copy link
Contributor

github-actions bot commented Feb 12, 2025

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/13285046202/npm-package-wrangler-8109

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13285046202/npm-package-wrangler-8109 dev path/to/script.js
Additional artifacts:

cloudflare-workers-bindings-extension:

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

create-cloudflare:

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

@cloudflare/kv-asset-handler:

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

miniflare:

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

@cloudflare/pages-shared:

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

@cloudflare/unenv-preset:

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

@cloudflare/vite-plugin:

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

@cloudflare/vitest-pool-workers:

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

@cloudflare/workers-editor-shared:

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

@cloudflare/workers-shared:

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

@cloudflare/workflows-shared:

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

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.0
workerd 1.20250204.0 1.20250204.0
workerd --version 1.20250204.0 2025-02-04

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

@emily-shen emily-shen marked this pull request as ready for review February 12, 2025 12:14
@emily-shen emily-shen requested a review from a team as a code owner February 12, 2025 12:14
@Skye-31
Copy link
Contributor

Skye-31 commented Feb 12, 2025

Out of curiosity: instead of each command having to think about --json and conditionally add the banner, could printBanner() itself do that check?

@emily-shen
Copy link
Contributor Author

Out of curiosity: instead of each command having to think about --json and conditionally add the banner, could printBanner() itself do that check?

yeah? i don't know if it would be huge benefit at the moment as the switches are so inconsistent: sometimes we use --json and sometimes we use --format, and sometimes we just print json and hope we remember to not mess it up in the future 🙃
I think there's some standardising in v4, but there's still two default behaviours that vary command by command.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Approved
Development

Successfully merging this pull request may close these issues.

4 participants