Refactor pipelines commands into separate files, rename some options by cmackenzie1 · Pull Request #7769 · cloudflare/workers-sdk

cmackenzie1 · 2025-01-14T23:10:39Z

Pipelines is currently in closed beta, renaming these without providing aliases should have limited to zero impact

Moving each of the subcommand handlers and options for each subcommand into its own file. This also renames many of the parameters to be more specific.

The following parameters have been renamed:

Previous Name	New Name
access-key-id	r2-access-key-id
secret-access-key	r2-secret-access-key
transform	transform-worker
r2	r2-bucket
prefix	r2-prefix
binding	enable-worker-binding
http	enable-http
authentication	require-http-auth
filename	file-template
filepath	partition-template

Adds the following new option for create and update commands:

--cors-origins           CORS origin allowlist for HTTP endpoint (use * for any origin)  [array]

Closes https://jira.cfdata.org/browse/PIPE-160.

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: Unit tests cover the change
Public documentation
- TODO (before merge)
- Cloudflare docs PR(s): Initial pipelines docs cloudflare-docs#18595
- Documentation not necessary because:

changeset-bot · 2025-01-14T23:10:44Z

🦋 Changeset detected

Latest commit: 6adab89

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 · 2025-01-14T23:25:43Z

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/13115864808/npm-package-wrangler-7769

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

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

Or you can use npx with this latest build directly:

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

Additional artifacts:

cloudflare-workers-bindings-extension:

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

create-cloudflare:

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

@cloudflare/kv-asset-handler:

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

miniflare:

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

@cloudflare/pages-shared:

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

@cloudflare/unenv-preset:

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

@cloudflare/vite-plugin:

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

@cloudflare/vitest-pool-workers:

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

@cloudflare/workers-editor-shared:

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

@cloudflare/workers-shared:

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

@cloudflare/workflows-shared:

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

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

wrangler@3.107.2 includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	3.20250129.0
`workerd`	1.20250129.0	1.20250129.0
`workerd --version`	1.20250129.0	2025-01-29

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

andyjessop

I have no comments on the code, as it looks like the functions have just been moved to separate files. The only thing it would be good to address here is the consistency in naming "Pipelines" vs "pipelines", "Workers" vs "workers". I believe we should always capitalise product names.

edmundhung

Looks good to me overall! Just a few minor suggestions.

Also, we’re migrating existing commands to a new setup as documented here. This isn’t blocking for this change, but just an FYI. 👍🏼

**Pipelines is currently in closed beta, renaming these without providing aliases _should_ have no impact** Moving each of the subcommand handlers and options for each subcommand into its own file. This also renames many of the parameters to be more specific. The following parameters have been renamed: | Previous Name | New Name | | ---- | ---- | | access-key-id | r2-access-key-id | | secret-access-key | r2-secret-access-key | | transform | transform-worker | | r2 | r2-bucket | | prefix | r2-prefix | | binding | enable-worker-binding | | http | enable-http | | authentication | require-http-auth | | filename | file-template | | filepath | partition-template | Adds the following new option for `create` and `update` commands: ``` --cors-origins CORS origin allowlist for HTTP endpoint (use * for any origin) [array] ``` Closes https://jira.cfdata.org/browse/PIPE-160.

This also replaces the use of retryOnError with a for-loop as retryOnError wasn't working as expected.

Previously this was nested under the `enableHttp` block which doesn't make sense if HTTP is already enabled and the user just wants to update the authentication or CORS settings.

Also split the previous changeset into two.

Co-authored-by: Edmund Hung <edmund@cloudflare.com>

Based on PR feedback, drop the metrics calls and use chalk.bold for CLI flag groups. Snapshots were updated for tests.

edmundhung

Looks good to me.

Co-authored-by: Edmund Hung <edmund@cloudflare.com>

cmackenzie1 force-pushed the cole/pipe-160-pipelines-cors branch from c9e676d to e7987d4 Compare January 14, 2025 23:11

cmackenzie1 self-assigned this Jan 14, 2025

cmackenzie1 requested review from hhoughgg, maheshwarip and oliy January 14, 2025 23:11

