process_settings 0.14.0.pre.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f741a9ba0e6370251e742c613fe5dba63b4c53c7dfdec8c352d00f9d2938489
-  data.tar.gz: 69b58c50ff369b61d95814cba575fad95d8eb3404443acfb2f5d4154aea392c4
+  metadata.gz: 93741a97801bc4783109ff2423f1d1254f764ccad969f8810e242cb32a48ca18
+  data.tar.gz: 8e8a865c9f03fa41dc9dd61b5aaa2d59ef86fb66753ca891898942677c9c518e
 SHA512:
-  metadata.gz: d00a43c0beffc30ab1af86edebc98adb7dc99dcc21d334dc7ba13cb146b5595e04bb905c6ce346a057ea29f2483fa729e52cdaaacb45eb743f0740fb062fdcf9
-  data.tar.gz: 97ebec348ff8d4220668b55148cb26aa5c3934317e91d114ecbeb5e2e2c7cc081bfa695595b09ee8b9ac984b1c58955346697eda2ef78b36e6ea7bab1a8e6491
+  metadata.gz: f42cb27c7d884a6be0e4543fe148f2e7cc68d2f8e41883789a5ee5a32db9ee4cec5de349f0f576dcb551f07f60e1b9d749a8d4b122ba43aa7346c4cb13f91014
+  data.tar.gz: 981330f869266006284477f9146f6686724d0240745ec4112b1b62ba090e4d28f5a211f3a515a3dba1a70f538e87a8191c6d81958c71f628711879031e8e1d11

data/README.md

