wrangler 0.0.0-e5a3814 → 0.0.0-e60dc909

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 (302) hide show
  1. package/README.md +23 -3
  2. package/bin/wrangler.js +170 -62
  3. package/kv-asset-handler.js +1 -0
  4. package/miniflare-dist/index.mjs +1499 -21
  5. package/package.json +193 -153
  6. package/src/__tests__/access.test.ts +25 -0
  7. package/src/__tests__/api-dev.test.ts +238 -0
  8. package/src/__tests__/api-devregistry.test.js +64 -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 +4152 -3476
  13. package/src/__tests__/d1/d1.test.ts +123 -0
  14. package/src/__tests__/d1/splitter.test.ts +255 -0
  15. package/src/__tests__/delete.test.ts +266 -0
  16. package/src/__tests__/deployments.test.ts +105 -0
  17. package/src/__tests__/dev.test.tsx +1559 -956
  18. package/src/__tests__/generate.test.ts +238 -0
  19. package/src/__tests__/get-host-from-url.test.ts +16 -0
  20. package/src/__tests__/guess-worker-format.test.ts +68 -68
  21. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  22. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  23. package/src/__tests__/helpers/mock-auth-domain.ts +20 -0
  24. package/src/__tests__/helpers/mock-bin.ts +20 -20
  25. package/src/__tests__/helpers/mock-cfetch.ts +167 -100
  26. package/src/__tests__/helpers/mock-console.ts +58 -39
  27. package/src/__tests__/helpers/mock-dialogs.ts +88 -81
  28. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -0
  29. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  30. package/src/__tests__/helpers/mock-istty.ts +65 -18
  31. package/src/__tests__/helpers/mock-known-routes.ts +7 -0
  32. package/src/__tests__/helpers/mock-kv.ts +27 -27
  33. package/src/__tests__/helpers/mock-oauth-flow.ts +244 -228
  34. package/src/__tests__/helpers/mock-process.ts +34 -0
  35. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  36. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  37. package/src/__tests__/helpers/msw/blob-worker.cjs +19 -0
  38. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  39. package/src/__tests__/helpers/msw/handlers/deployments.ts +59 -0
  40. package/src/__tests__/helpers/msw/handlers/namespaces.ts +104 -0
  41. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  42. package/src/__tests__/helpers/msw/handlers/r2.ts +80 -0
  43. package/src/__tests__/helpers/msw/handlers/script.ts +75 -0
  44. package/src/__tests__/helpers/msw/handlers/user.ts +63 -0
  45. package/src/__tests__/helpers/msw/handlers/zones.ts +22 -0
  46. package/src/__tests__/helpers/msw/index.ts +21 -0
  47. package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
  48. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  49. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  50. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  51. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  52. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  53. package/src/__tests__/helpers/worker-scripts/parent-worker.js +8 -0
  54. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  55. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  56. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  57. package/src/__tests__/https-options.test.ts +142 -109
  58. package/src/__tests__/index.test.ts +245 -234
  59. package/src/__tests__/init.test.ts +3146 -1608
  60. package/src/__tests__/jest.setup.ts +167 -46
  61. package/src/__tests__/kv.test.ts +1778 -1471
  62. package/src/__tests__/logger.test.ts +100 -74
  63. package/src/__tests__/logout.test.ts +47 -0
  64. package/src/__tests__/metrics.test.ts +493 -0
  65. package/src/__tests__/middleware.scheduled.test.ts +145 -0
  66. package/src/__tests__/middleware.test.ts +750 -0
  67. package/src/__tests__/package-manager.test.ts +303 -303
  68. package/src/__tests__/pages-deployment-tail.test.ts +884 -0
  69. package/src/__tests__/pages.test.ts +2888 -743
  70. package/src/__tests__/parse.test.ts +252 -252
  71. package/src/__tests__/paths.test.ts +39 -0
  72. package/src/__tests__/publish.test.ts +7641 -5626
  73. package/src/__tests__/pubsub.test.ts +490 -0
  74. package/src/__tests__/queues.test.ts +522 -0
  75. package/src/__tests__/r2.test.ts +388 -228
  76. package/src/__tests__/route.test.ts +18 -18
  77. package/src/__tests__/secret.test.ts +689 -469
  78. package/src/__tests__/tail.test.ts +782 -567
  79. package/src/__tests__/test-old-node-version.js +31 -0
  80. package/src/__tests__/tsconfig-sanity.ts +12 -0
  81. package/src/__tests__/tsconfig.json +8 -0
  82. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  83. package/src/__tests__/type-generation.test.ts +233 -0
  84. package/src/__tests__/user.test.ts +117 -119
  85. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  86. package/src/__tests__/validate-dev-props.test.ts +56 -0
  87. package/src/__tests__/version.test.ts +35 -0
  88. package/src/__tests__/whoami.test.tsx +176 -132
  89. package/src/__tests__/worker-namespace.test.ts +326 -0
  90. package/src/abort.d.ts +1 -1
  91. package/src/api/dev.ts +247 -0
  92. package/src/api/index.ts +2 -0
  93. package/src/bundle-reporter.ts +68 -0
  94. package/src/bundle.ts +785 -159
  95. package/src/cfetch/index.ts +120 -83
  96. package/src/cfetch/internal.ts +211 -92
  97. package/src/cli.ts +23 -8
  98. package/src/config/config.ts +236 -195
  99. package/src/config/diagnostics.ts +61 -61
  100. package/src/config/environment.ts +514 -357
  101. package/src/config/index.ts +326 -193
  102. package/src/config/validation-helpers.ts +379 -366
  103. package/src/config/validation.ts +1979 -1380
  104. package/src/config-cache.ts +81 -41
  105. package/src/create-worker-preview.ts +239 -142
  106. package/src/create-worker-upload-form.ts +309 -238
  107. package/src/d1/backups.tsx +223 -0
  108. package/src/d1/constants.ts +2 -0
  109. package/src/d1/create.tsx +63 -0
  110. package/src/d1/delete.ts +56 -0
  111. package/src/d1/execute.tsx +323 -0
  112. package/src/d1/formatTimeAgo.ts +14 -0
  113. package/src/d1/index.ts +101 -0
  114. package/src/d1/list.tsx +48 -0
  115. package/src/d1/migrations/apply.tsx +197 -0
  116. package/src/d1/migrations/create.tsx +77 -0
  117. package/src/d1/migrations/helpers.ts +147 -0
  118. package/src/d1/migrations/index.ts +3 -0
  119. package/src/d1/migrations/list.tsx +79 -0
  120. package/src/d1/migrations/options.ts +18 -0
  121. package/src/d1/options.ts +22 -0
  122. package/src/d1/splitter.ts +161 -0
  123. package/src/d1/types.ts +24 -0
  124. package/src/d1/utils.ts +48 -0
  125. package/src/delete.ts +103 -0
  126. package/src/deployments.ts +83 -0
  127. package/src/deprecated/index.ts +145 -0
  128. package/src/dev/dev-vars.ts +20 -17
  129. package/src/dev/dev.tsx +546 -333
  130. package/src/dev/get-local-persistence-path.ts +31 -0
  131. package/src/dev/local.tsx +912 -302
  132. package/src/dev/remote.tsx +618 -225
  133. package/src/dev/start-server.ts +543 -0
  134. package/src/dev/use-esbuild.ts +183 -97
  135. package/src/dev/validate-dev-props.ts +31 -0
  136. package/src/dev-registry.ts +201 -0
  137. package/src/dev.tsx +949 -0
  138. package/src/dialogs.ts +136 -0
  139. package/src/dispatch-namespace.ts +207 -0
  140. package/src/docs/index.ts +97 -0
  141. package/src/durable.ts +87 -87
  142. package/src/entry.ts +235 -228
  143. package/src/environment-variables/factory.ts +88 -0
  144. package/src/environment-variables/misc-variables.ts +30 -0
  145. package/src/errors.ts +6 -6
  146. package/src/generate/index.ts +300 -0
  147. package/src/git-client.ts +135 -0
  148. package/src/global-wrangler-config-path.ts +26 -0
  149. package/src/https-options.ts +84 -80
  150. package/src/index.ts +694 -0
  151. package/src/init.ts +1024 -0
  152. package/src/inspect.ts +698 -593
  153. package/src/intl-polyfill.d.ts +123 -123
  154. package/src/is-ci.ts +14 -0
  155. package/src/is-interactive.ts +16 -0
  156. package/src/jest.d.ts +4 -0
  157. package/src/kv/helpers.ts +430 -0
  158. package/src/kv/index.ts +596 -0
  159. package/src/logger.ts +80 -42
  160. package/src/metrics/index.ts +5 -0
  161. package/src/metrics/metrics-config.ts +239 -0
  162. package/src/metrics/metrics-dispatcher.ts +96 -0
  163. package/src/metrics/metrics-usage-headers.ts +24 -0
  164. package/src/metrics/send-event.ts +97 -0
  165. package/src/miniflare-cli/assets.ts +250 -0
  166. package/src/miniflare-cli/index.ts +202 -33
  167. package/src/miniflare-cli/request-context.ts +18 -18
  168. package/src/miniflare-cli/tsconfig.json +9 -0
  169. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  170. package/src/miniflare-cli/types.ts +11 -0
  171. package/src/module-collection.ts +221 -212
  172. package/src/open-in-browser.ts +4 -6
  173. package/src/package-manager.ts +173 -128
  174. package/src/pages/build.ts +270 -0
  175. package/src/pages/constants.ts +18 -0
  176. package/src/pages/deployment-tails.ts +284 -0
  177. package/src/pages/deployments.tsx +84 -0
  178. package/src/pages/dev.ts +711 -0
  179. package/src/pages/errors.ts +66 -0
  180. package/src/pages/functions/buildPlugin.ts +107 -0
  181. package/src/pages/functions/buildWorker.ts +166 -0
  182. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  183. package/src/pages/functions/filepath-routing.ts +189 -0
  184. package/src/pages/functions/identifiers.ts +78 -0
  185. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  186. package/src/pages/functions/routes-consolidation.ts +73 -0
  187. package/src/pages/functions/routes-transformation.test.ts +282 -0
  188. package/src/pages/functions/routes-transformation.ts +115 -0
  189. package/src/pages/functions/routes-validation.test.ts +403 -0
  190. package/src/pages/functions/routes-validation.ts +202 -0
  191. package/src/pages/functions/routes.ts +151 -0
  192. package/src/pages/functions/tsconfig.json +8 -0
  193. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  194. package/src/pages/functions.ts +82 -0
  195. package/src/pages/hash.ts +13 -0
  196. package/src/pages/index.ts +102 -0
  197. package/src/pages/projects.tsx +167 -0
  198. package/src/pages/prompt-select-project.tsx +31 -0
  199. package/src/pages/publish.tsx +462 -0
  200. package/src/pages/types.ts +41 -0
  201. package/src/pages/upload.tsx +447 -0
  202. package/src/pages/utils.ts +23 -0
  203. package/src/parse.ts +208 -125
  204. package/src/paths.ts +53 -8
  205. package/src/proxy.ts +623 -407
  206. package/src/publish/index.ts +270 -0
  207. package/src/publish/publish.ts +1038 -0
  208. package/src/pubsub/index.ts +286 -0
  209. package/src/pubsub/pubsub-commands.ts +624 -0
  210. package/src/queues/cli/commands/consumer/add.ts +71 -0
  211. package/src/queues/cli/commands/consumer/index.ts +22 -0
  212. package/src/queues/cli/commands/consumer/remove.ts +38 -0
  213. package/src/queues/cli/commands/create.ts +25 -0
  214. package/src/queues/cli/commands/delete.ts +26 -0
  215. package/src/queues/cli/commands/index.ts +36 -0
  216. package/src/queues/cli/commands/list.ts +25 -0
  217. package/src/queues/client.ts +135 -0
  218. package/src/queues/utils.ts +18 -0
  219. package/src/r2/constants.ts +4 -0
  220. package/src/r2/helpers.ts +131 -0
  221. package/src/r2/index.ts +289 -0
  222. package/src/routes.ts +140 -0
  223. package/src/secret/index.ts +379 -0
  224. package/src/selfsigned.d.ts +23 -23
  225. package/src/sites.ts +372 -0
  226. package/src/tail/createTail.ts +379 -0
  227. package/src/tail/filters.ts +108 -110
  228. package/src/tail/index.ts +210 -296
  229. package/src/tail/printing.ts +86 -46
  230. package/src/tsconfig-sanity.ts +16 -0
  231. package/src/type-generation.ts +181 -0
  232. package/src/update-check.ts +11 -11
  233. package/src/user/access.ts +68 -0
  234. package/src/user/auth-variables.ts +113 -0
  235. package/src/user/choose-account.tsx +39 -0
  236. package/src/user/generate-auth-url.ts +33 -0
  237. package/src/user/generate-random-state.ts +16 -0
  238. package/src/user/index.ts +2 -0
  239. package/src/user/user.ts +1232 -0
  240. package/src/utils/collectKeyValues.ts +14 -0
  241. package/src/whoami.ts +135 -0
  242. package/src/worker.ts +177 -107
  243. package/src/yargs-types.ts +24 -0
  244. package/src/zones.ts +158 -40
  245. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  246. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  247. package/templates/__tests__/tsconfig.json +8 -0
  248. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  249. package/templates/checked-fetch.js +17 -0
  250. package/templates/d1-beta-facade.js +241 -0
  251. package/templates/facade.d.ts +14 -0
  252. package/templates/first-party-worker-module-facade.ts +19 -0
  253. package/templates/format-dev-errors.ts +33 -0
  254. package/templates/init-tests/test-jest-new-worker.js +23 -0
  255. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  256. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  257. package/templates/middleware/common.ts +62 -0
  258. package/templates/middleware/loader-modules.ts +82 -0
  259. package/templates/middleware/loader-sw.ts +233 -0
  260. package/templates/middleware/middleware-miniflare3-json-error.ts +20 -0
  261. package/templates/middleware/middleware-pretty-error.ts +40 -0
  262. package/templates/middleware/middleware-scheduled.ts +15 -0
  263. package/templates/new-worker-scheduled.js +3 -3
  264. package/templates/new-worker-scheduled.ts +15 -15
  265. package/templates/new-worker.js +3 -3
  266. package/templates/new-worker.ts +15 -15
  267. package/templates/no-op-worker.js +10 -0
  268. package/templates/pages-dev-pipeline.ts +31 -0
  269. package/templates/pages-dev-util.ts +52 -0
  270. package/templates/pages-shim.ts +12 -0
  271. package/templates/pages-template-plugin.ts +176 -0
  272. package/templates/pages-template-worker.ts +189 -0
  273. package/templates/serve-static-assets.ts +65 -0
  274. package/templates/service-bindings-module-facade.js +54 -0
  275. package/templates/service-bindings-sw-facade.js +42 -0
  276. package/templates/tsconfig-sanity.ts +11 -0
  277. package/templates/tsconfig.init.json +106 -0
  278. package/templates/tsconfig.json +6 -103
  279. package/templates/tsconfig.tsbuildinfo +1 -0
  280. package/wrangler-dist/cli.d.ts +906 -0
  281. package/wrangler-dist/cli.js +128866 -110945
  282. package/wrangler-dist/wasm-sync.wasm +0 -0
  283. package/pages/functions/buildPlugin.ts +0 -105
  284. package/pages/functions/buildWorker.ts +0 -151
  285. package/pages/functions/filepath-routing.ts +0 -189
  286. package/pages/functions/identifiers.ts +0 -78
  287. package/pages/functions/routes.ts +0 -156
  288. package/pages/functions/template-plugin.ts +0 -147
  289. package/pages/functions/template-worker.ts +0 -143
  290. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  291. package/src/dialogs.tsx +0 -135
  292. package/src/environment-variables.ts +0 -35
  293. package/src/index.tsx +0 -2846
  294. package/src/kv.ts +0 -408
  295. package/src/miniflare-cli/enum-keys.ts +0 -17
  296. package/src/pages.tsx +0 -2093
  297. package/src/publish.ts +0 -716
  298. package/src/r2.ts +0 -50
  299. package/src/sites.tsx +0 -326
  300. package/src/user.tsx +0 -1214
  301. package/src/whoami.tsx +0 -71
  302. package/templates/static-asset-facade.js +0 -43
