Swizec Teller - a geek with a hatswizec.com

    Bring Ruby VCR to Javascript testing with Capybara and puffing-billy

    Let's say you are writing an application in Ruby. You are probably talking to every API under the sun and are happily writing tests to make sure your code isn't failing.

    Because you don't want to rely on 3rd parties or an internet connection to make your tests pass or fail you mock everything with let's say, Webmock. This also makes your tests much much faster. After all even the fastest internet is much slower than the processor talking to its memory.

    If you're too lazy to mock out every API under the sun, you might use VCR to record requests and play them back later. The main advantage being, you don't have to worry about meticulously reimplementing _everything, _and you can nuke the recordings at any time to make sure your code still works against the real API.

    Life is good.

    Enter Javascript, stage left

    Then Javascript becomes more and more prominent. Suddenly your application's logic is shifting from backend to browser and before you know it, most of your tests are pretty irrelevant.

    You're fine for a while with Capybara or Cucumber.

    Launch a headless browser, click around the site from the comfort of RSpec, make sure users see what they're supposed to. Balance restored.

    Then you add a payment form. Or something. Suddenly your frontend is talking to an API. In case of Stripe or Balanced it's even a feature. A great benefit for the user.

    jQuery(function ($) {
    $("#payment-form").submit(function (event) {
    var $form = $(this);
    // Disable the submit button to prevent repeated clicks
    $form.find("button").prop("disabled", true);
    Stripe.createToken($form, stripeResponseHandler);
    // Prevent the form from submitting with the default action
    return false;

    Well that sucks, you're suddenly back to square one.

    Your tests take minutes to execute. Your tests fail without an internet connection. Your tests rely on some 3rd party service being up. Your tests suck.

    Who wants to code when running ~5 tests takes 3 minutes? Nobody.

    Enter puffing-billy, stage right

    The problem is that neither Webmock nor VCR can handle requests originating in a browser because they happen in a different thread and they can't mess around with those.

    Luckily, a year ago Olly Smith, created puffing-billy.

    The idea was great - spin up a web proxy, tell your headless browser to use it, when your code makes a request it will go through the proxy, which will try to use a Webmock to handle it, otherwise pass it on to the vast internet.

    But who wants to mock everything out manually?

    Over the past few weeks I set upon the task of fixing this problem and restoring sanity to my life. Good tests are transparent to the application and I'll be damned if I use any of the suggested solutions on the internet like "Well you just put a switch in your code that knows if you're in a test and then doesn't talk to Stripe"

    Screw that.

    This morning I submitted a pull request to puffing-billy.

    I added the ability for puffing-billy to behave like it was VCR, but for your browser. When a request is made, it gets cached. The cache is then persisted between sessions, and requests are played back to the browser as needed.

    It's not as sophisticated as VCR just yet, but it gets the job done and my test runtime has gone from 3 minutes to just under a minute. That's a big deal in my book!

    The caching even understands that some URL's are needlessly different on every request (social buttons, analytics etc.) so you can configure it to normalize those requests to a single recording that is played back every time. Your tests don't really rely on gAnalytics working right?

    And the best thing is, you don't even have to change your tests.

    You add something like this in your spec_helper.rb:

    Billy.configure do |c|
    c.cache = true
    c.ignore_params = ["http://www.google-analytics.com/__utm.gif",
    c.persist_cache = true
    c.cache_path = 'spec/req_cache/'
    # need to call this because of a race condition between persist_cache
    # being set and the proxy being loaded for the first time
    Capybara.javascript_driver = :poltergeist_billy

    A test for the payment form looks the same as usual:

    scenario "physical product" do
    product = start_buying build(:product, :physical, user: @seller, active: true)
    VCR.use_cassette('Balanced/purchase_with_cc') do
    within '#new_order' do
    fill_in 'order_email', with: Faker::Internet.safe_email
    click_on 'Buy Now'
    page.should have_css('#receipt', :visible => true)
    validate_receipt product, @seller

    Puffing-billy will transparently cache every requests the browser makes and VCR records any requests made by your backend logic. It's pretty sweet.

    What do you guys think? I only have 20 days of Ruby experience and the internet has told me it really wants something like this, but I couldn't find anyone who's already made it.

    Enhanced by Zemanta

    Did you enjoy this article?

    Published on March 14th, 2013 in JavaScript, RSpec, Ruby, testing, Uncategorized

    Learned something new?
    Want to become an expert?

    Here's how it works 👇

    Leave your email and I'll send you thoughtfully written emails every week about React, JavaScript, and your career. Lessons learned over 20 years in the industry working with companies ranging from tiny startups to Fortune5 behemoths.

    Join Swizec's Newsletter

    And get thoughtful letters 💌 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 over 14,000 engineers just like you already improving their careers with my letters, workshops, courses, and talks. ✌️

    Have a burning question that you think I can answer? I don't have all of the answers, but I have some! Hit me up on twitter or book a 30min ama for in-depth help.

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

    Curious about Serverless and the modern backend? Check out Serverless Handbook, modern backend for the frontend engineer.

    Ready to learn how it all fits together and build a modern webapp from scratch? Learn how to launch a webapp and make your first 💰 on the side with ServerlessReact.Dev

    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 bySwizecwith ❤️