wrangler 0.0.0-ecc8b172 → 0.0.0-ecdfabed0

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 (248) hide show
  1. package/README.md +17 -19
  2. package/bin/wrangler.js +24 -93
  3. package/config-schema.json +3088 -0
  4. package/package.json +197 -190
  5. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  6. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  7. package/templates/__tests__/tsconfig.json +8 -0
  8. package/templates/checked-fetch.js +19 -6
  9. package/templates/facade.d.ts +19 -0
  10. package/templates/gitignore +2 -3
  11. package/templates/init-tests/test-jest-new-worker.js +3 -5
  12. package/templates/init-tests/test-vitest-new-worker.js +4 -6
  13. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  14. package/templates/middleware/common.ts +9 -4
  15. package/templates/middleware/loader-modules.ts +94 -44
  16. package/templates/middleware/loader-sw.ts +48 -32
  17. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  18. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  19. package/templates/middleware/middleware-scheduled.ts +15 -1
  20. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  21. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  22. package/templates/modules-watch-stub.js +4 -0
  23. package/templates/new-worker-scheduled.ts +1 -1
  24. package/templates/new-worker.ts +4 -1
  25. package/templates/pages-dev-pipeline.ts +10 -13
  26. package/templates/pages-dev-util.ts +55 -0
  27. package/templates/pages-shim.ts +1 -1
  28. package/templates/pages-template-plugin.ts +37 -14
  29. package/templates/pages-template-worker.ts +33 -7
  30. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  31. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  32. package/templates/tsconfig-sanity.ts +11 -0
  33. package/templates/tsconfig.init.json +22 -0
  34. package/templates/tsconfig.json +5 -102
  35. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  36. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  37. package/wrangler-dist/ProxyWorker.js +241 -0
  38. package/wrangler-dist/ProxyWorker.js.map +6 -0
  39. package/wrangler-dist/cli.d.ts +26031 -472
  40. package/wrangler-dist/cli.js +172877 -121674
  41. package/wrangler-dist/wasm-sync.wasm +0 -0
  42. package/Cloudflare_CA.pem +0 -18
  43. package/import_meta_url.js +0 -3
  44. package/miniflare-config-stubs/.env.empty +0 -0
  45. package/miniflare-config-stubs/package.empty.json +0 -1
  46. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  47. package/miniflare-dist/index.mjs +0 -6310
  48. package/src/__tests__/api-dev.test.ts +0 -209
  49. package/src/__tests__/api-devregistry.test.js +0 -56
  50. package/src/__tests__/api.test.ts +0 -80
  51. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  52. package/src/__tests__/config-cache.test.ts +0 -42
  53. package/src/__tests__/configuration.test.ts +0 -3864
  54. package/src/__tests__/d1.test.ts +0 -70
  55. package/src/__tests__/delete.test.ts +0 -116
  56. package/src/__tests__/dev.test.tsx +0 -1357
  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-bin.ts +0 -36
  65. package/src/__tests__/helpers/mock-cfetch.ts +0 -333
  66. package/src/__tests__/helpers/mock-console.ts +0 -106
  67. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  68. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -8
  69. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  70. package/src/__tests__/helpers/mock-istty.ts +0 -74
  71. package/src/__tests__/helpers/mock-known-routes.ts +0 -7
  72. package/src/__tests__/helpers/mock-kv.ts +0 -33
  73. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -252
  74. package/src/__tests__/helpers/mock-process.ts +0 -39
  75. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  76. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  77. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -104
  78. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -36
  79. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -80
  80. package/src/__tests__/helpers/msw/handlers/script.ts +0 -75
  81. package/src/__tests__/helpers/msw/handlers/user.ts +0 -63
  82. package/src/__tests__/helpers/msw/index.ts +0 -15
  83. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  84. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  85. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  86. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  87. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  88. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  89. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  90. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  91. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  92. package/src/__tests__/https-options.test.ts +0 -163
  93. package/src/__tests__/index.test.ts +0 -251
  94. package/src/__tests__/init.test.ts +0 -2816
  95. package/src/__tests__/jest.setup.ts +0 -191
  96. package/src/__tests__/kv.test.ts +0 -1675
  97. package/src/__tests__/logger.test.ts +0 -141
  98. package/src/__tests__/metrics.test.ts +0 -450
  99. package/src/__tests__/middleware.scheduled.test.ts +0 -135
  100. package/src/__tests__/middleware.test.ts +0 -726
  101. package/src/__tests__/package-manager.test.ts +0 -353
  102. package/src/__tests__/pages.test.ts +0 -2111
  103. package/src/__tests__/parse.test.ts +0 -330
  104. package/src/__tests__/paths.test.ts +0 -39
  105. package/src/__tests__/publish.test.ts +0 -7119
  106. package/src/__tests__/pubsub.test.ts +0 -367
  107. package/src/__tests__/r2.test.ts +0 -371
  108. package/src/__tests__/route.test.ts +0 -45
  109. package/src/__tests__/secret.test.ts +0 -644
  110. package/src/__tests__/tail.test.ts +0 -800
  111. package/src/__tests__/test-old-node-version.js +0 -31
  112. package/src/__tests__/user.test.ts +0 -155
  113. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  114. package/src/__tests__/validate-dev-props.test.ts +0 -56
  115. package/src/__tests__/version.test.ts +0 -35
  116. package/src/__tests__/whoami.test.tsx +0 -278
  117. package/src/__tests__/worker-namespace.test.ts +0 -321
  118. package/src/abort.d.ts +0 -3
  119. package/src/api/dev.ts +0 -208
  120. package/src/api/index.ts +0 -2
  121. package/src/bundle-reporter.tsx +0 -29
  122. package/src/bundle.ts +0 -756
  123. package/src/cfetch/index.ts +0 -160
  124. package/src/cfetch/internal.ts +0 -263
  125. package/src/cli.ts +0 -29
  126. package/src/config/README.md +0 -107
  127. package/src/config/config.ts +0 -275
  128. package/src/config/diagnostics.ts +0 -80
  129. package/src/config/environment.ts +0 -505
  130. package/src/config/index.ts +0 -293
  131. package/src/config/validation-helpers.ts +0 -597
  132. package/src/config/validation.ts +0 -1930
  133. package/src/config-cache.ts +0 -85
  134. package/src/create-worker-preview.ts +0 -275
  135. package/src/create-worker-upload-form.ts +0 -301
  136. package/src/d1/backups.tsx +0 -212
  137. package/src/d1/create.tsx +0 -54
  138. package/src/d1/delete.tsx +0 -56
  139. package/src/d1/execute.tsx +0 -294
  140. package/src/d1/formatTimeAgo.ts +0 -14
  141. package/src/d1/index.ts +0 -75
  142. package/src/d1/list.tsx +0 -48
  143. package/src/d1/options.ts +0 -12
  144. package/src/d1/types.tsx +0 -14
  145. package/src/d1/utils.ts +0 -39
  146. package/src/delete.ts +0 -86
  147. package/src/deprecated/index.ts +0 -453
  148. package/src/dev/dev-vars.ts +0 -36
  149. package/src/dev/dev.tsx +0 -575
  150. package/src/dev/get-local-persistence-path.tsx +0 -31
  151. package/src/dev/local.tsx +0 -686
  152. package/src/dev/remote.tsx +0 -601
  153. package/src/dev/start-server.ts +0 -506
  154. package/src/dev/use-esbuild.ts +0 -197
  155. package/src/dev/validate-dev-props.ts +0 -31
  156. package/src/dev-registry.tsx +0 -201
  157. package/src/dev.tsx +0 -865
  158. package/src/dialogs.tsx +0 -163
  159. package/src/dispatch-namespace.ts +0 -206
  160. package/src/durable.ts +0 -102
  161. package/src/entry.ts +0 -329
  162. package/src/environment-variables.ts +0 -50
  163. package/src/errors.ts +0 -11
  164. package/src/git-client.ts +0 -124
  165. package/src/global-wrangler-config-path.ts +0 -26
  166. package/src/https-options.ts +0 -127
  167. package/src/index.tsx +0 -582
  168. package/src/init.ts +0 -970
  169. package/src/inspect.ts +0 -747
  170. package/src/intl-polyfill.d.ts +0 -139
  171. package/src/is-ci.ts +0 -14
  172. package/src/is-interactive.ts +0 -12
  173. package/src/kv/helpers.ts +0 -430
  174. package/src/kv/index.ts +0 -645
  175. package/src/logger.ts +0 -80
  176. package/src/metrics/index.ts +0 -5
  177. package/src/metrics/metrics-config.ts +0 -239
  178. package/src/metrics/metrics-dispatcher.ts +0 -96
  179. package/src/metrics/metrics-usage-headers.ts +0 -24
  180. package/src/metrics/send-event.ts +0 -94
  181. package/src/miniflare-cli/README.md +0 -30
  182. package/src/miniflare-cli/assets.ts +0 -215
  183. package/src/miniflare-cli/index.ts +0 -208
  184. package/src/miniflare-cli/request-context.ts +0 -40
  185. package/src/module-collection.ts +0 -267
  186. package/src/open-in-browser.ts +0 -17
  187. package/src/package-manager.ts +0 -219
  188. package/src/pages/build.tsx +0 -238
  189. package/src/pages/constants.ts +0 -16
  190. package/src/pages/deployments.tsx +0 -106
  191. package/src/pages/dev.tsx +0 -689
  192. package/src/pages/errors.ts +0 -66
  193. package/src/pages/functions/buildPlugin.ts +0 -110
  194. package/src/pages/functions/buildWorker.ts +0 -156
  195. package/src/pages/functions/filepath-routing.test.ts +0 -234
  196. package/src/pages/functions/filepath-routing.ts +0 -189
  197. package/src/pages/functions/identifiers.ts +0 -78
  198. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  199. package/src/pages/functions/routes-consolidation.ts +0 -73
  200. package/src/pages/functions/routes-transformation.test.ts +0 -282
  201. package/src/pages/functions/routes-transformation.ts +0 -115
  202. package/src/pages/functions/routes-validation.test.ts +0 -403
  203. package/src/pages/functions/routes-validation.ts +0 -202
  204. package/src/pages/functions/routes.ts +0 -151
  205. package/src/pages/functions.tsx +0 -82
  206. package/src/pages/hash.tsx +0 -13
  207. package/src/pages/index.tsx +0 -94
  208. package/src/pages/projects.tsx +0 -169
  209. package/src/pages/publish.tsx +0 -436
  210. package/src/pages/types.ts +0 -49
  211. package/src/pages/upload.tsx +0 -398
  212. package/src/pages/utils.ts +0 -12
  213. package/src/parse.ts +0 -286
  214. package/src/paths.ts +0 -71
  215. package/src/proxy.ts +0 -657
  216. package/src/publish/index.ts +0 -267
  217. package/src/publish/publish.ts +0 -913
  218. package/src/pubsub/index.ts +0 -286
  219. package/src/pubsub/pubsub-commands.tsx +0 -623
  220. package/src/r2/helpers.ts +0 -131
  221. package/src/r2/index.ts +0 -277
  222. package/src/routes.ts +0 -140
  223. package/src/secret/index.ts +0 -403
  224. package/src/selfsigned.d.ts +0 -29
  225. package/src/sites.tsx +0 -372
  226. package/src/tail/createTail.ts +0 -315
  227. package/src/tail/filters.ts +0 -277
  228. package/src/tail/index.ts +0 -217
  229. package/src/tail/printing.ts +0 -107
  230. package/src/update-check.ts +0 -19
  231. package/src/user/choose-account.tsx +0 -69
  232. package/src/user/env-vars.ts +0 -46
  233. package/src/user/generate-auth-url.ts +0 -33
  234. package/src/user/generate-random-state.ts +0 -16
  235. package/src/user/index.ts +0 -3
  236. package/src/user/user.tsx +0 -1192
  237. package/src/utils/collectKeyValues.ts +0 -14
  238. package/src/whoami.tsx +0 -169
  239. package/src/worker.ts +0 -234
  240. package/src/yargs-types.ts +0 -7
  241. package/src/zones.ts +0 -165
  242. package/templates/d1-beta-facade.js +0 -174
  243. package/templates/experimental-local-cache-stubs.js +0 -27
  244. package/templates/first-party-worker-module-facade.ts +0 -18
  245. package/templates/format-dev-errors.ts +0 -32
  246. package/templates/serve-static-assets.ts +0 -63
  247. package/templates/service-bindings-module-facade.js +0 -54
  248. package/templates/service-bindings-sw-facade.js +0 -42
