wrangler 0.0.0-e1c2f5b9 → 0.0.0-e1d2fd668

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 (292) hide show
  1. package/README.md +17 -15
  2. package/bin/wrangler.js +14 -103
  3. package/config-schema.json +3126 -0
  4. package/package.json +197 -194
  5. package/templates/__tests__/tsconfig.json +1 -1
  6. package/templates/checked-fetch.js +19 -6
  7. package/templates/facade.d.ts +7 -2
  8. package/templates/gitignore +2 -3
  9. package/templates/init-tests/test-vitest-new-worker.js +1 -1
  10. package/templates/init-tests/test-vitest-new-worker.ts +2 -2
  11. package/templates/middleware/common.ts +9 -4
  12. package/templates/middleware/loader-modules.ts +94 -42
  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-mock-analytics-engine.d.ts +3 -0
  17. package/templates/middleware/middleware-mock-analytics-engine.ts +30 -0
  18. package/templates/middleware/middleware-scheduled.ts +15 -1
  19. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  20. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  21. package/templates/modules-watch-stub.js +4 -0
  22. package/templates/new-worker-scheduled.ts +1 -1
  23. package/templates/new-worker.ts +4 -1
  24. package/templates/pages-dev-pipeline.ts +2 -1
  25. package/templates/pages-dev-util.ts +4 -1
  26. package/templates/pages-shim.ts +0 -3
  27. package/templates/pages-template-plugin.ts +32 -13
  28. package/templates/pages-template-worker.ts +12 -3
  29. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  30. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  31. package/templates/tsconfig.init.json +5 -89
  32. package/templates/tsconfig.json +1 -1
  33. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  34. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  35. package/wrangler-dist/ProxyWorker.js +241 -0
  36. package/wrangler-dist/ProxyWorker.js.map +6 -0
  37. package/wrangler-dist/cli.d.ts +26117 -517
  38. package/wrangler-dist/cli.js +173803 -121437
  39. package/wrangler-dist/wasm-sync.wasm +0 -0
  40. package/Cloudflare_CA.pem +0 -18
  41. package/import_meta_url.js +0 -3
  42. package/miniflare-config-stubs/.env.empty +0 -0
  43. package/miniflare-config-stubs/package.empty.json +0 -1
  44. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  45. package/miniflare-dist/index.mjs +0 -6364
  46. package/src/__tests__/access.test.ts +0 -25
  47. package/src/__tests__/api-dev.test.ts +0 -238
  48. package/src/__tests__/api-devregistry.test.js +0 -64
  49. package/src/__tests__/api.test.ts +0 -80
  50. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  51. package/src/__tests__/config-cache.test.ts +0 -42
  52. package/src/__tests__/configuration.test.ts +0 -4163
  53. package/src/__tests__/d1.test.ts +0 -123
  54. package/src/__tests__/delete.test.ts +0 -263
  55. package/src/__tests__/deployments.test.ts +0 -105
  56. package/src/__tests__/dev.test.tsx +0 -1586
  57. package/src/__tests__/dialogs.test.tsx +0 -40
  58. package/src/__tests__/generate.test.ts +0 -235
  59. package/src/__tests__/get-host-from-url.test.ts +0 -16
  60. package/src/__tests__/guess-worker-format.test.ts +0 -85
  61. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  62. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  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-cfetch.ts +0 -277
  67. package/src/__tests__/helpers/mock-console.ts +0 -106
  68. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  69. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -8
  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 -7
  73. package/src/__tests__/helpers/mock-kv.ts +0 -33
  74. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -271
  75. package/src/__tests__/helpers/mock-process.ts +0 -34
  76. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  77. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  78. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  79. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -59
  80. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -104
  81. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  82. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -80
  83. package/src/__tests__/helpers/msw/handlers/script.ts +0 -75
  84. package/src/__tests__/helpers/msw/handlers/user.ts +0 -63
  85. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -22
  86. package/src/__tests__/helpers/msw/index.ts +0 -21
  87. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  88. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  89. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  90. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  91. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  92. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  93. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  94. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  95. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  96. package/src/__tests__/https-options.test.ts +0 -163
  97. package/src/__tests__/index.test.ts +0 -268
  98. package/src/__tests__/init.test.ts +0 -3094
  99. package/src/__tests__/jest.setup.ts +0 -203
  100. package/src/__tests__/kv.test.ts +0 -1786
  101. package/src/__tests__/logger.test.ts +0 -141
  102. package/src/__tests__/logout.test.ts +0 -47
  103. package/src/__tests__/metrics.test.ts +0 -495
  104. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  105. package/src/__tests__/middleware.test.ts +0 -750
  106. package/src/__tests__/package-manager.test.ts +0 -353
  107. package/src/__tests__/pages-deployment-tail.test.ts +0 -884
  108. package/src/__tests__/pages.test.ts +0 -2443
  109. package/src/__tests__/parse.test.ts +0 -330
  110. package/src/__tests__/paths.test.ts +0 -39
  111. package/src/__tests__/publish.test.ts +0 -7757
  112. package/src/__tests__/pubsub.test.ts +0 -490
  113. package/src/__tests__/queues.test.ts +0 -522
  114. package/src/__tests__/r2.test.ts +0 -393
  115. package/src/__tests__/route.test.ts +0 -45
  116. package/src/__tests__/secret.test.ts +0 -694
  117. package/src/__tests__/tail.test.ts +0 -899
  118. package/src/__tests__/test-old-node-version.js +0 -31
  119. package/src/__tests__/tsconfig-sanity.ts +0 -12
  120. package/src/__tests__/tsconfig.json +0 -8
  121. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  122. package/src/__tests__/type-generation.test.ts +0 -233
  123. package/src/__tests__/user.test.ts +0 -129
  124. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  125. package/src/__tests__/validate-dev-props.test.ts +0 -56
  126. package/src/__tests__/version.test.ts +0 -35
  127. package/src/__tests__/whoami.test.tsx +0 -278
  128. package/src/__tests__/worker-namespace.test.ts +0 -326
  129. package/src/abort.d.ts +0 -3
  130. package/src/api/dev.ts +0 -218
  131. package/src/api/index.ts +0 -2
  132. package/src/bundle-reporter.tsx +0 -68
  133. package/src/bundle.ts +0 -823
  134. package/src/cfetch/index.ts +0 -158
  135. package/src/cfetch/internal.ts +0 -261
  136. package/src/cli.ts +0 -28
  137. package/src/config/README.md +0 -107
  138. package/src/config/config.ts +0 -275
  139. package/src/config/diagnostics.ts +0 -80
  140. package/src/config/environment.ts +0 -577
  141. package/src/config/index.ts +0 -358
  142. package/src/config/validation-helpers.ts +0 -597
  143. package/src/config/validation.ts +0 -2151
  144. package/src/config-cache.ts +0 -85
  145. package/src/create-worker-preview.ts +0 -282
  146. package/src/create-worker-upload-form.ts +0 -325
  147. package/src/d1/backups.tsx +0 -223
  148. package/src/d1/constants.ts +0 -2
  149. package/src/d1/create.tsx +0 -63
  150. package/src/d1/delete.tsx +0 -56
  151. package/src/d1/execute.tsx +0 -352
  152. package/src/d1/formatTimeAgo.ts +0 -14
  153. package/src/d1/index.ts +0 -101
  154. package/src/d1/list.tsx +0 -48
  155. package/src/d1/migrations/apply.tsx +0 -196
  156. package/src/d1/migrations/create.tsx +0 -77
  157. package/src/d1/migrations/helpers.ts +0 -147
  158. package/src/d1/migrations/index.tsx +0 -3
  159. package/src/d1/migrations/list.tsx +0 -79
  160. package/src/d1/migrations/options.ts +0 -18
  161. package/src/d1/options.ts +0 -22
  162. package/src/d1/types.tsx +0 -24
  163. package/src/d1/utils.ts +0 -48
  164. package/src/delete.ts +0 -108
  165. package/src/deployments.ts +0 -83
  166. package/src/deprecated/index.ts +0 -145
  167. package/src/dev/dev-vars.ts +0 -39
  168. package/src/dev/dev.tsx +0 -614
  169. package/src/dev/get-local-persistence-path.tsx +0 -31
  170. package/src/dev/local.tsx +0 -932
  171. package/src/dev/remote.tsx +0 -603
  172. package/src/dev/start-server.ts +0 -543
  173. package/src/dev/use-esbuild.ts +0 -204
  174. package/src/dev/validate-dev-props.ts +0 -31
  175. package/src/dev-registry.tsx +0 -201
  176. package/src/dev.tsx +0 -949
  177. package/src/dialogs.tsx +0 -168
  178. package/src/dispatch-namespace.ts +0 -207
  179. package/src/docs/index.ts +0 -97
  180. package/src/durable.ts +0 -102
  181. package/src/entry.ts +0 -329
  182. package/src/environment-variables/factory.ts +0 -88
  183. package/src/environment-variables/misc-variables.ts +0 -30
  184. package/src/errors.ts +0 -11
  185. package/src/generate/index.ts +0 -300
  186. package/src/git-client.ts +0 -135
  187. package/src/global-wrangler-config-path.ts +0 -26
  188. package/src/https-options.ts +0 -127
  189. package/src/index.tsx +0 -694
  190. package/src/init.ts +0 -1025
  191. package/src/inspect.ts +0 -767
  192. package/src/intl-polyfill.d.ts +0 -139
  193. package/src/is-ci.ts +0 -14
  194. package/src/is-interactive.ts +0 -16
  195. package/src/jest.d.ts +0 -4
  196. package/src/kv/helpers.ts +0 -430
  197. package/src/kv/index.ts +0 -596
  198. package/src/logger.ts +0 -92
  199. package/src/metrics/index.ts +0 -5
  200. package/src/metrics/metrics-config.ts +0 -239
  201. package/src/metrics/metrics-dispatcher.ts +0 -96
  202. package/src/metrics/metrics-usage-headers.ts +0 -24
  203. package/src/metrics/send-event.ts +0 -97
  204. package/src/miniflare-cli/README.md +0 -30
  205. package/src/miniflare-cli/assets.ts +0 -250
  206. package/src/miniflare-cli/index.ts +0 -210
  207. package/src/miniflare-cli/request-context.ts +0 -40
  208. package/src/miniflare-cli/tsconfig.json +0 -9
  209. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  210. package/src/miniflare-cli/types.ts +0 -11
  211. package/src/module-collection.ts +0 -267
  212. package/src/open-in-browser.ts +0 -17
  213. package/src/package-manager.ts +0 -219
  214. package/src/pages/build.tsx +0 -270
  215. package/src/pages/constants.ts +0 -18
  216. package/src/pages/deployment-tails.tsx +0 -284
  217. package/src/pages/deployments.tsx +0 -84
  218. package/src/pages/dev.tsx +0 -710
  219. package/src/pages/errors.ts +0 -66
  220. package/src/pages/functions/buildPlugin.ts +0 -107
  221. package/src/pages/functions/buildWorker.ts +0 -166
  222. package/src/pages/functions/filepath-routing.test.ts +0 -234
  223. package/src/pages/functions/filepath-routing.ts +0 -189
  224. package/src/pages/functions/identifiers.ts +0 -78
  225. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  226. package/src/pages/functions/routes-consolidation.ts +0 -73
  227. package/src/pages/functions/routes-transformation.test.ts +0 -282
  228. package/src/pages/functions/routes-transformation.ts +0 -115
  229. package/src/pages/functions/routes-validation.test.ts +0 -403
  230. package/src/pages/functions/routes-validation.ts +0 -202
  231. package/src/pages/functions/routes.ts +0 -151
  232. package/src/pages/functions/tsconfig.json +0 -8
  233. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  234. package/src/pages/functions.tsx +0 -82
  235. package/src/pages/hash.tsx +0 -13
  236. package/src/pages/index.tsx +0 -102
  237. package/src/pages/projects.tsx +0 -169
  238. package/src/pages/prompt-select-project.tsx +0 -31
  239. package/src/pages/publish.tsx +0 -461
  240. package/src/pages/types.ts +0 -41
  241. package/src/pages/upload.tsx +0 -447
  242. package/src/pages/utils.ts +0 -23
  243. package/src/parse.ts +0 -286
  244. package/src/paths.ts +0 -71
  245. package/src/proxy.ts +0 -694
  246. package/src/publish/index.ts +0 -270
  247. package/src/publish/publish.ts +0 -1036
  248. package/src/pubsub/index.ts +0 -286
  249. package/src/pubsub/pubsub-commands.tsx +0 -624
  250. package/src/queues/cli/commands/consumer/add.ts +0 -71
  251. package/src/queues/cli/commands/consumer/index.ts +0 -22
  252. package/src/queues/cli/commands/consumer/remove.ts +0 -38
  253. package/src/queues/cli/commands/create.ts +0 -25
  254. package/src/queues/cli/commands/delete.ts +0 -26
  255. package/src/queues/cli/commands/index.ts +0 -36
  256. package/src/queues/cli/commands/list.ts +0 -25
  257. package/src/queues/client.ts +0 -135
  258. package/src/queues/utils.ts +0 -18
  259. package/src/r2/constants.ts +0 -4
  260. package/src/r2/helpers.ts +0 -131
  261. package/src/r2/index.ts +0 -289
  262. package/src/routes.ts +0 -140
  263. package/src/secret/index.ts +0 -379
  264. package/src/selfsigned.d.ts +0 -29
  265. package/src/sites.tsx +0 -372
  266. package/src/tail/createTail.ts +0 -379
  267. package/src/tail/filters.ts +0 -277
  268. package/src/tail/index.ts +0 -214
  269. package/src/tail/printing.ts +0 -107
  270. package/src/tsconfig-sanity.ts +0 -16
  271. package/src/type-generation.ts +0 -181
  272. package/src/update-check.ts +0 -19
  273. package/src/user/access.ts +0 -68
  274. package/src/user/auth-variables.ts +0 -113
  275. package/src/user/choose-account.tsx +0 -69
  276. package/src/user/generate-auth-url.ts +0 -33
  277. package/src/user/generate-random-state.ts +0 -16
  278. package/src/user/index.ts +0 -2
  279. package/src/user/user.tsx +0 -1238
  280. package/src/utils/collectKeyValues.ts +0 -14
  281. package/src/whoami.tsx +0 -169
  282. package/src/worker.ts +0 -251
  283. package/src/yargs-types.ts +0 -24
  284. package/src/zones.ts +0 -191
  285. package/templates/__tests__/tsconfig.tsbuildinfo +0 -1
  286. package/templates/d1-beta-facade.js +0 -205
  287. package/templates/first-party-worker-module-facade.ts +0 -19
  288. package/templates/format-dev-errors.ts +0 -33
  289. package/templates/serve-static-assets.ts +0 -65
  290. package/templates/service-bindings-module-facade.js +0 -54
  291. package/templates/service-bindings-sw-facade.js +0 -42
  292. 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,282 +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
