wrangler 0.0.0-e928f94 → 0.0.0-e9307365

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 (214) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +51 -14
  3. package/bin/wrangler.js +159 -27
  4. package/kv-asset-handler.js +1 -0
  5. package/miniflare-dist/index.mjs +5416 -0
  6. package/package.json +172 -113
  7. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  8. package/src/__tests__/config-cache.test.ts +42 -0
  9. package/src/__tests__/configuration.test.ts +4022 -0
  10. package/src/__tests__/dev.test.tsx +1294 -0
  11. package/src/__tests__/generate.test.ts +93 -0
  12. package/src/__tests__/guess-worker-format.test.ts +85 -0
  13. package/src/__tests__/{clipboardy-mock.js → helpers/clipboardy-mock.js} +0 -0
  14. package/src/__tests__/helpers/cmd-shim.d.ts +11 -0
  15. package/src/__tests__/helpers/mock-account-id.ts +48 -0
  16. package/src/__tests__/helpers/mock-bin.ts +36 -0
  17. package/src/__tests__/helpers/mock-cfetch.ts +263 -0
  18. package/src/__tests__/helpers/mock-console.ts +97 -0
  19. package/src/__tests__/helpers/mock-dialogs.ts +153 -0
  20. package/src/__tests__/helpers/mock-http-server.ts +46 -0
  21. package/src/__tests__/helpers/mock-istty.ts +74 -0
  22. package/src/__tests__/helpers/mock-kv.ts +33 -0
  23. package/src/__tests__/helpers/mock-oauth-flow.ts +250 -0
  24. package/src/__tests__/helpers/mock-process.ts +39 -0
  25. package/src/__tests__/helpers/mock-stdin.ts +108 -0
  26. package/src/__tests__/helpers/mock-web-socket.ts +29 -0
  27. package/src/__tests__/helpers/run-in-tmp.ts +38 -0
  28. package/src/__tests__/helpers/run-wrangler.ts +16 -0
  29. package/src/__tests__/helpers/write-worker-source.ts +31 -0
  30. package/src/__tests__/helpers/write-wrangler-toml.ts +17 -0
  31. package/src/__tests__/https-options.test.ts +163 -0
  32. package/src/__tests__/index.test.ts +242 -150
  33. package/src/__tests__/init.test.ts +1992 -0
  34. package/src/__tests__/jest.setup.ts +150 -0
  35. package/src/__tests__/kv.test.ts +1671 -0
  36. package/src/__tests__/logger.test.ts +141 -0
  37. package/src/__tests__/metrics.test.ts +450 -0
  38. package/src/__tests__/package-manager.test.ts +353 -0
  39. package/src/__tests__/pages.test.ts +1261 -0
  40. package/src/__tests__/parse.test.ts +330 -0
  41. package/src/__tests__/publish.test.ts +6914 -0
  42. package/src/__tests__/pubsub.test.ts +367 -0
  43. package/src/__tests__/r2.test.ts +317 -0
  44. package/src/__tests__/route.test.ts +45 -0
  45. package/src/__tests__/secret.test.ts +492 -0
  46. package/src/__tests__/tail.test.ts +698 -0
  47. package/src/__tests__/test-old-node-version.js +31 -0
  48. package/src/__tests__/user.test.ts +144 -0
  49. package/src/__tests__/validate-dev-props.test.ts +56 -0
  50. package/src/__tests__/version.test.ts +35 -0
  51. package/src/__tests__/whoami.test.tsx +289 -0
  52. package/src/__tests__/worker-namespace.test.ts +327 -0
  53. package/src/abort.d.ts +3 -0
  54. package/src/api/dev.ts +86 -0
  55. package/src/api/index.ts +1 -0
  56. package/src/bundle-reporter.tsx +29 -0
  57. package/src/bundle.ts +472 -0
  58. package/src/cfetch/index.ts +121 -0
  59. package/src/cfetch/internal.ts +181 -0
  60. package/src/cli.ts +25 -8
  61. package/src/config/README.md +107 -0
  62. package/src/config/config.ts +263 -0
  63. package/src/config/diagnostics.ts +80 -0
  64. package/src/config/environment.ts +485 -0
  65. package/src/config/index.ts +251 -0
  66. package/src/config/validation-helpers.ts +584 -0
  67. package/src/config/validation.ts +1856 -0
  68. package/src/config-cache.ts +84 -0
  69. package/src/create-worker-preview.ts +257 -0
  70. package/src/create-worker-upload-form.ts +288 -0
  71. package/src/dev/dev-vars.ts +36 -0
  72. package/src/dev/dev.tsx +531 -0
  73. package/src/dev/local.tsx +385 -0
  74. package/src/dev/remote.tsx +413 -0
  75. package/src/dev/use-esbuild.ts +175 -0
  76. package/src/dev/validate-dev-props.ts +31 -0
  77. package/src/dev-registry.tsx +157 -0
  78. package/src/dev.tsx +604 -712
  79. package/src/dialogs.tsx +115 -65
  80. package/src/durable.ts +102 -0
  81. package/src/entry.ts +328 -0
  82. package/src/environment-variables.ts +35 -0
  83. package/src/errors.ts +11 -0
  84. package/src/faye-websocket.d.ts +6 -0
  85. package/src/generate.ts +131 -0
  86. package/src/git-client.ts +42 -0
  87. package/src/global-wrangler-config-path.ts +26 -0
  88. package/src/https-options.ts +127 -0
  89. package/src/index.tsx +2167 -1841
  90. package/src/init.ts +549 -0
  91. package/src/inspect.ts +750 -0
  92. package/src/intl-polyfill.d.ts +139 -0
  93. package/src/is-interactive.ts +12 -0
  94. package/src/kv.ts +430 -0
  95. package/src/logger.ts +73 -0
  96. package/src/metrics/index.ts +5 -0
  97. package/src/metrics/is-ci.ts +14 -0
  98. package/src/metrics/metrics-config.ts +239 -0
  99. package/src/metrics/metrics-dispatcher.ts +96 -0
  100. package/src/metrics/metrics-usage-headers.ts +24 -0
  101. package/src/metrics/send-event.ts +92 -0
  102. package/src/miniflare-cli/README.md +30 -0
  103. package/src/miniflare-cli/assets.ts +543 -0
  104. package/src/miniflare-cli/enum-keys.ts +17 -0
  105. package/src/miniflare-cli/index.ts +85 -0
  106. package/src/miniflare-cli/request-context.ts +40 -0
  107. package/src/module-collection.ts +247 -53
  108. package/src/open-in-browser.ts +17 -0
  109. package/src/package-manager.ts +219 -0
  110. package/src/pages/build.tsx +204 -0
  111. package/src/pages/constants.ts +8 -0
  112. package/src/pages/deployments.tsx +106 -0
  113. package/src/pages/dev.tsx +414 -0
  114. package/src/pages/functions/buildPlugin.ts +105 -0
  115. package/src/pages/functions/buildWorker.ts +151 -0
  116. package/src/pages/functions/filepath-routing.test.ts +234 -0
  117. package/src/pages/functions/filepath-routing.ts +189 -0
  118. package/src/pages/functions/identifiers.ts +78 -0
  119. package/src/pages/functions/routes.ts +151 -0
  120. package/src/pages/index.tsx +84 -0
  121. package/src/pages/projects.tsx +163 -0
  122. package/src/pages/publish.tsx +338 -0
  123. package/src/pages/types.ts +40 -0
  124. package/src/pages/upload.tsx +415 -0
  125. package/src/pages/utils.ts +12 -0
  126. package/src/parse.ts +286 -0
  127. package/src/paths.ts +26 -0
  128. package/src/preview.ts +31 -0
  129. package/src/proxy.ts +476 -0
  130. package/src/publish.ts +796 -335
  131. package/src/pubsub/index.ts +286 -0
  132. package/src/pubsub/pubsub-commands.tsx +623 -0
  133. package/src/r2.ts +118 -0
  134. package/src/selfsigned.d.ts +29 -0
  135. package/src/sites.tsx +357 -100
  136. package/src/tail/filters.ts +279 -0
  137. package/src/tail/index.ts +299 -0
  138. package/src/tail/printing.ts +67 -0
  139. package/src/update-check.ts +19 -0
  140. package/src/user/choose-account.tsx +69 -0
  141. package/src/user/env-vars.ts +46 -0
  142. package/src/user/generate-auth-url.ts +33 -0
  143. package/src/user/generate-random-state.ts +16 -0
  144. package/src/user/index.ts +3 -0
  145. package/src/user/user.tsx +1189 -0
  146. package/src/whoami.tsx +169 -0
  147. package/src/worker-namespace.ts +206 -0
  148. package/src/worker.ts +203 -0
  149. package/src/zones.ts +76 -0
  150. package/templates/checked-fetch.js +17 -0
  151. package/templates/first-party-worker-module-facade.ts +18 -0
  152. package/templates/format-dev-errors.ts +32 -0
  153. package/templates/gitignore +171 -0
  154. package/templates/new-worker-scheduled.js +17 -0
  155. package/templates/new-worker-scheduled.ts +32 -0
  156. package/templates/new-worker.js +15 -0
  157. package/templates/new-worker.ts +30 -0
  158. package/templates/no-op-worker.js +10 -0
  159. package/templates/pages-shim.ts +9 -0
  160. package/templates/pages-template-plugin.ts +155 -0
  161. package/templates/pages-template-worker.ts +161 -0
  162. package/templates/serve-static-assets.ts +63 -0
  163. package/templates/service-bindings-module-facade.js +51 -0
  164. package/templates/service-bindings-sw-facade.js +39 -0
  165. package/templates/tsconfig.json +105 -0
  166. package/wrangler-dist/cli.d.ts +327 -0
  167. package/wrangler-dist/cli.js +126729 -101995
  168. package/src/__tests__/fixtures/init/.gitkeep +0 -0
  169. package/src/__tests__/mock-cfetch.js +0 -46
  170. package/src/api/form_data.ts +0 -141
  171. package/src/api/inspect.ts +0 -441
  172. package/src/api/preview.ts +0 -128
  173. package/src/api/worker.ts +0 -161
  174. package/src/cfetch.ts +0 -72
  175. package/src/config.ts +0 -122
  176. package/src/kv.tsx +0 -211
  177. package/src/pages.tsx +0 -843
  178. package/src/tail.tsx +0 -71
  179. package/src/user.tsx +0 -1029
  180. package/static-asset-facade.js +0 -47
  181. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  182. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  183. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  184. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  185. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  186. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  187. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  188. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  189. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  190. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  191. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  192. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  193. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  194. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  195. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  196. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  197. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  198. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  199. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  200. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  201. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  202. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  203. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  204. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  205. package/vendor/wrangler-mime/LICENSE +0 -21
  206. package/vendor/wrangler-mime/Mime.js +0 -97
  207. package/vendor/wrangler-mime/README.md +0 -187
  208. package/vendor/wrangler-mime/cli.js +0 -46
  209. package/vendor/wrangler-mime/index.js +0 -4
  210. package/vendor/wrangler-mime/lite.js +0 -4
  211. package/vendor/wrangler-mime/package.json +0 -52
  212. package/vendor/wrangler-mime/types/other.js +0 -1
  213. package/vendor/wrangler-mime/types/standard.js +0 -1
  214. package/wrangler-dist/cli.js.map +0 -7
