spring 4.3.0 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e92617adaa3e6c31e4d466d76894c94ec17a46fd7206864501218795ac8998d
-  data.tar.gz: aee2d23a222df8747942652dda1d6a725f59bb68b395fbd37a9084c5ed75fe7b
+  metadata.gz: a37d78748e084596d151cde2918d30799c8dfe9e10e029920ece9e9eee8118ad
+  data.tar.gz: c47e0897d3938b7350245854672812436505379cc498638c3eca9e2d52537fe6
 SHA512:
-  metadata.gz: 16e03232e4453b528812c925c4186360e1157b10aab0d663d1dc3d4a80a7d4bdf1da8f06d31c6ace1456fa4f6f5e20b2c62637ce0a23da6cae705b56baa6882b
-  data.tar.gz: 1a4c70a381783cc3f96372e28efc6b702b3b75a28c31a1a88eacace55c3a3cbd2aee3d3ff81236526366149a612754c22d9ec0861bc0a3dfb8669108f9bb0aba
+  metadata.gz: cda176e1dd4d22cabb680cb85c4fd562c256f8fb3dc04f9064fc61f910cfb384f044f63bee74a424501505b62f80e0746f6c05bddf327c6be0150f12cc678a3f
+  data.tar.gz: e8b1675241b3fc42c52eabb9e2f501d4abae16c35ae3e3d19080de332f3d28b258b7245c127264326871f09c35c333a3b71fcfb8fbbfecdc87648a72e1328c14

data/README.md

@@ -16,8 +16,8 @@ boot it every time you run a test, rake task or migration.
 
 ## Compatibility
 
-* Ruby versions: MRI 2.7, MRI 3.0, MRI 3.1, MRI 3.2
-* Rails versions: 6.0, 6.1, 7.0
+* Ruby versions: MRI 3.1+
+* Rails versions: 7.1+
 * Bundler v2.1+
 
 Spring makes extensive use of `Process.fork`, so won't be able to
@@ -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,16 +101,28 @@ 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"]
+          else
+            ["cache_classes", "false"]
+          end
           raise <<-MSG.strip_heredoc
             Spring reloads, and therefore needs the application to have reloading enabled.
-            Please, set config.cache_classes to false in config/environments/#{Rails.env}.rb.
+            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
@@ -124,8 +136,9 @@ module Spring
 
       if defined?(Rails) && Rails.application
         watcher.add Rails.application.paths["config/initializers"]
-        Rails::Engine.descendants.each do |engine|
-          if engine.root.to_s.start_with?(Rails.root.to_s)
+        rails_root = Rails.root.to_s
+        Rails::Engine.subclasses.each do |engine|
+          if engine.root.to_s.start_with?(rails_root)
             watcher.add engine.paths["config/initializers"].expanded
           end
         end
@@ -136,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
@@ -177,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
@@ -238,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
@@ -294,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) }
@@ -320,6 +356,7 @@ module Spring
               if $!
                 lib = File.expand_path("..", __FILE__)
                 $!.backtrace.reject! { |line| line.start_with?(lib) } unless $!.backtrace.frozen?
+                $!.backtrace_locations.reject! { |line| line.path&.start_with?(lib) } unless $!.backtrace_locations.frozen?
               end
             end
           end
@@ -331,6 +368,7 @@ module Spring
               if $!
                 lib = File.expand_path("..", __FILE__)
                 $!.backtrace.reject! { |line| line.start_with?(lib) } unless $!.backtrace.frozen?
+                $!.backtrace_locations.reject! { |line| line.path&.start_with?(lib) } unless $!.backtrace_locations.frozen?
               end
             end
           end
