feat: Cloudflare Pages _routes.json specification (#6441) #6530

jrf0110 · 2022-09-02T13:39:03Z

Closes #6441

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
This message body should clearly illustrate what problems it solves.
Ideally, include a test that fails without this PR but passes with it.

Tests

Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. All changesets should be patch until SvelteKit 1.0

changeset-bot · 2022-09-02T13:39:07Z

🦋 Changeset detected

Latest commit: 9cc96c3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@sveltejs/adapter-cloudflare	Patch
@sveltejs/kit	Patch
@sveltejs/adapter-auto	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

netlify · 2022-09-02T13:39:11Z

✅ Deploy Preview for kit-demo ready!

Name	Link
🔨 Latest commit	`c25d8e8`
🔍 Latest deploy log	https://app.netlify.com/sites/kit-demo/deploys/63121e05b58e7200095b7810
😎 Deploy Preview	https://deploy-preview-6530--kit-demo.netlify.app/build
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

jahands

Jacob from the Cloudflare Pages team here - I'm also working on this project.

LGTM

Rich-Harris

thank you! comments/questions inline

Rich-Harris · 2022-09-03T00:22:45Z

packages/adapter-cloudflare/index.js

+			builder.log.info(
+				`adapter-cloudfare is writing its own _headers file. If you have your own, you should duplicate the headers contained in: ${dest}/_headers`


can we automate this, and copy the contents of ${builder.config.kit.files.assets}/_headers into ${dest}/_headers if it exists?

We could, but I think that ought to be out-of-scope of this PR. We could optimistically concatenate the auto-generated headers to an existing ${dest}/_headers file. However, I expect most users are running their build process and then copying their src/_headers to ${dest}/_headers after the build completes. We still need to think about the best way to approach this scenario

Rich-Harris · 2022-09-03T00:27:09Z

packages/adapter-cloudflare/index.js

+				// We're being conservative by not excluding all assets in
+				// /static just yet. If there are any upstream auth rules to
+				// protect certain things (e.g. a PDF that requires auth),
+				// then we wouldn't want to prevent those requests from going
+				// to the user functions worker.
+				// We do want to show an example of a _routes.json that
+				// excludes more than just /_app/immutable/*, and favicons
+				// are a reasonable choice
+				.filter(({ file }) => file.includes('favicon'))
+				.map((asset) => asset.file)


Can you elaborate on 'upstream auth rules'? Where would those be expressed? All static files are considered to be outside SvelteKit's purview (unless we added some platform-agnostic 'middleware' concept in future), so it feels like we could just list all static assets here

Where would those be expressed?

This would be the case of a Cloudflare Pages user adding logic to a catch-all functions route (e.g. functions/_middleware.ts or functions/[[path.ts]] or simply having a _worker.js file). They might be adding headers to static assets with their functions or protecting a certain files to only be accessible by emails ending in @example.com. Either way, we don't want to be too prescriptive on whether or not functions runs before the asset or not.

Do note that omitting a file from excludes will never accidentally break a user's function. The reverse is not true; A misplaced exclusion rule could prevent a function from being run that the user intended to be run. For that reason, we're intentionally being conservative on which assets are explicitly being excluded.

Further, there is a size limit for these descriptions. We're maxing out the total number of rules - include or exclude - to 100. I'm sure plenty of sites would max out that rule limit with just excludes of static paths

Rich-Harris · 2022-09-03T00:29:45Z

packages/kit/src/core/adapt/builder.js

+		getBuildData() {
+			return build_data;
+		},


I think we can do everything we want in this PR without introducing new API surface area. writeClient(dest) returns an array of all the written files, so we could use that in place of build_data.manifest_data.assets, and app_dir can be accessed as builder.config.kit.appDir.

BuildData isn't a public type and it would be better to keep it that way, otherwise it becomes part of the contract and is thus subject to semver

Roger that. I'll remove

jrf0110 · 2022-09-08T21:38:31Z

packages/adapter-cloudflare/index.js


-			builder.writeClient(dest);
+			const written_files = builder.writeClient(dest);
+			console.log('written_files', written_files);


Oops. Remove

When a SvelteKit project is deployed to Cloudflare Pages, the server-side code is supported through Pages Functions (currently in beta). Unfortunately, by using Functions, each request must go through the server-side Functions code even if it doesn't need to. For instance, an immutable asset request to https://kit.svelte.dev/_app/immutable/assets/_layout-ab34ca4f.css would first have to route through Functions. This is problematic since the request would "count" as a request to Functions even though only a static asset was served. Further, there is a slight amount of added latency. This change exposes a set of includes and excludes based on static files generated.

jrf0110 · 2022-09-16T14:49:15Z

Hey @Rich-Harris aside from the the automerging _headers file thing, I've addressed your feedback. Mind taking another gander?

Rich-Harris · 2022-09-21T20:24:25Z

thank you!

vercel bot deployed to Preview – kit September 2, 2022 13:39 View deployment

jrf0110 force-pushed the pages-routing branch from 90bfdda to 6bf908f Compare September 2, 2022 14:02

vercel bot deployed to Preview – kit September 2, 2022 14:03 View deployment

jahands approved these changes Sep 2, 2022

View reviewed changes

jrf0110 force-pushed the pages-routing branch from 6bf908f to c25d8e8 Compare September 2, 2022 15:15

vercel bot deployed to Preview – kit September 2, 2022 15:15 View deployment

Rich-Harris requested changes Sep 3, 2022

View reviewed changes

jrf0110 force-pushed the pages-routing branch from c25d8e8 to bde732e Compare September 8, 2022 20:53

vercel bot deployed to Preview – kit September 8, 2022 20:53 View deployment

jrf0110 requested a review from Rich-Harris September 8, 2022 21:37

jrf0110 commented Sep 8, 2022

View reviewed changes

jrf0110 force-pushed the pages-routing branch from bde732e to 36638b3 Compare September 8, 2022 21:38

vercel bot deployed to Preview – kit September 8, 2022 21:39 View deployment

vercel bot deployed to Preview – kit-svelte-dev September 14, 2022 00:00 View deployment

Rich-Harris added 3 commits September 21, 2022 15:33

use writeFileSync over writeFile, for consistency with rest of codebase

4d9420a

code style stuff

cc179bc

tweak changeset

9cc96c3

vercel bot deployed to Preview – kit September 21, 2022 19:37 View deployment

vercel bot deployed to Preview – kit-svelte-dev September 21, 2022 19:40 View deployment

Rich-Harris approved these changes Sep 21, 2022

View reviewed changes

Rich-Harris merged commit ae8225d into sveltejs:master Sep 21, 2022

This was referenced Sep 21, 2022

Version Packages (next) #6946

Merged

Version Packages (next) #6948

Merged

Rich-Harris mentioned this pull request Sep 21, 2022

Ensure all excluded files in _routes.json start with / #6952

Merged

5 tasks

chientrm mentioned this pull request Sep 22, 2022

fix: #6458 add timestamp to force revalidating data #6880

Closed

5 tasks

benmccann mentioned this pull request Sep 28, 2022

[docs] "What's new in Svelte" October newsletter sveltejs/svelte#7898

Merged

benmccann mentioned this pull request Nov 9, 2022

adapter-cloudflare: serve prerendered pages and static assets using _routes.json #7298

Closed

Rich-Harris mentioned this pull request Jan 6, 2023

split option in cloudflare-adapter #8249

Closed

		builder.log.info(
		`adapter-cloudfare is writing its own _headers file. If you have your own, you should duplicate the headers contained in: ${dest}/_headers`

Uh oh!

feat: Cloudflare Pages _routes.json specification (#6441) #6530

feat: Cloudflare Pages _routes.json specification (#6441) #6530

Uh oh!

Conversation

jrf0110 commented Sep 2, 2022

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

Tests

Changesets

Uh oh!

changeset-bot bot commented Sep 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

netlify bot commented Sep 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for kit-demo ready!

Uh oh!

jahands left a comment

Choose a reason for hiding this comment

Uh oh!

Rich-Harris left a comment

Choose a reason for hiding this comment

Uh oh!

Rich-Harris Sep 3, 2022

Choose a reason for hiding this comment

Uh oh!

jrf0110 Sep 8, 2022

Choose a reason for hiding this comment

Uh oh!

Rich-Harris Sep 3, 2022

Choose a reason for hiding this comment

Uh oh!

jrf0110 Sep 8, 2022

Choose a reason for hiding this comment

Uh oh!

Rich-Harris Sep 3, 2022

Choose a reason for hiding this comment

Uh oh!

jrf0110 Sep 6, 2022

Choose a reason for hiding this comment

Uh oh!

jrf0110 Sep 8, 2022

Choose a reason for hiding this comment

Uh oh!

jrf0110 commented Sep 16, 2022

Uh oh!

Rich-Harris commented Sep 21, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

changeset-bot bot commented Sep 2, 2022 •

edited

Loading

netlify bot commented Sep 2, 2022 •

edited

Loading