wrangler 0.0.0-ea8f8d7 → 0.0.0-eab9542

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 (183) hide show
  1. package/README.md +7 -1
  2. package/bin/wrangler.js +114 -57
  3. package/kv-asset-handler.js +1 -0
  4. package/miniflare-dist/index.mjs +10 -2
  5. package/package.json +156 -152
  6. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  7. package/src/__tests__/config-cache.test.ts +30 -24
  8. package/src/__tests__/configuration.test.ts +3935 -3321
  9. package/src/__tests__/dev.test.tsx +1131 -871
  10. package/src/__tests__/guess-worker-format.test.ts +68 -68
  11. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  12. package/src/__tests__/helpers/faye-websocket.d.ts +4 -4
  13. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  14. package/src/__tests__/helpers/mock-bin.ts +20 -20
  15. package/src/__tests__/helpers/mock-cfetch.ts +92 -92
  16. package/src/__tests__/helpers/mock-console.ts +49 -39
  17. package/src/__tests__/helpers/mock-dialogs.ts +114 -51
  18. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  19. package/src/__tests__/helpers/mock-istty.ts +65 -18
  20. package/src/__tests__/helpers/mock-kv.ts +26 -26
  21. package/src/__tests__/helpers/mock-oauth-flow.ts +223 -228
  22. package/src/__tests__/helpers/mock-process.ts +39 -0
  23. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  24. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  25. package/src/__tests__/helpers/run-in-tmp.ts +27 -27
  26. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  27. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  28. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  29. package/src/__tests__/https-options.test.ts +104 -104
  30. package/src/__tests__/index.test.ts +239 -233
  31. package/src/__tests__/init.test.ts +1607 -1172
  32. package/src/__tests__/jest.setup.ts +63 -33
  33. package/src/__tests__/kv.test.ts +1136 -998
  34. package/src/__tests__/logger.test.ts +100 -74
  35. package/src/__tests__/package-manager.test.ts +312 -165
  36. package/src/__tests__/pages.test.ts +1177 -580
  37. package/src/__tests__/parse.test.ts +252 -252
  38. package/src/__tests__/publish.test.ts +6400 -5299
  39. package/src/__tests__/pubsub.test.ts +367 -0
  40. package/src/__tests__/r2.test.ts +133 -133
  41. package/src/__tests__/route.test.ts +18 -18
  42. package/src/__tests__/secret.test.ts +386 -381
  43. package/src/__tests__/tail.test.ts +530 -530
  44. package/src/__tests__/user.test.ts +123 -111
  45. package/src/__tests__/whoami.test.tsx +198 -83
  46. package/src/__tests__/worker-namespace.test.ts +327 -0
  47. package/src/abort.d.ts +1 -1
  48. package/src/api/dev.ts +52 -0
  49. package/src/api/index.ts +1 -0
  50. package/src/bundle-reporter.tsx +29 -0
  51. package/src/bundle.ts +158 -146
  52. package/src/cfetch/index.ts +80 -80
  53. package/src/cfetch/internal.ts +96 -86
  54. package/src/cli.ts +21 -7
  55. package/src/config/config.ts +204 -195
  56. package/src/config/diagnostics.ts +61 -61
  57. package/src/config/environment.ts +390 -357
  58. package/src/config/index.ts +206 -193
  59. package/src/config/validation-helpers.ts +366 -357
  60. package/src/config/validation.ts +1573 -1358
  61. package/src/config-cache.ts +79 -41
  62. package/src/create-worker-preview.ts +206 -136
  63. package/src/create-worker-upload-form.ts +247 -238
  64. package/src/dev/dev-vars.ts +13 -13
  65. package/src/dev/dev.tsx +333 -338
  66. package/src/dev/local.tsx +308 -274
  67. package/src/dev/remote.tsx +366 -211
  68. package/src/dev/use-esbuild.ts +126 -94
  69. package/src/dev.tsx +538 -0
  70. package/src/dialogs.tsx +111 -63
  71. package/src/durable.ts +87 -87
  72. package/src/entry.ts +234 -228
  73. package/src/environment-variables.ts +23 -23
  74. package/src/errors.ts +6 -6
  75. package/src/generate.ts +33 -0
  76. package/src/git-client.ts +42 -0
  77. package/src/https-options.ts +79 -79
  78. package/src/index.tsx +1773 -2691
  79. package/src/init.ts +549 -0
  80. package/src/inspect.ts +593 -593
  81. package/src/intl-polyfill.d.ts +123 -123
  82. package/src/is-interactive.ts +12 -0
  83. package/src/kv.ts +277 -277
  84. package/src/logger.ts +46 -39
  85. package/src/miniflare-cli/enum-keys.ts +8 -8
  86. package/src/miniflare-cli/index.ts +43 -31
  87. package/src/miniflare-cli/request-context.ts +18 -18
  88. package/src/module-collection.ts +212 -212
  89. package/src/open-in-browser.ts +4 -6
  90. package/src/package-manager.ts +133 -86
  91. package/src/pages/build.tsx +202 -0
  92. package/src/pages/constants.ts +7 -0
  93. package/src/pages/deployments.tsx +101 -0
  94. package/src/pages/dev.tsx +964 -0
  95. package/src/pages/functions/buildPlugin.ts +105 -0
  96. package/src/pages/functions/buildWorker.ts +151 -0
  97. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  98. package/src/pages/functions/filepath-routing.ts +189 -0
  99. package/src/pages/functions/identifiers.ts +78 -0
  100. package/src/pages/functions/routes.ts +151 -0
  101. package/src/pages/index.tsx +84 -0
  102. package/src/pages/projects.tsx +157 -0
  103. package/src/pages/publish.tsx +335 -0
  104. package/src/pages/types.ts +40 -0
  105. package/src/pages/upload.tsx +384 -0
  106. package/src/pages/utils.ts +12 -0
  107. package/src/parse.ts +209 -125
  108. package/src/paths.ts +6 -6
  109. package/src/preview.ts +31 -0
  110. package/src/proxy.ts +400 -389
  111. package/src/publish.ts +689 -505
  112. package/src/pubsub/index.ts +286 -0
  113. package/src/pubsub/pubsub-commands.tsx +577 -0
  114. package/src/r2.ts +19 -19
  115. package/src/selfsigned.d.ts +23 -23
  116. package/src/sites.tsx +278 -201
  117. package/src/tail/filters.ts +108 -108
  118. package/src/tail/index.ts +217 -217
  119. package/src/tail/printing.ts +45 -45
  120. package/src/update-check.ts +11 -11
  121. package/src/user/choose-account.tsx +60 -0
  122. package/src/user/env-vars.ts +46 -0
  123. package/src/user/generate-auth-url.ts +33 -0
  124. package/src/user/generate-random-state.ts +16 -0
  125. package/src/user/index.ts +3 -0
  126. package/src/user/user.tsx +1161 -0
  127. package/src/whoami.tsx +61 -41
  128. package/src/worker-namespace.ts +190 -0
  129. package/src/worker.ts +110 -99
  130. package/src/zones.ts +76 -0
  131. package/templates/checked-fetch.js +17 -0
  132. package/templates/new-worker-scheduled.js +17 -0
  133. package/templates/new-worker-scheduled.ts +32 -0
  134. package/templates/new-worker.js +3 -3
  135. package/templates/new-worker.ts +15 -15
  136. package/templates/no-op-worker.js +10 -0
  137. package/templates/pages-template-plugin.ts +155 -0
  138. package/templates/pages-template-worker.ts +161 -0
  139. package/templates/static-asset-facade.js +32 -36
  140. package/templates/tsconfig.json +95 -95
  141. package/wrangler-dist/cli.js +39087 -37488
  142. package/pages/functions/buildPlugin.ts +0 -105
  143. package/pages/functions/buildWorker.ts +0 -151
  144. package/pages/functions/filepath-routing.ts +0 -189
  145. package/pages/functions/identifiers.ts +0 -78
  146. package/pages/functions/routes.ts +0 -156
  147. package/pages/functions/template-plugin.ts +0 -147
  148. package/pages/functions/template-worker.ts +0 -143
  149. package/src/pages.tsx +0 -2024
  150. package/src/user.tsx +0 -1203
  151. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  152. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  153. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  154. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  155. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  156. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  157. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  158. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  159. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  160. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  161. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  162. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  163. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  164. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  165. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  166. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  167. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  168. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  169. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  170. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  171. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  172. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  173. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  174. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  175. package/vendor/wrangler-mime/LICENSE +0 -21
  176. package/vendor/wrangler-mime/Mime.js +0 -97
  177. package/vendor/wrangler-mime/README.md +0 -187
  178. package/vendor/wrangler-mime/cli.js +0 -46
  179. package/vendor/wrangler-mime/index.js +0 -4
  180. package/vendor/wrangler-mime/lite.js +0 -4
  181. package/vendor/wrangler-mime/package.json +0 -52
  182. package/vendor/wrangler-mime/types/other.js +0 -1
  183. package/vendor/wrangler-mime/types/standard.js +0 -1
