wrangler 0.0.0-e30d1013 → 0.0.0-e3136f935

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 (270) hide show
  1. package/README.md +17 -15
  2. package/bin/wrangler.js +24 -93
  3. package/config-schema.json +3115 -0
  4. package/package.json +197 -192
  5. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  6. package/templates/__tests__/tsconfig.json +8 -0
  7. package/templates/checked-fetch.js +19 -6
  8. package/templates/facade.d.ts +19 -0
  9. package/templates/gitignore +2 -3
  10. package/templates/init-tests/test-jest-new-worker.js +3 -5
  11. package/templates/init-tests/test-vitest-new-worker.js +4 -6
  12. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  13. package/templates/middleware/common.ts +9 -4
  14. package/templates/middleware/loader-modules.ts +94 -44
  15. package/templates/middleware/loader-sw.ts +48 -32
  16. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  17. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  18. package/templates/middleware/middleware-mock-analytics-engine.d.ts +3 -0
  19. package/templates/middleware/middleware-mock-analytics-engine.ts +30 -0
  20. package/templates/middleware/middleware-scheduled.ts +15 -1
  21. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  22. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  23. package/templates/modules-watch-stub.js +4 -0
  24. package/templates/new-worker-scheduled.ts +1 -1
  25. package/templates/new-worker.ts +4 -1
  26. package/templates/pages-dev-pipeline.ts +6 -2
  27. package/templates/pages-dev-util.ts +4 -1
  28. package/templates/pages-shim.ts +1 -1
  29. package/templates/pages-template-plugin.ts +33 -14
  30. package/templates/pages-template-worker.ts +12 -3
  31. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  32. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  33. package/templates/tsconfig-sanity.ts +11 -0
  34. package/templates/tsconfig.init.json +22 -0
  35. package/templates/tsconfig.json +5 -103
  36. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  37. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  38. package/wrangler-dist/ProxyWorker.js +241 -0
  39. package/wrangler-dist/ProxyWorker.js.map +6 -0
  40. package/wrangler-dist/cli.d.ts +26093 -517
  41. package/wrangler-dist/cli.js +173222 -119058
  42. package/wrangler-dist/wasm-sync.wasm +0 -0
  43. package/Cloudflare_CA.pem +0 -18
  44. package/import_meta_url.js +0 -3
  45. package/miniflare-config-stubs/.env.empty +0 -0
  46. package/miniflare-config-stubs/package.empty.json +0 -1
  47. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  48. package/miniflare-dist/index.mjs +0 -6316
  49. package/src/__tests__/access.test.ts +0 -25
  50. package/src/__tests__/api-dev.test.ts +0 -209
  51. package/src/__tests__/api-devregistry.test.js +0 -56
  52. package/src/__tests__/api.test.ts +0 -80
  53. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  54. package/src/__tests__/config-cache.test.ts +0 -42
  55. package/src/__tests__/configuration.test.ts +0 -3981
  56. package/src/__tests__/d1.test.ts +0 -74
  57. package/src/__tests__/delete.test.ts +0 -230
  58. package/src/__tests__/deployments.test.ts +0 -91
  59. package/src/__tests__/dev.test.tsx +0 -1509
  60. package/src/__tests__/dialogs.test.tsx +0 -40
  61. package/src/__tests__/generate.test.ts +0 -235
  62. package/src/__tests__/get-host-from-url.test.ts +0 -16
  63. package/src/__tests__/guess-worker-format.test.ts +0 -85
  64. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  65. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  66. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  67. package/src/__tests__/helpers/mock-bin.ts +0 -36
  68. package/src/__tests__/helpers/mock-cfetch.ts +0 -333
  69. package/src/__tests__/helpers/mock-console.ts +0 -106
  70. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  71. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -8
  72. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  73. package/src/__tests__/helpers/mock-istty.ts +0 -74
  74. package/src/__tests__/helpers/mock-known-routes.ts +0 -7
  75. package/src/__tests__/helpers/mock-kv.ts +0 -33
  76. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -252
  77. package/src/__tests__/helpers/mock-process.ts +0 -39
  78. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  79. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  80. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  81. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -59
  82. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -104
  83. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -36
  84. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -80
  85. package/src/__tests__/helpers/msw/handlers/script.ts +0 -75
  86. package/src/__tests__/helpers/msw/handlers/user.ts +0 -63
  87. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -22
  88. package/src/__tests__/helpers/msw/index.ts +0 -21
  89. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  90. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  91. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  92. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  93. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  94. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  95. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  96. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  97. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  98. package/src/__tests__/https-options.test.ts +0 -163
  99. package/src/__tests__/index.test.ts +0 -262
  100. package/src/__tests__/init.test.ts +0 -2900
  101. package/src/__tests__/jest.setup.ts +0 -202
  102. package/src/__tests__/kv.test.ts +0 -1675
  103. package/src/__tests__/logger.test.ts +0 -141
  104. package/src/__tests__/metrics.test.ts +0 -450
  105. package/src/__tests__/middleware.scheduled.test.ts +0 -135
  106. package/src/__tests__/middleware.test.ts +0 -726
  107. package/src/__tests__/package-manager.test.ts +0 -353
  108. package/src/__tests__/pages.test.ts +0 -2387
  109. package/src/__tests__/parse.test.ts +0 -330
  110. package/src/__tests__/paths.test.ts +0 -39
  111. package/src/__tests__/publish.test.ts +0 -7633
  112. package/src/__tests__/pubsub.test.ts +0 -370
  113. package/src/__tests__/queues.test.ts +0 -371
  114. package/src/__tests__/r2.test.ts +0 -393
  115. package/src/__tests__/route.test.ts +0 -45
  116. package/src/__tests__/secret.test.ts +0 -644
  117. package/src/__tests__/tail.test.ts +0 -800
  118. package/src/__tests__/test-old-node-version.js +0 -31
  119. package/src/__tests__/type-generation.test.ts +0 -225
  120. package/src/__tests__/user.test.ts +0 -155
  121. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  122. package/src/__tests__/validate-dev-props.test.ts +0 -56
  123. package/src/__tests__/version.test.ts +0 -35
  124. package/src/__tests__/whoami.test.tsx +0 -278
  125. package/src/__tests__/worker-namespace.test.ts +0 -326
  126. package/src/abort.d.ts +0 -3
  127. package/src/api/dev.ts +0 -208
  128. package/src/api/index.ts +0 -2
  129. package/src/bundle-reporter.tsx +0 -68
  130. package/src/bundle.ts +0 -815
  131. package/src/cfetch/index.ts +0 -160
  132. package/src/cfetch/internal.ts +0 -263
  133. package/src/cli.ts +0 -28
  134. package/src/config/README.md +0 -107
  135. package/src/config/config.ts +0 -275
  136. package/src/config/diagnostics.ts +0 -80
  137. package/src/config/environment.ts +0 -561
  138. package/src/config/index.ts +0 -334
  139. package/src/config/validation-helpers.ts +0 -597
  140. package/src/config/validation.ts +0 -2103
  141. package/src/config-cache.ts +0 -85
  142. package/src/create-worker-preview.ts +0 -282
  143. package/src/create-worker-upload-form.ts +0 -316
  144. package/src/d1/backups.tsx +0 -218
  145. package/src/d1/constants.ts +0 -2
  146. package/src/d1/create.tsx +0 -63
  147. package/src/d1/delete.tsx +0 -56
  148. package/src/d1/execute.tsx +0 -344
  149. package/src/d1/formatTimeAgo.ts +0 -14
  150. package/src/d1/index.ts +0 -99
  151. package/src/d1/list.tsx +0 -48
  152. package/src/d1/migrations.tsx +0 -446
  153. package/src/d1/options.ts +0 -22
  154. package/src/d1/types.tsx +0 -24
  155. package/src/d1/utils.ts +0 -48
  156. package/src/delete.ts +0 -108
  157. package/src/deployments.ts +0 -77
  158. package/src/deprecated/index.ts +0 -438
  159. package/src/dev/dev-vars.ts +0 -39
  160. package/src/dev/dev.tsx +0 -587
  161. package/src/dev/get-local-persistence-path.tsx +0 -31
  162. package/src/dev/local.tsx +0 -746
  163. package/src/dev/remote.tsx +0 -603
  164. package/src/dev/start-server.ts +0 -519
  165. package/src/dev/use-esbuild.ts +0 -204
  166. package/src/dev/validate-dev-props.ts +0 -31
  167. package/src/dev-registry.tsx +0 -201
  168. package/src/dev.tsx +0 -868
  169. package/src/dialogs.tsx +0 -169
  170. package/src/dispatch-namespace.ts +0 -207
  171. package/src/durable.ts +0 -102
  172. package/src/entry.ts +0 -329
  173. package/src/environment-variables.ts +0 -50
  174. package/src/errors.ts +0 -11
  175. package/src/git-client.ts +0 -124
  176. package/src/global-wrangler-config-path.ts +0 -26
  177. package/src/https-options.ts +0 -127
  178. package/src/index.tsx +0 -683
  179. package/src/init.ts +0 -970
  180. package/src/inspect.ts +0 -767
  181. package/src/intl-polyfill.d.ts +0 -139
  182. package/src/is-ci.ts +0 -14
  183. package/src/is-interactive.ts +0 -16
  184. package/src/kv/helpers.ts +0 -430
  185. package/src/kv/index.ts +0 -596
  186. package/src/logger.ts +0 -92
  187. package/src/metrics/index.ts +0 -5
  188. package/src/metrics/metrics-config.ts +0 -239
  189. package/src/metrics/metrics-dispatcher.ts +0 -96
  190. package/src/metrics/metrics-usage-headers.ts +0 -24
  191. package/src/metrics/send-event.ts +0 -94
  192. package/src/miniflare-cli/README.md +0 -30
  193. package/src/miniflare-cli/assets.ts +0 -215
  194. package/src/miniflare-cli/index.ts +0 -213
  195. package/src/miniflare-cli/request-context.ts +0 -40
  196. package/src/module-collection.ts +0 -267
  197. package/src/open-in-browser.ts +0 -17
  198. package/src/package-manager.ts +0 -219
  199. package/src/pages/build.tsx +0 -270
  200. package/src/pages/constants.ts +0 -18
  201. package/src/pages/deployments.tsx +0 -106
  202. package/src/pages/dev.tsx +0 -708
  203. package/src/pages/errors.ts +0 -66
  204. package/src/pages/functions/buildPlugin.ts +0 -106
  205. package/src/pages/functions/buildWorker.ts +0 -165
  206. package/src/pages/functions/filepath-routing.test.ts +0 -234
  207. package/src/pages/functions/filepath-routing.ts +0 -189
  208. package/src/pages/functions/identifiers.ts +0 -78
  209. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  210. package/src/pages/functions/routes-consolidation.ts +0 -73
  211. package/src/pages/functions/routes-transformation.test.ts +0 -282
  212. package/src/pages/functions/routes-transformation.ts +0 -115
  213. package/src/pages/functions/routes-validation.test.ts +0 -403
  214. package/src/pages/functions/routes-validation.ts +0 -202
  215. package/src/pages/functions/routes.ts +0 -151
  216. package/src/pages/functions.tsx +0 -82
  217. package/src/pages/hash.tsx +0 -13
  218. package/src/pages/index.tsx +0 -94
  219. package/src/pages/projects.tsx +0 -169
  220. package/src/pages/publish.tsx +0 -446
  221. package/src/pages/types.ts +0 -49
  222. package/src/pages/upload.tsx +0 -425
  223. package/src/pages/utils.ts +0 -12
  224. package/src/parse.ts +0 -286
  225. package/src/paths.ts +0 -71
  226. package/src/proxy.ts +0 -689
  227. package/src/publish/index.ts +0 -270
  228. package/src/publish/publish.ts +0 -1035
  229. package/src/pubsub/index.ts +0 -286
  230. package/src/pubsub/pubsub-commands.tsx +0 -624
  231. package/src/queues/cli/commands/consumer/add.ts +0 -71
  232. package/src/queues/cli/commands/consumer/index.ts +0 -22
  233. package/src/queues/cli/commands/consumer/remove.ts +0 -38
  234. package/src/queues/cli/commands/create.ts +0 -25
  235. package/src/queues/cli/commands/delete.ts +0 -26
  236. package/src/queues/cli/commands/index.ts +0 -33
  237. package/src/queues/cli/commands/list.ts +0 -25
  238. package/src/queues/client.ts +0 -135
  239. package/src/r2/constants.ts +0 -4
  240. package/src/r2/helpers.ts +0 -131
  241. package/src/r2/index.ts +0 -289
  242. package/src/routes.ts +0 -140
  243. package/src/secret/index.ts +0 -378
  244. package/src/selfsigned.d.ts +0 -29
  245. package/src/sites.tsx +0 -372
  246. package/src/tail/createTail.ts +0 -315
  247. package/src/tail/filters.ts +0 -277
  248. package/src/tail/index.ts +0 -214
  249. package/src/tail/printing.ts +0 -107
  250. package/src/type-generation.ts +0 -173
  251. package/src/update-check.ts +0 -19
  252. package/src/user/access.ts +0 -69
  253. package/src/user/choose-account.tsx +0 -69
  254. package/src/user/env-vars.ts +0 -46
  255. package/src/user/generate-auth-url.ts +0 -33
  256. package/src/user/generate-random-state.ts +0 -16
  257. package/src/user/index.ts +0 -3
  258. package/src/user/user.tsx +0 -1192
  259. package/src/utils/collectKeyValues.ts +0 -14
  260. package/src/whoami.tsx +0 -169
  261. package/src/worker.ts +0 -245
  262. package/src/yargs-types.ts +0 -20
  263. package/src/zones.ts +0 -191
  264. package/templates/d1-beta-facade.js +0 -196
  265. package/templates/experimental-local-cache-stubs.js +0 -27
  266. package/templates/first-party-worker-module-facade.ts +0 -18
  267. package/templates/format-dev-errors.ts +0 -32
  268. package/templates/serve-static-assets.ts +0 -63
  269. package/templates/service-bindings-module-facade.js +0 -54
  270. package/templates/service-bindings-sw-facade.js +0 -42