@@ -1,24 +1,52 @@
1
+ import { Readable } from "node:stream";
1
2
  import { URL, URLSearchParams } from "node:url";
2
3
  import { pathToRegexp } from "path-to-regexp";
3
- import { getCloudflareApiBaseUrl } from "../../cfetch";
4
+ import { Response } from "undici";
5
+ import { getCloudflareApiBaseUrl } from "../../environment-variables/misc-variables";
4
6
  import type { FetchResult, FetchError } from "../../cfetch";
5
- import type { RequestInit } from "undici";
7
+ import type {
8
+ fetchInternal,
9
+ fetchR2Objects,
10
+ performApiFetch,
11
+ } from "../../cfetch/internal";
12
+ import type { RequestInit, BodyInit, HeadersInit } from "undici";
13
+
14
+ /**
15
+ * When the custom mocks fallthrough in tests because they aren't set, instead of throwing an error,
16
+ * we use real fetch to make the request which will use Mock Service Workers.
17
+ */
18
+ const {
19
+ fetchInternal: realFetchInternal,
20
+ }: { fetchInternal: typeof fetchInternal } = jest.requireActual(
21
+ "../../cfetch/internal"
22
+ );
23
+ const {
24
+ fetchR2Objects: realFetchR2Objects,
25
+ }: { fetchR2Objects: typeof fetchR2Objects } = jest.requireActual(
26
+ "../../cfetch/internal"
27
+ );
28
+
29
+ const {
30
+ performApiFetch: realPerformApiFetch,
31
+ }: { performApiFetch: typeof performApiFetch } = jest.requireActual(
32
+ "../../cfetch/internal"
33
+ );
6
34
 
