wrangler 0.0.0-e7cf0caa → 0.0.0-e8053554

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 (308) hide show
  1. package/README.md +10 -12
  2. package/bin/wrangler.js +13 -74
  3. package/package.json +213 -199
  4. package/templates/__tests__/tsconfig.json +1 -1
  5. package/templates/checked-fetch.js +10 -3
  6. package/templates/facade.d.ts +4 -1
  7. package/templates/middleware/common.ts +9 -4
  8. package/templates/middleware/loader-modules.ts +64 -11
  9. package/templates/middleware/loader-sw.ts +2 -7
  10. package/templates/middleware/middleware-d1-beta.d.ts +3 -0
  11. package/templates/middleware/middleware-miniflare3-json-error.ts +1 -0
  12. package/templates/middleware/middleware-multiworker-dev.d.ts +4 -0
  13. package/templates/middleware/middleware-multiworker-dev.ts +68 -0
  14. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  15. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  16. package/templates/modules-watch-stub.js +4 -0
  17. package/templates/new-worker-scheduled.ts +1 -1
  18. package/templates/new-worker.ts +1 -1
  19. package/templates/pages-dev-util.ts +4 -1
  20. package/templates/pages-shim.ts +0 -3
  21. package/templates/pages-template-plugin.ts +12 -2
  22. package/templates/pages-template-worker.ts +11 -2
  23. package/templates/startDevWorker/InspectorProxyWorker.ts +652 -0
  24. package/templates/startDevWorker/ProxyWorker.ts +252 -0
  25. package/templates/tsconfig.json +1 -1
  26. package/wrangler-dist/InspectorProxyWorker.js +460 -0
  27. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  28. package/wrangler-dist/ProxyWorker.js +186 -0
  29. package/wrangler-dist/ProxyWorker.js.map +6 -0
  30. package/wrangler-dist/cli.d.ts +22048 -182
  31. package/wrangler-dist/cli.js +113098 -104303
  32. package/wrangler-dist/wasm-sync.wasm +0 -0
  33. package/import_meta_url.js +0 -3
  34. package/miniflare-config-stubs/.env.empty +0 -0
  35. package/miniflare-config-stubs/package.empty.json +0 -1
  36. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  37. package/miniflare-dist/index.mjs +0 -6368
  38. package/src/__tests__/access.test.ts +0 -25
  39. package/src/__tests__/api-dev.test.ts +0 -238
  40. package/src/__tests__/api-devregistry.test.ts +0 -121
  41. package/src/__tests__/api.test.ts +0 -102
  42. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  43. package/src/__tests__/config-cache.test.ts +0 -42
  44. package/src/__tests__/configuration.test.ts +0 -4509
  45. package/src/__tests__/d1/d1.test.ts +0 -82
  46. package/src/__tests__/d1/execute.test.ts +0 -66
  47. package/src/__tests__/d1/migrate.test.ts +0 -157
  48. package/src/__tests__/d1/splitter.test.ts +0 -255
  49. package/src/__tests__/delete.test.ts +0 -272
  50. package/src/__tests__/deployments.test.ts +0 -369
  51. package/src/__tests__/dev.test.tsx +0 -1617
  52. package/src/__tests__/generate.test.ts +0 -237
  53. package/src/__tests__/get-host-from-url.test.ts +0 -16
  54. package/src/__tests__/guess-worker-format.test.ts +0 -120
  55. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  56. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  57. package/src/__tests__/helpers/end-event-loop.ts +0 -6
  58. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  59. package/src/__tests__/helpers/mock-auth-domain.ts +0 -20
  60. package/src/__tests__/helpers/mock-bin.ts +0 -36
  61. package/src/__tests__/helpers/mock-console.ts +0 -112
  62. package/src/__tests__/helpers/mock-dialogs.ts +0 -139
  63. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +0 -25
  64. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -11
  65. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  66. package/src/__tests__/helpers/mock-istty.ts +0 -74
  67. package/src/__tests__/helpers/mock-known-routes.ts +0 -12
  68. package/src/__tests__/helpers/mock-kv.ts +0 -46
  69. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -263
  70. package/src/__tests__/helpers/mock-process.ts +0 -34
  71. package/src/__tests__/helpers/mock-set-timeout.ts +0 -16
  72. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  73. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  74. package/src/__tests__/helpers/msw/blob-worker.cjs +0 -19
  75. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  76. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -160
  77. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -81
  78. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  79. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -60
  80. package/src/__tests__/helpers/msw/handlers/script.ts +0 -56
  81. package/src/__tests__/helpers/msw/handlers/user.ts +0 -52
  82. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -20
  83. package/src/__tests__/helpers/msw/index.ts +0 -52
  84. package/src/__tests__/helpers/msw/read-file-sync.js +0 -61
  85. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  86. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  87. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +0 -28
  88. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  89. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  90. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  91. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -11
  92. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  93. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  94. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  95. package/src/__tests__/https-options.test.ts +0 -163
  96. package/src/__tests__/index.test.ts +0 -280
  97. package/src/__tests__/init.test.ts +0 -3196
  98. package/src/__tests__/jest.setup.ts +0 -179
  99. package/src/__tests__/kv.test.ts +0 -1799
  100. package/src/__tests__/logger.test.ts +0 -207
  101. package/src/__tests__/logout.test.ts +0 -47
  102. package/src/__tests__/metrics.test.ts +0 -493
  103. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  104. package/src/__tests__/middleware.test.ts +0 -816
  105. package/src/__tests__/mtls-certificates.test.ts +0 -588
  106. package/src/__tests__/package-manager.test.ts +0 -353
  107. package/src/__tests__/pages/deployment-list.test.ts +0 -80
  108. package/src/__tests__/pages/functions-build.test.ts +0 -452
  109. package/src/__tests__/pages/pages.test.ts +0 -81
  110. package/src/__tests__/pages/project-create.test.ts +0 -63
  111. package/src/__tests__/pages/project-list.test.ts +0 -110
  112. package/src/__tests__/pages/project-upload.test.ts +0 -500
  113. package/src/__tests__/pages/publish.test.ts +0 -2864
  114. package/src/__tests__/pages-deployment-tail.test.ts +0 -955
  115. package/src/__tests__/parse.test.ts +0 -436
  116. package/src/__tests__/paths.test.ts +0 -39
  117. package/src/__tests__/publish.test.ts +0 -8423
  118. package/src/__tests__/pubsub.test.ts +0 -496
  119. package/src/__tests__/queues.test.ts +0 -532
  120. package/src/__tests__/r2.test.ts +0 -374
  121. package/src/__tests__/route.test.ts +0 -45
  122. package/src/__tests__/secret.test.ts +0 -693
  123. package/src/__tests__/tail.test.ts +0 -958
  124. package/src/__tests__/test-old-node-version.js +0 -31
  125. package/src/__tests__/traverse-module-graph.test.ts +0 -220
  126. package/src/__tests__/tsconfig-sanity.ts +0 -12
  127. package/src/__tests__/tsconfig.json +0 -8
  128. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  129. package/src/__tests__/type-generation.test.ts +0 -234
  130. package/src/__tests__/user.test.ts +0 -118
  131. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  132. package/src/__tests__/validate-dev-props.test.ts +0 -56
  133. package/src/__tests__/version.test.ts +0 -35
  134. package/src/__tests__/whoami.test.tsx +0 -172
  135. package/src/__tests__/worker-namespace.test.ts +0 -340
  136. package/src/abort.d.ts +0 -3
  137. package/src/api/dev.ts +0 -316
  138. package/src/api/index.ts +0 -11
  139. package/src/api/mtls-certificate.ts +0 -148
  140. package/src/api/pages/create-worker-bundle-contents.ts +0 -76
  141. package/src/api/pages/index.ts +0 -5
  142. package/src/api/pages/publish.tsx +0 -355
  143. package/src/bundle-reporter.ts +0 -68
  144. package/src/bundle.ts +0 -908
  145. package/src/cfetch/index.ts +0 -158
  146. package/src/cfetch/internal.ts +0 -258
  147. package/src/cli.ts +0 -28
  148. package/src/config/README.md +0 -107
  149. package/src/config/config.ts +0 -282
  150. package/src/config/diagnostics.ts +0 -80
  151. package/src/config/environment.ts +0 -618
  152. package/src/config/index.ts +0 -403
  153. package/src/config/validation-helpers.ts +0 -597
  154. package/src/config/validation.ts +0 -2342
  155. package/src/config-cache.ts +0 -85
  156. package/src/create-worker-preview.ts +0 -293
  157. package/src/create-worker-upload-form.ts +0 -359
  158. package/src/d1/backups.tsx +0 -219
  159. package/src/d1/constants.ts +0 -2
  160. package/src/d1/create.tsx +0 -68
  161. package/src/d1/delete.ts +0 -53
  162. package/src/d1/execute.tsx +0 -357
  163. package/src/d1/formatTimeAgo.ts +0 -14
  164. package/src/d1/index.ts +0 -100
  165. package/src/d1/list.tsx +0 -60
  166. package/src/d1/migrations/apply.tsx +0 -212
  167. package/src/d1/migrations/create.tsx +0 -79
  168. package/src/d1/migrations/helpers.ts +0 -172
  169. package/src/d1/migrations/index.ts +0 -3
  170. package/src/d1/migrations/list.tsx +0 -95
  171. package/src/d1/migrations/options.ts +0 -23
  172. package/src/d1/options.ts +0 -22
  173. package/src/d1/splitter.ts +0 -161
  174. package/src/d1/types.ts +0 -25
  175. package/src/d1/utils.ts +0 -49
  176. package/src/delete.ts +0 -100
  177. package/src/deployments.ts +0 -368
  178. package/src/deprecated/index.ts +0 -144
  179. package/src/dev/dev-vars.ts +0 -39
  180. package/src/dev/dev.tsx +0 -600
  181. package/src/dev/get-local-persistence-path.ts +0 -31
  182. package/src/dev/local.tsx +0 -920
  183. package/src/dev/remote.tsx +0 -632
  184. package/src/dev/start-server.ts +0 -534
  185. package/src/dev/use-esbuild.ts +0 -203
  186. package/src/dev/validate-dev-props.ts +0 -40
  187. package/src/dev-registry.ts +0 -202
  188. package/src/dev.tsx +0 -929
  189. package/src/dialogs.ts +0 -136
  190. package/src/dispatch-namespace.ts +0 -211
  191. package/src/docs/index.ts +0 -97
  192. package/src/durable.ts +0 -102
  193. package/src/entry.ts +0 -337
  194. package/src/environment-variables/factory.ts +0 -88
  195. package/src/environment-variables/misc-variables.ts +0 -30
  196. package/src/errors.ts +0 -11
  197. package/src/generate/index.ts +0 -298
  198. package/src/git-client.ts +0 -135
  199. package/src/global-wrangler-config-path.ts +0 -26
  200. package/src/https-options.ts +0 -127
  201. package/src/index.ts +0 -758
  202. package/src/init.ts +0 -1032
  203. package/src/inspect.ts +0 -782
  204. package/src/intl-polyfill.d.ts +0 -139
  205. package/src/is-ci.ts +0 -14
  206. package/src/is-interactive.ts +0 -16
  207. package/src/jest.d.ts +0 -4
  208. package/src/kv/helpers.ts +0 -430
  209. package/src/kv/index.ts +0 -594
  210. package/src/logger.ts +0 -119
  211. package/src/metrics/index.ts +0 -5
  212. package/src/metrics/metrics-config.ts +0 -239
  213. package/src/metrics/metrics-dispatcher.ts +0 -96
  214. package/src/metrics/metrics-usage-headers.ts +0 -24
  215. package/src/metrics/send-event.ts +0 -99
  216. package/src/miniflare-cli/README.md +0 -30
  217. package/src/miniflare-cli/assets.ts +0 -251
  218. package/src/miniflare-cli/index.ts +0 -210
  219. package/src/miniflare-cli/request-context.ts +0 -40
  220. package/src/miniflare-cli/tsconfig.json +0 -9
  221. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  222. package/src/miniflare-cli/types.ts +0 -11
  223. package/src/module-collection.ts +0 -333
  224. package/src/mtls-certificate/cli.ts +0 -155
  225. package/src/open-in-browser.ts +0 -17
  226. package/src/package-manager.ts +0 -219
  227. package/src/pages/build.ts +0 -410
  228. package/src/pages/buildFunctions.ts +0 -140
  229. package/src/pages/constants.ts +0 -18
  230. package/src/pages/deployment-tails.ts +0 -281
  231. package/src/pages/deployments.tsx +0 -84
  232. package/src/pages/dev.ts +0 -716
  233. package/src/pages/errors.ts +0 -67
  234. package/src/pages/functions/buildPlugin.ts +0 -113
  235. package/src/pages/functions/buildWorker.ts +0 -291
  236. package/src/pages/functions/filepath-routing.test.ts +0 -234
  237. package/src/pages/functions/filepath-routing.ts +0 -189
  238. package/src/pages/functions/identifiers.ts +0 -78
  239. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  240. package/src/pages/functions/routes-consolidation.ts +0 -73
  241. package/src/pages/functions/routes-transformation.test.ts +0 -282
  242. package/src/pages/functions/routes-transformation.ts +0 -115
  243. package/src/pages/functions/routes-validation.test.ts +0 -403
  244. package/src/pages/functions/routes-validation.ts +0 -202
  245. package/src/pages/functions/routes.ts +0 -151
  246. package/src/pages/functions/tsconfig.json +0 -8
  247. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  248. package/src/pages/functions.ts +0 -86
  249. package/src/pages/hash.ts +0 -13
  250. package/src/pages/index.ts +0 -102
  251. package/src/pages/projects.tsx +0 -159
  252. package/src/pages/prompt-select-project.tsx +0 -31
  253. package/src/pages/publish.tsx +0 -267
  254. package/src/pages/types.ts +0 -46
  255. package/src/pages/upload.tsx +0 -469
  256. package/src/pages/utils.ts +0 -23
  257. package/src/parse.ts +0 -308
  258. package/src/paths.ts +0 -71
  259. package/src/proxy.ts +0 -694
  260. package/src/publish/index.ts +0 -274
  261. package/src/publish/publish.ts +0 -1060
  262. package/src/pubsub/index.ts +0 -286
  263. package/src/pubsub/pubsub-commands.ts +0 -623
  264. package/src/queues/cli/commands/consumer/add.ts +0 -71
  265. package/src/queues/cli/commands/consumer/index.ts +0 -19
  266. package/src/queues/cli/commands/consumer/remove.ts +0 -31
  267. package/src/queues/cli/commands/create.ts +0 -25
  268. package/src/queues/cli/commands/delete.ts +0 -26
  269. package/src/queues/cli/commands/index.ts +0 -35
  270. package/src/queues/cli/commands/list.ts +0 -25
  271. package/src/queues/client.ts +0 -136
  272. package/src/queues/utils.ts +0 -18
  273. package/src/r2/constants.ts +0 -4
  274. package/src/r2/helpers.ts +0 -132
  275. package/src/r2/index.ts +0 -289
  276. package/src/routes.ts +0 -140
  277. package/src/secret/index.ts +0 -376
  278. package/src/selfsigned.d.ts +0 -29
  279. package/src/sites.ts +0 -372
  280. package/src/tail/createTail.ts +0 -406
  281. package/src/tail/filters.ts +0 -277
  282. package/src/tail/index.ts +0 -211
  283. package/src/tail/printing.ts +0 -122
  284. package/src/traverse-module-graph.ts +0 -53
  285. package/src/tsconfig-sanity.ts +0 -16
  286. package/src/type-generation.ts +0 -181
  287. package/src/update-check.ts +0 -19
  288. package/src/user/access.ts +0 -68
  289. package/src/user/auth-variables.ts +0 -113
  290. package/src/user/choose-account.tsx +0 -39
  291. package/src/user/generate-auth-url.ts +0 -33
  292. package/src/user/generate-random-state.ts +0 -16
  293. package/src/user/index.ts +0 -2
  294. package/src/user/user.ts +0 -1233
  295. package/src/utils/collectKeyValues.ts +0 -14
  296. package/src/utils/render.ts +0 -93
  297. package/src/whoami.ts +0 -135
  298. package/src/worker.ts +0 -274
  299. package/src/yargs-types.ts +0 -37
  300. package/src/zones.ts +0 -191
  301. package/templates/__tests__/tsconfig.tsbuildinfo +0 -1
  302. package/templates/d1-beta-facade.js +0 -244
  303. package/templates/first-party-worker-module-facade.ts +0 -19
  304. package/templates/format-dev-errors.ts +0 -34
  305. package/templates/serve-static-assets.ts +0 -66
  306. package/templates/service-bindings-module-facade.js +0 -55
  307. package/templates/service-bindings-sw-facade.js +0 -42
  308. package/templates/tsconfig.tsbuildinfo +0 -1
