wrangler 0.0.0-e6e1daba → 0.0.0-e6fea1318

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 (313) hide show
  1. package/README.md +33 -43
  2. package/bin/wrangler.js +15 -110
  3. package/config-schema.json +2277 -0
  4. package/package.json +182 -194
  5. package/templates/__tests__/tsconfig.json +1 -1
  6. package/templates/checked-fetch.js +11 -4
  7. package/templates/facade.d.ts +7 -2
  8. package/templates/gitignore +2 -3
  9. package/templates/init-tests/test-vitest-new-worker.js +1 -1
  10. package/templates/init-tests/test-vitest-new-worker.ts +3 -3
  11. package/templates/middleware/common.ts +9 -4
  12. package/templates/middleware/loader-modules.ts +94 -44
  13. package/templates/middleware/loader-sw.ts +6 -10
  14. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  15. package/templates/middleware/middleware-miniflare3-json-error.ts +17 -5
  16. package/templates/middleware/middleware-mock-analytics-engine.d.ts +3 -0
  17. package/templates/middleware/middleware-mock-analytics-engine.ts +30 -0
  18. package/templates/middleware/middleware-patch-console-prefix.d.ts +3 -0
  19. package/templates/middleware/middleware-patch-console-prefix.ts +21 -0
  20. package/templates/middleware/middleware-scheduled.ts +15 -1
  21. package/templates/modules-watch-stub.js +4 -0
  22. package/templates/new-worker-scheduled.ts +1 -1
  23. package/templates/new-worker.ts +1 -1
  24. package/templates/pages-dev-pipeline.ts +5 -3
  25. package/templates/pages-dev-util.ts +4 -1
  26. package/templates/pages-shim.ts +0 -3
  27. package/templates/pages-template-plugin.ts +14 -4
  28. package/templates/pages-template-worker.ts +12 -3
  29. package/templates/startDevWorker/InspectorProxyWorker.ts +679 -0
  30. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  31. package/templates/tsconfig.init.json +5 -89
  32. package/templates/tsconfig.json +9 -2
  33. package/templates/tsconfig.tsbuildinfo +1 -1
  34. package/wrangler-dist/InspectorProxyWorker.js +471 -0
  35. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  36. package/wrangler-dist/ProxyWorker.js +238 -0
  37. package/wrangler-dist/ProxyWorker.js.map +6 -0
  38. package/wrangler-dist/cli.d.ts +25408 -336
  39. package/wrangler-dist/cli.js +149395 -146782
  40. package/Cloudflare_CA.pem +0 -18
  41. package/import_meta_url.js +0 -3
  42. package/miniflare-config-stubs/.env.empty +0 -0
  43. package/miniflare-config-stubs/package.empty.json +0 -1
  44. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  45. package/miniflare-dist/index.mjs +0 -6368
  46. package/src/__tests__/access.test.ts +0 -25
  47. package/src/__tests__/api-dev.test.ts +0 -238
  48. package/src/__tests__/api-devregistry.test.js +0 -64
  49. package/src/__tests__/api.test.ts +0 -80
  50. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  51. package/src/__tests__/config-cache.test.ts +0 -42
  52. package/src/__tests__/configuration.test.ts +0 -4233
  53. package/src/__tests__/d1/d1.test.ts +0 -82
  54. package/src/__tests__/d1/execute.test.ts +0 -64
  55. package/src/__tests__/d1/migrate.test.ts +0 -155
  56. package/src/__tests__/d1/splitter.test.ts +0 -255
  57. package/src/__tests__/delete.test.ts +0 -266
  58. package/src/__tests__/deployments.test.ts +0 -129
  59. package/src/__tests__/dev.test.tsx +0 -1587
  60. package/src/__tests__/generate.test.ts +0 -238
  61. package/src/__tests__/get-host-from-url.test.ts +0 -16
  62. package/src/__tests__/guess-worker-format.test.ts +0 -120
  63. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  64. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  65. package/src/__tests__/helpers/end-event-loop.ts +0 -6
  66. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  67. package/src/__tests__/helpers/mock-auth-domain.ts +0 -20
  68. package/src/__tests__/helpers/mock-bin.ts +0 -36
  69. package/src/__tests__/helpers/mock-console.ts +0 -106
  70. package/src/__tests__/helpers/mock-dialogs.ts +0 -139
  71. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +0 -25
  72. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -11
  73. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  74. package/src/__tests__/helpers/mock-istty.ts +0 -74
  75. package/src/__tests__/helpers/mock-known-routes.ts +0 -12
  76. package/src/__tests__/helpers/mock-kv.ts +0 -46
  77. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -263
  78. package/src/__tests__/helpers/mock-process.ts +0 -34
  79. package/src/__tests__/helpers/mock-set-timeout.ts +0 -16
  80. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  81. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  82. package/src/__tests__/helpers/msw/blob-worker.cjs +0 -19
  83. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  84. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -93
  85. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -81
  86. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  87. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -60
  88. package/src/__tests__/helpers/msw/handlers/script.ts +0 -56
  89. package/src/__tests__/helpers/msw/handlers/user.ts +0 -52
  90. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -20
  91. package/src/__tests__/helpers/msw/index.ts +0 -50
  92. package/src/__tests__/helpers/msw/read-file-sync.js +0 -61
  93. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  94. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  95. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +0 -28
  96. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  97. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  98. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  99. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  100. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  101. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  102. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  103. package/src/__tests__/https-options.test.ts +0 -163
  104. package/src/__tests__/index.test.ts +0 -274
  105. package/src/__tests__/init.test.ts +0 -3164
  106. package/src/__tests__/jest.setup.ts +0 -175
  107. package/src/__tests__/kv.test.ts +0 -1799
  108. package/src/__tests__/logger.test.ts +0 -141
  109. package/src/__tests__/logout.test.ts +0 -47
  110. package/src/__tests__/metrics.test.ts +0 -493
  111. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  112. package/src/__tests__/middleware.test.ts +0 -815
  113. package/src/__tests__/mtls-certificates.test.ts +0 -585
  114. package/src/__tests__/package-manager.test.ts +0 -353
  115. package/src/__tests__/pages/deployment-list.test.ts +0 -78
  116. package/src/__tests__/pages/functions-build.test.ts +0 -402
  117. package/src/__tests__/pages/pages.test.ts +0 -81
  118. package/src/__tests__/pages/project-create.test.ts +0 -63
  119. package/src/__tests__/pages/project-list.test.ts +0 -108
  120. package/src/__tests__/pages/project-upload.test.ts +0 -481
  121. package/src/__tests__/pages/publish.test.ts +0 -2745
  122. package/src/__tests__/pages-deployment-tail.test.ts +0 -955
  123. package/src/__tests__/parse.test.ts +0 -436
  124. package/src/__tests__/paths.test.ts +0 -39
  125. package/src/__tests__/publish.test.ts +0 -8167
  126. package/src/__tests__/pubsub.test.ts +0 -493
  127. package/src/__tests__/queues.test.ts +0 -529
  128. package/src/__tests__/r2.test.ts +0 -374
  129. package/src/__tests__/route.test.ts +0 -45
  130. package/src/__tests__/secret.test.ts +0 -693
  131. package/src/__tests__/tail.test.ts +0 -958
  132. package/src/__tests__/test-old-node-version.js +0 -31
  133. package/src/__tests__/tsconfig-sanity.ts +0 -12
  134. package/src/__tests__/tsconfig.json +0 -8
  135. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  136. package/src/__tests__/type-generation.test.ts +0 -233
  137. package/src/__tests__/user.test.ts +0 -118
  138. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  139. package/src/__tests__/validate-dev-props.test.ts +0 -56
  140. package/src/__tests__/version.test.ts +0 -35
  141. package/src/__tests__/whoami.test.tsx +0 -172
  142. package/src/__tests__/worker-namespace.test.ts +0 -339
  143. package/src/abort.d.ts +0 -3
  144. package/src/api/dev.ts +0 -328
  145. package/src/api/index.ts +0 -11
  146. package/src/api/mtls-certificate.ts +0 -148
  147. package/src/api/pages/create-worker-bundle-contents.ts +0 -75
  148. package/src/api/pages/index.ts +0 -5
  149. package/src/api/pages/publish.tsx +0 -368
  150. package/src/bundle-reporter.ts +0 -68
  151. package/src/bundle.ts +0 -877
  152. package/src/cfetch/index.ts +0 -158
  153. package/src/cfetch/internal.ts +0 -258
  154. package/src/cli.ts +0 -28
  155. package/src/config/README.md +0 -107
  156. package/src/config/config.ts +0 -282
  157. package/src/config/diagnostics.ts +0 -80
  158. package/src/config/environment.ts +0 -586
  159. package/src/config/index.ts +0 -375
  160. package/src/config/validation-helpers.ts +0 -597
  161. package/src/config/validation.ts +0 -2198
  162. package/src/config-cache.ts +0 -85
  163. package/src/create-worker-preview.ts +0 -293
  164. package/src/create-worker-upload-form.ts +0 -334
  165. package/src/d1/backups.tsx +0 -215
  166. package/src/d1/constants.ts +0 -2
  167. package/src/d1/create.tsx +0 -64
  168. package/src/d1/delete.ts +0 -53
  169. package/src/d1/execute.tsx +0 -354
  170. package/src/d1/formatTimeAgo.ts +0 -14
  171. package/src/d1/index.ts +0 -100
  172. package/src/d1/list.tsx +0 -60
  173. package/src/d1/migrations/apply.tsx +0 -206
  174. package/src/d1/migrations/create.tsx +0 -76
  175. package/src/d1/migrations/helpers.ts +0 -172
  176. package/src/d1/migrations/index.ts +0 -3
  177. package/src/d1/migrations/list.tsx +0 -92
  178. package/src/d1/migrations/options.ts +0 -23
  179. package/src/d1/options.ts +0 -22
  180. package/src/d1/splitter.ts +0 -161
  181. package/src/d1/types.ts +0 -25
  182. package/src/d1/utils.ts +0 -49
  183. package/src/delete.ts +0 -100
  184. package/src/deployments.ts +0 -116
  185. package/src/deprecated/index.ts +0 -144
  186. package/src/dev/dev-vars.ts +0 -39
  187. package/src/dev/dev.tsx +0 -600
  188. package/src/dev/get-local-persistence-path.ts +0 -31
  189. package/src/dev/local.tsx +0 -922
  190. package/src/dev/remote.tsx +0 -632
  191. package/src/dev/start-server.ts +0 -538
  192. package/src/dev/use-esbuild.ts +0 -205
  193. package/src/dev/validate-dev-props.ts +0 -31
  194. package/src/dev-registry.ts +0 -201
  195. package/src/dev.tsx +0 -914
  196. package/src/dialogs.ts +0 -136
  197. package/src/dispatch-namespace.ts +0 -211
  198. package/src/docs/index.ts +0 -97
  199. package/src/durable.ts +0 -102
  200. package/src/entry.ts +0 -327
  201. package/src/environment-variables/factory.ts +0 -88
  202. package/src/environment-variables/misc-variables.ts +0 -30
  203. package/src/errors.ts +0 -11
  204. package/src/generate/index.ts +0 -298
  205. package/src/git-client.ts +0 -135
  206. package/src/global-wrangler-config-path.ts +0 -26
  207. package/src/https-options.ts +0 -127
  208. package/src/index.ts +0 -705
  209. package/src/init.ts +0 -1022
  210. package/src/inspect.ts +0 -782
  211. package/src/intl-polyfill.d.ts +0 -139
  212. package/src/is-ci.ts +0 -14
  213. package/src/is-interactive.ts +0 -16
  214. package/src/jest.d.ts +0 -4
  215. package/src/kv/helpers.ts +0 -430
  216. package/src/kv/index.ts +0 -594
  217. package/src/logger.ts +0 -104
  218. package/src/metrics/index.ts +0 -5
  219. package/src/metrics/metrics-config.ts +0 -239
  220. package/src/metrics/metrics-dispatcher.ts +0 -96
  221. package/src/metrics/metrics-usage-headers.ts +0 -24
  222. package/src/metrics/send-event.ts +0 -98
  223. package/src/miniflare-cli/README.md +0 -30
  224. package/src/miniflare-cli/assets.ts +0 -251
  225. package/src/miniflare-cli/index.ts +0 -210
  226. package/src/miniflare-cli/request-context.ts +0 -40
  227. package/src/miniflare-cli/tsconfig.json +0 -9
  228. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  229. package/src/miniflare-cli/types.ts +0 -11
  230. package/src/module-collection.ts +0 -267
  231. package/src/mtls-certificate/cli.ts +0 -155
  232. package/src/open-in-browser.ts +0 -17
  233. package/src/package-manager.ts +0 -219
  234. package/src/pages/build.ts +0 -232
  235. package/src/pages/buildFunctions.ts +0 -130
  236. package/src/pages/constants.ts +0 -18
  237. package/src/pages/deployment-tails.ts +0 -281
  238. package/src/pages/deployments.tsx +0 -86
  239. package/src/pages/dev.ts +0 -716
  240. package/src/pages/errors.ts +0 -66
  241. package/src/pages/functions/buildPlugin.ts +0 -90
  242. package/src/pages/functions/buildWorker.ts +0 -288
  243. package/src/pages/functions/filepath-routing.test.ts +0 -234
  244. package/src/pages/functions/filepath-routing.ts +0 -189
  245. package/src/pages/functions/identifiers.ts +0 -78
  246. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  247. package/src/pages/functions/routes-consolidation.ts +0 -73
  248. package/src/pages/functions/routes-transformation.test.ts +0 -282
  249. package/src/pages/functions/routes-transformation.ts +0 -115
  250. package/src/pages/functions/routes-validation.test.ts +0 -403
  251. package/src/pages/functions/routes-validation.ts +0 -202
  252. package/src/pages/functions/routes.ts +0 -151
  253. package/src/pages/functions/tsconfig.json +0 -8
  254. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  255. package/src/pages/functions.ts +0 -86
  256. package/src/pages/hash.ts +0 -13
  257. package/src/pages/index.ts +0 -102
  258. package/src/pages/projects.tsx +0 -162
  259. package/src/pages/prompt-select-project.tsx +0 -31
  260. package/src/pages/publish.tsx +0 -276
  261. package/src/pages/types.ts +0 -46
  262. package/src/pages/upload.tsx +0 -449
  263. package/src/pages/utils.ts +0 -23
  264. package/src/parse.ts +0 -308
  265. package/src/paths.ts +0 -71
  266. package/src/proxy.ts +0 -694
  267. package/src/publish/index.ts +0 -274
  268. package/src/publish/publish.ts +0 -1065
  269. package/src/pubsub/index.ts +0 -286
  270. package/src/pubsub/pubsub-commands.ts +0 -623
  271. package/src/queues/cli/commands/consumer/add.ts +0 -65
  272. package/src/queues/cli/commands/consumer/index.ts +0 -19
  273. package/src/queues/cli/commands/consumer/remove.ts +0 -31
  274. package/src/queues/cli/commands/create.ts +0 -25
  275. package/src/queues/cli/commands/delete.ts +0 -26
  276. package/src/queues/cli/commands/index.ts +0 -35
  277. package/src/queues/cli/commands/list.ts +0 -25
  278. package/src/queues/client.ts +0 -135
  279. package/src/queues/utils.ts +0 -18
  280. package/src/r2/constants.ts +0 -4
  281. package/src/r2/helpers.ts +0 -132
  282. package/src/r2/index.ts +0 -289
  283. package/src/routes.ts +0 -140
  284. package/src/secret/index.ts +0 -375
  285. package/src/selfsigned.d.ts +0 -29
  286. package/src/sites.ts +0 -372
  287. package/src/tail/createTail.ts +0 -406
  288. package/src/tail/filters.ts +0 -277
  289. package/src/tail/index.ts +0 -211
  290. package/src/tail/printing.ts +0 -122
  291. package/src/tsconfig-sanity.ts +0 -16
  292. package/src/type-generation.ts +0 -181
  293. package/src/update-check.ts +0 -19
  294. package/src/user/access.ts +0 -68
  295. package/src/user/auth-variables.ts +0 -113
  296. package/src/user/choose-account.tsx +0 -39
  297. package/src/user/generate-auth-url.ts +0 -33
  298. package/src/user/generate-random-state.ts +0 -16
  299. package/src/user/index.ts +0 -2
  300. package/src/user/user.ts +0 -1233
  301. package/src/utils/collectKeyValues.ts +0 -14
  302. package/src/whoami.ts +0 -135
  303. package/src/worker.ts +0 -257
  304. package/src/yargs-types.ts +0 -37
  305. package/src/zones.ts +0 -191
  306. package/templates/__tests__/tsconfig.tsbuildinfo +0 -1
  307. package/templates/d1-beta-facade.js +0 -241
  308. package/templates/first-party-worker-module-facade.ts +0 -19
  309. package/templates/format-dev-errors.ts +0 -34
  310. package/templates/serve-static-assets.ts +0 -66
  311. package/templates/service-bindings-module-facade.js +0 -55
  312. package/templates/service-bindings-sw-facade.js +0 -42
  313. package/wrangler-dist/wasm-sync.wasm +0 -0