@@ -29,7 +29,7 @@ type EventContext<Env, P extends string, Data> = {
29
29
  declare type PagesFunction<
30
30
  Env = unknown,
31
31
  P extends string = string,
32
- Data extends Record<string, unknown> = Record<string, unknown>
32
+ Data extends Record<string, unknown> = Record<string, unknown>,
33
33
  > = (context: EventContext<Env, P, Data>) => Response | Promise<Response>;
34
34
  /* end @cloudflare/workers-types */
35
35
 
@@ -120,7 +120,7 @@ export default {
120
120
  ) {
121
121
  let request = originalRequest;
122
122
  const handlerIterator = executeRequest(request);
123
- const data = {}; // arbitrary data the user can set between functions
123
+ let data = {}; // arbitrary data the user can set between functions
124
124
  let isFailOpen = false;
125
125
 
126
126
  const next = async (input?: RequestInfo, init?: RequestInit) => {
@@ -141,7 +141,16 @@ export default {
141
141
  functionPath: path,
142
142
  next,
143
143
  params,
144
- data,
144
+ get data() {
145
+ return data;
146
+ },
147
+ set data(value) {
148
+ if (typeof value !== "object" || value === null) {
149
+ throw new Error("context.data must be an object");
150
+ }
151
+ // user has overriden context.data, so we need to merge it with the existing data
152
+ data = value;
153
+ },
145
154
  env,
146
155
  waitUntil: workerContext.waitUntil.bind(workerContext),
147
156
  passThroughOnException: () => {
@@ -0,0 +1,664 @@
1
+ import assert from "node:assert";
2
+ import {
3
+ DevToolsCommandRequest,
4
+ DevToolsCommandRequests,
5
+ DevToolsCommandResponses,
6
+ DevToolsEvent,
7
+ DevToolsEvents,
8
+ serialiseError,
9
+ } from "../../src/api/startDevWorker/events";
10
+ import {
11
+ assertNever,
12
+ createDeferred,
13
+ DeferredPromise,
14
+ MaybePromise,
15
+ urlFromParts,
16
+ } from "../../src/api/startDevWorker/utils";
17
+ import type {
18
+ InspectorProxyWorkerIncomingWebSocketMessage,
19
+ InspectorProxyWorkerOutgoingRequestBody,
20
+ InspectorProxyWorkerOutgoingWebsocketMessage,
21
+ ProxyData,
22
+ } from "../../src/api/startDevWorker/events";
23
+
24
+ const ALLOWED_HOST_HOSTNAMES = ["127.0.0.1", "[::1]", "localhost"];
25
+ const ALLOWED_ORIGIN_HOSTNAMES = [
26
+ "devtools.devprod.cloudflare.dev",
27
+ "cloudflare-devtools.pages.dev",
28
+ /^[a-z0-9]+\.cloudflare-devtools\.pages\.dev$/,
29
+ "127.0.0.1",
30
+ "[::1]",
31
+ "localhost",
32
+ ];
33
+
34
+ interface Env {
35
+ PROXY_CONTROLLER: Fetcher;
36
+ PROXY_CONTROLLER_AUTH_SECRET: string;
37
+ WRANGLER_VERSION: string;
38
+ DURABLE_OBJECT: DurableObjectNamespace;
39
+ }
40
+
41
+ export default {
42
+ fetch(req, env) {
43
+ const singleton = env.DURABLE_OBJECT.idFromName("");
44
+ const inspectorProxy = env.DURABLE_OBJECT.get(singleton);
45
+
46
+ return inspectorProxy.fetch(req);
47
+ },
48
+ } as ExportedHandler<Env>;
49
+
50
+ function isDevToolsEvent<Method extends DevToolsEvents["method"]>(
51
+ event: unknown,
52
+ name: Method
53
+ ): event is DevToolsEvent<Method> {
54
+ return (
55
+ typeof event === "object" &&
56
+ event !== null &&
57
+ "method" in event &&
58
+ event.method === name
59
+ );
60
+ }
61
+
62
+ export class InspectorProxyWorker implements DurableObject {
63
+ constructor(
64
+ _state: DurableObjectState,
65
+ readonly env: Env
66
+ ) {}
67
+
68
+ websockets: {
69
+ proxyController?: WebSocket;
70
+ runtime?: WebSocket;
71
+ devtools?: WebSocket;
72
+
73
+ // Browser DevTools cannot read the filesystem,
74
+ // instead they fetch via `Network.loadNetworkResource` messages.
75
+ // IDE DevTools can read the filesystem and expect absolute paths.
76
+ devtoolsHasFileSystemAccess?: boolean;
77
+
78
+ // We want to be able to delay devtools connection response
79
+ // until we've connected to the runtime inspector server
80
+ // so this deferred holds a promise to websockets.runtime
81
+ runtimeDeferred: DeferredPromise<WebSocket>;
82
+ } = {
83
+ runtimeDeferred: createDeferred<WebSocket>(),
84
+ };
85
+ proxyData?: ProxyData;
86
+ runtimeMessageBuffer: (DevToolsCommandResponses | DevToolsEvents)[] = [];
87
+
88
+ async fetch(req: Request) {
89
+ if (
90
+ req.headers.get("Authorization") === this.env.PROXY_CONTROLLER_AUTH_SECRET
91
+ ) {
92
+ return this.handleProxyControllerRequest(req);
93
+ }
94
+
95
+ if (req.headers.get("Upgrade") === "websocket") {
96
+ return this.handleDevToolsWebSocketUpgradeRequest(req);
97
+ }
98
+
99
+ return this.handleDevToolsJsonRequest(req);
100
+ }
101
+
102
+ // ************************
103
+ // ** PROXY CONTROLLER **
104
+ // ************************
105
+
106
+ handleProxyControllerRequest(req: Request) {
107
+ assert(
108
+ req.headers.get("Upgrade") === "websocket",
109
+ "Expected proxy controller data request to be WebSocket upgrade"
110
+ );
111
+
112
+ const { 0: response, 1: proxyController } = new WebSocketPair();
113
+ proxyController.accept();
114
+ proxyController.addEventListener("close", (event) => {
115
+ // don't reconnect the proxyController websocket
116
+ // ProxyController can detect this event and reconnect itself
117
+
118
+ this.sendDebugLog(
119
+ "PROXY CONTROLLER WEBSOCKET CLOSED",
120
+ event.code,
121
+ event.reason
122
+ );
123
+
124
+ if (this.websockets.proxyController === proxyController) {
125
+ this.websockets.proxyController = undefined;
126
+ }
127
+ });
128
+ proxyController.addEventListener("error", (event) => {
129
+ // don't reconnect the proxyController websocket
130
+ // ProxyController can detect this event and reconnect itself
131
+
132
+ const error = serialiseError(event.error);
133
+ this.sendDebugLog("PROXY CONTROLLER WEBSOCKET ERROR", error);
134
+
135
+ if (this.websockets.proxyController === proxyController) {
136
+ this.websockets.proxyController = undefined;
137
+ }
138
+ });
139
+ proxyController.addEventListener(
140
+ "message",
141
+ this.handleProxyControllerIncomingMessage
142
+ );
143
+
144
+ this.websockets.proxyController = proxyController;
145
+
146
+ return new Response(null, {
147
+ status: 101,
148
+ webSocket: response,
149
+ });
150
+ }
151
+
152
+ handleProxyControllerIncomingMessage = (event: MessageEvent) => {
153
+ assert(
154
+ typeof event.data === "string",
155
+ "Expected event.data from proxy controller to be string"
156
+ );
157
+
158
+ const message: InspectorProxyWorkerIncomingWebSocketMessage = JSON.parse(
159
+ event.data
160
+ );
161
+
162
+ this.sendDebugLog("handleProxyControllerIncomingMessage", event.data);
163
+
164
+ switch (message.type) {
165
+ case "reloadStart": {
166
+ this.sendRuntimeDiscardConsoleEntries();
167
+
168
+ break;
169
+ }
170
+ case "reloadComplete": {
171
+ this.proxyData = message.proxyData;
172
+
173
+ this.reconnectRuntimeWebSocket();
174
+
175
+ break;
176
+ }
177
+ default: {
178
+ assertNever(message);
179
+ }
180
+ }
181
+ };
182
+
183
+ sendProxyControllerMessage(
184
+ message: string | InspectorProxyWorkerOutgoingWebsocketMessage
185
+ ) {
186
+ message = typeof message === "string" ? message : JSON.stringify(message);
187
+
188
+ // if the proxyController websocket is disconnected, throw away the message
189
+ this.websockets.proxyController?.send(message);
190
+ }
191
+
192
+ async sendProxyControllerRequest(
193
+ message: InspectorProxyWorkerOutgoingRequestBody
194
+ ) {
195
+ try {
196
+ const res = await this.env.PROXY_CONTROLLER.fetch("http://dummy", {
197
+ method: "POST",
198
+ body: JSON.stringify(message),
199
+ });
200
+ return res.ok ? await res.text() : undefined;
201
+ } catch (e) {
202
+ this.sendDebugLog(
203
+ "FAILED TO SEND PROXY CONTROLLER REQUEST",
204
+ serialiseError(e)
205
+ );
206
+ return undefined;
207
+ }
208
+ }
209
+
210
+ sendDebugLog: typeof console.debug = (...args) => {
211
+ this.sendProxyControllerRequest({ type: "debug-log", args });
212
+ };
213
+
214
+ // ***************
215
+ // ** RUNTIME **
216
+ // ***************
217
+
218
+ handleRuntimeIncomingMessage = (event: MessageEvent) => {
219
+ assert(typeof event.data === "string");
220
+
221
+ const msg = JSON.parse(event.data) as
222
+ | DevToolsCommandResponses
223
+ | DevToolsEvents;
224
+ this.sendDebugLog("RUNTIME INCOMING MESSAGE", msg);
225
+
226
+ if (isDevToolsEvent(msg, "Runtime.exceptionThrown")) {
227
+ this.sendProxyControllerMessage(event.data);
228
+ }
229
+ if (
230
+ this.proxyData?.proxyLogsToController &&
231
+ isDevToolsEvent(msg, "Runtime.consoleAPICalled")
232
+ ) {
233
+ this.sendProxyControllerMessage(event.data);
234
+ }
235
+
236
+ this.runtimeMessageBuffer.push(msg);
237
+ this.tryDrainRuntimeMessageBuffer();
238
+ };
239
+
240
+ handleRuntimeScriptParsed(msg: DevToolsEvent<"Debugger.scriptParsed">) {
241
+ // If the devtools does not have filesystem access,
242
+ // rewrite the sourceMapURL to use a special scheme.
243
+ // This special scheme is used to indicate whether
244
+ // to intercept each loadNetworkResource message.
245
+
246
+ if (
247
+ !this.websockets.devtoolsHasFileSystemAccess &&
248
+ msg.params.sourceMapURL !== undefined &&
249
+ // Don't try to find a sourcemap for e.g. node-internal: scripts
250
+ msg.params.url.startsWith("file:")
251
+ ) {
252
+ const url = new URL(msg.params.sourceMapURL, msg.params.url);
253
+ // Check for file: in case msg.params.sourceMapURL has a different
254
+ // protocol (e.g. data). In that case we should ignore this file
255
+ if (url.protocol === "file:") {
256
+ msg.params.sourceMapURL = url.href.replace("file:", "wrangler-file:");
257
+ }
258
+ }
259
+
260
+ void this.sendDevToolsMessage(msg);
261
+ }
262
+
263
+ tryDrainRuntimeMessageBuffer = () => {
264
+ // If we don't have a DevTools WebSocket, try again later
265
+ if (this.websockets.devtools === undefined) return;
266
+
267
+ // clear the buffer and replay each message to devtools
268
+ for (const msg of this.runtimeMessageBuffer.splice(0)) {
269
+ if (isDevToolsEvent(msg, "Debugger.scriptParsed")) {
270
+ this.handleRuntimeScriptParsed(msg);
271
+ } else {
272
+ void this.sendDevToolsMessage(msg);
273
+ }
274
+ }
275
+ };
276
+
277
+ runtimeAbortController = new AbortController(); // will abort the in-flight websocket upgrade request to the remote runtime
278
+ runtimeKeepAliveInterval: number | null = null;
279
+ async reconnectRuntimeWebSocket() {
280
+ assert(this.proxyData, "Expected this.proxyData to be defined");
281
+
282
+ this.sendDebugLog("reconnectRuntimeWebSocket");
283
+
284
+ this.websockets.runtime?.close();
285
+ this.websockets.runtime = undefined;
286
+ this.runtimeAbortController.abort();
287
+ this.runtimeAbortController = new AbortController();
288
+ this.websockets.runtimeDeferred = createDeferred<WebSocket>(
289
+ this.websockets.runtimeDeferred
290
+ );
291
+
292
+ const runtimeWebSocketUrl = urlFromParts(
293
+ this.proxyData.userWorkerInspectorUrl
294
+ );
295
+ runtimeWebSocketUrl.protocol = this.proxyData.userWorkerUrl.protocol; // http: or https:
296
+
297
+ this.sendDebugLog("NEW RUNTIME WEBSOCKET", runtimeWebSocketUrl);
298
+
299
+ // Make sure DevTools re-fetches script contents,
300
+ // and uses the newly created execution context
301
+ this.sendDevToolsMessage({
302
+ method: "Runtime.executionContextsCleared",
303
+ params: undefined,
304
+ });
305
+
306
+ const upgrade = await fetch(runtimeWebSocketUrl, {
307
+ headers: {
308
+ ...this.proxyData.headers,
309
+ Upgrade: "websocket",
310
+ },
311
+ signal: this.runtimeAbortController.signal,
312
+ });
313
+
314
+ const runtime = upgrade.webSocket;
315
+ if (!runtime) {
316
+ const error = new Error(
317
+ `Failed to establish the WebSocket connection: expected server to reply with HTTP status code 101 (switching protocols), but received ${upgrade.status} instead.`
318
+ );
319
+
320
+ this.websockets.runtimeDeferred.reject(error);
321
+ this.sendProxyControllerRequest({
322
+ type: "runtime-websocket-error",
323
+ error: serialiseError(error),
324
+ });
325
+
326
+ return;
327
+ }
328
+
329
+ this.websockets.runtime = runtime;
330
+
331
+ runtime.addEventListener("message", this.handleRuntimeIncomingMessage);
332
+
333
+ runtime.addEventListener("close", (event) => {
334
+ this.sendDebugLog("RUNTIME WEBSOCKET CLOSED", event.code, event.reason);
335
+
336
+ clearInterval(this.runtimeKeepAliveInterval);
337
+
338
+ if (this.websockets.runtime === runtime) {
339
+ this.websockets.runtime = undefined;
340
+ }
341
+
342
+ // don't reconnect the runtime websocket
343
+ // if it closes unexpectedly (very rare or a case where reconnecting won't succeed anyway)
344
+ // wait for a new proxy-data message or manual restart
345
+ });
346
+
347
+ runtime.addEventListener("error", (event) => {
348
+ const error = serialiseError(event.error);
349
+ this.sendDebugLog("RUNTIME WEBSOCKET ERROR", error);
350
+
351
+ clearInterval(this.runtimeKeepAliveInterval);
352
+
353
+ if (this.websockets.runtime === runtime) {
354
+ this.websockets.runtime = undefined;
355
+ }
356
+
357
+ this.sendProxyControllerRequest({
358
+ type: "runtime-websocket-error",
359
+ error,
360
+ });
361
+
362
+ // don't reconnect the runtime websocket
363
+ // if it closes unexpectedly (very rare or a case where reconnecting won't succeed anyway)
364
+ // wait for a new proxy-data message or manual restart
365
+ });
366
+
367
+ runtime.accept();
368
+
369
+ // fetch(Upgrade: websocket) resolves when the websocket is open
370
+ // therefore the open event will not fire, so just trigger the handler
371
+ this.handleRuntimeWebSocketOpen(runtime);
372
+ }
373
+
374
+ #runtimeMessageCounter = 1e8;
375
+ nextCounter() {
376
+ return ++this.#runtimeMessageCounter;
377
+ }
378
+ handleRuntimeWebSocketOpen(runtime: WebSocket) {
379
+ this.sendDebugLog("RUNTIME WEBSOCKET OPENED");
380
+
381
+ this.sendRuntimeMessage(
382
+ { method: "Runtime.enable", id: this.nextCounter() },
383
+ runtime
384
+ );
385
+ this.sendRuntimeMessage(
386
+ { method: "Debugger.enable", id: this.nextCounter() },
387
+ runtime
388
+ );
389
+ this.sendRuntimeMessage(
390
+ { method: "Network.enable", id: this.nextCounter() },
391
+ runtime
392
+ );
393
+
394
+ clearInterval(this.runtimeKeepAliveInterval);
395
+ this.runtimeKeepAliveInterval = setInterval(() => {
396
+ this.sendRuntimeMessage(
397
+ { method: "Runtime.getIsolateId", id: this.nextCounter() },
398
+ runtime
399
+ );
400
+ }, 10_000) as any;
401
+
402
+ this.websockets.runtimeDeferred.resolve(runtime);
403
+ }
404
+
405
+ sendRuntimeDiscardConsoleEntries() {
406
+ // by default, sendRuntimeMessage waits for the runtime websocket to connect
407
+ // but we only want to send this message now or never
408
+ // if we schedule it to send later (like waiting for the websocket, by default)
409
+ // then we risk clearing logs that have occured since we scheduled it too
410
+ // which is worse than leaving logs from the previous version on screen
411
+ if (this.websockets.runtime) {
412
+ this.sendRuntimeMessage(
413
+ {
414
+ method: "Runtime.discardConsoleEntries",
415
+ id: this.nextCounter(),
416
+ },
417
+ this.websockets.runtime
418
+ );
419
+ }
420
+ }
421
+
422
+ async sendRuntimeMessage(
423
+ message: string | DevToolsCommandRequests,
424
+ runtime: MaybePromise<WebSocket> = this.websockets.runtimeDeferred.promise
425
+ ) {
426
+ runtime = await runtime;
427
+ message = typeof message === "string" ? message : JSON.stringify(message);
428
+
429
+ this.sendDebugLog("SEND TO RUNTIME", message);
430
+
431
+ runtime.send(message);
432
+ }
433
+
434
+ // ****************
435
+ // ** DEVTOOLS **
436
+ // ****************
437
+
438
+ #inspectorId = crypto.randomUUID();
439
+ async handleDevToolsJsonRequest(req: Request) {
440
+ const url = new URL(req.url);
441
+
442
+ if (url.pathname === "/json/version") {
443
+ return Response.json({
444
+ Browser: `wrangler/v${this.env.WRANGLER_VERSION}`,
445
+ // TODO: (someday): The DevTools protocol should match that of workerd.
446
+ // This could be exposed by the preview API.
447
+ "Protocol-Version": "1.3",
448
+ });
449
+ }
450
+
451
+ if (url.pathname === "/json" || url.pathname === "/json/list") {
452
+ // TODO: can we remove the `/ws` here if we only have a single worker?
453
+ const localHost = `${url.host}/ws`;
454
+ const devtoolsFrontendUrl = `https://devtools.devprod.cloudflare.dev/js_app?theme=systemPreferred&debugger=true&ws=${localHost}`;
455
+
456
+ return Response.json([
457
+ {
458
+ id: this.#inspectorId,
459
+ type: "node", // TODO: can we specify different type?
460
+ description: "workers",
461
+ webSocketDebuggerUrl: `ws://${localHost}`,
462
+ devtoolsFrontendUrl,
463
+ devtoolsFrontendUrlCompat: devtoolsFrontendUrl,
464
+ // Below are fields that are visible in the DevTools UI.
465
+ title: "Cloudflare Worker",
466
+ faviconUrl: "https://workers.cloudflare.com/favicon.ico",
467
+ // url: "http://" + localHost, // looks unnecessary
468
+ },
469
+ ]);
470
+ }
471
+
472
+ return new Response(null, { status: 404 });
473
+ }
474
+
475
+ async handleDevToolsWebSocketUpgradeRequest(req: Request) {
476
+ // Validate `Host` header
477
+ let hostHeader = req.headers.get("Host");
478
+ if (hostHeader == null) return new Response(null, { status: 400 });
479
+ try {
480
+ const host = new URL(`http://${hostHeader}`);
481
+ if (!ALLOWED_HOST_HOSTNAMES.includes(host.hostname)) {
482
+ return new Response("Disallowed `Host` header", { status: 401 });
483
+ }
484
+ } catch {
485
+ return new Response("Expected `Host` header", { status: 400 });
486
+ }
487
+ // Validate `Origin` header
488
+ let originHeader = req.headers.get("Origin");
489
+ if (originHeader === null && !req.headers.has("User-Agent")) {
490
+ // VSCode doesn't send an `Origin` header, but also doesn't send a
491
+ // `User-Agent` header, so allow an empty origin in this case.
492
+ originHeader = "http://localhost";
493
+ }
494
+ if (originHeader === null) {
495
+ return new Response("Expected `Origin` header", { status: 400 });
496
+ }
497
+ try {
498
+ const origin = new URL(originHeader);
499
+ const allowed = ALLOWED_ORIGIN_HOSTNAMES.some((rule) => {
500
+ if (typeof rule === "string") return origin.hostname === rule;
501
+ else return rule.test(origin.hostname);
502
+ });
503
+ if (!allowed) {
504
+ return new Response("Disallowed `Origin` header", { status: 401 });
505
+ }
506
+ } catch {
507
+ return new Response("Expected `Origin` header", { status: 400 });
508
+ }
509
+
510
+ // DevTools attempting to connect
511
+ this.sendDebugLog("DEVTOOLS WEBSOCKET TRYING TO CONNECT");
512
+
513
+ // Delay devtools connection response until we've connected to the runtime inspector server
514
+ await this.websockets.runtimeDeferred.promise;
515
+
516
+ this.sendDebugLog("DEVTOOLS WEBSOCKET CAN NOW CONNECT");
517
+
518
+ assert(
519
+ req.headers.get("Upgrade") === "websocket",
520
+ "Expected DevTools connection to be WebSocket upgrade"
521
+ );
522
+ const { 0: response, 1: devtools } = new WebSocketPair();
523
+ devtools.accept();
524
+
525
+ if (this.websockets.devtools !== undefined) {
526
+ /** We only want to have one active Devtools instance at a time. */
527
+ // TODO(consider): prioritise new websocket over previous
528
+ devtools.close(
529
+ 1013,
530
+ "Too many clients; only one can be connected at a time"
531
+ );
532
+ } else {
533
+ devtools.addEventListener("message", this.handleDevToolsIncomingMessage);
534
+ devtools.addEventListener("close", (event) => {
535
+ this.sendDebugLog(
536
+ "DEVTOOLS WEBSOCKET CLOSED",
537
+ event.code,
538
+ event.reason
539
+ );
540
+
541
+ if (this.websockets.devtools === devtools) {
542
+ this.websockets.devtools = undefined;
543
+ }
544
+ });
545
+ devtools.addEventListener("error", (event) => {
546
+ const error = serialiseError(event.error);
547
+ this.sendDebugLog("DEVTOOLS WEBSOCKET ERROR", error);
548
+
549
+ if (this.websockets.devtools === devtools) {
550
+ this.websockets.devtools = undefined;
551
+ }
552
+ });
553
+
554
+ // Since Wrangler proxies the inspector, reloading Chrome DevTools won't trigger debugger initialisation events (because it's connecting to an extant session).
555
+ // This sends a `Debugger.disable` message to the remote when a new WebSocket connection is initialised,
556
+ // with the assumption that the new connection will shortly send a `Debugger.enable` event and trigger re-initialisation.
557
+ // The key initialisation messages that are needed are the `Debugger.scriptParsed events`.
558
+ this.sendRuntimeMessage({
559
+ id: this.nextCounter(),
560
+ method: "Debugger.disable",
561
+ });
562
+
563
+ this.sendDebugLog("DEVTOOLS WEBSOCKET CONNECTED");
564
+
565
+ // Our patched DevTools are hosted on a `https://` URL. These cannot
566
+ // access `file://` URLs, meaning local source maps cannot be fetched.
567
+ // To get around this, we can rewrite `Debugger.scriptParsed` events to
568
+ // include a special `worker:` scheme for source maps, and respond to
569
+ // `Network.loadNetworkResource` commands for these. Unfortunately, this
570
+ // breaks IDE's built-in debuggers (e.g. VSCode and WebStorm), so we only
571
+ // want to enable this transformation when we detect hosted DevTools has
572
+ // connected. We do this by looking at the WebSocket handshake headers:
573
+ //
574
+ // DevTools
575
+ //
576
+ // Upgrade: websocket
577
+ // Host: localhost:9229
578
+ // (from Chrome) User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36
579
+ // (from Firefox) User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/116.0
580
+ // Origin: https://devtools.devprod.cloudflare.dev
581
+ // ...
582
+ //
583
+ // VSCode
584
+ //
585
+ // Upgrade: websocket
586
+ // Host: localhost
587
+ // ...
588
+ //
589
+ // WebStorm
590
+ //
591
+ // Upgrade: websocket
592
+ // Host: localhost:9229
593
+ // Origin: http://localhost:9229
594
+ // ...
595
+ //
596
+ // From this, we could just use the presence of a `User-Agent` header to
597
+ // determine if DevTools connected, but VSCode/WebStorm could very well
598
+ // add this in future versions. We could also look for an `Origin` header
599
+ // matching the hosted DevTools URL, but this would prevent preview/local
600
+ // versions working. Instead, we look for a browser-like `User-Agent`.
601
+ const userAgent = req.headers.get("User-Agent") ?? "";
602
+ const hasFileSystemAccess = !/mozilla/i.test(userAgent);
603
+
604
+ this.websockets.devtools = devtools;
605
+ this.websockets.devtoolsHasFileSystemAccess = hasFileSystemAccess;
606
+
607
+ this.tryDrainRuntimeMessageBuffer();
608
+ }
609
+
610
+ return new Response(null, { status: 101, webSocket: response });
611
+ }
612
+
613
+ handleDevToolsIncomingMessage = (event: MessageEvent) => {
614
+ assert(
615
+ typeof event.data === "string",
616
+ "Expected devtools incoming message to be of type string"
617
+ );
618
+
619
+ const message = JSON.parse(event.data) as DevToolsCommandRequests;
620
+ this.sendDebugLog("DEVTOOLS INCOMING MESSAGE", message);
621
+
622
+ if (message.method === "Network.loadNetworkResource") {
623
+ return void this.handleDevToolsLoadNetworkResource(message);
624
+ }
625
+
626
+ this.sendRuntimeMessage(JSON.stringify(message));
627
+ };
628
+
629
+ async handleDevToolsLoadNetworkResource(
630
+ message: DevToolsCommandRequest<"Network.loadNetworkResource">
631
+ ) {
632
+ const response = await this.sendProxyControllerRequest({
633
+ type: "load-network-resource",
634
+ url: message.params.url,
635
+ });
636
+ if (response === undefined) {
637
+ this.sendDebugLog(
638
+ `ProxyController could not resolve Network.loadNetworkResource for "${message.params.url}"`
639
+ );
640
+
641
+ // When the ProxyController cannot resolve a resource, let the runtime handle the request
642
+ this.sendRuntimeMessage(JSON.stringify(message));
643
+ } else {
644
+ // this.websockets.devtools can be undefined here
645
+ // the incoming message implies we have a devtools connection, but after
646
+ // the await it could've dropped in which case we can safely not respond
647
+ this.sendDevToolsMessage({
648
+ id: message.id,
649
+ // @ts-expect-error DevTools Protocol type does not match our patched devtools -- result.resource.text was added
650
+ result: { resource: { success: true, text: response } },
651
+ });
652
+ }
653
+ }
654
+
655
+ sendDevToolsMessage(
656
+ message: string | DevToolsCommandResponses | DevToolsEvents
657
+ ) {
658
+ message = typeof message === "string" ? message : JSON.stringify(message);
659
+
660
+ this.sendDebugLog("SEND TO DEVTOOLS", message);
661
+
662
+ this.websockets.devtools?.send(message);
663
+ }
664
+ }