@@ -167,6 +167,19 @@ This will be applied in any process that has (`service_name == "frontend"` OR `s
 ### Precedence
 The settings YAML files are always combined in alphabetical order by file path. Later settings take precedence over the earlier ones.
 
+### Forked Processes
+When using `ProcessSettings` within an environment that is forking threads (like `unicorn` web servers), you can restart the `FileMonitor`
+after the fork with `restart_after_fork`.
+```ruby
+# unicorn.rb
+
+preload_app true
+
+after_fork do
+  ProcessSettings.instance.restart_after_fork
+end
+```
+
 ### Testing
 For testing, it is often necessary to set a specific override hash for the process_settings values to use in
 that use case.  The `ProcessSettings::Testing::RSpec::Helpers` and `ProcessSettings::Testing::Minitest::Helpers` modules are provided for this purpose.
@@ -181,7 +194,7 @@ require 'process_settings/testing/helpers'
 RSpec.configure do |config|
   # ...
 
-  include ProcessSettings::Testing::RSpec::Helpers
+  config.include ProcessSettings::Testing::RSpec::Helpers
 
   # Note: the include above will automatically register a global after block that will reset process_settings to their initial values.
   # ...

data/bin/combine_process_settings

@@ -92,6 +92,26 @@ def warn_if_old_libyaml_version
   end
 end
 
+def settings_files_match?(filename_1, filename_2)
+  filename_1 && filename_2 &&
+    File.exist?(filename_1) && File.exist?(filename_2) &&
+    diff_process_settings(filename_1, filename_2)
+end
+
+def diff_process_settings(filename_1, filename_2)
+  system(<<~EOS)
+    bundle exec diff_process_settings --silent "#{filename_1}" "#{filename_2}"
+  EOS
+  status_code = $?.exitstatus
+  case status_code
+  when 0
+    true
+  when 1
+    false
+  else
+    raise "diff_process_settings failed with code #{status_code}"
+  end
+end
 
 #
 # main
@@ -115,14 +135,17 @@ tmp_output_filename = "#{output_filename}.tmp"
 system("rm -f #{tmp_output_filename}")
 File.write(tmp_output_filename, yaml_with_warning_comment)
 
-system(<<~EOS)
-  if bundle exec diff_process_settings --silent #{tmp_output_filename} #{output_filename} ; then
-    #{"echo #{options.root_folder}: unchanged;" if options.verbose}
-    rm -f #{tmp_output_filename};
+if settings_files_match?(options.initial_filename, tmp_output_filename)
+  if settings_files_match?(output_filename, tmp_output_filename)
+    puts "#{options.root_folder}: unchanged" if options.verbose
+    FileUtils.rm_f(tmp_output_filename)
   else
-    #{"echo #{options.root_folder}: UPDATING;" if options.verbose}
-    mv #{tmp_output_filename} #{output_filename};
-  fi
-EOS
+    puts "#{options.root_folder}: UPDATING (changed now)" if options.verbose
+    FileUtils.mv(tmp_output_filename, output_filename)
+  end
+else
+  puts "#{options.root_folder}: UPDATING (unchanged now, but changed from initial)" if options.verbose
+  FileUtils.mv(tmp_output_filename, output_filename)
+end
 
 exit(0)

data/bin/diff_process_settings

@@ -34,10 +34,7 @@ input_files =
       if path == '-'
         ''
       else
-        unless File.exists?(path)
-          warn "#{path} not found--must be a path to combined_process_settings.yml"
-          exit 1
-        end
+        File.exist?(path) or path = '/dev/null'
         "< #{path}"
       end
     end

data/lib/process_settings/abstract_monitor.rb

@@ -11,14 +11,16 @@ module ProcessSettings
   OnChangeDeprecation = ActiveSupport::Deprecation.new('1.0', 'ProcessSettings::Monitor')
 
   class AbstractMonitor
+
     attr_reader :min_polling_seconds, :logger
-    attr_reader :static_context, :statically_targeted_settings
+    attr_reader :static_context, :statically_targeted_settings, :full_context_cache
 
     def initialize(logger:)
       @logger = logger or raise ArgumentError, "logger must be not be nil"
       @on_change_callbacks = []
       @when_updated_blocks = Set.new
       @static_context = {}
+      @full_context_cache = {}
     end
 
     # This is the main entry point for looking up settings on the Monitor instance.
@@ -94,10 +96,20 @@ module ProcessSettings
     def targeted_value(*path, dynamic_context:, required: true)
       # Merging the static context in is necessary to make sure that the static context isn't shifting
       # this can be rather costly to do every time if the dynamic context is not changing
-      # TODO: Warn in the case where dynamic context was attempting to change a static value
-      # TODO: Cache the last used dynamic context as a potential optimization to avoid unnecessary deep merges
-      # TECH-4402 was created to address these todos
-      full_context = dynamic_context.deep_merge(static_context)
+
+      # Warn in the case where dynamic context was attempting to change a static value
+      changes = dynamic_context.each_with_object({}) do |(key, dynamic_value), result|
+        if static_context.has_key?(key)
+          static_value = static_context[key]
+          if static_value != dynamic_value
+            result[key] = [static_value, dynamic_value]
+          end
+        end
+      end
+
+      changes.empty? or warn("WARNING: static context overwritten by dynamic!\n#{changes.inspect}")
+
+      full_context = full_context_from_cache(dynamic_context)
       result = statically_targeted_settings.reduce(:not_found) do |latest_result, target_and_settings|
         # find last value from matching targets
         if target_and_settings.target.target_key_matches?(full_context)
@@ -119,6 +131,18 @@ module ProcessSettings
       end
     end
 
+    def full_context_from_cache(dynamic_context)
+      if (full_context = full_context_cache[dynamic_context])
+        full_context
+      else
+        dynamic_context.deep_merge(static_context).tap do |full_context|
+          if full_context_cache.size <= 1000
+            full_context_cache[dynamic_context] = full_context
+          end
+        end
+      end
+    end
+
     private
 
     class << self

data/lib/process_settings/file_monitor.rb

@@ -27,7 +27,11 @@ module ProcessSettings
     def start
       start_internal(enable_listen_thread?)
     end
-    deprecate :start, deprecator: ActiveSupport::Deprecation.new('1.0', 'ProcessSettings') # will become private
+    deprecate start: :restart_after_fork, deprecator: ActiveSupport::Deprecation.new('1.0', 'ProcessSettings')
+
+    def restart_after_fork
+      start_internal(enable_listen_thread?)
+    end
 
     def listen_thread_running?
       !@listener.nil?

data/lib/process_settings/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProcessSettings
-  VERSION = '0.14.0.pre.1'
+  VERSION = '0.17.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_settings
 version: !ruby/object:Gem::Version
-  version: 0.14.0.pre.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Invoca
@@ -122,9 +122,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: