wrangler 0.0.0-e7a0cd5b → 0.0.0-e7cf0caa

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 (237) hide show
  1. package/README.md +3 -3
  2. package/bin/wrangler.js +30 -10
  3. package/miniflare-dist/index.mjs +126 -74
  4. package/package.json +27 -19
  5. package/src/__tests__/api-dev.test.ts +65 -36
  6. package/src/__tests__/api-devregistry.test.ts +121 -0
  7. package/src/__tests__/api.test.ts +27 -5
  8. package/src/__tests__/configuration.test.ts +567 -86
  9. package/src/__tests__/d1/d1.test.ts +82 -0
  10. package/src/__tests__/d1/execute.test.ts +66 -0
  11. package/src/__tests__/d1/migrate.test.ts +157 -0
  12. package/src/__tests__/d1/splitter.test.ts +255 -0
  13. package/src/__tests__/delete.test.ts +91 -49
  14. package/src/__tests__/deployments.test.ts +330 -56
  15. package/src/__tests__/dev.test.tsx +198 -90
  16. package/src/__tests__/generate.test.ts +12 -10
  17. package/src/__tests__/guess-worker-format.test.ts +35 -0
  18. package/src/__tests__/helpers/end-event-loop.ts +6 -0
  19. package/src/__tests__/helpers/mock-auth-domain.ts +20 -0
  20. package/src/__tests__/helpers/mock-console.ts +6 -0
  21. package/src/__tests__/helpers/mock-dialogs.ts +71 -85
  22. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +25 -0
  23. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -5
  24. package/src/__tests__/helpers/mock-known-routes.ts +7 -2
  25. package/src/__tests__/helpers/mock-kv.ts +29 -16
  26. package/src/__tests__/helpers/mock-oauth-flow.ts +103 -92
  27. package/src/__tests__/helpers/mock-process.ts +8 -13
  28. package/src/__tests__/helpers/mock-set-timeout.ts +16 -0
  29. package/src/__tests__/helpers/msw/blob-worker.cjs +19 -0
  30. package/src/__tests__/helpers/msw/handlers/deployments.ts +128 -27
  31. package/src/__tests__/helpers/msw/handlers/namespaces.ts +18 -41
  32. package/src/__tests__/helpers/msw/handlers/oauth.ts +13 -18
  33. package/src/__tests__/helpers/msw/handlers/r2.ts +14 -34
  34. package/src/__tests__/helpers/msw/handlers/script.ts +9 -28
  35. package/src/__tests__/helpers/msw/handlers/user.ts +13 -24
  36. package/src/__tests__/helpers/msw/handlers/zones.ts +6 -8
  37. package/src/__tests__/helpers/msw/index.ts +32 -1
  38. package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
  39. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +28 -0
  40. package/src/__tests__/helpers/worker-scripts/parent-worker.js +4 -1
  41. package/src/__tests__/index.test.ts +90 -72
  42. package/src/__tests__/init.test.ts +927 -631
  43. package/src/__tests__/jest.setup.ts +19 -42
  44. package/src/__tests__/kv.test.ts +355 -231
  45. package/src/__tests__/logger.test.ts +68 -2
  46. package/src/__tests__/logout.test.ts +47 -0
  47. package/src/__tests__/metrics.test.ts +94 -51
  48. package/src/__tests__/middleware.scheduled.test.ts +42 -32
  49. package/src/__tests__/middleware.test.ts +212 -122
  50. package/src/__tests__/mtls-certificates.test.ts +588 -0
  51. package/src/__tests__/pages/deployment-list.test.ts +80 -0
  52. package/src/__tests__/pages/functions-build.test.ts +452 -0
  53. package/src/__tests__/pages/pages.test.ts +81 -0
  54. package/src/__tests__/pages/project-create.test.ts +63 -0
  55. package/src/__tests__/pages/project-list.test.ts +110 -0
  56. package/src/__tests__/pages/project-upload.test.ts +500 -0
  57. package/src/__tests__/pages/publish.test.ts +2864 -0
  58. package/src/__tests__/pages-deployment-tail.test.ts +955 -0
  59. package/src/__tests__/parse.test.ts +106 -0
  60. package/src/__tests__/publish.test.ts +1615 -852
  61. package/src/__tests__/pubsub.test.ts +226 -100
  62. package/src/__tests__/queues.test.ts +238 -77
  63. package/src/__tests__/r2.test.ts +55 -57
  64. package/src/__tests__/secret.test.ts +179 -130
  65. package/src/__tests__/tail.test.ts +267 -109
  66. package/src/__tests__/test-old-node-version.js +3 -3
  67. package/src/__tests__/traverse-module-graph.test.ts +220 -0
  68. package/src/__tests__/tsconfig-sanity.ts +12 -0
  69. package/src/__tests__/tsconfig.json +8 -0
  70. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  71. package/src/__tests__/type-generation.test.ts +43 -26
  72. package/src/__tests__/user.test.ts +35 -72
  73. package/src/__tests__/whoami.test.tsx +8 -114
  74. package/src/__tests__/worker-namespace.test.ts +83 -69
  75. package/src/api/dev.ts +168 -60
  76. package/src/api/index.ts +10 -1
  77. package/src/api/mtls-certificate.ts +148 -0
  78. package/src/api/pages/create-worker-bundle-contents.ts +76 -0
  79. package/src/api/pages/index.ts +5 -0
  80. package/src/api/pages/publish.tsx +355 -0
  81. package/src/bundle.ts +263 -140
  82. package/src/cfetch/index.ts +0 -2
  83. package/src/cfetch/internal.ts +16 -21
  84. package/src/cli.ts +4 -4
  85. package/src/config/config.ts +14 -7
  86. package/src/config/environment.ts +79 -24
  87. package/src/config/index.ts +99 -38
  88. package/src/config/validation-helpers.ts +1 -1
  89. package/src/config/validation.ts +248 -19
  90. package/src/create-worker-preview.ts +19 -8
  91. package/src/create-worker-upload-form.ts +60 -22
  92. package/src/d1/backups.tsx +43 -42
  93. package/src/d1/constants.ts +2 -0
  94. package/src/d1/create.tsx +44 -30
  95. package/src/d1/{delete.tsx → delete.ts} +11 -14
  96. package/src/d1/execute.tsx +209 -151
  97. package/src/d1/index.ts +31 -7
  98. package/src/d1/list.tsx +22 -10
  99. package/src/d1/migrations/apply.tsx +212 -0
  100. package/src/d1/migrations/create.tsx +79 -0
  101. package/src/d1/migrations/helpers.ts +172 -0
  102. package/src/d1/migrations/index.ts +3 -0
  103. package/src/d1/migrations/list.tsx +95 -0
  104. package/src/d1/migrations/options.ts +23 -0
  105. package/src/d1/options.ts +12 -2
  106. package/src/d1/splitter.ts +161 -0
  107. package/src/d1/{types.tsx → types.ts} +11 -0
  108. package/src/d1/utils.ts +12 -2
  109. package/src/delete.ts +8 -16
  110. package/src/deployments.ts +340 -46
  111. package/src/deprecated/index.ts +8 -302
  112. package/src/dev/dev.tsx +57 -44
  113. package/src/dev/local.tsx +294 -91
  114. package/src/dev/remote.tsx +32 -3
  115. package/src/dev/start-server.ts +89 -68
  116. package/src/dev/use-esbuild.ts +17 -18
  117. package/src/dev/validate-dev-props.ts +9 -0
  118. package/src/{dev-registry.tsx → dev-registry.ts} +2 -1
  119. package/src/dev.tsx +178 -118
  120. package/src/dialogs.ts +136 -0
  121. package/src/dispatch-namespace.ts +21 -17
  122. package/src/docs/index.ts +97 -0
  123. package/src/entry.ts +19 -11
  124. package/src/environment-variables/factory.ts +88 -0
  125. package/src/environment-variables/misc-variables.ts +30 -0
  126. package/src/generate/index.ts +298 -0
  127. package/src/git-client.ts +15 -4
  128. package/src/{index.tsx → index.ts} +137 -63
  129. package/src/init.ts +249 -187
  130. package/src/inspect.ts +16 -1
  131. package/src/jest.d.ts +4 -0
  132. package/src/kv/index.ts +15 -17
  133. package/src/logger.ts +32 -5
  134. package/src/metrics/metrics-config.ts +3 -3
  135. package/src/metrics/send-event.ts +6 -1
  136. package/src/miniflare-cli/assets.ts +64 -28
  137. package/src/miniflare-cli/index.ts +4 -7
  138. package/src/miniflare-cli/tsconfig.json +9 -0
  139. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  140. package/src/miniflare-cli/types.ts +11 -0
  141. package/src/module-collection.ts +91 -25
  142. package/src/mtls-certificate/cli.ts +155 -0
  143. package/src/pages/build.ts +410 -0
  144. package/src/pages/buildFunctions.ts +140 -0
  145. package/src/pages/deployment-tails.ts +281 -0
  146. package/src/pages/deployments.tsx +11 -33
  147. package/src/pages/{dev.tsx → dev.ts} +147 -124
  148. package/src/pages/errors.ts +1 -0
  149. package/src/pages/functions/buildPlugin.ts +72 -69
  150. package/src/pages/functions/buildWorker.ts +249 -114
  151. package/src/pages/functions/tsconfig.json +8 -0
  152. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  153. package/src/pages/{functions.tsx → functions.ts} +8 -4
  154. package/src/pages/{index.tsx → index.ts} +11 -3
  155. package/src/pages/projects.tsx +12 -22
  156. package/src/pages/prompt-select-project.tsx +31 -0
  157. package/src/pages/publish.tsx +45 -214
  158. package/src/pages/types.ts +6 -9
  159. package/src/pages/upload.tsx +58 -14
  160. package/src/pages/utils.ts +14 -3
  161. package/src/parse.ts +23 -1
  162. package/src/paths.ts +1 -1
  163. package/src/proxy.ts +5 -0
  164. package/src/publish/index.ts +20 -16
  165. package/src/publish/publish.ts +72 -47
  166. package/src/pubsub/{pubsub-commands.tsx → pubsub-commands.ts} +19 -20
  167. package/src/queues/cli/commands/consumer/add.ts +24 -24
  168. package/src/queues/cli/commands/consumer/index.ts +3 -6
  169. package/src/queues/cli/commands/consumer/remove.ts +11 -18
  170. package/src/queues/cli/commands/create.ts +8 -8
  171. package/src/queues/cli/commands/delete.ts +8 -8
  172. package/src/queues/cli/commands/index.ts +6 -4
  173. package/src/queues/cli/commands/list.ts +8 -8
  174. package/src/queues/client.ts +1 -0
  175. package/src/queues/utils.ts +18 -0
  176. package/src/r2/constants.ts +4 -0
  177. package/src/r2/helpers.ts +1 -0
  178. package/src/r2/index.ts +40 -28
  179. package/src/secret/index.ts +14 -17
  180. package/src/{sites.tsx → sites.ts} +1 -1
  181. package/src/tail/createTail.ts +94 -3
  182. package/src/tail/filters.ts +1 -1
  183. package/src/tail/index.ts +8 -11
  184. package/src/tail/printing.ts +15 -0
  185. package/src/traverse-module-graph.ts +53 -0
  186. package/src/tsconfig-sanity.ts +16 -0
  187. package/src/type-generation.ts +79 -57
  188. package/src/user/access.ts +0 -1
  189. package/src/user/auth-variables.ts +113 -0
  190. package/src/user/choose-account.tsx +1 -31
  191. package/src/user/index.ts +0 -1
  192. package/src/user/{user.tsx → user.ts} +123 -82
  193. package/src/utils/render.ts +93 -0
  194. package/src/{whoami.tsx → whoami.ts} +37 -71
  195. package/src/worker.ts +35 -3
  196. package/src/yargs-types.ts +22 -5
  197. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  198. package/templates/__tests__/tsconfig.json +8 -0
  199. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  200. package/templates/checked-fetch.js +9 -3
  201. package/templates/d1-beta-facade.js +95 -25
  202. package/templates/facade.d.ts +14 -0
  203. package/templates/first-party-worker-module-facade.ts +4 -3
  204. package/templates/format-dev-errors.ts +8 -6
  205. package/templates/gitignore +1 -0
  206. package/templates/init-tests/test-jest-new-worker.js +3 -5
  207. package/templates/init-tests/test-vitest-new-worker.js +3 -5
  208. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  209. package/templates/middleware/loader-modules.ts +2 -2
  210. package/templates/middleware/loader-sw.ts +51 -31
  211. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  212. package/templates/new-worker.ts +3 -0
  213. package/templates/pages-dev-pipeline.ts +4 -1
  214. package/templates/pages-shim.ts +4 -1
  215. package/templates/pages-template-plugin.ts +19 -10
  216. package/templates/serve-static-assets.ts +17 -14
  217. package/templates/service-bindings-module-facade.js +1 -0
  218. package/templates/tsconfig-sanity.ts +11 -0
  219. package/templates/tsconfig.init.json +105 -0
  220. package/templates/tsconfig.json +5 -103
  221. package/templates/tsconfig.tsbuildinfo +1 -0
  222. package/wrangler-dist/cli.d.ts +826 -77
  223. package/wrangler-dist/cli.js +130734 -140838
  224. package/wrangler-dist/wasm-sync.wasm +0 -0
  225. package/src/__tests__/api-devregistry.test.js +0 -57
  226. package/src/__tests__/d1.test.ts +0 -72
  227. package/src/__tests__/dialogs.test.tsx +0 -40
  228. package/src/__tests__/helpers/mock-cfetch.ts +0 -333
  229. package/src/__tests__/pages.test.ts +0 -2223
  230. package/src/dialogs.tsx +0 -163
  231. package/src/environment-variables.ts +0 -50
  232. package/src/pages/build.tsx +0 -238
  233. package/src/user/env-vars.ts +0 -46
  234. package/templates/experimental-local-cache-stubs.js +0 -27
  235. /package/src/{bundle-reporter.tsx → bundle-reporter.ts} +0 -0
  236. /package/src/dev/{get-local-persistence-path.tsx → get-local-persistence-path.ts} +0 -0
  237. /package/src/pages/{hash.tsx → hash.ts} +0 -0
