wrangler 0.0.0-e2f9bb2 → 0.0.0-e305903a

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 (258) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +30 -4
  3. package/bin/wrangler.js +154 -34
  4. package/kv-asset-handler.js +1 -0
  5. package/miniflare-dist/index.mjs +1437 -21
  6. package/package.json +185 -148
  7. package/src/__tests__/api-dev.test.ts +209 -0
  8. package/src/__tests__/api-devregistry.test.js +56 -0
  9. package/src/__tests__/api.test.ts +80 -0
  10. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  11. package/src/__tests__/config-cache.test.ts +30 -24
  12. package/src/__tests__/configuration.test.ts +4121 -3114
  13. package/src/__tests__/dev.test.tsx +1331 -738
  14. package/src/__tests__/dialogs.test.tsx +40 -0
  15. package/src/__tests__/generate.test.ts +91 -0
  16. package/src/__tests__/guess-worker-format.test.ts +68 -68
  17. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  18. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  19. package/src/__tests__/helpers/mock-bin.ts +20 -20
  20. package/src/__tests__/helpers/mock-cfetch.ts +199 -94
  21. package/src/__tests__/helpers/mock-console.ts +58 -39
  22. package/src/__tests__/helpers/mock-dialogs.ts +115 -51
  23. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -0
  24. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  25. package/src/__tests__/helpers/mock-istty.ts +65 -18
  26. package/src/__tests__/helpers/mock-known-routes.ts +7 -0
  27. package/src/__tests__/helpers/mock-kv.ts +26 -26
  28. package/src/__tests__/helpers/mock-oauth-flow.ts +225 -228
  29. package/src/__tests__/helpers/mock-process.ts +39 -0
  30. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  31. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  32. package/src/__tests__/helpers/msw/handlers/index.ts +13 -0
  33. package/src/__tests__/helpers/msw/handlers/namespaces.ts +104 -0
  34. package/src/__tests__/helpers/msw/handlers/oauth.ts +36 -0
  35. package/src/__tests__/helpers/msw/handlers/r2.ts +80 -0
  36. package/src/__tests__/helpers/msw/handlers/user.ts +63 -0
  37. package/src/__tests__/helpers/msw/index.ts +4 -0
  38. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  39. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  40. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  41. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  42. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  43. package/src/__tests__/helpers/worker-scripts/parent-worker.js +8 -0
  44. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  45. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  46. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  47. package/src/__tests__/https-options.test.ts +142 -109
  48. package/src/__tests__/index.test.ts +231 -231
  49. package/src/__tests__/init.test.ts +2689 -1014
  50. package/src/__tests__/jest.setup.ts +147 -30
  51. package/src/__tests__/kv.test.ts +1311 -1094
  52. package/src/__tests__/logger.test.ts +100 -74
  53. package/src/__tests__/metrics.test.ts +450 -0
  54. package/src/__tests__/middleware.scheduled.test.ts +135 -0
  55. package/src/__tests__/middleware.test.ts +726 -0
  56. package/src/__tests__/package-manager.test.ts +312 -165
  57. package/src/__tests__/pages.test.ts +1988 -322
  58. package/src/__tests__/parse.test.ts +253 -245
  59. package/src/__tests__/paths.test.ts +39 -0
  60. package/src/__tests__/publish.test.ts +6955 -4743
  61. package/src/__tests__/pubsub.test.ts +367 -0
  62. package/src/__tests__/r2.test.ts +363 -206
  63. package/src/__tests__/route.test.ts +18 -18
  64. package/src/__tests__/secret.test.ts +624 -426
  65. package/src/__tests__/tail.test.ts +650 -565
  66. package/src/__tests__/test-old-node-version.js +31 -0
  67. package/src/__tests__/user.test.ts +140 -116
  68. package/src/__tests__/validate-dev-props.test.ts +56 -0
  69. package/src/__tests__/version.test.ts +35 -0
  70. package/src/__tests__/whoami.test.tsx +259 -91
  71. package/src/__tests__/worker-namespace.test.ts +319 -0
  72. package/src/abort.d.ts +3 -0
  73. package/src/api/dev.ts +206 -0
  74. package/src/api/index.ts +2 -0
  75. package/src/bundle-reporter.tsx +29 -0
  76. package/src/bundle.ts +721 -134
  77. package/src/cfetch/index.ts +83 -66
  78. package/src/cfetch/internal.ts +267 -90
  79. package/src/cli.ts +23 -7
  80. package/src/config/config.ts +236 -195
  81. package/src/config/diagnostics.ts +61 -61
  82. package/src/config/environment.ts +450 -339
  83. package/src/config/index.ts +258 -38
  84. package/src/config/validation-helpers.ts +379 -357
  85. package/src/config/validation.ts +1769 -1263
  86. package/src/config-cache.ts +81 -41
  87. package/src/create-worker-preview.ts +232 -132
  88. package/src/create-worker-upload-form.ts +285 -224
  89. package/src/d1/backups.tsx +212 -0
  90. package/src/d1/create.tsx +54 -0
  91. package/src/d1/delete.tsx +56 -0
  92. package/src/d1/execute.tsx +294 -0
  93. package/src/d1/formatTimeAgo.ts +14 -0
  94. package/src/d1/index.ts +75 -0
  95. package/src/d1/list.tsx +48 -0
  96. package/src/d1/options.ts +12 -0
  97. package/src/d1/types.tsx +14 -0
  98. package/src/d1/utils.ts +39 -0
  99. package/src/dev/dev-vars.ts +13 -13
  100. package/src/dev/dev.tsx +500 -353
  101. package/src/dev/get-local-persistence-path.tsx +31 -0
  102. package/src/dev/local.tsx +628 -290
  103. package/src/dev/remote.tsx +397 -197
  104. package/src/dev/start-server.ts +443 -0
  105. package/src/dev/use-esbuild.ts +173 -94
  106. package/src/dev/validate-dev-props.ts +31 -0
  107. package/src/dev-registry.tsx +190 -0
  108. package/src/dev.tsx +869 -0
  109. package/src/dialogs.tsx +134 -63
  110. package/src/dispatch-namespace.ts +206 -0
  111. package/src/durable.ts +102 -0
  112. package/src/entry.ts +248 -186
  113. package/src/environment-variables.ts +38 -23
  114. package/src/errors.ts +6 -6
  115. package/src/faye-websocket.d.ts +6 -0
  116. package/src/generate.ts +131 -0
  117. package/src/git-client.ts +42 -0
  118. package/src/global-wrangler-config-path.ts +26 -0
  119. package/src/https-options.ts +84 -80
  120. package/src/index.tsx +2288 -2534
  121. package/src/init.ts +967 -0
  122. package/src/inspect.ts +686 -562
  123. package/src/intl-polyfill.d.ts +123 -123
  124. package/src/is-ci.ts +14 -0
  125. package/src/is-interactive.ts +12 -0
  126. package/src/kv.ts +353 -242
  127. package/src/logger.ts +53 -39
  128. package/src/metrics/index.ts +5 -0
  129. package/src/metrics/metrics-config.ts +239 -0
  130. package/src/metrics/metrics-dispatcher.ts +96 -0
  131. package/src/metrics/metrics-usage-headers.ts +24 -0
  132. package/src/metrics/send-event.ts +93 -0
  133. package/src/miniflare-cli/assets.ts +215 -0
  134. package/src/miniflare-cli/index.ts +200 -33
  135. package/src/miniflare-cli/request-context.ts +18 -18
  136. package/src/module-collection.ts +212 -212
  137. package/src/open-in-browser.ts +5 -14
  138. package/src/package-manager.ts +182 -90
  139. package/src/pages/build.tsx +238 -0
  140. package/src/pages/constants.ts +16 -0
  141. package/src/pages/deployments.tsx +106 -0
  142. package/src/pages/dev.tsx +684 -0
  143. package/src/pages/errors.ts +66 -0
  144. package/src/pages/functions/buildPlugin.ts +110 -0
  145. package/src/pages/functions/buildWorker.ts +156 -0
  146. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  147. package/src/pages/functions/filepath-routing.ts +189 -0
  148. package/src/pages/functions/identifiers.ts +78 -0
  149. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  150. package/src/pages/functions/routes-consolidation.ts +73 -0
  151. package/src/pages/functions/routes-transformation.test.ts +282 -0
  152. package/src/pages/functions/routes-transformation.ts +115 -0
  153. package/src/pages/functions/routes-validation.test.ts +403 -0
  154. package/src/pages/functions/routes-validation.ts +202 -0
  155. package/src/pages/functions/routes.ts +151 -0
  156. package/src/pages/functions.tsx +82 -0
  157. package/src/pages/hash.tsx +13 -0
  158. package/src/pages/index.tsx +94 -0
  159. package/src/pages/projects.tsx +169 -0
  160. package/src/pages/publish.tsx +419 -0
  161. package/src/pages/types.ts +49 -0
  162. package/src/pages/upload.tsx +398 -0
  163. package/src/pages/utils.ts +12 -0
  164. package/src/parse.ts +223 -120
  165. package/src/paths.ts +53 -8
  166. package/src/preview.ts +31 -0
  167. package/src/proxy.ts +435 -383
  168. package/src/publish.ts +837 -441
  169. package/src/pubsub/index.ts +286 -0
  170. package/src/pubsub/pubsub-commands.tsx +623 -0
  171. package/src/r2.ts +100 -19
  172. package/src/selfsigned.d.ts +23 -23
  173. package/src/sites.tsx +279 -200
  174. package/src/tail/filters.ts +108 -110
  175. package/src/tail/index.ts +234 -218
  176. package/src/tail/printing.ts +86 -46
  177. package/src/update-check.ts +11 -11
  178. package/src/user/choose-account.tsx +69 -0
  179. package/src/user/env-vars.ts +46 -0
  180. package/src/user/generate-auth-url.ts +33 -0
  181. package/src/user/generate-random-state.ts +16 -0
  182. package/src/user/index.ts +3 -0
  183. package/src/user/user.tsx +1192 -0
  184. package/src/whoami.tsx +141 -42
  185. package/src/worker.ts +163 -101
  186. package/src/zones.ts +167 -0
  187. package/templates/checked-fetch.js +17 -0
  188. package/templates/d1-beta-facade.js +174 -0
  189. package/templates/experimental-local-cache-stubs.js +27 -0
  190. package/templates/first-party-worker-module-facade.ts +18 -0
  191. package/templates/format-dev-errors.ts +32 -0
  192. package/templates/init-tests/test-jest-new-worker.js +25 -0
  193. package/templates/init-tests/test-vitest-new-worker.js +26 -0
  194. package/templates/middleware/common.ts +62 -0
  195. package/templates/middleware/loader-modules.ts +84 -0
  196. package/templates/middleware/loader-sw.ts +213 -0
  197. package/templates/middleware/middleware-pretty-error.ts +40 -0
  198. package/templates/middleware/middleware-scheduled.ts +15 -0
  199. package/templates/new-worker-scheduled.js +17 -0
  200. package/templates/new-worker-scheduled.ts +32 -0
  201. package/templates/new-worker.js +3 -3
  202. package/templates/new-worker.ts +18 -3
  203. package/templates/no-op-worker.js +10 -0
  204. package/templates/pages-dev-pipeline.ts +35 -0
  205. package/templates/pages-shim.ts +9 -0
  206. package/templates/pages-template-plugin.ts +167 -0
  207. package/templates/pages-template-worker.ts +172 -0
  208. package/templates/serve-static-assets.ts +63 -0
  209. package/templates/service-bindings-module-facade.js +54 -0
  210. package/templates/service-bindings-sw-facade.js +42 -0
  211. package/templates/tsconfig.json +95 -95
  212. package/wrangler-dist/cli.d.ts +841 -0
  213. package/wrangler-dist/cli.js +120834 -70331
  214. package/pages/functions/buildPlugin.ts +0 -92
  215. package/pages/functions/buildWorker.ts +0 -138
  216. package/pages/functions/filepath-routing.ts +0 -189
  217. package/pages/functions/identifiers.ts +0 -78
  218. package/pages/functions/routes.ts +0 -156
  219. package/pages/functions/template-plugin.ts +0 -146
  220. package/pages/functions/template-worker.ts +0 -143
  221. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  222. package/src/miniflare-cli/enum-keys.ts +0 -17
  223. package/src/pages.tsx +0 -1866
  224. package/src/user.tsx +0 -1193
  225. package/templates/static-asset-facade.js +0 -47
  226. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  227. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  228. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  229. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  230. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  231. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  232. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  233. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  234. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  235. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  236. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  237. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  238. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  239. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  240. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  241. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  242. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  243. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  244. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  245. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  246. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  247. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  248. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  249. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  250. package/vendor/wrangler-mime/LICENSE +0 -21
  251. package/vendor/wrangler-mime/Mime.js +0 -97
  252. package/vendor/wrangler-mime/README.md +0 -187
  253. package/vendor/wrangler-mime/cli.js +0 -46
  254. package/vendor/wrangler-mime/index.js +0 -4
  255. package/vendor/wrangler-mime/lite.js +0 -4
  256. package/vendor/wrangler-mime/package.json +0 -52
  257. package/vendor/wrangler-mime/types/other.js +0 -1
  258. package/vendor/wrangler-mime/types/standard.js +0 -1
@@ -1,57 +1,60 @@
1
1
  import { writeFileSync } from "node:fs";
2
- import { Headers } from "undici";
2
+ import { FormData, Headers } from "undici";
3
3
  import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
4
4
  import {
5
- setMockResponse,
6
- unsetAllMocks,
7
- unsetMockFetchKVGetValues,
8
- setMockFetchKVGetValue,
5
+ setMockResponse,
6
+ unsetAllMocks,
7
+ unsetSpecialMockFns,
8
+ setMockFetchKVGetValue,
9
+ setMockRawResponse,
10
+ createFetchResult,
9
11
  } from "./helpers/mock-cfetch";
10
12
  import { mockConsoleMethods } from "./helpers/mock-console";
11
13
  import { clearConfirmMocks, mockConfirm } from "./helpers/mock-dialogs";
14
+ import { useMockIsTTY } from "./helpers/mock-istty";
12
15
  import { mockKeyListRequest } from "./helpers/mock-kv";
16
+ import { mockGetMemberships } from "./helpers/mock-oauth-flow";
17
+ import { mockProcess } from "./helpers/mock-process";
13
18
  import { runInTempDir } from "./helpers/run-in-tmp";
14
19
  import { runWrangler } from "./helpers/run-wrangler";
15
20
  import type { KeyValue, KVNamespaceInfo, NamespaceKeyInfo } from "../kv";
16
21
 
