spring 4.5.0 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56e90e978202520c21d08823b1c539949f413ea8694868caec30042ede704533
-  data.tar.gz: 34d0bf24260d460621ba8dfbb5be7f3750a3c3b0e4c20092878f38aa66aee1a4
+  metadata.gz: a37d78748e084596d151cde2918d30799c8dfe9e10e029920ece9e9eee8118ad
+  data.tar.gz: c47e0897d3938b7350245854672812436505379cc498638c3eca9e2d52537fe6
 SHA512:
-  metadata.gz: b367e099835ce1cca3769b616905ac31a3d2a3ae7271b93031ebeb5cb95711735db2f3bc952541e0609197f0dc98fe3c03b0df36210fa6645ae5ff28a83c90a6
-  data.tar.gz: 9c428924ba4c30c0cc5ee22e21da828b237ab686fee3d134519b16198127c3829288147b4eb056f3596c05efa46db2b7c3693f4e9a1a9c7bb362b7c020b34610
+  metadata.gz: cda176e1dd4d22cabb680cb85c4fd562c256f8fb3dc04f9064fc61f910cfb384f044f63bee74a424501505b62f80e0746f6c05bddf327c6be0150f12cc678a3f
+  data.tar.gz: e8b1675241b3fc42c52eabb9e2f501d4abae16c35ae3e3d19080de332f3d28b258b7245c127264326871f09c35c333a3b71fcfb8fbbfecdc87648a72e1328c14

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

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,6 +112,8 @@ 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

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

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"
 

data/lib/spring/version.rb

@@ -1,3 +1,3 @@
 module Spring
-  VERSION = "4.5.0"
+  VERSION = "4.7.0"
 end

metadata

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