7
35
  /**
8
36
  * The signature of the function that will handle a mock request.
9
37
  */
10
38
  export type MockHandler<ResponseType> = (
11
- uri: RegExpExecArray,
12
- init: RequestInit,
13
- queryParams: URLSearchParams
39
+ uri: RegExpExecArray,
40
+ init: RequestInit,
41
+ queryParams: URLSearchParams
14
42
  ) => ResponseType | Promise<ResponseType>;
15
43
 
16
44
  type RemoveMockFn = () => void;
17
45
 
18
46
  interface MockFetch<ResponseType> {
19
- regexp: RegExp;
20
- method: string | undefined;
21
- handler: MockHandler<ResponseType>;
47
+ regexp: RegExp;
48
+ method: string | undefined;
49
+ handler: MockHandler<ResponseType>;
22
50
  }
23
51
  const mocks: MockFetch<unknown>[] = [];
24
52
 
@@ -30,25 +58,33 @@ const mocks: MockFetch<unknown>[] = [];
30
58
  * Once found the handler will be used to generate a mock response.
31
59
  */
32
60
  export async function mockFetchInternal(
33
- resource: string,
34
- init: RequestInit = {},
35
- queryParams: URLSearchParams = new URLSearchParams()
61
+ resource: string,
62
+ init: RequestInit = {},
63
+ queryParams: URLSearchParams | undefined
36
64
  ) {
37
- for (const { regexp, method, handler } of mocks) {
38
- const resourcePath = new URL(resource, getCloudflareApiBaseUrl()).pathname;
39
- const uri = regexp.exec(resourcePath);
40
- // Do the resource path and (if specified) the HTTP method match?
41
- if (uri !== null && (!method || method === (init.method ?? "GET"))) {
42
- // The `resource` regular expression will extract the labelled groups from the URL.
43
- // These are passed through to the `handler` call, to allow it to do additional checks or behaviour.
44
- return await handler(uri, init, queryParams); // TODO: should we have some kind of fallthrough system? we'll see.
45
- }
46
- }
47
- throw new Error(
48
- `no mocks found for ${init.method ?? "any HTTP"} request to ${resource}`
49
- );
65
+ for (const { regexp, method, handler } of mocks) {
66
+ const resourcePath = new URL(resource, getCloudflareApiBaseUrl()).pathname;
67
+ const uri = regexp.exec(resourcePath);
68
+ // Do the resource path and (if specified) the HTTP method match?
69
+ if (uri !== null && (!method || method === (init.method ?? "GET"))) {
70
+ // The `resource` regular expression will extract the labelled groups from the URL.
71
+ // These are passed through to the `handler` call, to allow it to do additional checks or behaviour.
72
+ return await handler(uri, init, queryParams ?? new URLSearchParams()); // TODO: should we have some kind of fallthrough system? we'll see.
73
+ }
74
+ }
75
+
76
+ // let it fall through to mock-service-worker
77
+ // (do a real, unmocked fetch)
78
+ return await realFetchInternal(resource, init, queryParams);
50
79
  }