@@ -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,75 +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
- wasm_modules: undefined,
53
- text_blobs: undefined,
54
- data_blobs: undefined,
55
- durable_objects: undefined,
56
- queues: undefined,
57
- r2_buckets: undefined,
58
- d1_databases: undefined,
59
- services: undefined,
60
- analytics_engine_datasets: undefined,
61
- dispatch_namespaces: undefined,
62
- mtls_certificates: undefined,
63
- logfwdr: undefined,
64
- unsafe: undefined,
65
- },
66
- migrations: undefined,
67
- compatibility_date: undefined,
68
- compatibility_flags: undefined,
69
- usage_model: undefined,
70
- keepVars: undefined,
71
- logpush: undefined,
72
- };
73
-
74
- return createWorkerUploadForm(worker);
75
- }
@@ -1,5 +0,0 @@
1
- import { publish } from "./publish";
2
-
3
- export const unstable_pages = {
4
- publish,
5
- };
@@ -1,368 +0,0 @@
1
- import { existsSync, readFileSync } from "node:fs";
2
- import { tmpdir } from "node:os";
3
- import { dirname, 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
- } from "../../pages/functions/buildWorker";
18
- import { validateRoutes } from "../../pages/functions/routes-validation";
19
- import { upload } from "../../pages/upload";
20
- import { createUploadWorkerBundleContents } from "./create-worker-bundle-contents";
21
- import type { BundleResult } from "../../bundle";
22
- import type { Project, Deployment } from "@cloudflare/types";
23
-
24
- interface PagesPublishOptions {
25
- /**
26
- * Path to static assets to publish to Pages
27
- */
28
- directory: string;
29
- /**
30
- * The Cloudflare Account ID that owns the project that's
31
- * being published
32
- */
33
- accountId: string;
34
- /**
35
- * The name of the project to be published
36
- */
37
- projectName: string;
38
- /**
39
- * Branch name to use. Defaults to production branch
40
- */
41
- branch?: string;
42
- /**
43
- * Whether or not to skip local file upload result caching
44
- */
45
- skipCaching?: boolean;
46
- /**
47
- * Commit message associated to deployment
48
- */
49
- commitMessage?: string;
50
- /**
51
- * Commit hash associated to deployment
52
- */
53
- commitHash?: string;
54
- /**
55
- * Whether or not the deployment should be considered to be
56
- * in a dirty commit state
57
- */
58
- commitDirty?: boolean;
59
- /**
60
- * Path to the project's functions directory. Default uses
61
- * the current working directory + /functions since this is
62
- * typically called in a CLI
63
- */
64
- functionsDirectory?: string;
65
-
66
- /**
67
- * Whether to run bundling on `_worker.js` before deploying.
68
- * Default: false
69
- */
70
- bundle?: boolean;
71
-
72
- /**
73
- * Whether to process non-JS module imports or not, such as
74
- * wasm/text/binary, when we run bundling on `functions` or
75
- * `_worker.js`
76
- * Default: false
77
- */
78
- experimentalWorkerBundle?: boolean;
79
-
80
- // TODO: Allow passing in the API key and plumb it through
81
- // to the API calls so that the publish function does not
82
- // rely on the `CLOUDFLARE_API_KEY` environment variable
83
- }
84
-
85
- /**
86
- * Publish a directory to an account/project.
87
- * NOTE: You will need the `CLOUDFLARE_API_KEY` environment
88
- * variable set
89
- */
90
- export async function publish({
91
- directory,
92
- accountId,
93
- projectName,
94
- branch,
95
- skipCaching,
96
- commitMessage,
97
- commitHash,
98
- commitDirty,
99
- functionsDirectory: customFunctionsDirectory,
100
- bundle,
101
- experimentalWorkerBundle,
102
- }: PagesPublishOptions) {
103
- let _headers: string | undefined,
104
- _redirects: string | undefined,
105
- _routesGenerated: string | undefined,
106
- _routesCustom: string | undefined,
107
- _workerJS: string | undefined;
108
-
109
- const workerScriptPath = resolvePath(directory, "_worker.js");
110
-
111
- try {
112
- _headers = readFileSync(join(directory, "_headers"), "utf-8");
113
- } catch {}
114
-
115
- try {
116
- _redirects = readFileSync(join(directory, "_redirects"), "utf-8");
117
- } catch {}
118
-
119
- try {
120
- /**
121
- * Developers can specify a custom _routes.json file, for projects with Pages
122
- * Functions or projects in Advanced Mode
123
- */
124
- _routesCustom = readFileSync(join(directory, "_routes.json"), "utf-8");
125
- } catch {}
126
-
127
- try {
128
- _workerJS = readFileSync(workerScriptPath, "utf-8");
129
- } catch {}
130
-
131
- // Grab the bindings from the API, we need these for shims and other such hacky inserts
132
- const project = await fetchResult<Project>(
133
- `/accounts/${accountId}/pages/projects/${projectName}`
134
- );
135
- let isProduction = true;
136
- if (branch) {
137
- isProduction = project.production_branch === branch;
138
- }
139
-
140
- /**
141
- * Evaluate if this is an Advanced Mode or Pages Functions project. If Advanced Mode, we'll
142
- * go ahead and upload `_worker.js` as is, but if Pages Functions, we need to attempt to build
143
- * Functions first and exit if it failed
144
- */
145
- let builtFunctions: string | undefined = undefined;
146
- let workerBundle: BundleResult | undefined = undefined;
147
-
148
- const functionsDirectory =
149
- customFunctionsDirectory || join(cwd(), "functions");
150
- const routesOutputPath = !existsSync(join(directory, "_routes.json"))
151
- ? join(tmpdir(), `_routes-${Math.random()}.json`)
152
- : undefined;
153
-
154
- // Routing configuration displayed in the Functions tab of a deployment in Dash
155
- let filepathRoutingConfig: string | undefined;
156
-
157
- const d1Databases = Object.keys(
158
- project.deployment_configs[isProduction ? "production" : "preview"]
159
- .d1_databases ?? {}
160
- );
161
-
162
- if (!_workerJS && existsSync(functionsDirectory)) {
163
- const outfile = join(tmpdir(), `./functionsWorker-${Math.random()}.js`);
164
- const outputConfigPath = join(
165
- tmpdir(),
166
- `functions-filepath-routing-config-${Math.random()}.json`
167
- );
168
-
169
- try {
170
- workerBundle = await buildFunctions({
171
- outfile,
172
- outputConfigPath,
173
- functionsDirectory,
174
- onEnd: () => {},
175
- buildOutputDirectory: dirname(outfile),
176
- routesOutputPath,
177
- local: false,
178
- d1Databases,
179
- experimentalWorkerBundle,
180
- });
181
-
182
- builtFunctions = readFileSync(outfile, "utf-8");
183
- filepathRoutingConfig = readFileSync(outputConfigPath, "utf-8");
184
- } catch (e) {
185
- if (e instanceof FunctionsNoRoutesError) {
186
- logger.warn(
187
- getFunctionsNoRoutesWarning(functionsDirectory, "skipping")
188
- );
189
- } else {
190
- throw e;
191
- }
192
- }
193
- }
194
-
195
- const manifest = await upload({
196
- directory,
197
- accountId,
198
- projectName,
199
- skipCaching: skipCaching ?? false,
200
- });
201
-
202
- const formData = new FormData();
203
-
204
- formData.append("manifest", JSON.stringify(manifest));
205
-
206
- if (branch) {
207
- formData.append("branch", branch);
208
- }
209
-
210
- if (commitMessage) {
211
- formData.append("commit_message", commitMessage);
212
- }
213
-
214
- if (commitHash) {
215
- formData.append("commit_hash", commitHash);
216
- }
217
-
218
- if (commitDirty !== undefined) {
219
- formData.append("commit_dirty", commitDirty);
220
- }
221
-
222
- if (_headers) {
223
- formData.append("_headers", new File([_headers], "_headers"));
224
- logger.log(`✨ Uploading _headers`);
225
- }
226
-
227
- if (_redirects) {
228
- formData.append("_redirects", new File([_redirects], "_redirects"));
229
- logger.log(`✨ Uploading _redirects`);
230
- }
231
-
232
- if (filepathRoutingConfig) {
233
- formData.append(
234
- "functions-filepath-routing-config.json",
235
- new File(
236
- [filepathRoutingConfig],
237
- "functions-filepath-routing-config.json"
238
- )
239
- );
240
- }
241
-
242
- /**
243
- * Advanced Mode
244
- * https://developers.cloudflare.com/pages/platform/functions/#advanced-mode
245
- *
246
- * When using a _worker.js file, the entire /functions directory is ignored
247
- * – this includes its routing and middleware characteristics.
248
- */
249
- if (_workerJS) {
250
- let workerFileContents = _workerJS;
251
- const enableBundling = bundle || experimentalWorkerBundle;
252
-
253
- if (enableBundling) {
254
- const outfile = join(tmpdir(), `./bundledWorker-${Math.random()}.mjs`);
255
- workerBundle = await buildRawWorker({
256
- workerScriptPath,
257
- outfile,
258
- directory: directory ?? ".",
259
- local: false,
260
- sourcemap: true,
261
- watch: false,
262
- onEnd: () => {},
263
- betaD1Shims: d1Databases,
264
- experimentalWorkerBundle,
265
- });
266
- workerFileContents = readFileSync(outfile, "utf8");
267
- } else {
268
- await checkRawWorker(workerScriptPath, () => {});
269
- }
270
-
271
- if (experimentalWorkerBundle) {
272
- const workerBundleContents = await createUploadWorkerBundleContents(
273
- workerBundle as BundleResult
274
- );
275
-
276
- formData.append(
277
- "_worker.bundle",
278
- new File([workerBundleContents], "_worker.bundle")
279
- );
280
- logger.log(`✨ Uploading Worker bundle`);
281
- } else {
282
- formData.append(
283
- "_worker.js",
284
- new File([workerFileContents], "_worker.js")
285
- );
286
- logger.log(`✨ Uploading _worker.js`);
287
- }
288
-
289
- if (_routesCustom) {
290
- // user provided a custom _routes.json file
291
- try {
292
- const routesCustomJSON = JSON.parse(_routesCustom);
293
- validateRoutes(routesCustomJSON, join(directory, "_routes.json"));
294
-
295
- formData.append(
296
- "_routes.json",
297
- new File([_routesCustom], "_routes.json")
298
- );
299
- logger.log(`✨ Uploading _routes.json`);
300
- } catch (err) {
301
- if (err instanceof FatalError) {
302
- throw err;
303
- }
304
- }
305
- }
306
- }
307
-
308
- /**
309
- * Pages Functions
310
- * https://developers.cloudflare.com/pages/platform/functions/
311
- */
312
- if (builtFunctions && !_workerJS) {
313
- if (experimentalWorkerBundle) {
314
- const workerBundleContents = await createUploadWorkerBundleContents(
315
- workerBundle as BundleResult
316
- );
317
-
318
- formData.append(
319
- "_worker.bundle",
320
- new File([workerBundleContents], "_worker.bundle")
321
- );
322
- logger.log(`✨ Uploading Functions bundle`);
323
- } else {
324
- // if Functions were build successfully, proceed to uploading the build file
325
- formData.append("_worker.js", new File([builtFunctions], "_worker.js"));
326
- logger.log(`✨ Uploading Functions`);
327
- }
328
-
329
- if (_routesCustom) {
330
- // user provided a custom _routes.json file
331
- try {
332
- const routesCustomJSON = JSON.parse(_routesCustom);
333
- validateRoutes(routesCustomJSON, join(directory, "_routes.json"));
334
-
335
- formData.append(
336
- "_routes.json",
337
- new File([_routesCustom], "_routes.json")
338
- );
339
- logger.log(`✨ Uploading _routes.json`);
340
- } catch (err) {
341
- if (err instanceof FatalError) {
342
- throw err;
343
- }
344
- }
345
- } else if (routesOutputPath) {
346
- // no custom _routes.json file found, so fallback to the generated one
347
- try {
348
- _routesGenerated = readFileSync(routesOutputPath, "utf-8");
349
-
350
- if (_routesGenerated) {
351
- formData.append(
352
- "_routes.json",
353
- new File([_routesGenerated], "_routes.json")
354
- );
355
- }
356
- } catch {}
357
- }
358
- }
359
-
360
- const deploymentResponse = await fetchResult<Deployment>(
361
- `/accounts/${accountId}/pages/projects/${projectName}/deployments`,
362
- {
363
- method: "POST",
364
- body: formData,
365
- }
366
- );
367
- return deploymentResponse;
368
- }
@@ -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
- }