wrangler 0.0.0-e6e1daba → 0.0.0-e70806f1

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 (310) hide show
  1. package/README.md +11 -13
  2. package/bin/wrangler.js +14 -103
  3. package/config-schema.json +2947 -0
  4. package/package.json +194 -194
  5. package/templates/__tests__/tsconfig.json +1 -1
  6. package/templates/checked-fetch.js +11 -4
  7. package/templates/facade.d.ts +7 -2
  8. package/templates/gitignore +0 -4
  9. package/templates/init-tests/test-vitest-new-worker.js +1 -1
  10. package/templates/init-tests/test-vitest-new-worker.ts +1 -1
  11. package/templates/middleware/common.ts +9 -4
  12. package/templates/middleware/loader-modules.ts +94 -44
  13. package/templates/middleware/loader-sw.ts +6 -10
  14. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  15. package/templates/middleware/middleware-miniflare3-json-error.ts +17 -5
  16. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  17. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  18. package/templates/modules-watch-stub.js +4 -0
  19. package/templates/new-worker-scheduled.ts +1 -1
  20. package/templates/new-worker.ts +1 -1
  21. package/templates/pages-dev-pipeline.ts +2 -1
  22. package/templates/pages-dev-util.ts +4 -1
  23. package/templates/pages-shim.ts +0 -3
  24. package/templates/pages-template-plugin.ts +14 -4
  25. package/templates/pages-template-worker.ts +12 -3
  26. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  27. package/templates/startDevWorker/ProxyWorker.ts +334 -0
  28. package/templates/tsconfig.init.json +1 -2
  29. package/templates/tsconfig.json +1 -1
  30. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  31. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  32. package/wrangler-dist/ProxyWorker.js +240 -0
  33. package/wrangler-dist/ProxyWorker.js.map +6 -0
  34. package/wrangler-dist/cli.d.ts +23790 -1052
  35. package/wrangler-dist/cli.js +155835 -98941
  36. package/wrangler-dist/wasm-sync.wasm +0 -0
  37. package/Cloudflare_CA.pem +0 -18
  38. package/import_meta_url.js +0 -3
  39. package/miniflare-config-stubs/.env.empty +0 -0
  40. package/miniflare-config-stubs/package.empty.json +0 -1
  41. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  42. package/miniflare-dist/index.mjs +0 -6368
  43. package/src/__tests__/access.test.ts +0 -25
  44. package/src/__tests__/api-dev.test.ts +0 -238
  45. package/src/__tests__/api-devregistry.test.js +0 -64
  46. package/src/__tests__/api.test.ts +0 -80
  47. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  48. package/src/__tests__/config-cache.test.ts +0 -42
  49. package/src/__tests__/configuration.test.ts +0 -4233
  50. package/src/__tests__/d1/d1.test.ts +0 -82
  51. package/src/__tests__/d1/execute.test.ts +0 -64
  52. package/src/__tests__/d1/migrate.test.ts +0 -155
  53. package/src/__tests__/d1/splitter.test.ts +0 -255
  54. package/src/__tests__/delete.test.ts +0 -266
  55. package/src/__tests__/deployments.test.ts +0 -129
  56. package/src/__tests__/dev.test.tsx +0 -1587
  57. package/src/__tests__/generate.test.ts +0 -238
  58. package/src/__tests__/get-host-from-url.test.ts +0 -16
  59. package/src/__tests__/guess-worker-format.test.ts +0 -120
  60. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  61. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  62. package/src/__tests__/helpers/end-event-loop.ts +0 -6
  63. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  64. package/src/__tests__/helpers/mock-auth-domain.ts +0 -20
  65. package/src/__tests__/helpers/mock-bin.ts +0 -36
  66. package/src/__tests__/helpers/mock-console.ts +0 -106
  67. package/src/__tests__/helpers/mock-dialogs.ts +0 -139
  68. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +0 -25
  69. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -11
  70. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  71. package/src/__tests__/helpers/mock-istty.ts +0 -74
  72. package/src/__tests__/helpers/mock-known-routes.ts +0 -12
  73. package/src/__tests__/helpers/mock-kv.ts +0 -46
  74. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -263
  75. package/src/__tests__/helpers/mock-process.ts +0 -34
  76. package/src/__tests__/helpers/mock-set-timeout.ts +0 -16
  77. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  78. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  79. package/src/__tests__/helpers/msw/blob-worker.cjs +0 -19
  80. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  81. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -93
  82. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -81
  83. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  84. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -60
  85. package/src/__tests__/helpers/msw/handlers/script.ts +0 -56
  86. package/src/__tests__/helpers/msw/handlers/user.ts +0 -52
  87. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -20
  88. package/src/__tests__/helpers/msw/index.ts +0 -50
  89. package/src/__tests__/helpers/msw/read-file-sync.js +0 -61
  90. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  91. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  92. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +0 -28
  93. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  94. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  95. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  96. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  97. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  98. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  99. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  100. package/src/__tests__/https-options.test.ts +0 -163
  101. package/src/__tests__/index.test.ts +0 -274
  102. package/src/__tests__/init.test.ts +0 -3164
  103. package/src/__tests__/jest.setup.ts +0 -175
  104. package/src/__tests__/kv.test.ts +0 -1799
  105. package/src/__tests__/logger.test.ts +0 -141
  106. package/src/__tests__/logout.test.ts +0 -47
  107. package/src/__tests__/metrics.test.ts +0 -493
  108. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  109. package/src/__tests__/middleware.test.ts +0 -815
  110. package/src/__tests__/mtls-certificates.test.ts +0 -585
  111. package/src/__tests__/package-manager.test.ts +0 -353
  112. package/src/__tests__/pages/deployment-list.test.ts +0 -78
  113. package/src/__tests__/pages/functions-build.test.ts +0 -402
  114. package/src/__tests__/pages/pages.test.ts +0 -81
  115. package/src/__tests__/pages/project-create.test.ts +0 -63
  116. package/src/__tests__/pages/project-list.test.ts +0 -108
  117. package/src/__tests__/pages/project-upload.test.ts +0 -481
  118. package/src/__tests__/pages/publish.test.ts +0 -2745
  119. package/src/__tests__/pages-deployment-tail.test.ts +0 -955
  120. package/src/__tests__/parse.test.ts +0 -436
  121. package/src/__tests__/paths.test.ts +0 -39
  122. package/src/__tests__/publish.test.ts +0 -8167
  123. package/src/__tests__/pubsub.test.ts +0 -493
  124. package/src/__tests__/queues.test.ts +0 -529
  125. package/src/__tests__/r2.test.ts +0 -374
  126. package/src/__tests__/route.test.ts +0 -45
  127. package/src/__tests__/secret.test.ts +0 -693
  128. package/src/__tests__/tail.test.ts +0 -958
  129. package/src/__tests__/test-old-node-version.js +0 -31
  130. package/src/__tests__/tsconfig-sanity.ts +0 -12
  131. package/src/__tests__/tsconfig.json +0 -8
  132. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  133. package/src/__tests__/type-generation.test.ts +0 -233
  134. package/src/__tests__/user.test.ts +0 -118
  135. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  136. package/src/__tests__/validate-dev-props.test.ts +0 -56
  137. package/src/__tests__/version.test.ts +0 -35
  138. package/src/__tests__/whoami.test.tsx +0 -172
  139. package/src/__tests__/worker-namespace.test.ts +0 -339
  140. package/src/abort.d.ts +0 -3
  141. package/src/api/dev.ts +0 -328
  142. package/src/api/index.ts +0 -11
  143. package/src/api/mtls-certificate.ts +0 -148
  144. package/src/api/pages/create-worker-bundle-contents.ts +0 -75
  145. package/src/api/pages/index.ts +0 -5
  146. package/src/api/pages/publish.tsx +0 -368
  147. package/src/bundle-reporter.ts +0 -68
  148. package/src/bundle.ts +0 -877
  149. package/src/cfetch/index.ts +0 -158
  150. package/src/cfetch/internal.ts +0 -258
  151. package/src/cli.ts +0 -28
  152. package/src/config/README.md +0 -107
  153. package/src/config/config.ts +0 -282
  154. package/src/config/diagnostics.ts +0 -80
  155. package/src/config/environment.ts +0 -586
  156. package/src/config/index.ts +0 -375
  157. package/src/config/validation-helpers.ts +0 -597
  158. package/src/config/validation.ts +0 -2198
  159. package/src/config-cache.ts +0 -85
  160. package/src/create-worker-preview.ts +0 -293
  161. package/src/create-worker-upload-form.ts +0 -334
  162. package/src/d1/backups.tsx +0 -215
  163. package/src/d1/constants.ts +0 -2
  164. package/src/d1/create.tsx +0 -64
  165. package/src/d1/delete.ts +0 -53
  166. package/src/d1/execute.tsx +0 -354
  167. package/src/d1/formatTimeAgo.ts +0 -14
  168. package/src/d1/index.ts +0 -100
  169. package/src/d1/list.tsx +0 -60
  170. package/src/d1/migrations/apply.tsx +0 -206
  171. package/src/d1/migrations/create.tsx +0 -76
  172. package/src/d1/migrations/helpers.ts +0 -172
  173. package/src/d1/migrations/index.ts +0 -3
  174. package/src/d1/migrations/list.tsx +0 -92
  175. package/src/d1/migrations/options.ts +0 -23
  176. package/src/d1/options.ts +0 -22
  177. package/src/d1/splitter.ts +0 -161
  178. package/src/d1/types.ts +0 -25
  179. package/src/d1/utils.ts +0 -49
  180. package/src/delete.ts +0 -100
  181. package/src/deployments.ts +0 -116
  182. package/src/deprecated/index.ts +0 -144
  183. package/src/dev/dev-vars.ts +0 -39
  184. package/src/dev/dev.tsx +0 -600
  185. package/src/dev/get-local-persistence-path.ts +0 -31
  186. package/src/dev/local.tsx +0 -922
  187. package/src/dev/remote.tsx +0 -632
  188. package/src/dev/start-server.ts +0 -538
  189. package/src/dev/use-esbuild.ts +0 -205
  190. package/src/dev/validate-dev-props.ts +0 -31
  191. package/src/dev-registry.ts +0 -201
  192. package/src/dev.tsx +0 -914
  193. package/src/dialogs.ts +0 -136
  194. package/src/dispatch-namespace.ts +0 -211
  195. package/src/docs/index.ts +0 -97
  196. package/src/durable.ts +0 -102
  197. package/src/entry.ts +0 -327
  198. package/src/environment-variables/factory.ts +0 -88
  199. package/src/environment-variables/misc-variables.ts +0 -30
  200. package/src/errors.ts +0 -11
  201. package/src/generate/index.ts +0 -298
  202. package/src/git-client.ts +0 -135
  203. package/src/global-wrangler-config-path.ts +0 -26
  204. package/src/https-options.ts +0 -127
  205. package/src/index.ts +0 -705
  206. package/src/init.ts +0 -1022
  207. package/src/inspect.ts +0 -782
  208. package/src/intl-polyfill.d.ts +0 -139
  209. package/src/is-ci.ts +0 -14
  210. package/src/is-interactive.ts +0 -16
  211. package/src/jest.d.ts +0 -4
  212. package/src/kv/helpers.ts +0 -430
  213. package/src/kv/index.ts +0 -594
  214. package/src/logger.ts +0 -104
  215. package/src/metrics/index.ts +0 -5
  216. package/src/metrics/metrics-config.ts +0 -239
  217. package/src/metrics/metrics-dispatcher.ts +0 -96
  218. package/src/metrics/metrics-usage-headers.ts +0 -24
  219. package/src/metrics/send-event.ts +0 -98
  220. package/src/miniflare-cli/README.md +0 -30
  221. package/src/miniflare-cli/assets.ts +0 -251
  222. package/src/miniflare-cli/index.ts +0 -210
  223. package/src/miniflare-cli/request-context.ts +0 -40
  224. package/src/miniflare-cli/tsconfig.json +0 -9
  225. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  226. package/src/miniflare-cli/types.ts +0 -11
  227. package/src/module-collection.ts +0 -267
  228. package/src/mtls-certificate/cli.ts +0 -155
  229. package/src/open-in-browser.ts +0 -17
  230. package/src/package-manager.ts +0 -219
  231. package/src/pages/build.ts +0 -232
  232. package/src/pages/buildFunctions.ts +0 -130
  233. package/src/pages/constants.ts +0 -18
  234. package/src/pages/deployment-tails.ts +0 -281
  235. package/src/pages/deployments.tsx +0 -86
  236. package/src/pages/dev.ts +0 -716
  237. package/src/pages/errors.ts +0 -66
  238. package/src/pages/functions/buildPlugin.ts +0 -90
  239. package/src/pages/functions/buildWorker.ts +0 -288
  240. package/src/pages/functions/filepath-routing.test.ts +0 -234
  241. package/src/pages/functions/filepath-routing.ts +0 -189
  242. package/src/pages/functions/identifiers.ts +0 -78
  243. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  244. package/src/pages/functions/routes-consolidation.ts +0 -73
  245. package/src/pages/functions/routes-transformation.test.ts +0 -282
  246. package/src/pages/functions/routes-transformation.ts +0 -115
  247. package/src/pages/functions/routes-validation.test.ts +0 -403
  248. package/src/pages/functions/routes-validation.ts +0 -202
  249. package/src/pages/functions/routes.ts +0 -151
  250. package/src/pages/functions/tsconfig.json +0 -8
  251. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  252. package/src/pages/functions.ts +0 -86
  253. package/src/pages/hash.ts +0 -13
  254. package/src/pages/index.ts +0 -102
  255. package/src/pages/projects.tsx +0 -162
  256. package/src/pages/prompt-select-project.tsx +0 -31
  257. package/src/pages/publish.tsx +0 -276
  258. package/src/pages/types.ts +0 -46
  259. package/src/pages/upload.tsx +0 -449
  260. package/src/pages/utils.ts +0 -23
  261. package/src/parse.ts +0 -308
  262. package/src/paths.ts +0 -71
  263. package/src/proxy.ts +0 -694
  264. package/src/publish/index.ts +0 -274
  265. package/src/publish/publish.ts +0 -1065
  266. package/src/pubsub/index.ts +0 -286
  267. package/src/pubsub/pubsub-commands.ts +0 -623
  268. package/src/queues/cli/commands/consumer/add.ts +0 -65
  269. package/src/queues/cli/commands/consumer/index.ts +0 -19
  270. package/src/queues/cli/commands/consumer/remove.ts +0 -31
  271. package/src/queues/cli/commands/create.ts +0 -25
  272. package/src/queues/cli/commands/delete.ts +0 -26
  273. package/src/queues/cli/commands/index.ts +0 -35
  274. package/src/queues/cli/commands/list.ts +0 -25
  275. package/src/queues/client.ts +0 -135
  276. package/src/queues/utils.ts +0 -18
  277. package/src/r2/constants.ts +0 -4
  278. package/src/r2/helpers.ts +0 -132
  279. package/src/r2/index.ts +0 -289
  280. package/src/routes.ts +0 -140
  281. package/src/secret/index.ts +0 -375
  282. package/src/selfsigned.d.ts +0 -29
  283. package/src/sites.ts +0 -372
  284. package/src/tail/createTail.ts +0 -406
  285. package/src/tail/filters.ts +0 -277
  286. package/src/tail/index.ts +0 -211
  287. package/src/tail/printing.ts +0 -122
  288. package/src/tsconfig-sanity.ts +0 -16
  289. package/src/type-generation.ts +0 -181
  290. package/src/update-check.ts +0 -19
  291. package/src/user/access.ts +0 -68
  292. package/src/user/auth-variables.ts +0 -113
  293. package/src/user/choose-account.tsx +0 -39
  294. package/src/user/generate-auth-url.ts +0 -33
  295. package/src/user/generate-random-state.ts +0 -16
  296. package/src/user/index.ts +0 -2
  297. package/src/user/user.ts +0 -1233
  298. package/src/utils/collectKeyValues.ts +0 -14
  299. package/src/whoami.ts +0 -135
  300. package/src/worker.ts +0 -257
  301. package/src/yargs-types.ts +0 -37
  302. package/src/zones.ts +0 -191
  303. package/templates/__tests__/tsconfig.tsbuildinfo +0 -1
  304. package/templates/d1-beta-facade.js +0 -241
  305. package/templates/first-party-worker-module-facade.ts +0 -19
  306. package/templates/format-dev-errors.ts +0 -34
  307. package/templates/serve-static-assets.ts +0 -66
  308. package/templates/service-bindings-module-facade.js +0 -55
  309. package/templates/service-bindings-sw-facade.js +0 -42
  310. package/templates/tsconfig.tsbuildinfo +0 -1
