spring 4.4.2 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: def7b2369b2bfd2e89227a11ab9fab2a336b10011ec8b51a82319828e73ecee4
-  data.tar.gz: 58e3868998fe06b76e2e6a86cd5274aabdd5f315395aae004e5cfd3d488708ca
+  metadata.gz: f386aff68c6b8feab1d79a933df930e6c47bf8d2f5f3610c7c483954e1b97cff
+  data.tar.gz: fb1ef130a243970266279570dad57c259ecd828cfab6b1043482ed429234e363
 SHA512:
-  metadata.gz: 4e48694be64ae52918a2a82c61d5e0ba1bec2c826123b697e789abcf74c38d7d8d6162b32b64ccd8694855e2bb4cf29af5147a2ea34fd96163c95fd4405940c7
-  data.tar.gz: '054845db5469efb81a6fc0a9775dcbaa0518153e51a13807a2e340a470b5ac100cd01f51f99b9676ccae1b395fd2b57bb3306d65410f1587999481ed40052d80'
+  metadata.gz: da2a3fbbb088ca721ed27128e0a60be6b8946b519ae4580fb7c99cc76f3052063b24bbacce932db0212a9308094e1e392e7a7c6937526dc19d940c896c4c4a1d
+  data.tar.gz: d712161465b1217b783046ec10ad2694c65bf7897ab78cc7e97d1b6c33ae0a124dc949f9dd056755d5aaf40890c502ee617e3ad2338cbe8551731ae8c29b1774

data/README.md

@@ -79,6 +79,31 @@ Spring manages. That setting is typically configured in
 Note: in versions of Rails before 7.1, the setting is called `cache_classes`,
 and it needs to be `false` for Spring to work.
 
+#### Running Spring with reloading disabled (advanced, risky)
+
+If you know what you are doing, and if every reloadable resource is configured
+to materialize *lazily in the forked child*, not in the Spring server process,
+then you can decide to run Spring without Rail's in-process reloaders.
+
+To opt into this, set in `config/spring.rb`:
+
+```ruby
+Spring.dangerously_allow_disabling_reloading = true
+```
+
+If you set this, you should make sure that you are NOT pre-loading reloadable
+resource in the Spring server. One approach is to add boot-time assertions at
+the end of `Spring.after_environment_load`, e.g.:
+
+```ruby
+Spring.after_environment_load do
+  raise "routes were drawn at boot" if Rails.application.routes_reloader.loaded
+  raise "i18n locales where loaded at boot" unless I18n.backend.instance_variable_get(:@translations).nil?
+end
+```
+
+When unsure, leave this disabled.
+
 ### Usage
 
 For this walkthrough I've generated a new Rails application, and run
@@ -334,7 +359,8 @@ server process is started, it can be used to add new top-level commands.
 Spring must know how to find your Rails application. If you have a
 normal app everything works out of the box. If you are working on a
 project with a special setup (an engine for example), you must tell
