Skip to content

Add purge queue command #8353

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
Merged
merged 2 commits into from
Mar 19, 2025
Merged

Add purge queue command #8353

merged 2 commits into from
Mar 19, 2025

Conversation

@jbwcloudflare
Copy link
Contributor

@jbwcloudflare jbwcloudflare commented Mar 4, 2025 •
edited
Loading

Fixes https://jira.cfdata.org/browse/MQ-851

Adds a new purge command to delete all messages in a Queue.

  • 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: covered by unit tests
  • Public documentation

@changeset-bot
Copy link

changeset-bot bot commented Mar 4, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: 09a96c9

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-project-automation github-project-automation bot moved this to Untriaged in workers-sdk Mar 4, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Mar 4, 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/13794363054/npm-package-wrangler-8353

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

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

Or you can use npx with this latest build directly:

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

cloudflare-workers-bindings-extension:

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

create-cloudflare:

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

@cloudflare/kv-asset-handler:

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

miniflare:

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

@cloudflare/pages-shared:

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

@cloudflare/unenv-preset:

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

@cloudflare/vite-plugin:

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

@cloudflare/vitest-pool-workers:

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

@cloudflare/workers-editor-shared:

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

@cloudflare/workers-shared:

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

@cloudflare/workflows-shared:

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

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.20250310.0
workerd 1.20250310.0 1.20250310.0
workerd --version 1.20250310.0 2025-03-10

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

@jbwcloudflare jbwcloudflare force-pushed the jwheeler/queues-purge branch from 3e043ee to f77e7e0 Compare March 10, 2025 15:59
@jbwcloudflare jbwcloudflare force-pushed the jwheeler/queues-purge branch from f77e7e0 to 30ec775 Compare March 10, 2025 16:06
@jbwcloudflare jbwcloudflare marked this pull request as ready for review March 10, 2025 16:39
@jbwcloudflare jbwcloudflare requested a review from a team as a code owner March 10, 2025 16:39
emily-shen
emily-shen reviewed Mar 11, 2025
View reviewed changes
packages/wrangler/src/queues/cli/commands/purge.ts Outdated
) {
const config = readConfig(args);

if (isInteractive()) {
Copy link
Contributor

@emily-shen emily-shen Mar 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

do you want to add a --force flag so there's a similar check in non-interactive mode?

Copy link
Contributor Author

@jbwcloudflare jbwcloudflare Mar 11, 2025

Choose a reason for hiding this comment

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

good call! I added the flag along with some better testing

packages/wrangler/src/queues/cli/commands/purge.ts Outdated

await purgeQueue(config, args.name);

logger.log(`Started a purge operation for Queue '${args.name}'`);
Copy link
Contributor

@emily-shen emily-shen Mar 11, 2025

Choose a reason for hiding this comment

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

nit: with that message I sort of expect there to be a Completed purge operation log eventually.
is the purge expected to take a while? how can the user confirm that this has succeeded/finished?

Copy link
Contributor Author

@jbwcloudflare jbwcloudflare Mar 11, 2025

Choose a reason for hiding this comment

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

I reworded this to avoid the confusion here!

@jbwcloudflare
Copy link
Contributor Author

jbwcloudflare commented Mar 11, 2025

@sdnts could you take a look tomorrow 🙏

@sdnts
Copy link
Contributor

sdnts commented Mar 12, 2025

I can't approve this but looks good to me!

@github-project-automation github-project-automation bot moved this from Untriaged to Approved in workers-sdk Mar 12, 2025
@penalosa penalosa merged commit c4fa349 into cloudflare:main Mar 19, 2025
14 of 17 checks passed
@github-project-automation github-project-automation bot moved this from Approved to Done in workers-sdk Mar 19, 2025
@workers-devprod workers-devprod mentioned this pull request Mar 19, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@emily-shen emily-shen emily-shen approved these changes

Assignees

No one assigned

Labels

None yet

Projects

workers-sdk
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jbwcloudflare @sdnts @emily-shen @penalosa