@@ -370,10 +408,10 @@ module Spring
       Spring.failsafe_thread {
         begin
           _, status = Process.wait2 pid
-          log "#{pid} exited with #{status.exitstatus}"
+          log "#{pid} exited with #{status.exitstatus || status.inspect}"
 
           streams.each(&:close)
-          client.puts(status.exitstatus)
+          client.puts(status.exitstatus || status.to_i)
           client.close
         ensure
           @mutex.synchronize { @waiting.delete pid }
@@ -395,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/application_manager.rb

@@ -42,7 +42,7 @@ module Spring
         if alive?
           begin
             yield
-          rescue Errno::ECONNRESET, Errno::EPIPE
+          rescue Errno::ECONNRESET, Errno::EPIPE, Errno::EINVAL
             # The child has died but has not been collected by the wait thread yet,
             # so start a new child and try again.
             log "child dead; starting"
@@ -102,7 +102,7 @@ module Spring
             "RACK_ENV"            => app_env,
             "SPRING_ORIGINAL_ENV" => JSON.dump(Spring::ORIGINAL_ENV),
             "SPRING_PRELOAD"      => preload ? "1" : "0",
-            "SPRING_SPAWN_ENV"    => JSON.dump(spawn_env),
+            "SPRING_SPAWN_ENV"    => JSON.dump(spawn_env.compact),
             **spawn_env,
           },
           "ruby",

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/client/run.rb

@@ -6,6 +6,7 @@ module Spring
   module Client
     class Run < Command
       FORWARDED_SIGNALS = %w(INT QUIT USR1 USR2 INFO WINCH) & Signal.list.keys
+      ServerReadTimeout = Class.new(StandardError)
 
       attr_reader :server
 
@@ -120,13 +121,27 @@ module Spring
       end
 
       def verify_server_version
-        unless IO.select([server], [], [], Spring.connect_timeout)
-          raise "Error connecting to Spring server"
+        begin
+          line = read_server_line
+        rescue ServerReadTimeout
+          if waiting_for_server_boot?
+            begin
+              # Try again, but with same timeout as booting, as server might still be booting
+              #   from another client starting it.
+              line = read_server_line(Spring.boot_timeout)
+            rescue ServerReadTimeout
+              reboot_or_raise_connection_error
+              return
+            end
+          else
+            reboot_or_raise_connection_error
+            return
+          end
         end
 
-        line = server.gets
-        unless line
-          raise "Error connecting to Spring server"
+        if line.nil?
+          reboot_or_raise_connection_error
+          return
         end
 
         server_version = line.chomp
@@ -145,6 +160,25 @@ module Spring
         end
       end
 
+      def read_server_line(timeout = Spring.connect_timeout)
+        raise ServerReadTimeout if IO.select([server], [], [], timeout).nil?
+
+        server.gets
+      end
+
+      def waiting_for_server_boot?
+        !server_booted? && env.server_running?
+      end
+
+      def reboot_or_raise_connection_error
+        if server_booted?
+          raise "Error connecting to Spring server"
+        else
+          stop_server
+          cold_run
+        end
+      end
+
       def connect_to_application(client)
         server.send_io client
         send_json server, "args" => args, "default_rails_env" => default_rails_env, "spawn_env" => spawn_env, "reset_env" => reset_env
@@ -184,11 +218,16 @@ module Spring
           suspend_resume_on_tstp_cont(pid)
 
           forward_signals(application)
-          status = application.read.to_i
+          status = application.read
+          log "got exit status #{status.inspect}"
 
-          log "got exit status #{status}"
+          # Status should always be an integer. If it is empty, something unexpected must have happened to the server.
+          if status.to_s.strip.empty?
+            log "unexpected empty exit status, app crashed?"
+            exit 1
+          end
 
-          exit status
+          exit status.to_i
         else
           log "got no pid"
           exit 1
@@ -249,7 +288,9 @@ module Spring
       end
 
       def spawn_env
-        ENV.slice(*Spring.spawn_on_env)
+        Spring.spawn_on_env.to_h do |key|
+          [key, ENV[key]]
+        end
       end
     end
   end

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/json.rb

@@ -13,6 +13,7 @@
 module Spring
   module JSON
     def self.load(string)
+      string = string.dup.force_encoding("utf-8") unless string.encoding == Encoding::UTF_8
       OkJson.decode(string)
     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.3.0"
+  VERSION = "4.7.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: spring
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.7.0
 platform: ruby
 authors:
 - Jon Leighton
 bindir: bin
 cert_chain: []
-date: 2025-03-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Preloads your application so things like console, rake and tests run
   faster
@@ -56,6 +56,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
+  changelog_uri: https://github.com/rails/spring/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -63,14 +64,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Rails application preloader
 test_files: []