@@ -1,1930 +0,0 @@
1
- import path from "node:path";
2
- import TOML from "@iarna/toml";
3
- import { Diagnostics } from "./diagnostics";
4
- import {
5
- deprecated,
6
- experimental,
7
- hasProperty,
8
- inheritable,
9
- isBoolean,
10
- isObjectWith,
11
- isOneOf,
12
- isOptionalProperty,
13
- isRequiredProperty,
14
- isString,
15
- isStringArray,
16
- validateAdditionalProperties,
17
- notInheritable,
18
- validateOptionalProperty,
19
- validateOptionalTypedArray,
20
- validateRequiredProperty,
21
- validateTypedArray,
22
- all,
23
- isMutuallyExclusiveWith,
24
- inheritableInLegacyEnvironments,
25
- appendEnvName,
26
- getBindingNames,
27
- isValidName,
28
- } from "./validation-helpers";
29
- import type { Config, DevConfig, RawConfig, RawDevConfig } from "./config";
30
- import type {
31
- RawEnvironment,
32
- DeprecatedUpload,
33
- Environment,
34
- Rule,
35
- } from "./environment";
36
- import type { ValidatorFn } from "./validation-helpers";
37
-
38
- const ENGLISH = new Intl.ListFormat("en");
39
-
40
- /**
41
- * Validate the given `rawConfig` object that was loaded from `configPath`.
42
- *
43
- * The configuration is normalized, which includes using default values for missing field,
44
- * and copying over inheritable fields into named environments.
45
- *
46
- * Any errors or warnings from the validation are available in the returned `diagnostics` object.
47
- */
48
- export function normalizeAndValidateConfig(
49
- rawConfig: RawConfig,
50
- configPath: string | undefined,
51
- args: unknown
52
- ): {
53
- config: Config;
54
- diagnostics: Diagnostics;
55
- } {
56
- const diagnostics = new Diagnostics(
57
- `Processing ${
58
- configPath ? path.relative(process.cwd(), configPath) : "wrangler"
59
- } configuration:`
60
- );
61
-
62
- deprecated(
63
- diagnostics,
64
- rawConfig,
65
- "miniflare",
66
- "Wrangler does not use configuration in the `miniflare` section. Unless you are using Miniflare directly you can remove this section.",
67
- true,
68
- "😶 Ignored"
69
- );
70
-
71
- deprecated(
72
- diagnostics,
73
- rawConfig,
74
- "type",
75
- "Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.",
76
- true,
77
- "😶 Ignored"
78
- );
79
-
80
- deprecated(
81
- diagnostics,
82
- rawConfig,
83
- "webpack_config",
84
- "Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.",
85
- true,
86
- "😶 Ignored"
87
- );
88
-
89
- validateOptionalProperty(
90
- diagnostics,
91
- "",
92
- "legacy_env",
93
- rawConfig.legacy_env,
94
- "boolean"
95
- );
96
-
97
- validateOptionalProperty(
98
- diagnostics,
99
- "",
100
- "send_metrics",
101
- rawConfig.send_metrics,
102
- "boolean"
103
- );
104
-
105
- validateOptionalProperty(
106
- diagnostics,
107
- "",
108
- "keep_vars",
109
- rawConfig.keep_vars,
110
- "boolean"
111
- );
112
-
113
- // TODO: set the default to false to turn on service environments as the default
114
- const isLegacyEnv =
115
- (args as { "legacy-env": boolean | undefined })["legacy-env"] ??
116
- rawConfig.legacy_env ??
117
- true;
118
-
119
- // TODO: remove this once service environments goes GA.
120
- if (!isLegacyEnv) {
121
- diagnostics.warnings.push(
122
- "Experimental: Service environments are in beta, and their behaviour is guaranteed to change in the future. DO NOT USE IN PRODUCTION."
123
- );
124
- }
125
-
126
- const topLevelEnv = normalizeAndValidateEnvironment(
127
- diagnostics,
128
- configPath,
129
- rawConfig
130
- );
131
-
132
- //TODO: find a better way to define the type of Args that can be passed to the normalizeAndValidateConfig()
133
- const envName = (args as { env: string | undefined }).env;
134
-
135
- let activeEnv = topLevelEnv;
136
- if (envName !== undefined) {
137
- const envDiagnostics = new Diagnostics(
138
- `"env.${envName}" environment configuration`
139
- );
140
- const rawEnv = rawConfig.env?.[envName];
141
- if (rawEnv !== undefined) {
142
- activeEnv = normalizeAndValidateEnvironment(
143
- envDiagnostics,
144
- configPath,
145
- rawEnv,
146
- envName,
147
- topLevelEnv,
148
- isLegacyEnv,
149
- rawConfig
150
- );
151
- diagnostics.addChild(envDiagnostics);
152
- } else {
153
- // An environment was specified, but no configuration for it was found.
154
- // To cover any legacy environment cases, where the `envName` is used,
155
- // Let's create a fake active environment with the specified `envName`.
156
- activeEnv = normalizeAndValidateEnvironment(
157
- envDiagnostics,
158
- configPath,
159
- {},
160
- envName,
161
- topLevelEnv,
162
- isLegacyEnv,
163
- rawConfig
164
- );
165
- const envNames = rawConfig.env
166
- ? `The available configured environment names are: ${JSON.stringify(
167
- Object.keys(rawConfig.env)
168
- )}\n`
169
- : "";
170
- const message =
171
- `No environment found in configuration with name "${envName}".\n` +
172
- `Before using \`--env=${envName}\` there should be an equivalent environment section in the configuration.\n` +
173
- `${envNames}\n` +
174
- `Consider adding an environment configuration section to the wrangler.toml file:\n` +
175
- "```\n[env." +
176
- envName +
177
- "]\n```\n";
178
-
179
- if (envNames.length > 0) {
180
- diagnostics.errors.push(message);
181
- } else {
182
- // Only warn (rather than error) if there are not actually any environments configured in wrangler.toml.
183
- diagnostics.warnings.push(message);
184
- }
185
- }
186
- }
187
-
188
- // Process the top-level default environment configuration.
189
- const config: Config = {
190
- configPath,
191
- legacy_env: isLegacyEnv,
192
- send_metrics: rawConfig.send_metrics,
193
- keep_vars: rawConfig.keep_vars,
194
- ...activeEnv,
195
- dev: normalizeAndValidateDev(diagnostics, rawConfig.dev ?? {}),
196
- migrations: normalizeAndValidateMigrations(
197
- diagnostics,
198
- rawConfig.migrations ?? [],
199
- activeEnv.durable_objects
200
- ),
201
- site: normalizeAndValidateSite(
202
- diagnostics,
203
- configPath,
204
- rawConfig,
205
- activeEnv.main
206
- ),
207
- assets: normalizeAndValidateAssets(diagnostics, configPath, rawConfig),
208
- wasm_modules: normalizeAndValidateModulePaths(
209
- diagnostics,
210
- configPath,
211
- "wasm_modules",
212
- rawConfig.wasm_modules
213
- ),
214
- text_blobs: normalizeAndValidateModulePaths(
215
- diagnostics,
216
- configPath,
217
- "text_blobs",
218
- rawConfig.text_blobs
219
- ),
220
- data_blobs: normalizeAndValidateModulePaths(
221
- diagnostics,
222
- configPath,
223
- "data_blobs",
224
- rawConfig.data_blobs
225
- ),
226
- };
227
-
228
- validateBindingsHaveUniqueNames(diagnostics, config);
229
-
230
- validateAdditionalProperties(
231
- diagnostics,
232
- "top-level",
233
- Object.keys(rawConfig),
234
- [...Object.keys(config), "env"]
235
- );
236
-
237
- experimental(diagnostics, rawConfig, "assets");
238
-
239
- return { config, diagnostics };
240
- }
241
-
242
- /**
243
- * Validate the `build` configuration and return the normalized values.
244
- */
245
- function normalizeAndValidateBuild(
246
- diagnostics: Diagnostics,
247
- rawEnv: RawEnvironment,
248
- rawBuild: Config["build"],
249
- configPath: string | undefined
250
- ): Config["build"] & { deprecatedUpload: DeprecatedUpload } {
251
- const { command, cwd, watch_dir = "./src", upload, ...rest } = rawBuild;
252
- const deprecatedUpload: DeprecatedUpload = { ...upload };
253
- validateAdditionalProperties(diagnostics, "build", Object.keys(rest), []);
254
-
255
- validateOptionalProperty(diagnostics, "build", "command", command, "string");
256
- validateOptionalProperty(diagnostics, "build", "cwd", cwd, "string");
257
- if (Array.isArray(watch_dir)) {
258
- validateTypedArray(diagnostics, "build.watch_dir", watch_dir, "string");
259
- } else {
260
- validateOptionalProperty(
261
- diagnostics,
262
- "build",
263
- "watch_dir",
264
- watch_dir,
265
- "string"
266
- );
267
- }
268
-
269
- deprecated(
270
- diagnostics,
271
- rawEnv,
272
- "build.upload.format",
273
- "The format is inferred automatically from the code.",
274
- true
275
- );
276
-
277
- if (rawEnv.main !== undefined && rawBuild.upload?.main) {
278
- diagnostics.errors.push(
279
- `Don't define both the \`main\` and \`build.upload.main\` fields in your configuration.\n` +
280
- `They serve the same purpose: to point to the entry-point of your worker.\n` +
281
- `Delete the \`build.upload.main\` and \`build.upload.dir\` field from your config.`
282
- );
283
- } else {
284
- deprecated(
285
- diagnostics,
286
- rawEnv,
287
- "build.upload.main",
288
- `Delete the \`build.upload.main\` and \`build.upload.dir\` fields.\n` +
289
- `Then add the top level \`main\` field to your configuration file:\n` +
290
- `\`\`\`\n` +
291
- `main = "${path.join(
292
- rawBuild.upload?.dir ?? "./dist",
293
- rawBuild.upload?.main ?? "."
294
- )}"\n` +
295
- `\`\`\``,
296
- true
297
- );
298
-
299
- deprecated(
300
- diagnostics,
301
- rawEnv,
302
- "build.upload.dir",
303
- `Use the top level "main" field or a command-line argument to specify the entry-point for the Worker.`,
304
- true
305
- );
306
- }
307
-
308
- return {
309
- command,
310
- watch_dir:
311
- // - `watch_dir` only matters when `command` is defined, so we apply
312
- // a default only when `command` is defined
313
- // - `configPath` will always be defined since `build` can only
314
- // be configured in `wrangler.toml`, but who knows, that may
315
- // change in the future, so we do a check anyway
316
- command && configPath
317
- ? Array.isArray(watch_dir)
318
- ? watch_dir.map((dir) =>
319
- path.relative(
320
- process.cwd(),
321
- path.join(path.dirname(configPath), `${dir}`)
322
- )
323
- )
324
- : path.relative(
325
- process.cwd(),
326
- path.join(path.dirname(configPath), `${watch_dir}`)
327
- )
328
- : watch_dir,
329
- cwd,
330
- deprecatedUpload,
331
- };
332
- }
333
-
334
- /**
335
- * Validate the `main` field and return the normalized values.
336
- */
337
- function normalizeAndValidateMainField(
338
- configPath: string | undefined,
339
- rawMain: string | undefined,
340
- deprecatedUpload: DeprecatedUpload | undefined
341
- ): string | undefined {
342
- const configDir = path.dirname(configPath ?? "wrangler.toml");
343
- if (rawMain !== undefined) {
344
- if (typeof rawMain === "string") {
345
- const directory = path.resolve(configDir);
346
- return path.resolve(directory, rawMain);
347
- } else {
348
- return rawMain;
349
- }
350
- } else if (deprecatedUpload?.main !== undefined) {
351
- const directory = path.resolve(
352
- configDir,
353
- deprecatedUpload?.dir || "./dist"
354
- );
355
- return path.resolve(directory, deprecatedUpload.main);
356
- } else {
357
- return;
358
- }
359
- }
360
-
361
- /**
362
- * Validate the `dev` configuration and return the normalized values.
363
- */
364
- function normalizeAndValidateDev(
365
- diagnostics: Diagnostics,
366
- rawDev: RawDevConfig
367
- ): DevConfig {
368
- const {
369
- ip = "0.0.0.0",
370
- port,
371
- inspector_port,
372
- local_protocol = "http",
373
- upstream_protocol = "https",
374
- host,
375
- ...rest
376
- } = rawDev;
377
- validateAdditionalProperties(diagnostics, "dev", Object.keys(rest), []);
378
-
379
- validateOptionalProperty(diagnostics, "dev", "ip", ip, "string");
380
- validateOptionalProperty(diagnostics, "dev", "port", port, "number");
381
- validateOptionalProperty(
382
- diagnostics,
383
- "dev",
384
- "inspector_port",
385
- inspector_port,
386
- "number"
387
- );
388
- validateOptionalProperty(
389
- diagnostics,
390
- "dev",
391
- "local_protocol",
392
- local_protocol,
393
- "string",
394
- ["http", "https"]
395
- );
396
- validateOptionalProperty(
397
- diagnostics,
398
- "dev",
399
- "upstream_protocol",
400
- upstream_protocol,
401
- "string",
402
- ["http", "https"]
403
- );
404
- validateOptionalProperty(diagnostics, "dev", "host", host, "string");
405
- return { ip, port, inspector_port, local_protocol, upstream_protocol, host };
406
- }
407
-
408
- /**
409
- * Validate the `migrations` configuration and return the normalized values.
410
- */
411
- function normalizeAndValidateMigrations(
412
- diagnostics: Diagnostics,
413
- rawMigrations: Config["migrations"],
414
- durableObjects: Config["durable_objects"]
415
- ): Config["migrations"] {
416
- if (!Array.isArray(rawMigrations)) {
417
- diagnostics.errors.push(
418
- `The optional "migrations" field should be an array, but got ${JSON.stringify(
419
- rawMigrations
420
- )}`
421
- );
422
- return [];
423
- } else {
424
- for (let i = 0; i < rawMigrations.length; i++) {
425
- const { tag, new_classes, renamed_classes, deleted_classes, ...rest } =
426
- rawMigrations[i];
427
-
428
- validateAdditionalProperties(
429
- diagnostics,
430
- "migrations",
431
- Object.keys(rest),
432
- []
433
- );
434
-
435
- validateRequiredProperty(
436
- diagnostics,
437
- `migrations[${i}]`,
438
- `tag`,
439
- tag,
440
- "string"
441
- );
442
- validateOptionalTypedArray(
443
- diagnostics,
444
- `migrations[${i}].new_classes`,
445
- new_classes,
446
- "string"
447
- );
448
- if (renamed_classes !== undefined) {
449
- if (!Array.isArray(renamed_classes)) {
450
- diagnostics.errors.push(
451
- `Expected "migrations[${i}].renamed_classes" to be an array of "{from: string, to: string}" objects but got ${JSON.stringify(
452
- renamed_classes
453
- )}.`
454
- );
455
- } else if (
456
- renamed_classes.some(
457
- (c) =>
458
- typeof c !== "object" ||
459
- !isRequiredProperty(c, "from", "string") ||
460
- !isRequiredProperty(c, "to", "string")
461
- )
462
- ) {
463
- diagnostics.errors.push(
464
- `Expected "migrations[${i}].renamed_classes" to be an array of "{from: string, to: string}" objects but got ${JSON.stringify(
465
- renamed_classes
466
- )}.`
467
- );
468
- }
469
- }
470
- validateOptionalTypedArray(
471
- diagnostics,
472
- `migrations[${i}].deleted_classes`,
473
- deleted_classes,
474
- "string"
475
- );
476
- }
477
-
478
- if (
479
- Array.isArray(durableObjects?.bindings) &&
480
- durableObjects.bindings.length > 0
481
- ) {
482
- // intrinsic [durable_objects] implies [migrations]
483
- const exportedDurableObjects = (durableObjects.bindings || []).filter(
484
- (binding) => !binding.script_name
485
- );
486
- if (exportedDurableObjects.length > 0 && rawMigrations.length === 0) {
487
- if (
488
- !exportedDurableObjects.some(
489
- (exportedDurableObject) =>
490
- typeof exportedDurableObject.class_name !== "string"
491
- )
492
- ) {
493
- const durableObjectClassnames = exportedDurableObjects.map(
494
- (durable) => durable.class_name
495
- );
496
-
497
- diagnostics.warnings.push(
498
- `In wrangler.toml, you have configured [durable_objects] exported by this Worker (${durableObjectClassnames.join(
499
- ", "
500
- )}), but no [migrations] for them. This may not work as expected until you add a [migrations] section to your wrangler.toml. Add this configuration to your wrangler.toml:
501
-
502
- \`\`\`
503
- [[migrations]]
504
- tag = "v1" # Should be unique for each entry
505
- new_classes = [${durableObjectClassnames
506
- .map((name) => `"${name}"`)
507
- .join(", ")}]
508
- \`\`\`
509
-
510
- Refer to https://developers.cloudflare.com/workers/learning/using-durable-objects/#durable-object-migrations-in-wranglertoml for more details.`
511
- );
512
- }
513
- }
514
- }
515
-
516
- return rawMigrations;
517
- }
518
- }
519
-
520
- /**
521
- * Validate the `site` configuration and return the normalized values.
522
- */
523
- function normalizeAndValidateSite(
524
- diagnostics: Diagnostics,
525
- configPath: string | undefined,
526
- rawConfig: RawConfig,
527
- mainEntryPoint: string | undefined
528
- ): Config["site"] {
529
- if (rawConfig?.site !== undefined) {
530
- const { bucket, include = [], exclude = [], ...rest } = rawConfig.site;
531
-
532
- validateAdditionalProperties(diagnostics, "site", Object.keys(rest), [
533
- "entry-point",
534
- ]);
535
- validateRequiredProperty(diagnostics, "site", "bucket", bucket, "string");
536
- validateTypedArray(diagnostics, "sites.include", include, "string");
537
- validateTypedArray(diagnostics, "sites.exclude", exclude, "string");
538
- validateOptionalProperty(
539
- diagnostics,
540
- "site",
541
- "entry-point",
542
- rawConfig.site["entry-point"],
543
- "string"
544
- );
545
-
546
- deprecated(
547
- diagnostics,
548
- rawConfig,
549
- `site.entry-point`,
550
- `Delete the \`site.entry-point\` field, then add the top level \`main\` field to your configuration file:\n` +
551
- `\`\`\`\n` +
552
- `main = "${path.join(
553
- String(rawConfig.site["entry-point"]) || "workers-site",
554
- path.extname(String(rawConfig.site["entry-point"]) || "workers-site")
555
- ? ""
556
- : "index.js"
557
- )}"\n` +
558
- `\`\`\``,
559
- false,
560
- undefined,
561
- "warning"
562
- );
563
-
564
- let siteEntryPoint = rawConfig.site["entry-point"];
565
-
566
- if (!mainEntryPoint && !siteEntryPoint) {
567
- // this means that we're defaulting to "workers-site"
568
- // so let's add the deprecation warning
569
- diagnostics.warnings.push(
570
- `Because you've defined a [site] configuration, we're defaulting to "workers-site" for the deprecated \`site.entry-point\`field.\n` +
571
- `Add the top level \`main\` field to your configuration file:\n` +
572
- `\`\`\`\n` +
573
- `main = "workers-site/index.js"\n` +
574
- `\`\`\``
575
- );
576
- siteEntryPoint = "workers-site";
577
- } else if (mainEntryPoint && siteEntryPoint) {
578
- diagnostics.errors.push(
579
- `Don't define both the \`main\` and \`site.entry-point\` fields in your configuration.\n` +
580
- `They serve the same purpose: to point to the entry-point of your worker.\n` +
581
- `Delete the deprecated \`site.entry-point\` field from your config.`
582
- );
583
- }
584
-
585
- if (configPath && siteEntryPoint) {
586
- // rewrite the path to be relative to the working directory
587
- siteEntryPoint = path.relative(
588
- process.cwd(),
589
- path.join(path.dirname(configPath), siteEntryPoint)
590
- );
591
- }
592
-
593
- return {
594
- bucket,
595
- "entry-point": siteEntryPoint,
596
- include,
597
- exclude,
598
- };
599
- }
600
- return undefined;
601
- }
602
-
603
- /**
604
- * Validate the `assets` configuration and return normalized values.
605
- */
606
- function normalizeAndValidateAssets(
607
- diagnostics: Diagnostics,
608
- configPath: string | undefined,
609
- rawConfig: RawConfig
610
- ): Config["assets"] {
611
- // Even though the type doesn't say it,
612
- // we allow for a string input in the config,
613
- // so let's normalise it
614
- if (typeof rawConfig?.assets === "string") {
615
- return {
616
- bucket: rawConfig.assets,
617
- include: [],
618
- exclude: [],
619
- browser_TTL: undefined,
620
- serve_single_page_app: false,
621
- };
622
- }
623
-
624
- if (rawConfig?.assets === undefined) {
625
- return undefined;
626
- }
627
-
628
- if (typeof rawConfig.assets !== "object") {
629
- diagnostics.errors.push(
630
- `Expected the \`assets\` field to be a string or an object, but got ${typeof rawConfig.assets}.`
631
- );
632
- return undefined;
633
- }
634
-
635
- const {
636
- bucket,
637
- include = [],
638
- exclude = [],
639
- browser_TTL,
640
- serve_single_page_app,
641
- ...rest
642
- } = rawConfig.assets;
643
-
644
- validateAdditionalProperties(diagnostics, "assets", Object.keys(rest), []);
645
-
646
- validateRequiredProperty(diagnostics, "assets", "bucket", bucket, "string");
647
- validateTypedArray(diagnostics, "assets.include", include, "string");
648
- validateTypedArray(diagnostics, "assets.exclude", exclude, "string");
649
-
650
- validateOptionalProperty(
651
- diagnostics,
652
- "assets",
653
- "browser_TTL",
654
- browser_TTL,
655
- "number"
656
- );
657
-
658
- validateOptionalProperty(
659
- diagnostics,
660
- "assets",
661
- "serve_single_page_app",
662
- serve_single_page_app,
663
- "boolean"
664
- );
665
-
666
- return {
667
- bucket,
668
- include,
669
- exclude,
670
- browser_TTL,
671
- serve_single_page_app,
672
- };
673
- }
674
-
675
- /**
676
- * Map the paths of the `wasm_modules`, `text_blobs` or `data_blobs` configuration to be relative to the current working directory.
677
- */
678
- function normalizeAndValidateModulePaths(
679
- diagnostics: Diagnostics,
680
- configPath: string | undefined,
681
- field: "wasm_modules" | "text_blobs" | "data_blobs",
682
- rawMapping: Record<string, string> | undefined
683
- ): Record<string, string> | undefined {
684
- if (rawMapping === undefined) {
685
- return undefined;
686
- }
687
- const mapping: Record<string, string> = {};
688
- // Rewrite paths to be relative to the cwd, rather than the config path.
689
- for (const [name, filePath] of Object.entries(rawMapping)) {
690
- if (isString(diagnostics, `${field}['${name}']`, filePath, undefined)) {
691
- if (configPath) {
692
- mapping[name] = configPath
693
- ? path.relative(
694
- process.cwd(),
695
- path.join(path.dirname(configPath), filePath)
696
- )
697
- : filePath;
698
- }
699
- }
700
- }
701
- return mapping;
702
- }
703
-
704
- /**
705
- * Check whether a value has the shape of a route, which can be a string
706
- * or an object that looks like {pattern: string, zone_id: string }
707
- */
708
- function isValidRouteValue(item: unknown): boolean {
709
- if (!item) {
710
- return false;
711
- }
712
- if (typeof item === "string") {
713
- return true;
714
- }
715
- if (typeof item === "object") {
716
- if (!hasProperty(item, "pattern") || typeof item.pattern !== "string") {
717
- return false;
718
- }
719
-
720
- const otherKeys = Object.keys(item).length - 1; // minus one to subtract "pattern"
721
-
722
- const hasZoneId =
723
- hasProperty(item, "zone_id") && typeof item.zone_id === "string";
724
- const hasZoneName =
725
- hasProperty(item, "zone_name") && typeof item.zone_name === "string";
726
- const hasCustomDomainFlag =
727
- hasProperty(item, "custom_domain") &&
728
- typeof item.custom_domain === "boolean";
729
-
730
- if (otherKeys === 2 && hasCustomDomainFlag && (hasZoneId || hasZoneName)) {
731
- return true;
732
- } else if (
733
- otherKeys === 1 &&
734
- (hasZoneId || hasZoneName || hasCustomDomainFlag)
735
- ) {
736
- return true;
737
- }
738
- }
739
- return false;
740
- }
741
-
742
- /**
743
- * If account_id has been passed as an empty string, normalise it to undefined.
744
- * This is to workaround older wrangler1-era templates that have account_id = '',
745
- * which isn't a valid value anyway
746
- */
747
- function mutateEmptyStringAccountIDValue(
748
- diagnostics: Diagnostics,
749
- rawEnv: RawEnvironment
750
- ) {
751
- if (rawEnv.account_id === "") {
752
- diagnostics.warnings.push(
753
- `The "account_id" field in your configuration is an empty string and will be ignored.\n` +
754
- `Please remove the "account_id" field from your configuration.`
755
- );
756
- rawEnv.account_id = undefined;
757
- }
758
- return rawEnv;
759
- }
760
-
761
- /**
762
- * Normalize empty string to `undefined` by mutating rawEnv.route value.
763
- * As part of backward compatibility with Wrangler1 converting empty string to `undefined`
764
- */
765
- function mutateEmptyStringRouteValue(
766
- diagnostics: Diagnostics,
767
- rawEnv: RawEnvironment
768
- ): RawEnvironment {
769
- if (rawEnv["route"] === "") {
770
- diagnostics.warnings.push(
771
- `The "route" field in your configuration is an empty string and will be ignored.\n` +
772
- `Please remove the "route" field from your configuration.`
773
- );
774
- rawEnv["route"] = undefined;
775
- }
776
-
777
- return rawEnv;
778
- }
779
-
780
- /**
781
- * Validate that the field is a route.
782
- */
783
- const isRoute: ValidatorFn = (diagnostics, field, value) => {
784
- if (value !== undefined && !isValidRouteValue(value)) {
785
- diagnostics.errors.push(
786
- `Expected "${field}" to be either a string, or an object with shape { pattern, custom_domain, zone_id | zone_name }, but got ${JSON.stringify(
787
- value
788
- )}.`
789
- );
790
- return false;
791
- }
792
- return true;
793
- };
794
-
795
- /**
796
- * Validate that the field is an array of routes.
797
- */
798
- const isRouteArray: ValidatorFn = (diagnostics, field, value) => {
799
- if (value === undefined) {
800
- return true;
801
- }
802
- if (!Array.isArray(value)) {
803
- diagnostics.errors.push(
804
- `Expected "${field}" to be an array but got ${JSON.stringify(value)}.`
805
- );
806
- return false;
807
- }
808
- const invalidRoutes = [];
809
- for (const item of value) {
810
- if (!isValidRouteValue(item)) {
811
- invalidRoutes.push(item);
812
- }
813
- }
814
- if (invalidRoutes.length > 0) {
815
- diagnostics.errors.push(
816
- `Expected "${field}" to be an array of either strings or objects with the shape { pattern, custom_domain, zone_id | zone_name }, but these weren't valid: ${JSON.stringify(
817
- invalidRoutes,
818
- null,
819
- 2
820
- )}.`
821
- );
822
- }
823
- return invalidRoutes.length === 0;
824
- };
825
-
826
- function normalizeAndValidateRoute(
827
- diagnostics: Diagnostics,
828
- topLevelEnv: Environment | undefined,
829
- rawEnv: RawEnvironment
830
- ): Config["route"] {
831
- return inheritable(
832
- diagnostics,
833
- topLevelEnv,
834
- mutateEmptyStringRouteValue(diagnostics, rawEnv),
835
- "route",
836
- isRoute,
837
- undefined
838
- );
839
- }
840
-
841
- function validateRoutes(
842
- diagnostics: Diagnostics,
843
- topLevelEnv: Environment | undefined,
844
- rawEnv: RawEnvironment
845
- ): Config["routes"] {
846
- return inheritable(
847
- diagnostics,
848
- topLevelEnv,
849
- rawEnv,
850
- "routes",
851
- all(isRouteArray, isMutuallyExclusiveWith(rawEnv, "route")),
852
- undefined
853
- );
854
- }
855
-
856
- /**
857
- * Validate top-level environment configuration and return the normalized values.
858
- */
859
- function normalizeAndValidateEnvironment(
860
- diagnostics: Diagnostics,
861
- configPath: string | undefined,
862
- topLevelEnv: RawEnvironment
863
- ): Environment;
864
- /**
865
- * Validate the named environment configuration and return the normalized values.
866
- */
867
- function normalizeAndValidateEnvironment(
868
- diagnostics: Diagnostics,
869
- configPath: string | undefined,
870
- rawEnv: RawEnvironment,
871
- envName: string,
872
- topLevelEnv: Environment,
873
- isLegacyEnv: boolean,
874
- rawConfig: RawConfig
875
- ): Environment;
876
- function normalizeAndValidateEnvironment(
877
- diagnostics: Diagnostics,
878
- configPath: string | undefined,
879
- rawEnv: RawEnvironment,
880
- envName = "top level",
881
- topLevelEnv?: Environment | undefined,
882
- isLegacyEnv?: boolean,
883
- rawConfig?: RawConfig | undefined
884
- ): Environment {
885
- deprecated(
886
- diagnostics,
887
- rawEnv,
888
- "kv-namespaces",
889
- `The "kv-namespaces" field is no longer supported, please rename to "kv_namespaces"`,
890
- true
891
- );
892
- deprecated(
893
- diagnostics,
894
- rawEnv,
895
- "zone_id",
896
- "This is unnecessary since we can deduce this from routes directly.",
897
- false // We need to leave this in-place for the moment since `route` commands might use it.
898
- );
899
-
900
- // The field "experimental_services" doesn't exist anymore in the config, but we still want to error about any older usage.
901
-
902
- deprecated(
903
- diagnostics,
904
- rawEnv,
905
- "experimental_services",
906
- `The "experimental_services" field is no longer supported. Simply rename the [experimental_services] field to [services].`,
907
- true
908
- );
909
-
910
- experimental(diagnostics, rawEnv, "unsafe");
911
- experimental(diagnostics, rawEnv, "services");
912
- experimental(diagnostics, rawEnv, "dispatch_namespaces");
913
-
914
- const route = normalizeAndValidateRoute(diagnostics, topLevelEnv, rawEnv);
915
-
916
- const account_id = inheritableInLegacyEnvironments(
917
- diagnostics,
918
- isLegacyEnv,
919
- topLevelEnv,
920
- mutateEmptyStringAccountIDValue(diagnostics, rawEnv),
921
- "account_id",
922
- isString,
923
- undefined,
924
- undefined
925
- );
926
-
927
- const routes = validateRoutes(diagnostics, topLevelEnv, rawEnv);
928
-
929
- const workers_dev = inheritable(
930
- diagnostics,
931
- topLevelEnv,
932
- rawEnv,
933
- "workers_dev",
934
- isBoolean,
935
- undefined
936
- );
937
-
938
- const { deprecatedUpload, ...build } = normalizeAndValidateBuild(
939
- diagnostics,
940
- rawEnv,
941
- rawEnv.build ?? topLevelEnv?.build ?? {},
942
- configPath
943
- );
944
-
945
- const environment: Environment = {
946
- // Inherited fields
947
- account_id,
948
- compatibility_date: inheritable(
949
- diagnostics,
950
- topLevelEnv,
951
- rawEnv,
952
- "compatibility_date",
953
- isString,
954
- undefined
955
- ),
956
- compatibility_flags: inheritable(
957
- diagnostics,
958
- topLevelEnv,
959
- rawEnv,
960
- "compatibility_flags",
961
- isStringArray,
962
- []
963
- ),
964
- jsx_factory: inheritable(
965
- diagnostics,
966
- topLevelEnv,
967
- rawEnv,
968
- "jsx_factory",
969
- isString,
970
- "React.createElement"
971
- ),
972
- jsx_fragment: inheritable(
973
- diagnostics,
974
- topLevelEnv,
975
- rawEnv,
976
- "jsx_fragment",
977
- isString,
978
- "React.Fragment"
979
- ),
980
- tsconfig: validateAndNormalizeTsconfig(
981
- diagnostics,
982
- topLevelEnv,
983
- rawEnv,
984
- configPath
985
- ),
986
- rules: validateAndNormalizeRules(
987
- diagnostics,
988
- topLevelEnv,
989
- rawEnv,
990
- deprecatedUpload?.rules,
991
- envName
992
- ),
993
- name: inheritableInLegacyEnvironments(
994
- diagnostics,
995
- isLegacyEnv,
996
- topLevelEnv,
997
- rawEnv,
998
- "name",
999
- isValidName,
1000
- appendEnvName(envName),
1001
- undefined
1002
- ),
1003
- main: normalizeAndValidateMainField(
1004
- configPath,
1005
- inheritable(
1006
- diagnostics,
1007
- topLevelEnv,
1008
- rawEnv,
1009
- "main",
1010
- isString,
1011
- undefined
1012
- ),
1013
- deprecatedUpload
1014
- ),
1015
- route,
1016
- routes,
1017
- triggers: inheritable(
1018
- diagnostics,
1019
- topLevelEnv,
1020
- rawEnv,
1021
- "triggers",
1022
- isObjectWith("crons"),
1023
- { crons: [] }
1024
- ),
1025
- usage_model: inheritable(
1026
- diagnostics,
1027
- topLevelEnv,
1028
- rawEnv,
1029
- "usage_model",
1030
- isOneOf("bundled", "unbound"),
1031
- undefined
1032
- ),
1033
- build,
1034
- workers_dev,
1035
- // Not inherited fields
1036
- vars: notInheritable(
1037
- diagnostics,
1038
- topLevelEnv,
1039
- rawConfig,
1040
- rawEnv,
1041
- envName,
1042
- "vars",
1043
- validateVars(envName),
1044
- {}
1045
- ),
1046
- define: notInheritable(
1047
- diagnostics,
1048
- topLevelEnv,
1049
- rawConfig,
1050
- rawEnv,
1051
- envName,
1052
- "define",
1053
- validateDefines(envName),
1054
- {}
1055
- ),
1056
- durable_objects: notInheritable(
1057
- diagnostics,
1058
- topLevelEnv,
1059
- rawConfig,
1060
- rawEnv,
1061
- envName,
1062
- "durable_objects",
1063
- validateBindingsProperty(envName, validateDurableObjectBinding),
1064
- {
1065
- bindings: [],
1066
- }
1067
- ),
1068
- kv_namespaces: notInheritable(
1069
- diagnostics,
1070
- topLevelEnv,
1071
- rawConfig,
1072
- rawEnv,
1073
- envName,
1074
- "kv_namespaces",
1075
- validateBindingArray(envName, validateKVBinding),
1076
- []
1077
- ),
1078
- r2_buckets: notInheritable(
1079
- diagnostics,
1080
- topLevelEnv,
1081
- rawConfig,
1082
- rawEnv,
1083
- envName,
1084
- "r2_buckets",
1085
- validateBindingArray(envName, validateR2Binding),
1086
- []
1087
- ),
1088
- d1_databases: notInheritable(
1089
- diagnostics,
1090
- topLevelEnv,
1091
- rawConfig,
1092
- rawEnv,
1093
- envName,
1094
- "d1_databases",
1095
- validateBindingArray(envName, validateD1Binding),
1096
- []
1097
- ),
1098
- services: notInheritable(
1099
- diagnostics,
1100
- topLevelEnv,
1101
- rawConfig,
1102
- rawEnv,
1103
- envName,
1104
- "services",
1105
- validateBindingArray(envName, validateServiceBinding),
1106
- []
1107
- ),
1108
- dispatch_namespaces: notInheritable(
1109
- diagnostics,
1110
- topLevelEnv,
1111
- rawConfig,
1112
- rawEnv,
1113
- envName,
1114
- "dispatch_namespaces",
1115
- validateBindingArray(envName, validateWorkerNamespaceBinding),
1116
- []
1117
- ),
1118
- logfwdr: inheritable(
1119
- diagnostics,
1120
- topLevelEnv,
1121
- rawEnv,
1122
- "logfwdr",
1123
- validateBindingsProperty(envName, validateCflogfwdrBinding),
1124
- {
1125
- schema: undefined,
1126
- bindings: [],
1127
- }
1128
- ),
1129
- unsafe: notInheritable(
1130
- diagnostics,
1131
- topLevelEnv,
1132
- rawConfig,
1133
- rawEnv,
1134
- envName,
1135
- "unsafe",
1136
- validateBindingsProperty(envName, validateUnsafeBinding),
1137
- {
1138
- bindings: [],
1139
- }
1140
- ),
1141
- zone_id: rawEnv.zone_id,
1142
- no_bundle: inheritable(
1143
- diagnostics,
1144
- topLevelEnv,
1145
- rawEnv,
1146
- "no_bundle",
1147
- isBoolean,
1148
- undefined
1149
- ),
1150
- minify: inheritable(
1151
- diagnostics,
1152
- topLevelEnv,
1153
- rawEnv,
1154
- "minify",
1155
- isBoolean,
1156
- undefined
1157
- ),
1158
- node_compat: inheritable(
1159
- diagnostics,
1160
- topLevelEnv,
1161
- rawEnv,
1162
- "node_compat",
1163
- isBoolean,
1164
- undefined
1165
- ),
1166
- first_party_worker: inheritable(
1167
- diagnostics,
1168
- topLevelEnv,
1169
- rawEnv,
1170
- "first_party_worker",
1171
- isBoolean,
1172
- undefined
1173
- ),
1174
- };
1175
-
1176
- return environment;
1177
- }
1178
-
1179
- function validateAndNormalizeTsconfig(
1180
- diagnostics: Diagnostics,
1181
- topLevelEnv: Environment | undefined,
1182
- rawEnv: RawEnvironment,
1183
- configPath: string | undefined
1184
- ) {
1185
- const tsconfig = inheritable(
1186
- diagnostics,
1187
- topLevelEnv,
1188
- rawEnv,
1189
- "tsconfig",
1190
- isString,
1191
- undefined
1192
- );
1193
-
1194
- return configPath && tsconfig
1195
- ? path.relative(
1196
- process.cwd(),
1197
- path.join(path.dirname(configPath), tsconfig)
1198
- )
1199
- : tsconfig;
1200
- }
1201
-
1202
- const validateAndNormalizeRules = (
1203
- diagnostics: Diagnostics,
1204
- topLevelEnv: Environment | undefined,
1205
- rawEnv: RawEnvironment,
1206
- deprecatedRules: Rule[] | undefined,
1207
- envName: string
1208
- ): Rule[] => {
1209
- if (topLevelEnv === undefined) {
1210
- // Only create errors/warnings for the top-level environment
1211
- if (rawEnv.rules && deprecatedRules) {
1212
- diagnostics.errors.push(
1213
- `You cannot configure both [rules] and [build.upload.rules] in your wrangler.toml. Delete the \`build.upload\` section.`
1214
- );
1215
- } else if (deprecatedRules) {
1216
- diagnostics.warnings.push(
1217
- `Deprecation: The \`build.upload.rules\` config field is no longer used, the rules should be specified via the \`rules\` config field. Delete the \`build.upload\` field from the configuration file, and add this:\n` +
1218
- "```\n" +
1219
- TOML.stringify({ rules: deprecatedRules }) +
1220
- "```"
1221
- );
1222
- }
1223
- }
1224
-
1225
- return inheritable(
1226
- diagnostics,
1227
- topLevelEnv,
1228
- rawEnv,
1229
- "rules",
1230
- validateRules(envName),
1231
- deprecatedRules ?? []
1232
- );
1233
- };
1234
-
1235
- const validateRules =
1236
- (envName: string): ValidatorFn =>
1237
- (diagnostics, field, envValue, config) => {
1238
- if (!envValue) {
1239
- return true;
1240
- }
1241
- const fieldPath =
1242
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1243
- if (!Array.isArray(envValue)) {
1244
- diagnostics.errors.push(
1245
- `The field "${fieldPath}" should be an array but got ${JSON.stringify(
1246
- envValue
1247
- )}.`
1248
- );
1249
- return false;
1250
- }
1251
-
1252
- let isValid = true;
1253
- for (let i = 0; i < envValue.length; i++) {
1254
- isValid =
1255
- validateRule(diagnostics, `${fieldPath}[${i}]`, envValue[i], config) &&
1256
- isValid;
1257
- }
1258
- return isValid;
1259
- };
1260
-
1261
- const validateRule: ValidatorFn = (diagnostics, field, value) => {
1262
- if (typeof value !== "object" || value === null) {
1263
- diagnostics.errors.push(
1264
- `"${field}" should be an object but got ${JSON.stringify(value)}.`
1265
- );
1266
- return false;
1267
- }
1268
- // Rules must have a type string and glob string array, and optionally a fallthrough boolean.
1269
- let isValid = true;
1270
- const rule = value as Rule;
1271
-
1272
- if (
1273
- !isRequiredProperty(rule, "type", "string", [
1274
- "ESModule",
1275
- "CommonJS",
1276
- "CompiledWasm",
1277
- "Text",
1278
- "Data",
1279
- ])
1280
- ) {
1281
- diagnostics.errors.push(
1282
- `bindings should have a string "type" field, which contains one of "ESModule", "CommonJS", "CompiledWasm", "Text", or "Data".`
1283
- );
1284
- isValid = false;
1285
- }
1286
-
1287
- isValid =
1288
- validateTypedArray(diagnostics, `${field}.globs`, rule.globs, "string") &&
1289
- isValid;
1290
-
1291
- if (!isOptionalProperty(rule, "fallthrough", "boolean")) {
1292
- diagnostics.errors.push(
1293
- `the field "fallthrough", when present, should be a boolean.`
1294
- );
1295
- isValid = false;
1296
- }
1297
-
1298
- return isValid;
1299
- };
1300
-
1301
- const validateDefines =
1302
- (envName: string): ValidatorFn =>
1303
- (diagnostics, field, value, config) => {
1304
- let isValid = true;
1305
- const fieldPath =
1306
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1307
-
1308
- if (typeof value === "object" && value !== null) {
1309
- for (const varName in value) {
1310
- // some casting here to appease typescript
1311
- // even though the value might not match the type
1312
- if (typeof (value as Record<string, string>)[varName] !== "string") {
1313
- diagnostics.errors.push(
1314
- `The field "${fieldPath}.${varName}" should be a string but got ${JSON.stringify(
1315
- (value as Record<string, string>)[varName]
1316
- )}.`
1317
- );
1318
- isValid = false;
1319
- }
1320
- }
1321
- } else {
1322
- if (value !== undefined) {
1323
- diagnostics.errors.push(
1324
- `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1325
- value
1326
- )}.\n`
1327
- );
1328
- isValid = false;
1329
- }
1330
- }
1331
-
1332
- const configDefines = Object.keys(config?.define ?? {});
1333
-
1334
- // If there are no top level vars then there is nothing to do here.
1335
- if (configDefines.length > 0) {
1336
- if (typeof value === "object" && value !== null) {
1337
- const configEnvDefines = config === undefined ? [] : Object.keys(value);
1338
-
1339
- for (const varName of configDefines) {
1340
- if (!(varName in value)) {
1341
- diagnostics.warnings.push(
1342
- `"define.${varName}" exists at the top level, but not on "${fieldPath}".\n` +
1343
- `This is not what you probably want, since "define" configuration is not inherited by environments.\n` +
1344
- `Please add "define.${varName}" to "env.${envName}".`
1345
- );
1346
- }
1347
- }
1348
- for (const varName of configEnvDefines) {
1349
- if (!configDefines.includes(varName)) {
1350
- diagnostics.warnings.push(
1351
- `"${varName}" exists on "env.${envName}", but not on the top level.\n` +
1352
- `This is not what you probably want, since "define" configuration within environments can only override existing top level "define" configuration\n` +
1353
- `Please remove "${fieldPath}.${varName}", or add "define.${varName}".`
1354
- );
1355
- }
1356
- }
1357
- }
1358
- }
1359
-
1360
- return isValid;
1361
- };
1362
-
1363
- const validateVars =
1364
- (envName: string): ValidatorFn =>
1365
- (diagnostics, field, value, config) => {
1366
- let isValid = true;
1367
- const fieldPath =
1368
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1369
- const configVars = Object.keys(config?.vars ?? {});
1370
- // If there are no top level vars then there is nothing to do here.
1371
- if (configVars.length > 0) {
1372
- if (typeof value !== "object" || value === null) {
1373
- diagnostics.errors.push(
1374
- `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1375
- value
1376
- )}.\n`
1377
- );
1378
- isValid = false;
1379
- } else {
1380
- for (const varName of configVars) {
1381
- if (!(varName in value)) {
1382
- diagnostics.warnings.push(
1383
- `"vars.${varName}" exists at the top level, but not on "${fieldPath}".\n` +
1384
- `This is not what you probably want, since "vars" configuration is not inherited by environments.\n` +
1385
- `Please add "vars.${varName}" to "env.${envName}".`
1386
- );
1387
- }
1388
- }
1389
- }
1390
- }
1391
- return isValid;
1392
- };
1393
-
1394
- const validateBindingsProperty =
1395
- (envName: string, validateBinding: ValidatorFn): ValidatorFn =>
1396
- (diagnostics, field, value, config) => {
1397
- let isValid = true;
1398
- const fieldPath =
1399
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1400
-
1401
- if (value !== undefined) {
1402
- // Check the validity of the `value` as a bindings container.
1403
- if (typeof value !== "object" || value === null || Array.isArray(value)) {
1404
- diagnostics.errors.push(
1405
- `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1406
- value
1407
- )}.`
1408
- );
1409
- isValid = false;
1410
- } else if (!hasProperty(value, "bindings")) {
1411
- diagnostics.errors.push(
1412
- `The field "${fieldPath}" is missing the required "bindings" property.`
1413
- );
1414
- isValid = false;
1415
- } else if (!Array.isArray(value.bindings)) {
1416
- diagnostics.errors.push(
1417
- `The field "${fieldPath}.bindings" should be an array but got ${JSON.stringify(
1418
- value.bindings
1419
- )}.`
1420
- );
1421
- isValid = false;
1422
- } else {
1423
- for (let i = 0; i < value.bindings.length; i++) {
1424
- const binding = value.bindings[i];
1425
- const bindingDiagnostics = new Diagnostics(
1426
- `"${fieldPath}.bindings[${i}]": ${JSON.stringify(binding)}`
1427
- );
1428
- isValid =
1429
- validateBinding(
1430
- bindingDiagnostics,
1431
- `${fieldPath}.bindings[${i}]`,
1432
- binding,
1433
- config
1434
- ) && isValid;
1435
- diagnostics.addChild(bindingDiagnostics);
1436
- }
1437
- }
1438
-
1439
- const configBindingNames = getBindingNames(
1440
- config?.[field as keyof Environment]
1441
- );
1442
- if (isValid && configBindingNames.length > 0) {
1443
- // If there are top level bindings then check that they all appear in the environment.
1444
- const envBindingNames = new Set(getBindingNames(value));
1445
- const missingBindings = configBindingNames.filter(
1446
- (name) => !envBindingNames.has(name)
1447
- );
1448
- if (missingBindings.length > 0) {
1449
- diagnostics.warnings.push(
1450
- `The following bindings are at the top level, but not on "env.${envName}".\n` +
1451
- `This is not what you probably want, since "${field}" configuration is not inherited by environments.\n` +
1452
- `Please add a binding for each to "${fieldPath}.bindings":\n` +
1453
- missingBindings.map((name) => `- ${name}`).join("\n")
1454
- );
1455
- }
1456
- }
1457
- }
1458
- return isValid;
1459
- };
1460
-
1461
- /**
1462
- * Check that the given field is a valid "durable_object" binding object.
1463
- */
1464
- const validateDurableObjectBinding: ValidatorFn = (
1465
- diagnostics,
1466
- field,
1467
- value
1468
- ) => {
1469
- if (typeof value !== "object" || value === null) {
1470
- diagnostics.errors.push(
1471
- `Expected "${field}" to be an object but got ${JSON.stringify(value)}`
1472
- );
1473
- return false;
1474
- }
1475
-
1476
- // Durable Object bindings must have a name and class_name, and optionally a script_name and an environment.
1477
- let isValid = true;
1478
- if (!isRequiredProperty(value, "name", "string")) {
1479
- diagnostics.errors.push(`binding should have a string "name" field.`);
1480
- isValid = false;
1481
- }
1482
- if (!isRequiredProperty(value, "class_name", "string")) {
1483
- diagnostics.errors.push(`binding should have a string "class_name" field.`);
1484
- isValid = false;
1485
- }
1486
- if (!isOptionalProperty(value, "script_name", "string")) {
1487
- diagnostics.errors.push(
1488
- `the field "script_name", when present, should be a string.`
1489
- );
1490
- isValid = false;
1491
- }
1492
- // environment requires a script_name
1493
- if (!isOptionalProperty(value, "environment", "string")) {
1494
- diagnostics.errors.push(
1495
- `the field "environment", when present, should be a string.`
1496
- );
1497
- isValid = false;
1498
- }
1499
-
1500
- if ("environment" in value && !("script_name" in value)) {
1501
- diagnostics.errors.push(
1502
- `binding should have a "script_name" field if "environment" is present.`
1503
- );
1504
- isValid = false;
1505
- }
1506
-
1507
- return isValid;
1508
- };
1509
-
1510
- const validateCflogfwdrBinding: ValidatorFn = (diagnostics, field, value) => {
1511
- if (typeof value !== "object" || value === null) {
1512
- diagnostics.errors.push(
1513
- `Expected "${field}" to be an object but got ${JSON.stringify(value)}`
1514
- );
1515
- return false;
1516
- }
1517
-
1518
- let isValid = true;
1519
- if (!isRequiredProperty(value, "name", "string")) {
1520
- diagnostics.errors.push(`binding should have a string "name" field.`);
1521
- isValid = false;
1522
- }
1523
-
1524
- if (!isRequiredProperty(value, "destination", "string")) {
1525
- diagnostics.errors.push(
1526
- `binding should have a string "destination" field.`
1527
- );
1528
- isValid = false;
1529
- }
1530
-
1531
- return isValid;
1532
- };
1533
-
1534
- /**
1535
- * Check that the given field is a valid "unsafe" binding object.
1536
- *
1537
- * TODO: further validation of known unsafe bindings.
1538
- */
1539
- const validateUnsafeBinding: ValidatorFn = (diagnostics, field, value) => {
1540
- if (typeof value !== "object" || value === null) {
1541
- diagnostics.errors.push(
1542
- `Expected ${field} to be an object but got ${JSON.stringify(value)}.`
1543
- );
1544
- return false;
1545
- }
1546
-
1547
- let isValid = true;
1548
- // Unsafe bindings must have a name and type.
1549
- if (!isRequiredProperty(value, "name", "string")) {
1550
- diagnostics.errors.push(`binding should have a string "name" field.`);
1551
- isValid = false;
1552
- }
1553
- if (isRequiredProperty(value, "type", "string")) {
1554
- const safeBindings = [
1555
- "plain_text",
1556
- "json",
1557
- "wasm_module",
1558
- "data_blob",
1559
- "text_blob",
1560
- "kv_namespace",
1561
- "durable_object_namespace",
1562
- "d1_database",
1563
- "r2_bucket",
1564
- "service",
1565
- "logfwdr",
1566
- ];
1567
-
1568
- if (safeBindings.includes(value.type)) {
1569
- diagnostics.warnings.push(
1570
- `The binding type "${value.type}" is directly supported by wrangler.\n` +
1571
- `Consider migrating this unsafe binding to a format for '${value.type}' bindings that is supported by wrangler for optimal support.\n` +
1572
- "For more details, see https://developers.cloudflare.com/workers/cli-wrangler/configuration"
1573
- );
1574
- }
1575
- } else {
1576
- diagnostics.errors.push(`binding should have a string "type" field.`);
1577
- isValid = false;
1578
- }
1579
- return isValid;
1580
- };
1581
-
1582
- /**
1583
- * Check that the given environment field is a valid array of bindings.
1584
- */
1585
- const validateBindingArray =
1586
- (envName: string, validateBinding: ValidatorFn): ValidatorFn =>
1587
- (diagnostics, field, envValue, config) => {
1588
- if (envValue === undefined) {
1589
- return true;
1590
- }
1591
-
1592
- const fieldPath =
1593
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1594
- if (!Array.isArray(envValue)) {
1595
- diagnostics.errors.push(
1596
- `The field "${fieldPath}" should be an array but got ${JSON.stringify(
1597
- envValue
1598
- )}.`
1599
- );
1600
- return false;
1601
- }
1602
-
1603
- let isValid = true;
1604
- for (let i = 0; i < envValue.length; i++) {
1605
- isValid =
1606
- validateBinding(
1607
- diagnostics,
1608
- `${fieldPath}[${i}]`,
1609
- envValue[i],
1610
- config
1611
- ) && isValid;
1612
- }
1613
- const configValue = config?.[field as keyof Environment] as {
1614
- binding: unknown;
1615
- }[];
1616
- if (Array.isArray(configValue)) {
1617
- const configBindingNames = configValue.map((value) => value.binding);
1618
- // If there are no top level bindings then there is nothing to do here.
1619
- if (configBindingNames.length > 0) {
1620
- const envBindingNames = new Set(envValue.map((value) => value.binding));
1621
- for (const configBindingName of configBindingNames) {
1622
- if (!envBindingNames.has(configBindingName)) {
1623
- diagnostics.warnings.push(
1624
- `There is a ${field} binding with name "${configBindingName}" at the top level, but not on "env.${envName}".\n` +
1625
- `This is not what you probably want, since "${field}" configuration is not inherited by environments.\n` +
1626
- `Please add a binding for "${configBindingName}" to "env.${envName}.${field}.bindings".`
1627
- );
1628
- }
1629
- }
1630
- }
1631
- }
1632
- return isValid;
1633
- };
1634
-
1635
- const validateKVBinding: ValidatorFn = (diagnostics, field, value) => {
1636
- if (typeof value !== "object" || value === null) {
1637
- diagnostics.errors.push(
1638
- `"kv_namespaces" bindings should be objects, but got ${JSON.stringify(
1639
- value
1640
- )}`
1641
- );
1642
- return false;
1643
- }
1644
- let isValid = true;
1645
- // KV bindings must have a binding and id.
1646
- if (!isRequiredProperty(value, "binding", "string")) {
1647
- diagnostics.errors.push(
1648
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1649
- value
1650
- )}.`
1651
- );
1652
- isValid = false;
1653
- }
1654
- if (
1655
- !isRequiredProperty(value, "id", "string") ||
1656
- (value as { id: string }).id.length === 0
1657
- ) {
1658
- diagnostics.errors.push(
1659
- `"${field}" bindings should have a string "id" field but got ${JSON.stringify(
1660
- value
1661
- )}.`
1662
- );
1663
- isValid = false;
1664
- }
1665
- if (!isOptionalProperty(value, "preview_id", "string")) {
1666
- diagnostics.errors.push(
1667
- `"${field}" bindings should, optionally, have a string "preview_id" field but got ${JSON.stringify(
1668
- value
1669
- )}.`
1670
- );
1671
- isValid = false;
1672
- }
1673
- return isValid;
1674
- };
1675
-
1676
- const validateR2Binding: ValidatorFn = (diagnostics, field, value) => {
1677
- if (typeof value !== "object" || value === null) {
1678
- diagnostics.errors.push(
1679
- `"r2_buckets" bindings should be objects, but got ${JSON.stringify(
1680
- value
1681
- )}`
1682
- );
1683
- return false;
1684
- }
1685
- let isValid = true;
1686
- // R2 bindings must have a binding and bucket_name.
1687
- if (!isRequiredProperty(value, "binding", "string")) {
1688
- diagnostics.errors.push(
1689
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1690
- value
1691
- )}.`
1692
- );
1693
- isValid = false;
1694
- }
1695
- if (
1696
- !isRequiredProperty(value, "bucket_name", "string") ||
1697
- (value as { bucket_name: string }).bucket_name.length === 0
1698
- ) {
1699
- diagnostics.errors.push(
1700
- `"${field}" bindings should have a string "bucket_name" field but got ${JSON.stringify(
1701
- value
1702
- )}.`
1703
- );
1704
- isValid = false;
1705
- }
1706
- if (!isOptionalProperty(value, "preview_bucket_name", "string")) {
1707
- diagnostics.errors.push(
1708
- `"${field}" bindings should, optionally, have a string "preview_bucket_name" field but got ${JSON.stringify(
1709
- value
1710
- )}.`
1711
- );
1712
- isValid = false;
1713
- }
1714
- return isValid;
1715
- };
1716
-
1717
- const validateD1Binding: ValidatorFn = (diagnostics, field, value) => {
1718
- if (typeof value !== "object" || value === null) {
1719
- diagnostics.errors.push(
1720
- `"d1_databases" bindings should be objects, but got ${JSON.stringify(
1721
- value
1722
- )}`
1723
- );
1724
- return false;
1725
- }
1726
- let isValid = true;
1727
- // D1 databases must have a binding and either a database_name or database_id.
1728
- if (!isRequiredProperty(value, "binding", "string")) {
1729
- diagnostics.errors.push(
1730
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1731
- value
1732
- )}.`
1733
- );
1734
- isValid = false;
1735
- }
1736
- if (
1737
- // TODO: allow name only, where we look up the ID dynamically
1738
- // !isOptionalProperty(value, "database_name", "string") &&
1739
- !isRequiredProperty(value, "database_id", "string")
1740
- ) {
1741
- diagnostics.errors.push(
1742
- `"${field}" bindings must have a "database_id" field but got ${JSON.stringify(
1743
- value
1744
- )}.`
1745
- );
1746
- isValid = false;
1747
- }
1748
- if (!isOptionalProperty(value, "preview_database_id", "string")) {
1749
- diagnostics.errors.push(
1750
- `"${field}" bindings should, optionally, have a string "preview_database_id" field but got ${JSON.stringify(
1751
- value
1752
- )}.`
1753
- );
1754
- isValid = false;
1755
- }
1756
- if (isValid && !process.env.NO_D1_WARNING) {
1757
- diagnostics.warnings.push(
1758
- `D1 Bindings are currently in beta to allow the API to evolve before general availability.\nPlease report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose\nNote: set NO_D1_WARNING=true to hide this message`
1759
- );
1760
- }
1761
- return isValid;
1762
- };
1763
-
1764
- /**
1765
- * Check that bindings whose names might conflict, don't.
1766
- *
1767
- * We don't want to have, for example, a KV namespace named "DATA"
1768
- * and a Durable Object also named "DATA". Then it would be ambiguous
1769
- * what exactly would live at `env.DATA` (or in the case of service-workers,
1770
- * the `DATA` global).
1771
- */
1772
- const validateBindingsHaveUniqueNames = (
1773
- diagnostics: Diagnostics,
1774
- {
1775
- durable_objects,
1776
- kv_namespaces,
1777
- r2_buckets,
1778
- text_blobs,
1779
- unsafe,
1780
- vars,
1781
- define,
1782
- wasm_modules,
1783
- data_blobs,
1784
- }: Partial<Config>
1785
- ): boolean => {
1786
- let hasDuplicates = false;
1787
-
1788
- const bindingsGroupedByType = {
1789
- "Durable Object": getBindingNames(durable_objects),
1790
- "KV Namespace": getBindingNames(kv_namespaces),
1791
- "R2 Bucket": getBindingNames(r2_buckets),
1792
- "Text Blob": getBindingNames(text_blobs),
1793
- Unsafe: getBindingNames(unsafe),
1794
- "Environment Variable": getBindingNames(vars),
1795
- Definition: getBindingNames(define),
1796
- "WASM Module": getBindingNames(wasm_modules),
1797
- "Data Blob": getBindingNames(data_blobs),
1798
- } as Record<string, string[]>;
1799
-
1800
- const bindingsGroupedByName: Record<string, string[]> = {};
1801
-
1802
- for (const bindingType in bindingsGroupedByType) {
1803
- const bindingNames = bindingsGroupedByType[bindingType];
1804
-
1805
- for (const bindingName of bindingNames) {
1806
- if (!(bindingName in bindingsGroupedByName)) {
1807
- bindingsGroupedByName[bindingName] = [];
1808
- }
1809
-
1810
- bindingsGroupedByName[bindingName].push(bindingType);
1811
- }
1812
- }
1813
-
1814
- for (const bindingName in bindingsGroupedByName) {
1815
- const bindingTypes = bindingsGroupedByName[bindingName];
1816
- if (bindingTypes.length < 2) {
1817
- // there's only one (or zero) binding(s) with this name, which is fine, actually
1818
- continue;
1819
- }
1820
-
1821
- hasDuplicates = true;
1822
-
1823
- // there's two types of duplicates we want to look for:
1824
- // - bindings with the same name of the same type (e.g. two Durable Objects both named "OBJ")
1825
- // - bindings with the same name of different types (a KV namespace and DO both named "DATA")
1826
-
1827
- const sameType = bindingTypes
1828
- // filter once to find duplicate binding types
1829
- .filter((type, i) => bindingTypes.indexOf(type) !== i)
1830
- // filter twice to only get _unique_ duplicate binding types
1831
- .filter(
1832
- (type, i, duplicateBindingTypes) =>
1833
- duplicateBindingTypes.indexOf(type) === i
1834
- );
1835
-
1836
- const differentTypes = bindingTypes.filter(
1837
- (type, i) => bindingTypes.indexOf(type) === i
1838
- );
1839
-
1840
- if (differentTypes.length > 1) {
1841
- // we have multiple different types using the same name
1842
- diagnostics.errors.push(
1843
- `${bindingName} assigned to ${ENGLISH.format(differentTypes)} bindings.`
1844
- );
1845
- }
1846
-
1847
- sameType.forEach((bindingType) => {
1848
- diagnostics.errors.push(
1849
- `${bindingName} assigned to multiple ${bindingType} bindings.`
1850
- );
1851
- });
1852
- }
1853
-
1854
- if (hasDuplicates) {
1855
- const problem =
1856
- "Bindings must have unique names, so that they can all be referenced in the worker.";
1857
- const resolution = "Please change your bindings to have unique names.";
1858
- diagnostics.errors.push(`${problem}\n${resolution}`);
1859
- }
1860
-
1861
- return !hasDuplicates;
1862
- };
1863
-
1864
- const validateServiceBinding: ValidatorFn = (diagnostics, field, value) => {
1865
- if (typeof value !== "object" || value === null) {
1866
- diagnostics.errors.push(
1867
- `"services" bindings should be objects, but got ${JSON.stringify(value)}`
1868
- );
1869
- return false;
1870
- }
1871
- let isValid = true;
1872
- // Service bindings must have a binding, service, and environment.
1873
- if (!isRequiredProperty(value, "binding", "string")) {
1874
- diagnostics.errors.push(
1875
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1876
- value
1877
- )}.`
1878
- );
1879
- isValid = false;
1880
- }
1881
- if (!isRequiredProperty(value, "service", "string")) {
1882
- diagnostics.errors.push(
1883
- `"${field}" bindings should have a string "service" field but got ${JSON.stringify(
1884
- value
1885
- )}.`
1886
- );
1887
- isValid = false;
1888
- }
1889
- if (!isOptionalProperty(value, "environment", "string")) {
1890
- diagnostics.errors.push(
1891
- `"${field}" bindings should have a string "environment" field but got ${JSON.stringify(
1892
- value
1893
- )}.`
1894
- );
1895
- isValid = false;
1896
- }
1897
- return isValid;
1898
- };
1899
-
1900
- const validateWorkerNamespaceBinding: ValidatorFn = (
1901
- diagnostics,
1902
- field,
1903
- value
1904
- ) => {
1905
- if (typeof value !== "object" || value === null) {
1906
- diagnostics.errors.push(
1907
- `"${field}" binding should be objects, but got ${JSON.stringify(value)}`
1908
- );
1909
- return false;
1910
- }
1911
- let isValid = true;
1912
- // Worker namespace bindings must have a binding, and a namespace.
1913
- if (!isRequiredProperty(value, "binding", "string")) {
1914
- diagnostics.errors.push(
1915
- `"${field}" should have a string "binding" field but got ${JSON.stringify(
1916
- value
1917
- )}.`
1918
- );
1919
- isValid = false;
1920
- }
1921
- if (!isRequiredProperty(value, "namespace", "string")) {
1922
- diagnostics.errors.push(
1923
- `"${field}" should have a string "namespace" field but got ${JSON.stringify(
1924
- value
1925
- )}.`
1926
- );
1927
- isValid = false;
1928
- }
1929
- return isValid;
1930
- };