Binary file
@@ -1,57 +0,0 @@
1
- import { unstable_dev } from "../api";
2
- import { fetch } from "undici";
3
-
4
- jest.unmock("undici");
5
-
6
- //TODO Fix Tests extremely flakey
7
- /**
8
- * a huge caveat to how testing multi-worker scripts works:
9
- * you can't shutdown the first worker you spun up, or it'll kill the devRegistry
10
- */
11
- describe.skip("multi-worker testing", () => {
12
- let childWorker;
13
- let parentWorker;
14
-
15
- beforeAll(async () => {
16
- childWorker = await unstable_dev(
17
- "src/__tests__/helpers/worker-scripts/hello-world-worker.js",
18
- { config: "src/__tests__/helpers/worker-scripts/child-wrangler.toml" },
19
- { disableExperimentalWarning: true }
20
- );
21
- parentWorker = await unstable_dev(
22
- "src/__tests__/helpers/worker-scripts/parent-worker.js",
23
- { config: "src/__tests__/helpers/worker-scripts/parent-wrangler.toml" },
24
- { disableExperimentalWarning: true }
25
- );
26
- });
27
-
28
- afterAll(async () => {
29
- await childWorker.stop();
30
- await parentWorker.stop();
31
- });
32
-
33
- it("parentWorker and childWorker should be added devRegistry", async () => {
34
- const resp = await fetch("http://localhost:6284/workers");
35
- if (resp) {
36
- const parsedResp = await resp.json();
37
- expect(parsedResp.parent).toBeTruthy();
38
- expect(parsedResp.child).toBeTruthy();
39
- }
40
- });
41
-
42
- it("childWorker should return Hello World itself", async () => {
43
- const resp = await childWorker.fetch();
44
- if (resp) {
45
- const text = await resp.text();
46
- expect(text).toMatchInlineSnapshot(`"Hello World!"`);
47
- }
48
- });
49
-
50
- it("parentWorker should return Hello World by invoking the child worker", async () => {
51
- const resp = await parentWorker.fetch();
52
- if (resp) {
53
- const parsedResp = await resp.text();
54
- expect(parsedResp).toEqual("Parent worker sees: Hello World!");
55
- }
56
- });
57
- });
@@ -1,72 +0,0 @@
1
- import { mockAccountId } from "./helpers/mock-account-id";
2
- import { mockConsoleMethods } from "./helpers/mock-console";
3
- import { runWrangler } from "./helpers/run-wrangler";
4
-
5
- function endEventLoop() {
6
- return new Promise((resolve) => setImmediate(resolve));
7
- }
8
-
9
- describe("d1", () => {
10
- const std = mockConsoleMethods();
11
-
12
- mockAccountId();
13
-
14
- it("should show help when no argument is passed", async () => {
15
- await runWrangler("d1");
16
- await endEventLoop();
17
-
18
- expect(std.out).toMatchInlineSnapshot(`
19
- "wrangler d1
20
-
21
- 🗄 Interact with a D1 database
22
-
23
- Commands:
24
- wrangler d1 list List D1 databases
25
- wrangler d1 create <name> Create D1 database
26
- wrangler d1 delete <name> Delete D1 database
27
- wrangler d1 backup Interact with D1 Backups
28
- wrangler d1 execute <name> Executed command or SQL file
29
-
30
- Flags:
31
- -c, --config Path to .toml configuration file [string]
32
- -e, --env Environment to use for operations and .env files [string]
33
- -h, --help Show help [boolean]
34
- -v, --version Show version number [boolean]
35
-
36
- 🚧 'wrangler d1 <command>' is a beta command. Please report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose"
37
- `);
38
- });
39
-
40
- it("should show help when an invalid argument is passed", async () => {
41
- await expect(() => runWrangler("d1 asdf")).rejects.toThrow(
42
- "Unknown argument: asdf"
43
- );
44
-
45
- expect(std.err).toMatchInlineSnapshot(`
46
- "X [ERROR] Unknown argument: asdf
47
-
48
- "
49
- `);
50
- expect(std.out).toMatchInlineSnapshot(`
51
- "
52
- wrangler d1
53
-
54
- 🗄 Interact with a D1 database
55
-
56
- Commands:
57
- wrangler d1 list List D1 databases
58
- wrangler d1 create <name> Create D1 database
59
- wrangler d1 delete <name> Delete D1 database
60
- wrangler d1 backup Interact with D1 Backups
61
- wrangler d1 execute <name> Executed command or SQL file
62
-
63
- Flags:
64
- -c, --config Path to .toml configuration file [string]
65
- -e, --env Environment to use for operations and .env files [string]
66
- -h, --help Show help [boolean]
67
- -v, --version Show version number [boolean]
68
-
69
- 🚧 'wrangler d1 <command>' is a beta command. Please report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose"
70
- `);
71
- });
72
- });
@@ -1,40 +0,0 @@
1
- jest.unmock("../dialogs");
2
- import { fromDashMessagePrompt } from "../dialogs";
3
- import { CI } from "../is-ci";
4
-
5
- describe("fromDashMessagePrompt", () => {
6
- it("should return undefined in CI when last deployed from api", async () => {
7
- //in CI
8
- jest.spyOn(CI, "isCI").mockReturnValue(true);
9
- const result = await fromDashMessagePrompt("api");
10
- expect(result).toBe(undefined);
11
- });
12
-
13
- it("should return undefined in CI when last deployed from wrangler", async () => {
14
- //in CI
15
- jest.spyOn(CI, "isCI").mockReturnValue(true);
16
- const result = await fromDashMessagePrompt("wrangler");
17
- expect(result).toBe(undefined);
18
- });
19
-
20
- it("should return true in CI when last deployed from dash", async () => {
21
- //in CI
22
- jest.spyOn(CI, "isCI").mockReturnValue(true);
23
- const result = await fromDashMessagePrompt("dash");
24
- expect(result).toBe(true);
25
- });
26
-
27
- it("should return undefined when last deployed from api", async () => {
28
- //not in CI
29
- jest.spyOn(CI, "isCI").mockReturnValue(false);
30
- const result = await fromDashMessagePrompt("api");
31
- expect(result).toBe(undefined);
32
- });
33
-
34
- it("should return undefined when last deployed from wrangler", async () => {
35
- //not in CI
36
- jest.spyOn(CI, "isCI").mockReturnValue(false);
37
- const result = await fromDashMessagePrompt("wrangler");
38
- expect(result).toBe(undefined);
39
- });
40
- });
@@ -1,333 +0,0 @@
1
- import { Readable } from "node:stream";
2
- import { URL, URLSearchParams } from "node:url";
3
- import { pathToRegexp } from "path-to-regexp";
4
- import { Response } from "undici";
5
- import { getCloudflareApiBaseUrl } from "../../cfetch";
6
- import type { FetchResult, FetchError } from "../../cfetch";
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
- );
34
-
35
- /**
36
- * The signature of the function that will handle a mock request.
37
- */
38
- export type MockHandler<ResponseType> = (
39
- uri: RegExpExecArray,
40
- init: RequestInit,
41
- queryParams: URLSearchParams
42
- ) => ResponseType | Promise<ResponseType>;
43
-
44
- type RemoveMockFn = () => void;
45
-
46
- interface MockFetch<ResponseType> {
47
- regexp: RegExp;
48
- method: string | undefined;
49
- handler: MockHandler<ResponseType>;
50
- }
51
- const mocks: MockFetch<unknown>[] = [];
52
-
53
- /**
54
- * The mock implementation of `cfApi.fetch()`.
55
- *
56
- * This function will attempt to match the given request to one of the mock handlers configured by calls to `setMock`.
57
- *
58
- * Once found the handler will be used to generate a mock response.
59
- */
60
- export async function mockFetchInternal(
61
- resource: string,
62
- init: RequestInit = {},
63
- queryParams: URLSearchParams | undefined
64
- ) {
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);
79
- }
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
-
88
- /**
89
- * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
90
- *
91
- * @param resource The path of the resource to be matched.
92
- * This can include wildcards whose value will be passed to the `handler`.
93
- * @param handler The function that will generate the mock response for this request.
94
- */
95
- export function setMockRawResponse<ResponseType>(
96
- resource: string,
97
- handler: MockHandler<ResponseType>
98
- ): RemoveMockFn;
99
- /**
100
- * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
101
- *
102
- * @param resource The path of the resource to be matched.
103
- * This can include wildcards whose value will be passed to the `handler`.
104
- * @param method The HTTP method (e.g. GET, POST, etc) that the request must have to match this mock handler.
105
- * @param handler The function that will generate the mock response for this request.
106
- */
107
- export function setMockRawResponse<ResponseType>(
108
- resource: string,
109
- method: string,
110
- handler: MockHandler<ResponseType>
111
- ): RemoveMockFn;
112
- /**
113
- * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
114
- */
115
- export function setMockRawResponse<ResponseType>(
116
- resource: string,
117
- ...args: [string, MockHandler<ResponseType>] | [MockHandler<ResponseType>]
118
- ): RemoveMockFn {
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
- };
134
- }
135
-
136
- /**
137
- * Specify an expected resource path that is to be handled, resulting in a `FetchRequest`.
138
- *
139
- * The mock `handler` should return the `result`, which will then be wrapped in a `FetchRequest` object.
140
- *
141
- * @param resource The path of the resource to be matched.
142
- * This can include wildcards whose value will be passed to the `handler`.
143
- * @param handler The function that will generate the mock response for this request.
144
- */
145
- export function setMockResponse<ResponseType>(
146
- resource: string,
147
- handler: MockHandler<ResponseType>
148
- ): RemoveMockFn;
149
- /**
150
- * Specify an expected resource path that is to be handled, resulting in a FetchRequest..
151
- *
152
- * @param resource The path of the resource to be matched.
153
- * This can include wildcards whose value will be passed to the `handler`.
154
- * @param method The HTTP method (e.g. GET, POST, etc) that the request must have to match this mock handler.
155
- * @param handler The function that will generate the mock response for this request.
156
- */
157
- export function setMockResponse<ResponseType>(
158
- resource: string,
159
- method: string,
160
- handler: MockHandler<ResponseType>
161
- ): RemoveMockFn;
162
- /**
163
- * Specify an expected resource path that is to be handled, resulting in a FetchRequest.
164
- */
165
- export function setMockResponse<ResponseType>(
166
- resource: string,
167
- ...args: [string, MockHandler<ResponseType>] | [MockHandler<ResponseType>]
168
- ): RemoveMockFn {
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
- );
174
- }
175
-
176
- /**
177
- * A helper to make it easier to create `FetchResult` objects in tests.
178
- */
179
- export async function createFetchResult<ResponseType>(
180
- result: ResponseType | Promise<ResponseType>,
181
- success = true,
182
- errors: FetchError[] = [],
183
- messages: string[] = [],
184
- result_info?: unknown
185
- ): Promise<FetchResult<ResponseType>> {
186
- return result_info
187
- ? {
188
- result: await result,
189
- success,
190
- errors,
191
- messages,
192
- result_info,
193
- }
194
- : {
195
- result: await result,
196
- success,
197
- errors,
198
- messages,
199
- };
200
- }
201
-
202
- /**
203
- * Remove all the configured mock handlers.
204
- *
205
- * This should be called in an `afterEach()` block to ensure that mock handlers do not leak between tests.
206
- */
207
- export function unsetAllMocks() {
208
- mocks.length = 0;
209
- }
210
-
211
- /**
212
- * We special-case fetching the request for `kv:key get`, because it's
213
- * the only cloudflare API endpoint that returns a plain string as the
214
- * value, and not as the "standard" FetchResult-style json. Hence, we also
215
- * special-case mocking it here.
216
- */
217
-
218
- const kvGetMocks = new Map<string, string | Buffer>();
219
- const r2GetMocks = new Map<string, string | undefined>();
220
- const dashScriptMocks = new Map<string, string | undefined>();
221
-
222
- /**
223
- * @mocked typeof fetchKVGetValue
224
- */
225
- export function mockFetchKVGetValue(
226
- accountId: string,
227
- namespaceId: string,
228
- key: string
229
- ) {
230
- const mapKey = `${accountId}/${namespaceId}/${key}`;
231
- if (kvGetMocks.has(mapKey)) {
232
- const value = kvGetMocks.get(mapKey);
233
- if (value !== undefined) return Promise.resolve(value);
234
- }
235
- throw new Error(`no mock value found for \`kv:key get\` - ${mapKey}`);
236
- }
237
-
238
- export function setMockFetchKVGetValue(
239
- accountId: string,
240
- namespaceId: string,
241
- key: string,
242
- value: string | Buffer
243
- ) {
244
- kvGetMocks.set(`${accountId}/${namespaceId}/${key}`, value);
245
- }
246
-
247
- /**
248
- * @mocked typeof fetchR2Objects
249
- */
250
- export async function mockFetchR2Objects(
251
- resource: string,
252
- bodyInit: {
253
- body: BodyInit | Readable;
254
- headers: HeadersInit | undefined;
255
- method: "PUT" | "GET" | "DELETE";
256
- }
257
- ): Promise<Response> {
258
- if (r2GetMocks.has(resource)) {
259
- /**
260
- * Here we destroy & removeListeners to "drain" the stream, for testing purposes
261
- * mimicking the fetch request taking in the stream and draining it.
262
- */
263
- if (bodyInit.body instanceof Readable) {
264
- bodyInit.body.destroy();
265
- bodyInit.body.removeAllListeners();
266
- }
267
-
268
- const value = r2GetMocks.get(resource);
269
-
270
- return new Response(value);
271
- }
272
-
273
- // No mocks found for ${init.method ?? "any HTTP"} request to ${resource}
274
- // let it fall through to Mock Service Worker with a real fetch.
275
- return await realFetchR2Objects(resource, bodyInit);
276
- }
277
-
278
- /**
279
- * Mock setter for usage within test blocks, companion helper to `mockFetchR2Objects`
280
- */
281
- export function setMockFetchR2Objects({
282
- accountId,
283
- bucketName,
284
- objectName,
285
- mockResponse,
286
- }: {
287
- accountId: string;
288
- bucketName: string;
289
- objectName: string;
290
- mockResponse?: string;
291
- }) {
292
- r2GetMocks.set(
293
- `/accounts/${accountId}/r2/buckets/${bucketName}/objects/${objectName}`,
294
- mockResponse
295
- );
296
- }
297
-
298
- export function unsetSpecialMockFns() {
299
- kvGetMocks.clear();
300
- r2GetMocks.clear();
301
- dashScriptMocks.clear();
302
- }
303
-
304
- /**
305
- * @mocked typeof fetchDashScript
306
- * multipart/form-data is the response for modules and raw text for the Script endpoint.
307
- */
308
- export async function mockFetchDashScript(resource: string): Promise<string> {
309
- if (dashScriptMocks.has(resource)) {
310
- return dashScriptMocks.get(resource) ?? "";
311
- }
312
- throw new Error(`no mock found for \`init from-dash\` - ${resource}`);
313
- }
314
-
315
- /**
316
- * Mock setter for usage within test blocks, companion helper to `mockFetchDashScript`
317
- */
318
- export function setMockFetchDashScript({
319
- accountId,
320
- fromDashScriptName,
321
- environment,
322
- mockResponse,
323
- }: {
324
- accountId: string;
325
- fromDashScriptName: string;
326
- environment: string;
327
- mockResponse?: string;
328
- }) {
329
- dashScriptMocks.set(
330
- `/accounts/${accountId}/workers/services/${fromDashScriptName}/environments/${environment}/content`,
331
- mockResponse
332
- );
333
- }