feat: add --secrets-file parameter to wrangler versions upload #10896
+502
−2
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| "wrangler": minor | ||
| --- | ||
|
|
||
| feat: add `--secrets-file` parameter to `wrangler versions upload` | ||
|
|
||
| You can now upload secrets alongside your Worker code in a single operation using the `--secrets-file` parameter. The file format matches what's used by `wrangler versions secret bulk`, supporting both JSON and .env formats. | ||
|
|
||
| Example usage: | ||
|
|
||
| ```bash | ||
| wrangler versions upload --secrets-file .env.production | ||
| wrangler versions upload --secrets-file secrets.json | ||
| ``` | ||
|
|
||
| Secrets not included in the file will be inherited from the previous version, matching the behavior of `wrangler versions secret bulk`. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,255 @@ | ||
| import { writeFileSync } from "node:fs"; | ||
| import { http, HttpResponse } from "msw"; | ||
| import { beforeEach, describe, expect, it } from "vitest"; | ||
| import { mockAccountId, mockApiToken } from "../helpers/mock-account-id"; | ||
| import { mockConsoleMethods } from "../helpers/mock-console"; | ||
| import { createFetchResult, msw } from "../helpers/msw"; | ||
| import { runInTempDir } from "../helpers/run-in-tmp"; | ||
| import { runWrangler } from "../helpers/run-wrangler"; | ||
| import { writeWorkerSource } from "../helpers/write-worker-source"; | ||
| import { writeWranglerConfig } from "../helpers/write-wrangler-config"; | ||
|
|
||
| describe("versions upload --secrets-file", () => { | ||
| const std = mockConsoleMethods(); | ||
| runInTempDir(); | ||
| mockAccountId(); | ||
| mockApiToken(); | ||
|
|
||
| const workerName = "test-worker"; | ||
|
|
||
| function mockGetScript() { | ||
| msw.use( | ||
| http.get( | ||
| `*/accounts/:accountId/workers/services/:scriptName`, | ||
| ({ params }) => { | ||
| expect(params.scriptName).toEqual(workerName); | ||
|
|
||
| return HttpResponse.json( | ||
| createFetchResult({ | ||
| default_environment: { | ||
| script: { | ||
| last_deployed_from: "wrangler", | ||
| }, | ||
| }, | ||
| }) | ||
| ); | ||
| }, | ||
| { once: true } | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| beforeEach(() => { | ||
| writeWranglerConfig({ | ||
| name: workerName, | ||
| main: "./index.js", | ||
| }); | ||
| writeWorkerSource(); | ||
| }); | ||
|
|
||
| it("should upload secrets from a JSON file alongside the worker version", async () => { | ||
| mockGetScript(); | ||
| const secretsFile = "secrets.json"; | ||
| writeFileSync( | ||
| secretsFile, | ||
| JSON.stringify({ | ||
| SECRET1: "value1", | ||
| SECRET2: "value2", | ||
| }) | ||
| ); | ||
|
|
||
| msw.use( | ||
| http.post( | ||
| "*/accounts/:accountId/workers/scripts/:scriptName/versions", | ||
| async ({ request, params }) => { | ||
| expect(params.accountId).toEqual("some-account-id"); | ||
| expect(params.scriptName).toEqual(workerName); | ||
|
|
||
| const formData = await request.formData(); | ||
| const metadata = JSON.parse(formData.get("metadata") as string); | ||
|
|
||
| expect(metadata.bindings).toEqual([ | ||
| { | ||
| type: "secret_text", | ||
| name: "SECRET1", | ||
| text: "value1", | ||
| }, | ||
| { | ||
| type: "secret_text", | ||
| name: "SECRET2", | ||
| text: "value2", | ||
| }, | ||
| ]); | ||
|
|
||
| expect(metadata.keep_bindings).toEqual(["secret_key", "secret_text"]); | ||
|
|
||
| return HttpResponse.json( | ||
| createFetchResult({ | ||
| id: "version-id-123", | ||
| startup_time_ms: 100, | ||
| metadata: { | ||
| has_preview: false, | ||
| }, | ||
| }) | ||
| ); | ||
| }, | ||
| { once: true } | ||
| ) | ||
| ); | ||
|
|
||
| await runWrangler( | ||
| `versions upload --name ${workerName} --secrets-file ${secretsFile}` | ||
| ); | ||
|
|
||
| expect(std.out).toContain("Worker Startup Time:"); | ||
| }); | ||
|
|
||
| it("should upload secrets from a .env file alongside the worker version", async () => { | ||
| mockGetScript(); | ||
| const secretsFile = ".env.production"; | ||
| writeFileSync( | ||
| secretsFile, | ||
| `SECRET1=value1 | ||
| SECRET2=value2 | ||
| # Comment line | ||
| SECRET3=value3` | ||
| ); | ||
|
|
||
| msw.use( | ||
| http.post( | ||
| "*/accounts/:accountId/workers/scripts/:scriptName/versions", | ||
| async ({ request, params }) => { | ||
| expect(params.accountId).toEqual("some-account-id"); | ||
| expect(params.scriptName).toEqual(workerName); | ||
|
|
||
| const formData = await request.formData(); | ||
| const metadata = JSON.parse(formData.get("metadata") as string); | ||
|
|
||
| expect(metadata.bindings).toEqual( | ||
| expect.arrayContaining([ | ||
| { | ||
| type: "secret_text", | ||
| name: "SECRET1", | ||
| text: "value1", | ||
| }, | ||
| { | ||
| type: "secret_text", | ||
| name: "SECRET2", | ||
| text: "value2", | ||
| }, | ||
| { | ||
| type: "secret_text", | ||
| name: "SECRET3", | ||
| text: "value3", | ||
| }, | ||
| ]) | ||
| ); | ||
|
|
||
| expect(metadata.keep_bindings).toEqual(["secret_key", "secret_text"]); | ||
|
|
||
| return HttpResponse.json( | ||
| createFetchResult({ | ||
| id: "version-id-123", | ||
| startup_time_ms: 100, | ||
| metadata: { | ||
| has_preview: false, | ||
| }, | ||
| }) | ||
| ); | ||
| }, | ||
| { once: true } | ||
| ) | ||
| ); | ||
|
|
||
| await runWrangler( | ||
| `versions upload --name ${workerName} --secrets-file ${secretsFile}` | ||
| ); | ||
|
|
||
| expect(std.out).toContain("Worker Startup Time:"); | ||
| }); | ||
|
|
||
| it("should set keep_bindings to inherit non-provided secrets when providing secrets file", async () => { | ||
| mockGetScript(); | ||
| const secretsFile = "secrets.json"; | ||
| writeFileSync( | ||
| secretsFile, | ||
| JSON.stringify({ | ||
| MY_SECRET: "secret_value", | ||
| }) | ||
| ); | ||
|
|
||
| msw.use( | ||
| http.post( | ||
| "*/accounts/:accountId/workers/scripts/:scriptName/versions", | ||
| async ({ request }) => { | ||
| const formData = await request.formData(); | ||
| const metadata = JSON.parse(formData.get("metadata") as string); | ||
|
|
||
| expect(metadata.keep_bindings).toEqual(["secret_key", "secret_text"]); | ||
|
|
||
| return HttpResponse.json( | ||
| createFetchResult({ | ||
| id: "version-id-123", | ||
| startup_time_ms: 100, | ||
| metadata: { | ||
| has_preview: false, | ||
| }, | ||
| }) | ||
| ); | ||
| }, | ||
| { once: true } | ||
| ) | ||
| ); | ||
|
|
||
| await runWrangler( | ||
| `versions upload --name ${workerName} --secrets-file ${secretsFile}` | ||
| ); | ||
| }); | ||
|
|
||
| it("should inherit secrets when not providing secrets file", async () => { | ||
| mockGetScript(); | ||
| msw.use( | ||
| http.post( | ||
| "*/accounts/:accountId/workers/scripts/:scriptName/versions", | ||
| async ({ request }) => { | ||
| const formData = await request.formData(); | ||
| const metadata = JSON.parse(formData.get("metadata") as string); | ||
|
|
||
| expect(metadata.keep_bindings).toEqual(["secret_text", "secret_key"]); | ||
|
|
||
| return HttpResponse.json( | ||
| createFetchResult({ | ||
| id: "version-id-123", | ||
| startup_time_ms: 100, | ||
| metadata: { | ||
| has_preview: false, | ||
| }, | ||
| }) | ||
| ); | ||
| }, | ||
| { once: true } | ||
| ) | ||
| ); | ||
|
|
||
| await runWrangler(`versions upload --name ${workerName}`); | ||
| }); | ||
|
|
||
| it("should fail when secrets file does not exist", async () => { | ||
| await expect( | ||
| runWrangler( | ||
| `versions upload --name ${workerName} --secrets-file non-existent-file.json` | ||
| ) | ||
| ).rejects.toThrowError(); | ||
| }); | ||
|
|
||
| it("should fail when secrets file contains invalid JSON", async () => { | ||
| const secretsFile = "invalid.json"; | ||
| writeFileSync(secretsFile, "{ invalid json }"); | ||
|
|
||
| await expect( | ||
| runWrangler( | ||
| `versions upload --name ${workerName} --secrets-file ${secretsFile}` | ||
| ) | ||
| ).rejects.toThrowError(); | ||
| }); | ||
| }); |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this change is quite right. They cancel each other out.
When
keepSecretsis true (i.e. heresecretsFileis falsy) we automatically addsecret_keyandsecret_textto the keep_bindings field increateWorkerUploadForm().And here if
secretsFileis truthy, then we are explicitly addingsecret_keyandsecret_text.If we are saying that
secretsFileis the full source of truth for secrets then we should be settingkeepSecretsto false and not settingkeepBindingsat all.If we are saying that
secretsFilesis additive to the current secrets in the dashboard thenkeepSecretsshould always be true andkeepBindingsshould not be defined.From looking at how
wrangler versions secret bulkworks, we should not be treating the secetsFile as a source of truth but only additive. I think we should follow that here too.So I think this should be: