wrangler 0.0.0-e3cab74 → 0.0.0-e3d46ab3

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 (158) hide show
  1. package/README.md +47 -16
  2. package/bin/wrangler.js +95 -32
  3. package/config-schema.json +2939 -0
  4. package/kv-asset-handler.js +1 -0
  5. package/package.json +135 -84
  6. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  7. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  8. package/templates/__tests__/tsconfig.json +8 -0
  9. package/templates/checked-fetch.js +30 -0
  10. package/templates/facade.d.ts +19 -0
  11. package/templates/gitignore +167 -0
  12. package/templates/init-tests/test-jest-new-worker.js +23 -0
  13. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  14. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  15. package/templates/middleware/common.ts +67 -0
  16. package/templates/middleware/loader-modules.ts +134 -0
  17. package/templates/middleware/loader-sw.ts +229 -0
  18. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  19. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  20. package/templates/middleware/middleware-pretty-error.ts +40 -0
  21. package/templates/middleware/middleware-scheduled.ts +15 -0
  22. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  23. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  24. package/templates/modules-watch-stub.js +4 -0
  25. package/templates/new-worker-scheduled.js +17 -0
  26. package/templates/new-worker-scheduled.ts +32 -0
  27. package/templates/new-worker.js +3 -3
  28. package/templates/new-worker.ts +22 -4
  29. package/templates/no-op-worker.js +10 -0
  30. package/templates/pages-dev-pipeline.ts +32 -0
  31. package/templates/pages-dev-util.ts +55 -0
  32. package/templates/pages-shim.ts +9 -0
  33. package/templates/pages-template-plugin.ts +190 -0
  34. package/templates/pages-template-worker.ts +198 -0
  35. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  36. package/templates/startDevWorker/ProxyWorker.ts +334 -0
  37. package/templates/tsconfig-sanity.ts +11 -0
  38. package/templates/tsconfig.init.json +105 -0
  39. package/templates/tsconfig.json +6 -103
  40. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  41. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  42. package/wrangler-dist/ProxyWorker.js +240 -0
  43. package/wrangler-dist/ProxyWorker.js.map +6 -0
  44. package/wrangler-dist/cli.d.ts +24056 -0
  45. package/wrangler-dist/cli.js +199391 -131806
  46. package/wrangler-dist/wasm-sync.wasm +0 -0
  47. package/import_meta_url.js +0 -3
  48. package/miniflare-config-stubs/.env.empty +0 -0
  49. package/miniflare-config-stubs/package.empty.json +0 -1
  50. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  51. package/pages/functions/buildWorker.ts +0 -62
  52. package/pages/functions/filepath-routing.test.ts +0 -123
  53. package/pages/functions/filepath-routing.ts +0 -178
  54. package/pages/functions/identifiers.ts +0 -78
  55. package/pages/functions/routes.ts +0 -151
  56. package/pages/functions/template-worker.ts +0 -130
  57. package/src/__tests__/configuration.test.ts +0 -2185
  58. package/src/__tests__/dev.test.tsx +0 -113
  59. package/src/__tests__/guess-worker-format.test.ts +0 -66
  60. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  61. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  62. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  63. package/src/__tests__/helpers/mock-account-id.ts +0 -30
  64. package/src/__tests__/helpers/mock-bin.ts +0 -36
  65. package/src/__tests__/helpers/mock-cfetch.ts +0 -207
  66. package/src/__tests__/helpers/mock-console.ts +0 -62
  67. package/src/__tests__/helpers/mock-dialogs.ts +0 -65
  68. package/src/__tests__/helpers/mock-kv.ts +0 -40
  69. package/src/__tests__/helpers/mock-user.ts +0 -27
  70. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  71. package/src/__tests__/helpers/run-in-tmp.ts +0 -29
  72. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  73. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  74. package/src/__tests__/index.test.ts +0 -866
  75. package/src/__tests__/jest.setup.ts +0 -57
  76. package/src/__tests__/kv.test.ts +0 -1141
  77. package/src/__tests__/logout.test.ts +0 -50
  78. package/src/__tests__/package-manager.test.ts +0 -206
  79. package/src/__tests__/parse.test.ts +0 -322
  80. package/src/__tests__/publish.test.ts +0 -2406
  81. package/src/__tests__/r2.test.ts +0 -198
  82. package/src/__tests__/secret.test.ts +0 -326
  83. package/src/__tests__/sentry.test.ts +0 -146
  84. package/src/__tests__/tail.test.ts +0 -564
  85. package/src/__tests__/whoami.test.tsx +0 -86
  86. package/src/api/form_data.ts +0 -217
  87. package/src/api/preview.ts +0 -147
  88. package/src/api/worker.ts +0 -186
  89. package/src/bundle.ts +0 -133
  90. package/src/cfetch/index.ts +0 -104
  91. package/src/cfetch/internal.ts +0 -133
  92. package/src/cli.ts +0 -19
  93. package/src/config/README.md +0 -107
  94. package/src/config/config.ts +0 -265
  95. package/src/config/diagnostics.ts +0 -80
  96. package/src/config/environment.ts +0 -305
  97. package/src/config/index.ts +0 -52
  98. package/src/config/validation-helpers.ts +0 -370
  99. package/src/config/validation.ts +0 -1017
  100. package/src/dev.tsx +0 -961
  101. package/src/dialogs.tsx +0 -77
  102. package/src/entry.ts +0 -57
  103. package/src/environment-variables.ts +0 -33
  104. package/src/guess-worker-format.ts +0 -68
  105. package/src/index.tsx +0 -2327
  106. package/src/inspect.ts +0 -609
  107. package/src/kv.tsx +0 -275
  108. package/src/module-collection.ts +0 -170
  109. package/src/open-in-browser.ts +0 -13
  110. package/src/package-manager.ts +0 -126
  111. package/src/pages.tsx +0 -1045
  112. package/src/parse.ts +0 -183
  113. package/src/paths.ts +0 -26
  114. package/src/proxy.ts +0 -376
  115. package/src/publish.ts +0 -368
  116. package/src/r2.ts +0 -50
  117. package/src/reporting.ts +0 -115
  118. package/src/sites.tsx +0 -241
  119. package/src/tail/filters.ts +0 -279
  120. package/src/tail/index.ts +0 -299
  121. package/src/tail/printing.ts +0 -62
  122. package/src/user.tsx +0 -1049
  123. package/src/whoami.tsx +0 -69
  124. package/templates/static-asset-facade.js +0 -47
  125. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  126. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  127. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  128. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  129. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  130. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  131. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  132. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  133. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  134. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  135. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  136. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  137. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  138. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  139. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  140. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  141. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  142. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  143. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  144. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  145. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  146. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  147. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  148. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  149. package/vendor/wrangler-mime/LICENSE +0 -21
  150. package/vendor/wrangler-mime/Mime.js +0 -97
  151. package/vendor/wrangler-mime/README.md +0 -187
  152. package/vendor/wrangler-mime/cli.js +0 -46
  153. package/vendor/wrangler-mime/index.js +0 -4
  154. package/vendor/wrangler-mime/lite.js +0 -4
  155. package/vendor/wrangler-mime/package.json +0 -52
  156. package/vendor/wrangler-mime/types/other.js +0 -1
  157. package/vendor/wrangler-mime/types/standard.js +0 -1
  158. package/wrangler-dist/cli.js.map +0 -7
