wrangler 2.20.0 → 3.0.0

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 (297) hide show
  1. package/README.md +4 -4
  2. package/bin/wrangler.js +9 -75
  3. package/package.json +5 -13
  4. package/templates/__tests__/tsconfig.tsbuildinfo +1 -1
  5. package/templates/checked-fetch.js +1 -1
  6. package/templates/first-party-worker-module-facade.ts +2 -2
  7. package/templates/middleware/common.ts +9 -4
  8. package/templates/middleware/loader-sw.ts +2 -7
  9. package/templates/new-worker-scheduled.ts +1 -1
  10. package/templates/new-worker.ts +1 -1
  11. package/templates/pages-dev-util.ts +4 -1
  12. package/templates/pages-shim.ts +0 -3
  13. package/templates/tsconfig.tsbuildinfo +1 -1
  14. package/wrangler-dist/cli.d.ts +149 -75
  15. package/wrangler-dist/cli.js +60062 -64338
  16. package/import_meta_url.js +0 -3
  17. package/miniflare-config-stubs/.env.empty +0 -0
  18. package/miniflare-config-stubs/package.empty.json +0 -1
  19. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  20. package/miniflare-dist/index.mjs +0 -6442
  21. package/src/__tests__/access.test.ts +0 -25
  22. package/src/__tests__/api-dev.test.ts +0 -238
  23. package/src/__tests__/api-devregistry.test.ts +0 -121
  24. package/src/__tests__/api.test.ts +0 -102
  25. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  26. package/src/__tests__/config-cache.test.ts +0 -42
  27. package/src/__tests__/configuration.test.ts +0 -4517
  28. package/src/__tests__/constellation.test.ts +0 -371
  29. package/src/__tests__/d1/d1.test.ts +0 -82
  30. package/src/__tests__/d1/execute.test.ts +0 -66
  31. package/src/__tests__/d1/migrate.test.ts +0 -257
  32. package/src/__tests__/d1/splitter.test.ts +0 -255
  33. package/src/__tests__/delete.test.ts +0 -272
  34. package/src/__tests__/deployments.test.ts +0 -369
  35. package/src/__tests__/dev.test.tsx +0 -1617
  36. package/src/__tests__/generate.test.ts +0 -237
  37. package/src/__tests__/get-host-from-url.test.ts +0 -16
  38. package/src/__tests__/guess-worker-format.test.ts +0 -120
  39. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  40. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  41. package/src/__tests__/helpers/end-event-loop.ts +0 -6
  42. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  43. package/src/__tests__/helpers/mock-auth-domain.ts +0 -20
  44. package/src/__tests__/helpers/mock-bin.ts +0 -36
  45. package/src/__tests__/helpers/mock-console.ts +0 -112
  46. package/src/__tests__/helpers/mock-dialogs.ts +0 -139
  47. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +0 -25
  48. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -11
  49. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  50. package/src/__tests__/helpers/mock-istty.ts +0 -74
  51. package/src/__tests__/helpers/mock-known-routes.ts +0 -12
  52. package/src/__tests__/helpers/mock-kv.ts +0 -46
  53. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -263
  54. package/src/__tests__/helpers/mock-process.ts +0 -34
  55. package/src/__tests__/helpers/mock-set-timeout.ts +0 -16
  56. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  57. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  58. package/src/__tests__/helpers/msw/blob-worker.cjs +0 -19
  59. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  60. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -160
  61. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -81
  62. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  63. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -60
  64. package/src/__tests__/helpers/msw/handlers/script.ts +0 -56
  65. package/src/__tests__/helpers/msw/handlers/user.ts +0 -52
  66. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -20
  67. package/src/__tests__/helpers/msw/index.ts +0 -52
  68. package/src/__tests__/helpers/msw/read-file-sync.js +0 -61
  69. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  70. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  71. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +0 -28
  72. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  73. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  74. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  75. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -11
  76. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  77. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  78. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  79. package/src/__tests__/https-options.test.ts +0 -163
  80. package/src/__tests__/index.test.ts +0 -282
  81. package/src/__tests__/init.test.ts +0 -3196
  82. package/src/__tests__/jest.setup.ts +0 -179
  83. package/src/__tests__/kv.test.ts +0 -1799
  84. package/src/__tests__/logger.test.ts +0 -207
  85. package/src/__tests__/logout.test.ts +0 -47
  86. package/src/__tests__/metrics.test.ts +0 -493
  87. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  88. package/src/__tests__/middleware.test.ts +0 -816
  89. package/src/__tests__/mtls-certificates.test.ts +0 -589
  90. package/src/__tests__/package-manager.test.ts +0 -353
  91. package/src/__tests__/pages/deployment-list.test.ts +0 -80
  92. package/src/__tests__/pages/functions-build.test.ts +0 -528
  93. package/src/__tests__/pages/pages.test.ts +0 -81
  94. package/src/__tests__/pages/project-create.test.ts +0 -63
  95. package/src/__tests__/pages/project-list.test.ts +0 -110
  96. package/src/__tests__/pages/project-upload.test.ts +0 -500
  97. package/src/__tests__/pages/publish.test.ts +0 -2864
  98. package/src/__tests__/pages-deployment-tail.test.ts +0 -957
  99. package/src/__tests__/parse.test.ts +0 -436
  100. package/src/__tests__/paths.test.ts +0 -39
  101. package/src/__tests__/publish.test.ts +0 -8849
  102. package/src/__tests__/pubsub.test.ts +0 -496
  103. package/src/__tests__/queues.test.ts +0 -532
  104. package/src/__tests__/r2.test.ts +0 -374
  105. package/src/__tests__/route.test.ts +0 -45
  106. package/src/__tests__/secret.test.ts +0 -693
  107. package/src/__tests__/tail.test.ts +0 -989
  108. package/src/__tests__/test-old-node-version.js +0 -31
  109. package/src/__tests__/traverse-module-graph.test.ts +0 -220
  110. package/src/__tests__/tsconfig-sanity.ts +0 -12
  111. package/src/__tests__/tsconfig.json +0 -8
  112. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  113. package/src/__tests__/type-generation.test.ts +0 -234
  114. package/src/__tests__/user.test.ts +0 -118
  115. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  116. package/src/__tests__/validate-dev-props.test.ts +0 -56
  117. package/src/__tests__/version.test.ts +0 -35
  118. package/src/__tests__/whoami.test.tsx +0 -172
  119. package/src/__tests__/worker-namespace.test.ts +0 -340
  120. package/src/abort.d.ts +0 -3
  121. package/src/api/dev.ts +0 -321
  122. package/src/api/index.ts +0 -11
  123. package/src/api/mtls-certificate.ts +0 -148
  124. package/src/api/pages/create-worker-bundle-contents.ts +0 -77
  125. package/src/api/pages/index.ts +0 -5
  126. package/src/api/pages/publish.tsx +0 -371
  127. package/src/bundle-reporter.ts +0 -68
  128. package/src/bundle.ts +0 -929
  129. package/src/cfetch/index.ts +0 -158
  130. package/src/cfetch/internal.ts +0 -258
  131. package/src/cli.ts +0 -28
  132. package/src/config/README.md +0 -107
  133. package/src/config/config.ts +0 -282
  134. package/src/config/diagnostics.ts +0 -80
  135. package/src/config/environment.ts +0 -625
  136. package/src/config/index.ts +0 -403
  137. package/src/config/validation-helpers.ts +0 -597
  138. package/src/config/validation.ts +0 -2369
  139. package/src/config-cache.ts +0 -85
  140. package/src/constellation/createProject.tsx +0 -51
  141. package/src/constellation/deleteProject.ts +0 -51
  142. package/src/constellation/deleteProjectModel.ts +0 -68
  143. package/src/constellation/index.ts +0 -75
  144. package/src/constellation/listCatalog.tsx +0 -35
  145. package/src/constellation/listModel.tsx +0 -41
  146. package/src/constellation/listProject.tsx +0 -28
  147. package/src/constellation/listRuntime.tsx +0 -28
  148. package/src/constellation/options.ts +0 -17
  149. package/src/constellation/types.ts +0 -17
  150. package/src/constellation/uploadModel.tsx +0 -64
  151. package/src/constellation/utils.ts +0 -90
  152. package/src/create-worker-preview.ts +0 -293
  153. package/src/create-worker-upload-form.ts +0 -363
  154. package/src/d1/backups.tsx +0 -219
  155. package/src/d1/constants.ts +0 -2
  156. package/src/d1/create.tsx +0 -70
  157. package/src/d1/delete.ts +0 -53
  158. package/src/d1/execute.tsx +0 -357
  159. package/src/d1/formatTimeAgo.ts +0 -14
  160. package/src/d1/index.ts +0 -100
  161. package/src/d1/list.tsx +0 -62
  162. package/src/d1/migrations/apply.tsx +0 -212
  163. package/src/d1/migrations/create.tsx +0 -79
  164. package/src/d1/migrations/helpers.ts +0 -169
  165. package/src/d1/migrations/index.ts +0 -3
  166. package/src/d1/migrations/list.tsx +0 -95
  167. package/src/d1/migrations/options.ts +0 -23
  168. package/src/d1/options.ts +0 -22
  169. package/src/d1/splitter.ts +0 -161
  170. package/src/d1/types.ts +0 -25
  171. package/src/d1/utils.ts +0 -49
  172. package/src/delete.ts +0 -100
  173. package/src/deployments.ts +0 -368
  174. package/src/deprecated/index.ts +0 -144
  175. package/src/dev/dev-vars.ts +0 -39
  176. package/src/dev/dev.tsx +0 -605
  177. package/src/dev/get-local-persistence-path.ts +0 -31
  178. package/src/dev/local.tsx +0 -952
  179. package/src/dev/remote.tsx +0 -635
  180. package/src/dev/start-server.ts +0 -545
  181. package/src/dev/use-esbuild.ts +0 -215
  182. package/src/dev/validate-dev-props.ts +0 -40
  183. package/src/dev-registry.ts +0 -202
  184. package/src/dev.tsx +0 -934
  185. package/src/dialogs.ts +0 -136
  186. package/src/dispatch-namespace.ts +0 -211
  187. package/src/docs/helpers.ts +0 -50
  188. package/src/docs/index.ts +0 -54
  189. package/src/durable.ts +0 -102
  190. package/src/entry.ts +0 -344
  191. package/src/environment-variables/factory.ts +0 -89
  192. package/src/environment-variables/misc-variables.ts +0 -30
  193. package/src/errors.ts +0 -11
  194. package/src/generate/index.ts +0 -298
  195. package/src/git-client.ts +0 -135
  196. package/src/global-wrangler-config-path.ts +0 -26
  197. package/src/https-options.ts +0 -127
  198. package/src/index.ts +0 -768
  199. package/src/init.ts +0 -1037
  200. package/src/inspect.ts +0 -883
  201. package/src/intl-polyfill.d.ts +0 -139
  202. package/src/is-ci.ts +0 -14
  203. package/src/is-interactive.ts +0 -16
  204. package/src/jest.d.ts +0 -4
  205. package/src/kv/helpers.ts +0 -433
  206. package/src/kv/index.ts +0 -594
  207. package/src/logger.ts +0 -123
  208. package/src/metrics/index.ts +0 -5
  209. package/src/metrics/metrics-config.ts +0 -239
  210. package/src/metrics/metrics-dispatcher.ts +0 -96
  211. package/src/metrics/metrics-usage-headers.ts +0 -24
  212. package/src/metrics/send-event.ts +0 -99
  213. package/src/miniflare-cli/README.md +0 -30
  214. package/src/miniflare-cli/assets.ts +0 -251
  215. package/src/miniflare-cli/index.ts +0 -210
  216. package/src/miniflare-cli/request-context.ts +0 -40
  217. package/src/miniflare-cli/tsconfig.json +0 -9
  218. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  219. package/src/miniflare-cli/types.ts +0 -11
  220. package/src/module-collection.ts +0 -333
  221. package/src/mtls-certificate/cli.ts +0 -155
  222. package/src/open-in-browser.ts +0 -17
  223. package/src/package-manager.ts +0 -219
  224. package/src/pages/build.ts +0 -423
  225. package/src/pages/buildFunctions.ts +0 -140
  226. package/src/pages/constants.ts +0 -18
  227. package/src/pages/deployment-tails.ts +0 -281
  228. package/src/pages/deployments.tsx +0 -84
  229. package/src/pages/dev.ts +0 -734
  230. package/src/pages/errors.ts +0 -67
  231. package/src/pages/functions/buildPlugin.ts +0 -114
  232. package/src/pages/functions/buildWorker.ts +0 -350
  233. package/src/pages/functions/filepath-routing.test.ts +0 -234
  234. package/src/pages/functions/filepath-routing.ts +0 -189
  235. package/src/pages/functions/identifiers.ts +0 -78
  236. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  237. package/src/pages/functions/routes-consolidation.ts +0 -73
  238. package/src/pages/functions/routes-transformation.test.ts +0 -282
  239. package/src/pages/functions/routes-transformation.ts +0 -115
  240. package/src/pages/functions/routes-validation.test.ts +0 -403
  241. package/src/pages/functions/routes-validation.ts +0 -202
  242. package/src/pages/functions/routes.ts +0 -151
  243. package/src/pages/functions/tsconfig.json +0 -8
  244. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  245. package/src/pages/functions.ts +0 -86
  246. package/src/pages/hash.ts +0 -13
  247. package/src/pages/index.ts +0 -102
  248. package/src/pages/projects.tsx +0 -159
  249. package/src/pages/prompt-select-project.tsx +0 -31
  250. package/src/pages/publish.tsx +0 -267
  251. package/src/pages/types.ts +0 -46
  252. package/src/pages/upload.tsx +0 -469
  253. package/src/pages/utils.ts +0 -23
  254. package/src/parse.ts +0 -308
  255. package/src/paths.ts +0 -71
  256. package/src/proxy.ts +0 -694
  257. package/src/publish/index.ts +0 -274
  258. package/src/publish/publish.ts +0 -1065
  259. package/src/pubsub/index.ts +0 -286
  260. package/src/pubsub/pubsub-commands.ts +0 -623
  261. package/src/queues/cli/commands/consumer/add.ts +0 -71
  262. package/src/queues/cli/commands/consumer/index.ts +0 -19
  263. package/src/queues/cli/commands/consumer/remove.ts +0 -31
  264. package/src/queues/cli/commands/create.ts +0 -25
  265. package/src/queues/cli/commands/delete.ts +0 -26
  266. package/src/queues/cli/commands/index.ts +0 -35
  267. package/src/queues/cli/commands/list.ts +0 -25
  268. package/src/queues/client.ts +0 -136
  269. package/src/queues/utils.ts +0 -18
  270. package/src/r2/constants.ts +0 -4
  271. package/src/r2/helpers.ts +0 -132
  272. package/src/r2/index.ts +0 -289
  273. package/src/routes.ts +0 -140
  274. package/src/secret/index.ts +0 -377
  275. package/src/selfsigned.d.ts +0 -29
  276. package/src/sites.ts +0 -484
  277. package/src/tail/createTail.ts +0 -415
  278. package/src/tail/filters.ts +0 -277
  279. package/src/tail/index.ts +0 -211
  280. package/src/tail/printing.ts +0 -132
  281. package/src/traverse-module-graph.ts +0 -54
  282. package/src/tsconfig-sanity.ts +0 -16
  283. package/src/type-generation.ts +0 -181
  284. package/src/update-check.ts +0 -19
  285. package/src/user/access.ts +0 -68
  286. package/src/user/auth-variables.ts +0 -113
  287. package/src/user/choose-account.tsx +0 -39
  288. package/src/user/generate-auth-url.ts +0 -33
  289. package/src/user/generate-random-state.ts +0 -16
  290. package/src/user/index.ts +0 -2
  291. package/src/user/user.ts +0 -1234
  292. package/src/utils/collectKeyValues.ts +0 -14
  293. package/src/utils/render.ts +0 -93
  294. package/src/whoami.ts +0 -135
  295. package/src/worker.ts +0 -279
  296. package/src/yargs-types.ts +0 -37
  297. package/src/zones.ts +0 -191
