wrangler 0.0.0-e452a35 → 0.0.0-e4ca780f

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