Skip to content
A monkey patch to speed up Rails's json generation time
Ruby
Branch: master
Clone or download
Latest commit 1ac2ab9 Jan 4, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
benchmark
lib/rails/patch/json
test
.gitignore
Gemfile
LICENSE.txt
README.md
Rakefile
rails-patch-json-encode.gemspec

README.md

Rails::Patch::Json::Encode

This is a monkey patch for Rails in order to speed up its JSON encoding, and to draw people's attention to this Rails issue.

For full details please read Jason Hutchens' blog post.

All credits goes to Jason Hutchens for discovering the issue and providing the code for this monkey patch.

Installation

First, let's measure the time before the patch.
Go to your Rails console and type:

require 'benchmark'
DATA = Hash.new
key = 'aaa'
1000.times { DATA[key.succ!] = DATA.keys }
Benchmark.realtime { 5.times { DATA.to_json } }

Then bundle install this gem with a fast JSON encoding gem in your Rails' Gemfile.

gem 'rails-patch-json-encode'
gem 'yajl-ruby', require: 'yajl'

In this case I choose the yajl-ruby gem, but you can choose a json-encoder gem that multi_json supports.

The final step is to choose a patch. Two types of patches are available, and you have to choose one and invoke it explictly:

  • Rails::Patch::Json::Encode.patch_base_classes patches all Ruby base classes.
  • Rails::Patch::Json::Encode.patch_renderers patches Rails' ActionController::Renderers only. This is for those who had issue with the JSON gem, as patching base classes cause infinite recursive loop.

Place one of them in a Rails initializer (e.g. config/initializers/rails_patch_json_encode.rb), and Rails should now use the faster encoder.

Now it's done. Reopen your Rails console and rerun the benchmark to see the difference.

Warning

If you are using Oj gem, there is no need to install this gem. Call Oj.optimize_rails instead.

Rails in recent years added safety nets to handle nested NaN, infinity and IO objects. This gem does not handle these cases.

This gem may break your app. Test your app.

Benchmark

rake benchmark is provided to show the difference before and after the patch. From my machine the time is dropped to 14% when using yajl on Rails 5.2.

The actual performance boost on real-world applications will probably be less than that. For one of my page I see the rendering time dropped by 25%.

What's with the name

This is just a temporal monkey patch, and a monkey patch isn't supposed to have a fancy name.

Related reading

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request
You can’t perform that action at this time.