package/src/inspect.ts DELETED
@@ -1,883 +0,0 @@
1
- import { readFileSync } from "fs";
2
- import { readFile } from "fs/promises";
3
- import assert from "node:assert";
4
- import { createServer } from "node:http";
5
- import os from "node:os";
6
- import { URL } from "node:url";
7
- import path from "path";
8
- import open from "open";
9
- import { useEffect, useRef, useState } from "react";
10
- import { SourceMapConsumer } from "source-map";
11
- import WebSocket, { WebSocketServer } from "ws";
12
- import { version } from "../package.json";
13
- import { logger } from "./logger";
14
- import { waitForPortToBeAvailable } from "./proxy";
15
- import { getAccessToken } from "./user/access";
16
- import type Protocol from "devtools-protocol";
17
- import type { IncomingMessage, Server, ServerResponse } from "node:http";
18
- import type { MessageEvent } from "ws";
19
-
20
- /**
21
- * `useInspector` is a hook for debugging Workers applications
22
- * when using `wrangler dev`.
23
- *
24
- * When we start a session with `wrangler dev`, the Workers platform
25
- * also exposes a debugging websocket that implements the DevTools
26
- * Protocol. While we could just start up DevTools and connect to this
27
- * URL, that URL changes every time we make a change to the
28
- * worker, or when the session expires. Instead, we start up a proxy
29
- * server locally that acts as a bridge between the remote DevTools
30
- * server and the local DevTools instance. So whenever the URL changes,
31
- * we can can silently connect to it and keep the local DevTools instance
32
- * up to date. Further, we also intercept these messages and selectively
33
- * log them directly to the terminal (namely, calls to `console.<x>`,
34
- * and exceptions)
35
- */
36
-
37
- /**
38
- * TODO:
39
- * - clear devtools whenever we save changes to the worker
40
- * - clear devtools when we switch between local/remote modes
41
- * - handle more methods from console
42
- */
43
-
44
- // Information about Wrangler's bundling process that needs passsed through
45
- // for DevTools sourcemap transformation
46
- export interface SourceMapMetadata {
47
- tmpDir: string;
48
- entryDirectory: string;
49
- }
50
-
51
- interface InspectorProps {
52
- /**
53
- * The port that the local proxy server should listen on.
54
- */
55
- port: number;
56
- /**
57
- * The websocket URL exposed by Workers that the inspector should connect to.
58
- */
59
- inspectorUrl: string | undefined;
60
- /**
61
- * Whether console statements and exceptions should be logged to the terminal.
62
- * (We don't log them in local mode because they're already getting
63
- * logged to the terminal by nature of them actually running in node locally.)
64
- */
65
- logToTerminal: boolean;
66
- /**
67
- * Sourcemap path, so that stacktraces can be interpretted
68
- */
69
- sourceMapPath: string | undefined;
70
-
71
- sourceMapMetadata: SourceMapMetadata | undefined;
72
-
73
- host?: string;
74
-
75
- name?: string;
76
- }
77
-
78
- export default function useInspector(props: InspectorProps) {
79
- /** A unique ID for this session. */
80
- const inspectorIdRef = useRef(randomId());
81
-
82
- /** The websocket from the devtools instance. */
83
- const [localWebSocket, setLocalWebSocket] = useState<WebSocket>();
84
- /** The websocket from the edge */
85
- const [remoteWebSocket, setRemoteWebSocket] = useState<WebSocket>();
86
-
87
- /**
88
- * The local proxy server that acts as the bridge between
89
- * the remote websocket and the local DevTools instance.
90
- */
91
- const serverRef = useRef<Server>();
92
- if (serverRef.current === undefined) {
93
- serverRef.current = createServer(
94
- (req: IncomingMessage, res: ServerResponse) => {
95
- switch (req.url) {
96
- // We implement a couple of well known end points
97
- // that are queried for metadata by chrome://inspect
98
- case "/json/version":
99
- res.setHeader("Content-Type", "application/json");
100
- res.end(
101
- JSON.stringify({
102
- Browser: `wrangler/v${version}`,
103
- // TODO: (someday): The DevTools protocol should match that of Edge Worker.
104
- // This could be exposed by the preview API.
105
- "Protocol-Version": "1.3",
106
- })
107
- );
108
- return;
109
- case "/json":
110
- case "/json/list":
111
- {
112
- res.setHeader("Content-Type", "application/json");
113
- const localHost = `localhost:${props.port}/ws`;
114
- const devtoolsFrontendUrl = `devtools://devtools/bundled/js_app.html?experiments=true&v8only=true&ws=${localHost}`;
115
- const devtoolsFrontendUrlCompat = `devtools://devtools/bundled/inspector.html?experiments=true&v8only=true&ws=${localHost}`;
116
- res.end(
117
- JSON.stringify([
118
- {
119
- id: inspectorIdRef.current,
120
- type: "node",
121
- description: "workers",
122
- webSocketDebuggerUrl: `ws://${localHost}`,
123
- devtoolsFrontendUrl,
124
- devtoolsFrontendUrlCompat,
125
- // Below are fields that are visible in the DevTools UI.
126
- title: "Cloudflare Worker",
127
- faviconUrl: "https://workers.cloudflare.com/favicon.ico",
128
- url:
129
- "https://" +
130
- (remoteWebSocket
131
- ? new URL(remoteWebSocket.url).host
132
- : "workers.dev"),
133
- },
134
- ])
135
- );
136
- }
137
- return;
138
- default:
139
- break;
140
- }
141
- }
142
- );
143
- }
144
- const server = serverRef.current;
145
-
146
- /**
147
- * The websocket server that runs on top of the proxy server.
148
- */
149
- const wsServerRef = useRef<WebSocketServer>();
150
- if (wsServerRef.current === undefined) {
151
- wsServerRef.current = new WebSocketServer({
152
- server,
153
- clientTracking: true,
154
- });
155
- }
156
- const wsServer = wsServerRef.current;
157
-
158
- wsServer.on("connection", (ws: WebSocket) => {
159
- if (wsServer.clients.size > 1) {
160
- /** We only want to have one active Devtools instance at a time. */
161
- logger.error(
162
- "Tried to open a new devtools window when a previous one was already open."
163
- );
164
- ws.close(1013, "Too many clients; only one can be connected at a time");
165
- } else {
166
- // Since Wrangler proxies the inspector, reloading Chrome DevTools won't trigger debugger initialisation events (because it's connecting to an extant session).
167
- // This sends a `Debugger.disable` message to the remote when a new WebSocket connection is initialised,
168
- // with the assumption that the new connection will shortly send a `Debugger.enable` event and trigger re-initialisation.
169
- // The key initialisation messages that are needed are the `Debugger.scriptParsed events`.
170
- remoteWebSocket?.send(
171
- JSON.stringify({
172
- // This number is arbitrary, and is chosen to be high so as not to conflict with messages that DevTools might actually send.
173
- // For completeness, these options don't work: 0, -1, or Number.MAX_SAFE_INTEGER
174
- id: 100_000_000,
175
- method: "Debugger.disable",
176
- })
177
- );
178
- // As promised, save the created websocket in a state hook
179
- setLocalWebSocket(ws);
180
-
181
- ws.addEventListener("close", () => {
182
- // And and cleanup when devtools closes
183
- setLocalWebSocket(undefined);
184
- });
185
- }
186
- });
187
-
188
- /**
189
- * We start and stop the server in an effect to take advantage
190
- * of the component lifecycle. Convenient.
191
- */
192
- useEffect(() => {
193
- const abortController = new AbortController();
194
- async function startInspectorProxy() {
195
- await waitForPortToBeAvailable(props.port, {
196
- retryPeriod: 200,
197
- timeout: 2000,
198
- abortSignal: abortController.signal,
199
- });
200
- server.listen(props.port);
201
- }
202
- startInspectorProxy().catch((err) => {
203
- if ((err as { code: string }).code !== "ABORT_ERR") {
204
- logger.error("Failed to start inspector:", err);
205
- }
206
- });
207
- return () => {
208
- server.close();
209
- // Also disconnect any open websockets/devtools connections
210
- wsServer.clients.forEach((ws) => ws.close());
211
- wsServer.close();
212
- abortController.abort();
213
- };
214
- }, [props.port, server, wsServer]);
215
-
216
- /**
217
- * When connecting to the remote websocket, if we don't start either
218
- * the devtools instance or make an actual request to the worker in time,
219
- * then the connecting process can error out. When this happens, we
220
- * want to simply retry the connection. We use a state hook to trigger retries
221
- * of the effect that connects to the remote websocket.
222
- */
223
- const [
224
- retryRemoteWebSocketConnectionSigil,
225
- setRetryRemoteWebSocketConnectionSigil,
226
- ] = useState<number>(0);
227
- function retryRemoteWebSocketConnection() {
228
- setRetryRemoteWebSocketConnectionSigil((x) => x + 1);
229
- }
230
-
231
- /** A simple incrementing id to attach to messages we send to devtools */
232
- const messageCounterRef = useRef(1);
233
-
234
- const cfAccessRef = useRef<string>();
235
-
236
- useEffect(() => {
237
- const run = async () => {
238
- if (props.host && !cfAccessRef.current) {
239
- const token = await getAccessToken(props.host);
240
- cfAccessRef.current = token;
241
- }
242
- };
243
- if (props.host) void run();
244
- }, [props.host]);
245
-
246
- // This effect tracks the connection to the remote websocket
247
- // (stored in, no surprises here, `remoteWebSocket`)
248
- useEffect(() => {
249
- if (!props.inspectorUrl) {
250
- return;
251
- }
252
-
253
- // The actual websocket instance
254
- const ws = new WebSocket(props.inspectorUrl, {
255
- headers: {
256
- cookie: `CF_Authorization=${cfAccessRef.current}`,
257
- },
258
- });
259
- setRemoteWebSocket(ws);
260
-
261
- /**
262
- * A handle to the interval we run to keep the websocket alive
263
- */
264
- let keepAliveInterval: NodeJS.Timer;
265
-
266
- /**
267
- * Test if the websocket is closed
268
- */
269
- function isClosed() {
270
- return (
271
- ws.readyState === WebSocket.CLOSED ||
272
- ws.readyState === WebSocket.CLOSING
273
- );
274
- }
275
-
276
- /**
277
- * Send a message to the remote websocket
278
- */
279
- function send(event: Record<string, unknown>): void {
280
- if (!isClosed()) {
281
- ws.send(JSON.stringify(event));
282
- }
283
- }
284
-
285
- /**
286
- * Closes the inspector.
287
- */
288
- function close(): void {
289
- if (!isClosed()) {
290
- try {
291
- ws.close();
292
- } catch (err) {
293
- // Closing before the websocket is ready will throw an error.
294
- }
295
- }
296
- }
297
-
298
- /**
299
- * Since we have a handle on the remote websocket, we can tap
300
- * into its events, and log any pertinent ones directly to
301
- * the terminal (which means you have insight into your worker
302
- * without having to open the devtools).
303
- */
304
- if (props.logToTerminal) {
305
- ws.addEventListener("message", async (event: MessageEvent) => {
306
- if (typeof event.data === "string") {
307
- const evt = JSON.parse(event.data);
308
- if (evt.method === "Runtime.exceptionThrown") {
309
- const params = evt.params as Protocol.Runtime.ExceptionThrownEvent;
310
-
311
- // Parse stack trace with source map.
312
- if (props.sourceMapPath) {
313
- // Parse in the sourcemap
314
- const mapContent = JSON.parse(
315
- await readFile(props.sourceMapPath, "utf-8")
316
- );
317
-
318
- // Create the lines for the exception details log
319
- const exceptionLines = [
320
- params.exceptionDetails.exception?.description?.split("\n")[0],
321
- ];
322
-
323
- await SourceMapConsumer.with(
324
- mapContent,
325
- null,
326
- async (consumer) => {
327
- // Pass each of the callframes into the consumer, and format the error
328
- const stack = params.exceptionDetails.stackTrace?.callFrames;
329
-
330
- stack?.forEach(
331
- ({ functionName, lineNumber, columnNumber }, i) => {
332
- try {
333
- if (lineNumber) {
334
- // The line and column numbers in the stackTrace are zero indexed,
335
- // whereas the sourcemap consumer indexes from one.
336
- const pos = consumer.originalPositionFor({
337
- line: lineNumber + 1,
338
- column: columnNumber + 1,
339
- });
340
-
341
- // Print out line which caused error:
342
- if (i === 0 && pos.source && pos.line) {
343
- const fileSource = consumer.sourceContentFor(
344
- pos.source
345
- );
346
- const fileSourceLine =
347
- fileSource?.split("\n")[pos.line - 1] || "";
348
- exceptionLines.push(fileSourceLine.trim());
349
-
350
- // If we have a column, we can mark the position underneath
351
- if (pos.column) {
352
- exceptionLines.push(
353
- `${" ".repeat(
354
- pos.column - fileSourceLine.search(/\S/)
355
- )}^`
356
- );
357
- }
358
- }
359
-
360
- // From the way esbuild implements the "names" field:
361
- // > To save space, the original name is only recorded when it's different from the final name.
362
- // however, source-map consumer does not handle this
363
- if (pos && pos.line != null) {
364
- const convertedFnName =
365
- pos.name || functionName || "";
366
- exceptionLines.push(
367
- ` at ${convertedFnName} (${pos.source}:${pos.line}:${pos.column})`
368
- );
369
- }
370
- }
371
- } catch {
372
- // Line failed to parse through the sourcemap consumer
373
- // We should handle this better
374
- }
375
- }
376
- );
377
- }
378
- );
379
-
380
- // Log the parsed stacktrace
381
- logger.error(
382
- params.exceptionDetails.text,
383
- exceptionLines.join("\n")
384
- );
385
- } else {
386
- // We log the stacktrace to the terminal
387
- logger.error(
388
- params.exceptionDetails.text,
389
- params.exceptionDetails.exception?.description ?? ""
390
- );
391
- }
392
- }
393
- if (evt.method === "Runtime.consoleAPICalled") {
394
- logConsoleMessage(
395
- evt.params as Protocol.Runtime.ConsoleAPICalledEvent
396
- );
397
- }
398
- } else {
399
- // We should never get here, but who know is 2022...
400
- logger.error("Unrecognised devtools event:", event);
401
- }
402
- });
403
- }
404
-
405
- ws.addEventListener("open", () => {
406
- send({ method: "Runtime.enable", id: messageCounterRef.current });
407
- // TODO: This doesn't actually work. Must fix.
408
- send({ method: "Network.enable", id: messageCounterRef.current++ });
409
-
410
- keepAliveInterval = setInterval(() => {
411
- send({
412
- method: "Runtime.getIsolateId",
413
- id: messageCounterRef.current++,
414
- });
415
- }, 10_000);
416
- });
417
-
418
- ws.on("unexpected-response", () => {
419
- logger.log("Waiting for connection...");
420
- /**
421
- * This usually means the worker is not "ready" yet
422
- * so we'll just retry the connection process
423
- */
424
- retryRemoteWebSocketConnection();
425
- });
426
-
427
- ws.addEventListener("close", () => {
428
- clearInterval(keepAliveInterval);
429
- });
430
-
431
- return () => {
432
- // clean up! Let's first stop the heartbeat interval
433
- clearInterval(keepAliveInterval);
434
- // Then we'll send a message to the devtools instance to
435
- // tell it to clear the console.
436
- wsServer.clients.forEach((client) => {
437
- // We could've used `localSocket` here, but
438
- // then we would have had to add it to the effect
439
- // change detection array, which would have made a
440
- // bunch of other stuff complicated. So we'll just
441
- // cycle through all of the server's connected clients
442
- // (in practice, there should only be one or zero) and send
443
- // the Log.clear message.
444
- client.send(
445
- JSON.stringify({
446
- // TODO: This doesn't actually work. Must fix.
447
- method: "Log.clear",
448
- // we can disable the next eslint warning since
449
- // we're referencing a ref that stays alive
450
- // eslint-disable-next-line react-hooks/exhaustive-deps
451
- id: messageCounterRef.current++,
452
- params: {},
453
- })
454
- );
455
- });
456
- // Finally, we'll close the websocket
457
- close();
458
- // And we'll clear `remoteWebsocket`
459
- setRemoteWebSocket(undefined);
460
- };
461
- }, [
462
- props.inspectorUrl,
463
- props.logToTerminal,
464
- props.sourceMapPath,
465
- wsServer,
466
- // We use a state value as a sigil to trigger a retry of the
467
- // remote websocket connection. It's not used inside the effect,
468
- // so react-hooks/exhaustive-deps doesn't complain if it's not
469
- // included in the dependency array. But its presence is critical,
470
- // so do NOT remove it from the dependency list.
471
- retryRemoteWebSocketConnectionSigil,
472
- ]);
473
-
474
- /**
475
- * We want to make sure we don't lose any messages we receive from the
476
- * remote websocket before devtools connects. So we use a ref to buffer
477
- * messages, and flush them whenever devtools connects.
478
- */
479
- const messageBufferRef = useRef<MessageEvent[]>([]);
480
-
481
- // This effect tracks the state changes _between_ the local
482
- // and remote websockets, and handles how messages flow between them.
483
- useEffect(() => {
484
- /**
485
- * This event listener is used for buffering messages from
486
- * the remote websocket, and flushing them
487
- * when the local websocket connects.
488
- */
489
- function bufferMessageFromRemoteSocket(event: MessageEvent) {
490
- messageBufferRef.current.push(event);
491
- // TODO: maybe we should have a max limit on this?
492
- // if so, we should be careful when removing messages
493
- // from the front, because they could be critical for
494
- // devtools (like execution context creation, etc)
495
- }
496
-
497
- if (remoteWebSocket && !localWebSocket) {
498
- // The local websocket hasn't connected yet, so we'll
499
- // buffer messages until it does.
500
- remoteWebSocket.addEventListener(
501
- "message",
502
- bufferMessageFromRemoteSocket
503
- );
504
- }
505
-
506
- /** Send a message from the local websocket to the remote websocket */
507
- function sendMessageToRemoteWebSocket(event: MessageEvent) {
508
- try {
509
- // Intercept Network.loadNetworkResource to load sourcemaps
510
- const message = JSON.parse(event.data as string);
511
- if (
512
- message.method === "Network.loadNetworkResource" &&
513
- props.sourceMapPath !== undefined &&
514
- props.sourceMapMetadata !== undefined
515
- ) {
516
- // Read the generated source map from esbuild
517
- const sourceMap = JSON.parse(
518
- readFileSync(props.sourceMapPath, "utf-8")
519
- );
520
-
521
- // The source root is a temporary directory (`tmpDir`), and so shouldn't be user-visible
522
- // It provides no useful info to the user
523
- sourceMap.sourceRoot = "";
524
-
525
- const tmpDir = props.sourceMapMetadata.tmpDir;
526
-
527
- // See https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k/edit#heading=h.mt2g20loc2ct
528
- // The above link documents the x_google_ignoreList property, which is intended to mark code that shouldn't be visible in DevTools
529
- // Here we use it to indicate specifically Wrangler-injected code (facades & middleware)
530
- sourceMap.x_google_ignoreList = sourceMap.sources
531
- // Filter anything in the generated tmpDir, and anything from Wrangler's templates
532
- // This should cover facades and middleware, but intentionally doesn't include all non-user code e.g. node_modules
533
- .map((s: string, idx: number) =>
534
- s.includes(tmpDir) || s.includes("wrangler/templates")
535
- ? idx
536
- : null
537
- )
538
- .filter((i: number | null) => i !== null);
539
-
540
- const entryDirectory = props.sourceMapMetadata.entryDirectory;
541
-
542
- sourceMap.sources = sourceMap.sources.map(
543
- (s: string) =>
544
- // These are never loaded by Wrangler or DevTools. However, the presence of a scheme is required for DevTools to show the path as folders in the Sources view
545
- // The scheme is intentially not the same as for the sourceMappingURL
546
- // Without this difference in scheme, DevTools will not strip prefix `../` path elements from top level folders (../node_modules -> node_modules, for instance)
547
- `worker://${props.name}/${path.relative(entryDirectory, s)}`
548
- );
549
-
550
- sendMessageToLocalWebSocket({
551
- data: JSON.stringify({
552
- id: message.id,
553
- result: {
554
- resource: {
555
- success: true,
556
- text: JSON.stringify(sourceMap),
557
- },
558
- },
559
- }),
560
- });
561
- return;
562
- }
563
- } catch (e) {
564
- logger.debug(e);
565
- // Ignore errors, fallthrough to the remote inspector
566
- }
567
- try {
568
- assert(
569
- remoteWebSocket,
570
- "Trying to send a message to an undefined `remoteWebSocket`"
571
- );
572
- remoteWebSocket.send(event.data);
573
- } catch (e) {
574
- if (
575
- (e as Error).message !==
576
- "WebSocket is not open: readyState 0 (CONNECTING)"
577
- ) {
578
- /**
579
- * ^ this just means we haven't opened a websocket yet
580
- * usually happens until there's at least one request
581
- * which is weird, because we may miss something that
582
- * happens on the first request. Maybe we should buffer
583
- * these messages too?
584
- */
585
- logger.error(e);
586
- }
587
- }
588
- }
589
-
590
- /** Send a message from the local websocket to the remote websocket */
591
- function sendMessageToLocalWebSocket(event: Pick<MessageEvent, "data">) {
592
- assert(
593
- localWebSocket,
594
- "Trying to send a message to an undefined `localWebSocket`"
595
- );
596
- try {
597
- // Intercept Debugger.scriptParsed responses to inject URL schemes
598
- const message = JSON.parse(event.data as string);
599
- if (message.method === "Debugger.scriptParsed") {
600
- // Add the worker:// scheme conditionally, since some module types already have schemes (e.g. wasm)
601
- message.params.url = new URL(
602
- message.params.url,
603
- `worker://${props.name}`
604
- ).href;
605
- localWebSocket.send(JSON.stringify(message));
606
- return;
607
- }
608
- } catch (e) {
609
- logger.debug(e);
610
- // Ignore errors, fallthrough to the local websocket
611
- }
612
-
613
- localWebSocket.send(event.data);
614
- }
615
-
616
- if (localWebSocket && remoteWebSocket) {
617
- // Both the remote and local websockets are connected, so let's
618
- // start sending messages between them.
619
- localWebSocket.addEventListener("message", sendMessageToRemoteWebSocket);
620
- remoteWebSocket.addEventListener("message", sendMessageToLocalWebSocket);
621
-
622
- // Also, let's flush any buffered messages
623
- messageBufferRef.current.forEach(sendMessageToLocalWebSocket);
624
- messageBufferRef.current = [];
625
- }
626
-
627
- return () => {
628
- // Cleanup like good citizens
629
- if (remoteWebSocket) {
630
- remoteWebSocket.removeEventListener(
631
- "message",
632
- bufferMessageFromRemoteSocket
633
- );
634
- remoteWebSocket.removeEventListener(
635
- "message",
636
- sendMessageToLocalWebSocket
637
- );
638
- }
639
- if (localWebSocket) {
640
- localWebSocket.removeEventListener(
641
- "message",
642
- sendMessageToRemoteWebSocket
643
- );
644
- }
645
- };
646
- }, [
647
- localWebSocket,
648
- remoteWebSocket,
649
- props.name,
650
- props.sourceMapMetadata,
651
- props.sourceMapPath,
652
- ]);
653
- }
654
-
655
- // Credit: https://stackoverflow.com/a/2117523
656
- function randomId(): string {
657
- return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function (c) {
658
- const r = (Math.random() * 16) | 0,
659
- v = c == "x" ? r : (r & 0x3) | 0x8;
660
- return v.toString(16);
661
- });
662
- }
663
-
664
- /**
665
- * This function converts a message serialised as a devtools event
666
- * into arguments suitable to be called by a console method, and
667
- * then actually calls the method with those arguments. Effectively,
668
- * we're just doing a little bit of the work of the devtools console,
669
- * directly in the terminal.
670
- */
671
-
672
- export const mapConsoleAPIMessageTypeToConsoleMethod: {
673
- [key in Protocol.Runtime.ConsoleAPICalledEvent["type"]]: Exclude<
674
- keyof Console,
675
- "Console"
676
- >;
677
- } = {
678
- log: "log",
679
- debug: "debug",
680
- info: "info",
681
- warning: "warn",
682
- error: "error",
683
- dir: "dir",
684
- dirxml: "dirxml",
685
- table: "table",
686
- trace: "trace",
687
- clear: "clear",
688
- count: "count",
689
- assert: "assert",
690
- profile: "profile",
691
- profileEnd: "profileEnd",
692
- timeEnd: "timeEnd",
693
- startGroup: "group",
694
- startGroupCollapsed: "groupCollapsed",
695
- endGroup: "groupEnd",
696
- };
697
-
698
- function logConsoleMessage(evt: Protocol.Runtime.ConsoleAPICalledEvent): void {
699
- const args: string[] = [];
700
- for (const ro of evt.args) {
701
- switch (ro.type) {
702
- case "string":
703
- case "number":
704
- case "boolean":
705
- case "undefined":
706
- case "symbol":
707
- case "bigint":
708
- args.push(ro.value);
709
- break;
710
- case "function":
711
- args.push(`[Function: ${ro.description ?? "<no-description>"}]`);
712
- break;
713
- case "object":
714
- if (!ro.preview) {
715
- args.push(
716
- ro.subtype === "null"
717
- ? "null"
718
- : ro.description ?? "<no-description>"
719
- );
720
- } else {
721
- args.push(ro.preview.description ?? "<no-description>");
722
-
723
- switch (ro.preview.subtype) {
724
- case "array":
725
- args.push(
726
- "[ " +
727
- ro.preview.properties
728
- .map(({ value }) => {
729
- return value;
730
- })
731
- .join(", ") +
732
- (ro.preview.overflow ? "..." : "") +
733
- " ]"
734
- );
735
-
736
- break;
737
- case "weakmap":
738
- case "map":
739
- ro.preview.entries === undefined
740
- ? args.push("{}")
741
- : args.push(
742
- "{\n" +
743
- ro.preview.entries
744
- .map(({ key, value }) => {
745
- return ` ${key?.description ?? "<unknown>"} => ${
746
- value.description
747
- }`;
748
- })
749
- .join(",\n") +
750
- (ro.preview.overflow ? "\n ..." : "") +
751
- "\n}"
752
- );
753
-
754
- break;
755
- case "weakset":
756
- case "set":
757
- ro.preview.entries === undefined
758
- ? args.push("{}")
759
- : args.push(
760
- "{ " +
761
- ro.preview.entries
762
- .map(({ value }) => {
763
- return `${value.description}`;
764
- })
765
- .join(", ") +
766
- (ro.preview.overflow ? ", ..." : "") +
767
- " }"
768
- );
769
- break;
770
- case "regexp":
771
- break;
772
- case "date":
773
- break;
774
- case "generator":
775
- args.push(ro.preview.properties[0].value || "");
776
- break;
777
- case "promise":
778
- if (ro.preview.properties[0].value === "pending") {
779
- args.push(`{<${ro.preview.properties[0].value}>}`);
780
- } else {
781
- args.push(
782
- `{<${ro.preview.properties[0].value}>: ${ro.preview.properties[1].value}}`
783
- );
784
- }
785
- break;
786
- case "node":
787
- case "iterator":
788
- case "proxy":
789
- case "typedarray":
790
- case "arraybuffer":
791
- case "dataview":
792
- case "webassemblymemory":
793
- case "wasmvalue":
794
- break;
795
- case "error":
796
- default:
797
- // just a pojo
798
- args.push(
799
- "{\n" +
800
- ro.preview.properties
801
- .map(({ name, value }) => {
802
- return ` ${name}: ${value}`;
803
- })
804
- .join(",\n") +
805
- (ro.preview.overflow ? "\n ..." : "") +
806
- "\n}"
807
- );
808
- }
809
- }
810
- break;
811
- default:
812
- args.push(ro.description || ro.unserializableValue || "🦋");
813
- break;
814
- }
815
- }
816
-
817
- const method = mapConsoleAPIMessageTypeToConsoleMethod[evt.type];
818
-
819
- if (method in console) {
820
- switch (method) {
821
- case "dir":
822
- console.dir(args);
823
- break;
824
- case "table":
825
- console.table(args);
826
- break;
827
- default:
828
- // eslint-disable-next-line prefer-spread
829
- console[method].apply(console, args);
830
- break;
831
- }
832
- } else {
833
- logger.warn(`Unsupported console method: ${method}`);
834
- logger.warn("console event:", evt);
835
- }
836
- }
837
-
838
- /**
839
- * Opens the chrome debugger
840
- */
841
- export const openInspector = async (
842
- inspectorPort: number,
843
- worker: string | undefined
844
- ) => {
845
- const query = new URLSearchParams();
846
- query.set("theme", "systemPreferred");
847
- query.set("ws", `localhost:${inspectorPort}/ws`);
848
- if (worker) query.set("domain", worker);
849
- const url = `https://devtools.devprod.cloudflare.dev/js_app?${query.toString()}`;
850
- const errorMessage =
851
- "Failed to open inspector.\nInspector depends on having a Chromium-based browser installed, maybe you need to install one?";
852
-
853
- // see: https://github.com/sindresorhus/open/issues/177#issue-610016699
854
- let braveBrowser: string;
855
- switch (os.platform()) {
856
- case "darwin":
857
- case "win32":
858
- braveBrowser = "Brave";
859
- break;
860
- default:
861
- braveBrowser = "brave";
862
- }
863
-
864
- const childProcess = await open(url, {
865
- app: [
866
- {
867
- name: open.apps.chrome,
868
- },
869
- {
870
- name: braveBrowser,
871
- },
872
- {
873
- name: open.apps.edge,
874
- },
875
- {
876
- name: open.apps.firefox,
877
- },
878
- ],
879
- });
880
- childProcess.on("error", () => {
881
- logger.warn(errorMessage);
882
- });
883
- };