@@ -1,2342 +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 `base_dir` field and return the normalized values.
363
- */
364
- function normalizeAndValidateBaseDirField(
365
- configPath: string | undefined,
366
- rawDir: string | undefined
367
- ): string | undefined {
368
- const configDir = path.dirname(configPath ?? "wrangler.toml");
369
- if (rawDir !== undefined) {
370
- if (typeof rawDir === "string") {
371
- const directory = path.resolve(configDir);
372
- return path.resolve(directory, rawDir);
373
- } else {
374
- return rawDir;
375
- }
376
- } else {
377
- return;
378
- }
379
- }
380
-
381
- /**
382
- * Validate the `dev` configuration and return the normalized values.
383
- */
384
- function normalizeAndValidateDev(
385
- diagnostics: Diagnostics,
386
- rawDev: RawDevConfig
387
- ): DevConfig {
388
- const {
389
- ip = "0.0.0.0",
390
- port,
391
- inspector_port,
392
- local_protocol = "http",
393
- upstream_protocol = "https",
394
- host,
395
- ...rest
396
- } = rawDev;
397
- validateAdditionalProperties(diagnostics, "dev", Object.keys(rest), []);
398
-
399
- validateOptionalProperty(diagnostics, "dev", "ip", ip, "string");
400
- validateOptionalProperty(diagnostics, "dev", "port", port, "number");
401
- validateOptionalProperty(
402
- diagnostics,
403
- "dev",
404
- "inspector_port",
405
- inspector_port,
406
- "number"
407
- );
408
- validateOptionalProperty(
409
- diagnostics,
410
- "dev",
411
- "local_protocol",
412
- local_protocol,
413
- "string",
414
- ["http", "https"]
415
- );
416
- validateOptionalProperty(
417
- diagnostics,
418
- "dev",
419
- "upstream_protocol",
420
- upstream_protocol,
421
- "string",
422
- ["http", "https"]
423
- );
424
- validateOptionalProperty(diagnostics, "dev", "host", host, "string");
425
- return { ip, port, inspector_port, local_protocol, upstream_protocol, host };
426
- }
427
-
428
- /**
429
- * Validate the `migrations` configuration and return the normalized values.
430
- */
431
- function normalizeAndValidateMigrations(
432
- diagnostics: Diagnostics,
433
- rawMigrations: Config["migrations"],
434
- durableObjects: Config["durable_objects"]
435
- ): Config["migrations"] {
436
- if (!Array.isArray(rawMigrations)) {
437
- diagnostics.errors.push(
438
- `The optional "migrations" field should be an array, but got ${JSON.stringify(
439
- rawMigrations
440
- )}`
441
- );
442
- return [];
443
- } else {
444
- for (let i = 0; i < rawMigrations.length; i++) {
445
- const { tag, new_classes, renamed_classes, deleted_classes, ...rest } =
446
- rawMigrations[i];
447
-
448
- validateAdditionalProperties(
449
- diagnostics,
450
- "migrations",
451
- Object.keys(rest),
452
- []
453
- );
454
-
455
- validateRequiredProperty(
456
- diagnostics,
457
- `migrations[${i}]`,
458
- `tag`,
459
- tag,
460
- "string"
461
- );
462
- validateOptionalTypedArray(
463
- diagnostics,
464
- `migrations[${i}].new_classes`,
465
- new_classes,
466
- "string"
467
- );
468
- if (renamed_classes !== undefined) {
469
- if (!Array.isArray(renamed_classes)) {
470
- diagnostics.errors.push(
471
- `Expected "migrations[${i}].renamed_classes" to be an array of "{from: string, to: string}" objects but got ${JSON.stringify(
472
- renamed_classes
473
- )}.`
474
- );
475
- } else if (
476
- renamed_classes.some(
477
- (c) =>
478
- typeof c !== "object" ||
479
- !isRequiredProperty(c, "from", "string") ||
480
- !isRequiredProperty(c, "to", "string")
481
- )
482
- ) {
483
- diagnostics.errors.push(
484
- `Expected "migrations[${i}].renamed_classes" to be an array of "{from: string, to: string}" objects but got ${JSON.stringify(
485
- renamed_classes
486
- )}.`
487
- );
488
- }
489
- }
490
- validateOptionalTypedArray(
491
- diagnostics,
492
- `migrations[${i}].deleted_classes`,
493
- deleted_classes,
494
- "string"
495
- );
496
- }
497
-
498
- if (
499
- Array.isArray(durableObjects?.bindings) &&
500
- durableObjects.bindings.length > 0
501
- ) {
502
- // intrinsic [durable_objects] implies [migrations]
503
- const exportedDurableObjects = (durableObjects.bindings || []).filter(
504
- (binding) => !binding.script_name
505
- );
506
- if (exportedDurableObjects.length > 0 && rawMigrations.length === 0) {
507
- if (
508
- !exportedDurableObjects.some(
509
- (exportedDurableObject) =>
510
- typeof exportedDurableObject.class_name !== "string"
511
- )
512
- ) {
513
- const durableObjectClassnames = exportedDurableObjects.map(
514
- (durable) => durable.class_name
515
- );
516
-
517
- diagnostics.warnings.push(
518
- `In wrangler.toml, you have configured [durable_objects] exported by this Worker (${durableObjectClassnames.join(
519
- ", "
520
- )}), 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:
521
-
522
- \`\`\`
523
- [[migrations]]
524
- tag = "v1" # Should be unique for each entry
525
- new_classes = [${durableObjectClassnames
526
- .map((name) => `"${name}"`)
527
- .join(", ")}]
528
- \`\`\`
529
-
530
- Refer to https://developers.cloudflare.com/workers/learning/using-durable-objects/#durable-object-migrations-in-wranglertoml for more details.`
531
- );
532
- }
533
- }
534
- }
535
-
536
- return rawMigrations;
537
- }
538
- }
539
-
540
- /**
541
- * Validate the `site` configuration and return the normalized values.
542
- */
543
- function normalizeAndValidateSite(
544
- diagnostics: Diagnostics,
545
- configPath: string | undefined,
546
- rawConfig: RawConfig,
547
- mainEntryPoint: string | undefined
548
- ): Config["site"] {
549
- if (rawConfig?.site !== undefined) {
550
- const { bucket, include = [], exclude = [], ...rest } = rawConfig.site;
551
-
552
- validateAdditionalProperties(diagnostics, "site", Object.keys(rest), [
553
- "entry-point",
554
- ]);
555
- validateRequiredProperty(diagnostics, "site", "bucket", bucket, "string");
556
- validateTypedArray(diagnostics, "sites.include", include, "string");
557
- validateTypedArray(diagnostics, "sites.exclude", exclude, "string");
558
- validateOptionalProperty(
559
- diagnostics,
560
- "site",
561
- "entry-point",
562
- rawConfig.site["entry-point"],
563
- "string"
564
- );
565
-
566
- deprecated(
567
- diagnostics,
568
- rawConfig,
569
- `site.entry-point`,
570
- `Delete the \`site.entry-point\` field, then add the top level \`main\` field to your configuration file:\n` +
571
- `\`\`\`\n` +
572
- `main = "${path.join(
573
- String(rawConfig.site["entry-point"]) || "workers-site",
574
- path.extname(String(rawConfig.site["entry-point"]) || "workers-site")
575
- ? ""
576
- : "index.js"
577
- )}"\n` +
578
- `\`\`\``,
579
- false,
580
- undefined,
581
- "warning"
582
- );
583
-
584
- let siteEntryPoint = rawConfig.site["entry-point"];
585
-
586
- if (!mainEntryPoint && !siteEntryPoint) {
587
- // this means that we're defaulting to "workers-site"
588
- // so let's add the deprecation warning
589
- diagnostics.warnings.push(
590
- `Because you've defined a [site] configuration, we're defaulting to "workers-site" for the deprecated \`site.entry-point\`field.\n` +
591
- `Add the top level \`main\` field to your configuration file:\n` +
592
- `\`\`\`\n` +
593
- `main = "workers-site/index.js"\n` +
594
- `\`\`\``
595
- );
596
- siteEntryPoint = "workers-site";
597
- } else if (mainEntryPoint && siteEntryPoint) {
598
- diagnostics.errors.push(
599
- `Don't define both the \`main\` and \`site.entry-point\` fields in your configuration.\n` +
600
- `They serve the same purpose: to point to the entry-point of your worker.\n` +
601
- `Delete the deprecated \`site.entry-point\` field from your config.`
602
- );
603
- }
604
-
605
- if (configPath && siteEntryPoint) {
606
- // rewrite the path to be relative to the working directory
607
- siteEntryPoint = path.relative(
608
- process.cwd(),
609
- path.join(path.dirname(configPath), siteEntryPoint)
610
- );
611
- }
612
-
613
- return {
614
- bucket,
615
- "entry-point": siteEntryPoint,
616
- include,
617
- exclude,
618
- };
619
- }
620
- return undefined;
621
- }
622
-
623
- /**
624
- * Validate the `assets` configuration and return normalized values.
625
- */
626
- function normalizeAndValidateAssets(
627
- diagnostics: Diagnostics,
628
- configPath: string | undefined,
629
- rawConfig: RawConfig
630
- ): Config["assets"] {
631
- // Even though the type doesn't say it,
632
- // we allow for a string input in the config,
633
- // so let's normalise it
634
- if (typeof rawConfig?.assets === "string") {
635
- return {
636
- bucket: rawConfig.assets,
637
- include: [],
638
- exclude: [],
639
- browser_TTL: undefined,
640
- serve_single_page_app: false,
641
- };
642
- }
643
-
644
- if (rawConfig?.assets === undefined) {
645
- return undefined;
646
- }
647
-
648
- if (typeof rawConfig.assets !== "object") {
649
- diagnostics.errors.push(
650
- `Expected the \`assets\` field to be a string or an object, but got ${typeof rawConfig.assets}.`
651
- );
652
- return undefined;
653
- }
654
-
655
- const {
656
- bucket,
657
- include = [],
658
- exclude = [],
659
- browser_TTL,
660
- serve_single_page_app,
661
- ...rest
662
- } = rawConfig.assets;
663
-
664
- validateAdditionalProperties(diagnostics, "assets", Object.keys(rest), []);
665
-
666
- validateRequiredProperty(diagnostics, "assets", "bucket", bucket, "string");
667
- validateTypedArray(diagnostics, "assets.include", include, "string");
668
- validateTypedArray(diagnostics, "assets.exclude", exclude, "string");
669
-
670
- validateOptionalProperty(
671
- diagnostics,
672
- "assets",
673
- "browser_TTL",
674
- browser_TTL,
675
- "number"
676
- );
677
-
678
- validateOptionalProperty(
679
- diagnostics,
680
- "assets",
681
- "serve_single_page_app",
682
- serve_single_page_app,
683
- "boolean"
684
- );
685
-
686
- return {
687
- bucket,
688
- include,
689
- exclude,
690
- browser_TTL,
691
- serve_single_page_app,
692
- };
693
- }
694
-
695
- /**
696
- * Map the paths of the `wasm_modules`, `text_blobs` or `data_blobs` configuration to be relative to the current working directory.
697
- */
698
- function normalizeAndValidateModulePaths(
699
- diagnostics: Diagnostics,
700
- configPath: string | undefined,
701
- field: "wasm_modules" | "text_blobs" | "data_blobs",
702
- rawMapping: Record<string, string> | undefined
703
- ): Record<string, string> | undefined {
704
- if (rawMapping === undefined) {
705
- return undefined;
706
- }
707
- const mapping: Record<string, string> = {};
708
- // Rewrite paths to be relative to the cwd, rather than the config path.
709
- for (const [name, filePath] of Object.entries(rawMapping)) {
710
- if (isString(diagnostics, `${field}['${name}']`, filePath, undefined)) {
711
- if (configPath) {
712
- mapping[name] = configPath
713
- ? path.relative(
714
- process.cwd(),
715
- path.join(path.dirname(configPath), filePath)
716
- )
717
- : filePath;
718
- }
719
- }
720
- }
721
- return mapping;
722
- }
723
-
724
- /**
725
- * Check whether a value has the shape of a route, which can be a string
726
- * or an object that looks like {pattern: string, zone_id: string }
727
- */
728
- function isValidRouteValue(item: unknown): boolean {
729
- if (!item) {
730
- return false;
731
- }
732
- if (typeof item === "string") {
733
- return true;
734
- }
735
- if (typeof item === "object") {
736
- if (!hasProperty(item, "pattern") || typeof item.pattern !== "string") {
737
- return false;
738
- }
739
-
740
- const otherKeys = Object.keys(item).length - 1; // minus one to subtract "pattern"
741
-
742
- const hasZoneId =
743
- hasProperty(item, "zone_id") && typeof item.zone_id === "string";
744
- const hasZoneName =
745
- hasProperty(item, "zone_name") && typeof item.zone_name === "string";
746
- const hasCustomDomainFlag =
747
- hasProperty(item, "custom_domain") &&
748
- typeof item.custom_domain === "boolean";
749
-
750
- if (otherKeys === 2 && hasCustomDomainFlag && (hasZoneId || hasZoneName)) {
751
- return true;
752
- } else if (
753
- otherKeys === 1 &&
754
- (hasZoneId || hasZoneName || hasCustomDomainFlag)
755
- ) {
756
- return true;
757
- }
758
- }
759
- return false;
760
- }
761
-
762
- /**
763
- * If account_id has been passed as an empty string, normalise it to undefined.
764
- * This is to workaround older Wrangler v1-era templates that have account_id = '',
765
- * which isn't a valid value anyway
766
- */
767
- function mutateEmptyStringAccountIDValue(
768
- diagnostics: Diagnostics,
769
- rawEnv: RawEnvironment
770
- ) {
771
- if (rawEnv.account_id === "") {
772
- diagnostics.warnings.push(
773
- `The "account_id" field in your configuration is an empty string and will be ignored.\n` +
774
- `Please remove the "account_id" field from your configuration.`
775
- );
776
- rawEnv.account_id = undefined;
777
- }
778
- return rawEnv;
779
- }
780
-
781
- /**
782
- * Normalize empty string to `undefined` by mutating rawEnv.route value.
783
- * As part of backward compatibility with Wrangler v1 converting empty string to `undefined`
784
- */
785
- function mutateEmptyStringRouteValue(
786
- diagnostics: Diagnostics,
787
- rawEnv: RawEnvironment
788
- ): RawEnvironment {
789
- if (rawEnv["route"] === "") {
790
- diagnostics.warnings.push(
791
- `The "route" field in your configuration is an empty string and will be ignored.\n` +
792
- `Please remove the "route" field from your configuration.`
793
- );
794
- rawEnv["route"] = undefined;
795
- }
796
-
797
- return rawEnv;
798
- }
799
-
800
- /**
801
- * Validate that the field is a route.
802
- */
803
- const isRoute: ValidatorFn = (diagnostics, field, value) => {
804
- if (value !== undefined && !isValidRouteValue(value)) {
805
- diagnostics.errors.push(
806
- `Expected "${field}" to be either a string, or an object with shape { pattern, custom_domain, zone_id | zone_name }, but got ${JSON.stringify(
807
- value
808
- )}.`
809
- );
810
- return false;
811
- }
812
- return true;
813
- };
814
-
815
- /**
816
- * Validate that the field is an array of routes.
817
- */
818
- const isRouteArray: ValidatorFn = (diagnostics, field, value) => {
819
- if (value === undefined) {
820
- return true;
821
- }
822
- if (!Array.isArray(value)) {
823
- diagnostics.errors.push(
824
- `Expected "${field}" to be an array but got ${JSON.stringify(value)}.`
825
- );
826
- return false;
827
- }
828
- const invalidRoutes = [];
829
- for (const item of value) {
830
- if (!isValidRouteValue(item)) {
831
- invalidRoutes.push(item);
832
- }
833
- }
834
- if (invalidRoutes.length > 0) {
835
- diagnostics.errors.push(
836
- `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(
837
- invalidRoutes,
838
- null,
839
- 2
840
- )}.`
841
- );
842
- }
843
- return invalidRoutes.length === 0;
844
- };
845
-
846
- function normalizeAndValidateRoute(
847
- diagnostics: Diagnostics,
848
- topLevelEnv: Environment | undefined,
849
- rawEnv: RawEnvironment
850
- ): Config["route"] {
851
- return inheritable(
852
- diagnostics,
853
- topLevelEnv,
854
- mutateEmptyStringRouteValue(diagnostics, rawEnv),
855
- "route",
856
- isRoute,
857
- undefined
858
- );
859
- }
860
-
861
- function validateRoutes(
862
- diagnostics: Diagnostics,
863
- topLevelEnv: Environment | undefined,
864
- rawEnv: RawEnvironment
865
- ): Config["routes"] {
866
- return inheritable(
867
- diagnostics,
868
- topLevelEnv,
869
- rawEnv,
870
- "routes",
871
- all(isRouteArray, isMutuallyExclusiveWith(rawEnv, "route")),
872
- undefined
873
- );
874
- }
875
-
876
- /**
877
- * Validate top-level environment configuration and return the normalized values.
878
- */
879
- function normalizeAndValidateEnvironment(
880
- diagnostics: Diagnostics,
881
- configPath: string | undefined,
882
- topLevelEnv: RawEnvironment
883
- ): Environment;
884
- /**
885
- * Validate the named environment configuration and return the normalized values.
886
- */
887
- function normalizeAndValidateEnvironment(
888
- diagnostics: Diagnostics,
889
- configPath: string | undefined,
890
- rawEnv: RawEnvironment,
891
- envName: string,
892
- topLevelEnv: Environment,
893
- isLegacyEnv: boolean,
894
- rawConfig: RawConfig
895
- ): Environment;
896
- function normalizeAndValidateEnvironment(
897
- diagnostics: Diagnostics,
898
- configPath: string | undefined,
899
- rawEnv: RawEnvironment,
900
- envName = "top level",
901
- topLevelEnv?: Environment | undefined,
902
- isLegacyEnv?: boolean,
903
- rawConfig?: RawConfig | undefined
904
- ): Environment {
905
- deprecated(
906
- diagnostics,
907
- rawEnv,
908
- "kv-namespaces",
909
- `The "kv-namespaces" field is no longer supported, please rename to "kv_namespaces"`,
910
- true
911
- );
912
- deprecated(
913
- diagnostics,
914
- rawEnv,
915
- "zone_id",
916
- "This is unnecessary since we can deduce this from routes directly.",
917
- false // We need to leave this in-place for the moment since `route` commands might use it.
918
- );
919
-
920
- // The field "experimental_services" doesn't exist anymore in the config, but we still want to error about any older usage.
921
-
922
- deprecated(
923
- diagnostics,
924
- rawEnv,
925
- "experimental_services",
926
- `The "experimental_services" field is no longer supported. Simply rename the [experimental_services] field to [services].`,
927
- true
928
- );
929
-
930
- experimental(diagnostics, rawEnv, "unsafe");
931
- experimental(diagnostics, rawEnv, "services");
932
-
933
- const route = normalizeAndValidateRoute(diagnostics, topLevelEnv, rawEnv);
934
-
935
- const account_id = inheritableInLegacyEnvironments(
936
- diagnostics,
937
- isLegacyEnv,
938
- topLevelEnv,
939
- mutateEmptyStringAccountIDValue(diagnostics, rawEnv),
940
- "account_id",
941
- isString,
942
- undefined,
943
- undefined
944
- );
945
-
946
- const routes = validateRoutes(diagnostics, topLevelEnv, rawEnv);
947
-
948
- const workers_dev = inheritable(
949
- diagnostics,
950
- topLevelEnv,
951
- rawEnv,
952
- "workers_dev",
953
- isBoolean,
954
- undefined
955
- );
956
-
957
- const { deprecatedUpload, ...build } = normalizeAndValidateBuild(
958
- diagnostics,
959
- rawEnv,
960
- rawEnv.build ?? topLevelEnv?.build ?? {},
961
- configPath
962
- );
963
-
964
- const environment: Environment = {
965
- // Inherited fields
966
- account_id,
967
- compatibility_date: inheritable(
968
- diagnostics,
969
- topLevelEnv,
970
- rawEnv,
971
- "compatibility_date",
972
- isString,
973
- undefined
974
- ),
975
- compatibility_flags: inheritable(
976
- diagnostics,
977
- topLevelEnv,
978
- rawEnv,
979
- "compatibility_flags",
980
- isStringArray,
981
- []
982
- ),
983
- jsx_factory: inheritable(
984
- diagnostics,
985
- topLevelEnv,
986
- rawEnv,
987
- "jsx_factory",
988
- isString,
989
- "React.createElement"
990
- ),
991
- jsx_fragment: inheritable(
992
- diagnostics,
993
- topLevelEnv,
994
- rawEnv,
995
- "jsx_fragment",
996
- isString,
997
- "React.Fragment"
998
- ),
999
- tsconfig: validateAndNormalizeTsconfig(
1000
- diagnostics,
1001
- topLevelEnv,
1002
- rawEnv,
1003
- configPath
1004
- ),
1005
- rules: validateAndNormalizeRules(
1006
- diagnostics,
1007
- topLevelEnv,
1008
- rawEnv,
1009
- deprecatedUpload?.rules,
1010
- envName
1011
- ),
1012
- name: inheritableInLegacyEnvironments(
1013
- diagnostics,
1014
- isLegacyEnv,
1015
- topLevelEnv,
1016
- rawEnv,
1017
- "name",
1018
- isValidName,
1019
- appendEnvName(envName),
1020
- undefined
1021
- ),
1022
- main: normalizeAndValidateMainField(
1023
- configPath,
1024
- inheritable(
1025
- diagnostics,
1026
- topLevelEnv,
1027
- rawEnv,
1028
- "main",
1029
- isString,
1030
- undefined
1031
- ),
1032
- deprecatedUpload
1033
- ),
1034
- base_dir: normalizeAndValidateBaseDirField(
1035
- configPath,
1036
- inheritable(
1037
- diagnostics,
1038
- topLevelEnv,
1039
- rawEnv,
1040
- "base_dir",
1041
- isString,
1042
- undefined
1043
- )
1044
- ),
1045
- route,
1046
- routes,
1047
- triggers: inheritable(
1048
- diagnostics,
1049
- topLevelEnv,
1050
- rawEnv,
1051
- "triggers",
1052
- isObjectWith("crons"),
1053
- { crons: [] }
1054
- ),
1055
- usage_model: inheritable(
1056
- diagnostics,
1057
- topLevelEnv,
1058
- rawEnv,
1059
- "usage_model",
1060
- isOneOf("bundled", "unbound"),
1061
- undefined
1062
- ),
1063
- build,
1064
- workers_dev,
1065
- // Not inherited fields
1066
- vars: notInheritable(
1067
- diagnostics,
1068
- topLevelEnv,
1069
- rawConfig,
1070
- rawEnv,
1071
- envName,
1072
- "vars",
1073
- validateVars(envName),
1074
- {}
1075
- ),
1076
- define: notInheritable(
1077
- diagnostics,
1078
- topLevelEnv,
1079
- rawConfig,
1080
- rawEnv,
1081
- envName,
1082
- "define",
1083
- validateDefines(envName),
1084
- {}
1085
- ),
1086
- durable_objects: notInheritable(
1087
- diagnostics,
1088
- topLevelEnv,
1089
- rawConfig,
1090
- rawEnv,
1091
- envName,
1092
- "durable_objects",
1093
- validateBindingsProperty(envName, validateDurableObjectBinding),
1094
- {
1095
- bindings: [],
1096
- }
1097
- ),
1098
- kv_namespaces: notInheritable(
1099
- diagnostics,
1100
- topLevelEnv,
1101
- rawConfig,
1102
- rawEnv,
1103
- envName,
1104
- "kv_namespaces",
1105
- validateBindingArray(envName, validateKVBinding),
1106
- []
1107
- ),
1108
- send_email: notInheritable(
1109
- diagnostics,
1110
- topLevelEnv,
1111
- rawConfig,
1112
- rawEnv,
1113
- envName,
1114
- "send_email",
1115
- validateBindingArray(envName, validateSendEmailBinding),
1116
- []
1117
- ),
1118
- queues: notInheritable(
1119
- diagnostics,
1120
- topLevelEnv,
1121
- rawConfig,
1122
- rawEnv,
1123
- envName,
1124
- "queues",
1125
- validateQueues(envName),
1126
- { producers: [], consumers: [] }
1127
- ),
1128
- r2_buckets: notInheritable(
1129
- diagnostics,
1130
- topLevelEnv,
1131
- rawConfig,
1132
- rawEnv,
1133
- envName,
1134
- "r2_buckets",
1135
- validateBindingArray(envName, validateR2Binding),
1136
- []
1137
- ),
1138
- d1_databases: notInheritable(
1139
- diagnostics,
1140
- topLevelEnv,
1141
- rawConfig,
1142
- rawEnv,
1143
- envName,
1144
- "d1_databases",
1145
- validateBindingArray(envName, validateD1Binding),
1146
- []
1147
- ),
1148
- services: notInheritable(
1149
- diagnostics,
1150
- topLevelEnv,
1151
- rawConfig,
1152
- rawEnv,
1153
- envName,
1154
- "services",
1155
- validateBindingArray(envName, validateServiceBinding),
1156
- []
1157
- ),
1158
- analytics_engine_datasets: notInheritable(
1159
- diagnostics,
1160
- topLevelEnv,
1161
- rawConfig,
1162
- rawEnv,
1163
- envName,
1164
- "analytics_engine_datasets",
1165
- validateBindingArray(envName, validateAnalyticsEngineBinding),
1166
- []
1167
- ),
1168
- dispatch_namespaces: notInheritable(
1169
- diagnostics,
1170
- topLevelEnv,
1171
- rawConfig,
1172
- rawEnv,
1173
- envName,
1174
- "dispatch_namespaces",
1175
- validateBindingArray(envName, validateWorkerNamespaceBinding),
1176
- []
1177
- ),
1178
- mtls_certificates: notInheritable(
1179
- diagnostics,
1180
- topLevelEnv,
1181
- rawConfig,
1182
- rawEnv,
1183
- envName,
1184
- "mtls_certificates",
1185
- validateBindingArray(envName, validateMTlsCertificateBinding),
1186
- []
1187
- ),
1188
- logfwdr: inheritable(
1189
- diagnostics,
1190
- topLevelEnv,
1191
- rawEnv,
1192
- "logfwdr",
1193
- validateBindingsProperty(envName, validateCflogfwdrBinding),
1194
- {
1195
- schema: undefined,
1196
- bindings: [],
1197
- }
1198
- ),
1199
- unsafe: notInheritable(
1200
- diagnostics,
1201
- topLevelEnv,
1202
- rawConfig,
1203
- rawEnv,
1204
- envName,
1205
- "unsafe",
1206
- validateUnsafeSettings(envName),
1207
- {}
1208
- ),
1209
- zone_id: rawEnv.zone_id,
1210
- no_bundle: inheritable(
1211
- diagnostics,
1212
- topLevelEnv,
1213
- rawEnv,
1214
- "no_bundle",
1215
- isBoolean,
1216
- undefined
1217
- ),
1218
- minify: inheritable(
1219
- diagnostics,
1220
- topLevelEnv,
1221
- rawEnv,
1222
- "minify",
1223
- isBoolean,
1224
- undefined
1225
- ),
1226
- node_compat: inheritable(
1227
- diagnostics,
1228
- topLevelEnv,
1229
- rawEnv,
1230
- "node_compat",
1231
- isBoolean,
1232
- undefined
1233
- ),
1234
- first_party_worker: inheritable(
1235
- diagnostics,
1236
- topLevelEnv,
1237
- rawEnv,
1238
- "first_party_worker",
1239
- isBoolean,
1240
- undefined
1241
- ),
1242
- logpush: inheritable(
1243
- diagnostics,
1244
- topLevelEnv,
1245
- rawEnv,
1246
- "logpush",
1247
- isBoolean,
1248
- undefined
1249
- ),
1250
- };
1251
-
1252
- return environment;
1253
- }
1254
-
1255
- function validateAndNormalizeTsconfig(
1256
- diagnostics: Diagnostics,
1257
- topLevelEnv: Environment | undefined,
1258
- rawEnv: RawEnvironment,
1259
- configPath: string | undefined
1260
- ) {
1261
- const tsconfig = inheritable(
1262
- diagnostics,
1263
- topLevelEnv,
1264
- rawEnv,
1265
- "tsconfig",
1266
- isString,
1267
- undefined
1268
- );
1269
-
1270
- return configPath && tsconfig
1271
- ? path.relative(
1272
- process.cwd(),
1273
- path.join(path.dirname(configPath), tsconfig)
1274
- )
1275
- : tsconfig;
1276
- }
1277
-
1278
- const validateAndNormalizeRules = (
1279
- diagnostics: Diagnostics,
1280
- topLevelEnv: Environment | undefined,
1281
- rawEnv: RawEnvironment,
1282
- deprecatedRules: Rule[] | undefined,
1283
- envName: string
1284
- ): Rule[] => {
1285
- if (topLevelEnv === undefined) {
1286
- // Only create errors/warnings for the top-level environment
1287
- if (rawEnv.rules && deprecatedRules) {
1288
- diagnostics.errors.push(
1289
- `You cannot configure both [rules] and [build.upload.rules] in your wrangler.toml. Delete the \`build.upload\` section.`
1290
- );
1291
- } else if (deprecatedRules) {
1292
- diagnostics.warnings.push(
1293
- `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` +
1294
- "```\n" +
1295
- TOML.stringify({ rules: deprecatedRules }) +
1296
- "```"
1297
- );
1298
- }
1299
- }
1300
-
1301
- return inheritable(
1302
- diagnostics,
1303
- topLevelEnv,
1304
- rawEnv,
1305
- "rules",
1306
- validateRules(envName),
1307
- deprecatedRules ?? []
1308
- );
1309
- };
1310
-
1311
- const validateRules =
1312
- (envName: string): ValidatorFn =>
1313
- (diagnostics, field, envValue, config) => {
1314
- if (!envValue) {
1315
- return true;
1316
- }
1317
- const fieldPath =
1318
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1319
- if (!Array.isArray(envValue)) {
1320
- diagnostics.errors.push(
1321
- `The field "${fieldPath}" should be an array but got ${JSON.stringify(
1322
- envValue
1323
- )}.`
1324
- );
1325
- return false;
1326
- }
1327
-
1328
- let isValid = true;
1329
- for (let i = 0; i < envValue.length; i++) {
1330
- isValid =
1331
- validateRule(diagnostics, `${fieldPath}[${i}]`, envValue[i], config) &&
1332
- isValid;
1333
- }
1334
- return isValid;
1335
- };
1336
-
1337
- const validateRule: ValidatorFn = (diagnostics, field, value) => {
1338
- if (typeof value !== "object" || value === null) {
1339
- diagnostics.errors.push(
1340
- `"${field}" should be an object but got ${JSON.stringify(value)}.`
1341
- );
1342
- return false;
1343
- }
1344
- // Rules must have a type string and glob string array, and optionally a fallthrough boolean.
1345
- let isValid = true;
1346
- const rule = value as Rule;
1347
-
1348
- if (
1349
- !isRequiredProperty(rule, "type", "string", [
1350
- "ESModule",
1351
- "CommonJS",
1352
- "CompiledWasm",
1353
- "Text",
1354
- "Data",
1355
- ])
1356
- ) {
1357
- diagnostics.errors.push(
1358
- `bindings should have a string "type" field, which contains one of "ESModule", "CommonJS", "CompiledWasm", "Text", or "Data".`
1359
- );
1360
- isValid = false;
1361
- }
1362
-
1363
- isValid =
1364
- validateTypedArray(diagnostics, `${field}.globs`, rule.globs, "string") &&
1365
- isValid;
1366
-
1367
- if (!isOptionalProperty(rule, "fallthrough", "boolean")) {
1368
- diagnostics.errors.push(
1369
- `the field "fallthrough", when present, should be a boolean.`
1370
- );
1371
- isValid = false;
1372
- }
1373
-
1374
- return isValid;
1375
- };
1376
-
1377
- const validateDefines =
1378
- (envName: string): ValidatorFn =>
1379
- (diagnostics, field, value, config) => {
1380
- let isValid = true;
1381
- const fieldPath =
1382
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1383
-
1384
- if (typeof value === "object" && value !== null) {
1385
- for (const varName in value) {
1386
- // some casting here to appease typescript
1387
- // even though the value might not match the type
1388
- if (typeof (value as Record<string, string>)[varName] !== "string") {
1389
- diagnostics.errors.push(
1390
- `The field "${fieldPath}.${varName}" should be a string but got ${JSON.stringify(
1391
- (value as Record<string, string>)[varName]
1392
- )}.`
1393
- );
1394
- isValid = false;
1395
- }
1396
- }
1397
- } else {
1398
- if (value !== undefined) {
1399
- diagnostics.errors.push(
1400
- `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1401
- value
1402
- )}.\n`
1403
- );
1404
- isValid = false;
1405
- }
1406
- }
1407
-
1408
- const configDefines = Object.keys(config?.define ?? {});
1409
-
1410
- // If there are no top level vars then there is nothing to do here.
1411
- if (configDefines.length > 0) {
1412
- if (typeof value === "object" && value !== null) {
1413
- const configEnvDefines = config === undefined ? [] : Object.keys(value);
1414
-
1415
- for (const varName of configDefines) {
1416
- if (!(varName in value)) {
1417
- diagnostics.warnings.push(
1418
- `"define.${varName}" exists at the top level, but not on "${fieldPath}".\n` +
1419
- `This is not what you probably want, since "define" configuration is not inherited by environments.\n` +
1420
- `Please add "define.${varName}" to "env.${envName}".`
1421
- );
1422
- }
1423
- }
1424
- for (const varName of configEnvDefines) {
1425
- if (!configDefines.includes(varName)) {
1426
- diagnostics.warnings.push(
1427
- `"${varName}" exists on "env.${envName}", but not on the top level.\n` +
1428
- `This is not what you probably want, since "define" configuration within environments can only override existing top level "define" configuration\n` +
1429
- `Please remove "${fieldPath}.${varName}", or add "define.${varName}".`
1430
- );
1431
- }
1432
- }
1433
- }
1434
- }
1435
-
1436
- return isValid;
1437
- };
1438
-
1439
- const validateVars =
1440
- (envName: string): ValidatorFn =>
1441
- (diagnostics, field, value, config) => {
1442
- let isValid = true;
1443
- const fieldPath =
1444
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1445
- const configVars = Object.keys(config?.vars ?? {});
1446
- // If there are no top level vars then there is nothing to do here.
1447
- if (configVars.length > 0) {
1448
- if (typeof value !== "object" || value === null) {
1449
- diagnostics.errors.push(
1450
- `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1451
- value
1452
- )}.\n`
1453
- );
1454
- isValid = false;
1455
- } else {
1456
- for (const varName of configVars) {
1457
- if (!(varName in value)) {
1458
- diagnostics.warnings.push(
1459
- `"vars.${varName}" exists at the top level, but not on "${fieldPath}".\n` +
1460
- `This is not what you probably want, since "vars" configuration is not inherited by environments.\n` +
1461
- `Please add "vars.${varName}" to "env.${envName}".`
1462
- );
1463
- }
1464
- }
1465
- }
1466
- }
1467
- return isValid;
1468
- };
1469
-
1470
- const validateBindingsProperty =
1471
- (envName: string, validateBinding: ValidatorFn): ValidatorFn =>
1472
- (diagnostics, field, value, config) => {
1473
- let isValid = true;
1474
- const fieldPath =
1475
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1476
-
1477
- if (value !== undefined) {
1478
- // Check the validity of the `value` as a bindings container.
1479
- if (typeof value !== "object" || value === null || Array.isArray(value)) {
1480
- diagnostics.errors.push(
1481
- `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1482
- value
1483
- )}.`
1484
- );
1485
- isValid = false;
1486
- } else if (!hasProperty(value, "bindings")) {
1487
- diagnostics.errors.push(
1488
- `The field "${fieldPath}" is missing the required "bindings" property.`
1489
- );
1490
- isValid = false;
1491
- } else if (!Array.isArray(value.bindings)) {
1492
- diagnostics.errors.push(
1493
- `The field "${fieldPath}.bindings" should be an array but got ${JSON.stringify(
1494
- value.bindings
1495
- )}.`
1496
- );
1497
- isValid = false;
1498
- } else {
1499
- for (let i = 0; i < value.bindings.length; i++) {
1500
- const binding = value.bindings[i];
1501
- const bindingDiagnostics = new Diagnostics(
1502
- `"${fieldPath}.bindings[${i}]": ${JSON.stringify(binding)}`
1503
- );
1504
- isValid =
1505
- validateBinding(
1506
- bindingDiagnostics,
1507
- `${fieldPath}.bindings[${i}]`,
1508
- binding,
1509
- config
1510
- ) && isValid;
1511
- diagnostics.addChild(bindingDiagnostics);
1512
- }
1513
- }
1514
-
1515
- const configBindingNames = getBindingNames(
1516
- config?.[field as keyof Environment]
1517
- );
1518
- if (isValid && configBindingNames.length > 0) {
1519
- // If there are top level bindings then check that they all appear in the environment.
1520
- const envBindingNames = new Set(getBindingNames(value));
1521
- const missingBindings = configBindingNames.filter(
1522
- (name) => !envBindingNames.has(name)
1523
- );
1524
- if (missingBindings.length > 0) {
1525
- diagnostics.warnings.push(
1526
- `The following bindings are at the top level, but not on "env.${envName}".\n` +
1527
- `This is not what you probably want, since "${field}" configuration is not inherited by environments.\n` +
1528
- `Please add a binding for each to "${fieldPath}.bindings":\n` +
1529
- missingBindings.map((name) => `- ${name}`).join("\n")
1530
- );
1531
- }
1532
- }
1533
- }
1534
- return isValid;
1535
- };
1536
-
1537
- const validateUnsafeSettings =
1538
- (envName: string): ValidatorFn =>
1539
- (diagnostics, field, value, config) => {
1540
- const fieldPath =
1541
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1542
-
1543
- if (typeof value !== "object" || value === null || Array.isArray(value)) {
1544
- diagnostics.errors.push(
1545
- `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1546
- value
1547
- )}.`
1548
- );
1549
- return false;
1550
- }
1551
-
1552
- // At least one of bindings and metadata must exist
1553
- if (!hasProperty(value, "bindings") && !hasProperty(value, "metadata")) {
1554
- diagnostics.errors.push(
1555
- `The field "${fieldPath}" should contain at least one of "bindings" or "metadata" properties but got ${JSON.stringify(
1556
- value
1557
- )}.`
1558
- );
1559
- return false;
1560
- }
1561
-
1562
- // unsafe.bindings
1563
- if (hasProperty(value, "bindings") && value.bindings !== undefined) {
1564
- const validateBindingsFn = validateBindingsProperty(
1565
- envName,
1566
- validateUnsafeBinding
1567
- );
1568
- const valid = validateBindingsFn(diagnostics, field, value, config);
1569
- if (!valid) {
1570
- return false;
1571
- }
1572
- }
1573
-
1574
- // unsafe.metadata
1575
- if (
1576
- hasProperty(value, "metadata") &&
1577
- value.metadata !== undefined &&
1578
- (typeof value.metadata !== "object" ||
1579
- value.metadata === null ||
1580
- Array.isArray(value.metadata))
1581
- ) {
1582
- diagnostics.errors.push(
1583
- `The field "${fieldPath}.metadata" should be an object but got ${JSON.stringify(
1584
- value.metadata
1585
- )}.`
1586
- );
1587
- return false;
1588
- }
1589
-
1590
- return true;
1591
- };
1592
-
1593
- /**
1594
- * Check that the given field is a valid "durable_object" binding object.
1595
- */
1596
- const validateDurableObjectBinding: ValidatorFn = (
1597
- diagnostics,
1598
- field,
1599
- value
1600
- ) => {
1601
- if (typeof value !== "object" || value === null) {
1602
- diagnostics.errors.push(
1603
- `Expected "${field}" to be an object but got ${JSON.stringify(value)}`
1604
- );
1605
- return false;
1606
- }
1607
-
1608
- // Durable Object bindings must have a name and class_name, and optionally a script_name and an environment.
1609
- let isValid = true;
1610
- if (!isRequiredProperty(value, "name", "string")) {
1611
- diagnostics.errors.push(`binding should have a string "name" field.`);
1612
- isValid = false;
1613
- }
1614
- if (!isRequiredProperty(value, "class_name", "string")) {
1615
- diagnostics.errors.push(`binding should have a string "class_name" field.`);
1616
- isValid = false;
1617
- }
1618
- if (!isOptionalProperty(value, "script_name", "string")) {
1619
- diagnostics.errors.push(
1620
- `the field "script_name", when present, should be a string.`
1621
- );
1622
- isValid = false;
1623
- }
1624
- // environment requires a script_name
1625
- if (!isOptionalProperty(value, "environment", "string")) {
1626
- diagnostics.errors.push(
1627
- `the field "environment", when present, should be a string.`
1628
- );
1629
- isValid = false;
1630
- }
1631
-
1632
- if ("environment" in value && !("script_name" in value)) {
1633
- diagnostics.errors.push(
1634
- `binding should have a "script_name" field if "environment" is present.`
1635
- );
1636
- isValid = false;
1637
- }
1638
-
1639
- return isValid;
1640
- };
1641
-
1642
- const validateCflogfwdrBinding: ValidatorFn = (diagnostics, field, value) => {
1643
- if (typeof value !== "object" || value === null) {
1644
- diagnostics.errors.push(
1645
- `Expected "${field}" to be an object but got ${JSON.stringify(value)}`
1646
- );
1647
- return false;
1648
- }
1649
-
1650
- let isValid = true;
1651
- if (!isRequiredProperty(value, "name", "string")) {
1652
- diagnostics.errors.push(`binding should have a string "name" field.`);
1653
- isValid = false;
1654
- }
1655
-
1656
- if (!isRequiredProperty(value, "destination", "string")) {
1657
- diagnostics.errors.push(
1658
- `binding should have a string "destination" field.`
1659
- );
1660
- isValid = false;
1661
- }
1662
-
1663
- return isValid;
1664
- };
1665
-
1666
- /**
1667
- * Check that the given field is a valid "unsafe" binding object.
1668
- *
1669
- * TODO: further validation of known unsafe bindings.
1670
- */
1671
- const validateUnsafeBinding: ValidatorFn = (diagnostics, field, value) => {
1672
- if (typeof value !== "object" || value === null) {
1673
- diagnostics.errors.push(
1674
- `Expected ${field} to be an object but got ${JSON.stringify(value)}.`
1675
- );
1676
- return false;
1677
- }
1678
-
1679
- let isValid = true;
1680
- // Unsafe bindings must have a name and type.
1681
- if (!isRequiredProperty(value, "name", "string")) {
1682
- diagnostics.errors.push(`binding should have a string "name" field.`);
1683
- isValid = false;
1684
- }
1685
- if (isRequiredProperty(value, "type", "string")) {
1686
- const safeBindings = [
1687
- "plain_text",
1688
- "json",
1689
- "wasm_module",
1690
- "data_blob",
1691
- "text_blob",
1692
- "kv_namespace",
1693
- "durable_object_namespace",
1694
- "d1_database",
1695
- "r2_bucket",
1696
- "service",
1697
- "logfwdr",
1698
- "mtls_certificate",
1699
- ];
1700
-
1701
- if (safeBindings.includes(value.type)) {
1702
- diagnostics.warnings.push(
1703
- `The binding type "${value.type}" is directly supported by wrangler.\n` +
1704
- `Consider migrating this unsafe binding to a format for '${value.type}' bindings that is supported by wrangler for optimal support.\n` +
1705
- "For more details, see https://developers.cloudflare.com/workers/cli-wrangler/configuration"
1706
- );
1707
- }
1708
- } else {
1709
- diagnostics.errors.push(`binding should have a string "type" field.`);
1710
- isValid = false;
1711
- }
1712
- return isValid;
1713
- };
1714
-
1715
- /**
1716
- * Check that the given environment field is a valid array of bindings.
1717
- */
1718
- const validateBindingArray =
1719
- (envName: string, validateBinding: ValidatorFn): ValidatorFn =>
1720
- (diagnostics, field, envValue, config) => {
1721
- if (envValue === undefined) {
1722
- return true;
1723
- }
1724
-
1725
- const fieldPath =
1726
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1727
- if (!Array.isArray(envValue)) {
1728
- diagnostics.errors.push(
1729
- `The field "${fieldPath}" should be an array but got ${JSON.stringify(
1730
- envValue
1731
- )}.`
1732
- );
1733
- return false;
1734
- }
1735
-
1736
- let isValid = true;
1737
- for (let i = 0; i < envValue.length; i++) {
1738
- isValid =
1739
- validateBinding(
1740
- diagnostics,
1741
- `${fieldPath}[${i}]`,
1742
- envValue[i],
1743
- config
1744
- ) && isValid;
1745
- }
1746
- const configValue = config?.[field as keyof Environment] as {
1747
- binding: unknown;
1748
- }[];
1749
- if (Array.isArray(configValue)) {
1750
- const configBindingNames = configValue.map((value) => value.binding);
1751
- // If there are no top level bindings then there is nothing to do here.
1752
- if (configBindingNames.length > 0) {
1753
- const envBindingNames = new Set(envValue.map((value) => value.binding));
1754
- for (const configBindingName of configBindingNames) {
1755
- if (!envBindingNames.has(configBindingName)) {
1756
- diagnostics.warnings.push(
1757
- `There is a ${field} binding with name "${configBindingName}" at the top level, but not on "env.${envName}".\n` +
1758
- `This is not what you probably want, since "${field}" configuration is not inherited by environments.\n` +
1759
- `Please add a binding for "${configBindingName}" to "env.${envName}.${field}.bindings".`
1760
- );
1761
- }
1762
- }
1763
- }
1764
- }
1765
- return isValid;
1766
- };
1767
-
1768
- const validateKVBinding: ValidatorFn = (diagnostics, field, value) => {
1769
- if (typeof value !== "object" || value === null) {
1770
- diagnostics.errors.push(
1771
- `"kv_namespaces" bindings should be objects, but got ${JSON.stringify(
1772
- value
1773
- )}`
1774
- );
1775
- return false;
1776
- }
1777
- let isValid = true;
1778
- // KV bindings must have a binding and id.
1779
- if (!isRequiredProperty(value, "binding", "string")) {
1780
- diagnostics.errors.push(
1781
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1782
- value
1783
- )}.`
1784
- );
1785
- isValid = false;
1786
- }
1787
- if (
1788
- !isRequiredProperty(value, "id", "string") ||
1789
- (value as { id: string }).id.length === 0
1790
- ) {
1791
- diagnostics.errors.push(
1792
- `"${field}" bindings should have a string "id" field but got ${JSON.stringify(
1793
- value
1794
- )}.`
1795
- );
1796
- isValid = false;
1797
- }
1798
- if (!isOptionalProperty(value, "preview_id", "string")) {
1799
- diagnostics.errors.push(
1800
- `"${field}" bindings should, optionally, have a string "preview_id" field but got ${JSON.stringify(
1801
- value
1802
- )}.`
1803
- );
1804
- isValid = false;
1805
- }
1806
- return isValid;
1807
- };
1808
-
1809
- const validateSendEmailBinding: ValidatorFn = (diagnostics, field, value) => {
1810
- if (typeof value !== "object" || value === null) {
1811
- diagnostics.errors.push(
1812
- `"send_email" bindings should be objects, but got ${JSON.stringify(
1813
- value
1814
- )}`
1815
- );
1816
- return false;
1817
- }
1818
- let isValid = true;
1819
- // send email bindings must have a name.
1820
- if (!isRequiredProperty(value, "name", "string")) {
1821
- diagnostics.errors.push(
1822
- `"${field}" bindings should have a string "name" field but got ${JSON.stringify(
1823
- value
1824
- )}.`
1825
- );
1826
- isValid = false;
1827
- }
1828
- if (!isOptionalProperty(value, "destination_address", "string")) {
1829
- diagnostics.errors.push(
1830
- `"${field}" bindings should, optionally, have a string "destination_address" field but got ${JSON.stringify(
1831
- value
1832
- )}.`
1833
- );
1834
- isValid = false;
1835
- }
1836
- if (!isOptionalProperty(value, "allowed_destination_addresses", "object")) {
1837
- diagnostics.errors.push(
1838
- `"${field}" bindings should, optionally, have a []string "allowed_destination_addresses" field but got ${JSON.stringify(
1839
- value
1840
- )}.`
1841
- );
1842
- isValid = false;
1843
- }
1844
- if (
1845
- "destination_address" in value &&
1846
- "allowed_destination_addresses" in value
1847
- ) {
1848
- diagnostics.errors.push(
1849
- `"${field}" bindings should have either a "destination_address" or "allowed_destination_addresses" field, but not both.`
1850
- );
1851
- isValid = false;
1852
- }
1853
- return isValid;
1854
- };
1855
-
1856
- const validateQueueBinding: ValidatorFn = (diagnostics, field, value) => {
1857
- if (typeof value !== "object" || value === null) {
1858
- diagnostics.errors.push(
1859
- `"queue" bindings should be objects, but got ${JSON.stringify(value)}`
1860
- );
1861
- return false;
1862
- }
1863
-
1864
- if (
1865
- !validateAdditionalProperties(diagnostics, field, Object.keys(value), [
1866
- "binding",
1867
- "queue",
1868
- ])
1869
- ) {
1870
- return false;
1871
- }
1872
-
1873
- // Queue bindings must have a binding and queue.
1874
- let isValid = true;
1875
- if (!isRequiredProperty(value, "binding", "string")) {
1876
- diagnostics.errors.push(
1877
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1878
- value
1879
- )}.`
1880
- );
1881
- isValid = false;
1882
- }
1883
- if (
1884
- !isRequiredProperty(value, "queue", "string") ||
1885
- (value as { queue: string }).queue.length === 0
1886
- ) {
1887
- diagnostics.errors.push(
1888
- `"${field}" bindings should have a string "queue" field but got ${JSON.stringify(
1889
- value
1890
- )}.`
1891
- );
1892
- isValid = false;
1893
- }
1894
- return isValid;
1895
- };
1896
-
1897
- const validateR2Binding: ValidatorFn = (diagnostics, field, value) => {
1898
- if (typeof value !== "object" || value === null) {
1899
- diagnostics.errors.push(
1900
- `"r2_buckets" bindings should be objects, but got ${JSON.stringify(
1901
- value
1902
- )}`
1903
- );
1904
- return false;
1905
- }
1906
- let isValid = true;
1907
- // R2 bindings must have a binding and bucket_name.
1908
- if (!isRequiredProperty(value, "binding", "string")) {
1909
- diagnostics.errors.push(
1910
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1911
- value
1912
- )}.`
1913
- );
1914
- isValid = false;
1915
- }
1916
- if (
1917
- !isRequiredProperty(value, "bucket_name", "string") ||
1918
- (value as { bucket_name: string }).bucket_name.length === 0
1919
- ) {
1920
- diagnostics.errors.push(
1921
- `"${field}" bindings should have a string "bucket_name" field but got ${JSON.stringify(
1922
- value
1923
- )}.`
1924
- );
1925
- isValid = false;
1926
- }
1927
- if (!isOptionalProperty(value, "preview_bucket_name", "string")) {
1928
- diagnostics.errors.push(
1929
- `"${field}" bindings should, optionally, have a string "preview_bucket_name" field but got ${JSON.stringify(
1930
- value
1931
- )}.`
1932
- );
1933
- isValid = false;
1934
- }
1935
- return isValid;
1936
- };
1937
-
1938
- const validateD1Binding: ValidatorFn = (diagnostics, field, value) => {
1939
- if (typeof value !== "object" || value === null) {
1940
- diagnostics.errors.push(
1941
- `"d1_databases" bindings should be objects, but got ${JSON.stringify(
1942
- value
1943
- )}`
1944
- );
1945
- return false;
1946
- }
1947
- let isValid = true;
1948
- // D1 databases must have a binding and either a database_name or database_id.
1949
- if (!isRequiredProperty(value, "binding", "string")) {
1950
- diagnostics.errors.push(
1951
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1952
- value
1953
- )}.`
1954
- );
1955
- isValid = false;
1956
- }
1957
- if (
1958
- // TODO: allow name only, where we look up the ID dynamically
1959
- // !isOptionalProperty(value, "database_name", "string") &&
1960
- !isRequiredProperty(value, "database_id", "string")
1961
- ) {
1962
- diagnostics.errors.push(
1963
- `"${field}" bindings must have a "database_id" field but got ${JSON.stringify(
1964
- value
1965
- )}.`
1966
- );
1967
- isValid = false;
1968
- }
1969
- if (!isOptionalProperty(value, "preview_database_id", "string")) {
1970
- diagnostics.errors.push(
1971
- `"${field}" bindings should, optionally, have a string "preview_database_id" field but got ${JSON.stringify(
1972
- value
1973
- )}.`
1974
- );
1975
- isValid = false;
1976
- }
1977
- if (isValid && !process.env.NO_D1_WARNING) {
1978
- diagnostics.warnings.push(
1979
- "D1 Bindings are currently in alpha to allow the API to evolve before general availability.\nPlease report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose\nNote: Run this command with the environment variable NO_D1_WARNING=true to hide this message\n\nFor example: `export NO_D1_WARNING=true && wrangler <YOUR COMMAND HERE>`"
1980
- );
1981
- }
1982
- return isValid;
1983
- };
1984
-
1985
- /**
1986
- * Check that bindings whose names might conflict, don't.
1987
- *
1988
- * We don't want to have, for example, a KV namespace named "DATA"
1989
- * and a Durable Object also named "DATA". Then it would be ambiguous
1990
- * what exactly would live at `env.DATA` (or in the case of service-workers,
1991
- * the `DATA` global).
1992
- */
1993
- const validateBindingsHaveUniqueNames = (
1994
- diagnostics: Diagnostics,
1995
- {
1996
- durable_objects,
1997
- kv_namespaces,
1998
- r2_buckets,
1999
- analytics_engine_datasets,
2000
- text_blobs,
2001
- unsafe,
2002
- vars,
2003
- define,
2004
- wasm_modules,
2005
- data_blobs,
2006
- }: Partial<Config>
2007
- ): boolean => {
2008
- let hasDuplicates = false;
2009
-
2010
- const bindingsGroupedByType = {
2011
- "Durable Object": getBindingNames(durable_objects),
2012
- "KV Namespace": getBindingNames(kv_namespaces),
2013
- "R2 Bucket": getBindingNames(r2_buckets),
2014
- "Analytics Engine Dataset": getBindingNames(analytics_engine_datasets),
2015
- "Text Blob": getBindingNames(text_blobs),
2016
- Unsafe: getBindingNames(unsafe),
2017
- "Environment Variable": getBindingNames(vars),
2018
- Definition: getBindingNames(define),
2019
- "WASM Module": getBindingNames(wasm_modules),
2020
- "Data Blob": getBindingNames(data_blobs),
2021
- } as Record<string, string[]>;
2022
-
2023
- const bindingsGroupedByName: Record<string, string[]> = {};
2024
-
2025
- for (const bindingType in bindingsGroupedByType) {
2026
- const bindingNames = bindingsGroupedByType[bindingType];
2027
-
2028
- for (const bindingName of bindingNames) {
2029
- if (!(bindingName in bindingsGroupedByName)) {
2030
- bindingsGroupedByName[bindingName] = [];
2031
- }
2032
-
2033
- bindingsGroupedByName[bindingName].push(bindingType);
2034
- }
2035
- }
2036
-
2037
- for (const bindingName in bindingsGroupedByName) {
2038
- const bindingTypes = bindingsGroupedByName[bindingName];
2039
- if (bindingTypes.length < 2) {
2040
- // there's only one (or zero) binding(s) with this name, which is fine, actually
2041
- continue;
2042
- }
2043
-
2044
- hasDuplicates = true;
2045
-
2046
- // there's two types of duplicates we want to look for:
2047
- // - bindings with the same name of the same type (e.g. two Durable Objects both named "OBJ")
2048
- // - bindings with the same name of different types (a KV namespace and DO both named "DATA")
2049
-
2050
- const sameType = bindingTypes
2051
- // filter once to find duplicate binding types
2052
- .filter((type, i) => bindingTypes.indexOf(type) !== i)
2053
- // filter twice to only get _unique_ duplicate binding types
2054
- .filter(
2055
- (type, i, duplicateBindingTypes) =>
2056
- duplicateBindingTypes.indexOf(type) === i
2057
- );
2058
-
2059
- const differentTypes = bindingTypes.filter(
2060
- (type, i) => bindingTypes.indexOf(type) === i
2061
- );
2062
-
2063
- if (differentTypes.length > 1) {
2064
- // we have multiple different types using the same name
2065
- diagnostics.errors.push(
2066
- `${bindingName} assigned to ${ENGLISH.format(differentTypes)} bindings.`
2067
- );
2068
- }
2069
-
2070
- sameType.forEach((bindingType) => {
2071
- diagnostics.errors.push(
2072
- `${bindingName} assigned to multiple ${bindingType} bindings.`
2073
- );
2074
- });
2075
- }
2076
-
2077
- if (hasDuplicates) {
2078
- const problem =
2079
- "Bindings must have unique names, so that they can all be referenced in the worker.";
2080
- const resolution = "Please change your bindings to have unique names.";
2081
- diagnostics.errors.push(`${problem}\n${resolution}`);
2082
- }
2083
-
2084
- return !hasDuplicates;
2085
- };
2086
-
2087
- const validateServiceBinding: ValidatorFn = (diagnostics, field, value) => {
2088
- if (typeof value !== "object" || value === null) {
2089
- diagnostics.errors.push(
2090
- `"services" bindings should be objects, but got ${JSON.stringify(value)}`
2091
- );
2092
- return false;
2093
- }
2094
- let isValid = true;
2095
- // Service bindings must have a binding, service, and environment.
2096
- if (!isRequiredProperty(value, "binding", "string")) {
2097
- diagnostics.errors.push(
2098
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
2099
- value
2100
- )}.`
2101
- );
2102
- isValid = false;
2103
- }
2104
- if (!isRequiredProperty(value, "service", "string")) {
2105
- diagnostics.errors.push(
2106
- `"${field}" bindings should have a string "service" field but got ${JSON.stringify(
2107
- value
2108
- )}.`
2109
- );
2110
- isValid = false;
2111
- }
2112
- if (!isOptionalProperty(value, "environment", "string")) {
2113
- diagnostics.errors.push(
2114
- `"${field}" bindings should have a string "environment" field but got ${JSON.stringify(
2115
- value
2116
- )}.`
2117
- );
2118
- isValid = false;
2119
- }
2120
- return isValid;
2121
- };
2122
-
2123
- const validateAnalyticsEngineBinding: ValidatorFn = (
2124
- diagnostics,
2125
- field,
2126
- value
2127
- ) => {
2128
- if (typeof value !== "object" || value === null) {
2129
- diagnostics.errors.push(
2130
- `"analytics_engine" bindings should be objects, but got ${JSON.stringify(
2131
- value
2132
- )}`
2133
- );
2134
- return false;
2135
- }
2136
- let isValid = true;
2137
- // Service bindings must have a binding and optional dataset.
2138
- if (!isRequiredProperty(value, "binding", "string")) {
2139
- diagnostics.errors.push(
2140
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
2141
- value
2142
- )}.`
2143
- );
2144
- isValid = false;
2145
- }
2146
- if (
2147
- !isOptionalProperty(value, "dataset", "string") ||
2148
- (value as { dataset: string }).dataset?.length === 0
2149
- ) {
2150
- diagnostics.errors.push(
2151
- `"${field}" bindings should, optionally, have a string "dataset" field but got ${JSON.stringify(
2152
- value
2153
- )}.`
2154
- );
2155
- isValid = false;
2156
- }
2157
- return isValid;
2158
- };
2159
-
2160
- const validateWorkerNamespaceBinding: ValidatorFn = (
2161
- diagnostics,
2162
- field,
2163
- value
2164
- ) => {
2165
- if (typeof value !== "object" || value === null) {
2166
- diagnostics.errors.push(
2167
- `"${field}" binding should be objects, but got ${JSON.stringify(value)}`
2168
- );
2169
- return false;
2170
- }
2171
- let isValid = true;
2172
- // Worker namespace bindings must have a binding, and a namespace.
2173
- if (!isRequiredProperty(value, "binding", "string")) {
2174
- diagnostics.errors.push(
2175
- `"${field}" should have a string "binding" field but got ${JSON.stringify(
2176
- value
2177
- )}.`
2178
- );
2179
- isValid = false;
2180
- }
2181
- if (!isRequiredProperty(value, "namespace", "string")) {
2182
- diagnostics.errors.push(
2183
- `"${field}" should have a string "namespace" field but got ${JSON.stringify(
2184
- value
2185
- )}.`
2186
- );
2187
- isValid = false;
2188
- }
2189
- return isValid;
2190
- };
2191
-
2192
- const validateMTlsCertificateBinding: ValidatorFn = (
2193
- diagnostics,
2194
- field,
2195
- value
2196
- ) => {
2197
- if (typeof value !== "object" || value === null) {
2198
- diagnostics.errors.push(
2199
- `"mtls_certificates" bindings should be objects, but got ${JSON.stringify(
2200
- value
2201
- )}`
2202
- );
2203
- return false;
2204
- }
2205
- let isValid = true;
2206
- if (!isRequiredProperty(value, "binding", "string")) {
2207
- diagnostics.errors.push(
2208
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
2209
- value
2210
- )}.`
2211
- );
2212
- isValid = false;
2213
- }
2214
- if (
2215
- !isRequiredProperty(value, "certificate_id", "string") ||
2216
- (value as { certificate_id: string }).certificate_id.length === 0
2217
- ) {
2218
- diagnostics.errors.push(
2219
- `"${field}" bindings should have a string "certificate_id" field but got ${JSON.stringify(
2220
- value
2221
- )}.`
2222
- );
2223
- isValid = false;
2224
- }
2225
- return isValid;
2226
- };
2227
-
2228
- function validateQueues(envName: string): ValidatorFn {
2229
- return (diagnostics, field, value, config) => {
2230
- const fieldPath =
2231
- config === undefined ? `${field}` : `env.${envName}.${field}`;
2232
-
2233
- if (typeof value !== "object" || Array.isArray(value) || value === null) {
2234
- diagnostics.errors.push(
2235
- `The field "${fieldPath}" should be an object but got ${JSON.stringify(
2236
- value
2237
- )}.`
2238
- );
2239
- return false;
2240
- }
2241
-
2242
- let isValid = true;
2243
- if (
2244
- !validateAdditionalProperties(
2245
- diagnostics,
2246
- fieldPath,
2247
- Object.keys(value),
2248
- ["consumers", "producers"]
2249
- )
2250
- ) {
2251
- isValid = false;
2252
- }
2253
-
2254
- if (hasProperty(value, "consumers")) {
2255
- const consumers = value.consumers;
2256
- if (!Array.isArray(consumers)) {
2257
- diagnostics.errors.push(
2258
- `The field "${fieldPath}.consumers" should be an array but got ${JSON.stringify(
2259
- consumers
2260
- )}.`
2261
- );
2262
- isValid = false;
2263
- }
2264
-
2265
- for (let i = 0; i < consumers.length; i++) {
2266
- const consumer = consumers[i];
2267
- const consumerPath = `${fieldPath}.consumers[${i}]`;
2268
- if (!validateConsumer(diagnostics, consumerPath, consumer, config)) {
2269
- isValid = false;
2270
- }
2271
- }
2272
- }
2273
-
2274
- if (hasProperty(value, "producers")) {
2275
- if (
2276
- !validateBindingArray(envName, validateQueueBinding)(
2277
- diagnostics,
2278
- `${field}.producers`,
2279
- value.producers,
2280
- config
2281
- )
2282
- ) {
2283
- isValid = false;
2284
- }
2285
- }
2286
- return isValid;
2287
- };
2288
- }
2289
-
2290
- const validateConsumer: ValidatorFn = (diagnostics, field, value, _config) => {
2291
- if (typeof value !== "object" || value === null) {
2292
- diagnostics.errors.push(
2293
- `"${field}" should be a objects, but got ${JSON.stringify(value)}`
2294
- );
2295
- return false;
2296
- }
2297
-
2298
- let isValid = true;
2299
- if (
2300
- !validateAdditionalProperties(diagnostics, field, Object.keys(value), [
2301
- "queue",
2302
- "max_batch_size",
2303
- "max_batch_timeout",
2304
- "max_retries",
2305
- "dead_letter_queue",
2306
- "max_concurrency",
2307
- ])
2308
- ) {
2309
- isValid = false;
2310
- }
2311
-
2312
- if (!isRequiredProperty(value, "queue", "string")) {
2313
- diagnostics.errors.push(
2314
- `"${field}" should have a string "queue" field but got ${JSON.stringify(
2315
- value
2316
- )}.`
2317
- );
2318
- }
2319
-
2320
- const options: {
2321
- key: string;
2322
- type: "number" | "string" | "boolean";
2323
- }[] = [
2324
- { key: "max_batch_size", type: "number" },
2325
- { key: "max_batch_timeout", type: "number" },
2326
- { key: "max_retries", type: "number" },
2327
- { key: "dead_letter_queue", type: "string" },
2328
- { key: "max_concurrency", type: "number" },
2329
- ];
2330
- for (const optionalOpt of options) {
2331
- if (!isOptionalProperty(value, optionalOpt.key, optionalOpt.type)) {
2332
- diagnostics.errors.push(
2333
- `"${field}" should, optionally, have a ${optionalOpt.type} "${
2334
- optionalOpt.key
2335
- }" field but got ${JSON.stringify(value)}.`
2336
- );
2337
- isValid = false;
2338
- }
2339
- }
2340
-
2341
- return isValid;
2342
- };