Swizec Teller - a geek with a hatswizec.com

    Writing modular Backbone with Backbone.SubRoute

    Working on a complicated frontend web app, Backbone soon becomes unwieldy. Routes definitions grow and grow, views steal each other's actions and parts of the code try to become independent modules.

    This is the problem I faced a few weeks ago while working on the fanciest signup funnel I ever helped create. Visitors would see the splash page, create their cart, revise it, sign up, add billing and shipping info, and finally checkout without ever refreshing the page.

    A daunting challenge only made worse by the complexity of components involved. We needed a full-blown inventory listing, a full-blown cart editor and we even added some shiny bits to the billing and shipping forms. The funnel changes into an accordion after the first step.

    Oh and the user can refresh at any point in the funnel without losing their place.

    To divide work among the team, we took a straight-forward modular approach: a module handles the whole funnel, submodules take care of each step. This way everyone can focus on their own piece of the funnel and the javascript code can be reused when making the standalone versions of each step for signed-in users.

    The skeleton

    Backbone.SubRoute makes this approach possible by letting you create Backbone routers attached at a certain path in the URL. By doing something like var bla = new SubBla("/bla", …) you create a self-contained Backbone app that handles everything under /bla and doesn't care about the outside world.

    We didn't like how the official docs recommend going about this, so we made it automagical-er.

    A simple app_skeleton.js file holds the entire application together and loads modules when they're needed.

    var YourApp = (window.YourApp = { Routers: {} });
    YourApp.Router = Backbone.Router.extend({
    routes: {
    "": "invokeRootModule",
    ":module(/*subroute)": "invokeModule",
    },
    invokeRootModule: function () {
    this.invokeModule("root");
    },
    invokeModule: function (module, subroute) {
    module = module.toLowerCase().capitalize();
    if (!YourApp.Routers[module]) {
    YourApp.Routers[module] = new YourApp[
    module
    ].Router(module.toLowerCase() + "/", { createTrailingSlashRoutes: true });
    }
    },
    });

    We agree to register all our modules as window.YourApp.Module.Router. This lets us put every module in its own file and creates a predictable interface for creating instances of sub routers.

    That was easy, now all we need is a submodule.

    A module

    Modules work the same as standalone Backbone applications. They have views and collections and models and everything is held together by a router. You just have to conform to what app skeleton expects.

    A simple module might look like this:

    (function ($) {
    YourApp.Root = {};
    YourApp.Root.Router = Backbone.SubRoute.extend({
    routes: {
    "(:step)": "step",
    },
    initialize: function () {
    // do stuff
    },
    step: function () {
    // something for this step
    },
    });
    })(jQuery);

    Router is the only necessary part. Everything else is added to taste. We rely on the router's initialize function as the entry point into the module, so all initialization should happen in there.

    Sub sub modules

    Let's make things interesting; the module is called Root because it's going to handle submodules of its own - funnel steps in our case. Root loads them on the home page, app_skeleton loads them on standalone pages.

    For some reason dynamically instantiating submodules was not an option in this case. Not sure why, but it probably had to do with listening to events between submodules. Yes, unclean, but there's no reason to go overboard with architecture principles. Sometimes you just have to get shit done.

    Root's initialize becomes something like this:

    initialize: function () {
    this.subrouters = {};
    this.subrouters.step1 = new YourApp.Step1.Router("base/step1/");
    this.subrouters.step2 = new YourApp.Step2.Router("base/step2/");
    // ...
    this.__listenToSubrouters();
    // other stuff
    },

    Every subrouter is instantiated on initialize. If we want to change our views when particular submodules are active, we have to listen to their route events because they steal routing from their parent. For instance, we had to make sure the accordion was visible, splash step was hidden and so on.

    __listenToSubrouters: function () {
    _.keys(this.subrouters).map(_.bind(function (router) {
    this.listenTo(this.subrouters[router],
    "route",
    _.bind(function () {
    this.step(router, "",
    {dont_navigate: true});
    }, this));
    }, this));
    },

    __listenToSubrouters goes through all the instantiated routers and makes sure to call the step function when a submodule does something.

    The step function becomes something like this:

    step: function(step, subpath, options) {
    // do view stuff here
    subpath = subpath || "";
    if (this.subrouters[step] && !(options && options.dont_navigate)) {
    this.subrouters[step].navigate(subpath, {trigger: true});
    }
    }

    This makes sure to .navigate subrouters when it's appropriate and avoid doing so when the code is reacting to a subrouter's route event. I've left out the view stuff because that isn't very interesting.

    Win

    And there you go. Backbone with a modular design that keeps modules neat, encapsulated and reusable.

    To make things even smoother I also added an event that triggers only when a certain step is fully visible. This helps submodules activate/deactivate their views properly because things like jQuery Waypoints don't initialize well when elements aren't at their final positions.

    As for the super fancy signup process - you'll be able to see it when Dwellers launches. It's pretty great.

    Enhanced by Zemanta

    Did you enjoy this article?

    Published on July 31st, 2013 in JavaScript, jQuery, Modules, Programming, Router, Uncategorized, Web application,

    Learned something new?
    Read more Software Engineering Lessons from Production

    I write articles with real insight into the career and skills of a modern software engineer. "Raw and honest from the heart!" as one reader described them. Fueled by lessons learned over 20 years of building production code for side-projects, small businesses, and hyper growth startups. Both successful and not.

    Subscribe below 👇

    Software Engineering Lessons from Production

    Join Swizec's Newsletter and get insightful emails 💌 on mindsets, tactics, and technical skills for your career. Real lessons from building production software. No bullshit.

    "Man, love your simple writing! Yours is the only newsletter I open and only blog that I give a fuck to read & scroll till the end. And wow always take away lessons with me. Inspiring! And very relatable. 👌"

    ~ Ashish Kumar

    Join 15,883+ engineers learning lessons from my "raw and honest from the heart" emails.

    ⭐️⭐️⭐️⭐️✨
    4.5 stars average rating

    Have a burning question that you think I can answer? Hit me up on twitter and I'll do my best.

    Who am I and who do I help? I'm Swizec Teller and I turn coders into engineers with "Raw and honest from the heart!" writing. No bullshit. Real insights into the career and skills of a modern software engineer.

    Want to become a true senior engineer? Take ownership, have autonomy, and be a force multiplier on your team. The Senior Engineer Mindset ebook can help 👉 swizec.com/senior-mindset. These are the shifts in mindset that unlocked my career.

    Curious about Serverless and the modern backend? Check out Serverless Handbook, for frontend engineers 👉 ServerlessHandbook.dev

    Want to Stop copy pasting D3 examples and create data visualizations of your own? Learn how to build scalable dataviz React components your whole team can understand with React for Data Visualization

    Want to get my best emails on JavaScript, React, Serverless, Fullstack Web, or Indie Hacking? Check out swizec.com/collections

    Want to brush up on modern JavaScript syntax? Check out my interactive cheatsheet: es6cheatsheet.com

    Did someone amazing share this letter with you? Wonderful! You can sign up for my weekly letters for software engineers on their path to greatness, here: swizec.com/blog

    Want to brush up on your modern JavaScript syntax? Check out my interactive cheatsheet: es6cheatsheet.com

    By the way, just in case no one has told you it yet today: I love and appreciate you for who you are ❤️

    Created by Swizec with ❤️