- /**
113
- * Generates a preview session token.
114
- */
115
- export async function createPreviewSession(
116
- account: CfAccount,
117
- ctx: CfWorkerContext,
118
- abortSignal: AbortSignal
119
- ): Promise<CfPreviewSession> {
120
- const { accountId } = account;
121
- const initUrl = ctx.zone
122
- ? `/zones/${ctx.zone}/workers/edge-preview`
123
- : `/accounts/${accountId}/workers/subdomain/edge-preview`;
124
-
125
- const { exchange_url } = await fetchResult<{ exchange_url: string }>(
126
- initUrl,
127
- undefined,
128
- undefined,
129
- abortSignal
130
- );
131
-
132
- logger.debug(`-- START EXCHANGE API REQUEST: GET ${exchange_url}`);
133
- logger.debug("-- END EXCHANGE API REQUEST");
134
- const exchangeResponse = await fetch(exchange_url, { signal: abortSignal });
135
- const bodyText = await exchangeResponse.text();
136
- logger.debug(
137
- "-- START EXCHANGE API RESPONSE:",
138
- exchangeResponse.statusText,
139
- exchangeResponse.status
140
- );
141
- logger.debug("HEADERS:", JSON.stringify(exchangeResponse.headers, null, 2));
142
- logger.debug("RESPONSE:", bodyText);
143
- logger.debug("-- END EXCHANGE API RESPONSE");
144
-
145
- const { inspector_websocket, prewarm, token } = parseJSON<{
146
- inspector_websocket: string;
147
- token: string;
148
- prewarm: string;
149
- }>(bodyText);
150
-
151
- const { host } = new URL(inspector_websocket);
152
- const query = `cf_workers_preview_token=${token}`;
153
-
154
- return {
155
- id: randomId(),
156
- value: token,
157
- host,
158
- inspectorUrl: new URL(`${inspector_websocket}?${query}`),
159
- prewarmUrl: new URL(prewarm),
160
- };
161
- }
162
-
163
- /**
164
- * Creates a preview token.
165
- */
166
- async function createPreviewToken(
167
- account: CfAccount,
168
- worker: CfWorkerInit,
169
- ctx: CfWorkerContext,
170
- session: CfPreviewSession,
171
- abortSignal: AbortSignal
172
- ): Promise<CfPreviewToken> {
173
- const { value, host, inspectorUrl, prewarmUrl } = session;
174
- const { accountId } = account;
175
- const scriptId = worker.name || (ctx.zone ? session.id : host.split(".")[0]);
176
- const url =
177
- ctx.env && !ctx.legacyEnv
178
- ? `/accounts/${accountId}/workers/services/${scriptId}/environments/${ctx.env}/edge-preview`
179
- : `/accounts/${accountId}/workers/scripts/${scriptId}/edge-preview`;
180
-
181
- const mode: CfPreviewMode = ctx.zone
182
- ? {
183
- routes: ctx.routes
184
- ? // extract all the route patterns
185
- ctx.routes.map((route) => {
186
- if (typeof route === "string") {
187
- return route;
188
- }
189
- if (route.custom_domain) {
190
- return `${route.pattern}/*`;
191
- }
192
- return route.pattern;
193
- })
194
- : // if there aren't any patterns, then just match on all routes
195
- ["*/*"],
196
- }
197
- : { workers_dev: true };
198
-
199
- const formData = createWorkerUploadForm(worker);
200
- formData.set("wrangler-session-config", JSON.stringify(mode));
201
-
202
- const { preview_token } = await fetchResult<{ preview_token: string }>(
203
- url,
204
- {
205
- method: "POST",
206
- body: formData,
207
- headers: {
208
- "cf-preview-upload-config-token": value,
209
- },
210
- },
211
- undefined,
212
- abortSignal
213
- );
214
-
215
- return {
216
- value: preview_token,
217
- host:
218
- ctx.host ??
219
- (worker.name
220
- ? `${
221
- worker.name
222
- // TODO: this should also probably have the env prefix
223
- // but it doesn't appear to work yet, instead giving us the
224
- // "There is nothing here yet" screen
225
- // ctx.env && !ctx.legacyEnv
226
- // ? `${ctx.env}.${worker.name}`
227
- // : worker.name
228
- }.${host.split(".").slice(1).join(".")}`
229
- : host),
230
-
231
- inspectorUrl,
232
- prewarmUrl,
233
- };
234
- }
235
-
236
- /**
237
- * A stub to create a Cloudflare Worker preview.
238
- *
239
- * @example
240
- * const {value, host} = await createWorker(init, acct);
241
- */
242
- export async function createWorkerPreview(
243
- init: CfWorkerInit,
244
- account: CfAccount,
245
- ctx: CfWorkerContext,
246
- session: CfPreviewSession,
247
- abortSignal: AbortSignal
248
- ): Promise<CfPreviewToken> {
249
- const token = await createPreviewToken(
250
- account,
251
- init,
252
- ctx,
253
- session,
254
- abortSignal
255
- );
256
- const accessToken = await getAccessToken(token.prewarmUrl.hostname);
257
-
258
- const headers: HeadersInit = { "cf-workers-preview-token": token.value };
259
- if (accessToken) {
260
- headers.cookie = `CF_Authorization=${accessToken}`;
261
- }
262
-
263
- // fire and forget the prewarm call
264
- fetch(token.prewarmUrl.href, {
265
- method: "POST",
266
- signal: abortSignal,
267
- headers,
268
- }).then(
269
- (response) => {
270
- if (!response.ok) {
271
- logger.warn("worker failed to prewarm: ", response.statusText);
272
- }
273
- },
274
- (err) => {
275
- if ((err as { code: string }).code !== "ABORT_ERR") {
276
- logger.warn("worker failed to prewarm: ", err);
277
- }
278
- }
279
- );
280
-
281
- return token;
282
- }
@@ -1,325 +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
- | {
49
- type: "logfwdr";
50
- name: string;
51
- destination: string;
52
- };
53
-
54
- export interface WorkerMetadata {
55
- /** The name of the entry point module. Only exists when the worker is in the ES module format */
56
- main_module?: string;
57
- /** The name of the entry point module. Only exists when the worker is in the service-worker format */
58
- body_part?: string;
59
- compatibility_date?: string;
60
- compatibility_flags?: string[];
61
- usage_model?: "bundled" | "unbound";
62
- migrations?: CfDurableObjectMigrations;
63
- capnp_schema?: string;
64
- bindings: WorkerMetadataBinding[];
65
- keep_bindings?: WorkerMetadataBinding["type"][];
66
- logpush?: boolean;
67
- }
68
-
69
- /**
70
- * Creates a `FormData` upload from a `CfWorkerInit`.
71
- */
72
- export function createWorkerUploadForm(worker: CfWorkerInit): FormData {
73
- const formData = new FormData();
74
- const {
75
- main,
76
- bindings,
77
- migrations,
78
- usage_model,
79
- compatibility_date,
80
- compatibility_flags,
81
- keepVars,
82
- logpush,
83
- } = worker;
84
-
85
- let { modules } = worker;
86
-
87
- const metadataBindings: WorkerMetadata["bindings"] = [];
88
-
89
- Object.entries(bindings.vars || {})?.forEach(([key, value]) => {
90
- if (typeof value === "string") {
91
- metadataBindings.push({ name: key, type: "plain_text", text: value });
92
- } else {
93
- metadataBindings.push({ name: key, type: "json", json: value });
94
- }
95
- });
96
-
97
- bindings.kv_namespaces?.forEach(({ id, binding }) => {
98
- metadataBindings.push({
99
- name: binding,
100
- type: "kv_namespace",
101
- namespace_id: id,
102
- });
103
- });
104
-
105
- bindings.durable_objects?.bindings.forEach(
106
- ({ name, class_name, script_name, environment }) => {
107
- metadataBindings.push({
108
- name,
109
- type: "durable_object_namespace",
110
- class_name: class_name,
111
- ...(script_name && { script_name }),
112
- ...(environment && { environment }),
113
- });
114
- }
115
- );
116
-
117
- bindings.queues?.forEach(({ binding, queue_name }) => {
118
- metadataBindings.push({
119
- type: "queue",
120
- name: binding,
121
- queue_name,
122
- });
123
- });
124
-
125
- bindings.r2_buckets?.forEach(({ binding, bucket_name }) => {
126
- metadataBindings.push({
127
- name: binding,
128
- type: "r2_bucket",
129
- bucket_name,
130
- });
131
- });
132
-
133
- bindings.d1_databases?.forEach(
134
- ({ binding, database_id, database_internal_env }) => {
135
- metadataBindings.push({
136
- name: binding,
137
- type: "d1",
138
- id: database_id,
139
- internalEnv: database_internal_env,
140
- });
141
- }
142
- );
143
-
144
- bindings.services?.forEach(({ binding, service, environment }) => {
145
- metadataBindings.push({
146
- name: binding,
147
- type: "service",
148
- service,
149
- ...(environment && { environment }),
150
- });
151
- });
152
-
153
- bindings.analytics_engine_datasets?.forEach(({ binding, dataset }) => {
154
- metadataBindings.push({
155
- name: binding,
156
- type: "analytics_engine",
157
- dataset,
158
- });
159
- });
160
-
161
- bindings.dispatch_namespaces?.forEach(({ binding, namespace }) => {
162
- metadataBindings.push({
163
- name: binding,
164
- type: "dispatch_namespace",
165
- namespace,
166
- });
167
- });
168
-
169
- bindings.logfwdr?.bindings.forEach(({ name, destination }) => {
170
- metadataBindings.push({
171
- name: name,
172
- type: "logfwdr",
173
- destination,
174
- });
175
- });
176
-
177
- for (const [name, filePath] of Object.entries(bindings.wasm_modules || {})) {
178
- metadataBindings.push({
179
- name,
180
- type: "wasm_module",
181
- part: name,
182
- });
183
-
184
- formData.set(
185
- name,
186
- new File([readFileSync(filePath)], filePath, {
187
- type: "application/wasm",
188
- })
189
- );
190
- }
191
-
192
- for (const [name, filePath] of Object.entries(bindings.text_blobs || {})) {
193
- metadataBindings.push({
194
- name,
195
- type: "text_blob",
196
- part: name,
197
- });
198
-
199
- if (name !== "__STATIC_CONTENT_MANIFEST") {
200
- formData.set(
201
- name,
202
- new File([readFileSync(filePath)], filePath, {
203
- type: "text/plain",
204
- })
205
- );
206
- }
207
- }
208
-
209
- for (const [name, filePath] of Object.entries(bindings.data_blobs || {})) {
210
- metadataBindings.push({
211
- name,
212
- type: "data_blob",
213
- part: name,
214
- });
215
-
216
- formData.set(
217
- name,
218
- new File([readFileSync(filePath)], filePath, {
219
- type: "application/octet-stream",
220
- })
221
- );
222
- }
223
-
224
- if (main.type === "commonjs") {
225
- // This is a service-worker format worker.
226
- for (const module of Object.values([...(modules || [])])) {
227
- if (module.name === "__STATIC_CONTENT_MANIFEST") {
228
- // Add the manifest to the form data.
229
- formData.set(
230
- module.name,
231
- new File([module.content], module.name, {
232
- type: "text/plain",
233
- })
234
- );
235
- // And then remove it from the modules collection
236
- modules = modules?.filter((m) => m !== module);
237
- } else if (
238
- module.type === "compiled-wasm" ||
239
- module.type === "text" ||
240
- module.type === "buffer"
241
- ) {
242
- // Convert all wasm/text/data modules into `wasm_module`/`text_blob`/`data_blob` bindings.
243
- // The "name" of the module is a file path. We use it
244
- // to instead be a "part" of the body, and a reference
245
- // that we can use inside our source. This identifier has to be a valid
246
- // JS identifier, so we replace all non alphanumeric characters
247
- // with an underscore.
248
- const name = module.name.replace(/[^a-zA-Z0-9_$]/g, "_");
249
- metadataBindings.push({
250
- name,
251
- type:
252
- module.type === "compiled-wasm"
253
- ? "wasm_module"
254
- : module.type === "text"
255
- ? "text_blob"
256
- : "data_blob",
257
- part: name,
258
- });
259
-
260
- // Add the module to the form data.
261
- formData.set(
262
- name,
263
- new File([module.content], module.name, {
264
- type:
265
- module.type === "compiled-wasm"
266
- ? "application/wasm"
267
- : module.type === "text"
268
- ? "text/plain"
269
- : "application/octet-stream",
270
- })
271
- );
272
- // And then remove it from the modules collection
273
- modules = modules?.filter((m) => m !== module);
274
- }
275
- }
276
- }
277
-
278
- if (bindings.unsafe) {
279
- // @ts-expect-error unsafe bindings don't need to match a specific type here
280
- metadataBindings.push(...bindings.unsafe);
281
- }
282
-
283
- const metadata: WorkerMetadata = {
284
- ...(main.type !== "commonjs"
285
- ? { main_module: main.name }
286
- : { body_part: main.name }),
287
- bindings: metadataBindings,
288
- ...(compatibility_date && { compatibility_date }),
289
- ...(compatibility_flags && { compatibility_flags }),
290
- ...(usage_model && { usage_model }),
291
- ...(migrations && { migrations }),
292
- capnp_schema: bindings.logfwdr?.schema,
293
- ...(keepVars && { keep_bindings: ["plain_text", "json"] }),
294
- ...(logpush !== undefined && { logpush }),
295
- };
296
-
297
- formData.set("metadata", JSON.stringify(metadata));
298
-
299
- if (main.type === "commonjs" && modules && modules.length > 0) {
300
- throw new TypeError(
301
- "More than one module can only be specified when type = 'esm'"
302
- );
303
- }
304
-
305
- for (const module of [main].concat(modules || [])) {
306
- formData.set(
307
- module.name,
308
- new File([module.content], module.name, {
309
- type: toMimeType(module.type ?? main.type ?? "esm"),
310
- })
311
- );
312
- }
313
-
314
- if (bindings.logfwdr && bindings.logfwdr.schema) {
315
- const filePath = bindings.logfwdr.schema;
316
- formData.set(
317
- filePath,
318
- new File([readFileSync(filePath)], filePath, {
319
- type: "application/octet-stream",
320
- })
321
- );
322
- }
323
-
324
- return formData;
325
- }