wrangler 2.20.0 → 3.0.0

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 (297) hide show
  1. package/README.md +4 -4
  2. package/bin/wrangler.js +9 -75
  3. package/package.json +5 -13
  4. package/templates/__tests__/tsconfig.tsbuildinfo +1 -1
  5. package/templates/checked-fetch.js +1 -1
  6. package/templates/first-party-worker-module-facade.ts +2 -2
  7. package/templates/middleware/common.ts +9 -4
  8. package/templates/middleware/loader-sw.ts +2 -7
  9. package/templates/new-worker-scheduled.ts +1 -1
  10. package/templates/new-worker.ts +1 -1
  11. package/templates/pages-dev-util.ts +4 -1
  12. package/templates/pages-shim.ts +0 -3
  13. package/templates/tsconfig.tsbuildinfo +1 -1
  14. package/wrangler-dist/cli.d.ts +149 -75
  15. package/wrangler-dist/cli.js +60062 -64338
  16. package/import_meta_url.js +0 -3
  17. package/miniflare-config-stubs/.env.empty +0 -0
  18. package/miniflare-config-stubs/package.empty.json +0 -1
  19. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  20. package/miniflare-dist/index.mjs +0 -6442
  21. package/src/__tests__/access.test.ts +0 -25
  22. package/src/__tests__/api-dev.test.ts +0 -238
  23. package/src/__tests__/api-devregistry.test.ts +0 -121
  24. package/src/__tests__/api.test.ts +0 -102
  25. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  26. package/src/__tests__/config-cache.test.ts +0 -42
  27. package/src/__tests__/configuration.test.ts +0 -4517
  28. package/src/__tests__/constellation.test.ts +0 -371
  29. package/src/__tests__/d1/d1.test.ts +0 -82
  30. package/src/__tests__/d1/execute.test.ts +0 -66
  31. package/src/__tests__/d1/migrate.test.ts +0 -257
  32. package/src/__tests__/d1/splitter.test.ts +0 -255
  33. package/src/__tests__/delete.test.ts +0 -272
  34. package/src/__tests__/deployments.test.ts +0 -369
  35. package/src/__tests__/dev.test.tsx +0 -1617
  36. package/src/__tests__/generate.test.ts +0 -237
  37. package/src/__tests__/get-host-from-url.test.ts +0 -16
  38. package/src/__tests__/guess-worker-format.test.ts +0 -120
  39. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  40. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  41. package/src/__tests__/helpers/end-event-loop.ts +0 -6
  42. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  43. package/src/__tests__/helpers/mock-auth-domain.ts +0 -20
  44. package/src/__tests__/helpers/mock-bin.ts +0 -36
  45. package/src/__tests__/helpers/mock-console.ts +0 -112
  46. package/src/__tests__/helpers/mock-dialogs.ts +0 -139
  47. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +0 -25
  48. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -11
  49. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  50. package/src/__tests__/helpers/mock-istty.ts +0 -74
  51. package/src/__tests__/helpers/mock-known-routes.ts +0 -12
  52. package/src/__tests__/helpers/mock-kv.ts +0 -46
  53. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -263
  54. package/src/__tests__/helpers/mock-process.ts +0 -34
  55. package/src/__tests__/helpers/mock-set-timeout.ts +0 -16
  56. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  57. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  58. package/src/__tests__/helpers/msw/blob-worker.cjs +0 -19
  59. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  60. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -160
  61. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -81
  62. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  63. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -60
  64. package/src/__tests__/helpers/msw/handlers/script.ts +0 -56
  65. package/src/__tests__/helpers/msw/handlers/user.ts +0 -52
  66. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -20
  67. package/src/__tests__/helpers/msw/index.ts +0 -52
  68. package/src/__tests__/helpers/msw/read-file-sync.js +0 -61
  69. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  70. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  71. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +0 -28
  72. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  73. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  74. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  75. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -11
  76. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  77. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  78. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  79. package/src/__tests__/https-options.test.ts +0 -163
  80. package/src/__tests__/index.test.ts +0 -282
  81. package/src/__tests__/init.test.ts +0 -3196
  82. package/src/__tests__/jest.setup.ts +0 -179
  83. package/src/__tests__/kv.test.ts +0 -1799
  84. package/src/__tests__/logger.test.ts +0 -207
  85. package/src/__tests__/logout.test.ts +0 -47
  86. package/src/__tests__/metrics.test.ts +0 -493
  87. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  88. package/src/__tests__/middleware.test.ts +0 -816
  89. package/src/__tests__/mtls-certificates.test.ts +0 -589
  90. package/src/__tests__/package-manager.test.ts +0 -353
  91. package/src/__tests__/pages/deployment-list.test.ts +0 -80
  92. package/src/__tests__/pages/functions-build.test.ts +0 -528
  93. package/src/__tests__/pages/pages.test.ts +0 -81
  94. package/src/__tests__/pages/project-create.test.ts +0 -63
  95. package/src/__tests__/pages/project-list.test.ts +0 -110
  96. package/src/__tests__/pages/project-upload.test.ts +0 -500
  97. package/src/__tests__/pages/publish.test.ts +0 -2864
  98. package/src/__tests__/pages-deployment-tail.test.ts +0 -957
  99. package/src/__tests__/parse.test.ts +0 -436
  100. package/src/__tests__/paths.test.ts +0 -39
  101. package/src/__tests__/publish.test.ts +0 -8849
  102. package/src/__tests__/pubsub.test.ts +0 -496
  103. package/src/__tests__/queues.test.ts +0 -532
  104. package/src/__tests__/r2.test.ts +0 -374
  105. package/src/__tests__/route.test.ts +0 -45
  106. package/src/__tests__/secret.test.ts +0 -693
  107. package/src/__tests__/tail.test.ts +0 -989
  108. package/src/__tests__/test-old-node-version.js +0 -31
  109. package/src/__tests__/traverse-module-graph.test.ts +0 -220
  110. package/src/__tests__/tsconfig-sanity.ts +0 -12
  111. package/src/__tests__/tsconfig.json +0 -8
  112. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  113. package/src/__tests__/type-generation.test.ts +0 -234
  114. package/src/__tests__/user.test.ts +0 -118
  115. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  116. package/src/__tests__/validate-dev-props.test.ts +0 -56
  117. package/src/__tests__/version.test.ts +0 -35
  118. package/src/__tests__/whoami.test.tsx +0 -172
  119. package/src/__tests__/worker-namespace.test.ts +0 -340
  120. package/src/abort.d.ts +0 -3
  121. package/src/api/dev.ts +0 -321
  122. package/src/api/index.ts +0 -11
  123. package/src/api/mtls-certificate.ts +0 -148
  124. package/src/api/pages/create-worker-bundle-contents.ts +0 -77
  125. package/src/api/pages/index.ts +0 -5
  126. package/src/api/pages/publish.tsx +0 -371
  127. package/src/bundle-reporter.ts +0 -68
  128. package/src/bundle.ts +0 -929
  129. package/src/cfetch/index.ts +0 -158
  130. package/src/cfetch/internal.ts +0 -258
  131. package/src/cli.ts +0 -28
  132. package/src/config/README.md +0 -107
  133. package/src/config/config.ts +0 -282
  134. package/src/config/diagnostics.ts +0 -80
  135. package/src/config/environment.ts +0 -625
  136. package/src/config/index.ts +0 -403
  137. package/src/config/validation-helpers.ts +0 -597
  138. package/src/config/validation.ts +0 -2369
  139. package/src/config-cache.ts +0 -85
  140. package/src/constellation/createProject.tsx +0 -51
  141. package/src/constellation/deleteProject.ts +0 -51
  142. package/src/constellation/deleteProjectModel.ts +0 -68
  143. package/src/constellation/index.ts +0 -75
  144. package/src/constellation/listCatalog.tsx +0 -35
  145. package/src/constellation/listModel.tsx +0 -41
  146. package/src/constellation/listProject.tsx +0 -28
  147. package/src/constellation/listRuntime.tsx +0 -28
  148. package/src/constellation/options.ts +0 -17
  149. package/src/constellation/types.ts +0 -17
  150. package/src/constellation/uploadModel.tsx +0 -64
  151. package/src/constellation/utils.ts +0 -90
  152. package/src/create-worker-preview.ts +0 -293
  153. package/src/create-worker-upload-form.ts +0 -363
  154. package/src/d1/backups.tsx +0 -219
  155. package/src/d1/constants.ts +0 -2
  156. package/src/d1/create.tsx +0 -70
  157. package/src/d1/delete.ts +0 -53
  158. package/src/d1/execute.tsx +0 -357
  159. package/src/d1/formatTimeAgo.ts +0 -14
  160. package/src/d1/index.ts +0 -100
  161. package/src/d1/list.tsx +0 -62
  162. package/src/d1/migrations/apply.tsx +0 -212
  163. package/src/d1/migrations/create.tsx +0 -79
  164. package/src/d1/migrations/helpers.ts +0 -169
  165. package/src/d1/migrations/index.ts +0 -3
  166. package/src/d1/migrations/list.tsx +0 -95
  167. package/src/d1/migrations/options.ts +0 -23
  168. package/src/d1/options.ts +0 -22
  169. package/src/d1/splitter.ts +0 -161
  170. package/src/d1/types.ts +0 -25
  171. package/src/d1/utils.ts +0 -49
  172. package/src/delete.ts +0 -100
  173. package/src/deployments.ts +0 -368
  174. package/src/deprecated/index.ts +0 -144
  175. package/src/dev/dev-vars.ts +0 -39
  176. package/src/dev/dev.tsx +0 -605
  177. package/src/dev/get-local-persistence-path.ts +0 -31
  178. package/src/dev/local.tsx +0 -952
  179. package/src/dev/remote.tsx +0 -635
  180. package/src/dev/start-server.ts +0 -545
  181. package/src/dev/use-esbuild.ts +0 -215
  182. package/src/dev/validate-dev-props.ts +0 -40
  183. package/src/dev-registry.ts +0 -202
  184. package/src/dev.tsx +0 -934
  185. package/src/dialogs.ts +0 -136
  186. package/src/dispatch-namespace.ts +0 -211
  187. package/src/docs/helpers.ts +0 -50
  188. package/src/docs/index.ts +0 -54
  189. package/src/durable.ts +0 -102
  190. package/src/entry.ts +0 -344
  191. package/src/environment-variables/factory.ts +0 -89
  192. package/src/environment-variables/misc-variables.ts +0 -30
  193. package/src/errors.ts +0 -11
  194. package/src/generate/index.ts +0 -298
  195. package/src/git-client.ts +0 -135
  196. package/src/global-wrangler-config-path.ts +0 -26
  197. package/src/https-options.ts +0 -127
  198. package/src/index.ts +0 -768
  199. package/src/init.ts +0 -1037
  200. package/src/inspect.ts +0 -883
  201. package/src/intl-polyfill.d.ts +0 -139
  202. package/src/is-ci.ts +0 -14
  203. package/src/is-interactive.ts +0 -16
  204. package/src/jest.d.ts +0 -4
  205. package/src/kv/helpers.ts +0 -433
  206. package/src/kv/index.ts +0 -594
  207. package/src/logger.ts +0 -123
  208. package/src/metrics/index.ts +0 -5
  209. package/src/metrics/metrics-config.ts +0 -239
  210. package/src/metrics/metrics-dispatcher.ts +0 -96
  211. package/src/metrics/metrics-usage-headers.ts +0 -24
  212. package/src/metrics/send-event.ts +0 -99
  213. package/src/miniflare-cli/README.md +0 -30
  214. package/src/miniflare-cli/assets.ts +0 -251
  215. package/src/miniflare-cli/index.ts +0 -210
  216. package/src/miniflare-cli/request-context.ts +0 -40
  217. package/src/miniflare-cli/tsconfig.json +0 -9
  218. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  219. package/src/miniflare-cli/types.ts +0 -11
  220. package/src/module-collection.ts +0 -333
  221. package/src/mtls-certificate/cli.ts +0 -155
  222. package/src/open-in-browser.ts +0 -17
  223. package/src/package-manager.ts +0 -219
  224. package/src/pages/build.ts +0 -423
  225. package/src/pages/buildFunctions.ts +0 -140
  226. package/src/pages/constants.ts +0 -18
  227. package/src/pages/deployment-tails.ts +0 -281
  228. package/src/pages/deployments.tsx +0 -84
  229. package/src/pages/dev.ts +0 -734
  230. package/src/pages/errors.ts +0 -67
  231. package/src/pages/functions/buildPlugin.ts +0 -114
  232. package/src/pages/functions/buildWorker.ts +0 -350
  233. package/src/pages/functions/filepath-routing.test.ts +0 -234
  234. package/src/pages/functions/filepath-routing.ts +0 -189
  235. package/src/pages/functions/identifiers.ts +0 -78
  236. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  237. package/src/pages/functions/routes-consolidation.ts +0 -73
  238. package/src/pages/functions/routes-transformation.test.ts +0 -282
  239. package/src/pages/functions/routes-transformation.ts +0 -115
  240. package/src/pages/functions/routes-validation.test.ts +0 -403
  241. package/src/pages/functions/routes-validation.ts +0 -202
  242. package/src/pages/functions/routes.ts +0 -151
  243. package/src/pages/functions/tsconfig.json +0 -8
  244. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  245. package/src/pages/functions.ts +0 -86
  246. package/src/pages/hash.ts +0 -13
  247. package/src/pages/index.ts +0 -102
  248. package/src/pages/projects.tsx +0 -159
  249. package/src/pages/prompt-select-project.tsx +0 -31
  250. package/src/pages/publish.tsx +0 -267
  251. package/src/pages/types.ts +0 -46
  252. package/src/pages/upload.tsx +0 -469
  253. package/src/pages/utils.ts +0 -23
  254. package/src/parse.ts +0 -308
  255. package/src/paths.ts +0 -71
  256. package/src/proxy.ts +0 -694
  257. package/src/publish/index.ts +0 -274
  258. package/src/publish/publish.ts +0 -1065
  259. package/src/pubsub/index.ts +0 -286
  260. package/src/pubsub/pubsub-commands.ts +0 -623
  261. package/src/queues/cli/commands/consumer/add.ts +0 -71
  262. package/src/queues/cli/commands/consumer/index.ts +0 -19
  263. package/src/queues/cli/commands/consumer/remove.ts +0 -31
  264. package/src/queues/cli/commands/create.ts +0 -25
  265. package/src/queues/cli/commands/delete.ts +0 -26
  266. package/src/queues/cli/commands/index.ts +0 -35
  267. package/src/queues/cli/commands/list.ts +0 -25
  268. package/src/queues/client.ts +0 -136
  269. package/src/queues/utils.ts +0 -18
  270. package/src/r2/constants.ts +0 -4
  271. package/src/r2/helpers.ts +0 -132
  272. package/src/r2/index.ts +0 -289
  273. package/src/routes.ts +0 -140
  274. package/src/secret/index.ts +0 -377
  275. package/src/selfsigned.d.ts +0 -29
  276. package/src/sites.ts +0 -484
  277. package/src/tail/createTail.ts +0 -415
  278. package/src/tail/filters.ts +0 -277
  279. package/src/tail/index.ts +0 -211
  280. package/src/tail/printing.ts +0 -132
  281. package/src/traverse-module-graph.ts +0 -54
  282. package/src/tsconfig-sanity.ts +0 -16
  283. package/src/type-generation.ts +0 -181
  284. package/src/update-check.ts +0 -19
  285. package/src/user/access.ts +0 -68
  286. package/src/user/auth-variables.ts +0 -113
  287. package/src/user/choose-account.tsx +0 -39
  288. package/src/user/generate-auth-url.ts +0 -33
  289. package/src/user/generate-random-state.ts +0 -16
  290. package/src/user/index.ts +0 -2
  291. package/src/user/user.ts +0 -1234
  292. package/src/utils/collectKeyValues.ts +0 -14
  293. package/src/utils/render.ts +0 -93
  294. package/src/whoami.ts +0 -135
  295. package/src/worker.ts +0 -279
  296. package/src/yargs-types.ts +0 -37
  297. package/src/zones.ts +0 -191