@@ -1,113 +0,0 @@
1
- import { render } from "ink-testing-library";
2
- import patchConsole from "patch-console";
3
- import React from "react";
4
- import Dev from "../dev";
5
- import { mockConsoleMethods } from "./helpers/mock-console";
6
- import { runWrangler } from "./helpers/run-wrangler";
7
- import writeWranglerToml from "./helpers/write-wrangler-toml";
8
- import type { DevProps } from "../dev";
9
-
10
- describe("Dev component", () => {
11
- let restoreConsole: ReturnType<typeof patchConsole>;
12
- beforeEach(() => (restoreConsole = patchConsole(() => {})));
13
- afterEach(() => restoreConsole());
14
- const std = mockConsoleMethods();
15
-
16
- // This test needs to be rewritten because the error now throws asynchronously
17
- // and the Ink framework does not yet have async testing support.
18
- it.skip("should throw if format is service-worker and there is a public directory", () => {
19
- const { lastFrame } = renderDev({
20
- format: "service-worker",
21
- accountId: "some-account-id",
22
- public: "some/public/path",
23
- });
24
- expect(lastFrame()?.split("\n").slice(0, 2).join("\n"))
25
- .toMatchInlineSnapshot(`
26
- "Something went wrong:
27
- Error: You cannot use the service worker format with a \`public\` directory."
28
- `);
29
- });
30
-
31
- describe("entry-points", () => {
32
- it("should error if there is no entry-point specified", async () => {
33
- writeWranglerToml();
34
-
35
- await expect(
36
- runWrangler("dev")
37
- ).rejects.toThrowErrorMatchingInlineSnapshot(
38
- `"Missing entry-point: The entry-point should be specified via the command line (e.g. \`wrangler dev path/to/script\`) or the \`main\` config field."`
39
- );
40
-
41
- expect(std.out).toMatchInlineSnapshot(`""`);
42
- expect(std.err).toMatchInlineSnapshot(`
43
- "Missing entry-point: The entry-point should be specified via the command line (e.g. \`wrangler dev path/to/script\`) or the \`main\` config field.
44
-
45
- %s
46
- If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
47
- `);
48
- });
49
- });
50
- });
51
-
52
- /**
53
- * Helper function to make it easier to setup and render the `Dev` component.
54
- *
55
- * All the `Dev` props are optional here, with sensible defaults for testing.
56
- */
57
- function renderDev({
58
- name,
59
- entry = { file: "some/entry.ts", directory: process.cwd() },
60
- port,
61
- inspectorPort = 9229,
62
- format,
63
- accountId,
64
- legacyEnv = true,
65
- initialMode = "local",
66
- jsxFactory,
67
- jsxFragment,
68
- rules = [],
69
- bindings = {
70
- kv_namespaces: [],
71
- vars: {},
72
- durable_objects: { bindings: [] },
73
- r2_buckets: [],
74
- wasm_modules: {},
75
- text_blobs: {},
76
- unsafe: [],
77
- },
78
- public: publicDir,
79
- assetPaths,
80
- compatibilityDate,
81
- compatibilityFlags,
82
- usageModel,
83
- buildCommand = {},
84
- enableLocalPersistence = false,
85
- env,
86
- zone,
87
- }: Partial<DevProps>) {
88
- return render(
89
- <Dev
90
- name={name}
91
- entry={entry}
92
- env={env}
93
- rules={rules}
94
- port={port}
95
- inspectorPort={inspectorPort}
96
- legacyEnv={legacyEnv}
97
- buildCommand={buildCommand}
98
- format={format}
99
- initialMode={initialMode}
100
- jsxFactory={jsxFactory}
101
- jsxFragment={jsxFragment}
102
- accountId={accountId}
103
- assetPaths={assetPaths}
104
- public={publicDir}
105
- compatibilityDate={compatibilityDate}
106
- compatibilityFlags={compatibilityFlags}
107
- usageModel={usageModel}
108
- bindings={bindings}
109
- enableLocalPersistence={enableLocalPersistence}
110
- zone={zone}
111
- />
112
- );
113
- }
@@ -1,66 +0,0 @@
1
- import { writeFile } from "fs/promises";
2
- import path from "path";
3
- import guessWorkerFormat from "../guess-worker-format";
4
- import { runInTempDir } from "./helpers/run-in-tmp";
5
-
6
- describe("guess worker format", () => {
7
- runInTempDir();
8
- it('should detect a "modules" worker', async () => {
9
- await writeFile("./index.ts", "export default {};");
10
- // Note that this isn't actually a valid worker, because it's missing
11
- // a fetch handler. Regardless, our heuristic is simply to check for exports.
12
- const guess = await guessWorkerFormat(
13
- {
14
- file: path.join(process.cwd(), "./index.ts"),
15
- directory: process.cwd(),
16
- },
17
- undefined
18
- );
19
- expect(guess).toBe("modules");
20
- });
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
- {
29
- file: path.join(process.cwd(), "./index.ts"),
30
- directory: process.cwd(),
31
- },
32
- undefined
33
- );
34
- expect(guess).toBe("service-worker");
35
- });
36
-
37
- it("should throw an error when the hint doesn't match the guess (modules - service-worker)", async () => {
38
- await writeFile("./index.ts", "export default {};");
39
- await expect(
40
- guessWorkerFormat(
41
- {
42
- file: path.join(process.cwd(), "./index.ts"),
43
- directory: process.cwd(),
44
- },
45
- "service-worker"
46
- )
47
- ).rejects.toThrow(
48
- "You configured this worker to be a 'service-worker', but the file you are trying to build appears to have ES module exports. Please pass `--format modules`, or simply remove the configuration."
49
- );
50
- });
51
-
52
- it("should throw an error when the hint doesn't match the guess (service-worker - modules)", async () => {
53
- await writeFile("./index.ts", "");
54
- await expect(
55
- guessWorkerFormat(
56
- {
57
- file: path.join(process.cwd(), "./index.ts"),
58
- directory: process.cwd(),
59
- },
60
- "modules"
61
- )
62
- ).rejects.toThrow(
63
- "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."
64
- );
65
- });
66
- });
@@ -1,4 +0,0 @@
1
- // We use this mock during tests because we're having trouble
2
- // properly compiling clipboardy for jest
3
- // We can revisit this if and when we write tests that test
4
- // the copying part of `dev`
@@ -1,11 +0,0 @@
1
- /**
2
- * The typings file available at `@types/cmd-shim` are out of date.
3
- */
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>;
11
- }
@@ -1,6 +0,0 @@
1
- module "faye-websocket" {
2
- /**
3
- * Standards-compliant WebSocket client and server.
4
- */
5
- export default WebSocket;
6
- }
@@ -1,30 +0,0 @@
1
- const ORIGINAL_CLOUDFLARE_API_TOKEN = process.env.CLOUDFLARE_API_TOKEN;
2
- const ORIGINAL_CLOUDFLARE_ACCOUNT_ID = process.env.CLOUDFLARE_ACCOUNT_ID;
3
-
4
- /**
5
- * Mock the API token so that we don't need to read it from user configuration files.
6
- */
7
- export function mockApiToken({
8
- apiToken = "some-api-token",
9
- }: { apiToken?: string } = {}) {
10
- beforeEach(() => {
11
- process.env.CLOUDFLARE_API_TOKEN = apiToken;
12
- });
13
- afterEach(() => {
14
- process.env.CLOUDFLARE_API_TOKEN = ORIGINAL_CLOUDFLARE_API_TOKEN;
15
- });
16
- }
17
-
18
- /**
19
- * Mock the current account ID so that we don't need to read it from configuration files.
20
- */
21
- export function mockAccountId({
22
- accountId = "some-account-id",
23
- }: { accountId?: string } = {}) {
24
- beforeEach(() => {
25
- process.env.CLOUDFLARE_ACCOUNT_ID = accountId;
26
- });
27
- afterEach(() => {
28
- process.env.CLOUDFLARE_ACCOUNT_ID = ORIGINAL_CLOUDFLARE_ACCOUNT_ID;
29
- });
30
- }
@@ -1,36 +0,0 @@
1
- import { chmodSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
2
- import { basename, resolve } from "node:path";
3
- import cmdShim from "cmd-shim";
4
-
5
- const nodeShebang = "#!/usr/bin/env node";
6
-
7
- /**
8
- * Create a binary file in a temp directory and make it available on the PATH.
9
- */
10
- export async function mockBinary(
11
- binaryName: string,
12
- code: string
13
- ): Promise<() => void> {
14
- // Ensure there is a directory to put the mock binary in.
15
- const tmpDir = resolve(mkdtempSync(".mock-binary-"));
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);
22
-
23
- if (process.platform === "win32") {
24
- await cmdShim(filePath, basename(filePath, ".x-mock-bin"));
25
- }
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;
31
-
32
- return function unMock() {
33
- rmSync(tmpDir, { recursive: true });
34
- process.env.PATH = process.env.PATH?.replace(tmpDir + sep, "");
35
- };
36
- }
@@ -1,207 +0,0 @@
1
- import { URL, URLSearchParams } from "node:url";
2
- import { pathToRegexp } from "path-to-regexp";
3
- import { getCloudflareApiBaseUrl } from "../../cfetch";
4
- import type { FetchResult } from "../../cfetch";
5
- import type { RequestInit } from "undici";
6
-
7
- /**
8
- * The signature of the function that will handle a mock request.
9
- */
10
- export type MockHandler<ResponseType> = (
11
- uri: RegExpExecArray,
12
- init: RequestInit,
13
- queryParams: URLSearchParams
14
- ) => ResponseType | Promise<ResponseType>;
15
-
16
- type RemoveMockFn = () => void;
17
-
18
- interface MockFetch<ResponseType> {
19
- regexp: RegExp;
20
- method: string | undefined;
21
- handler: MockHandler<ResponseType>;
22
- }
23
- const mocks: MockFetch<unknown>[] = [];
24
-
25
- /**
26
- * The mock implementation of `cfApi.fetch()`.
27
- *
28
- * This function will attempt to match the given request to one of the mock handlers configured by calls to `setMock`.
29
- *
30
- * Once found the handler will be used to generate a mock response.
31
- */
32
- export async function mockFetchInternal(
33
- resource: string,
34
- init: RequestInit = {},
35
- queryParams: URLSearchParams = new URLSearchParams()
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
- );
50
- }
51
-
52
- /**
53
- * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
54
- *
55
- * @param resource The path of the resource to be matched.
56
- * This can include wildcards whose value will be passed to the `handler`.
57
- * @param handler The function that will generate the mock response for this request.
58
- */
59
- export function setMockRawResponse<ResponseType>(
60
- resource: string,
61
- handler: MockHandler<ResponseType>
62
- ): RemoveMockFn;
63
- /**
64
- * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
65
- *
66
- * @param resource The path of the resource to be matched.
67
- * This can include wildcards whose value will be passed to the `handler`.
68
- * @param method The HTTP method (e.g. GET, POST, etc) that the request must have to match this mock handler.
69
- * @param handler The function that will generate the mock response for this request.
70
- */
71
- export function setMockRawResponse<ResponseType>(
72
- resource: string,
73
- method: string,
74
- handler: MockHandler<ResponseType>
75
- ): RemoveMockFn;
76
- /**
77
- * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
78
- */
79
- export function setMockRawResponse<ResponseType>(
80
- resource: string,
81
- ...args: [string, MockHandler<ResponseType>] | [MockHandler<ResponseType>]
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
- };
98
- }
99
-
100
- /**
101
- * Specify an expected resource path that is to be handled, resulting in a `FetchRequest`.
102
- *
103
- * The mock `handler` should return the `result`, which will then be wrapped in a `FetchRequest` object.
104
- *
105
- * @param resource The path of the resource to be matched.
106
- * This can include wildcards whose value will be passed to the `handler`.
107
- * @param handler The function that will generate the mock response for this request.
108
- */
109
- export function setMockResponse<ResponseType>(
110
- resource: string,
111
- handler: MockHandler<ResponseType>
112
- ): RemoveMockFn;
113
- /**
114
- * Specify an expected resource path that is to be handled, resulting in a FetchRequest..
115
- *
116
- * @param resource The path of the resource to be matched.
117
- * This can include wildcards whose value will be passed to the `handler`.
118
- * @param method The HTTP method (e.g. GET, POST, etc) that the request must have to match this mock handler.
119
- * @param handler The function that will generate the mock response for this request.
120
- */
121
- export function setMockResponse<ResponseType>(
122
- resource: string,
123
- method: string,
124
- handler: MockHandler<ResponseType>
125
- ): RemoveMockFn;
126
- /**
127
- * Specify an expected resource path that is to be handled, resulting in a FetchRequest.
128
- */
129
- export function setMockResponse<ResponseType>(
130
- resource: string,
131
- ...args: [string, MockHandler<ResponseType>] | [MockHandler<ResponseType>]
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
- );
138
- }
139
-
140
- /**
141
- * A helper to make it easier to create `FetchResult` objects in tests.
142
- */
143
- export async function createFetchResult<ResponseType>(
144
- result: ResponseType | Promise<ResponseType>,
145
- success = true,
146
- errors = [],
147
- messages = [],
148
- result_info?: unknown
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
- };
164
- }
165
-
166
- /**
167
- * Remove all the configured mock handlers.
168
- *
169
- * This should be called in an `afterEach()` block to ensure that mock handlers do not leak between tests.
170
- */
171
- export function unsetAllMocks() {
172
- mocks.length = 0;
173
- }
174
-
175
- /**
176
- * We special-case fetching the request for `kv:key get`, because it's
177
- * the only cloudflare API endpoint that returns a plain string as the
178
- * value, and not as the "standard" FetchResult-style json. Hence, we also
179
- * special-case mocking it here.
180
- */
181
-
182
- const kvGetMocks = new Map<string, string>();
183
-
184
- export function mockFetchKVGetValue(
185
- accountId: string,
186
- namespaceId: string,
187
- key: string
188
- ) {
189
- const mapKey = `${accountId}/${namespaceId}/${key}`;
190
- if (kvGetMocks.has(mapKey)) {
191
- return kvGetMocks.get(mapKey);
192
- }
193
- throw new Error(`no mock value found for \`kv:key get\` - ${mapKey}`);
194
- }
195
-
196
- export function setMockFetchKVGetValue(
197
- accountId: string,
198
- namespaceId: string,
199
- key: string,
200
- value: string
201
- ) {
202
- kvGetMocks.set(`${accountId}/${namespaceId}/${key}`, value);
203
- }
204
-
205
- export function unsetMockFetchKVGetValues() {
206
- kvGetMocks.clear();
207
- }
@@ -1,62 +0,0 @@
1
- /**
2
- * We use this module to mock console methods, and optionally
3
- * assert on the values they're called with in our tests.
4
- */
5
-
6
- let logSpy: jest.SpyInstance,
7
- errorSpy: jest.SpyInstance,
8
- warnSpy: jest.SpyInstance;
9
-
10
- const std = {
11
- get out() {
12
- return stripTrailingWhitespace(
13
- normalizeSlashes(stripTimings(logSpy.mock.calls.flat(2).join("\n")))
14
- );
15
- },
16
- get err() {
17
- return stripTrailingWhitespace(
18
- normalizeSlashes(stripTimings(errorSpy.mock.calls.flat(2).join("\n")))
19
- );
20
- },
21
- get warn() {
22
- return stripTrailingWhitespace(
23
- normalizeSlashes(stripTimings(warnSpy.mock.calls.flat(2).join("\n")))
24
- );
25
- },
26
- };
27
-
28
- export function mockConsoleMethods() {
29
- beforeEach(() => {
30
- logSpy = jest.spyOn(console, "log").mockImplementation();
31
- errorSpy = jest.spyOn(console, "error").mockImplementation();
32
- warnSpy = jest.spyOn(console, "warn").mockImplementation();
33
- });
34
- afterEach(() => {
35
- logSpy.mockRestore();
36
- errorSpy.mockRestore();
37
- warnSpy.mockRestore();
38
- });
39
- return std;
40
- }
41
-
42
- /**
43
- * Ensure slashes in the `str` are OS file-system agnostic.
44
- *
45
- * Use this in snapshot tests to be resilient to file-system differences.
46
- */
47
- export function normalizeSlashes(str: string): string {
48
- return str.replace(/\\/g, "/");
49
- }
50
-
51
- /**
52
- * Strip "timing data" out of the `stdout` string, since this is not always deterministic.
53
- *
54
- * Use this in snapshot tests to be resilient to slight changes in timing of processing.
55
- */
56
- export function stripTimings(stdout: string): string {
57
- return stdout.replace(/\(\d+\.\d+ sec\)/g, "(TIMINGS)");
58
- }
59
-
60
- export function stripTrailingWhitespace(str: string): string {
61
- return str.replace(/[^\S\n]+\n/g, "\n");
62
- }
@@ -1,65 +0,0 @@
1
- import { confirm, prompt } from "../../dialogs";
2
-
3
- /**
4
- * The expected values for a confirmation request.
5
- */
6
- export interface ConfirmExpectation {
7
- /** The text expected to be seen in the confirmation dialog. */
8
- text: string;
9
- /** The mock response send back from the confirmation dialog. */
10
- result: boolean;
11
- }
12
-
13
- /**
14
- * Mock the implementation of `confirm()` that will respond with configured results
15
- * for configured confirmation text messages.
16
- *
17
- * If there is a call to `confirm()` that does not match any of the expectations
18
- * then an error is thrown.
19
- */
20
- export function mockConfirm(...expectations: ConfirmExpectation[]) {
21
- (confirm as jest.Mock).mockImplementation((text: string) => {
22
- for (const { text: expectedText, result } of expectations) {
23
- if (text === expectedText) {
24
- return Promise.resolve(result);
25
- }
26
- }
27
- throw new Error(`Unexpected confirmation message: ${text}`);
28
- });
29
- }
30
-
31
- /**
32
- * The expected values for a prompt request.
33
- */
34
- export interface PromptExpectation {
35
- /** The text expected to be seen in the prompt dialog. */
36
- text: string;
37
- /** The type of the prompt. */
38
- type: "text" | "password";
39
- /** The mock response send back from the prompt dialog. */
40
- result: string;
41
- }
42
-
43
- /**
44
- * Mock the implementation of `prompt()` that will respond with configured results
45
- * for configured prompt text messages.
46
- *
47
- * If there is a call to `prompt()` that does not match any of the expectations
48
- * then an error is thrown.
49
- */
50
- export function mockPrompt(...expectations: PromptExpectation[]) {
51
- (prompt as jest.Mock).mockImplementation(
52
- (text: string, type: "text" | "password") => {
53
- for (const {
54
- text: expectedText,
55
- type: expectedType,
56
- result,
57
- } of expectations) {
58
- if (text === expectedText && type == expectedType) {
59
- return Promise.resolve(result);
60
- }
61
- }
62
- throw new Error(`Unexpected confirmation message: ${text}`);
63
- }
64
- );
65
- }
@@ -1,40 +0,0 @@
1
- import { createFetchResult, setMockRawResponse } from "./mock-cfetch";
2
-
3
- export function mockKeyListRequest(
4
- expectedNamespaceId: string,
5
- expectedKeys: string[],
6
- keysPerRequest = 1000,
7
- blankCursorValue: "" | undefined | null = undefined
8
- ) {
9
- const requests = { count: 0 };
10
- // See https://api.cloudflare.com/#workers-kv-namespace-list-a-namespace-s-keys
11
- const expectedKeyObjects = expectedKeys.map((name) => ({
12
- name,
13
- expiration: 123456789,
14
- metadata: {},
15
- }));
16
- setMockRawResponse(
17
- "/accounts/:accountId/storage/kv/namespaces/:namespaceId/keys",
18
- "GET",
19
- ([_url, accountId, namespaceId], _init, query) => {
20
- requests.count++;
21
- expect(accountId).toEqual("some-account-id");
22
- expect(namespaceId).toEqual(expectedNamespaceId);
23
- if (expectedKeyObjects.length <= keysPerRequest) {
24
- return createFetchResult(expectedKeyObjects);
25
- } else {
26
- const start = parseInt(query.get("cursor") ?? "0") || 0;
27
- const end = start + keysPerRequest;
28
- const cursor = end < expectedKeyObjects.length ? end : blankCursorValue;
29
- return createFetchResult(
30
- expectedKeyObjects.slice(start, end),
31
- true,
32
- [],
33
- [],
34
- { cursor }
35
- );
36
- }
37
- }
38
- );
39
- return requests;
40
- }
@@ -1,27 +0,0 @@
1
- import { mkdirSync, writeFileSync } from "node:fs";
2
- import os from "node:os";
3
- import path from "node:path";
4
-
5
- export function writeUserConfig(
6
- oauth_token?: string,
7
- refresh_token?: string,
8
- expiration_time?: string
9
- ) {
10
- const lines: string[] = [];
11
- if (oauth_token) {
12
- lines.push(`oauth_token = "${oauth_token}"`);
13
- }
14
- if (refresh_token) {
15
- lines.push(`refresh_token = "${refresh_token}"`);
16
- }
17
- if (expiration_time) {
18
- lines.push(`expiration_time = "${expiration_time}"`);
19
- }
20
- const configPath = path.join(os.homedir(), ".wrangler/config");
21
- mkdirSync(configPath, { recursive: true });
22
- writeFileSync(
23
- path.join(configPath, "default.toml"),
24
- lines.join("\n"),
25
- "utf-8"
26
- );
27
- }