51
80
 
81
+ /**
82
+ * We don't have loads of infrastructure around performApiFetch
83
+ * the same way we do for cfetch, so we'll just pass off the real
84
+ * deal to avoid getting it auto-mocked, so that msw can catch it.
85
+ */
86
+ export const mockPerformApiFetch = realPerformApiFetch;
87
+
52
88
  /**
53
89
  * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
54
90
  *
@@ -57,8 +93,8 @@ export async function mockFetchInternal(
57
93
  * @param handler The function that will generate the mock response for this request.
58
94
  */
59
95
  export function setMockRawResponse<ResponseType>(
60
- resource: string,
61
- handler: MockHandler<ResponseType>
96
+ resource: string,
97
+ handler: MockHandler<ResponseType>
62
98
  ): RemoveMockFn;
63
99
  /**
64
100
  * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
@@ -69,32 +105,32 @@ export function setMockRawResponse<ResponseType>(
69
105
  * @param handler The function that will generate the mock response for this request.
70
106
  */
71
107
  export function setMockRawResponse<ResponseType>(
72
- resource: string,
73
- method: string,
74
- handler: MockHandler<ResponseType>
108
+ resource: string,
109
+ method: string,
110
+ handler: MockHandler<ResponseType>
75
111
  ): RemoveMockFn;