@@ -5,81 +5,81 @@ import { mockConsoleMethods } from "./helpers/mock-console";
5
5
  import { runInTempDir } from "./helpers/run-in-tmp";
6
6
 
7
7
  describe("guess worker format", () => {
8
- runInTempDir();
9
- const std = mockConsoleMethods();
10
- it('should detect a "modules" worker', async () => {
11
- await writeFile("./index.ts", "export default {};");
12
- // Note that this isn't actually a valid worker, because it's missing
13
- // a fetch handler. Regardless, our heuristic is simply to check for exports.
14
- const guess = await guessWorkerFormat(
15
- path.join(process.cwd(), "./index.ts"),
16
- process.cwd(),
17
- undefined
18
- );
19
- expect(guess).toBe("modules");
20
- });
8
+ runInTempDir();
9
+ const std = mockConsoleMethods();
10
+ it('should detect a "modules" worker', async () => {
11
+ await writeFile("./index.ts", "export default {};");
12
+ // Note that this isn't actually a valid worker, because it's missing
13
+ // a fetch handler. Regardless, our heuristic is simply to check for exports.
14
+ const guess = await guessWorkerFormat(
15
+ path.join(process.cwd(), "./index.ts"),
16
+ process.cwd(),
17
+ undefined
18
+ );
19
+ expect(guess).toBe("modules");
20
+ });
21
21
 
22
- it('should detect a "service-worker" worker', async () => {
23
- await writeFile("./index.ts", "");
24
- // Note that this isn't actually a valid worker, because it's missing
25
- // a fetch listener. Regardless, our heuristic is simply to check for
26
- // the lack of exports.
27
- const guess = await guessWorkerFormat(
28
- path.join(process.cwd(), "./index.ts"),
29
- process.cwd(),
30
- undefined
31
- );
32
- expect(guess).toBe("service-worker");
33
- });
22
+ it('should detect a "service-worker" worker', async () => {
23
+ await writeFile("./index.ts", "");
24
+ // Note that this isn't actually a valid worker, because it's missing
25
+ // a fetch listener. Regardless, our heuristic is simply to check for
26
+ // the lack of exports.
27
+ const guess = await guessWorkerFormat(
28
+ path.join(process.cwd(), "./index.ts"),
29
+ process.cwd(),
30
+ undefined
31
+ );
32
+ expect(guess).toBe("service-worker");
33
+ });
34
34
 
35
- it("should throw an error when the hint doesn't match the guess (modules - service-worker)", async () => {
36
- await writeFile("./index.ts", "export default {};");
37
- await expect(
38
- guessWorkerFormat(
39
- path.join(process.cwd(), "./index.ts"),
40
- process.cwd(),
41
- "service-worker"
42
- )
43
- ).rejects.toThrow(
44
- "You configured this worker to be a 'service-worker', but the file you are trying to build appears to have a `default` export like a module worker. Please pass `--format modules`, or simply remove the configuration."
45
- );
46
- });
35
+ it("should throw an error when the hint doesn't match the guess (modules - service-worker)", async () => {
36
+ await writeFile("./index.ts", "export default {};");
37
+ await expect(
38
+ guessWorkerFormat(
39
+ path.join(process.cwd(), "./index.ts"),
40
+ process.cwd(),
41
+ "service-worker"
42
+ )
43
+ ).rejects.toThrow(
44
+ "You configured this worker to be a 'service-worker', but the file you are trying to build appears to have a `default` export like a module worker. Please pass `--format modules`, or simply remove the configuration."
45
+ );
46
+ });
47
47
 
48
- it("should throw an error when the hint doesn't match the guess (service-worker - modules)", async () => {
49
- await writeFile("./index.ts", "");
50
- await expect(
51
- guessWorkerFormat(
52
- path.join(process.cwd(), "./index.ts"),
53
- process.cwd(),
54
- "modules"
55
- )
56
- ).rejects.toThrow(
57
- "You configured this worker to be 'modules', but the file you are trying to build doesn't export a handler. Please pass `--format service-worker`, or simply remove the configuration."
58
- );
59
- });
48
+ it("should throw an error when the hint doesn't match the guess (service-worker - modules)", async () => {
49
+ await writeFile("./index.ts", "");
50
+ await expect(
51
+ guessWorkerFormat(
52
+ path.join(process.cwd(), "./index.ts"),
53
+ process.cwd(),
54
+ "modules"
55
+ )
56
+ ).rejects.toThrow(
57
+ "You configured this worker to be 'modules', but the file you are trying to build doesn't export a handler. Please pass `--format service-worker`, or simply remove the configuration."
58
+ );
59
+ });
60
60
 
61
- it("should not error if a .js entry point has jsx", async () => {
62
- await writeFile("./index.js", "console.log(<div/>)");
63
- const guess = await guessWorkerFormat(
64
- path.join(process.cwd(), "./index.js"),
65
- process.cwd(),
66
- undefined
67
- );
68
- expect(guess).toBe("service-worker");
69
- });
61
+ it("should not error if a .js entry point has jsx", async () => {
62
+ await writeFile("./index.js", "console.log(<div/>)");
63
+ const guess = await guessWorkerFormat(
64
+ path.join(process.cwd(), "./index.js"),
65
+ process.cwd(),
66
+ undefined
67
+ );
68
+ expect(guess).toBe("service-worker");
69
+ });
70
70
 
71
- it("logs a warning when a worker has exports, but not a default one", async () => {
72
- await writeFile("./index.ts", "export const foo = 1;");
73
- const guess = await guessWorkerFormat(
74
- path.join(process.cwd(), "./index.ts"),
75
- process.cwd(),
76
- undefined
77
- );
78
- expect(guess).toBe("service-worker");
79
- expect(std.warn).toMatchInlineSnapshot(`
71
+ it("logs a warning when a worker has exports, but not a default one", async () => {
72
+ await writeFile("./index.ts", "export const foo = 1;");
73
+ const guess = await guessWorkerFormat(
74
+ path.join(process.cwd(), "./index.ts"),
75
+ process.cwd(),
76
+ undefined
77
+ );
78
+ expect(guess).toBe("service-worker");
79
+ expect(std.warn).toMatchInlineSnapshot(`
80
80
  "▲ [WARNING] The entrypoint index.ts has exports like an ES Module, but hasn't defined a default export like a module worker normally would. Building the worker using \\"service-worker\\" format...
81
81
 
82
82
  "
83
83
  `);
84
- });
84
+ });
85
85
  });
@@ -2,10 +2,10 @@
2
2
  * The typings file available at `@types/cmd-shim` are out of date.
3
3
  */
4
4
  module "cmd-shim" {
5
- /**
6
- *
7
- * Create a cmd shim at `to` for the command line program at `from`.
8
- *
9
- */
10
- export default function cmdShim(from: string, to: string): Promise<void>;
5
+ /**
6
+ *
7
+ * Create a cmd shim at `to` for the command line program at `from`.
8
+ *
9
+ */
10
+ export default function cmdShim(from: string, to: string): Promise<void>;
11
11
  }
@@ -1,6 +1,6 @@
1
1
  module "faye-websocket" {
2
- /**
3
- * Standards-compliant WebSocket client and server.
4
- */
5
- export default WebSocket;
2
+ /**
3
+ * Standards-compliant WebSocket client and server.
4
+ */
5
+ export default WebSocket;
6
6
  }
@@ -10,20 +10,20 @@ const ORIGINAL_CLOUDFLARE_ACCOUNT_ID = process.env.CLOUDFLARE_ACCOUNT_ID;
10
10
  * This is useful if a higher `describe()` block has already called `mockApiToken()`.
11
11
  */
12
12
  export function mockApiToken({
13
- apiToken = "some-api-token",
13
+ apiToken = "some-api-token",
14
14
  }: { apiToken?: string | null } = {}) {
15
- beforeEach(() => {
16
- if (apiToken === null) {
17
- delete process.env.CLOUDFLARE_API_TOKEN;
18
- } else {
19
- process.env.CLOUDFLARE_API_TOKEN = apiToken;
20
- }
21
- // Now we have updated the environment, we must reinitialize the user auth state.
22
- reinitialiseAuthTokens();
23
- });
24
- afterEach(() => {
25
- process.env.CLOUDFLARE_API_TOKEN = ORIGINAL_CLOUDFLARE_API_TOKEN;
26
- });
15
+ beforeEach(() => {
16
+ if (apiToken === null) {
17
+ delete process.env.CLOUDFLARE_API_TOKEN;
18
+ } else {
19
+ process.env.CLOUDFLARE_API_TOKEN = apiToken;
20
+ }
21
+ // Now we have updated the environment, we must reinitialize the user auth state.
22
+ reinitialiseAuthTokens();
23
+ });
24
+ afterEach(() => {
25
+ process.env.CLOUDFLARE_API_TOKEN = ORIGINAL_CLOUDFLARE_API_TOKEN;
26
+ });
27
27
  }
28
28
 
29
29
  /**
@@ -33,16 +33,16 @@ export function mockApiToken({
33
33
  * This is useful if a higher `describe()` block has already called `mockAccountId()`.
34
34
  */
35
35
  export function mockAccountId({
36
- accountId = "some-account-id",
36
+ accountId = "some-account-id",
37
37
  }: { accountId?: string | null } = {}) {
38
- beforeEach(() => {
39
- if (accountId === null) {
40
- delete process.env.CLOUDFLARE_ACCOUNT_ID;
41
- } else {
42
- process.env.CLOUDFLARE_ACCOUNT_ID = accountId;
43
- }
44
- });
45
- afterEach(() => {
46
- process.env.CLOUDFLARE_ACCOUNT_ID = ORIGINAL_CLOUDFLARE_ACCOUNT_ID;
47
- });
38
+ beforeEach(() => {
39
+ if (accountId === null) {
40
+ delete process.env.CLOUDFLARE_ACCOUNT_ID;
41
+ } else {
42
+ process.env.CLOUDFLARE_ACCOUNT_ID = accountId;
43
+ }
44
+ });
45
+ afterEach(() => {
46
+ process.env.CLOUDFLARE_ACCOUNT_ID = ORIGINAL_CLOUDFLARE_ACCOUNT_ID;
47
+ });
48
48
  }
@@ -8,29 +8,29 @@ const nodeShebang = "#!/usr/bin/env node";
8
8
  * Create a binary file in a temp directory and make it available on the PATH.
9
9
  */
10
10
  export async function mockBinary(
11
- binaryName: string,
12
- code: string
11
+ binaryName: string,
12
+ code: string
13
13
  ): Promise<() => void> {
14
- // Ensure there is a directory to put the mock binary in.
15
- const tmpDir = resolve(mkdtempSync(".mock-binary-"));
14
+ // Ensure there is a directory to put the mock binary in.
15
+ const tmpDir = resolve(mkdtempSync(".mock-binary-"));
16
16
 
17
- // Use a fake extension on Windows because we will create a cmd-shim to run the binary.
18
- const extension = process.platform === "win32" ? ".x-mock-bin" : "";
19
- const filePath = resolve(tmpDir, `${binaryName}${extension}`);
20
- writeFileSync(filePath, nodeShebang + "\n" + code);
21
- chmodSync(filePath, 0o777);
17
+ // Use a fake extension on Windows because we will create a cmd-shim to run the binary.
18
+ const extension = process.platform === "win32" ? ".x-mock-bin" : "";
19
+ const filePath = resolve(tmpDir, `${binaryName}${extension}`);
20
+ writeFileSync(filePath, nodeShebang + "\n" + code);
21
+ chmodSync(filePath, 0o777);
22
22
 
23
- if (process.platform === "win32") {
24
- await cmdShim(filePath, basename(filePath, ".x-mock-bin"));
25
- }
23
+ if (process.platform === "win32") {
24
+ await cmdShim(filePath, basename(filePath, ".x-mock-bin"));
25
+ }
26
26
 
27
- // Update PATH using the appropriate separator for the platform.
28
- const oldPath = process.env.PATH;
29
- const sep = process.platform === "win32" ? ";" : ":";
30
- process.env.PATH = tmpDir + sep + oldPath;
27
+ // Update PATH using the appropriate separator for the platform.
28
+ const oldPath = process.env.PATH;
29
+ const sep = process.platform === "win32" ? ";" : ":";
30
+ process.env.PATH = tmpDir + sep + oldPath;
31
31
 
32
- return function unMock() {
33
- rmSync(tmpDir, { recursive: true });
34
- process.env.PATH = process.env.PATH?.replace(tmpDir + sep, "");
35
- };
32
+ return function unMock() {
33
+ rmSync(tmpDir, { recursive: true });
34
+ process.env.PATH = process.env.PATH?.replace(tmpDir + sep, "");
35
+ };
36
36
  }
@@ -8,17 +8,17 @@ import type { RequestInit } from "undici";
8
8
  * The signature of the function that will handle a mock request.
9
9
  */
10
10
  export type MockHandler<ResponseType> = (
11
- uri: RegExpExecArray,
12
- init: RequestInit,
13
- queryParams: URLSearchParams
11
+ uri: RegExpExecArray,
12
+ init: RequestInit,
13
+ queryParams: URLSearchParams
14
14
  ) => ResponseType | Promise<ResponseType>;
15
15
 
16
16
  type RemoveMockFn = () => void;
17
17
 
18
18
  interface MockFetch<ResponseType> {
19
- regexp: RegExp;
20
- method: string | undefined;
21
- handler: MockHandler<ResponseType>;
19
+ regexp: RegExp;
20
+ method: string | undefined;
21
+ handler: MockHandler<ResponseType>;
22
22
  }
23
23
  const mocks: MockFetch<unknown>[] = [];
24
24
 
@@ -30,23 +30,23 @@ const mocks: MockFetch<unknown>[] = [];
30
30
  * Once found the handler will be used to generate a mock response.
31
31
  */
32
32
  export async function mockFetchInternal(
33
- resource: string,
34
- init: RequestInit = {},
35
- queryParams: URLSearchParams = new URLSearchParams()
33
+ resource: string,
34
+ init: RequestInit = {},
35
+ queryParams: URLSearchParams = new URLSearchParams()
36
36
  ) {
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
- );
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
+ );
50
50
  }
51
51
 
52
52
  /**
@@ -57,8 +57,8 @@ export async function mockFetchInternal(
57
57
  * @param handler The function that will generate the mock response for this request.
58
58
  */
59
59
  export function setMockRawResponse<ResponseType>(
60
- resource: string,
61
- handler: MockHandler<ResponseType>
60
+ resource: string,
61
+ handler: MockHandler<ResponseType>
62
62
  ): RemoveMockFn;
63
63
  /**
64
64
  * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
@@ -69,32 +69,32 @@ export function setMockRawResponse<ResponseType>(
69
69
  * @param handler The function that will generate the mock response for this request.
70
70
  */
71
71
  export function setMockRawResponse<ResponseType>(
72
- resource: string,
73
- method: string,
74
- handler: MockHandler<ResponseType>
72
+ resource: string,
73
+ method: string,
74
+ handler: MockHandler<ResponseType>
75
75
  ): RemoveMockFn;
76
76
  /**
77
77
  * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
78
78
  */
79
79
  export function setMockRawResponse<ResponseType>(
80
- resource: string,
81
- ...args: [string, MockHandler<ResponseType>] | [MockHandler<ResponseType>]
80
+ resource: string,
81
+ ...args: [string, MockHandler<ResponseType>] | [MockHandler<ResponseType>]
82
82
  ): 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
- };
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
+ };
98
98
  }
99
99
 
100
100
  /**
@@ -107,8 +107,8 @@ export function setMockRawResponse<ResponseType>(
107
107
  * @param handler The function that will generate the mock response for this request.
108
108
  */
109
109
  export function setMockResponse<ResponseType>(
110
- resource: string,
111
- handler: MockHandler<ResponseType>
110
+ resource: string,
111
+ handler: MockHandler<ResponseType>
112
112
  ): RemoveMockFn;
113
113
  /**
114
114
  * Specify an expected resource path that is to be handled, resulting in a FetchRequest..
@@ -119,48 +119,48 @@ export function setMockResponse<ResponseType>(
119
119
  * @param handler The function that will generate the mock response for this request.
120
120
  */
121
121
  export function setMockResponse<ResponseType>(
122
- resource: string,
123
- method: string,
124
- handler: MockHandler<ResponseType>
122
+ resource: string,
123
+ method: string,
124
+ handler: MockHandler<ResponseType>
125
125
  ): RemoveMockFn;
126
126
  /**
127
127
  * Specify an expected resource path that is to be handled, resulting in a FetchRequest.
128
128
  */
129
129
  export function setMockResponse<ResponseType>(
130
- resource: string,
131
- ...args: [string, MockHandler<ResponseType>] | [MockHandler<ResponseType>]
130
+ resource: string,
131
+ ...args: [string, MockHandler<ResponseType>] | [MockHandler<ResponseType>]
132
132
  ): 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
- );
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
+ );
138
138
  }
139
139
 
140
140
  /**
141
141
  * A helper to make it easier to create `FetchResult` objects in tests.
142
142
  */
143
143
  export async function createFetchResult<ResponseType>(
144
- result: ResponseType | Promise<ResponseType>,
145
- success = true,
146
- errors: FetchError[] = [],
147
- messages: string[] = [],
148
- result_info?: unknown
144
+ result: ResponseType | Promise<ResponseType>,
145
+ success = true,
146
+ errors: FetchError[] = [],
147
+ messages: string[] = [],
148
+ result_info?: unknown
149
149
  ): 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
- };
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
+ };
164
164
  }
165
165
 
166
166
  /**
@@ -169,7 +169,7 @@ export async function createFetchResult<ResponseType>(
169
169
  * This should be called in an `afterEach()` block to ensure that mock handlers do not leak between tests.
170
170
  */
171
171
  export function unsetAllMocks() {
172
- mocks.length = 0;
172
+ mocks.length = 0;
173
173
  }
174
174
 
175
175
  /**
@@ -179,33 +179,33 @@ export function unsetAllMocks() {
179
179
  * special-case mocking it here.
180
180
  */
181
181
 
182
- const kvGetMocks = new Map<string, string>();
182
+ const kvGetMocks = new Map<string, string | Buffer>();
183
183
 
184
184
  /**
185
185
  * @mocked typeof fetchKVGetValue
186
186
  */
187
187
  export function mockFetchKVGetValue(
188
- accountId: string,
189
- namespaceId: string,
190
- key: string
188
+ accountId: string,
189
+ namespaceId: string,
190
+ key: string
191
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}`);
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}`);
198
198
  }
199
199
 
200
200
  export function setMockFetchKVGetValue(
201
- accountId: string,
202
- namespaceId: string,
203
- key: string,
204
- value: string
201
+ accountId: string,
202
+ namespaceId: string,
203
+ key: string,
204
+ value: string | Buffer
205
205
  ) {
206
- kvGetMocks.set(`${accountId}/${namespaceId}/${key}`, value);
206
+ kvGetMocks.set(`${accountId}/${namespaceId}/${key}`, value);
207
207
  }
208
208
 
209
209
  export function unsetMockFetchKVGetValues() {
210
- kvGetMocks.clear();
210
+ kvGetMocks.clear();
211
211
  }