@@ -1,85 +0,0 @@
1
- import { mkdirSync, readFileSync, rmSync, writeFileSync } from "fs";
2
- import * as path from "path";
3
- import { findUpSync } from "find-up";
4
- import { CI } from "./is-ci";
5
- import isInteractive from "./is-interactive";
6
- import { logger } from "./logger";
7
-
8
- let cacheMessageShown = false;
9
-
10
- let __cacheFolder: string | null | undefined;
11
- function getCacheFolder() {
12
- if (__cacheFolder || __cacheFolder === null) return __cacheFolder;
13
-
14
- const closestNodeModulesDirectory = findUpSync("node_modules", {
15
- type: "directory",
16
- });
17
- __cacheFolder = closestNodeModulesDirectory
18
- ? path.join(closestNodeModulesDirectory, ".cache/wrangler")
19
- : null;
20
-
21
- if (!__cacheFolder) {
22
- logger.debug("No folder available to cache configuration");
23
- }
24
- return __cacheFolder;
25
- }
26
-
27
- const arrayFormatter = new Intl.ListFormat("en", {
28
- style: "long",
29
- type: "conjunction",
30
- });
31
-
32
- function showCacheMessage(fields: string[], folder: string) {
33
- if (!cacheMessageShown && isInteractive() && !CI.isCI()) {
34
- if (fields.length > 0) {
35
- logger.debug(
36
- `Retrieving cached values for ${arrayFormatter.format(
37
- fields
38
- )} from ${path.relative(process.cwd(), folder)}`
39
- );
40
- cacheMessageShown = true;
41
- }
42
- }
43
- }
44
-
45
- export function getConfigCache<T>(fileName: string): Partial<T> {
46
- try {
47
- const cacheFolder = getCacheFolder();
48
- if (cacheFolder) {
49
- const configCacheLocation = path.join(cacheFolder, fileName);
50
- const configCache = JSON.parse(
51
- readFileSync(configCacheLocation, "utf-8")
52
- );
53
- showCacheMessage(Object.keys(configCache), cacheFolder);
54
- return configCache;
55
- } else return {};
56
- } catch (err) {
57
- return {};
58
- }
59
- }
60
-
61
- export function saveToConfigCache<T>(
62
- fileName: string,
63
- newValues: Partial<T>
64
- ): void {
65
- const cacheFolder = getCacheFolder();
66
- if (cacheFolder) {
67
- logger.debug(`Saving to cache: ${JSON.stringify(newValues)}`);
68
- const configCacheLocation = path.join(cacheFolder, fileName);
69
- const existingValues = getConfigCache(fileName);
70
-
71
- mkdirSync(path.dirname(configCacheLocation), { recursive: true });
72
- writeFileSync(
73
- configCacheLocation,
74
- JSON.stringify({ ...existingValues, ...newValues }, null, 2)
75
- );
76
- }
77
- }
78
-
79
- export function purgeConfigCaches() {
80
- const cacheFolder = getCacheFolder();
81
- if (cacheFolder) {
82
- rmSync(cacheFolder, { recursive: true, force: true });
83
- }
84
- __cacheFolder = undefined;
85
- }
@@ -1,293 +0,0 @@
1
- import { URL } from "node:url";
2
- import { fetch } from "undici";
3
- import { fetchResult } from "./cfetch";
4
- import { createWorkerUploadForm } from "./create-worker-upload-form";
5
- import { logger } from "./logger";
6
- import { parseJSON } from "./parse";
7
- import { getAccessToken } from "./user/access";
8
- import type { CfAccount, CfWorkerContext, CfWorkerInit } from "./worker";
9
- import type { HeadersInit } from "undici";
10
-
11
- /**
12
- * A Preview Session on the edge
13
- */
14
- export interface CfPreviewSession {
15
- /**
16
- * A randomly generated id for this session
17
- */
18
- id: string;
19
- /**
20
- * A value to use when creating a worker preview under a session
21
- */
22
- value: string;
23
- /**
24
- * The host where the session is available.
25
- */
26
- host: string;
27
- /**
28
- * A websocket url to a DevTools inspector.
29
- *
30
- * Workers does not have a fully-featured implementation
31
- * of the Chrome DevTools protocol, but supports the following:
32
- * * `console.log()` output.
33
- * * `Error` stack traces.
34
- * * `fetch()` events.
35
- *
36
- * There is no support for breakpoints, but we want to implement
37
- * this eventually.
38
- *
39
- * @link https://chromedevtools.github.io/devtools-protocol/
40
- */
41
- inspectorUrl: URL;
42
- /**
43
- * A url to prewarm the preview session.
44
- *
45
- * @example
46
- * fetch(prewarmUrl, { method: 'POST' })
47
- */
48
- prewarmUrl: URL;
49
- }
50
-
51
- /**
52
- * A preview mode.
53
- *
54
- * * If true, then using a `workers.dev` subdomain.
55
- * * Otherwise, a list of routes under a single zone.
56
- */
57
- type CfPreviewMode = { workers_dev: boolean } | { routes: string[] };
58
-
59
- /**
60
- * A preview token.
61
- */
62
- export interface CfPreviewToken {
63
- /**
64
- * The header value required to trigger a preview.
65
- *
66
- * @example
67
- * const headers = { 'cf-workers-preview-token': value }
68
- * const response = await fetch('https://' + host, { headers })
69
- */
70
- value: string;
71
- /**
72
- * The host where the preview is available.
73
- */
74
- host: string;
75
- /**
76
- * A websocket url to a DevTools inspector.
77
- *
78
- * Workers does not have a fully-featured implementation
79
- * of the Chrome DevTools protocol, but supports the following:
80
- * * `console.log()` output.
81
- * * `Error` stack traces.
82
- * * `fetch()` events.
83
- *
84
- * There is no support for breakpoints, but we want to implement
85
- * this eventually.
86
- *
87
- * @link https://chromedevtools.github.io/devtools-protocol/
88
- */
89
- inspectorUrl: URL;
90
- /**
91
- * A url to prewarm the preview session.
92
- *
93
- * @example
94
- * fetch(prewarmUrl, { method: 'POST',
95
- * headers: {
96
- * "cf-workers-preview-token": (preview)token.value,
97
- * }
98
- * })
99
- */
100
- prewarmUrl: URL;
101
- }
102
-
103
- // Credit: https://stackoverflow.com/a/2117523
104
- function randomId(): string {
105
- return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function (c) {
106
- const r = (Math.random() * 16) | 0,
107
- v = c == "x" ? r : (r & 0x3) | 0x8;
108
- return v.toString(16);
109
- });
110
- }
111
-
112
- // URLs are often relative to the zone. Sometimes the base zone
113
- // will be grey-clouded, and so the host must be swapped out for
114
- // the worker route host, which is more likely to be orange-clouded
115
- function switchHost(originalUrl: string, host?: string): URL {
116
- const url = new URL(originalUrl);
117
- url.hostname = host ?? url.hostname;
118
- return url;
119
- }
120
- /**
121
- * Generates a preview session token.
122
- */
123
- export async function createPreviewSession(
124
- account: CfAccount,
125
- ctx: CfWorkerContext,
126
- abortSignal: AbortSignal
127
- ): Promise<CfPreviewSession> {
128
- const { accountId } = account;
129
- const initUrl = ctx.zone
130
- ? `/zones/${ctx.zone}/workers/edge-preview`
131
- : `/accounts/${accountId}/workers/subdomain/edge-preview`;
132
-
133
- const { exchange_url } = await fetchResult<{ exchange_url: string }>(
134
- initUrl,
135
- undefined,
136
- undefined,
137
- abortSignal
138
- );
139
-
140
- const switchedExchangeUrl = switchHost(exchange_url, ctx.host).toString();
141
-
142
- logger.debug(`-- START EXCHANGE API REQUEST: GET ${switchedExchangeUrl}`);
143
- logger.debug("-- END EXCHANGE API REQUEST");
144
- const exchangeResponse = await fetch(switchedExchangeUrl, {
145
- signal: abortSignal,
146
- });
147
- const bodyText = await exchangeResponse.text();
148
- logger.debug(
149
- "-- START EXCHANGE API RESPONSE:",
150
- exchangeResponse.statusText,
151
- exchangeResponse.status
152
- );
153
- logger.debug("HEADERS:", JSON.stringify(exchangeResponse.headers, null, 2));
154
- logger.debug("RESPONSE:", bodyText);
155
- logger.debug("-- END EXCHANGE API RESPONSE");
156
-
157
- const { inspector_websocket, prewarm, token } = parseJSON<{
158
- inspector_websocket: string;
159
- token: string;
160
- prewarm: string;
161
- }>(bodyText);
162
- const inspector = new URL(inspector_websocket);
163
- inspector.searchParams.append("cf_workers_preview_token", token);
164
-
165
- return {
166
- id: randomId(),
167
- value: token,
168
- host: ctx.host ?? inspector.host,
169
- inspectorUrl: switchHost(inspector.href, ctx.host),
170
- prewarmUrl: switchHost(prewarm, ctx.host),
171
- };
172
- }
173
-
174
- /**
175
- * Creates a preview token.
176
- */
177
- async function createPreviewToken(
178
- account: CfAccount,
179
- worker: CfWorkerInit,
180
- ctx: CfWorkerContext,
181
- session: CfPreviewSession,
182
- abortSignal: AbortSignal
183
- ): Promise<CfPreviewToken> {
184
- const { value, host, inspectorUrl, prewarmUrl } = session;
185
- const { accountId } = account;
186
- const scriptId = worker.name || (ctx.zone ? session.id : host.split(".")[0]);
187
- const url =
188
- ctx.env && !ctx.legacyEnv
189
- ? `/accounts/${accountId}/workers/services/${scriptId}/environments/${ctx.env}/edge-preview`
190
- : `/accounts/${accountId}/workers/scripts/${scriptId}/edge-preview`;
191
-
192
- const mode: CfPreviewMode = ctx.zone
193
- ? {
194
- routes: ctx.routes
195
- ? // extract all the route patterns
196
- ctx.routes.map((route) => {
197
- if (typeof route === "string") {
198
- return route;
199
- }
200
- if (route.custom_domain) {
201
- return `${route.pattern}/*`;
202
- }
203
- return route.pattern;
204
- })
205
- : // if there aren't any patterns, then just match on all routes
206
- ["*/*"],
207
- }
208
- : { workers_dev: true };
209
-
210
- const formData = createWorkerUploadForm(worker);
211
- formData.set("wrangler-session-config", JSON.stringify(mode));
212
-
213
- const { preview_token } = await fetchResult<{ preview_token: string }>(
214
- url,
215
- {
216
- method: "POST",
217
- body: formData,
218
- headers: {
219
- "cf-preview-upload-config-token": value,
220
- },
221
- },
222
- undefined,
223
- abortSignal
224
- );
225
-
226
- return {
227
- value: preview_token,
228
- host:
229
- ctx.host ??
230
- (worker.name
231
- ? `${
232
- worker.name
233
- // TODO: this should also probably have the env prefix
234
- // but it doesn't appear to work yet, instead giving us the
235
- // "There is nothing here yet" screen
236
- // ctx.env && !ctx.legacyEnv
237
- // ? `${ctx.env}.${worker.name}`
238
- // : worker.name
239
- }.${host.split(".").slice(1).join(".")}`
240
- : host),
241
-
242
- inspectorUrl,
243
- prewarmUrl,
244
- };
245
- }
246
-
247
- /**
248
- * A stub to create a Cloudflare Worker preview.
249
- *
250
- * @example
251
- * const {value, host} = await createWorker(init, acct);
252
- */
253
- export async function createWorkerPreview(
254
- init: CfWorkerInit,
255
- account: CfAccount,
256
- ctx: CfWorkerContext,
257
- session: CfPreviewSession,
258
- abortSignal: AbortSignal
259
- ): Promise<CfPreviewToken> {
260
- const token = await createPreviewToken(
261
- account,
262
- init,
263
- ctx,
264
- session,
265
- abortSignal
266
- );
267
- const accessToken = await getAccessToken(token.prewarmUrl.hostname);
268
-
269
- const headers: HeadersInit = { "cf-workers-preview-token": token.value };
270
- if (accessToken) {
271
- headers.cookie = `CF_Authorization=${accessToken}`;
272
- }
273
-
274
- // fire and forget the prewarm call
275
- fetch(token.prewarmUrl.href, {
276
- method: "POST",
277
- signal: abortSignal,
278
- headers,
279
- }).then(
280
- (response) => {
281
- if (!response.ok) {
282
- logger.warn("worker failed to prewarm: ", response.statusText);
283
- }
284
- },
285
- (err) => {
286
- if ((err as { code: string }).code !== "ABORT_ERR") {
287
- logger.warn("worker failed to prewarm: ", err);
288
- }
289
- }
290
- );
291
-
292
- return token;
293
- }
@@ -1,334 +0,0 @@
1
- import { readFileSync } from "node:fs";
2
- import { FormData, File } from "undici";
3
- import type {
4
- CfWorkerInit,
5
- CfModuleType,
6
- CfDurableObjectMigrations,
7
- } from "./worker.js";
8
-
9
- export function toMimeType(type: CfModuleType): string {
10
- switch (type) {
11
- case "esm":
12
- return "application/javascript+module";
13
- case "commonjs":
14
- return "application/javascript";
15
- case "compiled-wasm":
16
- return "application/wasm";
17
- case "buffer":
18
- return "application/octet-stream";
19
- case "text":
20
- return "text/plain";
21
- default:
22
- throw new TypeError("Unsupported module: " + type);
23
- }
24
- }
25
-
26
- type WorkerMetadataBinding =
27
- // If you add any new binding types here, also add it to safeBindings
28
- // under validateUnsafeBinding in config/validation.ts
29
- | { type: "plain_text"; name: string; text: string }
30
- | { type: "json"; name: string; json: unknown }
31
- | { type: "wasm_module"; name: string; part: string }
32
- | { type: "text_blob"; name: string; part: string }
33
- | { type: "data_blob"; name: string; part: string }
34
- | { type: "kv_namespace"; name: string; namespace_id: string }
35
- | {
36
- type: "durable_object_namespace";
37
- name: string;
38
- class_name: string;
39
- script_name?: string;
40
- environment?: string;
41
- }
42
- | { type: "queue"; name: string; queue_name: string }
43
- | { type: "r2_bucket"; name: string; bucket_name: string }
44
- | { type: "d1"; name: string; id: string; internalEnv?: string }
45
- | { type: "service"; name: string; service: string; environment?: string }
46
- | { type: "analytics_engine"; name: string; dataset?: string }
47
- | { type: "dispatch_namespace"; name: string; namespace: string }
48
- | { type: "mtls_certificate"; name: string; certificate_id: string }
49
- | {
50
- type: "logfwdr";
51
- name: string;
52
- destination: string;
53
- };
54
-
55
- export interface WorkerMetadata {
56
- /** The name of the entry point module. Only exists when the worker is in the ES module format */
57
- main_module?: string;
58
- /** The name of the entry point module. Only exists when the worker is in the service-worker format */
59
- body_part?: string;
60
- compatibility_date?: string;
61
- compatibility_flags?: string[];
62
- usage_model?: "bundled" | "unbound";
63
- migrations?: CfDurableObjectMigrations;
64
- capnp_schema?: string;
65
- bindings: WorkerMetadataBinding[];
66
- keep_bindings?: WorkerMetadataBinding["type"][];
67
- logpush?: boolean;
68
- }
69
-
70
- /**
71
- * Creates a `FormData` upload from a `CfWorkerInit`.
72
- */
73
- export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
74
- const formData = new FormData();
75
- const {
76
- main,
77
- bindings,
78
- migrations,
79
- usage_model,
80
- compatibility_date,
81
- compatibility_flags,
82
- keepVars,
83
- logpush,
84
- } = worker;
85
-
86
- let { modules } = worker;
87
-
88
- const metadataBindings: WorkerMetadata["bindings"] = [];
89
-
90
- Object.entries(bindings.vars || {})?.forEach(([key, value]) => {
91
- if (typeof value === "string") {
92
- metadataBindings.push({ name: key, type: "plain_text", text: value });
93
- } else {
94
- metadataBindings.push({ name: key, type: "json", json: value });
95
- }
96
- });
97
-
98
- bindings.kv_namespaces?.forEach(({ id, binding }) => {
99
- metadataBindings.push({
100
- name: binding,
101
- type: "kv_namespace",
102
- namespace_id: id,
103
- });
104
- });
105
-
106
- bindings.durable_objects?.bindings.forEach(
107
- ({ name, class_name, script_name, environment }) => {
108
- metadataBindings.push({
109
- name,
110
- type: "durable_object_namespace",
111
- class_name: class_name,
112
- ...(script_name && { script_name }),
113
- ...(environment && { environment }),
114
- });
115
- }
116
- );
117
-
118
- bindings.queues?.forEach(({ binding, queue_name }) => {
119
- metadataBindings.push({
120
- type: "queue",
121
- name: binding,
122
- queue_name,
123
- });
124
- });
125
-
126
- bindings.r2_buckets?.forEach(({ binding, bucket_name }) => {
127
- metadataBindings.push({
128
- name: binding,
129
- type: "r2_bucket",
130
- bucket_name,
131
- });
132
- });
133
-
134
- bindings.d1_databases?.forEach(
135
- ({ binding, database_id, database_internal_env }) => {
136
- metadataBindings.push({
137
- name: binding,
138
- type: "d1",
139
- id: database_id,
140
- internalEnv: database_internal_env,
141
- });
142
- }
143
- );
144
-
145
- bindings.services?.forEach(({ binding, service, environment }) => {
146
- metadataBindings.push({
147
- name: binding,
148
- type: "service",
149
- service,
150
- ...(environment && { environment }),
151
- });
152
- });
153
-
154
- bindings.analytics_engine_datasets?.forEach(({ binding, dataset }) => {
155
- metadataBindings.push({
156
- name: binding,
157
- type: "analytics_engine",
158
- dataset,
159
- });
160
- });
161
-
162
- bindings.dispatch_namespaces?.forEach(({ binding, namespace }) => {
163
- metadataBindings.push({
164
- name: binding,
165
- type: "dispatch_namespace",
166
- namespace,
167
- });
168
- });
169
-
170
- bindings.mtls_certificates?.forEach(({ binding, certificate_id }) => {
171
- metadataBindings.push({
172
- name: binding,
173
- type: "mtls_certificate",
174
- certificate_id,
175
- });
176
- });
177
-
178
- bindings.logfwdr?.bindings.forEach(({ name, destination }) => {
179
- metadataBindings.push({
180
- name: name,
181
- type: "logfwdr",
182
- destination,
183
- });
184
- });
185
-
186
- for (const [name, filePath] of Object.entries(bindings.wasm_modules || {})) {
187
- metadataBindings.push({
188
- name,
189
- type: "wasm_module",
190
- part: name,
191
- });
192
-
193
- formData.set(
194
- name,
195
- new File([readFileSync(filePath)], filePath, {
196
- type: "application/wasm",
197
- })
198
- );
199
- }
200
-
201
- for (const [name, filePath] of Object.entries(bindings.text_blobs || {})) {
202
- metadataBindings.push({
203
- name,
204
- type: "text_blob",
205
- part: name,
206
- });
207
-
208
- if (name !== "__STATIC_CONTENT_MANIFEST") {
209
- formData.set(
210
- name,
211
- new File([readFileSync(filePath)], filePath, {
212
- type: "text/plain",
213
- })
214
- );
215
- }
216
- }
217
-
218
- for (const [name, filePath] of Object.entries(bindings.data_blobs || {})) {
219
- metadataBindings.push({
220
- name,
221
- type: "data_blob",
222
- part: name,
223
- });
224
-
225
- formData.set(
226
- name,
227
- new File([readFileSync(filePath)], filePath, {
228
- type: "application/octet-stream",
229
- })
230
- );
231
- }
232
-
233
- if (main.type === "commonjs") {
234
- // This is a service-worker format worker.
235
- for (const module of Object.values([...(modules || [])])) {
236
- if (module.name === "__STATIC_CONTENT_MANIFEST") {
237
- // Add the manifest to the form data.
238
- formData.set(
239
- module.name,
240
- new File([module.content], module.name, {
241
- type: "text/plain",
242
- })
243
- );
244
- // And then remove it from the modules collection
245
- modules = modules?.filter((m) => m !== module);
246
- } else if (
247
- module.type === "compiled-wasm" ||
248
- module.type === "text" ||
249
- module.type === "buffer"
250
- ) {
251
- // Convert all wasm/text/data modules into `wasm_module`/`text_blob`/`data_blob` bindings.
252
- // The "name" of the module is a file path. We use it
253
- // to instead be a "part" of the body, and a reference
254
- // that we can use inside our source. This identifier has to be a valid
255
- // JS identifier, so we replace all non alphanumeric characters
256
- // with an underscore.
257
- const name = module.name.replace(/[^a-zA-Z0-9_$]/g, "_");
258
- metadataBindings.push({
259
- name,
260
- type:
261
- module.type === "compiled-wasm"
262
- ? "wasm_module"
263
- : module.type === "text"
264
- ? "text_blob"
265
- : "data_blob",
266
- part: name,
267
- });
268
-
269
- // Add the module to the form data.
270
- formData.set(
271
- name,
272
- new File([module.content], module.name, {
273
- type:
274
- module.type === "compiled-wasm"
275
- ? "application/wasm"
276
- : module.type === "text"
277
- ? "text/plain"
278
- : "application/octet-stream",
279
- })
280
- );
281
- // And then remove it from the modules collection
282
- modules = modules?.filter((m) => m !== module);
283
- }
284
- }
285
- }
286
-
287
- if (bindings.unsafe) {
288
- // @ts-expect-error unsafe bindings don't need to match a specific type here
289
- metadataBindings.push(...bindings.unsafe);
290
- }
291
-
292
- const metadata: WorkerMetadata = {
293
- ...(main.type !== "commonjs"
294
- ? { main_module: main.name }
295
- : { body_part: main.name }),
296
- bindings: metadataBindings,
297
- ...(compatibility_date && { compatibility_date }),
298
- ...(compatibility_flags && { compatibility_flags }),
299
- ...(usage_model && { usage_model }),
300
- ...(migrations && { migrations }),
301
- capnp_schema: bindings.logfwdr?.schema,
302
- ...(keepVars && { keep_bindings: ["plain_text", "json"] }),
303
- ...(logpush !== undefined && { logpush }),
304
- };
305
-
306
- formData.set("metadata", JSON.stringify(metadata));
307
-
308
- if (main.type === "commonjs" && modules && modules.length > 0) {
309
- throw new TypeError(
310
- "More than one module can only be specified when type = 'esm'"
311
- );
312
- }
313
-
314
- for (const module of [main].concat(modules || [])) {
315
- formData.set(
316
- module.name,
317
- new File([module.content], module.name, {
318
- type: toMimeType(module.type ?? main.type ?? "esm"),
319
- })
320
- );
321
- }
322
-
323
- if (bindings.logfwdr && bindings.logfwdr.schema) {
324
- const filePath = bindings.logfwdr.schema;
325
- formData.set(
326
- filePath,
327
- new File([readFileSync(filePath)], filePath, {
328
- type: "application/octet-stream",
329
- })
330
- );
331
- }
332
-
333
- return formData;
334
- }