https://github.com/amatsuda/routes_lazy_routes

A boot time booster for Ruby on Rails that defers loading the whole bloody routes so the app can spin up quickly 🤘
https://github.com/amatsuda/routes_lazy_routes

gem rails routes ruby

Last synced: 2 days ago
JSON representation

A boot time booster for Ruby on Rails that defers loading the whole bloody routes so the app can spin up quickly 🤘

• Host: GitHub
• URL: https://github.com/amatsuda/routes_lazy_routes
• Owner: amatsuda
• License: mit
• Created: 2020-12-06T22:53:19.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-31T09:22:55.000Z (6 months ago)
• Last Synced: 2025-01-03T21:04:25.706Z (about 1 month ago)
• Topics: gem, rails, routes, ruby
• Language: Ruby
• Homepage:
• Size: 55.7 KB
• Stars: 148
• Watchers: 6
• Forks: 10
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
# routes_lazy_routes

routes_lazy_routes is an evil Rails plugin that defers loading the whole bloody routes until the server gets the first request, so the app can spin up quickly. 🤘

This voodoo gem is designed especially for you who are maintaining a huge legacy Rails app that contains hundreds of routes that forces you to wait dozens of seconds per every `rails` command invocation.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'routes_lazy_routes'

```

If you're not brave enough, you can limit the group not to include `production` environment.

Indeed, enabling this gem for the processes like batch or job may improve their runtime performance, but so far as that's not a critical problem for your production system, the following setup might be safer.

```ruby

group :development, :test do

  gem 'routes_lazy_routes'

end

```

## Usage

You have nothing to do with it. It should just work beneath the skin.

## Trade-off

The first visitor of the server should sacrifice their time for the Rails process to load the routes. First strike is deadly.

If you're bundling this in the production server, it'd be a good idea to throw a jab to the server right after the deployment in order to warm up before accepting real client requests.

## Notes

- You can manually eager_load the routes by calling `RoutesLazyRoutes.eager_load!` (the "load runner").

- `Rails.application.eager_load!` automatically invokes `RoutesLazyRoutes.eager_load!` since that should be what we expect for `Rails.application.eager_load!`.

- Loading an integration test automatically kicks `RoutesLazyRoutes.eager_load!` since AD::Integration expects the routes to be loaded.

- And, as already explained, sending a request to the Rails server automatically runs `RoutesLazyRoutes.eager_load!` on the server.

- On the other hand, you need manually calling `RoutesLazyRoutes.eager_load!` inside your worker process (e.g. Sidekiq) to resolve named routes like the following:

  ``` ruby

  # config/initializers/sidekiq.rb

  Sidekiq.configure_server do |config|

    if defined?(RoutesLazyRoutes)

      Rails.application.config.after_initialize do

        RoutesLazyRoutes.eager_load!

      end

    end

  end

  ```

## Contributing

Patches are welcome on GitHub at https://github.com/amatsuda/routes_lazy_routes.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).