76
112
  /**
77
113
  * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
78
114
  */
79
115
  export function setMockRawResponse<ResponseType>(
80
- resource: string,
81
- ...args: [string, MockHandler<ResponseType>] | [MockHandler<ResponseType>]
116
+ resource: string,
117
+ ...args: [string, MockHandler<ResponseType>] | [MockHandler<ResponseType>]
82
118
  ): RemoveMockFn {
83
- const handler = args.pop() as MockHandler<ResponseType>;
84
- const method = args.pop() as string;
85
- const mock = {
86
- resource,
87
- method,
88
- handler,
89
- regexp: pathToRegexp(resource),
90
- };
91
- mocks.push(mock);
92
- return () => {
93
- const mockIndex = mocks.indexOf(mock);
94
- if (mockIndex !== -1) {
95
- mocks.splice(mockIndex, 1);
96
- }
97
- };
119
+ const handler = args.pop() as MockHandler<ResponseType>;
120
+ const method = args.pop() as string;
121
+ const mock = {
122
+ resource,
123
+ method,
124
+ handler,
125
+ regexp: pathToRegexp(resource),
126
+ };
127
+ mocks.push(mock);
128
+ return () => {
129
+ const mockIndex = mocks.indexOf(mock);
130
+ if (mockIndex !== -1) {
131
+ mocks.splice(mockIndex, 1);
132
+ }
133
+ };
98
134
  }