17
22
  describe("wrangler", () => {
18
- mockAccountId();
19
- mockApiToken();
20
- runInTempDir();
21
- const std = mockConsoleMethods();
22
-
23
- afterEach(() => {
24
- unsetAllMocks();
25
- clearConfirmMocks();
26
- });
27
-
28
- describe("kv:namespace", () => {
29
- describe("create", () => {
30
- function mockCreateRequest(expectedTitle: string) {
31
- setMockResponse(
32
- "/accounts/:accountId/storage/kv/namespaces",
33
- "POST",
34
- ([_url, accountId], { body }) => {
35
- expect(accountId).toEqual("some-account-id");
36
- const title = JSON.parse(body as string).title;
37
- expect(title).toEqual(expectedTitle);
38
- return { id: "some-namespace-id" };
39
- }
40
- );
41
- }
42
-
43
- it("should error if no namespace is given", async () => {
44
- await expect(
45
- runWrangler("kv:namespace create")
46
- ).rejects.toThrowErrorMatchingInlineSnapshot(
47
- `"Not enough non-option arguments: got 0, need at least 1"`
48
- );
49
- expect(std.out).toMatchInlineSnapshot(`
50
- "
23
+ mockAccountId();
24
+ mockApiToken();
25
+ runInTempDir();
26
+ const std = mockConsoleMethods();
27
+ const proc = mockProcess();
28
+
29
+ afterEach(() => {
30
+ unsetAllMocks();
31
+ clearConfirmMocks();
32
+ });
33
+
34
+ describe("kv:namespace", () => {
35
+ describe("create", () => {
36
+ function mockCreateRequest(expectedTitle: string) {
37
+ setMockResponse(
38
+ "/accounts/:accountId/storage/kv/namespaces",
39
+ "POST",
40
+ ([_url, accountId], { body }) => {
41
+ expect(accountId).toEqual("some-account-id");
42
+ const title = JSON.parse(body as string).title;
43
+ expect(title).toEqual(expectedTitle);
44
+ return { id: "some-namespace-id" };
45
+ }
46
+ );
47
+ }
48
+
49
+ it("should error if no namespace is given", async () => {
50
+ await expect(
51
+ runWrangler("kv:namespace create")
52
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
53
+ `"Not enough non-option arguments: got 0, need at least 1"`
54
+ );
55
+ expect(std.out).toMatchInlineSnapshot(`
51
56
  "
52
- `);
53
- expect(std.err).toMatchInlineSnapshot(`
54
- "wrangler kv:namespace create <namespace>
57
+ wrangler kv:namespace create <namespace>
55
58
 
56
59
  Create a new namespace
57
60
 
@@ -59,32 +62,30 @@ describe("wrangler", () => {
59
62
  namespace The name of the new namespace [string] [required]
60
63
 
61
64
  Flags:
62
- -c, --config Path to .toml configuration file [string]
63
- -h, --help Show help [boolean]
64
- -v, --version Show version number [boolean]
65
- --legacy-env Use legacy environments [boolean]
65
+ -c, --config Path to .toml configuration file [string]
66
+ -h, --help Show help [boolean]
67
+ -v, --version Show version number [boolean]
66
68
 
67
69
  Options:
68
70
  -e, --env Perform on a specific environment [string]
69
- --preview Interact with a preview namespace [boolean]
70
- X [ERROR] Not enough non-option arguments: got 0, need at least 1
71
+ --preview Interact with a preview namespace [boolean]"
72
+ `);
73
+ expect(std.err).toMatchInlineSnapshot(`
74
+ "X [ERROR] Not enough non-option arguments: got 0, need at least 1
71
75
 
72
76
  "
73
77
  `);
74
- });
75
-
76
- it("should error if the namespace to create contains spaces", async () => {
77
- await expect(
78
- runWrangler("kv:namespace create abc def ghi")
79
- ).rejects.toThrowErrorMatchingInlineSnapshot(
80
- `"Unknown arguments: def, ghi"`
81
- );
82
- expect(std.out).toMatchInlineSnapshot(`
78
+ });
79
+
80
+ it("should error if the namespace to create contains spaces", async () => {
81
+ await expect(
82
+ runWrangler("kv:namespace create abc def ghi")
83
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
84
+ `"Unknown arguments: def, ghi"`
85
+ );
86
+ expect(std.out).toMatchInlineSnapshot(`
83
87
  "
84
- "
85
- `);
86
- expect(std.err).toMatchInlineSnapshot(`
87
- "wrangler kv:namespace create <namespace>
88
+ wrangler kv:namespace create <namespace>
88
89
 
89
90
  Create a new namespace
90
91
 
@@ -92,33 +93,31 @@ describe("wrangler", () => {
92
93
  namespace The name of the new namespace [string] [required]
93
94
 
94
95
  Flags:
95
- -c, --config Path to .toml configuration file [string]
96
- -h, --help Show help [boolean]
97
- -v, --version Show version number [boolean]
98
- --legacy-env Use legacy environments [boolean]
96
+ -c, --config Path to .toml configuration file [string]
97
+ -h, --help Show help [boolean]
98
+ -v, --version Show version number [boolean]
99
99
 
100
100
  Options:
101
101
  -e, --env Perform on a specific environment [string]
102
- --preview Interact with a preview namespace [boolean]
103
- X [ERROR] Unknown arguments: def, ghi
102
+ --preview Interact with a preview namespace [boolean]"
103
+ `);
104
+ expect(std.err).toMatchInlineSnapshot(`
105
+ "X [ERROR] Unknown arguments: def, ghi
104
106
 
105
107
  "
106
108
  `);
107
- });
109
+ });
108
110
 
109
- it("should error if the namespace to create is not valid", async () => {
110
- await expect(
111
- runWrangler("kv:namespace create abc-def")
112
- ).rejects.toThrowErrorMatchingInlineSnapshot(
113
- `"The namespace binding name \\"abc-def\\" is invalid. It can only have alphanumeric and _ characters, and cannot begin with a number."`
114
- );
111
+ it("should error if the namespace to create is not valid", async () => {
112
+ await expect(
113
+ runWrangler("kv:namespace create abc-def")
114
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
115
+ `"The namespace binding name \\"abc-def\\" is invalid. It can only have alphanumeric and _ characters, and cannot begin with a number."`
116
+ );
115
117
 
116
- expect(std.out).toMatchInlineSnapshot(`
118
+ expect(std.out).toMatchInlineSnapshot(`
117
119
  "
118
- "
119
- `);
120
- expect(std.err).toMatchInlineSnapshot(`
121
- "wrangler kv:namespace create <namespace>
120
+ wrangler kv:namespace create <namespace>
122
121
 
123
122
  Create a new namespace
124
123
 
@@ -126,362 +125,410 @@ describe("wrangler", () => {
126
125
  namespace The name of the new namespace [string] [required]
127
126
 
128
127
  Flags:
129
- -c, --config Path to .toml configuration file [string]
130
- -h, --help Show help [boolean]
131
- -v, --version Show version number [boolean]
132
- --legacy-env Use legacy environments [boolean]
128
+ -c, --config Path to .toml configuration file [string]
129
+ -h, --help Show help [boolean]
130
+ -v, --version Show version number [boolean]
133
131
 
134
132
  Options:
135
133
  -e, --env Perform on a specific environment [string]
136
- --preview Interact with a preview namespace [boolean]
137
- X [ERROR] The namespace binding name \\"abc-def\\" is invalid. It can only have alphanumeric and _ characters, and cannot begin with a number.
134
+ --preview Interact with a preview namespace [boolean]"
135
+ `);
136
+ expect(std.err).toMatchInlineSnapshot(`
137
+ "X [ERROR] The namespace binding name \\"abc-def\\" is invalid. It can only have alphanumeric and _ characters, and cannot begin with a number.
138
138
 
139
139
  "
140
140
  `);
141
- });
141
+ });
142
142
 
143
- it("should create a namespace", async () => {
144
- mockCreateRequest("worker-UnitTestNamespace");
145
- await runWrangler("kv:namespace create UnitTestNamespace");
146
- expect(std.out).toMatchInlineSnapshot(`
143
+ it("should create a namespace", async () => {
144
+ mockCreateRequest("worker-UnitTestNamespace");
145
+ await runWrangler("kv:namespace create UnitTestNamespace");
146
+ expect(std.out).toMatchInlineSnapshot(`
147
147
  "🌀 Creating namespace with title \\"worker-UnitTestNamespace\\"
148
148
  ✨ Success!
149
149
  Add the following to your configuration file in your kv_namespaces array:
150
150
  { binding = \\"UnitTestNamespace\\", id = \\"some-namespace-id\\" }"
151
151
  `);
152
- });
152
+ });
153
153
 
154
- it("should create a preview namespace if configured to do so", async () => {
155
- mockCreateRequest("worker-UnitTestNamespace_preview");
156
- await runWrangler("kv:namespace create UnitTestNamespace --preview");
157
- expect(std.out).toMatchInlineSnapshot(`
154
+ it("should create a preview namespace if configured to do so", async () => {
155
+ mockCreateRequest("worker-UnitTestNamespace_preview");
156
+ await runWrangler("kv:namespace create UnitTestNamespace --preview");
157
+ expect(std.out).toMatchInlineSnapshot(`
158
158
  "🌀 Creating namespace with title \\"worker-UnitTestNamespace_preview\\"
159
159
  ✨ Success!
160
160
  Add the following to your configuration file in your kv_namespaces array:
161
161
  { binding = \\"UnitTestNamespace\\", preview_id = \\"some-namespace-id\\" }"
162
162
  `);
163
- });
163
+ });
164
164
 
165
- it("should create a namespace using configured worker name", async () => {
166
- writeFileSync("./wrangler.toml", 'name = "other-worker"', "utf-8");
167
- mockCreateRequest("other-worker-UnitTestNamespace");
168
- await runWrangler("kv:namespace create UnitTestNamespace");
169
- expect(std.out).toMatchInlineSnapshot(`
165
+ it("should create a namespace using configured worker name", async () => {
166
+ writeFileSync("./wrangler.toml", 'name = "other-worker"', "utf-8");
167
+ mockCreateRequest("other-worker-UnitTestNamespace");
168
+ await runWrangler("kv:namespace create UnitTestNamespace");
169
+ expect(std.out).toMatchInlineSnapshot(`
170
170
  "🌀 Creating namespace with title \\"other-worker-UnitTestNamespace\\"
171
171
  ✨ Success!
172
172
  Add the following to your configuration file in your kv_namespaces array:
173
173
  { binding = \\"UnitTestNamespace\\", id = \\"some-namespace-id\\" }"
174
174
  `);
175
- });
176
-
177
- it("should create a namespace in an environment if configured to do so", async () => {
178
- mockCreateRequest("worker-customEnv-UnitTestNamespace");
179
- await runWrangler(
180
- "kv:namespace create UnitTestNamespace --env customEnv"
181
- );
182
- expect(std.out).toMatchInlineSnapshot(`
175
+ });
176
+
177
+ it("should create a namespace in an environment if configured to do so", async () => {
178
+ mockCreateRequest("worker-customEnv-UnitTestNamespace");
179
+ await runWrangler(
180
+ "kv:namespace create UnitTestNamespace --env customEnv"
181
+ );
182
+ expect(std.out).toMatchInlineSnapshot(`
183
183
  "🌀 Creating namespace with title \\"worker-customEnv-UnitTestNamespace\\"
184
184
  ✨ Success!
185
185
  Add the following to your configuration file in your kv_namespaces array under [env.customEnv]:
186
186
  { binding = \\"UnitTestNamespace\\", id = \\"some-namespace-id\\" }"
187
187
  `);
188
- });
189
- });
190
-
191
- describe("list", () => {
192
- function mockListRequest(namespaces: unknown[]) {
193
- const requests = { count: 0 };
194
- setMockResponse(
195
- "/accounts/:accountId/storage/kv/namespaces",
196
- ([_url, accountId], init, query) => {
197
- requests.count++;
198
- expect(accountId).toEqual("some-account-id");
199
- expect(query.get("per_page")).toEqual("100");
200
- expect(query.get("order")).toEqual("title");
201
- expect(query.get("direction")).toEqual("asc");
202
- expect(query.get("page")).toEqual(`${requests.count}`);
203
- expect(init).toEqual({});
204
- const pageSize = Number(query.get("per_page"));
205
- const page = Number(query.get("page"));
206
- return namespaces.slice((page - 1) * pageSize, page * pageSize);
207
- }
208
- );
209
- return requests;
210
- }
211
-
212
- it("should list namespaces", async () => {
213
- const kvNamespaces: KVNamespaceInfo[] = [
214
- { title: "title-1", id: "id-1" },
215
- { title: "title-2", id: "id-2" },
216
- ];
217
- mockListRequest(kvNamespaces);
218
- await runWrangler("kv:namespace list");
219
-
220
- expect(std.err).toMatchInlineSnapshot(`""`);
221
- const namespaces = JSON.parse(std.out);
222
- expect(namespaces).toEqual(kvNamespaces);
223
- });
224
-
225
- it("should make multiple requests for paginated results", async () => {
226
- // Create a lot of mock namespaces, so that the fetch requests will be paginated
227
- const kvNamespaces: KVNamespaceInfo[] = [];
228
- for (let i = 0; i < 550; i++) {
229
- kvNamespaces.push({ title: "title-" + i, id: "id-" + i });
230
- }
231
- const requests = mockListRequest(kvNamespaces);
232
- await runWrangler("kv:namespace list");
233
- const namespaces = JSON.parse(std.out);
234
- expect(namespaces).toEqual(kvNamespaces);
235
- expect(requests.count).toEqual(6);
236
- });
237
- });
238
-
239
- describe("delete", () => {
240
- function mockDeleteRequest(expectedNamespaceId: string) {
241
- const requests = { count: 0 };
242
- setMockResponse(
243
- "/accounts/:accountId/storage/kv/namespaces/:namespaceId",
244
- "DELETE",
245
- ([_url, accountId, namespaceId]) => {
246
- requests.count++;
247
- expect(accountId).toEqual("some-account-id");
248
- expect(namespaceId).toEqual(expectedNamespaceId);
249
- return null;
250
- }
251
- );
252
- return requests;
253
- }
254
-
255
- it("should delete a namespace specified by id", async () => {
256
- const requests = mockDeleteRequest("some-namespace-id");
257
- await runWrangler(
258
- `kv:namespace delete --namespace-id some-namespace-id`
259
- );
260
- expect(requests.count).toEqual(1);
261
- });
262
-
263
- it("should delete a namespace specified by binding name", async () => {
264
- writeWranglerConfig();
265
- const requests = mockDeleteRequest("bound-id");
266
- await runWrangler(
267
- `kv:namespace delete --binding someBinding --preview false`
268
- );
269
- expect(requests.count).toEqual(1);
270
- });
271
-
272
- it("should delete a preview namespace specified by binding name", async () => {
273
- writeWranglerConfig();
274
- const requests = mockDeleteRequest("preview-bound-id");
275
- await runWrangler(
276
- `kv:namespace delete --binding someBinding --preview`
277
- );
278
- expect(requests.count).toEqual(1);
279
- });
280
-
281
- it("should error if a given binding name is not in the configured kv namespaces", async () => {
282
- writeWranglerConfig();
283
- await expect(runWrangler("kv:namespace delete --binding otherBinding"))
284
- .rejects.toThrowErrorMatchingInlineSnapshot(`
285
- "Not able to delete namespace.
286
- A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."
287
- `);
288
- expect(std.err).toMatchInlineSnapshot(`
289
- "wrangler kv:namespace delete
290
-
291
- Deletes a given namespace.
292
-
293
- Flags:
294
- -c, --config Path to .toml configuration file [string]
295
- -h, --help Show help [boolean]
296
- -v, --version Show version number [boolean]
297
- --legacy-env Use legacy environments [boolean]
298
-
299
- Options:
300
- --binding The name of the namespace to delete [string]
301
- --namespace-id The id of the namespace to delete [string]
302
- -e, --env Perform on a specific environment [string]
303
- --preview Interact with a preview namespace [boolean]
304
- X [ERROR] Not able to delete namespace.
188
+ });
189
+ });
190
+
191
+ describe("list", () => {
192
+ function mockListRequest(namespaces: unknown[]) {
193
+ const requests = { count: 0 };
194
+ setMockResponse(
195
+ "/accounts/:accountId/storage/kv/namespaces",
196
+ ([_url, accountId], init, query) => {
197
+ requests.count++;
198
+ expect(accountId).toEqual("some-account-id");
199
+ expect(query.get("per_page")).toEqual("100");
200
+ expect(query.get("order")).toEqual("title");
201
+ expect(query.get("direction")).toEqual("asc");
202
+ expect(query.get("page")).toEqual(`${requests.count}`);
203
+ expect(init).toEqual({});
204
+ const pageSize = Number(query.get("per_page"));
205
+ const page = Number(query.get("page"));
206
+ return namespaces.slice((page - 1) * pageSize, page * pageSize);
207
+ }
208
+ );
209
+ return requests;
210
+ }
211
+
212
+ it("should list namespaces", async () => {
213
+ const kvNamespaces: KVNamespaceInfo[] = [
214
+ { title: "title-1", id: "id-1" },
215
+ { title: "title-2", id: "id-2" },
216
+ ];
217
+ mockListRequest(kvNamespaces);
218
+ await runWrangler("kv:namespace list");
219
+
220
+ expect(std.err).toMatchInlineSnapshot(`""`);
221
+ const namespaces = JSON.parse(std.out);
222
+ expect(namespaces).toEqual(kvNamespaces);
223
+ });
224
+
225
+ it("should make multiple requests for paginated results", async () => {
226
+ // Create a lot of mock namespaces, so that the fetch requests will be paginated
227
+ const kvNamespaces: KVNamespaceInfo[] = [];
228
+ for (let i = 0; i < 550; i++) {
229
+ kvNamespaces.push({ title: "title-" + i, id: "id-" + i });
230
+ }
231
+ const requests = mockListRequest(kvNamespaces);
232
+ await runWrangler("kv:namespace list");
233
+ const namespaces = JSON.parse(std.out);
234
+ expect(namespaces).toEqual(kvNamespaces);
235
+ expect(requests.count).toEqual(6);
236
+ });
237
+ });
238
+
239
+ describe("delete", () => {
240
+ function mockDeleteRequest(expectedNamespaceId: string) {
241
+ const requests = { count: 0 };
242
+ setMockResponse(
243
+ "/accounts/:accountId/storage/kv/namespaces/:namespaceId",
244
+ "DELETE",
245
+ ([_url, accountId, namespaceId]) => {
246
+ requests.count++;
247
+ expect(accountId).toEqual("some-account-id");
248
+ expect(namespaceId).toEqual(expectedNamespaceId);
249
+ return null;
250
+ }
251
+ );
252
+ return requests;
253
+ }
254
+
255
+ it("should delete a namespace specified by id", async () => {
256
+ const requests = mockDeleteRequest("some-namespace-id");
257
+ await runWrangler(
258
+ `kv:namespace delete --namespace-id some-namespace-id`
259
+ );
260
+ expect(requests.count).toEqual(1);
261
+ });
262
+
263
+ it("should delete a namespace specified by binding name", async () => {
264
+ writeWranglerConfig();
265
+ const requests = mockDeleteRequest("bound-id");
266
+ await runWrangler(
267
+ `kv:namespace delete --binding someBinding --preview false`
268
+ );
269
+ expect(requests.count).toEqual(1);
270
+ });
271
+
272
+ it("should delete a preview namespace specified by binding name", async () => {
273
+ writeWranglerConfig();
274
+ const requests = mockDeleteRequest("preview-bound-id");
275
+ await runWrangler(
276
+ `kv:namespace delete --binding someBinding --preview`
277
+ );
278
+ expect(requests.count).toEqual(1);
279
+ });
280
+
281
+ it("should error if a given binding name is not in the configured kv namespaces", async () => {
282
+ writeWranglerConfig();
283
+ await expect(runWrangler("kv:namespace delete --binding otherBinding"))
284
+ .rejects.toThrowErrorMatchingInlineSnapshot(`
285
+ "Not able to delete namespace.
286
+ A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."
287
+ `);
288
+ expect(std.err).toMatchInlineSnapshot(`
289
+ "X [ERROR] Not able to delete namespace.
305
290
 
306
291
  A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
307
292
 
308
293
  "
309
294
  `);
310
- });
311
-
312
- it("should delete a namespace specified by binding name in a given environment", async () => {
313
- writeWranglerConfig();
314
- const requests = mockDeleteRequest("env-bound-id");
315
- await runWrangler(
316
- "kv:namespace delete --binding someBinding --env some-environment --preview false"
317
- );
318
-
319
- expect(std.out).toMatchInlineSnapshot(`""`);
320
- expect(std.err).toMatchInlineSnapshot(`""`);
321
- expect(requests.count).toEqual(1);
322
- });
323
-
324
- it("should delete a preview namespace specified by binding name in a given environment", async () => {
325
- writeWranglerConfig();
326
- const requests = mockDeleteRequest("preview-env-bound-id");
327
- await runWrangler(
328
- `kv:namespace delete --binding someBinding --env some-environment --preview`
329
- );
330
- expect(requests.count).toEqual(1);
331
- });
332
- });
333
- });
334
-
335
- describe("kv:key", () => {
336
- describe("put", () => {
337
- function mockKeyPutRequest(
338
- expectedNamespaceId: string,
339
- expectedKV: KeyValue
340
- ) {
341
- const requests = { count: 0 };
342
- setMockResponse(
343
- "/accounts/:accountId/storage/kv/namespaces/:namespaceId/values/:key",
344
- "PUT",
345
- ([_url, accountId, namespaceId, key], { body }, query) => {
346
- requests.count++;
347
- expect(accountId).toEqual("some-account-id");
348
- expect(namespaceId).toEqual(expectedNamespaceId);
349
- expect(key).toEqual(expectedKV.key);
350
- expect(body).toEqual(expectedKV.value);
351
- if (expectedKV.expiration !== undefined) {
352
- expect(query.get("expiration")).toEqual(
353
- `${expectedKV.expiration}`
354
- );
355
- } else {
356
- expect(query.has("expiration")).toBe(false);
357
- }
358
- if (expectedKV.expiration_ttl) {
359
- expect(query.get("expiration_ttl")).toEqual(
360
- `${expectedKV.expiration_ttl}`
361
- );
362
- } else {
363
- expect(query.has("expiration_ttl")).toBe(false);
364
- }
365
- return null;
366
- }
367
- );
368
- return requests;
369
- }
370
-
371
- it("should put a key in a given namespace specified by namespace-id", async () => {
372
- const requests = mockKeyPutRequest("some-namespace-id", {
373
- key: "my-key",
374
- value: "my-value",
375
- });
376
-
377
- await runWrangler(
378
- "kv:key put my-key my-value --namespace-id some-namespace-id"
379
- );
380
-
381
- expect(requests.count).toEqual(1);
382
- expect(std.out).toMatchInlineSnapshot(
383
- `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace some-namespace-id."`
384
- );
385
- expect(std.err).toMatchInlineSnapshot(`""`);
386
- });
387
-
388
- it("should put a key in a given namespace specified by binding", async () => {
389
- writeWranglerConfig();
390
- const requests = mockKeyPutRequest("bound-id", {
391
- key: "my-key",
392
- value: "my-value",
393
- });
394
- await runWrangler(
395
- "kv:key put my-key my-value --binding someBinding --preview false"
396
- );
397
-
398
- expect(std.out).toMatchInlineSnapshot(
399
- `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace bound-id."`
400
- );
401
- expect(std.err).toMatchInlineSnapshot(`""`);
402
- expect(requests.count).toEqual(1);
403
- });
404
-
405
- it("should put a key in a given preview namespace specified by binding", async () => {
406
- writeWranglerConfig();
407
- const requests = mockKeyPutRequest("preview-bound-id", {
408
- key: "my-key",
409
- value: "my-value",
410
- });
411
-
412
- await runWrangler(
413
- "kv:key put my-key my-value --binding someBinding --preview"
414
- );
415
-
416
- expect(std.out).toMatchInlineSnapshot(
417
- `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace preview-bound-id."`
418
- );
419
- expect(std.err).toMatchInlineSnapshot(`""`);
420
- expect(requests.count).toEqual(1);
421
- });
422
-
423
- it("should add expiration and ttl properties when putting a key", async () => {
424
- const requests = mockKeyPutRequest("some-namespace-id", {
425
- key: "my-key",
426
- value: "my-value",
427
- expiration: 10,
428
- expiration_ttl: 20,
429
- });
430
- await runWrangler(
431
- "kv:key put my-key my-value --namespace-id some-namespace-id --expiration 10 --ttl 20"
432
- );
433
- expect(requests.count).toEqual(1);
434
- expect(std.out).toMatchInlineSnapshot(
435
- `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace some-namespace-id."`
436
- );
437
- expect(std.err).toMatchInlineSnapshot(`""`);
438
- });
439
-
440
- it("should put a key to the specified environment in a given namespace", async () => {
441
- writeWranglerConfig();
442
- const requests = mockKeyPutRequest("env-bound-id", {
443
- key: "my-key",
444
- value: "my-value",
445
- });
446
- await runWrangler(
447
- "kv:key put my-key my-value --binding someBinding --env some-environment --preview false"
448
- );
449
- expect(std.out).toMatchInlineSnapshot(
450
- `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace env-bound-id."`
451
- );
452
- expect(std.err).toMatchInlineSnapshot(`""`);
453
- expect(requests.count).toEqual(1);
454
- });
455
-
456
- it("should put a key with a value loaded from a given path", async () => {
457
- writeFileSync("foo.txt", "file-contents", "utf-8");
458
- const requests = mockKeyPutRequest("some-namespace-id", {
459
- key: "my-key",
460
- value: "file-contents",
461
- });
462
- await runWrangler(
463
- "kv:key put my-key --namespace-id some-namespace-id --path foo.txt"
464
- );
465
- expect(std.out).toMatchInlineSnapshot(
466
- `"Writing the contents of foo.txt to the key \\"my-key\\" on namespace some-namespace-id."`
467
- );
468
- expect(std.err).toMatchInlineSnapshot(`""`);
469
- expect(requests.count).toEqual(1);
470
- });
471
-
472
- it("should error if no key is provided", async () => {
473
- await expect(
474
- runWrangler("kv:key put")
475
- ).rejects.toThrowErrorMatchingInlineSnapshot(
476
- `"Not enough non-option arguments: got 0, need at least 1"`
477
- );
478
-
479
- expect(std.out).toMatchInlineSnapshot(`
480
- "
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
+ "Deleting KV namespace env-bound-id.
306
+ Deleted KV namespace env-bound-id."
307
+ `);
308
+ expect(std.err).toMatchInlineSnapshot(`""`);
309
+ expect(requests.count).toEqual(1);
310
+ });
311
+
312
+ it("should delete a preview namespace specified by binding name in a given environment", async () => {
313
+ writeWranglerConfig();
314
+ const requests = mockDeleteRequest("preview-env-bound-id");
315
+ await runWrangler(
316
+ `kv:namespace delete --binding someBinding --env some-environment --preview`
317
+ );
318
+ expect(requests.count).toEqual(1);
319
+ });
320
+ });
321
+ });
322
+
323
+ describe("kv:key", () => {
324
+ describe("put", () => {
325
+ function mockKeyPutRequest(
326
+ expectedNamespaceId: string,
327
+ expectedKV: KeyValue
328
+ ) {
329
+ const requests = { count: 0 };
330
+ setMockResponse(
331
+ "/accounts/:accountId/storage/kv/namespaces/:namespaceId/values/:key",
332
+ "PUT",
333
+ ([_url, accountId, namespaceId, key], { body }, query) => {
334
+ requests.count++;
335
+ expect(accountId).toEqual("some-account-id");
336
+ expect(namespaceId).toEqual(expectedNamespaceId);
337
+ expect(key).toEqual(expectedKV.key);
338
+ if (expectedKV.metadata) {
339
+ expect(body).toBeInstanceOf(FormData);
340
+ expect((body as FormData).get("value")).toEqual(expectedKV.value);
341
+ expect((body as FormData).get("metadata")).toEqual(
342
+ JSON.stringify(expectedKV.metadata)
343
+ );
344
+ } else {
345
+ expect(body).toEqual(expectedKV.value);
346
+ }
347
+ if (expectedKV.expiration !== undefined) {
348
+ expect(query.get("expiration")).toEqual(
349
+ `${expectedKV.expiration}`
350
+ );
351
+ } else {
352
+ expect(query.has("expiration")).toBe(false);
353
+ }
354
+ if (expectedKV.expiration_ttl) {
355
+ expect(query.get("expiration_ttl")).toEqual(
356
+ `${expectedKV.expiration_ttl}`
357
+ );
358
+ } else {
359
+ expect(query.has("expiration_ttl")).toBe(false);
360
+ }
361
+ return null;
362
+ }
363
+ );
364
+ return requests;
365
+ }
366
+
367
+ it("should put a key in a given namespace specified by namespace-id", async () => {
368
+ const requests = mockKeyPutRequest("some-namespace-id", {
369
+ key: "my-key",
370
+ value: "my-value",
371
+ });
372
+
373
+ await runWrangler(
374
+ "kv:key put my-key my-value --namespace-id some-namespace-id"
375
+ );
376
+
377
+ expect(requests.count).toEqual(1);
378
+ expect(std.out).toMatchInlineSnapshot(
379
+ `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace some-namespace-id."`
380
+ );
381
+ expect(std.err).toMatchInlineSnapshot(`""`);
382
+ });
383
+
384
+ it("should encode the key in the api request to put a value", async () => {
385
+ const requests = mockKeyPutRequest("DS9", {
386
+ key: "%2Fmy-key",
387
+ value: "my-value",
388
+ });
389
+
390
+ await runWrangler("kv:key put /my-key my-value --namespace-id DS9");
391
+
392
+ expect(requests.count).toEqual(1);
393
+ expect(std.out).toMatchInlineSnapshot(
394
+ `"Writing the value \\"my-value\\" to key \\"/my-key\\" on namespace DS9."`
395
+ );
396
+ expect(std.err).toMatchInlineSnapshot(`""`);
397
+ });
398
+
399
+ it("should put a key in a given namespace specified by binding", async () => {
400
+ writeWranglerConfig();
401
+ const requests = mockKeyPutRequest("bound-id", {
402
+ key: "my-key",
403
+ value: "my-value",
404
+ });
405
+ await runWrangler(
406
+ "kv:key put my-key my-value --binding someBinding --preview false"
407
+ );
408
+
409
+ expect(std.out).toMatchInlineSnapshot(
410
+ `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace bound-id."`
411
+ );
412
+ expect(std.err).toMatchInlineSnapshot(`""`);
413
+ expect(requests.count).toEqual(1);
414
+ });
415
+
416
+ it("should put a key in a given preview namespace specified by binding", async () => {
417
+ writeWranglerConfig();
418
+ const requests = mockKeyPutRequest("preview-bound-id", {
419
+ key: "my-key",
420
+ value: "my-value",
421
+ });
422
+
423
+ await runWrangler(
424
+ "kv:key put my-key my-value --binding someBinding --preview"
425
+ );
426
+
427
+ expect(std.out).toMatchInlineSnapshot(
428
+ `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace preview-bound-id."`
429
+ );
430
+ expect(std.err).toMatchInlineSnapshot(`""`);
431
+ expect(requests.count).toEqual(1);
432
+ });
433
+
434
+ it("should add expiration and ttl properties when putting a key", async () => {
435
+ const requests = mockKeyPutRequest("some-namespace-id", {
436
+ key: "my-key",
437
+ value: "my-value",
438
+ expiration: 10,
439
+ expiration_ttl: 20,
440
+ });
441
+ await runWrangler(
442
+ "kv:key put my-key my-value --namespace-id some-namespace-id --expiration 10 --ttl 20"
443
+ );
444
+ expect(requests.count).toEqual(1);
445
+ expect(std.out).toMatchInlineSnapshot(
446
+ `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace some-namespace-id."`
447
+ );
448
+ expect(std.err).toMatchInlineSnapshot(`""`);
449
+ });
450
+
451
+ it("should put a key to the specified environment in a given namespace", async () => {
452
+ writeWranglerConfig();
453
+ const requests = mockKeyPutRequest("env-bound-id", {
454
+ key: "my-key",
455
+ value: "my-value",
456
+ });
457
+ await runWrangler(
458
+ "kv:key put my-key my-value --binding someBinding --env some-environment --preview false"
459
+ );
460
+ expect(std.out).toMatchInlineSnapshot(
461
+ `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace env-bound-id."`
462
+ );
463
+ expect(std.err).toMatchInlineSnapshot(`""`);
464
+ expect(requests.count).toEqual(1);
465
+ });
466
+
467
+ it("should put a key with a value loaded from a given path", async () => {
468
+ const buf = Buffer.from("file-contents", "utf-8");
469
+ writeFileSync("foo.txt", buf);
470
+ const requests = mockKeyPutRequest("some-namespace-id", {
471
+ key: "my-key",
472
+ value: buf,
473
+ });
474
+ await runWrangler(
475
+ "kv:key put my-key --namespace-id some-namespace-id --path foo.txt"
476
+ );
477
+ expect(std.out).toMatchInlineSnapshot(
478
+ `"Writing the contents of foo.txt to the key \\"my-key\\" on namespace some-namespace-id."`
479
+ );
480
+ expect(std.err).toMatchInlineSnapshot(`""`);
481
+ expect(requests.count).toEqual(1);
482
+ });
483
+
484
+ it("should put a key with a binary value loaded from a given path", async () => {
485
+ const buf = Buffer.from(
486
+ "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAiSURBVHgB7coxEQAACMPAgH/PgAM6dGwu49fA/deIBXrgAj2cAhIFT4QxAAAAAElFTkSuQmCC",
487
+ "base64"
488
+ );
489
+ writeFileSync("test.png", buf);
490
+ const requests = mockKeyPutRequest("another-namespace-id", {
491
+ key: "my-key",
492
+ value: buf,
493
+ });
494
+ await runWrangler(
495
+ "kv:key put my-key --namespace-id another-namespace-id --path test.png"
496
+ );
497
+ expect(std.out).toMatchInlineSnapshot(
498
+ `"Writing the contents of test.png to the key \\"my-key\\" on namespace another-namespace-id."`
499
+ );
500
+ expect(std.err).toMatchInlineSnapshot(`""`);
501
+ expect(requests.count).toEqual(1);
502
+ });
503
+
504
+ it("should put a key with metadata", async () => {
505
+ const requests = mockKeyPutRequest("some-namespace-id", {
506
+ key: "dKey",
507
+ value: "dVal",
508
+ metadata: {
509
+ mKey: "mValue",
510
+ },
511
+ });
512
+ await runWrangler(
513
+ `kv:key put dKey dVal --namespace-id some-namespace-id --metadata {"mKey":"mValue"}`
514
+ );
515
+ expect(requests.count).toEqual(1);
516
+ expect(std.out).toMatchInlineSnapshot(
517
+ `"Writing the value \\"dVal\\" to key \\"dKey\\" on namespace some-namespace-id with metadata \\"{\\"mKey\\":\\"mValue\\"}\\"."`
518
+ );
519
+ expect(std.err).toMatchInlineSnapshot(`""`);
520
+ });
521
+
522
+ it("should error if no key is provided", async () => {
523
+ await expect(
524
+ runWrangler("kv:key put")
525
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
526
+ `"Not enough non-option arguments: got 0, need at least 1"`
527
+ );
528
+
529
+ expect(std.out).toMatchInlineSnapshot(`
481
530
  "
482
- `);
483
- expect(std.err).toMatchInlineSnapshot(`
484
- "wrangler kv:key put <key> [value]
531
+ wrangler kv:key put <key> [value]
485
532
 
486
533
  Writes a single key/value pair to the given namespace.
487
534
 
@@ -490,10 +537,9 @@ describe("wrangler", () => {
490
537
  value The value to write [string]
491
538
 
492
539
  Flags:
493
- -c, --config Path to .toml configuration file [string]
494
- -h, --help Show help [boolean]
495
- -v, --version Show version number [boolean]
496
- --legacy-env Use legacy environments [boolean]
540
+ -c, --config Path to .toml configuration file [string]
541
+ -h, --help Show help [boolean]
542
+ -v, --version Show version number [boolean]
497
543
 
498
544
  Options:
499
545
  --binding The binding of the namespace to write to [string]
@@ -502,26 +548,26 @@ describe("wrangler", () => {
502
548
  --preview Interact with a preview namespace [boolean]
503
549
  --ttl Time for which the entries should be visible [number]
504
550
  --expiration Time since the UNIX epoch after which the entry expires [number]
505
- --path Read value from the file at a given path [string]
506
- X [ERROR] Not enough non-option arguments: got 0, need at least 1
551
+ --metadata Arbitrary JSON that is associated with a key [string]
552
+ --path Read value from the file at a given path [string]"
553
+ `);
554
+ expect(std.err).toMatchInlineSnapshot(`
555
+ "X [ERROR] Not enough non-option arguments: got 0, need at least 1
507
556
 
508
557
  "
509
558
  `);
510
- });
559
+ });
511
560
 
512
- it("should error if no binding nor namespace is provided", async () => {
513
- await expect(
514
- runWrangler("kv:key put foo bar")
515
- ).rejects.toThrowErrorMatchingInlineSnapshot(
516
- `"Exactly one of the arguments binding and namespace-id is required"`
517
- );
561
+ it("should error if no binding nor namespace is provided", async () => {
562
+ await expect(
563
+ runWrangler("kv:key put foo bar")
564
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
565
+ `"Exactly one of the arguments binding and namespace-id is required"`
566
+ );
518
567
 
519
- expect(std.out).toMatchInlineSnapshot(`
520
- "
568
+ expect(std.out).toMatchInlineSnapshot(`
521
569
  "
522
- `);
523
- expect(std.err).toMatchInlineSnapshot(`
524
- "wrangler kv:key put <key> [value]
570
+ wrangler kv:key put <key> [value]
525
571
 
526
572
  Writes a single key/value pair to the given namespace.
527
573
 
@@ -530,10 +576,9 @@ describe("wrangler", () => {
530
576
  value The value to write [string]
531
577
 
532
578
  Flags:
533
- -c, --config Path to .toml configuration file [string]
534
- -h, --help Show help [boolean]
535
- -v, --version Show version number [boolean]
536
- --legacy-env Use legacy environments [boolean]
579
+ -c, --config Path to .toml configuration file [string]
580
+ -h, --help Show help [boolean]
581
+ -v, --version Show version number [boolean]
537
582
 
538
583
  Options:
539
584
  --binding The binding of the namespace to write to [string]
@@ -542,26 +587,26 @@ describe("wrangler", () => {
542
587
  --preview Interact with a preview namespace [boolean]
543
588
  --ttl Time for which the entries should be visible [number]
544
589
  --expiration Time since the UNIX epoch after which the entry expires [number]
545
- --path Read value from the file at a given path [string]
546
- X [ERROR] Exactly one of the arguments binding and namespace-id is required
590
+ --metadata Arbitrary JSON that is associated with a key [string]
591
+ --path Read value from the file at a given path [string]"
592
+ `);
593
+ expect(std.err).toMatchInlineSnapshot(`
594
+ "X [ERROR] Exactly one of the arguments binding and namespace-id is required
547
595
 
548
596
  "
549
597
  `);
550
- });
598
+ });
551
599
 
552
- it("should error if both binding and namespace is provided", async () => {
553
- await expect(
554
- runWrangler("kv:key put foo bar --binding x --namespace-id y")
555
- ).rejects.toThrowErrorMatchingInlineSnapshot(
556
- `"Arguments binding and namespace-id are mutually exclusive"`
557
- );
600
+ it("should error if both binding and namespace is provided", async () => {
601
+ await expect(
602
+ runWrangler("kv:key put foo bar --binding x --namespace-id y")
603
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
604
+ `"Arguments binding and namespace-id are mutually exclusive"`
605
+ );
558
606
 
559
- expect(std.out).toMatchInlineSnapshot(`
560
- "
607
+ expect(std.out).toMatchInlineSnapshot(`
561
608
  "
562
- `);
563
- expect(std.err).toMatchInlineSnapshot(`
564
- "wrangler kv:key put <key> [value]
609
+ wrangler kv:key put <key> [value]
565
610
 
566
611
  Writes a single key/value pair to the given namespace.
567
612
 
@@ -570,10 +615,9 @@ describe("wrangler", () => {
570
615
  value The value to write [string]
571
616
 
572
617
  Flags:
573
- -c, --config Path to .toml configuration file [string]
574
- -h, --help Show help [boolean]
575
- -v, --version Show version number [boolean]
576
- --legacy-env Use legacy environments [boolean]
618
+ -c, --config Path to .toml configuration file [string]
619
+ -h, --help Show help [boolean]
620
+ -v, --version Show version number [boolean]
577
621
 
578
622
  Options:
579
623
  --binding The binding of the namespace to write to [string]
@@ -582,26 +626,26 @@ describe("wrangler", () => {
582
626
  --preview Interact with a preview namespace [boolean]
583
627
  --ttl Time for which the entries should be visible [number]
584
628
  --expiration Time since the UNIX epoch after which the entry expires [number]
585
- --path Read value from the file at a given path [string]
586
- X [ERROR] Arguments binding and namespace-id are mutually exclusive
629
+ --metadata Arbitrary JSON that is associated with a key [string]
630
+ --path Read value from the file at a given path [string]"
631
+ `);
632
+ expect(std.err).toMatchInlineSnapshot(`
633
+ "X [ERROR] Arguments binding and namespace-id are mutually exclusive
587
634
 
588
635
  "
589
636
  `);
590
- });
637
+ });
591
638
 
592
- it("should error if no value nor path is provided", async () => {
593
- await expect(
594
- runWrangler("kv:key put key --namespace-id 12345")
595
- ).rejects.toThrowErrorMatchingInlineSnapshot(
596
- `"Exactly one of the arguments value and path is required"`
597
- );
639
+ it("should error if no value nor path is provided", async () => {
640
+ await expect(
641
+ runWrangler("kv:key put key --namespace-id 12345")
642
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
643
+ `"Exactly one of the arguments value and path is required"`
644
+ );
598
645
 
599
- expect(std.out).toMatchInlineSnapshot(`
646
+ expect(std.out).toMatchInlineSnapshot(`
600
647
  "
601
- "
602
- `);
603
- expect(std.err).toMatchInlineSnapshot(`
604
- "wrangler kv:key put <key> [value]
648
+ wrangler kv:key put <key> [value]
605
649
 
606
650
  Writes a single key/value pair to the given namespace.
607
651
 
@@ -610,10 +654,9 @@ describe("wrangler", () => {
610
654
  value The value to write [string]
611
655
 
612
656
  Flags:
613
- -c, --config Path to .toml configuration file [string]
614
- -h, --help Show help [boolean]
615
- -v, --version Show version number [boolean]
616
- --legacy-env Use legacy environments [boolean]
657
+ -c, --config Path to .toml configuration file [string]
658
+ -h, --help Show help [boolean]
659
+ -v, --version Show version number [boolean]
617
660
 
618
661
  Options:
619
662
  --binding The binding of the namespace to write to [string]
@@ -622,26 +665,26 @@ describe("wrangler", () => {
622
665
  --preview Interact with a preview namespace [boolean]
623
666
  --ttl Time for which the entries should be visible [number]
624
667
  --expiration Time since the UNIX epoch after which the entry expires [number]
625
- --path Read value from the file at a given path [string]
626
- X [ERROR] Exactly one of the arguments value and path is required
668
+ --metadata Arbitrary JSON that is associated with a key [string]
669
+ --path Read value from the file at a given path [string]"
670
+ `);
671
+ expect(std.err).toMatchInlineSnapshot(`
672
+ "X [ERROR] Exactly one of the arguments value and path is required
627
673
 
628
674
  "
629
675
  `);
630
- });
676
+ });
631
677
 
632
- it("should error if both value and path is provided", async () => {
633
- await expect(
634
- runWrangler("kv:key put key value --path xyz --namespace-id 12345")
635
- ).rejects.toThrowErrorMatchingInlineSnapshot(
636
- `"Arguments value and path are mutually exclusive"`
637
- );
678
+ it("should error if both value and path is provided", async () => {
679
+ await expect(
680
+ runWrangler("kv:key put key value --path xyz --namespace-id 12345")
681
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
682
+ `"Arguments value and path are mutually exclusive"`
683
+ );
638
684
 
639
- expect(std.out).toMatchInlineSnapshot(`
685
+ expect(std.out).toMatchInlineSnapshot(`
640
686
  "
641
- "
642
- `);
643
- expect(std.err).toMatchInlineSnapshot(`
644
- "wrangler kv:key put <key> [value]
687
+ wrangler kv:key put <key> [value]
645
688
 
646
689
  Writes a single key/value pair to the given namespace.
647
690
 
@@ -650,10 +693,9 @@ describe("wrangler", () => {
650
693
  value The value to write [string]
651
694
 
652
695
  Flags:
653
- -c, --config Path to .toml configuration file [string]
654
- -h, --help Show help [boolean]
655
- -v, --version Show version number [boolean]
656
- --legacy-env Use legacy environments [boolean]
696
+ -c, --config Path to .toml configuration file [string]
697
+ -h, --help Show help [boolean]
698
+ -v, --version Show version number [boolean]
657
699
 
658
700
  Options:
659
701
  --binding The binding of the namespace to write to [string]
@@ -662,67 +704,70 @@ describe("wrangler", () => {
662
704
  --preview Interact with a preview namespace [boolean]
663
705
  --ttl Time for which the entries should be visible [number]
664
706
  --expiration Time since the UNIX epoch after which the entry expires [number]
665
- --path Read value from the file at a given path [string]
666
- X [ERROR] Arguments value and path are mutually exclusive
707
+ --metadata Arbitrary JSON that is associated with a key [string]
708
+ --path Read value from the file at a given path [string]"
709
+ `);
710
+ expect(std.err).toMatchInlineSnapshot(`
711
+ "X [ERROR] Arguments value and path are mutually exclusive
667
712
 
668
713
  "
669
714
  `);
670
- });
715
+ });
671
716
 
672
- it("should error if a given binding name is not in the configured kv namespaces", async () => {
673
- writeWranglerConfig();
674
- await expect(
675
- runWrangler("kv:key put key value --binding otherBinding")
676
- ).rejects.toThrowErrorMatchingInlineSnapshot(
677
- `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
678
- );
717
+ it("should error if a given binding name is not in the configured kv namespaces", async () => {
718
+ writeWranglerConfig();
719
+ await expect(
720
+ runWrangler("kv:key put key value --binding otherBinding")
721
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
722
+ `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
723
+ );
679
724
 
680
- expect(std.out).toMatchInlineSnapshot(`
725
+ expect(std.out).toMatchInlineSnapshot(`
681
726
  "
682
- If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
727
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
683
728
  `);
684
- expect(std.err).toMatchInlineSnapshot(`
729
+ expect(std.err).toMatchInlineSnapshot(`
685
730
  "X [ERROR] A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
686
731
 
687
732
  "
688
733
  `);
689
- });
690
-
691
- it("should error if a given binding has both preview and non-preview and --preview is not specified", async () => {
692
- writeWranglerConfig();
693
- const requests = mockKeyPutRequest("preview-bound-id", {
694
- key: "my-key",
695
- value: "my-value",
696
- });
697
- await expect(
698
- runWrangler("kv:key put my-key my-value --binding someBinding")
699
- ).rejects.toThrowErrorMatchingInlineSnapshot(
700
- `"someBinding has both a namespace ID and a preview ID. Specify \\"--preview\\" or \\"--preview false\\" to avoid writing data to the wrong namespace."`
701
- );
702
- expect(std.out).toMatchInlineSnapshot(`
734
+ });
735
+
736
+ it("should error if a given binding has both preview and non-preview and --preview is not specified", async () => {
737
+ writeWranglerConfig();
738
+ const requests = mockKeyPutRequest("preview-bound-id", {
739
+ key: "my-key",
740
+ value: "my-value",
741
+ });
742
+ await expect(
743
+ runWrangler("kv:key put my-key my-value --binding someBinding")
744
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
745
+ `"someBinding has both a namespace ID and a preview ID. Specify \\"--preview\\" or \\"--preview false\\" to avoid writing data to the wrong namespace."`
746
+ );
747
+ expect(std.out).toMatchInlineSnapshot(`
703
748
  "
704
- If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
749
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
705
750
  `);
706
- expect(std.err).toMatchInlineSnapshot(`
751
+ expect(std.err).toMatchInlineSnapshot(`
707
752
  "X [ERROR] someBinding has both a namespace ID and a preview ID. Specify \\"--preview\\" or \\"--preview false\\" to avoid writing data to the wrong namespace.
708
753
 
709
754
  "
710
755
  `);
711
- expect(requests.count).toEqual(0);
712
- });
713
- });
714
-
715
- describe("list", () => {
716
- it("should list the keys of a namespace specified by namespace-id", async () => {
717
- const keys = [
718
- { name: "key-1" },
719
- { name: "key-2", expiration: 123456789 },
720
- { name: "key-3", expiration_ttl: 666 },
721
- ];
722
- mockKeyListRequest("some-namespace-id", keys);
723
- await runWrangler("kv:key list --namespace-id some-namespace-id");
724
- expect(std.err).toMatchInlineSnapshot(`""`);
725
- expect(std.out).toMatchInlineSnapshot(`
756
+ expect(requests.count).toEqual(0);
757
+ });
758
+ });
759
+
760
+ describe("list", () => {
761
+ it("should list the keys of a namespace specified by namespace-id", async () => {
762
+ const keys = [
763
+ { name: "key-1" },
764
+ { name: "key-2", expiration: 123456789 },
765
+ { name: "key-3", expiration_ttl: 666 },
766
+ ];
767
+ mockKeyListRequest("some-namespace-id", keys);
768
+ await runWrangler("kv:key list --namespace-id some-namespace-id");
769
+ expect(std.err).toMatchInlineSnapshot(`""`);
770
+ expect(std.out).toMatchInlineSnapshot(`
726
771
  "[
727
772
  {
728
773
  \\"name\\": \\"key-1\\"
@@ -737,16 +782,16 @@ describe("wrangler", () => {
737
782
  }
738
783
  ]"
739
784
  `);
740
- });
785
+ });
741
786
 
742
- it("should list the keys of a namespace specified by binding", async () => {
743
- writeWranglerConfig();
744
- const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
745
- mockKeyListRequest("bound-id", keys);
787
+ it("should list the keys of a namespace specified by binding", async () => {
788
+ writeWranglerConfig();
789
+ const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
790
+ mockKeyListRequest("bound-id", keys);
746
791
 
747
- await runWrangler("kv:key list --binding someBinding");
748
- expect(std.err).toMatchInlineSnapshot(`""`);
749
- expect(std.out).toMatchInlineSnapshot(`
792
+ await runWrangler("kv:key list --binding someBinding");
793
+ expect(std.err).toMatchInlineSnapshot(`""`);
794
+ expect(std.out).toMatchInlineSnapshot(`
750
795
  "[
751
796
  {
752
797
  \\"name\\": \\"key-1\\"
@@ -759,15 +804,15 @@ describe("wrangler", () => {
759
804
  }
760
805
  ]"
761
806
  `);
762
- });
763
-
764
- it("should list the keys of a preview namespace specified by binding", async () => {
765
- writeWranglerConfig();
766
- const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
767
- mockKeyListRequest("preview-bound-id", keys);
768
- await runWrangler("kv:key list --binding someBinding --preview");
769
- expect(std.err).toMatchInlineSnapshot(`""`);
770
- expect(std.out).toMatchInlineSnapshot(`
807
+ });
808
+
809
+ it("should list the keys of a preview namespace specified by binding", async () => {
810
+ writeWranglerConfig();
811
+ const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
812
+ mockKeyListRequest("preview-bound-id", keys);
813
+ await runWrangler("kv:key list --binding someBinding --preview");
814
+ expect(std.err).toMatchInlineSnapshot(`""`);
815
+ expect(std.out).toMatchInlineSnapshot(`
771
816
  "[
772
817
  {
773
818
  \\"name\\": \\"key-1\\"
@@ -780,17 +825,17 @@ describe("wrangler", () => {
780
825
  }
781
826
  ]"
782
827
  `);
783
- });
784
-
785
- it("should list the keys of a namespace specified by binding, in a given environment", async () => {
786
- writeWranglerConfig();
787
- const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
788
- mockKeyListRequest("env-bound-id", keys);
789
- await runWrangler(
790
- "kv:key list --binding someBinding --env some-environment"
791
- );
792
- expect(std.err).toMatchInlineSnapshot(`""`);
793
- expect(std.out).toMatchInlineSnapshot(`
828
+ });
829
+
830
+ it("should list the keys of a namespace specified by binding, in a given environment", async () => {
831
+ writeWranglerConfig();
832
+ const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
833
+ mockKeyListRequest("env-bound-id", keys);
834
+ await runWrangler(
835
+ "kv:key list --binding someBinding --env some-environment"
836
+ );
837
+ expect(std.err).toMatchInlineSnapshot(`""`);
838
+ expect(std.out).toMatchInlineSnapshot(`
794
839
  "[
795
840
  {
796
841
  \\"name\\": \\"key-1\\"
@@ -803,17 +848,17 @@ describe("wrangler", () => {
803
848
  }
804
849
  ]"
805
850
  `);
806
- });
807
-
808
- it("should list the keys of a preview namespace specified by binding, in a given environment", async () => {
809
- writeWranglerConfig();
810
- const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
811
- mockKeyListRequest("preview-env-bound-id", keys);
812
- await runWrangler(
813
- "kv:key list --binding someBinding --preview --env some-environment"
814
- );
815
- expect(std.err).toMatchInlineSnapshot(`""`);
816
- expect(std.out).toMatchInlineSnapshot(`
851
+ });
852
+
853
+ it("should list the keys of a preview namespace specified by binding, in a given environment", async () => {
854
+ writeWranglerConfig();
855
+ const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
856
+ mockKeyListRequest("preview-env-bound-id", keys);
857
+ await runWrangler(
858
+ "kv:key list --binding someBinding --preview --env some-environment"
859
+ );
860
+ expect(std.err).toMatchInlineSnapshot(`""`);
861
+ expect(std.out).toMatchInlineSnapshot(`
817
862
  "[
818
863
  {
819
864
  \\"name\\": \\"key-1\\"
@@ -826,129 +871,197 @@ describe("wrangler", () => {
826
871
  }
827
872
  ]"
828
873
  `);
829
- });
830
-
831
- // We'll run the next test with variations on the cursor
832
- // that's returned on cloudflare's API after all results
833
- // have been drained.
834
- for (const blankCursorValue of [undefined, null, ""] as [
835
- undefined,
836
- null,
837
- ""
838
- ]) {
839
- describe(`cursor - ${blankCursorValue}`, () => {
840
- it("should make multiple requests for paginated results", async () => {
841
- // Create a lot of mock keys, so that the fetch requests will be paginated
842
- const keys: NamespaceKeyInfo[] = [];
843
- for (let i = 0; i < 550; i++) {
844
- keys.push({ name: "key-" + i });
845
- }
846
- // Ask for the keys in pages of size 100.
847
- const requests = mockKeyListRequest(
848
- "some-namespace-id",
849
- keys,
850
- 100,
851
- blankCursorValue
852
- );
853
- await runWrangler("kv:key list --namespace-id some-namespace-id");
854
- expect(std.err).toMatchInlineSnapshot(`""`);
855
- expect(JSON.parse(std.out)).toEqual(keys);
856
- expect(requests.count).toEqual(6);
857
- });
858
- });
859
- }
860
-
861
- it("should error if a given binding name is not in the configured kv namespaces", async () => {
862
- writeWranglerConfig();
863
- await expect(
864
- runWrangler("kv:key list --binding otherBinding")
865
- ).rejects.toThrowErrorMatchingInlineSnapshot(
866
- `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
867
- );
868
- expect(std.err).toMatchInlineSnapshot(`
874
+ });
875
+
876
+ // We'll run the next test with variations on the cursor
877
+ // that's returned on cloudflare's API after all results
878
+ // have been drained.
879
+ for (const blankCursorValue of [undefined, null, ""] as [
880
+ undefined,
881
+ null,
882
+ ""
883
+ ]) {
884
+ describe(`cursor - ${blankCursorValue}`, () => {
885
+ it("should make multiple requests for paginated results", async () => {
886
+ // Create a lot of mock keys, so that the fetch requests will be paginated
887
+ const keys: NamespaceKeyInfo[] = [];
888
+ for (let i = 0; i < 550; i++) {
889
+ keys.push({ name: "key-" + i });
890
+ }
891
+ // Ask for the keys in pages of size 100.
892
+ const requests = mockKeyListRequest(
893
+ "some-namespace-id",
894
+ keys,
895
+ 100,
896
+ blankCursorValue
897
+ );
898
+ await runWrangler("kv:key list --namespace-id some-namespace-id");
899
+ expect(std.err).toMatchInlineSnapshot(`""`);
900
+ expect(JSON.parse(std.out)).toEqual(keys);
901
+ expect(requests.count).toEqual(6);
902
+ });
903
+ });
904
+ }
905
+
906
+ it("should error if a given binding name is not in the configured kv namespaces", async () => {
907
+ writeWranglerConfig();
908
+ await expect(
909
+ runWrangler("kv:key list --binding otherBinding")
910
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
911
+ `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
912
+ );
913
+ expect(std.err).toMatchInlineSnapshot(`
869
914
  "X [ERROR] A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
870
915
 
871
916
  "
872
917
  `);
873
- expect(std.out).toMatchInlineSnapshot(`
918
+ expect(std.out).toMatchInlineSnapshot(`
874
919
  "
875
- If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
920
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
876
921
  `);
877
- });
878
- });
879
-
880
- describe("get", () => {
881
- afterEach(() => {
882
- unsetMockFetchKVGetValues();
883
- });
884
-
885
- it("should get a key in a given namespace specified by namespace-id", async () => {
886
- setMockFetchKVGetValue(
887
- "some-account-id",
888
- "some-namespace-id",
889
- "my-key",
890
- "my-value"
891
- );
892
- await runWrangler("kv:key get my-key --namespace-id some-namespace-id");
893
- expect(std.out).toMatchInlineSnapshot(`"my-value"`);
894
- expect(std.err).toMatchInlineSnapshot(`""`);
895
- });
896
-
897
- it("should get a key in a given namespace specified by binding", async () => {
898
- writeWranglerConfig();
899
- setMockFetchKVGetValue(
900
- "some-account-id",
901
- "bound-id",
902
- "my-key",
903
- "my-value"
904
- );
905
- await runWrangler(
906
- "kv:key get my-key --binding someBinding --preview false"
907
- );
908
- expect(std.out).toMatchInlineSnapshot(`"my-value"`);
909
- expect(std.err).toMatchInlineSnapshot(`""`);
910
- });
911
-
912
- it("should get a key in a given preview namespace specified by binding", async () => {
913
- writeWranglerConfig();
914
- setMockFetchKVGetValue(
915
- "some-account-id",
916
- "preview-bound-id",
917
- "my-key",
918
- "my-value"
919
- );
920
- await runWrangler("kv:key get my-key --binding someBinding --preview");
921
- expect(std.out).toMatchInlineSnapshot(`"my-value"`);
922
- expect(std.err).toMatchInlineSnapshot(`""`);
923
- });
924
-
925
- it("should get a key for the specified environment in a given namespace", async () => {
926
- writeWranglerConfig();
927
- setMockFetchKVGetValue(
928
- "some-account-id",
929
- "env-bound-id",
930
- "my-key",
931
- "my-value"
932
- );
933
- await runWrangler(
934
- "kv:key get my-key --binding someBinding --env some-environment --preview false"
935
- );
936
- expect(std.out).toMatchInlineSnapshot(`"my-value"`);
937
- expect(std.err).toMatchInlineSnapshot(`""`);
938
- });
939
-
940
- it("should error if no key is provided", async () => {
941
- await expect(
942
- runWrangler("kv:key get")
943
- ).rejects.toThrowErrorMatchingInlineSnapshot(
944
- `"Not enough non-option arguments: got 0, need at least 1"`
945
- );
946
- expect(std.out).toMatchInlineSnapshot(`
947
- "
948
- "
922
+ });
923
+ });
924
+
925
+ describe("get", () => {
926
+ afterEach(() => {
927
+ unsetSpecialMockFns();
928
+ });
929
+
930
+ it("should get a key in a given namespace specified by namespace-id", async () => {
931
+ setMockFetchKVGetValue(
932
+ "some-account-id",
933
+ "some-namespace-id",
934
+ "my-key",
935
+ "my-value"
936
+ );
937
+ await runWrangler("kv:key get my-key --namespace-id some-namespace-id");
938
+ expect(proc.write).toEqual(Buffer.from("my-value"));
939
+ expect(std.err).toMatchInlineSnapshot(`""`);
940
+ });
941
+
942
+ it("should get a key and decode the value from the response as a utf8 string if the `--text` flag is passed", async () => {
943
+ setMockFetchKVGetValue(
944
+ "some-account-id",
945
+ "some-namespace-id",
946
+ "my-key",
947
+ "my-value"
948
+ );
949
+ await runWrangler(
950
+ "kv:key get my-key --text --namespace-id some-namespace-id"
951
+ );
952
+ expect(proc.write).not.toEqual(Buffer.from("my-value"));
953
+ expect(std).toMatchInlineSnapshot(`
954
+ Object {
955
+ "debug": "",
956
+ "err": "",
957
+ "out": "my-value",
958
+ "warn": "",
959
+ }
949
960
  `);
950
- expect(std.err).toMatchInlineSnapshot(`
951
- "wrangler kv:key get <key>
961
+ });
962
+
963
+ it("should get a binary and decode as utf8 text, resulting in improper decoding", async () => {
964
+ const buf = Buffer.from(
965
+ "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAiSURBVHgB7coxEQAACMPAgH/PgAM6dGwu49fA/deIBXrgAj2cAhIFT4QxAAAAAElFTkSuQmCC",
966
+ "base64"
967
+ );
968
+ setMockFetchKVGetValue(
969
+ "some-account-id",
970
+ "some-namespace-id",
971
+ "my-key",
972
+ buf
973
+ );
974
+ await runWrangler(
975
+ "kv:key get my-key --text --namespace-id some-namespace-id"
976
+ );
977
+ expect(proc.write).not.toEqual(buf);
978
+ expect(JSON.stringify(std)).toMatchInlineSnapshot(
979
+ `"{\\"debug\\":\\"\\",\\"out\\":\\"�PNG\\\\n\\\\u001a\\\\n\\\\u0000\\\\u0000\\\\u0000\\\\rIHDR\\\\u0000\\\\u0000\\\\u0000\\\\n\\\\u0000\\\\u0000\\\\u0000\\\\n\\\\b\\\\u0006\\\\u0000\\\\u0000\\\\u0000�2Ͻ\\\\u0000\\\\u0000\\\\u0000\\\\tpHYs\\\\u0000\\\\u0000\\\\u000b\\\\u0013\\\\u0000\\\\u0000\\\\u000b\\\\u0013\\\\u0001\\\\u0000��\\\\u0018\\\\u0000\\\\u0000\\\\u0000\\\\u0001sRGB\\\\u0000��\\\\u001c�\\\\u0000\\\\u0000\\\\u0000\\\\u0004gAMA\\\\u0000\\\\u0000��\\\\u000b�a\\\\u0005\\\\u0000\\\\u0000\\\\u0000\\\\\\"IDATx\\\\u0001��1\\\\u0011\\\\u0000\\\\u0000\\\\b���π\\\\u0003:tl.����׈\\\\u0005z�\\\\u0002=�\\\\u0002\\\\u0012\\\\u0005O�1\\\\u0000\\\\u0000\\\\u0000\\\\u0000IEND�B\`�\\",\\"err\\":\\"\\",\\"warn\\":\\"\\"}"`
980
+ );
981
+ });
982
+
983
+ it("should get a binary file by key in a given namespace specified by namespace-id", async () => {
984
+ const buf = Buffer.from(
985
+ "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAiSURBVHgB7coxEQAACMPAgH/PgAM6dGwu49fA/deIBXrgAj2cAhIFT4QxAAAAAElFTkSuQmCC",
986
+ "base64"
987
+ );
988
+ setMockFetchKVGetValue(
989
+ "some-account-id",
990
+ "some-namespace-id",
991
+ "my-key",
992
+ buf
993
+ );
994
+ await runWrangler("kv:key get my-key --namespace-id some-namespace-id");
995
+ expect(proc.write).toEqual(buf);
996
+ expect(std.err).toMatchInlineSnapshot(`""`);
997
+ });
998
+
999
+ it("should get a key in a given namespace specified by binding", async () => {
1000
+ writeWranglerConfig();
1001
+ setMockFetchKVGetValue(
1002
+ "some-account-id",
1003
+ "bound-id",
1004
+ "my-key",
1005
+ "my-value"
1006
+ );
1007
+ await runWrangler(
1008
+ "kv:key get my-key --binding someBinding --preview false"
1009
+ );
1010
+ expect(proc.write).toEqual(Buffer.from("my-value"));
1011
+ expect(std.err).toMatchInlineSnapshot(`""`);
1012
+ });
1013
+
1014
+ it("should get a key in a given preview namespace specified by binding", async () => {
1015
+ writeWranglerConfig();
1016
+ setMockFetchKVGetValue(
1017
+ "some-account-id",
1018
+ "preview-bound-id",
1019
+ "my-key",
1020
+ "my-value"
1021
+ );
1022
+ await runWrangler("kv:key get my-key --binding someBinding --preview");
1023
+ expect(proc.write).toEqual(Buffer.from("my-value"));
1024
+ expect(std.err).toMatchInlineSnapshot(`""`);
1025
+ });
1026
+
1027
+ it("should get a key for the specified environment in a given namespace", async () => {
1028
+ writeWranglerConfig();
1029
+ setMockFetchKVGetValue(
1030
+ "some-account-id",
1031
+ "env-bound-id",
1032
+ "my-key",
1033
+ "my-value"
1034
+ );
1035
+ await runWrangler(
1036
+ "kv:key get my-key --binding someBinding --env some-environment --preview false"
1037
+ );
1038
+ expect(proc.write).toEqual(Buffer.from("my-value"));
1039
+ expect(std.err).toMatchInlineSnapshot(`""`);
1040
+ });
1041
+
1042
+ it("should encode the key in the api request to get a value", async () => {
1043
+ setMockFetchKVGetValue(
1044
+ "some-account-id",
1045
+ "some-namespace-id",
1046
+ "%2Fmy%2Ckey",
1047
+ "my-value"
1048
+ );
1049
+ await runWrangler(
1050
+ "kv:key get /my,key --namespace-id some-namespace-id"
1051
+ );
1052
+ expect(proc.write).toEqual(Buffer.from("my-value"));
1053
+ expect(std.err).toMatchInlineSnapshot(`""`);
1054
+ });
1055
+
1056
+ it("should error if no key is provided", async () => {
1057
+ await expect(
1058
+ runWrangler("kv:key get")
1059
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
1060
+ `"Not enough non-option arguments: got 0, need at least 1"`
1061
+ );
1062
+ expect(std.out).toMatchInlineSnapshot(`
1063
+ "
1064
+ wrangler kv:key get <key>
952
1065
 
953
1066
  Reads a single value by key from the given namespace.
954
1067
 
@@ -956,34 +1069,33 @@ describe("wrangler", () => {
956
1069
  key The key value to get. [string] [required]
957
1070
 
958
1071
  Flags:
959
- -c, --config Path to .toml configuration file [string]
960
- -h, --help Show help [boolean]
961
- -v, --version Show version number [boolean]
962
- --legacy-env Use legacy environments [boolean]
1072
+ -c, --config Path to .toml configuration file [string]
1073
+ -h, --help Show help [boolean]
1074
+ -v, --version Show version number [boolean]
963
1075
 
964
1076
  Options:
965
1077
  --binding The name of the namespace to get from [string]
966
1078
  --namespace-id The id of the namespace to get from [string]
967
1079
  -e, --env Perform on a specific environment [string]
968
1080
  --preview Interact with a preview namespace [boolean] [default: false]
969
- X [ERROR] Not enough non-option arguments: got 0, need at least 1
1081
+ --text Decode the returned value as a utf8 string [boolean] [default: false]"
1082
+ `);
1083
+ expect(std.err).toMatchInlineSnapshot(`
1084
+ "X [ERROR] Not enough non-option arguments: got 0, need at least 1
970
1085
 
971
1086
  "
972
1087
  `);
973
- });
974
-
975
- it("should error if no binding nor namespace is provided", async () => {
976
- await expect(
977
- runWrangler("kv:key get foo")
978
- ).rejects.toThrowErrorMatchingInlineSnapshot(
979
- `"Exactly one of the arguments binding and namespace-id is required"`
980
- );
981
- expect(std.out).toMatchInlineSnapshot(`
1088
+ });
1089
+
1090
+ it("should error if no binding nor namespace is provided", async () => {
1091
+ await expect(
1092
+ runWrangler("kv:key get foo")
1093
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
1094
+ `"Exactly one of the arguments binding and namespace-id is required"`
1095
+ );
1096
+ expect(std.out).toMatchInlineSnapshot(`
982
1097
  "
983
- "
984
- `);
985
- expect(std.err).toMatchInlineSnapshot(`
986
- "wrangler kv:key get <key>
1098
+ wrangler kv:key get <key>
987
1099
 
988
1100
  Reads a single value by key from the given namespace.
989
1101
 
@@ -991,35 +1103,34 @@ describe("wrangler", () => {
991
1103
  key The key value to get. [string] [required]
992
1104
 
993
1105
  Flags:
994
- -c, --config Path to .toml configuration file [string]
995
- -h, --help Show help [boolean]
996
- -v, --version Show version number [boolean]
997
- --legacy-env Use legacy environments [boolean]
1106
+ -c, --config Path to .toml configuration file [string]
1107
+ -h, --help Show help [boolean]
1108
+ -v, --version Show version number [boolean]
998
1109
 
999
1110
  Options:
1000
1111
  --binding The name of the namespace to get from [string]
1001
1112
  --namespace-id The id of the namespace to get from [string]
1002
1113
  -e, --env Perform on a specific environment [string]
1003
1114
  --preview Interact with a preview namespace [boolean] [default: false]
1004
- X [ERROR] Exactly one of the arguments binding and namespace-id is required
1115
+ --text Decode the returned value as a utf8 string [boolean] [default: false]"
1116
+ `);
1117
+ expect(std.err).toMatchInlineSnapshot(`
1118
+ "X [ERROR] Exactly one of the arguments binding and namespace-id is required
1005
1119
 
1006
1120
  "
1007
1121
  `);
1008
- });
1122
+ });
1009
1123
 
1010
- it("should error if both binding and namespace is provided", async () => {
1011
- await expect(
1012
- runWrangler("kv:key get foo --binding x --namespace-id y")
1013
- ).rejects.toThrowErrorMatchingInlineSnapshot(
1014
- `"Arguments binding and namespace-id are mutually exclusive"`
1015
- );
1124
+ it("should error if both binding and namespace is provided", async () => {
1125
+ await expect(
1126
+ runWrangler("kv:key get foo --binding x --namespace-id y")
1127
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
1128
+ `"Arguments binding and namespace-id are mutually exclusive"`
1129
+ );
1016
1130
 
1017
- expect(std.out).toMatchInlineSnapshot(`
1131
+ expect(std.out).toMatchInlineSnapshot(`
1018
1132
  "
1019
- "
1020
- `);
1021
- expect(std.err).toMatchInlineSnapshot(`
1022
- "wrangler kv:key get <key>
1133
+ wrangler kv:key get <key>
1023
1134
 
1024
1135
  Reads a single value by key from the given namespace.
1025
1136
 
@@ -1027,428 +1138,534 @@ describe("wrangler", () => {
1027
1138
  key The key value to get. [string] [required]
1028
1139
 
1029
1140
  Flags:
1030
- -c, --config Path to .toml configuration file [string]
1031
- -h, --help Show help [boolean]
1032
- -v, --version Show version number [boolean]
1033
- --legacy-env Use legacy environments [boolean]
1141
+ -c, --config Path to .toml configuration file [string]
1142
+ -h, --help Show help [boolean]
1143
+ -v, --version Show version number [boolean]
1034
1144
 
1035
1145
  Options:
1036
1146
  --binding The name of the namespace to get from [string]
1037
1147
  --namespace-id The id of the namespace to get from [string]
1038
1148
  -e, --env Perform on a specific environment [string]
1039
1149
  --preview Interact with a preview namespace [boolean] [default: false]
1040
- X [ERROR] Arguments binding and namespace-id are mutually exclusive
1150
+ --text Decode the returned value as a utf8 string [boolean] [default: false]"
1151
+ `);
1152
+ expect(std.err).toMatchInlineSnapshot(`
1153
+ "X [ERROR] Arguments binding and namespace-id are mutually exclusive
1041
1154
 
1042
1155
  "
1043
1156
  `);
1044
- });
1045
-
1046
- it("should error if a given binding name is not in the configured kv namespaces", async () => {
1047
- writeWranglerConfig();
1048
- await expect(
1049
- runWrangler("kv:key get key --binding otherBinding")
1050
- ).rejects.toThrowErrorMatchingInlineSnapshot(
1051
- `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
1052
- );
1053
- expect(std.out).toMatchInlineSnapshot(`
1157
+ });
1158
+
1159
+ it("should error if a given binding name is not in the configured kv namespaces", async () => {
1160
+ writeWranglerConfig();
1161
+ await expect(
1162
+ runWrangler("kv:key get key --binding otherBinding")
1163
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
1164
+ `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
1165
+ );
1166
+ expect(std.out).toMatchInlineSnapshot(`
1054
1167
  "
1055
- If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
1168
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
1056
1169
  `);
1057
- expect(std.err).toMatchInlineSnapshot(`
1170
+ expect(std.err).toMatchInlineSnapshot(`
1058
1171
  "X [ERROR] A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
1059
1172
 
1060
1173
  "
1061
1174
  `);
1062
- });
1063
- });
1064
-
1065
- describe("delete", () => {
1066
- function mockDeleteRequest(
1067
- expectedNamespaceId: string,
1068
- expectedKey: string
1069
- ) {
1070
- const requests = { count: 0 };
1071
- setMockResponse(
1072
- "/accounts/:accountId/storage/kv/namespaces/:namespaceId/values/:key",
1073
- "DELETE",
1074
- ([_url, accountId, namespaceId, key]) => {
1075
- requests.count++;
1076
- expect(accountId).toEqual("some-account-id");
1077
- expect(namespaceId).toEqual(expectedNamespaceId);
1078
- expect(key).toEqual(expectedKey);
1079
- return null;
1080
- }
1081
- );
1082
- return requests;
1083
- }
1084
-
1085
- it("should delete a key in a namespace specified by id", async () => {
1086
- const requests = mockDeleteRequest("some-namespace-id", "someKey");
1087
- await runWrangler(
1088
- `kv:key delete --namespace-id some-namespace-id someKey`
1089
- );
1090
- expect(requests.count).toEqual(1);
1091
- });
1092
-
1093
- it("should delete a key in a namespace specified by binding name", async () => {
1094
- writeWranglerConfig();
1095
- const requests = mockDeleteRequest("bound-id", "someKey");
1096
- await runWrangler(
1097
- `kv:key delete --binding someBinding --preview false someKey`
1098
- );
1099
- expect(requests.count).toEqual(1);
1100
- });
1101
-
1102
- it("should delete a key in a preview namespace specified by binding name", async () => {
1103
- writeWranglerConfig();
1104
- const requests = mockDeleteRequest("preview-bound-id", "someKey");
1105
- await runWrangler(
1106
- `kv:key delete --binding someBinding --preview someKey`
1107
- );
1108
- expect(requests.count).toEqual(1);
1109
- });
1110
-
1111
- it("should error if a given binding name is not in the configured kv namespaces", async () => {
1112
- writeWranglerConfig();
1113
- await expect(
1114
- runWrangler(`kv:key delete --binding otherBinding someKey`)
1115
- ).rejects.toThrowErrorMatchingInlineSnapshot(
1116
- `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
1117
- );
1118
-
1119
- expect(std.err).toMatchInlineSnapshot(`
1175
+ });
1176
+
1177
+ describe("non-interactive", () => {
1178
+ const { setIsTTY } = useMockIsTTY();
1179
+ mockAccountId({ accountId: null });
1180
+
1181
+ it("should error if there are multiple accounts available but not interactive on stdin", async () => {
1182
+ mockGetMemberships([
1183
+ { id: "xxx", account: { id: "1", name: "one" } },
1184
+ { id: "yyy", account: { id: "2", name: "two" } },
1185
+ ]);
1186
+ setIsTTY({ stdin: false, stdout: true });
1187
+ await expect(runWrangler("kv:key get key --namespace-id=xxxx"))
1188
+ .rejects.toThrowErrorMatchingInlineSnapshot(`
1189
+ "More than one account available but unable to select one in non-interactive mode.
1190
+ Please set the appropriate \`account_id\` in your \`wrangler.toml\` file.
1191
+ Available accounts are (\\"<name>\\" - \\"<id>\\"):
1192
+ \\"one\\" - \\"1\\")
1193
+ \\"two\\" - \\"2\\")"
1194
+ `);
1195
+ });
1196
+
1197
+ it("should error if there are multiple accounts available but not interactive on stdout", async () => {
1198
+ mockGetMemberships([
1199
+ { id: "xxx", account: { id: "1", name: "one" } },
1200
+ { id: "yyy", account: { id: "2", name: "two" } },
1201
+ ]);
1202
+ setIsTTY({ stdin: true, stdout: false });
1203
+ await expect(runWrangler("kv:key get key --namespace-id=xxxx"))
1204
+ .rejects.toThrowErrorMatchingInlineSnapshot(`
1205
+ "More than one account available but unable to select one in non-interactive mode.
1206
+ Please set the appropriate \`account_id\` in your \`wrangler.toml\` file.
1207
+ Available accounts are (\\"<name>\\" - \\"<id>\\"):
1208
+ \\"one\\" - \\"1\\")
1209
+ \\"two\\" - \\"2\\")"
1210
+ `);
1211
+ });
1212
+
1213
+ it("should recommend using a configuration if unable to fetch memberships", async () => {
1214
+ setMockRawResponse("/memberships", () => {
1215
+ return createFetchResult(undefined, false, [
1216
+ {
1217
+ code: 9109,
1218
+ message: "Uauthorized to access requested resource",
1219
+ },
1220
+ ]);
1221
+ });
1222
+ await expect(runWrangler("kv:key get key --namespace-id=xxxx"))
1223
+ .rejects.toThrowErrorMatchingInlineSnapshot(`
1224
+ "Failed to automatically retrieve account IDs for the logged in user.
1225
+ You may have incorrect permissions on your API token. You can skip this account check by adding an \`account_id\` in your \`wrangler.toml\`, or by setting the value of CLOUDFLARE_ACCOUNT_ID\\""
1226
+ `);
1227
+ });
1228
+
1229
+ it("should error if there are multiple accounts available but not interactive at all", async () => {
1230
+ mockGetMemberships([
1231
+ { id: "xxx", account: { id: "1", name: "one" } },
1232
+ { id: "yyy", account: { id: "2", name: "two" } },
1233
+ ]);
1234
+ setIsTTY(false);
1235
+ await expect(runWrangler("kv:key get key --namespace-id=xxxx"))
1236
+ .rejects.toThrowErrorMatchingInlineSnapshot(`
1237
+ "More than one account available but unable to select one in non-interactive mode.
1238
+ Please set the appropriate \`account_id\` in your \`wrangler.toml\` file.
1239
+ Available accounts are (\\"<name>\\" - \\"<id>\\"):
1240
+ \\"one\\" - \\"1\\")
1241
+ \\"two\\" - \\"2\\")"
1242
+ `);
1243
+ });
1244
+ });
1245
+ });
1246
+
1247
+ describe("delete", () => {
1248
+ function mockDeleteRequest(
1249
+ expectedNamespaceId: string,
1250
+ expectedKey: string
1251
+ ) {
1252
+ const requests = { count: 0 };
1253
+ setMockResponse(
1254
+ "/accounts/:accountId/storage/kv/namespaces/:namespaceId/values/:key",
1255
+ "DELETE",
1256
+ ([_url, accountId, namespaceId, key]) => {
1257
+ requests.count++;
1258
+ expect(accountId).toEqual("some-account-id");
1259
+ expect(namespaceId).toEqual(expectedNamespaceId);
1260
+ expect(key).toEqual(expectedKey);
1261
+ return null;
1262
+ }
1263
+ );
1264
+ return requests;
1265
+ }
1266
+
1267
+ it("should delete a key in a namespace specified by id", async () => {
1268
+ const requests = mockDeleteRequest("some-namespace-id", "someKey");
1269
+ await runWrangler(
1270
+ `kv:key delete --namespace-id some-namespace-id someKey`
1271
+ );
1272
+ expect(requests.count).toEqual(1);
1273
+ });
1274
+
1275
+ it("should encode the key in the api request to delete a value", async () => {
1276
+ const requests = mockDeleteRequest("voyager", "%2FNCC-74656");
1277
+ await runWrangler(`kv:key delete --namespace-id voyager /NCC-74656`);
1278
+ expect(requests.count).toEqual(1);
1279
+ expect(std.out).toMatchInlineSnapshot(
1280
+ `"Deleting the key \\"/NCC-74656\\" on namespace voyager."`
1281
+ );
1282
+ expect(std.err).toMatchInlineSnapshot(`""`);
1283
+ });
1284
+
1285
+ it("should delete a key in a namespace specified by binding name", async () => {
1286
+ writeWranglerConfig();
1287
+ const requests = mockDeleteRequest("bound-id", "someKey");
1288
+ await runWrangler(
1289
+ `kv:key delete --binding someBinding --preview false someKey`
1290
+ );
1291
+ expect(requests.count).toEqual(1);
1292
+ });
1293
+
1294
+ it("should delete a key in a preview namespace specified by binding name", async () => {
1295
+ writeWranglerConfig();
1296
+ const requests = mockDeleteRequest("preview-bound-id", "someKey");
1297
+ await runWrangler(
1298
+ `kv:key delete --binding someBinding --preview someKey`
1299
+ );
1300
+ expect(requests.count).toEqual(1);
1301
+ });
1302
+
1303
+ it("should error if a given binding name is not in the configured kv namespaces", async () => {
1304
+ writeWranglerConfig();
1305
+ await expect(
1306
+ runWrangler(`kv:key delete --binding otherBinding someKey`)
1307
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
1308
+ `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
1309
+ );
1310
+
1311
+ expect(std.err).toMatchInlineSnapshot(`
1120
1312
  "X [ERROR] A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
1121
1313
 
1122
1314
  "
1123
1315
  `);
1124
- });
1125
-
1126
- it("should delete a key in a namespace specified by binding name in a given environment", async () => {
1127
- writeWranglerConfig();
1128
- const requests = mockDeleteRequest("env-bound-id", "someKey");
1129
- await runWrangler(
1130
- `kv:key delete --binding someBinding --env some-environment --preview false someKey`
1131
- );
1132
- expect(std.out).toMatchInlineSnapshot(
1133
- `"Deleting the key \\"someKey\\" on namespace env-bound-id."`
1134
- );
1135
- expect(std.err).toMatchInlineSnapshot(`""`);
1136
- expect(requests.count).toEqual(1);
1137
- });
1138
-
1139
- it("should delete a key in a preview namespace specified by binding name in a given environment", async () => {
1140
- writeWranglerConfig();
1141
- const requests = mockDeleteRequest("preview-env-bound-id", "someKey");
1142
- await runWrangler(
1143
- `kv:key delete --binding someBinding --env some-environment --preview someKey`
1144
- );
1145
- expect(requests.count).toEqual(1);
1146
- });
1147
- });
1148
- });
1149
-
1150
- describe("kv:bulk", () => {
1151
- describe("put", () => {
1152
- function mockPutRequest(
1153
- expectedNamespaceId: string,
1154
- expectedKeyValues: KeyValue[]
1155
- ) {
1156
- const requests = { count: 0 };
1157
- setMockResponse(
1158
- "/accounts/:accountId/storage/kv/namespaces/:namespaceId/bulk",
1159
- "PUT",
1160
- ([_url, accountId, namespaceId], { body }) => {
1161
- requests.count++;
1162
- expect(accountId).toEqual("some-account-id");
1163
- expect(namespaceId).toEqual(expectedNamespaceId);
1164
- expect(JSON.parse(body as string)).toEqual(
1165
- expectedKeyValues.slice(
1166
- (requests.count - 1) * 5000,
1167
- requests.count * 5000
1168
- )
1169
- );
1170
- return null;
1171
- }
1172
- );
1173
- return requests;
1174
- }
1175
-
1176
- it("should put the key-values parsed from a file", async () => {
1177
- const keyValues: KeyValue[] = [
1178
- { key: "someKey1", value: "someValue1" },
1179
- { key: "ns:someKey2", value: "123", base64: true },
1180
- { key: "someKey3", value: "someValue3", expiration: 100 },
1181
- { key: "someKey4", value: "someValue4", expiration_ttl: 500 },
1182
- ];
1183
- writeFileSync("./keys.json", JSON.stringify(keyValues));
1184
- const requests = mockPutRequest("some-namespace-id", keyValues);
1185
- await runWrangler(
1186
- `kv:bulk put --namespace-id some-namespace-id keys.json`
1187
- );
1188
- expect(requests.count).toEqual(1);
1189
- expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1190
- expect(std.warn).toMatchInlineSnapshot(`""`);
1191
- expect(std.err).toMatchInlineSnapshot(`""`);
1192
- });
1193
-
1194
- it("should put the key-values in batches of 5000 parsed from a file", async () => {
1195
- const keyValues: KeyValue[] = new Array(12000).fill({
1196
- key: "someKey1",
1197
- value: "someValue1",
1198
- });
1199
- writeFileSync("./keys.json", JSON.stringify(keyValues));
1200
- const requests = mockPutRequest("some-namespace-id", keyValues);
1201
- await runWrangler(
1202
- `kv:bulk put --namespace-id some-namespace-id keys.json`
1203
- );
1204
- expect(requests.count).toEqual(3);
1205
- expect(std.out).toMatchInlineSnapshot(`
1206
- "Uploaded 0 of 12000.
1207
- Uploaded 5000 of 12000.
1208
- Uploaded 10000 of 12000.
1209
- Uploaded 12000 of 12000.
1316
+ });
1317
+
1318
+ it("should delete a key in a namespace specified by binding name in a given environment", async () => {
1319
+ writeWranglerConfig();
1320
+ const requests = mockDeleteRequest("env-bound-id", "someKey");
1321
+ await runWrangler(
1322
+ `kv:key delete --binding someBinding --env some-environment --preview false someKey`
1323
+ );
1324
+ expect(std.out).toMatchInlineSnapshot(
1325
+ `"Deleting the key \\"someKey\\" on namespace env-bound-id."`
1326
+ );
1327
+ expect(std.err).toMatchInlineSnapshot(`""`);
1328
+ expect(requests.count).toEqual(1);
1329
+ });
1330
+
1331
+ it("should delete a key in a preview namespace specified by binding name in a given environment", async () => {
1332
+ writeWranglerConfig();
1333
+ const requests = mockDeleteRequest("preview-env-bound-id", "someKey");
1334
+ await runWrangler(
1335
+ `kv:key delete --binding someBinding --env some-environment --preview someKey`
1336
+ );
1337
+ expect(requests.count).toEqual(1);
1338
+ });
1339
+ });
1340
+ });
1341
+
1342
+ describe("kv:bulk", () => {
1343
+ describe("put", () => {
1344
+ function mockPutRequest(
1345
+ expectedNamespaceId: string,
1346
+ expectedKeyValues: KeyValue[]
1347
+ ) {
1348
+ const requests = { count: 0 };
1349
+ setMockResponse(
1350
+ "/accounts/:accountId/storage/kv/namespaces/:namespaceId/bulk",
1351
+ "PUT",
1352
+ ([_url, accountId, namespaceId], { body }) => {
1353
+ requests.count++;
1354
+ expect(accountId).toEqual("some-account-id");
1355
+ expect(namespaceId).toEqual(expectedNamespaceId);
1356
+ expect(JSON.parse(body as string)).toEqual(
1357
+ expectedKeyValues.slice(
1358
+ (requests.count - 1) * 5000,
1359
+ requests.count * 5000
1360
+ )
1361
+ );
1362
+ return null;
1363
+ }
1364
+ );
1365
+ return requests;
1366
+ }
1367
+
1368
+ it("should put the key-values parsed from a file", async () => {
1369
+ const keyValues: KeyValue[] = [
1370
+ { key: "someKey1", value: "someValue1" },
1371
+ { key: "ns:someKey2", value: "123", base64: true },
1372
+ { key: "someKey3", value: "someValue3", expiration: 100 },
1373
+ { key: "someKey4", value: "someValue4", expiration_ttl: 500 },
1374
+ ];
1375
+ writeFileSync("./keys.json", JSON.stringify(keyValues));
1376
+ const requests = mockPutRequest("some-namespace-id", keyValues);
1377
+ await runWrangler(
1378
+ `kv:bulk put --namespace-id some-namespace-id keys.json`
1379
+ );
1380
+ expect(requests.count).toEqual(1);
1381
+ expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1382
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1383
+ expect(std.err).toMatchInlineSnapshot(`""`);
1384
+ });
1385
+
1386
+ it("should put the key-values in batches of 5000 parsed from a file", async () => {
1387
+ const keyValues: KeyValue[] = new Array(12000).fill({
1388
+ key: "someKey1",
1389
+ value: "someValue1",
1390
+ });
1391
+ writeFileSync("./keys.json", JSON.stringify(keyValues));
1392
+ const requests = mockPutRequest("some-namespace-id", keyValues);
1393
+ await runWrangler(
1394
+ `kv:bulk put --namespace-id some-namespace-id keys.json`
1395
+ );
1396
+ expect(requests.count).toEqual(3);
1397
+ expect(std.out).toMatchInlineSnapshot(`
1398
+ "Uploaded 0% (0 out of 12,000)
1399
+ Uploaded 41% (5,000 out of 12,000)
1400
+ Uploaded 83% (10,000 out of 12,000)
1401
+ Uploaded 100% (12,000 out of 12,000)
1210
1402
  Success!"
1211
1403
  `);
1212
- expect(std.warn).toMatchInlineSnapshot(`""`);
1213
- expect(std.err).toMatchInlineSnapshot(`""`);
1214
- });
1215
-
1216
- it("should error if the file is not a JSON array", async () => {
1217
- const keyValues = { key: "someKey1", value: "someValue1" };
1218
- writeFileSync("./keys.json", JSON.stringify(keyValues));
1219
- await expect(
1220
- runWrangler(`kv:bulk put --namespace-id some-namespace-id keys.json`)
1221
- ).rejects.toThrowErrorMatchingInlineSnapshot(`
1222
- "Unexpected JSON input from \\"keys.json\\".
1223
- Expected an array of key-value objects but got type \\"object\\"."
1224
- `);
1225
- expect(std.out).toMatchInlineSnapshot(`
1404
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1405
+ expect(std.err).toMatchInlineSnapshot(`""`);
1406
+ });
1407
+
1408
+ it("should error if the file is not a JSON array", async () => {
1409
+ const keyValues = { key: "someKey1", value: "someValue1" };
1410
+ writeFileSync("./keys.json", JSON.stringify(keyValues));
1411
+ await expect(
1412
+ runWrangler(`kv:bulk put --namespace-id some-namespace-id keys.json`)
1413
+ ).rejects.toThrowErrorMatchingInlineSnapshot(`
1414
+ "Unexpected JSON input from \\"keys.json\\".
1415
+ Expected an array of key-value objects but got type \\"object\\"."
1416
+ `);
1417
+ expect(std.out).toMatchInlineSnapshot(`
1226
1418
  "
1227
- If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
1419
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
1228
1420
  `);
1229
- expect(std.warn).toMatchInlineSnapshot(`""`);
1230
- });
1231
-
1232
- it("should error if the array contains items that are not key-value objects", async () => {
1233
- const keyValues = [
1234
- 123,
1235
- "a string",
1236
- { key: "someKey" },
1237
- { value: "someValue" },
1238
- { key: "someKey1", value: "someValue1", invalid: true },
1239
- ];
1240
- writeFileSync("./keys.json", JSON.stringify(keyValues));
1241
- await expect(
1242
- runWrangler(`kv:bulk put --namespace-id some-namespace-id keys.json`)
1243
- ).rejects.toThrowErrorMatchingInlineSnapshot(`
1244
- "Unexpected JSON input from \\"keys.json\\".
1245
- Each item in the array should be an object that matches:
1246
-
1247
- interface KeyValue {
1248
- key: string;
1249
- value: string;
1250
- expiration?: number;
1251
- expiration_ttl?: number;
1252
- metadata?: object;
1253
- base64?: boolean;
1254
- }
1255
-
1256
- The item at index 0 is type: \\"number\\" - 123
1257
- The item at index 1 is type: \\"string\\" - \\"a string\\"
1258
- The item at index 2 is {\\"key\\":\\"someKey\\"}
1259
- The item at index 3 is {\\"value\\":\\"someValue\\"}"
1260
- `);
1261
-
1262
- expect(std.out).toMatchInlineSnapshot(`
1421
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1422
+ });
1423
+
1424
+ it("should error if the array contains items that are not key-value objects", async () => {
1425
+ const keyValues = [
1426
+ 123,
1427
+ "a string",
1428
+ { key: "someKey" },
1429
+ { value: "someValue" },
1430
+ // add a valid object here to make sure it's not included
1431
+ { key: "someKey1", value: "someValue1" },
1432
+ // this one will only add a warning
1433
+ { key: "someKey1", value: "someValue1", invalid: true },
1434
+ // back to the invalid ones
1435
+ { key: 123, value: "somevalue" },
1436
+ { key: "somekey", value: 123 },
1437
+ { key: "someKey1", value: "someValue1", expiration: "string" },
1438
+ { key: "someKey1", value: "someValue1", expiration_ttl: "string" },
1439
+ {
1440
+ key: 123,
1441
+ value: {
1442
+ a: {
1443
+ nested: "object",
1444
+ },
1445
+ },
1446
+ },
1447
+ { key: "someKey1", value: "someValue1", metadata: 123 },
1448
+ { key: "someKey1", value: "someValue1", base64: "string" },
1449
+ ];
1450
+ writeFileSync("./keys.json", JSON.stringify(keyValues));
1451
+ await expect(
1452
+ runWrangler(`kv:bulk put --namespace-id some-namespace-id keys.json`)
1453
+ ).rejects.toThrowErrorMatchingInlineSnapshot(`
1454
+ "Unexpected JSON input from \\"keys.json\\".
1455
+ Each item in the array should be an object that matches:
1456
+
1457
+ interface KeyValue {
1458
+ key: string;
1459
+ value: string;
1460
+ expiration?: number;
1461
+ expiration_ttl?: number;
1462
+ metadata?: object;
1463
+ base64?: boolean;
1464
+ }
1465
+
1466
+ The item at index 0 is 123
1467
+ The item at index 1 is \\"a string\\"
1468
+ The item at index 2 is {\\"key\\":\\"someKey\\"}
1469
+ The item at index 3 is {\\"value\\":\\"someValue\\"}
1470
+ The item at index 6 is {\\"key\\":123,\\"value\\":\\"somevalue\\"}
1471
+ The item at index 7 is {\\"key\\":\\"somekey\\",\\"value\\":123}
1472
+ The item at index 8 is {\\"key\\":\\"someKey1\\",\\"value\\":\\"someValue1\\",\\"expiration\\":\\"string\\"}
1473
+ The item at index 9 is {\\"key\\":\\"someKey1\\",\\"value\\":\\"someValue1\\",\\"expiration_ttl\\":\\"string\\"}
1474
+ The item at index 10 is {\\"key\\":123,\\"value\\":{\\"a\\":{\\"nested\\":\\"object\\"}}}
1475
+ The item at index 11 is {\\"key\\":\\"someKey1\\",\\"value\\":\\"someValue1\\",\\"metadata\\":123}
1476
+ The item at index 12 is {\\"key\\":\\"someKey1\\",\\"value\\":\\"someValue1\\",\\"base64\\":\\"string\\"}"
1477
+ `);
1478
+
1479
+ expect(std.out).toMatchInlineSnapshot(`
1263
1480
  "
1264
- If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
1481
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
1265
1482
  `);
1266
- expect(std.warn).toMatchInlineSnapshot(`
1483
+ expect(std.warn).toMatchInlineSnapshot(`
1267
1484
  "▲ [WARNING] Unexpected key-value properties in \\"keys.json\\".
1268
1485
 
1269
- The item at index 4 contains unexpected properties: [\\"invalid\\"].
1486
+ The item at index 5 contains unexpected properties: [\\"invalid\\"].
1270
1487
 
1271
1488
  "
1272
1489
  `);
1273
- });
1274
- });
1275
-
1276
- describe("delete", () => {
1277
- function mockDeleteRequest(
1278
- expectedNamespaceId: string,
1279
- expectedKeys: string[]
1280
- ) {
1281
- const requests = { count: 0 };
1282
- setMockResponse(
1283
- "/accounts/:accountId/storage/kv/namespaces/:namespaceId/bulk",
1284
- "DELETE",
1285
- ([_url, accountId, namespaceId], { headers, body }) => {
1286
- requests.count++;
1287
- expect(accountId).toEqual("some-account-id");
1288
- expect(namespaceId).toEqual(expectedNamespaceId);
1289
- expect(new Headers(headers ?? []).get("Content-Type")).toEqual(
1290
- "application/json"
1291
- );
1292
- expect(JSON.parse(body as string)).toEqual(
1293
- expectedKeys.slice(
1294
- (requests.count - 1) * 5000,
1295
- requests.count * 5000
1296
- )
1297
- );
1298
- return null;
1299
- }
1300
- );
1301
- return requests;
1302
- }
1303
-
1304
- it("should delete the keys parsed from a file", async () => {
1305
- const keys = ["someKey1", "ns:someKey2"];
1306
- writeFileSync("./keys.json", JSON.stringify(keys));
1307
- mockConfirm({
1308
- text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1309
- result: true,
1310
- });
1311
- const requests = mockDeleteRequest("some-namespace-id", keys);
1312
- await runWrangler(
1313
- `kv:bulk delete --namespace-id some-namespace-id keys.json`
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 delete the keys in batches of 5000 parsed from a file", async () => {
1322
- const keys = new Array(12000).fill("some-key");
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
- const requests = mockDeleteRequest("some-namespace-id", keys);
1329
- await runWrangler(
1330
- `kv:bulk delete --namespace-id some-namespace-id keys.json`
1331
- );
1332
- expect(requests.count).toEqual(3);
1333
- expect(std.out).toMatchInlineSnapshot(`
1334
- "Deleted 0 of 12000.
1335
- Deleted 5000 of 12000.
1336
- Deleted 10000 of 12000.
1337
- Deleted 12000 of 12000.
1490
+ });
1491
+ });
1492
+
1493
+ describe("delete", () => {
1494
+ function mockDeleteRequest(
1495
+ expectedNamespaceId: string,
1496
+ expectedKeys: string[]
1497
+ ) {
1498
+ const requests = { count: 0 };
1499
+ setMockResponse(
1500
+ "/accounts/:accountId/storage/kv/namespaces/:namespaceId/bulk",
1501
+ "DELETE",
1502
+ ([_url, accountId, namespaceId], { headers, body }) => {
1503
+ requests.count++;
1504
+ expect(accountId).toEqual("some-account-id");
1505
+ expect(namespaceId).toEqual(expectedNamespaceId);
1506
+ expect(new Headers(headers ?? []).get("Content-Type")).toEqual(
1507
+ "application/json"
1508
+ );
1509
+ expect(JSON.parse(body as string)).toEqual(
1510
+ expectedKeys.slice(
1511
+ (requests.count - 1) * 5000,
1512
+ requests.count * 5000
1513
+ )
1514
+ );
1515
+ return null;
1516
+ }
1517
+ );
1518
+ return requests;
1519
+ }
1520
+
1521
+ it("should delete the keys parsed from a file", async () => {
1522
+ const keys = ["someKey1", "ns:someKey2"];
1523
+ writeFileSync("./keys.json", JSON.stringify(keys));
1524
+ mockConfirm({
1525
+ text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1526
+ result: true,
1527
+ });
1528
+ const requests = mockDeleteRequest("some-namespace-id", keys);
1529
+ await runWrangler(
1530
+ `kv:bulk delete --namespace-id some-namespace-id keys.json`
1531
+ );
1532
+ expect(requests.count).toEqual(1);
1533
+ expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1534
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1535
+ expect(std.err).toMatchInlineSnapshot(`""`);
1536
+ });
1537
+
1538
+ it("should delete the keys in batches of 5000 parsed from a file", async () => {
1539
+ const keys = new Array(12000).fill("some-key");
1540
+ writeFileSync("./keys.json", JSON.stringify(keys));
1541
+ mockConfirm({
1542
+ text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1543
+ result: true,
1544
+ });
1545
+ const requests = mockDeleteRequest("some-namespace-id", keys);
1546
+ await runWrangler(
1547
+ `kv:bulk delete --namespace-id some-namespace-id keys.json`
1548
+ );
1549
+ expect(requests.count).toEqual(3);
1550
+ expect(std.out).toMatchInlineSnapshot(`
1551
+ "Deleted 0% (0 out of 12,000)
1552
+ Deleted 41% (5,000 out of 12,000)
1553
+ Deleted 83% (10,000 out of 12,000)
1554
+ Deleted 100% (12,000 out of 12,000)
1338
1555
  Success!"
1339
1556
  `);
1340
- expect(std.warn).toMatchInlineSnapshot(`""`);
1341
- expect(std.err).toMatchInlineSnapshot(`""`);
1342
- });
1343
-
1344
- it("should not delete the keys if the user confirms no", async () => {
1345
- const keys = ["someKey1", "ns:someKey2"];
1346
- writeFileSync("./keys.json", JSON.stringify(keys));
1347
- mockConfirm({
1348
- text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1349
- result: false,
1350
- });
1351
- await runWrangler(
1352
- `kv:bulk delete --namespace-id some-namespace-id keys.json`
1353
- );
1354
- expect(std.out).toMatchInlineSnapshot(
1355
- `"Not deleting keys read from \\"keys.json\\"."`
1356
- );
1357
- expect(std.warn).toMatchInlineSnapshot(`""`);
1358
- expect(std.err).toMatchInlineSnapshot(`""`);
1359
- });
1360
-
1361
- it("should delete the keys without asking if --force is provided", async () => {
1362
- const keys = ["someKey1", "ns:someKey2"];
1363
- writeFileSync("./keys.json", JSON.stringify(keys));
1364
- const requests = mockDeleteRequest("some-namespace-id", keys);
1365
- await runWrangler(
1366
- `kv:bulk delete --namespace-id some-namespace-id keys.json --force`
1367
- );
1368
- expect(requests.count).toEqual(1);
1369
- expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1370
- expect(std.warn).toMatchInlineSnapshot(`""`);
1371
- expect(std.err).toMatchInlineSnapshot(`""`);
1372
- });
1373
-
1374
- it("should delete the keys without asking if -f is provided", async () => {
1375
- const keys = ["someKey1", "ns:someKey2"];
1376
- writeFileSync("./keys.json", JSON.stringify(keys));
1377
- const requests = mockDeleteRequest("some-namespace-id", keys);
1378
- await runWrangler(
1379
- `kv:bulk delete --namespace-id some-namespace-id keys.json -f`
1380
- );
1381
- expect(requests.count).toEqual(1);
1382
- expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1383
- expect(std.warn).toMatchInlineSnapshot(`""`);
1384
- expect(std.err).toMatchInlineSnapshot(`""`);
1385
- });
1386
-
1387
- it("should error if the file is not a JSON array", async () => {
1388
- const keys = 12354;
1389
- writeFileSync("./keys.json", JSON.stringify(keys));
1390
- mockConfirm({
1391
- text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1392
- result: true,
1393
- });
1394
- await expect(
1395
- runWrangler(
1396
- `kv:bulk delete --namespace-id some-namespace-id keys.json`
1397
- )
1398
- ).rejects.toThrowErrorMatchingInlineSnapshot(`
1399
- "Unexpected JSON input from \\"keys.json\\".
1400
- Expected an array of strings but got:
1401
- 12354"
1402
- `);
1403
- expect(std.out).toMatchInlineSnapshot(`
1557
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1558
+ expect(std.err).toMatchInlineSnapshot(`""`);
1559
+ });
1560
+
1561
+ it("should not delete the keys if the user confirms no", async () => {
1562
+ const keys = ["someKey1", "ns:someKey2"];
1563
+ writeFileSync("./keys.json", JSON.stringify(keys));
1564
+ mockConfirm({
1565
+ text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1566
+ result: false,
1567
+ });
1568
+ await runWrangler(
1569
+ `kv:bulk delete --namespace-id some-namespace-id keys.json`
1570
+ );
1571
+ expect(std.out).toMatchInlineSnapshot(
1572
+ `"Not deleting keys read from \\"keys.json\\"."`
1573
+ );
1574
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1575
+ expect(std.err).toMatchInlineSnapshot(`""`);
1576
+ });
1577
+
1578
+ it("should delete the keys without asking if --force is provided", async () => {
1579
+ const keys = ["someKey1", "ns:someKey2"];
1580
+ writeFileSync("./keys.json", JSON.stringify(keys));
1581
+ const requests = mockDeleteRequest("some-namespace-id", keys);
1582
+ await runWrangler(
1583
+ `kv:bulk delete --namespace-id some-namespace-id keys.json --force`
1584
+ );
1585
+ expect(requests.count).toEqual(1);
1586
+ expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1587
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1588
+ expect(std.err).toMatchInlineSnapshot(`""`);
1589
+ });
1590
+
1591
+ it("should delete the keys without asking if -f is provided", async () => {
1592
+ const keys = ["someKey1", "ns:someKey2"];
1593
+ writeFileSync("./keys.json", JSON.stringify(keys));
1594
+ const requests = mockDeleteRequest("some-namespace-id", keys);
1595
+ await runWrangler(
1596
+ `kv:bulk delete --namespace-id some-namespace-id keys.json -f`
1597
+ );
1598
+ expect(requests.count).toEqual(1);
1599
+ expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1600
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1601
+ expect(std.err).toMatchInlineSnapshot(`""`);
1602
+ });
1603
+
1604
+ it("should error if the file is not a JSON array", async () => {
1605
+ const keys = 12354;
1606
+ writeFileSync("./keys.json", JSON.stringify(keys));
1607
+ mockConfirm({
1608
+ text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1609
+ result: true,
1610
+ });
1611
+ await expect(
1612
+ runWrangler(
1613
+ `kv:bulk delete --namespace-id some-namespace-id keys.json`
1614
+ )
1615
+ ).rejects.toThrowErrorMatchingInlineSnapshot(`
1616
+ "Unexpected JSON input from \\"keys.json\\".
1617
+ Expected an array of strings but got:
1618
+ 12354"
1619
+ `);
1620
+ expect(std.out).toMatchInlineSnapshot(`
1404
1621
  "
1405
- If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
1622
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
1406
1623
  `);
1407
- expect(std.warn).toMatchInlineSnapshot(`""`);
1408
- });
1409
-
1410
- it("should error if the file contains non-string items", async () => {
1411
- const keys = ["good", 12354, { key: "someKey" }, null];
1412
- writeFileSync("./keys.json", JSON.stringify(keys));
1413
- mockConfirm({
1414
- text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1415
- result: true,
1416
- });
1417
- await expect(
1418
- runWrangler(
1419
- `kv:bulk delete --namespace-id some-namespace-id keys.json`
1420
- )
1421
- ).rejects.toThrowErrorMatchingInlineSnapshot(`
1422
- "Unexpected JSON input from \\"keys.json\\".
1423
- Expected an array of strings.
1424
- The item at index 1 is type: \\"number\\" - 12354
1425
- The item at index 2 is type: \\"object\\" - {\\"key\\":\\"someKey\\"}
1426
- The item at index 3 is type: \\"object\\" - null"
1427
- `);
1428
- expect(std.out).toMatchInlineSnapshot(`
1624
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1625
+ });
1626
+
1627
+ it("should error if the file contains non-string items", async () => {
1628
+ const keys = ["good", 12354, { key: "someKey" }, null];
1629
+ writeFileSync("./keys.json", JSON.stringify(keys));
1630
+ mockConfirm({
1631
+ text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1632
+ result: true,
1633
+ });
1634
+ await expect(
1635
+ runWrangler(
1636
+ `kv:bulk delete --namespace-id some-namespace-id keys.json`
1637
+ )
1638
+ ).rejects.toThrowErrorMatchingInlineSnapshot(`
1639
+ "Unexpected JSON input from \\"keys.json\\".
1640
+ Expected an array of strings.
1641
+ The item at index 1 is type: \\"number\\" - 12354
1642
+ The item at index 2 is type: \\"object\\" - {\\"key\\":\\"someKey\\"}
1643
+ The item at index 3 is type: \\"object\\" - null"
1644
+ `);
1645
+ expect(std.out).toMatchInlineSnapshot(`
1429
1646
  "
1430
- If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
1647
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
1431
1648
  `);
1432
- expect(std.warn).toMatchInlineSnapshot(`""`);
1433
- });
1434
- });
1435
- });
1649
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1650
+ });
1651
+ });
1652
+ });
1436
1653
  });
1437
1654
 
1438
1655
  function writeWranglerConfig() {
1439
- writeFileSync(
1440
- "./wrangler.toml",
1441
- [
1442
- 'name = "other-worker"',
1443
- "kv_namespaces = [",
1444
- ' { binding = "someBinding", id = "bound-id", preview_id = "preview-bound-id" }',
1445
- "]",
1446
- "",
1447
- "[env.some-environment]",
1448
- "kv_namespaces = [",
1449
- ' { binding = "someBinding", id = "env-bound-id", preview_id = "preview-env-bound-id" }',
1450
- "]",
1451
- ].join("\n"),
1452
- "utf-8"
1453
- );
1656
+ writeFileSync(
1657
+ "./wrangler.toml",
1658
+ [
1659
+ 'name = "other-worker"',
1660
+ "kv_namespaces = [",
1661
+ ' { binding = "someBinding", id = "bound-id", preview_id = "preview-bound-id" }',
1662
+ "]",
1663
+ "",
1664
+ "[env.some-environment]",
1665
+ "kv_namespaces = [",
1666
+ ' { binding = "someBinding", id = "env-bound-id", preview_id = "preview-env-bound-id" }',
1667
+ "]",
1668
+ ].join("\n"),
1669
+ "utf-8"
1670
+ );
1454
1671
  }