Jerod Santo

Why we chose Turbolinks is not a Rails app, but it is a Turbolinks app. Think about that for a moment.

That means we aren’t using Turbolinks because it’s Omakase. We aren’t using Turbolinks because we forgot to delete it from our Gemfile. We actively chose Turbolinks, installed it, and integrated it in to our application. I think that makes us pretty unique.

The number one question we’ve received since open sourcing the site is, “why Turbolinks?”1

Here’s why we chose it (and maybe you should too).

It comes down to one word: Courage Pragmatism

It’s easy to get swept up by the New Hotness. I’m even more prone to this than most, since we talk to creators of the New Hotness all about their New Hotness on a weekly basis. But there’s a big difference between a) keeping up with open source, and b) hitching your cart to every horse that struts by with shiny new shoes.

I find I’m most effective as a developer when I’m informed, yet cautious of trends. One trend I’ve long been skeptical of is the De Facto Single Page App. Don’t get me wrong, SPAs are a legit (and often best) architecture for many apps2. However, when an application is built as an SPA when it doesn’t need to be, bad things happen to good people.

In my experience, we’re too often wooed in to asking ourselves “why shouldn’t this application be an SPA?” instead of asking ourselves “why should this application be an SPA?” The application’s needs should drive the architecture, not the developer’s desires.

The tricky thing I was faced with when asking myself, “why should the new be an SPA?” is that we have one (important) feature that just screams, “SPA!”

A persistent audio player that stays in the footer and continues to play as you navigate pages.3

persistent audio player action shot
Click this ^ to try the player

But that's it. There is no other feature or need that we have imagined that would necessitate an SPA. Did I really want to bifurcate the codebase, increase our JS payload, and < gasp>choose a front-end framework</gasp> all so we could have a persistent audio player?

The technologist inside of me absolutely did want to. The pragmatist knew there was a simpler way.

Things have changed in Turbolinks land

When Turbolinks first shipped with Rails 4.0 back in 2012, it caused a lot of headaches for developers around the world.

Some people thought it was a bad idea altogether, but that didn’t resonate with me because GitHub was using pjax (Turbolinks’ inspiration) with much success.

Other people gave it a chance until they ran in to edge cases, frustrating bugs, and a more complex mental model than advertised. I fell in to this camp.

In other words, Turbolinks didn’t live up to its promise, so most folks wrote it off and moved on with their lives (some deriding any mention of its name). But the team behind the library continued to work at it, improving things along the way. It’s four years later now, and Turbolinks has changed quite a bit. Here’s a quick list of features and changes to get you up to speed:

  • It underwent a complete rewrite for Turbolinks 5 (see Turbolinks Classic)
  • It doesn’t require server-side request detection or alternate rendering
  • It doesn’t depend on jQuery or any other library
  • It includes a CSS-based loading progress bar
  • It can reload when assets change
  • It can persist elements across page loads
  • You can install it with npm/yarn and load it with webpack

Those last two bullet points provided exactly what we needed for our persistent player. If you haven’t looked at Turbolinks since version 5 was released, I recommend you do.

Using it with Phoenix took less time than reading its README

I falsely presumed that using Turbolinks outside of Rails would be tough. Here’s what it took:

  1. Add Turbolinks to a dependency in our package.json
  2. Import Turbolinks at the top of app.js
  3. Call Turbolinks.start(); at the bottom of app.js
  4. Add data-turbolinks-permanent to the player div

With that, I was done and it Just Worked. That being said, Turbolinks isn’t completely gotcha free. There are a few things to keep in mind when writing your application’s JavaScript. Make sure to read and understand the Building Your Turbolinks Application section of the README and you should be just fine.

As a wise senior developer once said: It Depends

I know, I know. Balanced reasoning about which tools and practices we should use doesn’t make for popular writing, but it does make for good systems. I’m not here to hand wave and proclaim that you should ditch your current thing and use Turbolinks.

There are many reasons why our application is different than yours, some of which makes us a good fit for this solution. I’ll list a few so you don’t have to email us in anger:

  • Ultimately, we’re a content-first site. Very few content sites require rich enough interactions to necessitate an SPA.
  • We don’t have much JavaScript and very few (public facing) form submissions, so we haven’t hit some of the more complex scenarios where Turbolinks may fall down.
  • As our needs grow, we may come to a point where we need client-side routing. I doubt that highly, but it’s a possibility.

In the end, we accomplished our goal with minimal engineering effort and launched our site to much acclaim. People love our persistent player and I love Turbolinks for helping us pull it off with such aplomb. If you’ve written Turbolinks off, now might be a good time to give it a second chance.

More to come

We have a lot more to say about our new software stack.

Coming soon: my experience working with Phoenix

Subscribe to Changelog Weekly, follow @Changelog (and me) on Twitter, and/or grab the RSS feed (the fire hose | posts only) to keep up. 💚

  1. The #2 question is, "How is it so fast?"  Turbolinks helps with that, but it's mostly Elixir's fault.

  2. My first SPA was in 2010 when I helped Grooveshark (RIP) switch from Flash to a web app.

  3. Click the example image embedded in this post to see the player in action.


Sign in or Join to comment or subscribe

Player art
  0:00 / 0:00