wrangler 0.0.0-e88a54e → 0.0.0-e89ee2a5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (174) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +47 -16
  3. package/bin/wrangler.js +123 -32
  4. package/kv-asset-handler.js +1 -0
  5. package/package.json +168 -86
  6. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  7. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  8. package/templates/__tests__/tsconfig.json +8 -0
  9. package/templates/checked-fetch.js +30 -0
  10. package/templates/facade.d.ts +17 -0
  11. package/templates/gitignore +167 -0
  12. package/templates/init-tests/test-jest-new-worker.js +23 -0
  13. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  14. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  15. package/templates/middleware/common.ts +67 -0
  16. package/templates/middleware/loader-modules.ts +136 -0
  17. package/templates/middleware/loader-sw.ts +229 -0
  18. package/templates/middleware/middleware-d1-beta.d.ts +3 -0
  19. package/templates/middleware/middleware-ensure-req-body-drained.ts +19 -0
  20. package/templates/middleware/middleware-miniflare3-json-error.ts +33 -0
  21. package/templates/middleware/middleware-multiworker-dev.d.ts +4 -0
  22. package/templates/middleware/middleware-multiworker-dev.ts +68 -0
  23. package/templates/middleware/middleware-pretty-error.ts +40 -0
  24. package/templates/middleware/middleware-scheduled.ts +15 -0
  25. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  26. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  27. package/templates/modules-watch-stub.js +4 -0
  28. package/templates/new-worker-scheduled.js +17 -0
  29. package/templates/new-worker-scheduled.ts +32 -0
  30. package/templates/new-worker.js +3 -3
  31. package/templates/new-worker.ts +22 -4
  32. package/templates/no-op-worker.js +10 -0
  33. package/templates/pages-dev-pipeline.ts +32 -0
  34. package/templates/pages-dev-util.ts +55 -0
  35. package/templates/pages-shim.ts +9 -0
  36. package/templates/pages-template-plugin.ts +190 -0
  37. package/templates/pages-template-worker.ts +198 -0
  38. package/templates/startDevWorker/InspectorProxyWorker.ts +661 -0
  39. package/templates/startDevWorker/ProxyWorker.ts +326 -0
  40. package/templates/tsconfig-sanity.ts +11 -0
  41. package/templates/tsconfig.init.json +105 -0
  42. package/templates/tsconfig.json +6 -103
  43. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  44. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  45. package/wrangler-dist/ProxyWorker.js +237 -0
  46. package/wrangler-dist/ProxyWorker.js.map +6 -0
  47. package/wrangler-dist/cli.d.ts +23948 -0
  48. package/wrangler-dist/cli.js +164439 -134006
  49. package/wrangler-dist/wasm-sync.wasm +0 -0
  50. package/import_meta_url.js +0 -3
  51. package/miniflare-config-stubs/.env.empty +0 -0
  52. package/miniflare-config-stubs/package.empty.json +0 -1
  53. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  54. package/miniflare-dist/index.mjs +0 -79
  55. package/miniflare-dist/index.mjs.map +0 -7
  56. package/pages/functions/buildWorker.ts +0 -62
  57. package/pages/functions/filepath-routing.test.ts +0 -223
  58. package/pages/functions/filepath-routing.ts +0 -181
  59. package/pages/functions/identifiers.ts +0 -78
  60. package/pages/functions/routes.ts +0 -151
  61. package/pages/functions/template-worker.ts +0 -130
  62. package/src/__tests__/configuration.test.ts +0 -2796
  63. package/src/__tests__/dev.test.tsx +0 -496
  64. package/src/__tests__/dev2.test.tsx +0 -154
  65. package/src/__tests__/guess-worker-format.test.ts +0 -58
  66. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  67. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  68. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  69. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  70. package/src/__tests__/helpers/mock-bin.ts +0 -36
  71. package/src/__tests__/helpers/mock-cfetch.ts +0 -207
  72. package/src/__tests__/helpers/mock-console.ts +0 -70
  73. package/src/__tests__/helpers/mock-dialogs.ts +0 -65
  74. package/src/__tests__/helpers/mock-kv.ts +0 -33
  75. package/src/__tests__/helpers/mock-stdin.ts +0 -103
  76. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  77. package/src/__tests__/helpers/run-in-tmp.ts +0 -32
  78. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  79. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  80. package/src/__tests__/https-options.test.ts +0 -127
  81. package/src/__tests__/index.test.ts +0 -991
  82. package/src/__tests__/jest.setup.ts +0 -69
  83. package/src/__tests__/kv.test.ts +0 -1382
  84. package/src/__tests__/logout.test.ts +0 -52
  85. package/src/__tests__/package-manager.test.ts +0 -206
  86. package/src/__tests__/pages.test.ts +0 -44
  87. package/src/__tests__/parse.test.ts +0 -322
  88. package/src/__tests__/publish.test.ts +0 -2704
  89. package/src/__tests__/r2.test.ts +0 -198
  90. package/src/__tests__/route.test.ts +0 -45
  91. package/src/__tests__/secret.test.ts +0 -425
  92. package/src/__tests__/sentry.test.ts +0 -146
  93. package/src/__tests__/tail.test.ts +0 -564
  94. package/src/__tests__/whoami.test.tsx +0 -100
  95. package/src/bundle.ts +0 -142
  96. package/src/cfetch/index.ts +0 -104
  97. package/src/cfetch/internal.ts +0 -139
  98. package/src/cli.ts +0 -19
  99. package/src/config/README.md +0 -107
  100. package/src/config/config.ts +0 -218
  101. package/src/config/diagnostics.ts +0 -80
  102. package/src/config/environment.ts +0 -366
  103. package/src/config/index.ts +0 -62
  104. package/src/config/validation-helpers.ts +0 -486
  105. package/src/config/validation.ts +0 -1090
  106. package/src/create-worker-preview.ts +0 -166
  107. package/src/create-worker-upload-form.ts +0 -217
  108. package/src/dev/dev.tsx +0 -364
  109. package/src/dev/local.tsx +0 -232
  110. package/src/dev/remote.tsx +0 -203
  111. package/src/dev/use-esbuild.ts +0 -100
  112. package/src/dialogs.tsx +0 -77
  113. package/src/entry.ts +0 -208
  114. package/src/environment-variables.ts +0 -33
  115. package/src/https-options.ts +0 -122
  116. package/src/index.tsx +0 -2373
  117. package/src/inspect.ts +0 -617
  118. package/src/kv.ts +0 -319
  119. package/src/miniflare-cli/README.md +0 -30
  120. package/src/miniflare-cli/enum-keys.ts +0 -17
  121. package/src/miniflare-cli/index.ts +0 -37
  122. package/src/module-collection.ts +0 -258
  123. package/src/open-in-browser.ts +0 -25
  124. package/src/package-manager.ts +0 -126
  125. package/src/pages.tsx +0 -1047
  126. package/src/parse.ts +0 -183
  127. package/src/paths.ts +0 -26
  128. package/src/proxy.ts +0 -440
  129. package/src/publish.ts +0 -347
  130. package/src/r2.ts +0 -50
  131. package/src/reporting.ts +0 -131
  132. package/src/selfsigned.d.ts +0 -29
  133. package/src/sites.tsx +0 -280
  134. package/src/tail/filters.ts +0 -279
  135. package/src/tail/index.ts +0 -299
  136. package/src/tail/printing.ts +0 -62
  137. package/src/user.tsx +0 -1118
  138. package/src/whoami.tsx +0 -69
  139. package/src/worker.ts +0 -163
  140. package/templates/static-asset-facade.js +0 -47
  141. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  142. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  143. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  144. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  145. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  146. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  147. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  148. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  149. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  150. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  151. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  152. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  153. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  154. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  155. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  156. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  157. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  158. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  159. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  160. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  161. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  162. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  163. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  164. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  165. package/vendor/wrangler-mime/LICENSE +0 -21
  166. package/vendor/wrangler-mime/Mime.js +0 -97
  167. package/vendor/wrangler-mime/README.md +0 -187
  168. package/vendor/wrangler-mime/cli.js +0 -46
  169. package/vendor/wrangler-mime/index.js +0 -4
  170. package/vendor/wrangler-mime/lite.js +0 -4
  171. package/vendor/wrangler-mime/package.json +0 -52
  172. package/vendor/wrangler-mime/types/other.js +0 -1
  173. package/vendor/wrangler-mime/types/standard.js +0 -1
  174. package/wrangler-dist/cli.js.map +0 -7