-Spring where your app is located:
+Spring where your app is located by specifying the below code in a
+`config/spring.rb` file relative to your engines root directory :
 
 ```ruby
 Spring.application_root = './test/dummy'

data/lib/spring/application.rb

@@ -101,6 +101,8 @@ module Spring
       end
 
       Rails::Application.initializer :ensure_reloading_is_enabled, group: :all do
+        next if Spring.dangerously_allow_disabling_reloading
+
         if Rails.application.config.cache_classes
           config_name, set_to = if Rails.application.config.respond_to?(:enable_reloading=)
             ["enable_reloading", "true"]
@@ -110,12 +112,17 @@ module Spring
           raise <<-MSG.strip_heredoc
             Spring reloads, and therefore needs the application to have reloading enabled.
             Please, set config.#{config_name} to #{set_to} in config/environments/#{Rails.env}.rb.
+            (If you understand the trade-offs and want to disable Rails' reloader anyway,
+            set `Spring.dangerously_allow_disabling_reloading = true` in config/spring.rb.)
           MSG
         end
       end
 
       require Spring.application_root_path.join("config", "environment")
 
+      invoke_after_environment_load_callbacks
+      preload_framework_base_classes
+
       disconnect_database
 
       @preloaded = :success
@@ -142,6 +149,19 @@ module Spring
       end
     end
 
+    # Eagerly autoload framework base classes
+    FRAMEWORK_BASE_CLASSES = %w[
+      ActionMailer::Base
+      ActionController::Base
+      ActionController::API
+    ].freeze
+
+    def preload_framework_base_classes
+      FRAMEWORK_BASE_CLASSES.each do |const|
+        Object.const_get(const) if Object.const_defined?(const)
+      end
+    end
+
     def eager_preload
       with_pty do
         # we can't see stderr and there could be issues when it's overflown
@@ -183,7 +203,7 @@ module Spring
           client.puts(0) # preload success
         rescue Exception
           log "preload failed"
-          client.puts(1) # preload failure
+          ignore_client_disconnect { client.puts(1) } # preload failure
           raise
         end
       end
@@ -244,15 +264,19 @@ module Spring
 
       wait pid, streams, client
     rescue Exception => e
-      log "exception: #{e}"
+      if e.is_a?(Errno::EPIPE)
+        log "client disconnected (#{e.message}), ignoring command"
+      else
+        log "exception: #{e}"
+      end
       manager.puts unless pid
 
       if streams && !e.is_a?(SystemExit)
-        print_exception(stderr, e)
-        streams.each(&:close)
+        ignore_client_disconnect { print_exception(stderr, e) }
+        streams.each { |stream| ignore_client_disconnect { stream.close } }
       end
 
-      client.puts(1) if pid
+      ignore_client_disconnect { client.puts(1) if pid }
       client.close
     ensure
       # Redirect STDOUT and STDERR to prevent from keeping the original FDs
@@ -300,6 +324,12 @@ module Spring
       end
     end
 
+    def invoke_after_environment_load_callbacks
+      Spring.after_environment_load_callbacks.each do |callback|
+        callback.call
+      end
+    end
+
     def loaded_application_features
       root = Spring.application_root_path.to_s
       $LOADED_FEATURES.select { |f| f.start_with?(root) }
@@ -403,6 +433,15 @@ module Spring
 
     private
 
+    # Tolerate Errno::EPIPE on writes to the client socket. Once the client
+    # disconnects, every subsequent write to it raises — that's expected
+    # during `serve`'s status reporting; we'd be talking to a process
+    # that's gone.
+    def ignore_client_disconnect
+      yield
+    rescue Errno::EPIPE
+    end
+
     def active_record_configured?
       defined?(ActiveRecord::Base) && ActiveRecord::Base.configurations.any?
     end

data/lib/spring/client/binstub.rb

@@ -26,7 +26,7 @@ module Spring
         if !defined?(Spring) && [nil, "development", "test"].include?(ENV["RAILS_ENV"])
           require "bundler"
 
-          Bundler.locked_gems.specs.find { |spec| spec.name == "spring" }&.tap do |spring|
+          Bundler.definition.requested_specs.find { |spec| spec.name == "spring" }&.tap do |spring|
             Gem.use_paths Gem.dir, Bundler.bundle_path.to_s, *Gem.path
             gem "spring", spring.version
             require "spring/binstub"

data/lib/spring/configuration.rb

@@ -3,11 +3,17 @@ require "spring/errors"
 module Spring
   @connect_timeout = 5
   @boot_timeout = 20
+  @dangerously_allow_disabling_reloading = false
 
   class << self
     attr_accessor :application_root, :connect_timeout, :boot_timeout
     attr_writer :quiet
 
+    # Opt-in: skip the `:ensure_reloading_is_enabled` initializer so Spring
+    # boots with `config.enable_reloading = false`. Default `false`. See
+    # README "Running Spring with reloading disabled" for what this gives up.
+    attr_accessor :dangerously_allow_disabling_reloading
+
     def gemfile
       require "bundler"
 
@@ -35,6 +41,14 @@ module Spring
       after_fork_callbacks << block
     end
 
+    def after_environment_load_callbacks
+      @after_environment_load_callbacks ||= []
+    end
+
+    def after_environment_load(&block)
+      after_environment_load_callbacks << block
+    end
+
     def spawn_on_env
       @spawn_on_env ||= []
     end

data/lib/spring/server.rb

@@ -74,6 +74,8 @@ module Spring
       end
     rescue SocketError => e
       raise e unless client.eof?
+    rescue Errno::EPIPE => e
+      log "client disconnected with error #{e.message}, ignoring command"
     ensure
       redirect_output
     end

data/lib/spring/version.rb

@@ -1,3 +1,3 @@
 module Spring
-  VERSION = "4.4.2"
+  VERSION = "4.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spring
 version: !ruby/object:Gem::Version
-  version: 4.4.2
+  version: 4.6.0
 platform: ruby
 authors:
 - Jon Leighton