wrangler 0.0.0-e41c7e41 → 0.0.0-e44f496a8

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