@@ -1,148 +0,0 @@
1
- import { fetchResult } from "../cfetch";
2
- import { readFileSync } from "../parse";
3
-
4
- /**
5
- * the representation of an mTLS certificate in the account certificate store
6
- */
7
- export interface MTlsCertificateResponse {
8
- id: string;
9
- name?: string;
10
- ca: boolean;
11
- certificates: string;
12
- expires_on: string;
13
- issuer: string;
14
- serial_number: string;
15
- signature: string;
16
- uploaded_on: string;
17
- }
18
-
19
- /**
20
- * details for uploading an mTLS certificate from disk
21
- */
22
- export interface MTlsCertificateUploadDetails {
23
- certificateChainFilename: string;
24
- privateKeyFilename: string;
25
- name?: string;
26
- }
27
-
28
- /**
29
- * details for uploading an mTLS certificate via the ssl api
30
- */
31
- export interface MTlsCertificateBody {
32
- certificateChain: string;
33
- privateKey: string;
34
- name?: string;
35
- }
36
-
37
- /**
38
- * supported filters for listing mTLS certificates via the ssl api
39
- */
40
- export interface MTlsCertificateListFilter {
41
- name?: string;
42
- }
43
-
44
- /**
45
- * indicates that looking up a certificate by name failed due to zero matching results
46
- */
47
- export class ErrorMTlsCertificateNameNotFound extends Error {}
48
-
49
- /**
50
- * indicates that looking up a certificate by name failed due to more than one matching results
51
- */
52
- export class ErrorMTlsCertificateManyNamesMatch extends Error {}
53
-
54
- /**
55
- * reads an mTLS certificate and private key pair from disk and uploads it to the account mTLS certificate store
56
- */
57
- export async function uploadMTlsCertificateFromFs(
58
- accountId: string,
59
- details: MTlsCertificateUploadDetails
60
- ): Promise<MTlsCertificateResponse> {
61
- return await uploadMTlsCertificate(accountId, {
62
- certificateChain: readFileSync(details.certificateChainFilename),
63
- privateKey: readFileSync(details.privateKeyFilename),
64
- name: details.name,
65
- });
66
- }
67
-
68
- /**
69
- * uploads an mTLS certificate and private key pair to the account mTLS certificate store
70
- */
71
- export async function uploadMTlsCertificate(
72
- accountId: string,
73
- body: MTlsCertificateBody
74
- ): Promise<MTlsCertificateResponse> {
75
- return await fetchResult(`/accounts/${accountId}/mtls_certificates`, {
76
- method: "POST",
77
- body: JSON.stringify({
78
- name: body.name,
79
- certificates: body.certificateChain,
80
- private_key: body.privateKey,
81
- ca: false,
82
- }),
83
- });
84
- }
85
-
86
- /**
87
- * fetches an mTLS certificate from the account mTLS certificate store by ID
88
- */
89
- export async function getMTlsCertificate(
90
- accountId: string,
91
- id: string
92
- ): Promise<MTlsCertificateResponse> {
93
- return await fetchResult(
94
- `/accounts/${accountId}/mtls_certificates/${id}`,
95
- {}
96
- );
97
- }
98
-
99
- /**
100
- * lists mTLS certificates for an account. filtering by name is supported
101
- */
102
- export async function listMTlsCertificates(
103
- accountId: string,
104
- filter: MTlsCertificateListFilter
105
- ): Promise<MTlsCertificateResponse[]> {
106
- const params = new URLSearchParams();
107
- params.append("ca", "false");
108
- if (filter.name) {
109
- params.append("name", filter.name);
110
- }
111
- return await fetchResult(
112
- `/accounts/${accountId}/mtls_certificates`,
113
- {},
114
- params
115
- );
116
- }
117
-
118
- /**
119
- * fetches an mTLS certificate from the account mTLS certificate store by name. will throw an error if no certificates are found, or multiple are found with that name
120
- */
121
- export async function getMTlsCertificateByName(
122
- accountId: string,
123
- name: string
124
- ): Promise<MTlsCertificateResponse> {
125
- const certificates = await listMTlsCertificates(accountId, { name });
126
- if (certificates.length === 0) {
127
- throw new ErrorMTlsCertificateNameNotFound(
128
- `certificate not found with name "${name}"`
129
- );
130
- }
131
- if (certificates.length > 1) {
132
- throw new ErrorMTlsCertificateManyNamesMatch(
133
- `multiple certificates found with name "${name}"`
134
- );
135
- }
136
- const certificate = certificates[0];
137
- return certificate;
138
- }
139
-
140
- export async function deleteMTlsCertificate(
141
- accountId: string,
142
- certificateId: string
143
- ) {
144
- return await fetchResult(
145
- `/accounts/${accountId}/mtls_certificates/${certificateId}`,
146
- { method: "DELETE" }
147
- );
148
- }
@@ -1,77 +0,0 @@
1
- import { readFileSync } from "node:fs";
2
- import path from "node:path";
3
- import { Response } from "undici";
4
- import { createWorkerUploadForm } from "../../create-worker-upload-form";
5
- import type { BundleResult } from "../../bundle";
6
- import type { CfWorkerInit } from "../../worker";
7
- import type { Blob } from "node:buffer";
8
- import type { FormData } from "undici";
9
-
10
- /**
11
- * Takes a Worker bundle - `BundleResult` - and generates the _worker.bundle
12
- * contents
13
- */
14
- export async function createUploadWorkerBundleContents(
15
- workerBundle: BundleResult
16
- ): Promise<Blob> {
17
- const workerBundleFormData = createWorkerBundleFormData(workerBundle);
18
- const metadata = JSON.parse(workerBundleFormData.get("metadata") as string);
19
-
20
- /**
21
- * Pages doesn't need the metadata bindings returned by
22
- * `createWorkerBundleFormData`. Let's strip them out and return only
23
- * the contents we need
24
- */
25
- workerBundleFormData.set(
26
- "metadata",
27
- JSON.stringify({ main_module: metadata.main_module })
28
- );
29
-
30
- return await new Response(workerBundleFormData).blob();
31
- }
32
-
33
- /**
34
- * Creates a `FormData` upload from a `BundleResult`
35
- */
36
- function createWorkerBundleFormData(workerBundle: BundleResult): FormData {
37
- const mainModule = {
38
- name: path.basename(workerBundle.resolvedEntryPointPath),
39
- content: readFileSync(workerBundle.resolvedEntryPointPath, {
40
- encoding: "utf-8",
41
- }),
42
- type: workerBundle.bundleType || "esm",
43
- };
44
-
45
- const worker: CfWorkerInit = {
46
- name: mainModule.name,
47
- main: mainModule,
48
- modules: workerBundle.modules,
49
- bindings: {
50
- vars: undefined,
51
- kv_namespaces: undefined,
52
- send_email: undefined,
53
- wasm_modules: undefined,
54
- text_blobs: undefined,
55
- data_blobs: undefined,
56
- durable_objects: undefined,
57
- queues: undefined,
58
- r2_buckets: undefined,
59
- d1_databases: undefined,
60
- services: undefined,
61
- analytics_engine_datasets: undefined,
62
- dispatch_namespaces: undefined,
63
- mtls_certificates: undefined,
64
- logfwdr: undefined,
65
- unsafe: undefined,
66
- },
67
- migrations: undefined,
68
- compatibility_date: undefined,
69
- compatibility_flags: undefined,
70
- usage_model: undefined,
71
- keepVars: undefined,
72
- logpush: undefined,
73
- placement: undefined,
74
- };
75
-
76
- return createWorkerUploadForm(worker);
77
- }
@@ -1,5 +0,0 @@
1
- import { publish } from "./publish";
2
-
3
- export const unstable_pages = {
4
- publish,
5
- };
@@ -1,371 +0,0 @@
1
- import { existsSync, lstatSync, readFileSync } from "node:fs";
2
- import { tmpdir } from "node:os";
3
- import { join, resolve as resolvePath } from "node:path";
4
- import { cwd } from "node:process";
5
- import { File, FormData } from "undici";
6
- import { fetchResult } from "../../cfetch";
7
- import { FatalError } from "../../errors";
8
- import { logger } from "../../logger";
9
- import { buildFunctions } from "../../pages/buildFunctions";
10
- import {
11
- FunctionsNoRoutesError,
12
- getFunctionsNoRoutesWarning,
13
- } from "../../pages/errors";
14
- import {
15
- buildRawWorker,
16
- checkRawWorker,
17
- traverseAndBuildWorkerJSDirectory,
18
- } from "../../pages/functions/buildWorker";
19
- import { validateRoutes } from "../../pages/functions/routes-validation";
20
- import { upload } from "../../pages/upload";
21
- import { createUploadWorkerBundleContents } from "./create-worker-bundle-contents";
22
- import type { BundleResult } from "../../bundle";
23
- import type { Project, Deployment } from "@cloudflare/types";
24
-
25
- interface PagesPublishOptions {
26
- /**
27
- * Path to static assets to publish to Pages
28
- */
29
- directory: string;
30
- /**
31
- * The Cloudflare Account ID that owns the project that's
32
- * being published
33
- */
34
- accountId: string;
35
- /**
36
- * The name of the project to be published
37
- */
38
- projectName: string;
39
- /**
40
- * Branch name to use. Defaults to production branch
41
- */
42
- branch?: string;
43
- /**
44
- * Whether or not to skip local file upload result caching
45
- */
46
- skipCaching?: boolean;
47
- /**
48
- * Commit message associated to deployment
49
- */
50
- commitMessage?: string;
51
- /**
52
- * Commit hash associated to deployment
53
- */
54
- commitHash?: string;
55
- /**
56
- * Whether or not the deployment should be considered to be
57
- * in a dirty commit state
58
- */
59
- commitDirty?: boolean;
60
- /**
61
- * Path to the project's functions directory. Default uses
62
- * the current working directory + /functions since this is
63
- * typically called in a CLI
64
- */
65
- functionsDirectory?: string;
66
-
67
- /**
68
- * Whether to run bundling on `_worker.js` before deploying.
69
- * Default: true
70
- */
71
- bundle?: boolean;
72
-
73
- // TODO: Allow passing in the API key and plumb it through
74
- // to the API calls so that the publish function does not
75
- // rely on the `CLOUDFLARE_API_KEY` environment variable
76
- }
77
-
78
- /**
79
- * Publish a directory to an account/project.
80
- * NOTE: You will need the `CLOUDFLARE_API_KEY` environment
81
- * variable set
82
- */
83
- export async function publish({
84
- directory,
85
- accountId,
86
- projectName,
87
- branch,
88
- skipCaching,
89
- commitMessage,
90
- commitHash,
91
- commitDirty,
92
- functionsDirectory: customFunctionsDirectory,
93
- bundle,
94
- }: PagesPublishOptions) {
95
- let _headers: string | undefined,
96
- _redirects: string | undefined,
97
- _routesGenerated: string | undefined,
98
- _routesCustom: string | undefined,
99
- _workerJSIsDirectory = false,
100
- _workerJS: string | undefined;
101
-
102
- bundle = bundle ?? true;
103
-
104
- const _workerPath = resolvePath(directory, "_worker.js");
105
-
106
- try {
107
- _headers = readFileSync(join(directory, "_headers"), "utf-8");
108
- } catch {}
109
-
110
- try {
111
- _redirects = readFileSync(join(directory, "_redirects"), "utf-8");
112
- } catch {}
113
-
114
- try {
115
- /**
116
- * Developers can specify a custom _routes.json file, for projects with Pages
117
- * Functions or projects in Advanced Mode
118
- */
119
- _routesCustom = readFileSync(join(directory, "_routes.json"), "utf-8");
120
- } catch {}
121
-
122
- try {
123
- _workerJSIsDirectory = lstatSync(_workerPath).isDirectory();
124
- if (!_workerJSIsDirectory) {
125
- _workerJS = readFileSync(_workerPath, "utf-8");
126
- }
127
- } catch {}
128
-
129
- // Grab the bindings from the API, we need these for shims and other such hacky inserts
130
- const project = await fetchResult<Project>(
131
- `/accounts/${accountId}/pages/projects/${projectName}`
132
- );
133
- let isProduction = true;
134
- if (branch) {
135
- isProduction = project.production_branch === branch;
136
- }
137
-
138
- const deploymentConfig =
139
- project.deployment_configs[isProduction ? "production" : "preview"];
140
- const nodejsCompat =
141
- deploymentConfig.compatibility_flags?.includes("nodejs_compat");
142
-
143
- /**
144
- * Evaluate if this is an Advanced Mode or Pages Functions project. If Advanced Mode, we'll
145
- * go ahead and upload `_worker.js` as is, but if Pages Functions, we need to attempt to build
146
- * Functions first and exit if it failed
147
- */
148
- let builtFunctions: string | undefined = undefined;
149
- let workerBundle: BundleResult | undefined = undefined;
150
-
151
- const functionsDirectory =
152
- customFunctionsDirectory || join(cwd(), "functions");
153
- const routesOutputPath = !existsSync(join(directory, "_routes.json"))
154
- ? join(tmpdir(), `_routes-${Math.random()}.json`)
155
- : undefined;
156
-
157
- // Routing configuration displayed in the Functions tab of a deployment in Dash
158
- let filepathRoutingConfig: string | undefined;
159
-
160
- const d1Databases = Object.keys(
161
- project.deployment_configs[isProduction ? "production" : "preview"]
162
- .d1_databases ?? {}
163
- );
164
-
165
- if (!_workerJS && existsSync(functionsDirectory)) {
166
- const outputConfigPath = join(
167
- tmpdir(),
168
- `functions-filepath-routing-config-${Math.random()}.json`
169
- );
170
-
171
- try {
172
- workerBundle = await buildFunctions({
173
- outputConfigPath,
174
- functionsDirectory,
175
- onEnd: () => {},
176
- buildOutputDirectory: directory,
177
- routesOutputPath,
178
- local: false,
179
- d1Databases,
180
- nodejsCompat,
181
- });
182
-
183
- builtFunctions = readFileSync(
184
- workerBundle.resolvedEntryPointPath,
185
- "utf-8"
186
- );
187
- filepathRoutingConfig = readFileSync(outputConfigPath, "utf-8");
188
- } catch (e) {
189
- if (e instanceof FunctionsNoRoutesError) {
190
- logger.warn(
191
- getFunctionsNoRoutesWarning(functionsDirectory, "skipping")
192
- );
193
- } else {
194
- throw e;
195
- }
196
- }
197
- }
198
-
199
- const manifest = await upload({
200
- directory,
201
- accountId,
202
- projectName,
203
- skipCaching: skipCaching ?? false,
204
- });
205
-
206
- const formData = new FormData();
207
-
208
- formData.append("manifest", JSON.stringify(manifest));
209
-
210
- if (branch) {
211
- formData.append("branch", branch);
212
- }
213
-
214
- if (commitMessage) {
215
- formData.append("commit_message", commitMessage);
216
- }
217
-
218
- if (commitHash) {
219
- formData.append("commit_hash", commitHash);
220
- }
221
-
222
- if (commitDirty !== undefined) {
223
- formData.append("commit_dirty", commitDirty);
224
- }
225
-
226
- if (_headers) {
227
- formData.append("_headers", new File([_headers], "_headers"));
228
- logger.log(`✨ Uploading _headers`);
229
- }
230
-
231
- if (_redirects) {
232
- formData.append("_redirects", new File([_redirects], "_redirects"));
233
- logger.log(`✨ Uploading _redirects`);
234
- }
235
-
236
- if (filepathRoutingConfig) {
237
- formData.append(
238
- "functions-filepath-routing-config.json",
239
- new File(
240
- [filepathRoutingConfig],
241
- "functions-filepath-routing-config.json"
242
- )
243
- );
244
- }
245
-
246
- /**
247
- * Advanced Mode
248
- * https://developers.cloudflare.com/pages/platform/functions/#advanced-mode
249
- *
250
- * When using a _worker.js file or _worker.js/ directory, the entire /functions directory is ignored
251
- * – this includes its routing and middleware characteristics.
252
- */
253
- if (_workerJSIsDirectory) {
254
- workerBundle = await traverseAndBuildWorkerJSDirectory({
255
- workerJSDirectory: _workerPath,
256
- buildOutputDirectory: directory,
257
- d1Databases,
258
- nodejsCompat,
259
- });
260
- } else if (_workerJS) {
261
- if (bundle) {
262
- const outfile = join(tmpdir(), `./bundledWorker-${Math.random()}.mjs`);
263
- workerBundle = await buildRawWorker({
264
- workerScriptPath: _workerPath,
265
- outfile,
266
- directory,
267
- local: false,
268
- sourcemap: true,
269
- watch: false,
270
- onEnd: () => {},
271
- betaD1Shims: d1Databases,
272
- nodejsCompat,
273
- });
274
- } else {
275
- await checkRawWorker(_workerPath, () => {});
276
- // TODO: Let users configure this in the future.
277
- workerBundle = {
278
- modules: [],
279
- dependencies: {},
280
- stop: undefined,
281
- resolvedEntryPointPath: _workerPath,
282
- bundleType: "esm",
283
- };
284
- }
285
- }
286
-
287
- if (_workerJS || _workerJSIsDirectory) {
288
- const workerBundleContents = await createUploadWorkerBundleContents(
289
- workerBundle as BundleResult
290
- );
291
-
292
- formData.append(
293
- "_worker.bundle",
294
- new File([workerBundleContents], "_worker.bundle")
295
- );
296
- logger.log(`✨ Uploading Worker bundle`);
297
-
298
- if (_routesCustom) {
299
- // user provided a custom _routes.json file
300
- try {
301
- const routesCustomJSON = JSON.parse(_routesCustom);
302
- validateRoutes(routesCustomJSON, join(directory, "_routes.json"));
303
-
304
- formData.append(
305
- "_routes.json",
306
- new File([_routesCustom], "_routes.json")
307
- );
308
- logger.log(`✨ Uploading _routes.json`);
309
- } catch (err) {
310
- if (err instanceof FatalError) {
311
- throw err;
312
- }
313
- }
314
- }
315
- }
316
-
317
- /**
318
- * Pages Functions
319
- * https://developers.cloudflare.com/pages/platform/functions/
320
- */
321
- if (builtFunctions && !_workerJS && !_workerJSIsDirectory) {
322
- const workerBundleContents = await createUploadWorkerBundleContents(
323
- workerBundle as BundleResult
324
- );
325
-
326
- formData.append(
327
- "_worker.bundle",
328
- new File([workerBundleContents], "_worker.bundle")
329
- );
330
- logger.log(`✨ Uploading Functions bundle`);
331
-
332
- if (_routesCustom) {
333
- // user provided a custom _routes.json file
334
- try {
335
- const routesCustomJSON = JSON.parse(_routesCustom);
336
- validateRoutes(routesCustomJSON, join(directory, "_routes.json"));
337
-
338
- formData.append(
339
- "_routes.json",
340
- new File([_routesCustom], "_routes.json")
341
- );
342
- logger.log(`✨ Uploading _routes.json`);
343
- } catch (err) {
344
- if (err instanceof FatalError) {
345
- throw err;
346
- }
347
- }
348
- } else if (routesOutputPath) {
349
- // no custom _routes.json file found, so fallback to the generated one
350
- try {
351
- _routesGenerated = readFileSync(routesOutputPath, "utf-8");
352
-
353
- if (_routesGenerated) {
354
- formData.append(
355
- "_routes.json",
356
- new File([_routesGenerated], "_routes.json")
357
- );
358
- }
359
- } catch {}
360
- }
361
- }
362
-
363
- const deploymentResponse = await fetchResult<Deployment>(
364
- `/accounts/${accountId}/pages/projects/${projectName}/deployments`,
365
- {
366
- method: "POST",
367
- body: formData,
368
- }
369
- );
370
- return deploymentResponse;
371
- }
@@ -1,68 +0,0 @@
1
- import { Blob } from "node:buffer";
2
- import { gzipSync } from "node:zlib";
3
- import { logger } from "./logger";
4
- import type { CfModule } from "./worker";
5
- import type { Metafile } from "esbuild";
6
-
7
- const ONE_KIB_BYTES = 1024;
8
- const ONE_MIB_BYTES = ONE_KIB_BYTES * 1024;
9
-
10
- async function getSize(modules: CfModule[]) {
11
- const gzipSize = gzipSync(
12
- await new Blob(modules.map((file) => file.content)).arrayBuffer()
13
- ).byteLength;
14
- const aggregateSize = new Blob(modules.map((file) => file.content)).size;
15
-
16
- return { size: aggregateSize, gzipSize };
17
- }
18
-
19
- export async function printBundleSize(
20
- main: {
21
- name: string;
22
- content: string;
23
- },
24
- modules: CfModule[]
25
- ) {
26
- const { size, gzipSize } = await getSize([...modules, main]);
27
-
28
- const bundleReport = `${(size / ONE_KIB_BYTES).toFixed(2)} KiB / gzip: ${(
29
- gzipSize / ONE_KIB_BYTES
30
- ).toFixed(2)} KiB`;
31
-
32
- logger.log(`Total Upload: ${bundleReport}`);
33
-
34
- if (gzipSize > ONE_MIB_BYTES && !process.env.NO_SCRIPT_SIZE_WARNING) {
35
- logger.warn(
36
- "We recommend keeping your script less than 1MiB (1024 KiB) after gzip. Exceeding past this can affect cold start time"
37
- );
38
- }
39
- }
40
-
41
- export function printOffendingDependencies(
42
- dependencies: Metafile["outputs"][string]["inputs"]
43
- ) {
44
- const warning: string[] = [];
45
-
46
- const dependenciesSorted = Object.entries(dependencies);
47
- dependenciesSorted.sort(
48
- ([_adep, aData], [_bdep, bData]) =>
49
- bData.bytesInOutput - aData.bytesInOutput
50
- );
51
- const topLargest = dependenciesSorted.slice(0, 5);
52
-
53
- if (topLargest.length > 0) {
54
- warning.push(
55
- `Here are the ${topLargest.length} largest dependencies included in your script:`
56
- );
57
-
58
- for (const [dep, data] of topLargest) {
59
- warning.push(
60
- `- ${dep} - ${(data.bytesInOutput / ONE_KIB_BYTES).toFixed(2)} KiB`
61
- );
62
- }
63
-
64
- warning.push("If these are unnecessary, consider removing them");
65
-
66
- logger.warn(warning.join("\n"));
67
- }
68
- }