cmackenzie1 marked this pull request as ready for review January 14, 2025 23:45

cmackenzie1 requested a review from a team as a code owner January 14, 2025 23:45

CarmenPopoviciu reviewed Jan 15, 2025

View reviewed changes

Comment thread packages/wrangler/src/pipelines/cli/list.ts

cmackenzie1 requested a review from CarmenPopoviciu January 21, 2025 23:42

cmackenzie1 force-pushed the cole/pipe-160-pipelines-cors branch from 8661d52 to 133c4d2 Compare January 21, 2025 23:45

maheshwarip approved these changes Jan 22, 2025

View reviewed changes

cmackenzie1 force-pushed the cole/pipe-160-pipelines-cors branch 3 times, most recently from d10d5c9 to 33c4b28 Compare January 24, 2025 21:05

lrapoport-cf added the caretaking Priority for caretaking label Jan 25, 2025

andyjessop reviewed Jan 27, 2025

View reviewed changes

Comment thread .changeset/short-kids-hunt.md Outdated

andyjessop reviewed Jan 27, 2025

View reviewed changes

Comment thread packages/wrangler/src/__tests__/pipelines.test.ts Outdated

andyjessop reviewed Jan 27, 2025

View reviewed changes

Comment thread packages/wrangler/src/__tests__/pipelines.test.ts Outdated

Comment thread packages/wrangler/src/pipelines/cli/create.ts Outdated

cmackenzie1 requested a review from andyjessop January 27, 2025 17:31

cmackenzie1 force-pushed the cole/pipe-160-pipelines-cors branch from 7703b5c to 7669912 Compare January 27, 2025 18:36

edmundhung reviewed Jan 29, 2025

View reviewed changes

Comment thread .changeset/plenty-birds-melt.md Outdated

edmundhung reviewed Jan 29, 2025

View reviewed changes

cmackenzie1 added 6 commits January 29, 2025 10:15

Fix non-exported type

7dd2160

Add snapshot for create pipeline

284a41a

Add support for R2 staging, print banner for list cmd

fd76120

Refactor our verifyBucketAccess function

5a70d07

This also replaces the use of retryOnError with a for-loop as retryOnError wasn't working as expected.

Update CORS Origins when provided

1828dbc

Previously this was nested under the `enableHttp` block which doesn't make sense if HTTP is already enabled and the user just wants to update the authentication or CORS settings.

cmackenzie1 and others added 6 commits January 29, 2025 10:15

Add test for pipeline cors update

254bf4f

Fix default for partition template

d6a7682

remove defaults and rely on API defaults instead

2015a49

Use proper capitalization for Workers and Pipelines

9f1b00d

Also split the previous changeset into two.

Apply suggestions from code review

336e935

Co-authored-by: Edmund Hung <edmund@cloudflare.com>

Drop metrics calls, use chalk for CLI flag groups

3d3fad0

Based on PR feedback, drop the metrics calls and use chalk.bold for CLI flag groups. Snapshots were updated for tests.

cmackenzie1 force-pushed the cole/pipe-160-pipelines-cors branch from 68bb78a to 3d3fad0 Compare January 29, 2025 18:25

cmackenzie1 requested a review from edmundhung January 29, 2025 18:26

edmundhung approved these changes Jan 31, 2025

View reviewed changes

Comment thread .changeset/short-kids-hunt.md Outdated

Update .changeset/short-kids-hunt.md

6adab89

Co-authored-by: Edmund Hung <edmund@cloudflare.com>

cmackenzie1 merged commit 6abe69c into main Feb 4, 2025

cmackenzie1 deleted the cole/pipe-160-pipelines-cors branch February 4, 2025 16:53

workers-devprod mentioned this pull request Feb 4, 2025

Version Packages #8027

Merged

Conversation

cmackenzie1 commented Jan 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented Jan 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions Bot commented Jan 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andyjessop left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

edmundhung left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

edmundhung left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

cmackenzie1 commented Jan 14, 2025 •

edited

Loading

changeset-bot Bot commented Jan 14, 2025 •

edited

Loading

github-actions Bot commented Jan 14, 2025 •

edited

Loading