package/src/dev.tsx CHANGED
@@ -1,724 +1,616 @@
1
- import esbuild from "esbuild";
2
- import httpProxy from "http-proxy";
3
- import { readFile } from "fs/promises";
4
- import type { DirectoryResult } from "tmp-promise";
5
- import tmp from "tmp-promise";
6
- import type { CfPreviewToken } from "./api/preview";
7
- import { Box, Text, useInput } from "ink";
8
- import React, { useState, useEffect, useRef } from "react";
9
- import path from "path";
10
- import open from "open";
11
- import { DtInspector } from "./api/inspect";
12
- import type { CfModule, CfVariable } from "./api/worker";
13
- import { createWorker } from "./api/worker";
14
- import type { CfWorkerInit } from "./api/worker";
15
- import { spawn } from "child_process";
16
- import onExit from "signal-exit";
17
- import { syncAssets } from "./sites";
18
- import clipboardy from "clipboardy";
19
- import http from "node:http";
20
- import serveStatic from "serve-static";
21
- import commandExists from "command-exists";
22
- import assert from "assert";
23
- import { getAPIToken } from "./user";
24
- import fetch from "node-fetch";
25
- import makeModuleCollector from "./module-collection";
26
-
27
- type CfScriptFormat = void | "modules" | "service-worker";
28
-
29
- type Props = {
30
- name?: string;
31
- entry: string;
32
- port?: number;
33
- format: CfScriptFormat;
34
- accountId: void | string;
35
- initialMode: "local" | "remote";
36
- jsxFactory: void | string;
37
- jsxFragment: void | string;
38
- variables: { [name: string]: CfVariable };
39
- public: void | string;
40
- site: void | string;
41
- compatibilityDate: void | string;
42
- compatibilityFlags: void | string[];
43
- usageModel: void | "bundled" | "unbound";
44
- };
45
-
46
- export function Dev(props: Props): JSX.Element {
47
- if (props.public && props.format === "service-worker") {
48
- throw new Error(
49
- "You cannot use the service worker format with a `public` directory."
50
- );
51
- }
52
- const port = props.port || 8787;
53
- const apiToken = getAPIToken();
54
- const directory = useTmpDir();
55
-
56
- const bundle = useEsbuild({
57
- entry: props.entry,
58
- destination: directory,
59
- staticRoot: props.public,
60
- jsxFactory: props.jsxFactory,
61
- jsxFragment: props.jsxFragment,
62
- });
63
- if (bundle && bundle.type === "commonjs" && !props.format && props.public) {
64
- throw new Error(
65
- "You cannot use the service worker format with a `public` directory."
66
- );
67
- }
68
-
69
- // @ts-expect-error whack
70
- useDevtoolsRefresh(bundle?.id ?? 0);
71
-
72
- const toggles = useHotkeys(
73
- {
74
- local: props.initialMode === "local",
75
- tunnel: false,
76
- },
77
- port
78
- );
79
-
80
- useTunnel(toggles.tunnel);
81
-
82
- return (
83
- <>
84
- {toggles.local ? (
85
- <Local
86
- name={props.name}
87
- bundle={bundle}
88
- format={props.format}
89
- variables={props.variables}
90
- site={props.site}
91
- public={props.public}
92
- port={props.port}
93
- />
94
- ) : (
95
- <Remote
96
- name={props.name}
97
- bundle={bundle}
98
- format={props.format}
99
- accountId={props.accountId}
100
- apiToken={apiToken}
101
- variables={props.variables}
102
- site={props.site}
103
- public={props.public}
104
- port={props.port}
105
- compatibilityDate={props.compatibilityDate}
106
- compatibilityFlags={props.compatibilityFlags}
107
- usageModel={props.usageModel}
108
- />
109
- )}
110
- <Box borderStyle="round" paddingLeft={1} paddingRight={1}>
111
- <Text>
112
- {`B to open a browser, D to open Devtools, S to ${
113
- toggles.tunnel ? "turn off" : "turn on"
114
- } (experimental) sharing, L to ${
115
- toggles.local ? "turn off" : "turn on"
116
- } local mode, X to exit`}
117
- </Text>
118
- </Box>
119
- </>
120
- );
1
+ import path from "node:path";
2
+ import { watch } from "chokidar";
3
+ import getPort from "get-port";
4
+ import { render } from "ink";
5
+ import React from "react";
6
+ import { fetch } from "undici";
7
+ import { findWranglerToml, printBindings, readConfig } from "./config";
8
+ import Dev from "./dev/dev";
9
+ import { getVarsForDev } from "./dev/dev-vars";
10
+
11
+ import { getEntry } from "./entry";
12
+ import { logger } from "./logger";
13
+ import * as metrics from "./metrics";
14
+ import { getAssetPaths, getSiteAssetPaths } from "./sites";
15
+ import { getAccountFromCache } from "./user";
16
+ import { getZoneIdFromHost, getZoneForRoute, getHostFromRoute } from "./zones";
17
+ import {
18
+ printWranglerBanner,
19
+ DEFAULT_LOCAL_PORT,
20
+ type ConfigPath,
21
+ getScriptName,
22
+ getDevCompatibilityDate,
23
+ getRules,
24
+ isLegacyEnv,
25
+ DEFAULT_INSPECTOR_PORT,
26
+ } from "./index";
27
+
28
+ import type { Config } from "./config";
29
+ import type { Route } from "./config/environment";
30
+ import type { EnablePagesAssetsServiceBindingOptions } from "./miniflare-cli";
31
+ import type { CfWorkerInit } from "./worker";
32
+ import type { RequestInit } from "undici";
33
+ import type { Argv, ArgumentsCamelCase } from "yargs";
34
+
35
+ interface DevArgs {
36
+ config?: string;
37
+ script?: string;
38
+ name?: string;
39
+ bundle?: boolean;
40
+ build?: boolean;
41
+ format?: string;
42
+ env?: string;
43
+ "compatibility-date"?: string;
44
+ "compatibility-flags"?: string[];
45
+ latest?: boolean;
46
+ ip?: string;
47
+ inspect?: boolean;
48
+ port?: number;
49
+ "inspector-port"?: number;
50
+ routes?: string[];
51
+ host?: string;
52
+ "local-protocol"?: "http" | "https";
53
+ "local-upstream"?: string | undefined;
54
+ "experimental-public"?: string;
55
+ public?: string;
56
+ assets?: string;
57
+ site?: string;
58
+ "site-include"?: string[];
59
+ "site-exclude"?: string[];
60
+ "upstream-protocol"?: "http" | "https";
61
+ "jsx-factory"?: string;
62
+ "jsx-fragment"?: string;
63
+ tsconfig?: string;
64
+ local?: boolean;
65
+ minify?: boolean;
66
+ "node-compat"?: boolean;
67
+ "experimental-enable-local-persistence"?: boolean;
68
+ "live-reload"?: boolean;
69
+ onReady?: () => void;
70
+ logLevel?: "none" | "error" | "log" | "warn" | "debug";
71
+ logPrefix?: string;
72
+ showInteractiveDevSession?: boolean;
121
73
  }
122
74
 
123
- function useDevtoolsRefresh(bundleId: number) {
124
- // TODO: this is a hack while we figure out
125
- // a better cleaner solution to get devtools to reconnect
126
- // without having to do a full refresh
127
- const ref = useRef();
128
- // @ts-expect-error whack
129
- ref.current = bundleId;
130
-
131
- useEffect(() => {
132
- const server = http.createServer((req, res) => {
133
- res.setHeader("Access-Control-Allow-Origin", "*");
134
- res.setHeader("Access-Control-Request-Method", "*");
135
- res.setHeader("Access-Control-Allow-Methods", "OPTIONS, GET");
136
- res.setHeader("Access-Control-Allow-Headers", "*");
137
- if (req.method === "OPTIONS") {
138
- res.writeHead(200);
139
- res.end();
140
- return;
141
- }
142
- res.writeHead(200, { "Content-Type": "application/json" });
143
- res.end(JSON.stringify({ value: ref.current }));
144
- });
145
-
146
- server.listen(3142);
147
- return () => {
148
- server.close();
149
- };
150
- }, []);
151
- }
152
-
153
- function Remote(props: {
154
- name: void | string;
155
- bundle: EsbuildBundle | void;
156
- format: CfScriptFormat;
157
- public: void | string;
158
- site: void | string;
159
- port: number;
160
- accountId: void | string;
161
- apiToken: void | string;
162
- variables: { [name: string]: CfVariable };
163
- compatibilityDate: string | void;
164
- compatibilityFlags: void | string[];
165
- usageModel: void | "bundled" | "unbound";
166
- }) {
167
- assert(props.accountId, "accountId is required");
168
- assert(props.apiToken, "apiToken is required");
169
- const token = useWorker({
170
- name: props.name,
171
- bundle: props.bundle,
172
- format: props.format,
173
- modules: props.bundle ? props.bundle.modules : [],
174
- accountId: props.accountId,
175
- apiToken: props.apiToken,
176
- variables: props.variables,
177
- sitesFolder: props.site,
178
- port: props.port,
179
- compatibilityDate: props.compatibilityDate,
180
- compatibilityFlags: props.compatibilityFlags,
181
- usageModel: props.usageModel,
182
- });
183
-
184
- useProxy({ token, publicRoot: props.public, port: props.port });
185
-
186
- useInspector(token ? token.inspectorUrl.href : undefined);
187
- return null;
188
- }
189
- function Local(props: {
190
- name: void | string;
191
- bundle: EsbuildBundle | void;
192
- format: CfScriptFormat;
193
- variables: { [name: string]: CfVariable };
194
- public: void | string;
195
- site: void | string;
196
- port: number;
197
- }) {
198
- const { inspectorUrl } = useLocalWorker({
199
- name: props.name,
200
- bundle: props.bundle,
201
- format: props.format,
202
- variables: props.variables,
203
- port: props.port,
204
- });
205
- useInspector(inspectorUrl);
206
- return null;
75
+ export function devOptions(yargs: Argv): Argv<DevArgs> {
76
+ return (
77
+ yargs
78
+ .positional("script", {
79
+ describe: "The path to an entry point for your worker",
80
+ type: "string",
81
+ })
82
+ .option("name", {
83
+ describe: "Name of the worker",
84
+ type: "string",
85
+ requiresArg: true,
86
+ })
87
+ // We want to have a --no-bundle flag, but yargs requires that
88
+ // we also have a --bundle flag (that it adds the --no to by itself)
89
+ // So we make a --bundle flag, but hide it, and then add a --no-bundle flag
90
+ // that's visible to the user but doesn't "do" anything.
91
+ .option("bundle", {
92
+ describe: "Run wrangler's compilation step before publishing",
93
+ type: "boolean",
94
+ hidden: true,
95
+ })
96
+ .option("no-bundle", {
97
+ describe: "Skip internal build steps and directly publish script",
98
+ type: "boolean",
99
+ default: false,
100
+ })
101
+ .option("format", {
102
+ choices: ["modules", "service-worker"] as const,
103
+ describe: "Choose an entry type",
104
+ deprecated: true,
105
+ })
106
+ .option("env", {
107
+ describe: "Perform on a specific environment",
108
+ type: "string",
109
+ requiresArg: true,
110
+ alias: "e",
111
+ })
112
+ .option("compatibility-date", {
113
+ describe: "Date to use for compatibility checks",
114
+ type: "string",
115
+ requiresArg: true,
116
+ })
117
+ .option("compatibility-flags", {
118
+ describe: "Flags to use for compatibility checks",
119
+ alias: "compatibility-flag",
120
+ type: "string",
121
+ requiresArg: true,
122
+ array: true,
123
+ })
124
+ .option("latest", {
125
+ describe: "Use the latest version of the worker runtime",
126
+ type: "boolean",
127
+ default: true,
128
+ })
129
+ .option("ip", {
130
+ describe: "IP address to listen on, defaults to `localhost`",
131
+ type: "string",
132
+ requiresArg: true,
133
+ })
134
+ .option("port", {
135
+ describe: "Port to listen on",
136
+ type: "number",
137
+ })
138
+ .option("inspector-port", {
139
+ describe: "Port for devtools to connect to",
140
+ type: "number",
141
+ })
142
+ .option("routes", {
143
+ describe: "Routes to upload",
144
+ alias: "route",
145
+ type: "string",
146
+ requiresArg: true,
147
+ array: true,
148
+ })
149
+ .option("host", {
150
+ type: "string",
151
+ requiresArg: true,
152
+ describe:
153
+ "Host to forward requests to, defaults to the zone of project",
154
+ })
155
+ .option("local-protocol", {
156
+ describe: "Protocol to listen to requests on, defaults to http.",
157
+ choices: ["http", "https"] as const,
158
+ })
159
+ .options("local-upstream", {
160
+ type: "string",
161
+ describe:
162
+ "Host to act as origin in local mode, defaults to dev.host or route",
163
+ })
164
+ .option("experimental-public", {
165
+ describe: "Static assets to be served",
166
+ type: "string",
167
+ requiresArg: true,
168
+ deprecated: true,
169
+ hidden: true,
170
+ })
171
+ .option("assets", {
172
+ describe: "Static assets to be served",
173
+ type: "string",
174
+ requiresArg: true,
175
+ })
176
+ .option("site", {
177
+ describe: "Root folder of static assets for Workers Sites",
178
+ type: "string",
179
+ requiresArg: true,
180
+ })
181
+ .option("site-include", {
182
+ describe:
183
+ "Array of .gitignore-style patterns that match file or directory names from the sites directory. Only matched items will be uploaded.",
184
+ type: "string",
185
+ requiresArg: true,
186
+ array: true,
187
+ })
188
+ .option("site-exclude", {
189
+ describe:
190
+ "Array of .gitignore-style patterns that match file or directory names from the sites directory. Matched items will not be uploaded.",
191
+ type: "string",
192
+ requiresArg: true,
193
+ array: true,
194
+ })
195
+ .option("upstream-protocol", {
196
+ describe: "Protocol to forward requests to host on, defaults to https.",
197
+ choices: ["http", "https"] as const,
198
+ })
199
+ .option("jsx-factory", {
200
+ describe: "The function that is called for each JSX element",
201
+ type: "string",
202
+ requiresArg: true,
203
+ })
204
+ .option("jsx-fragment", {
205
+ describe: "The function that is called for each JSX fragment",
206
+ type: "string",
207
+ requiresArg: true,
208
+ })
209
+ .option("tsconfig", {
210
+ describe: "Path to a custom tsconfig.json file",
211
+ type: "string",
212
+ requiresArg: true,
213
+ })
214
+ .option("local", {
215
+ alias: "l",
216
+ describe: "Run on my machine",
217
+ type: "boolean",
218
+ default: false, // I bet this will a point of contention. We'll revisit it.
219
+ })
220
+ .option("minify", {
221
+ describe: "Minify the script",
222
+ type: "boolean",
223
+ })
224
+ .option("node-compat", {
225
+ describe: "Enable node.js compatibility",
226
+ type: "boolean",
227
+ })
228
+ .option("experimental-enable-local-persistence", {
229
+ describe: "Enable persistence for this session (only for local mode)",
230
+ type: "boolean",
231
+ })
232
+ .option("live-reload", {
233
+ // TODO: Add back in once we have remote `--live-reload`
234
+ hidden: true,
235
+ // describe: "Auto reload HTML pages when change is detected",
236
+ type: "boolean",
237
+ })
238
+ .option("inspect", {
239
+ describe: "Enable dev tools",
240
+ type: "boolean",
241
+ deprecated: true,
242
+ })
243
+ .option("legacy-env", {
244
+ type: "boolean",
245
+ describe: "Use legacy environments",
246
+ hidden: true,
247
+ })
248
+ );
207
249
  }
208
250
 
209
- function useLocalWorker(props: {
210
- name: void | string;
211
- bundle: EsbuildBundle | void;
212
- format: CfScriptFormat;
213
- variables: { [name: string]: CfVariable };
214
- port: number;
215
- }) {
216
- // TODO: pass vars via command line
217
- const { bundle, format, variables, port } = props;
218
- const local = useRef<ReturnType<typeof spawn>>();
219
- const removeSignalExitListener = useRef<() => void>();
220
- const [inspectorUrl, setInspectorUrl] = useState<string | void>();
221
- useEffect(() => {
222
- async function startLocalWorker() {
223
- if (!bundle) return;
224
- if (format === "modules" && bundle.type === "commonjs") {
225
- console.error("⎔ Cannot use modules with a commonjs bundle.");
226
- // TODO: a much better error message here, with what to do next
227
- return;
228
- }
229
- if (format === "service-worker" && bundle.type !== "esm") {
230
- console.error("⎔ Cannot use service-worker with a esm bundle.");
231
- // TODO: a much better error message here, with what to do next
232
- return;
233
- }
234
-
235
- console.log("⎔ Starting a local server...");
236
- local.current = spawn("node", [
237
- "--experimental-vm-modules",
238
- "--inspect",
239
- require.resolve("miniflare/cli"),
240
- bundle.path,
241
- "--watch",
242
- "--wrangler-config",
243
- path.join(__dirname, "../miniflare-config-stubs/wrangler.empty.toml"),
244
- "--env",
245
- path.join(__dirname, "../miniflare-config-stubs/.env.empty"),
246
- "--package",
247
- path.join(__dirname, "../miniflare-config-stubs/package.empty.json"),
248
- "--port",
249
- port.toString(),
250
- "--kv-persist",
251
- "--cache-persist",
252
- "--do-persist",
253
- ...Object.entries(variables)
254
- .map(([varKey, varVal]) => {
255
- if (typeof varVal === "string") {
256
- return `--binding ${varKey}=${varVal}`;
257
- } else if (
258
- "namespaceId" in varVal &&
259
- typeof varVal.namespaceId === "string"
260
- ) {
261
- return `--kv ${varKey}`;
262
- } else if ("class_name" in varVal) {
263
- return `--do ${varKey}=${varVal.class_name}`;
264
- }
265
- })
266
- .filter(Boolean),
267
- "--modules",
268
- format ||
269
- (bundle.type === "esm" ? "modules" : "service-worker") === "modules"
270
- ? "true"
271
- : "false",
272
- ]);
273
- console.log(`⬣ Listening at http://localhost:${port}`);
274
-
275
- local.current.on("close", (code) => {
276
- if (code !== null) {
277
- console.log(`miniflare process exited with code ${code}`);
278
- }
279
- });
280
-
281
- local.current.stdout.on("data", (_data: string) => {
282
- // console.log(`stdout: ${data}`);
283
- });
284
-
285
- local.current.stderr.on("data", (data: string) => {
286
- // console.error(`stderr: ${data}`);
287
- const matches =
288
- /Debugger listening on (ws:\/\/127\.0\.0\.1:9229\/[A-Za-z0-9-]+)/.exec(
289
- data
290
- );
291
- if (matches) {
292
- setInspectorUrl(matches[1]);
293
- }
294
- });
295
-
296
- removeSignalExitListener.current = onExit((_code, _signal) => {
297
- console.log("⎔ Shutting down local server.");
298
- local.current?.kill();
299
- local.current = undefined;
300
- });
301
- }
302
-
303
- startLocalWorker();
304
-
305
- return () => {
306
- if (local.current) {
307
- console.log("⎔ Shutting down local server.");
308
- local.current?.kill();
309
- local.current = undefined;
310
- removeSignalExitListener.current && removeSignalExitListener.current();
311
- removeSignalExitListener.current = undefined;
312
- }
313
- };
314
- }, [bundle, format, port]);
315
- return { inspectorUrl };
251
+ export async function devHandler(args: ArgumentsCamelCase<DevArgs>) {
252
+ let watcher;
253
+ try {
254
+ const devInstance = await startDev(args);
255
+ watcher = devInstance.watcher;
256
+ const { waitUntilExit } = devInstance.devReactElement;
257
+ await waitUntilExit();
258
+ } finally {
259
+ await watcher?.close();
260
+ }
316
261
  }
317
262
 
318
- function useTmpDir(): string | void {
319
- const [directory, setDirectory] = useState<DirectoryResult>();
320
- useEffect(() => {
321
- let dir: DirectoryResult;
322
- async function create() {
323
- try {
324
- dir = await tmp.dir({ unsafeCleanup: true });
325
- setDirectory(dir);
326
- return;
327
- } catch (err) {
328
- console.error("failed to create tmp dir");
329
- console.error(err);
330
- throw err;
331
- }
332
- }
333
- create();
334
- return () => {
335
- dir.cleanup();
336
- };
337
- }, []);
338
- return directory?.path;
339
- }
340
-
341
- type EsbuildBundle = {
342
- id: number;
343
- path: string;
344
- entry: string;
345
- type: "esm" | "commonjs";
346
- exports: string[];
347
- modules: CfModule[];
263
+ export type AdditionalDevProps = {
264
+ vars?: {
265
+ [key: string]: unknown;
266
+ };
267
+ kv?: {
268
+ binding: string;
269
+ id: string;
270
+ preview_id?: string;
271
+ }[];
272
+ durableObjects?: {
273
+ name: string;
274
+ class_name: string;
275
+ script_name?: string | undefined;
276
+ environment?: string | undefined;
277
+ }[];
348
278
  };
349
-
350
- function useEsbuild(props: {
351
- entry: string;
352
- destination: string | void;
353
- staticRoot: void | string;
354
- jsxFactory: string | void;
355
- jsxFragment: string | void;
356
- }): EsbuildBundle | void {
357
- const { entry, destination, staticRoot, jsxFactory, jsxFragment } = props;
358
- const [bundle, setBundle] = useState<EsbuildBundle>();
359
- useEffect(() => {
360
- let result: esbuild.BuildResult;
361
- async function build() {
362
- if (!destination) return;
363
- const moduleCollector = makeModuleCollector();
364
- result = await esbuild.build({
365
- entryPoints: [entry],
366
- bundle: true,
367
- outdir: destination,
368
- metafile: true,
369
- format: "esm",
370
- sourcemap: true,
371
- loader: {
372
- ".js": "jsx",
373
- },
374
- ...(jsxFactory && { jsxFactory }),
375
- ...(jsxFragment && { jsxFragment }),
376
- external: ["__STATIC_CONTENT_MANIFEST"],
377
- conditions: ["worker", "browser"],
378
- plugins: [moduleCollector.plugin],
379
- // TODO: import.meta.url
380
- watch: {
381
- async onRebuild(error) {
382
- if (error) console.error("watch build failed:", error);
383
- else {
384
- // nothing really changes here, so let's increment the id
385
- // to change the return object's identity
386
- setBundle((bundle) => ({ ...bundle, id: bundle.id + 1 }));
387
- }
388
- },
389
- },
390
- });
391
-
392
- const chunks = Object.entries(result.metafile.outputs).find(
393
- ([_path, { entryPoint }]) => entryPoint === entry
394
- ); // assumedly only one entry point
395
-
396
- setBundle({
397
- id: 0,
398
- entry,
399
- path: chunks[0],
400
- type: chunks[1].exports.length > 0 ? "esm" : "commonjs",
401
- exports: chunks[1].exports,
402
- modules: moduleCollector.modules,
403
- });
404
- }
405
- build();
406
- return () => {
407
- result?.stop();
408
- };
409
- }, [entry, destination, staticRoot, jsxFactory, jsxFragment]);
410
- return bundle;
411
- }
412
-
413
- function useWorker(props: {
414
- name: void | string;
415
- bundle: EsbuildBundle | void;
416
- format: CfScriptFormat;
417
- modules: CfModule[];
418
- accountId: string;
419
- apiToken: string;
420
- variables: { [name: string]: CfVariable };
421
- sitesFolder: void | string;
422
- port: number;
423
- compatibilityDate: string | void;
424
- compatibilityFlags: string[] | void;
425
- usageModel: void | "bundled" | "unbound";
426
- }): CfPreviewToken | void {
427
- const {
428
- name,
429
- bundle,
430
- format,
431
- modules,
432
- accountId,
433
- apiToken,
434
- variables,
435
- sitesFolder,
436
- compatibilityDate,
437
- compatibilityFlags,
438
- usageModel,
439
- port,
440
- } = props;
441
- const [token, setToken] = useState<CfPreviewToken>();
442
- useEffect(() => {
443
- async function start() {
444
- if (!bundle) return;
445
- if (format === "modules" && bundle.type === "commonjs") {
446
- console.error("⎔ Cannot use modules with a commonjs bundle.");
447
- // TODO: a much better error message here, with what to do next
448
- return;
449
- }
450
- if (format === "service-worker" && bundle.type !== "esm") {
451
- console.error("⎔ Cannot use service-worker with a esm bundle.");
452
- // TODO: a much better error message here, with what to do next
453
- return;
454
- }
455
-
456
- if (token) {
457
- console.log("⎔ Detected changes, restarting server...");
458
- } else {
459
- console.log("⎔ Starting server...");
460
- }
461
-
462
- const assets = sitesFolder
463
- ? await syncAssets(
464
- accountId,
465
- path.basename(bundle.path),
466
- sitesFolder,
467
- true,
468
- undefined // TODO: env
469
- )
470
- : {
471
- manifest: undefined,
472
- namespace: undefined,
473
- }; // TODO: cancellable?
474
-
475
- const content = await readFile(bundle.path, "utf-8");
476
- const init: CfWorkerInit = {
477
- name,
478
- main: {
479
- name: path.basename(bundle.path),
480
- type: format || bundle.type === "esm" ? "esm" : "commonjs",
481
- content,
482
- },
483
- modules: assets.manifest
484
- ? modules.concat({
485
- name: "__STATIC_CONTENT_MANIFEST",
486
- content: JSON.stringify(assets.manifest),
487
- type: "text",
488
- })
489
- : modules,
490
- variables: assets.namespace
491
- ? {
492
- ...variables,
493
- __STATIC_CONTENT: { namespaceId: assets.namespace },
494
- }
495
- : variables,
496
- migrations: undefined, // no migrations in dev
497
- compatibility_date: compatibilityDate,
498
- compatibility_flags: compatibilityFlags,
499
- usage_model: usageModel,
500
- };
501
- setToken(
502
- await createWorker(init, {
503
- accountId,
504
- apiToken,
505
- })
506
- );
507
- console.log(`⬣ Listening at http://localhost:${port}`);
508
- }
509
- start();
510
- }, [
511
- name,
512
- bundle,
513
- format,
514
- accountId,
515
- apiToken,
516
- port,
517
- sitesFolder,
518
- compatibilityDate,
519
- compatibilityFlags,
520
- usageModel,
521
- ]);
522
- return token;
523
- }
524
-
525
- function useProxy({
526
- token,
527
- publicRoot,
528
- port,
529
- }: {
530
- token: CfPreviewToken | void;
531
- publicRoot: void | string;
532
- port: number;
533
- }) {
534
- useEffect(() => {
535
- if (!token) return;
536
- const proxy = httpProxy.createProxyServer({
537
- secure: false,
538
- changeOrigin: true,
539
- headers: {
540
- "cf-workers-preview-token": token.value,
541
- },
542
- target: `https://${token.host}`,
543
- // TODO: log websockets too? validate durables, etc
544
- });
545
-
546
- const servePublic =
547
- publicRoot &&
548
- serveStatic(publicRoot, {
549
- cacheControl: false,
550
- });
551
- const server = http
552
- .createServer((req, res) => {
553
- if (publicRoot) {
554
- servePublic(req, res, () => {
555
- proxy.web(req, res);
556
- });
557
- } else {
558
- proxy.web(req, res);
559
- }
560
- })
561
- .listen(port); // TODO: custom port
562
-
563
- proxy.on("proxyRes", function (proxyRes, req, res) {
564
- // log all requests
565
- console.log(
566
- new Date().toLocaleTimeString(),
567
- req.method,
568
- req.url,
569
- res.statusCode // TODO add a status message like Ok etc?
570
- );
571
- });
572
- // TODO: log errors?
573
-
574
- return () => {
575
- proxy.close();
576
- server.close();
577
- };
578
- }, [token, publicRoot, port]);
279
+ type StartDevOptions = ArgumentsCamelCase<DevArgs> &
280
+ // These options can be passed in directly when called with the `wrangler.dev()` API.
281
+ // They aren't exposed as CLI arguments.
282
+ AdditionalDevProps & {
283
+ forceLocal?: boolean;
284
+ enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
285
+ };
286
+
287
+ export async function startDev(args: StartDevOptions) {
288
+ let watcher: ReturnType<typeof watch> | undefined;
289
+ let rerender: (node: React.ReactNode) => void | undefined;
290
+ try {
291
+ if (args.logLevel) {
292
+ // we don't define a "none" logLevel, so "error" will do for now.
293
+ logger.loggerLevel = args.logLevel === "none" ? "error" : args.logLevel;
294
+ }
295
+ await printWranglerBanner();
296
+
297
+ const configPath =
298
+ (args.config as ConfigPath) ||
299
+ ((args.script &&
300
+ findWranglerToml(path.dirname(args.script))) as ConfigPath);
301
+ let config = readConfig(configPath, args);
302
+
303
+ if (config.configPath) {
304
+ watcher = watch(config.configPath, {
305
+ persistent: true,
306
+ }).on("change", async (_event) => {
307
+ // TODO: Do we need to handle different `_event` types differently?
308
+ // e.g. what if the file is deleted, or added?
309
+ config = readConfig(configPath, args);
310
+ if (config.configPath) {
311
+ logger.log(`${path.basename(config.configPath)} changed...`);
312
+ rerender(await getDevReactElement(config));
313
+ }
314
+ });
315
+ }
316
+
317
+ const entry = await getEntry(
318
+ { assets: args.assets, script: args.script },
319
+ config,
320
+ "dev"
321
+ );
322
+
323
+ await metrics.sendMetricsEvent(
324
+ "run dev",
325
+ {
326
+ local: args.local,
327
+ usesTypeScript: /\.tsx?$/.test(entry.file),
328
+ },
329
+ { sendMetrics: config.send_metrics, offline: args.local }
330
+ );
331
+
332
+ if (config.services && config.services.length > 0) {
333
+ logger.warn(
334
+ `This worker is bound to live services: ${config.services
335
+ .map(
336
+ (service) =>
337
+ `${service.binding} (${service.service}${
338
+ service.environment ? `@${service.environment}` : ""
339
+ })`
340
+ )
341
+ .join(", ")}`
342
+ );
343
+ }
344
+
345
+ if (args.inspect) {
346
+ //devtools are enabled by default, but we still need to disable them if the caller doesn't want them
347
+ logger.warn(
348
+ "Passing --inspect is unnecessary, now you can always connect to devtools."
349
+ );
350
+ }
351
+
352
+ if (args["experimental-public"]) {
353
+ throw new Error(
354
+ "The --experimental-public field has been renamed to --assets"
355
+ );
356
+ }
357
+
358
+ if (args.public) {
359
+ throw new Error("The --public field has been renamed to --assets");
360
+ }
361
+
362
+ if ((args.assets || config.assets) && (args.site || config.site)) {
363
+ throw new Error(
364
+ "Cannot use Assets and Workers Sites in the same Worker."
365
+ );
366
+ }
367
+
368
+ if (args.assets) {
369
+ logger.warn(
370
+ "The --assets argument is experimental and may change or break at any time"
371
+ );
372
+ }
373
+
374
+ const upstreamProtocol =
375
+ args["upstream-protocol"] || config.dev.upstream_protocol;
376
+ if (upstreamProtocol === "http") {
377
+ logger.warn(
378
+ "Setting upstream-protocol to http is not currently implemented.\n" +
379
+ "If this is required in your project, please add your use case to the following issue:\n" +
380
+ "https://github.com/cloudflare/wrangler2/issues/583."
381
+ );
382
+ }
383
+
384
+ // TODO: if worker_dev = false and no routes, then error (only for dev)
385
+
386
+ // Compute zone info from the `host` and `route` args and config;
387
+ let host = args.host || config.dev.host;
388
+ let zoneId: string | undefined;
389
+ const routes: Route[] | undefined =
390
+ args.routes || (config.route && [config.route]) || config.routes;
391
+
392
+ if (args.forceLocal) {
393
+ args.local = true;
394
+ }
395
+
396
+ if (!args.local) {
397
+ if (host) {
398
+ zoneId = await getZoneIdFromHost(host);
399
+ }
400
+ if (!zoneId && routes) {
401
+ const firstRoute = routes[0];
402
+ const zone = await getZoneForRoute(firstRoute);
403
+ if (zone) {
404
+ zoneId = zone.id;
405
+ host = zone.host;
406
+ }
407
+ }
408
+ } else if (!host) {
409
+ if (routes) {
410
+ const firstRoute = routes[0];
411
+ host = getHostFromRoute(firstRoute);
412
+ }
413
+ }
414
+
415
+ const nodeCompat = args.nodeCompat ?? config.node_compat;
416
+ if (nodeCompat) {
417
+ logger.warn(
418
+ "Enabling node.js compatibility mode for built-ins and globals. This is experimental and has serious tradeoffs. Please see https://github.com/ionic-team/rollup-plugin-node-polyfills/ for more details."
419
+ );
420
+ }
421
+
422
+ const getLocalPort = memoizeGetPort(DEFAULT_LOCAL_PORT);
423
+ const getInspectorPort = memoizeGetPort(DEFAULT_INSPECTOR_PORT);
424
+
425
+ // eslint-disable-next-line no-inner-declarations
426
+ async function getDevReactElement(configParam: Config) {
427
+ // now log all available bindings into the terminal
428
+ const bindings = await getBindings(configParam, {
429
+ kv: args.kv,
430
+ vars: args.vars,
431
+ durableObjects: args.durableObjects,
432
+ });
433
+
434
+ // mask anything that was overridden in .dev.vars
435
+ // so that we don't log potential secrets into the terminal
436
+ const maskedVars = { ...bindings.vars };
437
+ for (const key of Object.keys(maskedVars)) {
438
+ if (maskedVars[key] !== configParam.vars[key]) {
439
+ // This means it was overridden in .dev.vars
440
+ // so let's mask it
441
+ maskedVars[key] = "(hidden)";
442
+ }
443
+ }
444
+
445
+ printBindings({
446
+ ...bindings,
447
+ vars: maskedVars,
448
+ });
449
+
450
+ const assetPaths =
451
+ args.assets || config.assets
452
+ ? getAssetPaths(config, args.assets)
453
+ : getSiteAssetPaths(
454
+ config,
455
+ args.site,
456
+ args.siteInclude,
457
+ args.siteExclude
458
+ );
459
+
460
+ return (
461
+ <Dev
462
+ name={getScriptName({ name: args.name, env: args.env }, config)}
463
+ noBundle={!(args.bundle ?? !config.no_bundle)}
464
+ entry={entry}
465
+ env={args.env}
466
+ zone={zoneId}
467
+ host={host}
468
+ routes={routes}
469
+ rules={getRules(config)}
470
+ legacyEnv={isLegacyEnv(config)}
471
+ minify={args.minify ?? config.minify}
472
+ nodeCompat={nodeCompat}
473
+ build={config.build || {}}
474
+ define={config.define}
475
+ initialMode={args.local ? "local" : "remote"}
476
+ jsxFactory={args["jsx-factory"] || config.jsx_factory}
477
+ jsxFragment={args["jsx-fragment"] || config.jsx_fragment}
478
+ tsconfig={args.tsconfig ?? config.tsconfig}
479
+ upstreamProtocol={upstreamProtocol}
480
+ localProtocol={args.localProtocol || config.dev.local_protocol}
481
+ localUpstream={args["local-upstream"] || host}
482
+ enableLocalPersistence={
483
+ args.experimentalEnableLocalPersistence || false
484
+ }
485
+ liveReload={args.liveReload || false}
486
+ accountId={config.account_id || getAccountFromCache()?.id}
487
+ assetPaths={assetPaths}
488
+ assetsConfig={config.assets}
489
+ port={args.port || config.dev.port || (await getLocalPort())}
490
+ ip={args.ip || config.dev.ip}
491
+ inspectorPort={
492
+ args["inspector-port"] ||
493
+ config.dev.inspector_port ||
494
+ (await getInspectorPort())
495
+ }
496
+ isWorkersSite={Boolean(args.site || config.site)}
497
+ compatibilityDate={getDevCompatibilityDate(
498
+ config,
499
+ args["compatibility-date"]
500
+ )}
501
+ compatibilityFlags={
502
+ args["compatibility-flags"] || config.compatibility_flags
503
+ }
504
+ usageModel={config.usage_model}
505
+ bindings={bindings}
506
+ crons={config.triggers.crons}
507
+ logLevel={args.logLevel}
508
+ logPrefix={args.logPrefix}
509
+ onReady={args.onReady}
510
+ inspect={args.inspect ?? true}
511
+ showInteractiveDevSession={args.showInteractiveDevSession}
512
+ forceLocal={args.forceLocal}
513
+ enablePagesAssetsServiceBinding={args.enablePagesAssetsServiceBinding}
514
+ firstPartyWorker={config.first_party_worker}
515
+ sendMetrics={config.send_metrics}
516
+ />
517
+ );
518
+ }
519
+ const devReactElement = render(await getDevReactElement(config));
520
+ rerender = devReactElement.rerender;
521
+ return {
522
+ devReactElement,
523
+ watcher,
524
+ stop: async () => {
525
+ devReactElement.unmount();
526
+ await watcher?.close();
527
+ },
528
+ fetch: async (init?: RequestInit) => {
529
+ //TODO: we are not guaranteed to be assigned this port, we should fix this ASAP
530
+ const port = args.port || config.dev.port || (await getLocalPort());
531
+ const address = args.ip || config.dev.ip || "localhost";
532
+
533
+ return await fetch(`http://${address}:${port}/`, init);
534
+ },
535
+ };
536
+ } finally {
537
+ await watcher?.close();
538
+ }
579
539
  }
580
540
 
581
- function useInspector(inspectorUrl: string | void) {
582
- useEffect(() => {
583
- if (!inspectorUrl) return;
584
-
585
- const inspector = new DtInspector(inspectorUrl);
586
- const abortController = inspector.proxyTo(9229);
587
- return () => {
588
- inspector.close();
589
- abortController.abort();
590
- };
591
- }, [inspectorUrl]);
541
+ /**
542
+ * Avoiding calling `getPort()` multiple times by memoizing the first result.
543
+ */
544
+ function memoizeGetPort(defaultPort: number) {
545
+ let portValue: number;
546
+ return async () => {
547
+ return portValue || (portValue = await getPort({ port: defaultPort }));
548
+ };
592
549
  }
593
550
 
594
- function sleep(period: number) {
595
- return new Promise((resolve) => setTimeout(resolve, period));
596
- }
597
- const SLEEP_DURATION = 2000;
598
- // really need a first class api for this
599
- const hostNameRegex = /userHostname="(.*)"/g;
600
- async function findTunnelHostname() {
601
- let hostName: string;
602
- while (!hostName) {
603
- try {
604
- const resp = await fetch("http://localhost:8789/metrics");
605
- const data = await resp.text();
606
- const matches = Array.from(data.matchAll(hostNameRegex));
607
- hostName = matches[0][1];
608
- } catch (err) {
609
- await sleep(SLEEP_DURATION);
610
- }
611
- }
612
- return hostName;
613
- }
614
-
615
- function useTunnel(toggle: boolean) {
616
- const tunnel = useRef<ReturnType<typeof spawn>>();
617
- const removeSignalExitListener = useRef<() => void>();
618
- // TODO: test if cloudflared is available, if not
619
- // point them to a url where they can get docs to install it
620
- useEffect(() => {
621
- async function startTunnel() {
622
- if (toggle) {
623
- try {
624
- await commandExists("cloudflared");
625
- } catch (e) {
626
- console.error(
627
- "To share your worker on the internet, please install `cloudflared` from https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/installation"
628
- );
629
- return;
630
- }
631
- console.log("⎔ Starting a tunnel...");
632
- tunnel.current = spawn("cloudflared", [
633
- "tunnel",
634
- "--url",
635
- "http://localhost:8787",
636
- "--metrics",
637
- "localhost:8789",
638
- ]);
639
-
640
- tunnel.current.on("close", (code) => {
641
- if (code !== 0) {
642
- console.log(`Tunnel process exited with code ${code}`);
643
- }
644
- });
645
-
646
- removeSignalExitListener.current = onExit((_code, _signal) => {
647
- console.log("⎔ Shutting down local tunnel.");
648
- tunnel.current?.kill();
649
- tunnel.current = undefined;
650
- });
651
-
652
- const hostName = await findTunnelHostname();
653
- clipboardy.write(hostName);
654
- console.log(`⬣ Sharing at ${hostName}, copied to clipboard.`);
655
- }
656
- }
657
-
658
- startTunnel();
659
-
660
- return () => {
661
- if (tunnel.current) {
662
- console.log("⎔ Shutting down tunnel.");
663
- tunnel.current?.kill();
664
- tunnel.current = undefined;
665
- removeSignalExitListener.current && removeSignalExitListener.current();
666
- removeSignalExitListener.current = undefined;
667
- }
668
- };
669
- }, [toggle]);
670
- }
671
-
672
- type useHotkeysInitialState = {
673
- local: boolean;
674
- tunnel: boolean;
675
- };
676
- function useHotkeys(initial: useHotkeysInitialState, port: number) {
677
- // UGH, we should put port in context instead
678
- const [toggles, setToggles] = useState(initial);
679
- useInput(
680
- (
681
- input,
682
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
683
- key
684
- ) => {
685
- switch (input) {
686
- case "b": // open browser
687
- open(
688
- `http://localhost:${port}/`
689
- // {
690
- // app: {
691
- // name: open.apps.chrome, // TODO: fallback on other browsers
692
- // },
693
- // }
694
- );
695
- break;
696
- case "d": // toggle inspector
697
- open(
698
- `https://built-devtools.pages.dev/js_app?experiments=true&v8only=true&ws=localhost:9229/ws`
699
- // {
700
- // app: {
701
- // name: open.apps.chrome,
702
- // // todo - add firefox and edge fallbacks
703
- // },
704
- // }
705
- );
706
- break;
707
- case "s": // toggle tunnel
708
- setToggles((toggles) => ({ ...toggles, tunnel: !toggles.tunnel }));
709
- break;
710
- case "l": // toggle local
711
- setToggles((toggles) => ({ ...toggles, local: !toggles.local }));
712
- break;
713
- case "q": // shut down
714
- case "x": // shut down
715
- process.exit(0);
716
- break;
717
- default:
718
- // nothing?
719
- break;
720
- }
721
- }
722
- );
723
- return toggles;
551
+ async function getBindings(
552
+ configParam: Config,
553
+ args: AdditionalDevProps
554
+ ): Promise<CfWorkerInit["bindings"]> {
555
+ const bindings = {
556
+ kv_namespaces: [
557
+ ...(configParam.kv_namespaces || []).map(
558
+ ({ binding, preview_id, id: _id }) => {
559
+ // In `dev`, we make folks use a separate kv namespace called
560
+ // `preview_id` instead of `id` so that they don't
561
+ // break production data. So here we check that a `preview_id`
562
+ // has actually been configured.
563
+ // This whole block of code will be obsoleted in the future
564
+ // when we have copy-on-write for previews on edge workers.
565
+ if (!preview_id) {
566
+ // TODO: This error has to be a _lot_ better, ideally just asking
567
+ // to create a preview namespace for the user automatically
568
+ throw new Error(
569
+ `In development, you should use a separate kv namespace than the one you'd use in production. Please create a new kv namespace with "wrangler kv:namespace create <name> --preview" and add its id as preview_id to the kv_namespace "${binding}" in your wrangler.toml`
570
+ ); // Ugh, I really don't like this message very much
571
+ }
572
+ return {
573
+ binding,
574
+ id: preview_id,
575
+ };
576
+ }
577
+ ),
578
+ ...(args.kv || []),
579
+ ],
580
+ // Use a copy of combinedVars since we're modifying it later
581
+ vars: {
582
+ ...getVarsForDev(configParam),
583
+ ...args.vars,
584
+ },
585
+ wasm_modules: configParam.wasm_modules,
586
+ text_blobs: configParam.text_blobs,
587
+ data_blobs: configParam.data_blobs,
588
+ durable_objects: {
589
+ bindings: [
590
+ ...(configParam.durable_objects || { bindings: [] }).bindings,
591
+ ...(args.durableObjects || []),
592
+ ],
593
+ },
594
+ r2_buckets: configParam.r2_buckets?.map(
595
+ ({ binding, preview_bucket_name, bucket_name: _bucket_name }) => {
596
+ // same idea as kv namespace preview id,
597
+ // same copy-on-write TODO
598
+ if (!preview_bucket_name) {
599
+ throw new Error(
600
+ `In development, you should use a separate r2 bucket than the one you'd use in production. Please create a new r2 bucket with "wrangler r2 bucket create <name>" and add its name as preview_bucket_name to the r2_buckets "${binding}" in your wrangler.toml`
601
+ );
602
+ }
603
+ return {
604
+ binding,
605
+ bucket_name: preview_bucket_name,
606
+ };
607
+ }
608
+ ),
609
+ worker_namespaces: configParam.worker_namespaces,
610
+ services: configParam.services,
611
+ unsafe: configParam.unsafe?.bindings,
612
+ logfwdr: configParam.logfwdr,
613
+ };
614
+
615
+ return bindings;
724
616
  }