99
135
 
100
136
  /**
@@ -107,8 +143,8 @@ export function setMockRawResponse<ResponseType>(
107
143
  * @param handler The function that will generate the mock response for this request.
108
144
  */
109
145
  export function setMockResponse<ResponseType>(
110
- resource: string,
111
- handler: MockHandler<ResponseType>
146
+ resource: string,
147
+ handler: MockHandler<ResponseType>
112
148
  ): RemoveMockFn;
113
149
  /**
114
150
  * Specify an expected resource path that is to be handled, resulting in a FetchRequest..
@@ -119,48 +155,49 @@ export function setMockResponse<ResponseType>(
119
155
  * @param handler The function that will generate the mock response for this request.
120
156
  */
121
157
  export function setMockResponse<ResponseType>(
122
- resource: string,
123
- method: string,
124
- handler: MockHandler<ResponseType>
158
+ resource: string,
159
+ method: string,
160
+ handler: MockHandler<ResponseType>
125
161
  ): RemoveMockFn;
126
162
  /**
127
163
  * Specify an expected resource path that is to be handled, resulting in a FetchRequest.
128
164
  */
129
165
  export function setMockResponse<ResponseType>(
130
- resource: string,
131
- ...args: [string, MockHandler<ResponseType>] | [MockHandler<ResponseType>]
166
+ resource: string,
167
+ ...args: [string, MockHandler<ResponseType>] | [MockHandler<ResponseType>]
132
168
  ): RemoveMockFn {
133
- const handler = args.pop() as MockHandler<ResponseType>;
134
- const method = args.pop() as string;
135
- return setMockRawResponse(resource, method, (...handlerArgs) =>
136
- createFetchResult(handler(...handlerArgs))
137
- );
169
+ const handler = args.pop() as MockHandler<ResponseType>;
170
+ const method = args.pop() as string;
171
+ return setMockRawResponse(resource, method, (...handlerArgs) =>
172
+ createFetchResult(handler(...handlerArgs))
173
+ );
138
174
  }
139
175
 
140
176
  /**
141
177
  * A helper to make it easier to create `FetchResult` objects in tests.
178
+ * TODO: Hijack this for MSW response objects. - JACOB
142
179
  */
143
180
  export async function createFetchResult<ResponseType>(
144
- result: ResponseType | Promise<ResponseType>,
145
- success = true,
146
- errors: FetchError[] = [],
147
- messages: string[] = [],
148
- result_info?: unknown
181
+ result: ResponseType | Promise<ResponseType>,
182
+ success = true,
183
+ errors: FetchError[] = [],
184
+ messages: string[] = [],
185
+ result_info?: unknown
149
186
  ): Promise<FetchResult<ResponseType>> {
150
- return result_info
151
- ? {
152
- result: await result,
153
- success,
154
- errors,
155
- messages,
156
- result_info,
157
- }
158
- : {
159
- result: await result,
160
- success,
161
- errors,
162
- messages,
163
- };
187
+ return result_info
188
+ ? {
189
+ result: await result,
190
+ success,
191
+ errors,
192
+ messages,
193
+ result_info,
194
+ }
195
+ : {
196
+ result: await result,
197
+ success,
198
+ errors,
199
+ messages,
200
+ };
164
201
  }
165
202
 