@@ -1,1382 +0,0 @@
1
- import { writeFileSync } from "node:fs";
2
- import { Headers } from "undici";
3
- import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
4
- import {
5
- setMockResponse,
6
- unsetAllMocks,
7
- unsetMockFetchKVGetValues,
8
- setMockFetchKVGetValue,
9
- } from "./helpers/mock-cfetch";
10
- import { mockConsoleMethods } from "./helpers/mock-console";
11
- import { mockConfirm } from "./helpers/mock-dialogs";
12
- import { mockKeyListRequest } from "./helpers/mock-kv";
13
- import { runInTempDir } from "./helpers/run-in-tmp";
14
- import { runWrangler } from "./helpers/run-wrangler";
15
- import type { KeyValue, KVNamespaceInfo, NamespaceKeyInfo } from "../kv";
16
-
17
- describe("wrangler", () => {
18
- mockAccountId();
19
- mockApiToken();
20
- runInTempDir();
21
- const std = mockConsoleMethods();
22
-
23
- afterEach(() => {
24
- unsetAllMocks();
25
- });
26
-
27
- describe("kv:namespace", () => {
28
- describe("create", () => {
29
- function mockCreateRequest(expectedTitle: string) {
30
- setMockResponse(
31
- "/accounts/:accountId/storage/kv/namespaces",
32
- "POST",
33
- ([_url, accountId], { body }) => {
34
- expect(accountId).toEqual("some-account-id");
35
- const title = JSON.parse(body as string).title;
36
- expect(title).toEqual(expectedTitle);
37
- return { id: "some-namespace-id" };
38
- }
39
- );
40
- }
41
-
42
- it("should error if no namespace is given", async () => {
43
- await expect(
44
- runWrangler("kv:namespace create")
45
- ).rejects.toThrowErrorMatchingInlineSnapshot(
46
- `"Not enough non-option arguments: got 0, need at least 1"`
47
- );
48
- expect(std.out).toMatchInlineSnapshot(`""`);
49
- expect(std.err).toMatchInlineSnapshot(`
50
- "wrangler kv:namespace create <namespace>
51
-
52
- Create a new namespace
53
-
54
- Positionals:
55
- namespace The name of the new namespace [string] [required]
56
-
57
- Flags:
58
- -c, --config Path to .toml configuration file [string]
59
- -h, --help Show help [boolean]
60
- -v, --version Show version number [boolean]
61
- --legacy-env Use legacy environments [boolean]
62
-
63
- Options:
64
- -e, --env Perform on a specific environment [string]
65
- --preview Interact with a preview namespace [boolean]
66
-
67
- Not enough non-option arguments: got 0, need at least 1"
68
- `);
69
- });
70
-
71
- it("should error if the namespace to create contains spaces", async () => {
72
- await expect(
73
- runWrangler("kv:namespace create abc def ghi")
74
- ).rejects.toThrowErrorMatchingInlineSnapshot(
75
- `"Unexpected additional positional arguments \\"def ghi\\"."`
76
- );
77
- expect(std.out).toMatchInlineSnapshot(`""`);
78
- expect(std.err).toMatchInlineSnapshot(`
79
- "wrangler kv:namespace create <namespace>
80
-
81
- Create a new namespace
82
-
83
- Positionals:
84
- namespace The name of the new namespace [string] [required]
85
-
86
- Flags:
87
- -c, --config Path to .toml configuration file [string]
88
- -h, --help Show help [boolean]
89
- -v, --version Show version number [boolean]
90
- --legacy-env Use legacy environments [boolean]
91
-
92
- Options:
93
- -e, --env Perform on a specific environment [string]
94
- --preview Interact with a preview namespace [boolean]
95
-
96
- Unexpected additional positional arguments \\"def ghi\\"."
97
- `);
98
- });
99
-
100
- it("should error if the namespace to create is not valid", async () => {
101
- await expect(
102
- runWrangler("kv:namespace create abc-def")
103
- ).rejects.toThrowErrorMatchingInlineSnapshot(
104
- `"The namespace binding name \\"abc-def\\" is invalid. It can only have alphanumeric and _ characters, and cannot begin with a number."`
105
- );
106
-
107
- expect(std.out).toMatchInlineSnapshot(`""`);
108
- expect(std.err).toMatchInlineSnapshot(`
109
- "wrangler kv:namespace create <namespace>
110
-
111
- Create a new namespace
112
-
113
- Positionals:
114
- namespace The name of the new namespace [string] [required]
115
-
116
- Flags:
117
- -c, --config Path to .toml configuration file [string]
118
- -h, --help Show help [boolean]
119
- -v, --version Show version number [boolean]
120
- --legacy-env Use legacy environments [boolean]
121
-
122
- Options:
123
- -e, --env Perform on a specific environment [string]
124
- --preview Interact with a preview namespace [boolean]
125
-
126
- The namespace binding name \\"abc-def\\" is invalid. It can only have alphanumeric and _ characters, and cannot begin with a number."
127
- `);
128
- });
129
-
130
- it("should create a namespace", async () => {
131
- mockCreateRequest("worker-UnitTestNamespace");
132
- await runWrangler("kv:namespace create UnitTestNamespace");
133
- expect(std.out).toMatchInlineSnapshot(`
134
- "🌀 Creating namespace with title \\"worker-UnitTestNamespace\\"
135
- ✨ Success!
136
- Add the following to your configuration file in your kv_namespaces array:
137
- { binding = \\"UnitTestNamespace\\", id = \\"some-namespace-id\\" }"
138
- `);
139
- });
140
-
141
- it("should create a preview namespace if configured to do so", async () => {
142
- mockCreateRequest("worker-UnitTestNamespace_preview");
143
- await runWrangler("kv:namespace create UnitTestNamespace --preview");
144
- expect(std.out).toMatchInlineSnapshot(`
145
- "🌀 Creating namespace with title \\"worker-UnitTestNamespace_preview\\"
146
- ✨ Success!
147
- Add the following to your configuration file in your kv_namespaces array:
148
- { binding = \\"UnitTestNamespace\\", preview_id = \\"some-namespace-id\\" }"
149
- `);
150
- });
151
-
152
- it("should create a namespace using configured worker name", async () => {
153
- writeFileSync("./wrangler.toml", 'name = "otherWorker"', "utf-8");
154
- mockCreateRequest("otherWorker-UnitTestNamespace");
155
- await runWrangler("kv:namespace create UnitTestNamespace");
156
- expect(std.out).toMatchInlineSnapshot(`
157
- "🌀 Creating namespace with title \\"otherWorker-UnitTestNamespace\\"
158
- ✨ Success!
159
- Add the following to your configuration file in your kv_namespaces array:
160
- { binding = \\"UnitTestNamespace\\", id = \\"some-namespace-id\\" }"
161
- `);
162
- });
163
-
164
- it("should create a namespace in an environment if configured to do so", async () => {
165
- mockCreateRequest("worker-customEnv-UnitTestNamespace");
166
- await runWrangler(
167
- "kv:namespace create UnitTestNamespace --env customEnv"
168
- );
169
- expect(std.out).toMatchInlineSnapshot(`
170
- "🌀 Creating namespace with title \\"worker-customEnv-UnitTestNamespace\\"
171
- ✨ Success!
172
- Add the following to your configuration file in your kv_namespaces array under [env.customEnv]:
173
- { binding = \\"UnitTestNamespace\\", id = \\"some-namespace-id\\" }"
174
- `);
175
- });
176
- });
177
-
178
- describe("list", () => {
179
- function mockListRequest(namespaces: unknown[]) {
180
- const requests = { count: 0 };
181
- setMockResponse(
182
- "/accounts/:accountId/storage/kv/namespaces",
183
- ([_url, accountId], init, query) => {
184
- requests.count++;
185
- expect(accountId).toEqual("some-account-id");
186
- expect(query.get("per_page")).toEqual("100");
187
- expect(query.get("order")).toEqual("title");
188
- expect(query.get("direction")).toEqual("asc");
189
- expect(query.get("page")).toEqual(`${requests.count}`);
190
- expect(init).toEqual({});
191
- const pageSize = Number(query.get("per_page"));
192
- const page = Number(query.get("page"));
193
- return namespaces.slice((page - 1) * pageSize, page * pageSize);
194
- }
195
- );
196
- return requests;
197
- }
198
-
199
- it("should list namespaces", async () => {
200
- const kvNamespaces: KVNamespaceInfo[] = [
201
- { title: "title-1", id: "id-1" },
202
- { title: "title-2", id: "id-2" },
203
- ];
204
- mockListRequest(kvNamespaces);
205
- await runWrangler("kv:namespace list");
206
-
207
- expect(std.err).toMatchInlineSnapshot(`""`);
208
- const namespaces = JSON.parse(std.out);
209
- expect(namespaces).toEqual(kvNamespaces);
210
- });
211
-
212
- it("should make multiple requests for paginated results", async () => {
213
- // Create a lot of mock namespaces, so that the fetch requests will be paginated
214
- const kvNamespaces: KVNamespaceInfo[] = [];
215
- for (let i = 0; i < 550; i++) {
216
- kvNamespaces.push({ title: "title-" + i, id: "id-" + i });
217
- }
218
- const requests = mockListRequest(kvNamespaces);
219
- await runWrangler("kv:namespace list");
220
- const namespaces = JSON.parse(std.out);
221
- expect(namespaces).toEqual(kvNamespaces);
222
- expect(requests.count).toEqual(6);
223
- });
224
- });
225
-
226
- describe("delete", () => {
227
- function mockDeleteRequest(expectedNamespaceId: string) {
228
- const requests = { count: 0 };
229
- setMockResponse(
230
- "/accounts/:accountId/storage/kv/namespaces/:namespaceId",
231
- "DELETE",
232
- ([_url, accountId, namespaceId]) => {
233
- requests.count++;
234
- expect(accountId).toEqual("some-account-id");
235
- expect(namespaceId).toEqual(expectedNamespaceId);
236
- return null;
237
- }
238
- );
239
- return requests;
240
- }
241
-
242
- it("should delete a namespace specified by id", async () => {
243
- const requests = mockDeleteRequest("some-namespace-id");
244
- await runWrangler(
245
- `kv:namespace delete --namespace-id some-namespace-id`
246
- );
247
- expect(requests.count).toEqual(1);
248
- });
249
-
250
- it("should delete a namespace specified by binding name", async () => {
251
- writeWranglerConfig();
252
- const requests = mockDeleteRequest("bound-id");
253
- await runWrangler(
254
- `kv:namespace delete --binding someBinding --preview false`
255
- );
256
- expect(requests.count).toEqual(1);
257
- });
258
-
259
- it("should delete a preview namespace specified by binding name", async () => {
260
- writeWranglerConfig();
261
- const requests = mockDeleteRequest("preview-bound-id");
262
- await runWrangler(
263
- `kv:namespace delete --binding someBinding --preview`
264
- );
265
- expect(requests.count).toEqual(1);
266
- });
267
-
268
- it("should error if a given binding name is not in the configured kv namespaces", async () => {
269
- writeWranglerConfig();
270
- await expect(runWrangler("kv:namespace delete --binding otherBinding"))
271
- .rejects.toThrowErrorMatchingInlineSnapshot(`
272
- "Not able to delete namespace.
273
- A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."
274
- `);
275
- expect(std.err).toMatchInlineSnapshot(`
276
- "wrangler kv:namespace delete
277
-
278
- Deletes a given namespace.
279
-
280
- Flags:
281
- -c, --config Path to .toml configuration file [string]
282
- -h, --help Show help [boolean]
283
- -v, --version Show version number [boolean]
284
- --legacy-env Use legacy environments [boolean]
285
-
286
- Options:
287
- --binding The name of the namespace to delete [string]
288
- --namespace-id The id of the namespace to delete [string]
289
- -e, --env Perform on a specific environment [string]
290
- --preview Interact with a preview namespace [boolean]
291
-
292
- Not able to delete namespace.
293
- A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."
294
- `);
295
- });
296
-
297
- it("should delete a namespace specified by binding name in a given environment", async () => {
298
- writeWranglerConfig();
299
- const requests = mockDeleteRequest("env-bound-id");
300
- await runWrangler(
301
- "kv:namespace delete --binding someBinding --env some-environment --preview false"
302
- );
303
-
304
- expect(std.out).toMatchInlineSnapshot(`""`);
305
- expect(std.err).toMatchInlineSnapshot(`""`);
306
- expect(requests.count).toEqual(1);
307
- });
308
-
309
- it("should delete a preview namespace specified by binding name in a given environment", async () => {
310
- writeWranglerConfig();
311
- const requests = mockDeleteRequest("preview-env-bound-id");
312
- await runWrangler(
313
- `kv:namespace delete --binding someBinding --env some-environment --preview`
314
- );
315
- expect(requests.count).toEqual(1);
316
- });
317
- });
318
- });
319
-
320
- describe("kv:key", () => {
321
- describe("put", () => {
322
- function mockKeyPutRequest(
323
- expectedNamespaceId: string,
324
- expectedKV: KeyValue
325
- ) {
326
- const requests = { count: 0 };
327
- setMockResponse(
328
- "/accounts/:accountId/storage/kv/namespaces/:namespaceId/values/:key",
329
- "PUT",
330
- ([_url, accountId, namespaceId, key], { body }, query) => {
331
- requests.count++;
332
- expect(accountId).toEqual("some-account-id");
333
- expect(namespaceId).toEqual(expectedNamespaceId);
334
- expect(key).toEqual(expectedKV.key);
335
- expect(body).toEqual(expectedKV.value);
336
- if (expectedKV.expiration !== undefined) {
337
- expect(query.get("expiration")).toEqual(
338
- `${expectedKV.expiration}`
339
- );
340
- } else {
341
- expect(query.has("expiration")).toBe(false);
342
- }
343
- if (expectedKV.expiration_ttl) {
344
- expect(query.get("expiration_ttl")).toEqual(
345
- `${expectedKV.expiration_ttl}`
346
- );
347
- } else {
348
- expect(query.has("expiration_ttl")).toBe(false);
349
- }
350
- return null;
351
- }
352
- );
353
- return requests;
354
- }
355
-
356
- it("should put a key in a given namespace specified by namespace-id", async () => {
357
- const requests = mockKeyPutRequest("some-namespace-id", {
358
- key: "my-key",
359
- value: "my-value",
360
- });
361
-
362
- await runWrangler(
363
- "kv:key put my-key my-value --namespace-id some-namespace-id"
364
- );
365
-
366
- expect(requests.count).toEqual(1);
367
- expect(std.out).toMatchInlineSnapshot(
368
- `"writing the value \\"my-value\\" to key \\"my-key\\" on namespace some-namespace-id"`
369
- );
370
- expect(std.err).toMatchInlineSnapshot(`""`);
371
- });
372
-
373
- it("should put a key in a given namespace specified by binding", async () => {
374
- writeWranglerConfig();
375
- const requests = mockKeyPutRequest("bound-id", {
376
- key: "my-key",
377
- value: "my-value",
378
- });
379
- await runWrangler(
380
- "kv:key put my-key my-value --binding someBinding --preview false"
381
- );
382
-
383
- expect(std.out).toMatchInlineSnapshot(
384
- `"writing the value \\"my-value\\" to key \\"my-key\\" on namespace bound-id"`
385
- );
386
- expect(std.err).toMatchInlineSnapshot(`""`);
387
- expect(requests.count).toEqual(1);
388
- });
389
-
390
- it("should put a key in a given preview namespace specified by binding", async () => {
391
- writeWranglerConfig();
392
- const requests = mockKeyPutRequest("preview-bound-id", {
393
- key: "my-key",
394
- value: "my-value",
395
- });
396
-
397
- await runWrangler(
398
- "kv:key put my-key my-value --binding someBinding --preview"
399
- );
400
-
401
- expect(std.out).toMatchInlineSnapshot(
402
- `"writing the value \\"my-value\\" to key \\"my-key\\" on namespace preview-bound-id"`
403
- );
404
- expect(std.err).toMatchInlineSnapshot(`""`);
405
- expect(requests.count).toEqual(1);
406
- });
407
-
408
- it("should add expiration and ttl properties when putting a key", async () => {
409
- const requests = mockKeyPutRequest("some-namespace-id", {
410
- key: "my-key",
411
- value: "my-value",
412
- expiration: 10,
413
- expiration_ttl: 20,
414
- });
415
- await runWrangler(
416
- "kv:key put my-key my-value --namespace-id some-namespace-id --expiration 10 --ttl 20"
417
- );
418
- expect(requests.count).toEqual(1);
419
- expect(std.out).toMatchInlineSnapshot(
420
- `"writing the value \\"my-value\\" to key \\"my-key\\" on namespace some-namespace-id"`
421
- );
422
- expect(std.err).toMatchInlineSnapshot(`""`);
423
- });
424
-
425
- it("should put a key to the specified environment in a given namespace", async () => {
426
- writeWranglerConfig();
427
- const requests = mockKeyPutRequest("env-bound-id", {
428
- key: "my-key",
429
- value: "my-value",
430
- });
431
- await runWrangler(
432
- "kv:key put my-key my-value --binding someBinding --env some-environment --preview false"
433
- );
434
- expect(std.out).toMatchInlineSnapshot(
435
- `"writing the value \\"my-value\\" to key \\"my-key\\" on namespace env-bound-id"`
436
- );
437
- expect(std.err).toMatchInlineSnapshot(`""`);
438
- expect(requests.count).toEqual(1);
439
- });
440
-
441
- it("should put a key with a value loaded from a given path", async () => {
442
- writeFileSync("foo.txt", "file-contents", "utf-8");
443
- const requests = mockKeyPutRequest("some-namespace-id", {
444
- key: "my-key",
445
- value: "file-contents",
446
- });
447
- await runWrangler(
448
- "kv:key put my-key --namespace-id some-namespace-id --path foo.txt"
449
- );
450
- expect(std.out).toMatchInlineSnapshot(
451
- `"writing the contents of foo.txt to the key \\"my-key\\" on namespace some-namespace-id"`
452
- );
453
- expect(std.err).toMatchInlineSnapshot(`""`);
454
- expect(requests.count).toEqual(1);
455
- });
456
-
457
- it("should error if no key is provided", async () => {
458
- await expect(
459
- runWrangler("kv:key put")
460
- ).rejects.toThrowErrorMatchingInlineSnapshot(
461
- `"Not enough non-option arguments: got 0, need at least 1"`
462
- );
463
-
464
- expect(std.out).toMatchInlineSnapshot(`""`);
465
- expect(std.err).toMatchInlineSnapshot(`
466
- "wrangler kv:key put <key> [value]
467
-
468
- Writes a single key/value pair to the given namespace.
469
-
470
- Positionals:
471
- key The key to write to [string] [required]
472
- value The value to write [string]
473
-
474
- Flags:
475
- -c, --config Path to .toml configuration file [string]
476
- -h, --help Show help [boolean]
477
- -v, --version Show version number [boolean]
478
- --legacy-env Use legacy environments [boolean]
479
-
480
- Options:
481
- --binding The binding of the namespace to write to [string]
482
- --namespace-id The id of the namespace to write to [string]
483
- -e, --env Perform on a specific environment [string]
484
- --preview Interact with a preview namespace [boolean]
485
- --ttl Time for which the entries should be visible [number]
486
- --expiration Time since the UNIX epoch after which the entry expires [number]
487
- --path Read value from the file at a given path [string]
488
-
489
- Not enough non-option arguments: got 0, need at least 1"
490
- `);
491
- });
492
-
493
- it("should error if no binding nor namespace is provided", async () => {
494
- await expect(
495
- runWrangler("kv:key put foo bar")
496
- ).rejects.toThrowErrorMatchingInlineSnapshot(
497
- `"Exactly one of the arguments binding and namespace-id is required"`
498
- );
499
-
500
- expect(std.out).toMatchInlineSnapshot(`""`);
501
- expect(std.err).toMatchInlineSnapshot(`
502
- "wrangler kv:key put <key> [value]
503
-
504
- Writes a single key/value pair to the given namespace.
505
-
506
- Positionals:
507
- key The key to write to [string] [required]
508
- value The value to write [string]
509
-
510
- Flags:
511
- -c, --config Path to .toml configuration file [string]
512
- -h, --help Show help [boolean]
513
- -v, --version Show version number [boolean]
514
- --legacy-env Use legacy environments [boolean]
515
-
516
- Options:
517
- --binding The binding of the namespace to write to [string]
518
- --namespace-id The id of the namespace to write to [string]
519
- -e, --env Perform on a specific environment [string]
520
- --preview Interact with a preview namespace [boolean]
521
- --ttl Time for which the entries should be visible [number]
522
- --expiration Time since the UNIX epoch after which the entry expires [number]
523
- --path Read value from the file at a given path [string]
524
-
525
- Exactly one of the arguments binding and namespace-id is required"
526
- `);
527
- });
528
-
529
- it("should error if both binding and namespace is provided", async () => {
530
- await expect(
531
- runWrangler("kv:key put foo bar --binding x --namespace-id y")
532
- ).rejects.toThrowErrorMatchingInlineSnapshot(
533
- `"Arguments binding and namespace-id are mutually exclusive"`
534
- );
535
-
536
- expect(std.out).toMatchInlineSnapshot(`""`);
537
- expect(std.err).toMatchInlineSnapshot(`
538
- "wrangler kv:key put <key> [value]
539
-
540
- Writes a single key/value pair to the given namespace.
541
-
542
- Positionals:
543
- key The key to write to [string] [required]
544
- value The value to write [string]
545
-
546
- Flags:
547
- -c, --config Path to .toml configuration file [string]
548
- -h, --help Show help [boolean]
549
- -v, --version Show version number [boolean]
550
- --legacy-env Use legacy environments [boolean]
551
-
552
- Options:
553
- --binding The binding of the namespace to write to [string]
554
- --namespace-id The id of the namespace to write to [string]
555
- -e, --env Perform on a specific environment [string]
556
- --preview Interact with a preview namespace [boolean]
557
- --ttl Time for which the entries should be visible [number]
558
- --expiration Time since the UNIX epoch after which the entry expires [number]
559
- --path Read value from the file at a given path [string]
560
-
561
- Arguments binding and namespace-id are mutually exclusive"
562
- `);
563
- });
564
-
565
- it("should error if no value nor path is provided", async () => {
566
- await expect(
567
- runWrangler("kv:key put key --namespace-id 12345")
568
- ).rejects.toThrowErrorMatchingInlineSnapshot(
569
- `"Exactly one of the arguments value and path is required"`
570
- );
571
-
572
- expect(std.out).toMatchInlineSnapshot(`""`);
573
- expect(std.err).toMatchInlineSnapshot(`
574
- "wrangler kv:key put <key> [value]
575
-
576
- Writes a single key/value pair to the given namespace.
577
-
578
- Positionals:
579
- key The key to write to [string] [required]
580
- value The value to write [string]
581
-
582
- Flags:
583
- -c, --config Path to .toml configuration file [string]
584
- -h, --help Show help [boolean]
585
- -v, --version Show version number [boolean]
586
- --legacy-env Use legacy environments [boolean]
587
-
588
- Options:
589
- --binding The binding of the namespace to write to [string]
590
- --namespace-id The id of the namespace to write to [string]
591
- -e, --env Perform on a specific environment [string]
592
- --preview Interact with a preview namespace [boolean]
593
- --ttl Time for which the entries should be visible [number]
594
- --expiration Time since the UNIX epoch after which the entry expires [number]
595
- --path Read value from the file at a given path [string]
596
-
597
- Exactly one of the arguments value and path is required"
598
- `);
599
- });
600
-
601
- it("should error if both value and path is provided", async () => {
602
- await expect(
603
- runWrangler("kv:key put key value --path xyz --namespace-id 12345")
604
- ).rejects.toThrowErrorMatchingInlineSnapshot(
605
- `"Arguments value and path are mutually exclusive"`
606
- );
607
-
608
- expect(std.out).toMatchInlineSnapshot(`""`);
609
- expect(std.err).toMatchInlineSnapshot(`
610
- "wrangler kv:key put <key> [value]
611
-
612
- Writes a single key/value pair to the given namespace.
613
-
614
- Positionals:
615
- key The key to write to [string] [required]
616
- value The value to write [string]
617
-
618
- Flags:
619
- -c, --config Path to .toml configuration file [string]
620
- -h, --help Show help [boolean]
621
- -v, --version Show version number [boolean]
622
- --legacy-env Use legacy environments [boolean]
623
-
624
- Options:
625
- --binding The binding of the namespace to write to [string]
626
- --namespace-id The id of the namespace to write to [string]
627
- -e, --env Perform on a specific environment [string]
628
- --preview Interact with a preview namespace [boolean]
629
- --ttl Time for which the entries should be visible [number]
630
- --expiration Time since the UNIX epoch after which the entry expires [number]
631
- --path Read value from the file at a given path [string]
632
-
633
- Arguments value and path are mutually exclusive"
634
- `);
635
- });
636
-
637
- it("should error if a given binding name is not in the configured kv namespaces", async () => {
638
- writeWranglerConfig();
639
- await expect(
640
- runWrangler("kv:key put key value --binding otherBinding")
641
- ).rejects.toThrowErrorMatchingInlineSnapshot(
642
- `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
643
- );
644
-
645
- expect(std.out).toMatchInlineSnapshot(`""`);
646
- expect(std.err).toMatchInlineSnapshot(`
647
- "A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
648
-
649
- %s If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
650
- `);
651
- });
652
-
653
- it("should error if a given binding has both preview and non-preview and --preview is not specified", async () => {
654
- writeWranglerConfig();
655
- const requests = mockKeyPutRequest("preview-bound-id", {
656
- key: "my-key",
657
- value: "my-value",
658
- });
659
- await expect(
660
- runWrangler("kv:key put my-key my-value --binding someBinding")
661
- ).rejects.toThrowErrorMatchingInlineSnapshot(
662
- `"someBinding has both a namespace ID and a preview ID. Specify \\"--preview\\" or \\"--preview false\\" to avoid writing data to the wrong namespace."`
663
- );
664
- expect(std.out).toMatchInlineSnapshot(`""`);
665
- expect(std.err).toMatchInlineSnapshot(`
666
- "someBinding has both a namespace ID and a preview ID. Specify \\"--preview\\" or \\"--preview false\\" to avoid writing data to the wrong namespace.
667
-
668
- %s If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
669
- `);
670
- expect(requests.count).toEqual(0);
671
- });
672
- });
673
-
674
- describe("list", () => {
675
- it("should list the keys of a namespace specified by namespace-id", async () => {
676
- const keys = [
677
- { name: "key-1" },
678
- { name: "key-2", expiration: 123456789 },
679
- { name: "key-3", expiration_ttl: 666 },
680
- ];
681
- mockKeyListRequest("some-namespace-id", keys);
682
- await runWrangler("kv:key list --namespace-id some-namespace-id");
683
- expect(std.err).toMatchInlineSnapshot(`""`);
684
- expect(std.out).toMatchInlineSnapshot(`
685
- "[
686
- {
687
- \\"name\\": \\"key-1\\"
688
- },
689
- {
690
- \\"name\\": \\"key-2\\",
691
- \\"expiration\\": 123456789
692
- },
693
- {
694
- \\"name\\": \\"key-3\\",
695
- \\"expiration_ttl\\": 666
696
- }
697
- ]"
698
- `);
699
- });
700
-
701
- it("should list the keys of a namespace specified by binding", async () => {
702
- writeWranglerConfig();
703
- const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
704
- mockKeyListRequest("bound-id", keys);
705
-
706
- await runWrangler("kv:key list --binding someBinding");
707
- expect(std.err).toMatchInlineSnapshot(`""`);
708
- expect(std.out).toMatchInlineSnapshot(`
709
- "[
710
- {
711
- \\"name\\": \\"key-1\\"
712
- },
713
- {
714
- \\"name\\": \\"key-2\\"
715
- },
716
- {
717
- \\"name\\": \\"key-3\\"
718
- }
719
- ]"
720
- `);
721
- });
722
-
723
- it("should list the keys of a preview namespace specified by binding", async () => {
724
- writeWranglerConfig();
725
- const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
726
- mockKeyListRequest("preview-bound-id", keys);
727
- await runWrangler("kv:key list --binding someBinding --preview");
728
- expect(std.err).toMatchInlineSnapshot(`""`);
729
- expect(std.out).toMatchInlineSnapshot(`
730
- "[
731
- {
732
- \\"name\\": \\"key-1\\"
733
- },
734
- {
735
- \\"name\\": \\"key-2\\"
736
- },
737
- {
738
- \\"name\\": \\"key-3\\"
739
- }
740
- ]"
741
- `);
742
- });
743
-
744
- it("should list the keys of a namespace specified by binding, in a given environment", async () => {
745
- writeWranglerConfig();
746
- const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
747
- mockKeyListRequest("env-bound-id", keys);
748
- await runWrangler(
749
- "kv:key list --binding someBinding --env some-environment"
750
- );
751
- expect(std.err).toMatchInlineSnapshot(`""`);
752
- expect(std.out).toMatchInlineSnapshot(`
753
- "[
754
- {
755
- \\"name\\": \\"key-1\\"
756
- },
757
- {
758
- \\"name\\": \\"key-2\\"
759
- },
760
- {
761
- \\"name\\": \\"key-3\\"
762
- }
763
- ]"
764
- `);
765
- });
766
-
767
- it("should list the keys of a preview namespace specified by binding, in a given environment", async () => {
768
- writeWranglerConfig();
769
- const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
770
- mockKeyListRequest("preview-env-bound-id", keys);
771
- await runWrangler(
772
- "kv:key list --binding someBinding --preview --env some-environment"
773
- );
774
- expect(std.err).toMatchInlineSnapshot(`""`);
775
- expect(std.out).toMatchInlineSnapshot(`
776
- "[
777
- {
778
- \\"name\\": \\"key-1\\"
779
- },
780
- {
781
- \\"name\\": \\"key-2\\"
782
- },
783
- {
784
- \\"name\\": \\"key-3\\"
785
- }
786
- ]"
787
- `);
788
- });
789
-
790
- // We'll run the next test with variations on the cursor
791
- // that's returned on cloudflare's API after all results
792
- // have been drained.
793
- for (const blankCursorValue of [undefined, null, ""] as [
794
- undefined,
795
- null,
796
- ""
797
- ]) {
798
- describe(`cursor - ${blankCursorValue}`, () => {
799
- it("should make multiple requests for paginated results", async () => {
800
- // Create a lot of mock keys, so that the fetch requests will be paginated
801
- const keys: NamespaceKeyInfo[] = [];
802
- for (let i = 0; i < 550; i++) {
803
- keys.push({ name: "key-" + i });
804
- }
805
- // Ask for the keys in pages of size 100.
806
- const requests = mockKeyListRequest(
807
- "some-namespace-id",
808
- keys,
809
- 100,
810
- blankCursorValue
811
- );
812
- await runWrangler(
813
- "kv:key list --namespace-id some-namespace-id --limit 100"
814
- );
815
- expect(std.err).toMatchInlineSnapshot(`""`);
816
- expect(JSON.parse(std.out)).toEqual(keys);
817
- expect(requests.count).toEqual(6);
818
- });
819
- });
820
- }
821
-
822
- it("should error if a given binding name is not in the configured kv namespaces", async () => {
823
- writeWranglerConfig();
824
- await expect(
825
- runWrangler("kv:key list --binding otherBinding")
826
- ).rejects.toThrowErrorMatchingInlineSnapshot(
827
- `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
828
- );
829
- expect(std.err).toMatchInlineSnapshot(`
830
- "A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
831
-
832
- %s If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
833
- `);
834
- expect(std.out).toMatchInlineSnapshot(`""`);
835
- });
836
- });
837
-
838
- describe("get", () => {
839
- afterEach(() => {
840
- unsetMockFetchKVGetValues();
841
- });
842
-
843
- it("should get a key in a given namespace specified by namespace-id", async () => {
844
- setMockFetchKVGetValue(
845
- "some-account-id",
846
- "some-namespace-id",
847
- "my-key",
848
- "my-value"
849
- );
850
- await runWrangler("kv:key get my-key --namespace-id some-namespace-id");
851
- expect(std.out).toMatchInlineSnapshot(`"my-value"`);
852
- expect(std.err).toMatchInlineSnapshot(`""`);
853
- });
854
-
855
- it("should get a key in a given namespace specified by binding", async () => {
856
- writeWranglerConfig();
857
- setMockFetchKVGetValue(
858
- "some-account-id",
859
- "bound-id",
860
- "my-key",
861
- "my-value"
862
- );
863
- await runWrangler(
864
- "kv:key get my-key --binding someBinding --preview false"
865
- );
866
- expect(std.out).toMatchInlineSnapshot(`"my-value"`);
867
- expect(std.err).toMatchInlineSnapshot(`""`);
868
- });
869
-
870
- it("should get a key in a given preview namespace specified by binding", async () => {
871
- writeWranglerConfig();
872
- setMockFetchKVGetValue(
873
- "some-account-id",
874
- "preview-bound-id",
875
- "my-key",
876
- "my-value"
877
- );
878
- await runWrangler("kv:key get my-key --binding someBinding --preview");
879
- expect(std.out).toMatchInlineSnapshot(`"my-value"`);
880
- expect(std.err).toMatchInlineSnapshot(`""`);
881
- });
882
-
883
- it("should get a key for the specified environment in a given namespace", async () => {
884
- writeWranglerConfig();
885
- setMockFetchKVGetValue(
886
- "some-account-id",
887
- "env-bound-id",
888
- "my-key",
889
- "my-value"
890
- );
891
- await runWrangler(
892
- "kv:key get my-key my-value --binding someBinding --env some-environment --preview false"
893
- );
894
- expect(std.out).toMatchInlineSnapshot(`"my-value"`);
895
- expect(std.err).toMatchInlineSnapshot(`""`);
896
- });
897
-
898
- it("should error if no key is provided", async () => {
899
- await expect(
900
- runWrangler("kv:key get")
901
- ).rejects.toThrowErrorMatchingInlineSnapshot(
902
- `"Not enough non-option arguments: got 0, need at least 1"`
903
- );
904
- expect(std.out).toMatchInlineSnapshot(`""`);
905
- expect(std.err).toMatchInlineSnapshot(`
906
- "wrangler kv:key get <key>
907
-
908
- Reads a single value by key from the given namespace.
909
-
910
- Positionals:
911
- key The key value to get. [string] [required]
912
-
913
- Flags:
914
- -c, --config Path to .toml configuration file [string]
915
- -h, --help Show help [boolean]
916
- -v, --version Show version number [boolean]
917
- --legacy-env Use legacy environments [boolean]
918
-
919
- Options:
920
- --binding The name of the namespace to get from [string]
921
- --namespace-id The id of the namespace to get from [string]
922
- -e, --env Perform on a specific environment [string]
923
- --preview Interact with a preview namespace [boolean] [default: false]
924
-
925
- Not enough non-option arguments: got 0, need at least 1"
926
- `);
927
- });
928
-
929
- it("should error if no binding nor namespace is provided", async () => {
930
- await expect(
931
- runWrangler("kv:key get foo")
932
- ).rejects.toThrowErrorMatchingInlineSnapshot(
933
- `"Exactly one of the arguments binding and namespace-id is required"`
934
- );
935
- expect(std.out).toMatchInlineSnapshot(`""`);
936
- expect(std.err).toMatchInlineSnapshot(`
937
- "wrangler kv:key get <key>
938
-
939
- Reads a single value by key from the given namespace.
940
-
941
- Positionals:
942
- key The key value to get. [string] [required]
943
-
944
- Flags:
945
- -c, --config Path to .toml configuration file [string]
946
- -h, --help Show help [boolean]
947
- -v, --version Show version number [boolean]
948
- --legacy-env Use legacy environments [boolean]
949
-
950
- Options:
951
- --binding The name of the namespace to get from [string]
952
- --namespace-id The id of the namespace to get from [string]
953
- -e, --env Perform on a specific environment [string]
954
- --preview Interact with a preview namespace [boolean] [default: false]
955
-
956
- Exactly one of the arguments binding and namespace-id is required"
957
- `);
958
- });
959
-
960
- it("should error if both binding and namespace is provided", async () => {
961
- await expect(
962
- runWrangler("kv:key get foo --binding x --namespace-id y")
963
- ).rejects.toThrowErrorMatchingInlineSnapshot(
964
- `"Arguments binding and namespace-id are mutually exclusive"`
965
- );
966
-
967
- expect(std.out).toMatchInlineSnapshot(`""`);
968
- expect(std.err).toMatchInlineSnapshot(`
969
- "wrangler kv:key get <key>
970
-
971
- Reads a single value by key from the given namespace.
972
-
973
- Positionals:
974
- key The key value to get. [string] [required]
975
-
976
- Flags:
977
- -c, --config Path to .toml configuration file [string]
978
- -h, --help Show help [boolean]
979
- -v, --version Show version number [boolean]
980
- --legacy-env Use legacy environments [boolean]
981
-
982
- Options:
983
- --binding The name of the namespace to get from [string]
984
- --namespace-id The id of the namespace to get from [string]
985
- -e, --env Perform on a specific environment [string]
986
- --preview Interact with a preview namespace [boolean] [default: false]
987
-
988
- Arguments binding and namespace-id are mutually exclusive"
989
- `);
990
- });
991
-
992
- it("should error if a given binding name is not in the configured kv namespaces", async () => {
993
- writeWranglerConfig();
994
- await expect(
995
- runWrangler("kv:key get key --binding otherBinding")
996
- ).rejects.toThrowErrorMatchingInlineSnapshot(
997
- `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
998
- );
999
- expect(std.out).toMatchInlineSnapshot(`""`);
1000
- expect(std.err).toMatchInlineSnapshot(`
1001
- "A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
1002
-
1003
- %s If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
1004
- `);
1005
- });
1006
- });
1007
-
1008
- describe("delete", () => {
1009
- function mockDeleteRequest(
1010
- expectedNamespaceId: string,
1011
- expectedKey: string
1012
- ) {
1013
- const requests = { count: 0 };
1014
- setMockResponse(
1015
- "/accounts/:accountId/storage/kv/namespaces/:namespaceId/values/:key",
1016
- "DELETE",
1017
- ([_url, accountId, namespaceId, key]) => {
1018
- requests.count++;
1019
- expect(accountId).toEqual("some-account-id");
1020
- expect(namespaceId).toEqual(expectedNamespaceId);
1021
- expect(key).toEqual(expectedKey);
1022
- return null;
1023
- }
1024
- );
1025
- return requests;
1026
- }
1027
-
1028
- it("should delete a key in a namespace specified by id", async () => {
1029
- const requests = mockDeleteRequest("some-namespace-id", "someKey");
1030
- await runWrangler(
1031
- `kv:key delete --namespace-id some-namespace-id someKey`
1032
- );
1033
- expect(requests.count).toEqual(1);
1034
- });
1035
-
1036
- it("should delete a key in a namespace specified by binding name", async () => {
1037
- writeWranglerConfig();
1038
- const requests = mockDeleteRequest("bound-id", "someKey");
1039
- await runWrangler(
1040
- `kv:key delete --binding someBinding --preview false someKey`
1041
- );
1042
- expect(requests.count).toEqual(1);
1043
- });
1044
-
1045
- it("should delete a key in a preview namespace specified by binding name", async () => {
1046
- writeWranglerConfig();
1047
- const requests = mockDeleteRequest("preview-bound-id", "someKey");
1048
- await runWrangler(
1049
- `kv:key delete --binding someBinding --preview someKey`
1050
- );
1051
- expect(requests.count).toEqual(1);
1052
- });
1053
-
1054
- it("should error if a given binding name is not in the configured kv namespaces", async () => {
1055
- writeWranglerConfig();
1056
- await expect(
1057
- runWrangler(`kv:key delete --binding otherBinding someKey`)
1058
- ).rejects.toThrowErrorMatchingInlineSnapshot(
1059
- `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
1060
- );
1061
-
1062
- expect(std.err).toMatchInlineSnapshot(`
1063
- "A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
1064
-
1065
- %s If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
1066
- `);
1067
- });
1068
-
1069
- it("should delete a key in a namespace specified by binding name in a given environment", async () => {
1070
- writeWranglerConfig();
1071
- const requests = mockDeleteRequest("env-bound-id", "someKey");
1072
- await runWrangler(
1073
- `kv:key delete --binding someBinding --env some-environment --preview false someKey`
1074
- );
1075
- expect(std.out).toMatchInlineSnapshot(
1076
- `"deleting the key \\"someKey\\" on namespace env-bound-id"`
1077
- );
1078
- expect(std.err).toMatchInlineSnapshot(`""`);
1079
- expect(requests.count).toEqual(1);
1080
- });
1081
-
1082
- it("should delete a key in a preview namespace specified by binding name in a given environment", async () => {
1083
- writeWranglerConfig();
1084
- const requests = mockDeleteRequest("preview-env-bound-id", "someKey");
1085
- await runWrangler(
1086
- `kv:key delete --binding someBinding --env some-environment --preview someKey`
1087
- );
1088
- expect(requests.count).toEqual(1);
1089
- });
1090
- });
1091
- });
1092
-
1093
- describe("kv:bulk", () => {
1094
- describe("put", () => {
1095
- function mockPutRequest(
1096
- expectedNamespaceId: string,
1097
- expectedKeyValues: KeyValue[]
1098
- ) {
1099
- const requests = { count: 0 };
1100
- setMockResponse(
1101
- "/accounts/:accountId/storage/kv/namespaces/:namespaceId/bulk",
1102
- "PUT",
1103
- ([_url, accountId, namespaceId], { body }) => {
1104
- requests.count++;
1105
- expect(accountId).toEqual("some-account-id");
1106
- expect(namespaceId).toEqual(expectedNamespaceId);
1107
- expect(JSON.parse(body as string)).toEqual(
1108
- expectedKeyValues.slice(
1109
- (requests.count - 1) * 5000,
1110
- requests.count * 5000
1111
- )
1112
- );
1113
- return null;
1114
- }
1115
- );
1116
- return requests;
1117
- }
1118
-
1119
- it("should put the key-values parsed from a file", async () => {
1120
- const keyValues: KeyValue[] = [
1121
- { key: "someKey1", value: "someValue1" },
1122
- { key: "ns:someKey2", value: "123", base64: true },
1123
- { key: "someKey3", value: "someValue3", expiration: 100 },
1124
- { key: "someKey4", value: "someValue4", expiration_ttl: 500 },
1125
- ];
1126
- writeFileSync("./keys.json", JSON.stringify(keyValues));
1127
- const requests = mockPutRequest("some-namespace-id", keyValues);
1128
- await runWrangler(
1129
- `kv:bulk put --namespace-id some-namespace-id keys.json`
1130
- );
1131
- expect(requests.count).toEqual(1);
1132
- expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1133
- expect(std.warn).toMatchInlineSnapshot(`""`);
1134
- expect(std.err).toMatchInlineSnapshot(`""`);
1135
- });
1136
-
1137
- it("should put the key-values in batches of 5000 parsed from a file", async () => {
1138
- const keyValues: KeyValue[] = new Array(12000).fill({
1139
- key: "someKey1",
1140
- value: "someValue1",
1141
- });
1142
- writeFileSync("./keys.json", JSON.stringify(keyValues));
1143
- const requests = mockPutRequest("some-namespace-id", keyValues);
1144
- await runWrangler(
1145
- `kv:bulk put --namespace-id some-namespace-id keys.json`
1146
- );
1147
- expect(requests.count).toEqual(3);
1148
- expect(std.out).toMatchInlineSnapshot(`
1149
- "Uploaded 0 of 12000.
1150
- Uploaded 5000 of 12000.
1151
- Uploaded 10000 of 12000.
1152
- Uploaded 12000 of 12000.
1153
- Success!"
1154
- `);
1155
- expect(std.warn).toMatchInlineSnapshot(`""`);
1156
- expect(std.err).toMatchInlineSnapshot(`""`);
1157
- });
1158
-
1159
- it("should error if the file is not a JSON array", async () => {
1160
- const keyValues = { key: "someKey1", value: "someValue1" };
1161
- writeFileSync("./keys.json", JSON.stringify(keyValues));
1162
- await expect(
1163
- runWrangler(`kv:bulk put --namespace-id some-namespace-id keys.json`)
1164
- ).rejects.toThrowErrorMatchingInlineSnapshot(`
1165
- "Unexpected JSON input from \\"keys.json\\".
1166
- Expected an array of key-value objects but got type \\"object\\"."
1167
- `);
1168
- expect(std.out).toMatchInlineSnapshot(`""`);
1169
- expect(std.warn).toMatchInlineSnapshot(`""`);
1170
- });
1171
-
1172
- it("should error if the array contains items that are not key-value objects", async () => {
1173
- const keyValues = [
1174
- 123,
1175
- "a string",
1176
- { key: "someKey" },
1177
- { value: "someValue" },
1178
- { key: "someKey1", value: "someValue1", invalid: true },
1179
- ];
1180
- writeFileSync("./keys.json", JSON.stringify(keyValues));
1181
- await expect(
1182
- runWrangler(`kv:bulk put --namespace-id some-namespace-id keys.json`)
1183
- ).rejects.toThrowErrorMatchingInlineSnapshot(`
1184
- "Unexpected JSON input from \\"keys.json\\".
1185
- Each item in the array should be an object that matches:
1186
-
1187
- interface KeyValue {
1188
- key: string;
1189
- value: string;
1190
- expiration?: number;
1191
- expiration_ttl?: number;
1192
- metadata?: object;
1193
- base64?: boolean;
1194
- }
1195
-
1196
- The item at index 0 is type: \\"number\\" - 123
1197
- The item at index 1 is type: \\"string\\" - \\"a string\\"
1198
- The item at index 2 is {\\"key\\":\\"someKey\\"}
1199
- The item at index 3 is {\\"value\\":\\"someValue\\"}"
1200
- `);
1201
-
1202
- expect(std.out).toMatchInlineSnapshot(`""`);
1203
- expect(std.warn).toMatchInlineSnapshot(`
1204
- "Unexpected key-value properties in \\"keys.json\\".
1205
- The item at index 4 contains unexpected properties: [\\"invalid\\"]."
1206
- `);
1207
- });
1208
- });
1209
-
1210
- describe("delete", () => {
1211
- function mockDeleteRequest(
1212
- expectedNamespaceId: string,
1213
- expectedKeys: string[]
1214
- ) {
1215
- const requests = { count: 0 };
1216
- setMockResponse(
1217
- "/accounts/:accountId/storage/kv/namespaces/:namespaceId/bulk",
1218
- "DELETE",
1219
- ([_url, accountId, namespaceId], { headers, body }) => {
1220
- requests.count++;
1221
- expect(accountId).toEqual("some-account-id");
1222
- expect(namespaceId).toEqual(expectedNamespaceId);
1223
- expect(new Headers(headers ?? []).get("Content-Type")).toEqual(
1224
- "application/json"
1225
- );
1226
- expect(JSON.parse(body as string)).toEqual(
1227
- expectedKeys.slice(
1228
- (requests.count - 1) * 5000,
1229
- requests.count * 5000
1230
- )
1231
- );
1232
- return null;
1233
- }
1234
- );
1235
- return requests;
1236
- }
1237
-
1238
- it("should delete the keys parsed from a file", async () => {
1239
- const keys = ["someKey1", "ns:someKey2"];
1240
- writeFileSync("./keys.json", JSON.stringify(keys));
1241
- mockConfirm({
1242
- text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1243
- result: true,
1244
- });
1245
- const requests = mockDeleteRequest("some-namespace-id", keys);
1246
- await runWrangler(
1247
- `kv:bulk delete --namespace-id some-namespace-id keys.json`
1248
- );
1249
- expect(requests.count).toEqual(1);
1250
- expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1251
- expect(std.warn).toMatchInlineSnapshot(`""`);
1252
- expect(std.err).toMatchInlineSnapshot(`""`);
1253
- });
1254
-
1255
- it("should delete the keys in batches of 5000 parsed from a file", async () => {
1256
- const keys = new Array(12000).fill("some-key");
1257
- writeFileSync("./keys.json", JSON.stringify(keys));
1258
- mockConfirm({
1259
- text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1260
- result: true,
1261
- });
1262
- const requests = mockDeleteRequest("some-namespace-id", keys);
1263
- await runWrangler(
1264
- `kv:bulk delete --namespace-id some-namespace-id keys.json`
1265
- );
1266
- expect(requests.count).toEqual(3);
1267
- expect(std.out).toMatchInlineSnapshot(`
1268
- "Deleted 0 of 12000.
1269
- Deleted 5000 of 12000.
1270
- Deleted 10000 of 12000.
1271
- Deleted 12000 of 12000.
1272
- Success!"
1273
- `);
1274
- expect(std.warn).toMatchInlineSnapshot(`""`);
1275
- expect(std.err).toMatchInlineSnapshot(`""`);
1276
- });
1277
-
1278
- it("should not delete the keys if the user confirms no", async () => {
1279
- const keys = ["someKey1", "ns:someKey2"];
1280
- writeFileSync("./keys.json", JSON.stringify(keys));
1281
- mockConfirm({
1282
- text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1283
- result: false,
1284
- });
1285
- await runWrangler(
1286
- `kv:bulk delete --namespace-id some-namespace-id keys.json`
1287
- );
1288
- expect(std.out).toMatchInlineSnapshot(
1289
- `"Not deleting keys read from \\"keys.json\\"."`
1290
- );
1291
- expect(std.warn).toMatchInlineSnapshot(`""`);
1292
- expect(std.err).toMatchInlineSnapshot(`""`);
1293
- });
1294
-
1295
- it("should delete the keys without asking if --force is provided", async () => {
1296
- const keys = ["someKey1", "ns:someKey2"];
1297
- writeFileSync("./keys.json", JSON.stringify(keys));
1298
- const requests = mockDeleteRequest("some-namespace-id", keys);
1299
- await runWrangler(
1300
- `kv:bulk delete --namespace-id some-namespace-id keys.json --force`
1301
- );
1302
- expect(requests.count).toEqual(1);
1303
- expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1304
- expect(std.warn).toMatchInlineSnapshot(`""`);
1305
- expect(std.err).toMatchInlineSnapshot(`""`);
1306
- });
1307
-
1308
- it("should delete the keys without asking if -f is provided", async () => {
1309
- const keys = ["someKey1", "ns:someKey2"];
1310
- writeFileSync("./keys.json", JSON.stringify(keys));
1311
- const requests = mockDeleteRequest("some-namespace-id", keys);
1312
- await runWrangler(
1313
- `kv:bulk delete --namespace-id some-namespace-id keys.json -f`
1314
- );
1315
- expect(requests.count).toEqual(1);
1316
- expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1317
- expect(std.warn).toMatchInlineSnapshot(`""`);
1318
- expect(std.err).toMatchInlineSnapshot(`""`);
1319
- });
1320
-
1321
- it("should error if the file is not a JSON array", async () => {
1322
- const keys = 12354;
1323
- writeFileSync("./keys.json", JSON.stringify(keys));
1324
- mockConfirm({
1325
- text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1326
- result: true,
1327
- });
1328
- await expect(
1329
- runWrangler(
1330
- `kv:bulk delete --namespace-id some-namespace-id keys.json`
1331
- )
1332
- ).rejects.toThrowErrorMatchingInlineSnapshot(`
1333
- "Unexpected JSON input from \\"keys.json\\".
1334
- Expected an array of strings but got:
1335
- 12354"
1336
- `);
1337
- expect(std.out).toMatchInlineSnapshot(`""`);
1338
- expect(std.warn).toMatchInlineSnapshot(`""`);
1339
- });
1340
-
1341
- it("should error if the file contains non-string items", async () => {
1342
- const keys = ["good", 12354, { key: "someKey" }, null];
1343
- writeFileSync("./keys.json", JSON.stringify(keys));
1344
- mockConfirm({
1345
- text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1346
- result: true,
1347
- });
1348
- await expect(
1349
- runWrangler(
1350
- `kv:bulk delete --namespace-id some-namespace-id keys.json`
1351
- )
1352
- ).rejects.toThrowErrorMatchingInlineSnapshot(`
1353
- "Unexpected JSON input from \\"keys.json\\".
1354
- Expected an array of strings.
1355
- The item at index 1 is type: \\"number\\" - 12354
1356
- The item at index 2 is type: \\"object\\" - {\\"key\\":\\"someKey\\"}
1357
- The item at index 3 is type: \\"object\\" - null"
1358
- `);
1359
- expect(std.out).toMatchInlineSnapshot(`""`);
1360
- expect(std.warn).toMatchInlineSnapshot(`""`);
1361
- });
1362
- });
1363
- });
1364
- });
1365
-
1366
- function writeWranglerConfig() {
1367
- writeFileSync(
1368
- "./wrangler.toml",
1369
- [
1370
- 'name = "otherWorker"',
1371
- "kv_namespaces = [",
1372
- ' { binding = "someBinding", id = "bound-id", preview_id = "preview-bound-id" }',
1373
- "]",
1374
- "",
1375
- "[env.some-environment]",
1376
- "kv_namespaces = [",
1377
- ' { binding = "someBinding", id = "env-bound-id", preview_id = "preview-env-bound-id" }',
1378
- "]",
1379
- ].join("\n"),
1380
- "utf-8"
1381
- );
1382
- }