{"id":2200,"date":"2024-05-15T17:26:46","date_gmt":"2024-05-15T23:26:46","guid":{"rendered":"https:\/\/frontendmasters.com\/blog\/?p=2200"},"modified":"2024-05-21T16:17:28","modified_gmt":"2024-05-21T22:17:28","slug":"prefetching-when-server-loading-wont-do","status":"publish","type":"post","link":"https:\/\/frontendmasters.com\/blog\/prefetching-when-server-loading-wont-do\/","title":{"rendered":"Prefetching When Server Loading Won’t Do"},"content":{"rendered":"\n

This is a post about a boring* topic: loading data.<\/p>\n\n\n\n

(* Just kidding it will be amazing and engaging.)<\/small><\/p>\n\n\n\n

Not how<\/em> to load data, but instead we’ll take a step back, and look at where<\/em> to load data. Not in any particular framework, either, this is going to be more broadly about data loading in different web application architectures, and paricularly how that impacts performance.<\/p>\n\n\n\n

We’ll start with client-rendered sites and talk about some of the negative performance characteristics they may have. Then we’ll move on to server-rendered apps, and then to the lesser-known out-of-order streaming model. To wrap up, we’ll talk about a surprisingly old, rarely talked about way to effectively load slow<\/em> data in a server-rendered application. Let’s get started!<\/p>\n\n\n\n

Client Rendering<\/h2>\n\n\n\n

Application metaframeworks like Next<\/a> and SvelteKit<\/a> have become incredibly popular. In addition to offering developer conveniences like file system-based routing and scaffolding of API endoints, they also, more importantly, allow you to server render your application.<\/p>\n\n\n\n

Why is server rendering so important? Let’s take a look at how the world looks with the opposite: client-rendered web applications, commonly referred to as “single page applications” or SPAs. Let’s start with a simplified diagram of what a typical request for a page looks like in an SPA.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

The browser makes a request to your site. Let’s call it yoursite.io<\/code>. With an SPA, it usually sends down a single, mostly empty<\/em> HTML page, which has whatever script and style tags needed to run the site. This shell<\/em> of a page might display your company logo, your static header, your copyright message in the footer, etc. But mostly it exists to load and run JavaScript, which will build the “real” site.<\/p>\n\n\n\n

This is why these sites are called “single page” applications. There’s a single web page for the whole app, which runs code on the client to detect URL changes, and request and render whatever new UI is needed.<\/p>\n\n\n\n

Back to our diagram. The inital web page was sent back from the web server as HTML. Now what? The browser will parse that HTML and find script tags. These script tags contain our application code, our JavaScript framework, etc. The browser will send requests back to the web server to load these<\/em> scripts. Once the browser gets them back, it’ll parse, and execute them, and in so doing, begin executing your application code.<\/p>\n\n\n\n

At this point whatever client-side router you’re using (i.e. react-router<\/a>, Tanstack Router<\/a>, etc) will render your current page.<\/p>\n\n\n\n

But there’s no data yet!<\/p>\n\n\n\n

So you’re probably displaying loading spinners or skeleton screens or the like. To get the data, your client-side code will now<\/em> make yet another<\/em> request to your server to fetch whatever data are needed, so you can display your real, finished page to your user. This could be via a plain old fetch<\/code>, react-query<\/a>, or whatever. Those details won’t concern us here.<\/p>\n\n\n\n

SSR To The Rescue<\/h2>\n\n\n\n

There is a pretty clear solution here. The server already has<\/em> has the URL of the request, so instead of only returning that shell page, it could (should) request the data as well, get the page all ready to go, and send down the complete page.<\/p>\n\n\n\n

Somehow.<\/p>\n\n\n\n

This is how the web always worked with tools like PHP or asp.net. But when your app is written with a client-side JavaScript framework like React or Svelte, it’s surprisingly tricky. These frameworks all have API’s for stringifying a component tree into HTML on the server, so that markup can be sent down to the browser. But if a component in the middle of that component tree needs data, how do you load it on the server, and then somehow inject it where it’s needed? And then have the client acknowledge that data, and not re-request it. And of course, once you solve these problems and render your component tree, with data, on the server, you still<\/em> need to re-render<\/em> this component tree on the client, so your client-side code, like event handlers and such, start working.<\/p>\n\n\n\n

This act of re-rendering the app client side is called hydration<\/em>. Once it’s happened, we say that our app is interactive<\/em>. Getting these things right is one of the main benefits modern application meta-frameworks like Next and SvelteKit provide.<\/p>\n\n\n\n

Let’s take a look at what our request looks like in this server-rendered setup:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

That’s great<\/em>. The user sees the full page much, much sooner. Sure, it’s not interactive<\/em> yet, but if you’re not shipping down obscene amounts of JavaScript, there’s a really<\/em> good chance hydration will finish before the user can manage to click on any buttons.<\/p>\n\n\n\n

We won’t get into all this, but Google themselves tell you this is much better for SEO as well.<\/p>\n\n\n\n

So, what’s the catch? Well, what if our data are slow to load<\/strong>. Maybe our database is busy. Maybe it’s a huge request. Maybe there is a network hiccup. Or maybe you just depend on slow services you can’t control. It’s not rare.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

This might be worse<\/em> than the SPA we started with. Even though we needed multiple round trips to the server to get data, at least we were displaying a shell of a page quickly. Here, the initial request to the server will just hang and wait as long as needed for that data to load on the server, before sending down the full page. To the user, their browser (and your page) could appear unresponsive, and they might just give up and go back.<\/p>\n\n\n\n

Out of Order Streaming<\/h2>\n\n\n\n

What if we could have the best of all worlds. What if we could server render, like we saw. But<\/em> if some data are slow to load, we ship the rest of the page, with the data that we have, and let the server push<\/em> down the remaining data, when ready. This is called streaming, or more precisely, out-of-order streaming (streaming, without the out-of-order part, is a separate, much more limited thing which we won’t cover here).<\/p>\n\n\n\n

Let’s take a hypothetical example where the\u00a0data abd<\/code>, and\u00a0data xyz<\/code>\u00a0are slow to load.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

With out-of-order streaming we can load the to-do data load on the server, and send the page with just that data down to the user, immediately. The other two pieces of data have not loaded, yet, so our UI will display some manner of loading indicator. When the next piece of data is ready, the server pushes it down:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

What’s the catch?<\/h3>\n\n\n\n

So does this solve all of our problems? Yes, but… only if the framework you’re using supports it. To stream with Next.js app directory<\/a> you’ll use Suspense components with RSC<\/a>. With SvelteKit<\/a> you just return a promise from your loader. Remix supports this too<\/a>, with an API that’s in the process of changing, so check their docs. SolidStart<\/a> will also support this, but as of writing that entire project is still in beta, so check its docs when it comes out.<\/p>\n\n\n\n

Some frameworks do not support this, like Astro<\/a> and Next if you’re using the legacy pages<\/code> directory.<\/p>\n\n\n\n

What if we’re using those projects, and we have some dependencies on data which are slow to load? Are we stuck rendering this data in client code, after hydration?<\/p>\n\n\n\n

Prefetching to the rescue<\/h2>\n\n\n\n

The web platform has a feature called prefetching<\/a>. This lets us add a <link><\/code> tag to the <head><\/code> section of our HTML page, with a rel=\"prefetch\"<\/code> attribute, and an href<\/code> attribute of the URL we want to prefetch. We can put service endpoint calls here, so long as they use the GET verb. If we need to pre-fetch data from an endpoint that uses POST, you’ll need to proxy it through an endpoint that uses GET. It’s worth noting that you can also prefetch with an HTTP header if that’s more convenient; see this post<\/a> for more information.<\/p>\n\n\n\n

When we do this, our page will start pre-fetching our resources as soon as the browser parses the link tag. Since it’s in the <head><\/code>, that means it’ll start pre-fetching at the same time our scripts and stylesheets are requested. So we no longer need to wait until our script tags load, parse, and hydrate our app. Now the data we need will start pre-fetching immediately. When hydration does complete, and our application code requests those same endpoints, the browser will be smart enough to serve that data from the prefetch cache<\/em>.<\/p>\n\n\n\n

Let’s see prefetching in action<\/h3>\n\n\n\n

To see pre-fetching in action, we’ll use Astro<\/a>. Astro is a wonderful web framework that doesn’t get nearly enough attention. One of the very few things it can’t do is out-of-order streaming (for now). But let’s see how we can improve life with pre-fetching.<\/p>\n\n\n\n

The repo for the code I’ll be showing is here<\/a>. It’s not deployed anywhere, for fear of this blog posting getting popular, and me getting a big bill from Vercel. But the project has no external dependencies, so you can clone, install, and run locally. You could also deploy this to Vercel yourself if you really want to see it in action.<\/p>\n\n\n\n

I whipped up a very basic, very ugly web page that hits some endpoints to pull down a hypothetical list of books, and some metadata about the library, which renders the books once ready. It looks like this:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

The endpoints return static data, which is why there’s no external dependencies. I added a manual delay of 700ms to these endpoints (sometimes you have slow services and there’s nothing you can do about it), and I also installed and imported some large JavaScript libraries (d3, framer-motion, and recharts) to make sure hydration would take a moment or two, like with most production applications. And since these endpoints are slow, they’re a poor candidate for server fetching.<\/p>\n\n\n\n

So let’s request them client-side, see the performance of the page, and then add pre-fetching to see how that improves things.<\/p>\n\n\n\n

The client-side fetching looks like this:<\/p>\n\n\n

useEffect(()<\/span> =><\/span> {\n  fetch(\"\/api\/books\"<\/span>)\n    .then((resp<\/span>) =><\/span> resp.json())\n    .then((books<\/span>) =><\/span> {\n      setBooks(books);\n    });\n\n  fetch(\"\/api\/books-count\"<\/span>)\n    .then((resp<\/span>) =><\/span> resp.json())\n    .then((booksCountResp<\/span>) =><\/span> {\n      setCount(booksCountResp.count);\n    });\n}, []);\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Nothing fancy. Nothing particularly resilient here. Not even any error handling. But perfect for our purposes.<\/p>\n\n\n\n
Network diagram without pre-fetching<\/h3>\n\n\n\n
Running this project, deployed to Vercel, my network diagram looks like this:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Notice all of the script and style resources, which need to be requested and processed before our client-side fetches start (on the last two lines).<\/p>\n\n\n\n
Adding pre-fetching<\/h3>\n\n\n\n
I’ve added a second page to this project, called with-prefetch<\/code>, which is the same as the index page. Except now, let’s see how we can add some <link><\/code> tags to request these resources sooner.<\/p>\n\n\n\n
First, in the root layout, let’s add this in the head section<\/p>\n\n\n
<slot<\/span> name<\/span>=\"head\"<\/span>><\/span><\/slot<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
this gives us the ability to (but does not require us to) add content to our HTML document’s <head><\/code>. This is exactly what we need. Now we can make a PrefetchBooks<\/code> React component:<\/p>\n\n\n
import<\/span> type { FC } from<\/span> \"react\"<\/span>;\n\nexport<\/span> const<\/span> PrefetchBooks: FC<{}> = (props<\/span>) =><\/span> {\n  return<\/span> (\n    <><\/span>\n      <link<\/span> rel<\/span>=\"prefetch\"<\/span> href<\/span>=\"\/api\/books\"<\/span> as<\/span>=\"fetch\"<\/span> \/><\/span>\n      <link<\/span> rel<\/span>=\"prefetch\"<\/span> href<\/span>=\"\/api\/books-count\"<\/span> as<\/span>=\"fetch\"<\/span> \/><\/span>\n    <\/><\/span><\/span>\n  );\n};<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Then render it in our prefetching page, like so<\/p>\n\n\n
<PrefetchBooks slot=\"head\"<\/span> \/><\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Note the slot<\/code> attribute on the React component, which tells Astro (not React) where to put this content.<\/p>\n\n\n\n
With that, if we run that<\/em> page, we’ll see our link tags in the head<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Now let’s look at our updated network diagram:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Notice our endpoint calls now start immediately, on lines 3 and 4. Then later, in the last two lines, we see the real fetches being executed, at which point they just latch onto the prefetch calls already in flight.<\/p>\n\n\n\n
Let’s put some hard numbers on this. When I ran a webpagetest mobile Lighthouse analysis on the version of this page without the pre-fetch, I got the following.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Note the LCP (Largest Contentful Paint) value. That’s essentially telling us when the page looks finished to a user. Remember, the Lighthouse test simulates your site in the slowest mobile device imagineable, which is why it’s 4.6 seconds.<\/p>\n\n\n\n
When I re-run the same test on the pre-fetched version, things improved about a second<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Definitely much better, but still not good<\/em>; but it never will be until you can get your backend fast. But with some intelligent, targetted pre-fetching, you can at least improve things.<\/p>\n\n\n\n
Parting thoughts<\/h2>\n\n\n\n
Hopefully all of your back-end data requirements will be forever fast in your developer journeys. But when they’re not, prefetching resources is a useful tool to keep in your toolbelt.<\/p>\n","protected":false},"excerpt":{"rendered":"
Let’s get into the challenges and strategies of loading data in web applications, focusing on the comparison between client-rendered sites and server-rendered applications. There are some clear negative performance impacts of SPAs and server-rendered apps are *usually* better here, except when data is slow. Then what?<\/p>\n","protected":false},"author":21,"featured_media":2217,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"sig_custom_text":"","sig_image_type":"featured-image","sig_custom_image":0,"sig_is_disabled":false,"inline_featured_image":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[1],"tags":[174,109,127,162],"class_list":["post-2200","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-blog-post","tag-data","tag-next-js","tag-streaming-html","tag-sveltekit"],"acf":[],"jetpack_featured_media_url":"https:\/\/i0.wp.com\/frontendmasters.com\/blog\/wp-content\/uploads\/2024\/05\/image-3.png?fit=1792%2C1024&ssl=1","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/frontendmasters.com\/blog\/wp-json\/wp\/v2\/posts\/2200","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/frontendmasters.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/frontendmasters.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/frontendmasters.com\/blog\/wp-json\/wp\/v2\/users\/21"}],"replies":[{"embeddable":true,"href":"https:\/\/frontendmasters.com\/blog\/wp-json\/wp\/v2\/comments?post=2200"}],"version-history":[{"count":7,"href":"https:\/\/frontendmasters.com\/blog\/wp-json\/wp\/v2\/posts\/2200\/revisions"}],"predecessor-version":[{"id":2336,"href":"https:\/\/frontendmasters.com\/blog\/wp-json\/wp\/v2\/posts\/2200\/revisions\/2336"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/frontendmasters.com\/blog\/wp-json\/wp\/v2\/media\/2217"}],"wp:attachment":[{"href":"https:\/\/frontendmasters.com\/blog\/wp-json\/wp\/v2\/media?parent=2200"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/frontendmasters.com\/blog\/wp-json\/wp\/v2\/categories?post=2200"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/frontendmasters.com\/blog\/wp-json\/wp\/v2\/tags?post=2200"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}