166
203
  /**
@@ -169,7 +206,7 @@ export async function createFetchResult<ResponseType>(
169
206
  * This should be called in an `afterEach()` block to ensure that mock handlers do not leak between tests.
170
207
  */
171
208
  export function unsetAllMocks() {
172
- mocks.length = 0;
209
+ mocks.length = 0;
173
210
  }
174
211
 
175
212
  /**
@@ -179,33 +216,63 @@ export function unsetAllMocks() {
179
216
  * special-case mocking it here.
180
217
  */
181
218
 
182
- const kvGetMocks = new Map<string, string>();
219
+ const kvGetMocks = new Map<string, string | Buffer>();
220
+ const r2GetMocks = new Map<string, string | undefined>();
221
+ const dashScriptMocks = new Map<string, string | undefined>();
183
222
 
184
223
  /**
185
- * @mocked typeof fetchKVGetValue
224
+ * @mocked typeof fetchR2Objects
186
225
  */
187
- export function mockFetchKVGetValue(
188
- accountId: string,
189
- namespaceId: string,
190
- key: string
191
- ) {
192
- const mapKey = `${accountId}/${namespaceId}/${key}`;
193
- if (kvGetMocks.has(mapKey)) {
194
- const value = kvGetMocks.get(mapKey);
195
- if (value !== undefined) return Promise.resolve(value);
196
- }
197
- throw new Error(`no mock value found for \`kv:key get\` - ${mapKey}`);
226
+ export async function mockFetchR2Objects(
227
+ resource: string,
228
+ bodyInit: {
229
+ body: BodyInit | Readable;
230
+ headers: HeadersInit | undefined;
231
+ method: "PUT" | "GET" | "DELETE";
232
+ }
233
+ ): Promise<Response> {
234
+ if (r2GetMocks.has(resource)) {
235
+ /**
236
+ * Here we destroy & removeListeners to "drain" the stream, for testing purposes
237
+ * mimicking the fetch request taking in the stream and draining it.
238
+ */
239
+ if (bodyInit.body instanceof Readable) {
240
+ bodyInit.body.destroy();
241
+ bodyInit.body.removeAllListeners();
242
+ }
243
+
244
+ const value = r2GetMocks.get(resource);
245
+
246
+ return new Response(value);
247
+ }
248
+
249
+ // No mocks found for ${init.method ?? "any HTTP"} request to ${resource}
250
+ // let it fall through to Mock Service Worker with a real fetch.
251
+ return await realFetchR2Objects(resource, bodyInit);
198
252
  }
199
253
 
200
- export function setMockFetchKVGetValue(
201
- accountId: string,
202
- namespaceId: string,
203
- key: string,
204
- value: string
205
- ) {
206
- kvGetMocks.set(`${accountId}/${namespaceId}/${key}`, value);
254
+ /**
255
+ * Mock setter for usage within test blocks, companion helper to `mockFetchR2Objects`
256
+ */
257
+ export function setMockFetchR2Objects({
258
+ accountId,
259
+ bucketName,
260
+ objectName,
261
+ mockResponse,
262
+ }: {
263
+ accountId: string;
264
+ bucketName: string;
265
+ objectName: string;
266
+ mockResponse?: string;
267
+ }) {
268
+ r2GetMocks.set(
269
+ `/accounts/${accountId}/r2/buckets/${bucketName}/objects/${objectName}`,
270
+ mockResponse
271
+ );
207
272
  }
208
273
 
209
- export function unsetMockFetchKVGetValues() {
210
- kvGetMocks.clear();
274
+ export function unsetSpecialMockFns() {
275
+ kvGetMocks.clear();
276
+ r2GetMocks.clear();
277
+ dashScriptMocks.clear();
211
278
  }
@@ -7,52 +7,56 @@ import { logger } from "../../logger";
7
7
  */
8
8
 
9
9
  let debugSpy: jest.SpyInstance,
10
- logSpy: jest.SpyInstance,
11
- errorSpy: jest.SpyInstance,
12
- warnSpy: jest.SpyInstance;
10
+ logSpy: jest.SpyInstance,
11
+ errorSpy: jest.SpyInstance,
12
+ warnSpy: jest.SpyInstance;
13
13
 
14
14
  const std = {
15
- get debug() {
16
- return normalizeOutput(debugSpy);
17
- },
18
- get out() {
19
- return normalizeOutput(logSpy);
20
- },
21
- get err() {
22
- return normalizeOutput(errorSpy);
23
- },
24
- get warn() {
25
- return normalizeOutput(warnSpy);
26
- },
15
+ get debug() {
16
+ return normalizeOutput(debugSpy);
17
+ },
18
+ get out() {
19
+ return normalizeOutput(logSpy);
20
+ },
21
+ get err() {
22
+ return normalizeOutput(errorSpy);
23
+ },
24
+ get warn() {
25
+ return normalizeOutput(warnSpy);
26
+ },
27
27
  };
28
28
 
29
29
  function normalizeOutput(spy: jest.SpyInstance): string {
30
- return normalizeErrorMarkers(
31
- stripTrailingWhitespace(normalizeSlashes(stripTimings(captureCalls(spy))))
32
- );
30
+ return normalizeErrorMarkers(
31
+ replaceByte(
32
+ stripTrailingWhitespace(
33
+ normalizeSlashes(normalizeTempDirs(stripTimings(captureCalls(spy))))
34
+ )
35
+ )
36
+ );
33
37
  }
34
38
 
35
39
  function captureCalls(spy: jest.SpyInstance): string {
36
- return spy.mock.calls
37
- .map((args: unknown[]) => util.format("%s", ...args))
38
- .join("\n");
40
+ return spy.mock.calls
41
+ .map((args: unknown[]) => util.format("%s", ...args))
42
+ .join("\n");
39
43
  }
40
44
 
41
45
  export function mockConsoleMethods() {
42
- beforeEach(() => {
43
- logger.columns = 100;
44
- debugSpy = jest.spyOn(console, "debug").mockImplementation();
45
- logSpy = jest.spyOn(console, "log").mockImplementation();
46
- errorSpy = jest.spyOn(console, "error").mockImplementation();
47
- warnSpy = jest.spyOn(console, "warn").mockImplementation();
48
- });
49
- afterEach(() => {
50
- debugSpy.mockRestore();
51
- logSpy.mockRestore();
52
- errorSpy.mockRestore();
53
- warnSpy.mockRestore();
54
- });
55
- return std;
46
+ beforeEach(() => {
47
+ logger.columns = 100;
48
+ debugSpy = jest.spyOn(console, "debug").mockImplementation();
49
+ logSpy = jest.spyOn(console, "log").mockImplementation();
50
+ errorSpy = jest.spyOn(console, "error").mockImplementation();
51
+ warnSpy = jest.spyOn(console, "warn").mockImplementation();
52
+ });
53
+ afterEach(() => {
54
+ debugSpy.mockRestore();
55
+ logSpy.mockRestore();
56
+ errorSpy.mockRestore();
57
+ warnSpy.mockRestore();
58
+ });
59
+ return std;
56
60
  }
57
61
 
58
62
  /**
@@ -61,7 +65,7 @@ export function mockConsoleMethods() {
61
65
  * Windows gets a different character.
62
66
  */
63
67
  function normalizeErrorMarkers(str: string): string {
64
- return str.replaceAll("✘", "X");
68
+ return str.replaceAll("✘", "X");
65
69
  }
66
70
 
67
71
  /**
@@ -70,7 +74,7 @@ function normalizeErrorMarkers(str: string): string {
70
74
  * Use this in snapshot tests to be resilient to file-system differences.
71
75
  */
72
76
  export function normalizeSlashes(str: string): string {
73
- return str.replace(/\\/g, "/");
77
+ return str.replace(/\\/g, "/");
74
78
  }
75
79
 
76
80
  /**
@@ -79,9 +83,24 @@ export function normalizeSlashes(str: string): string {
79
83
  * Use this in snapshot tests to be resilient to slight changes in timing of processing.
80
84
  */
81
85
  export function stripTimings(stdout: string): string {
82
- return stdout.replace(/\(\d+\.\d+ sec\)/g, "(TIMINGS)");
86
+ return stdout.replace(/\(\d+\.\d+ sec\)/g, "(TIMINGS)");
83
87
  }
84
88
 
85
89
  export function stripTrailingWhitespace(str: string): string {
86
- return str.replace(/[^\S\n]+\n/g, "\n");
90
+ return str.replace(/[^\S\n]+\n/g, "\n");
91
+ }
92
+
93
+ /**
94
+ * Removing leading kilobit (tenth of a byte) from test output due to
95
+ * variation causing every few tests the value to change by ± .01
96
+ */
97
+ function replaceByte(stdout: string): string {
98
+ return stdout.replaceAll(/\d+\.\d+ KiB/g, "xx KiB");
99
+ }
100
+
101
+ /**
102
+ * Temp directories are created with random names, so we replace all comments temp dirs in them
103
+ */
104
+ export function normalizeTempDirs(stdout: string): string {
105
+ return stdout.replaceAll(/\/\/.+\/tmp.+/g, "//tmpdir");
87
106
  }