routes_lazy_routes 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 776e64fd7ac17ff3e62acfb3cafd7e908ed32de16d798ecda0f9e494abdca344
-  data.tar.gz: 5c8811a1b1411849d27e2988f9a4d12db36a9fbbfd5c6676d383903678c85f44
+  metadata.gz: a8065fe0f170a4c5d2e2c2f9373ca5c3720769a077ed97ae13551968109d5169
+  data.tar.gz: 78b733748df2a374f040e638eb3e4dd49992c34dfe90571a3b22e27a210472c8
 SHA512:
-  metadata.gz: 444b44d3d13ba5eff7a1c1b2960eba368295223506e460b48156eb7a5046e94a208adefabc855d48f560de5cef5151b0ea6d58fa027378b3ba9096a6bcaf5c12
-  data.tar.gz: a3ae5366ea23776ac6aeabfcaf7b3116adfb47aa7c7ec2becf97a22b62ed856001fee1d2d2d1d8dcb591f584b4aa6553d641da1ecd7f0fdb5887dd27d4bccf9b
+  metadata.gz: 846e473fd9665a503acc56c83075952b759aa24f88711e057594b03854a56b1443f88553f3ed3323e25e1a6fd12282cc87eed768c5090cfec72400ad8699a92d
+  data.tar.gz: 8da7e3f095411d40337f3d3da1aae0e4350e2e1da3c83639b7371382104ed34225960cf595a07ce0096e7c8624e1cf1dc89fa887b29c86cb824e91366dbc4d0b

data/.github/workflows/main.yml

@@ -4,15 +4,30 @@ on: [push,pull_request]
 
 jobs:
   build:
+    strategy:
+      matrix:
+        include:
+          - ruby-version: 2.7.2
+            rails-version: '~> 5.2.4'
+          - ruby-version: 2.7.2
+            rails-version: '~> 6.0.3'
+          - ruby-version: 2.7.2
+            rails-version: '~> 6.1.0'
+          - ruby-version: 3.0.0
+            rails-version: '~> 6.0.3'
+          - ruby-version: 3.0.0
+            rails-version: '~> 6.1.0'
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.0
+        ruby-version: ${{ matrix.ruby-version }}
     - name: Run the default task
       run: |
         gem install bundler -v 2.2.0.rc.2
         bundle install
         bundle exec rake
+      env:
+        RAILS_VERSION: ${{ matrix.rails-version }}

data/Gemfile

@@ -5,6 +5,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in routes_lazy_routes.gemspec
 gemspec
 
+gem "rails", ENV["RAILS_VERSION"] if ENV["RAILS_VERSION"]
+
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"

data/README.md

@@ -2,7 +2,7 @@
 
 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 Rails app that contains hundreds of routes that forces to wait dozens of seconds per every `rails` command invocation.
+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
@@ -30,10 +30,21 @@ 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.
+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.
+
+
 ## Contributing
 
 Patches are welcome on GitHub at https://github.com/amatsuda/routes_lazy_routes.

data/lib/routes_lazy_routes.rb

@@ -17,5 +17,12 @@ module RoutesLazyRoutes
         end
       end
     end
+
+    # The load runner
+    def eager_load!
+      if RoutesLazyRoutes::RoutesReloaderWrapper === (reloader = Rails.application.routes_reloader)
+        reloader.reload!
+      end
+    end
   end
 end

data/lib/routes_lazy_routes/application.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RoutesLazyRoutes
+  module Application
+    module LoadRunner
+      # We expect `Rails.application.eager_load!` to load all routes as well
+      def eager_load!
+        RoutesLazyRoutes.eager_load!
+
+        super
+      end
+    end
+
+    module TaskLoader
+      # A monkey-patch that loads our Rake task for enhancing `rake routes` after Rails loads all other tasks.
+      # Just declaring our own `rake_tasks` in the railtie cannot achieve this, since calling each railtie's `rake_tasks` is done before requiring "rails/tasks",
+      # so enhancing Rails' Rake task from a gem this way seems impossible.
+      def load_tasks(*)
+        super
+
+        load "#{__dir__}/tasks/routes_lazy_routes.rake"
+      end
+    end
+  end
+end

data/lib/routes_lazy_routes/command/routes_command.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RoutesLazyRoutes
+  module Command
+    module RoutesCommand
+      # A monkey-patch that eager_loads the routes right before running the `rails routes` command.
+      def require_environment!
+        super
+
+        RoutesLazyRoutes.eager_load!
+      end
+    end
+  end
+end

