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.

Sign up for GitHub

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

Jump to bottom

feat: allowlist some types defaults #8130

Merged
merged 4 commits into from
Feb 13, 2025
Merged

feat: allowlist some types defaults #8130

merged 4 commits into from
Feb 13, 2025

Conversation

emily-shen
Copy link
Contributor

@emily-shen emily-shen commented Feb 13, 2025 •
edited
Loading

Include default values for wrangler types --path and --x-include-runtime in telemetry

User provided strings are still left redacted as always.

Note i've also tested this manually for wrangler types

  • 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: metrics
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Documentation not necessary because: expanding documented behaviour

@emily-shen emily-shen requested a review from a team as a code owner February 13, 2025 11:06
@changeset-bot changeset-bot
Copy link

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

🦋 Changeset detected

Latest commit: 6b15d37

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

@github-actions GitHub Actions
Copy link
Contributor

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

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/13313097367/npm-package-wrangler-8130

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

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

Or you can use npx with this latest build directly:

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

cloudflare-workers-bindings-extension:

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

create-cloudflare:

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

@cloudflare/kv-asset-handler:

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

miniflare:

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

@cloudflare/pages-shared:

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

@cloudflare/unenv-preset:

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

@cloudflare/vite-plugin:

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

@cloudflare/vitest-pool-workers:

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

@cloudflare/workers-editor-shared:

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

@cloudflare/workers-shared:

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

@cloudflare/workflows-shared:

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

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.

penalosa
penalosa reviewed Feb 13, 2025
View reviewed changes
packages/wrangler/src/metrics/metrics-dispatcher.ts Outdated Show resolved Hide resolved
packages/wrangler/src/metrics/metrics-dispatcher.ts Outdated Show resolved Hide resolved
packages/wrangler/src/metrics/metrics-dispatcher.ts Outdated
Comment on lines 289 to 299
} else if (
typeof value === "string" &&
!(allowedValuesForArg === "*" || allowedValuesForArg.includes(value))
) {
result[key] = "<REDACTED>";
} else if (Array.isArray(value)) {
result[key] = value.map((v) =>
typeof v === "string" ? "<REDACTED>" : v
typeof v === "string" &&
!(allowedValuesForArg === "*" || allowedValuesForArg.includes(v))
? "<REDACTED>"
: v
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you add some comments explaining this logic? It's gotten pretty hairy—but be nice if there was a way to simplify

Copy link
Contributor Author

@emily-shen emily-shen Feb 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

yeah i'd like to tidy all of this up, because the sanitise + redact + normalise functions have gotten very redundant and messy. Would you be okay with leaving it for now so I can start collecting metrics, and doing that in a fast follow this afternooon?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

depends how long until the release really 😅

Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good--let's get this in as-is for the current release

@penalosa penalosa merged commit 1aa2a91 into main Feb 13, 2025
51 checks passed
@penalosa penalosa deleted the emily/types-metrics branch February 13, 2025 18:24
@workers-devprod workers-devprod mentioned this pull request Feb 13, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@penalosa penalosa penalosa approved these changes

Assignees
No one assigned
Labels
None yet
Projects
workers-sdk
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@emily-shen @penalosa