WC-5233 use patch apis for wrangler preview secret commands - #15043
Open
podonnell-dev wants to merge 3 commits into
Open
WC-5233 use patch apis for wrangler preview secret commands#15043podonnell-dev wants to merge 3 commits into
wrangler preview secret commands#15043podonnell-dev wants to merge 3 commits into
Conversation
🦋 Changeset detectedLatest commit: 7b3c9db The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
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 |
workers-devprod
requested review from
a team and
jamesopstad
and removed request for
a team
August 5, 2026 16:49
Contributor
|
Codeowners approval required for this PR:
Show detailed file reviewers
|
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
podonnell-dev
commented
Aug 5, 2026
| PREVIEW_NOT_FOUND_ERR_CODE, | ||
| previewNotFoundMessage, | ||
| resolvePreviewName, | ||
| } from "./index"; |
Author
There was a problem hiding this comment.
open to making this easier to distinguish - maybe a shared.ts or something similar
GregBrimble
reviewed
Aug 5, 2026
| ); | ||
| } | ||
|
|
||
| function mockGetPreviewDeploymentError(code: number) { |
Contributor
There was a problem hiding this comment.
diff between this and mockPreviewDeploymentNotFound?
GregBrimble
reviewed
Aug 5, 2026
| expect, | ||
| }) => { | ||
| mockStdIn.send("preview-secret"); | ||
| let patchedPreviewDefaults = false; |
Contributor
There was a problem hiding this comment.
don't really need the assertion that we aren't patching preview defaults any more. that's just cruft lying around from the previous design.
GregBrimble
reviewed
Aug 5, 2026
Comment on lines
+417
to
+459
| test("reads the latest Preview deployment and lists secrets as JSON", async ({ | ||
| expect, | ||
| }) => { | ||
| let requestUrl: string | undefined; | ||
| mockGetLatestPreviewDeployment( | ||
| { | ||
| DB_PASSWORD: { type: "secret_text" }, | ||
| API_KEY: { type: "secret_text" }, | ||
| PUBLIC_VAR: { type: "plain_text", text: "visible" }, | ||
| }, | ||
| ({ url }) => { | ||
| requestUrl = url; | ||
| } | ||
| ); | ||
| await runWrangler( | ||
| "preview secret list --json --worker-name test-worker" | ||
| "preview secret list --json --name test-preview --worker-name test-worker" | ||
| ); | ||
| expect(requestUrl).toContain( | ||
| "/workers/workers/test-worker/previews/test-preview/deployments/latest" | ||
| ); | ||
| expect(std.out).toContain('"name": "DB_PASSWORD"'); | ||
| expect(std.out).toContain('"name": "API_KEY"'); | ||
| expect(std.out).toContain('"type": "secret_text"'); | ||
| expect(std.out).not.toContain("PUBLIC_VAR"); | ||
| }); | ||
|
|
||
| test("should list secrets in pretty format", async ({ expect }) => { | ||
| msw.use( | ||
| http.get(`*/accounts/:accountId/workers/workers/:workerId`, () => | ||
| HttpResponse.json({ | ||
| success: true, | ||
| result: { | ||
| preview_defaults: { | ||
| env: { | ||
| MY_SECRET: { type: "secret_text" }, | ||
| PLAIN: { type: "plain_text", text: "not-a-secret" }, | ||
| }, | ||
| }, | ||
| }, | ||
| }) | ||
| ) | ||
| test("should list secrets in pretty format with values masked", async ({ | ||
| expect, | ||
| }) => { | ||
| mockGetLatestPreviewDeployment({ | ||
| MY_SECRET: { type: "secret_text", text: "super-secret-value" }, | ||
| PLAIN: { type: "plain_text", text: "not-a-secret" }, | ||
| }); | ||
| await runWrangler( | ||
| "preview secret list --name test-preview --worker-name test-worker" | ||
| ); | ||
| await runWrangler("preview secret list --worker-name test-worker"); | ||
| expect(std.out).toContain("Worker: test-worker"); | ||
| expect(std.out).toContain("Previews settings"); | ||
| expect(std.out).toContain("Secrets"); | ||
| expect(std.out).toContain("MY_SECRET"); | ||
| expect(std.out).not.toContain("PLAIN"); | ||
| expect(std.out).toContain("********"); | ||
| expect(std.out).not.toContain("super-secret-value"); | ||
| }); |
Contributor
There was a problem hiding this comment.
maybe a matrix test for "can handle no text value provided" vs. "masks text value if provided" and "json" vs. "pretty"?
GregBrimble
reviewed
Aug 5, 2026
| ); | ||
| }); | ||
|
|
||
| test("creates a deployment with an empty patch for null-only input", async ({ |
Contributor
There was a problem hiding this comment.
is skipping over null values current behavior?
if they're all null, should we error as if no input was provided?
GregBrimble
reviewed
Aug 5, 2026
| export const previewSecretBulkCommand = createCommand({ | ||
| metadata: { | ||
| description: | ||
| "Upload multiple secrets to a Worker Preview's latest deployment", |
Contributor
There was a problem hiding this comment.
Suggested change
| "Upload multiple secrets to a Worker Preview's latest deployment", | |
| "Upload multiple secrets to a Worker Preview and create a new deployment", |
GregBrimble
reviewed
Aug 5, 2026
| export const previewSecretDeleteCommand = createCommand({ | ||
| metadata: { | ||
| description: | ||
| "Delete a secret variable from a Worker Preview's latest deployment", |
Contributor
There was a problem hiding this comment.
Suggested change
| "Delete a secret variable from a Worker Preview's latest deployment", | |
| "Delete a secret variable from a Worker Preview and create a new deployment", |
GregBrimble
approved these changes
Aug 5, 2026
GregBrimble
left a comment
GregBrimble
left a comment
Contributor
There was a problem hiding this comment.
Only other thing I'd consider testing is: no preview name provided and not in a git worktree.
| export const noPreviewDeploymentPatchMessage = (previewName: string) => | ||
| `There are currently no deployments for the Preview "${previewName}". Please create a Preview deployment before modifying a secret.`; | ||
| export const noPreviewDeploymentListMessage = (previewName: string) => | ||
| `There are currently no deployments for the Preview "${previewName}" - please create a Preview deployment.`; |
Contributor
There was a problem hiding this comment.
Suggested change
| `There are currently no deployments for the Preview "${previewName}" - please create a Preview deployment.`; | |
| `There are currently no deployments for the Preview "${previewName}". Please create a Preview deployment.`; |
✨ consistency ✨
dario-piotrowicz
requested review from
dario-piotrowicz
and removed request for
jamesopstad
August 6, 2026 11:05
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes WC-5233
Use PATCH APIs for wrangler
preview secretcommands. Removing the dependence onpreview_defaults- all preview secret commands now patch secrets for the latest preview deployment. Also adjusted file conventions to match #14448 more closelyReviewable, but ask Patrick before merging - we'll be trying to time this release for next week
A picture of a cute animal (not mandatory, but encouraged)