data/lib/routes_lazy_routes/lazy_routes_middleware.rb

@@ -2,20 +2,15 @@
 
 module RoutesLazyRoutes
   class LazyRoutesMiddleware
-    def initialize(app, original_routes_reloader)
+    def initialize(app)
       @app = app
-      @original_routes_reloader = original_routes_reloader
-      @mutex = Mutex.new
       @loaded = false
     end
 
     def call(env)
       unless @loaded
-        @mutex.synchronize do
-          @app.instance_variable_set :@routes_reloader, @original_routes_reloader
-          @original_routes_reloader.execute
-          @loaded = true
-        end
+        RoutesLazyRoutes.eager_load!
+        @loaded = true
       end
 
       @app.call env

data/lib/routes_lazy_routes/railtie.rb

@@ -1,9 +1,27 @@
 # frozen_string_literal: true
 
+require_relative 'application'
+
 module RoutesLazyRoutes
   class Railtie < ::Rails::Railtie
-    initializer 'routes_lazy_routes', before: :add_routing_paths do
+    # Extending the following modules have to be done very early, like before executing any initializer, so here it is
+    Rails::Application.prepend RoutesLazyRoutes::Application::TaskLoader
+
+    if defined? Rails::Command::RoutesCommand
+      require_relative 'command/routes_command'
+      Rails::Command::RoutesCommand.prepend RoutesLazyRoutes::Command::RoutesCommand
+    end
+
+    initializer :routes_lazy_routes, before: :add_routing_paths do
       RoutesLazyRoutes.arise!
+
+      Rails.application.config.middleware.use LazyRoutesMiddleware
+
+      Rails.application.extend RoutesLazyRoutes::Application::LoadRunner
+
+      ActiveSupport.on_load :action_dispatch_integration_test, run_once: true do
+        RoutesLazyRoutes.eager_load!
+      end
     end
   end
 end

data/lib/routes_lazy_routes/routes_reloader_wrapper.rb

@@ -2,16 +2,24 @@
 
 module RoutesLazyRoutes
   class RoutesReloaderWrapper
-    delegate :paths, :eager_load=, :updated?, :route_sets, to: :@original_routes_reloader
+    delegate :paths, :eager_load=, :updated?, :route_sets, :external_routes, to: :@original_routes_reloader
 
     def initialize(original_routes_reloader)
       @original_routes_reloader = original_routes_reloader
-
-      Rails.application.config.middleware.use LazyRoutesMiddleware, original_routes_reloader
+      @mutex = Mutex.new
     end
 
     def execute
       # pretty vacant
     end
+
+    def reload!
+      @mutex.synchronize do
+        if Rails.application.routes_reloader == self
+          Rails.application.instance_variable_set :@routes_reloader, @original_routes_reloader
+          @original_routes_reloader.execute
+        end
+      end
+    end
   end
 end

data/lib/routes_lazy_routes/tasks/routes_lazy_routes.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :routes_lazy_routes do
+  task :eager_load do
+    RoutesLazyRoutes.eager_load!
+  end
+end
+
+Rake::Task['routes'].enhance ['routes_lazy_routes:eager_load']

data/lib/routes_lazy_routes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RoutesLazyRoutes
-  VERSION = "0.1.0"
+  VERSION = '0.4.0'
 end

data/routes_lazy_routes.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rails'
+  spec.add_dependency 'railties'
+  spec.add_dependency 'actionpack'
   spec.add_development_dependency 'byebug'
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: routes_lazy_routes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-06 00:00:00.000000000 Z
+date: 2021-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -55,9 +69,12 @@ files:
 - bin/console
 - bin/setup
 - lib/routes_lazy_routes.rb
+- lib/routes_lazy_routes/application.rb
+- lib/routes_lazy_routes/command/routes_command.rb
 - lib/routes_lazy_routes/lazy_routes_middleware.rb
 - lib/routes_lazy_routes/railtie.rb
 - lib/routes_lazy_routes/routes_reloader_wrapper.rb
+- lib/routes_lazy_routes/tasks/routes_lazy_routes.rake
 - lib/routes_lazy_routes/version.rb
 - routes_lazy_routes.gemspec
 homepage: https://github.com/amatsuda/routes_lazy_routes
@@ -81,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.2
+rubygems_version: 3.3.0.dev
 signing_key:
 specification_version: 4
 summary: A Rails routes lazy loader