process_settings 0.14.0 → 0.18.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6719811e3b27382e1c3ab6872a6dc3775b6a06c1971ac980d62f0130252d66e
-  data.tar.gz: d206be34980dd24cf6dd413d8db0e8e63a4b49409ff392135fada36bb68c4295
+  metadata.gz: 15a15a0c5c7ea497858038e4b4be06e63aea209c8e3033662c28963d19839d39
+  data.tar.gz: ba4e23e5216b60ecc7e5e999dcac7d1679c90fd2cf6b712624da9a04aa629c1a
 SHA512:
-  metadata.gz: bc5ba17baca2d071bd68aed1a685d223e0febe073463e46344d314003004948463e7e9da400198ad45a075a599aff7bd34a6989f4223e598ea014026e611ab18
-  data.tar.gz: cee3d3980e62c840c061df1e8f5d44aec487c855d49b467d81b7bf52f5d48cf61f02ef97759a7eb1b43b575db39beee0f73849fe36f5069976adb35f17deff0b
+  metadata.gz: 44058ab68dbb74cdf889bd57ac0bff0324f35f4608a27f67623da3b17a8ee0b4f9bfef24311395e969f941db28c2a5137c79c3233db75659fcc9e1f4239797e1
+  data.tar.gz: 3310afc60c343999207561d0e2820dc6ff4e985f71b1e25b8402fe7f3f39c762dd560f83cf78a5ccd57fa937a13c9dfdb43f41e57e8aa3326eb3a63d05f628bd

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

@@ -8,6 +8,8 @@ require 'active_support/deprecation'
 require 'process_settings/abstract_monitor'
 require 'process_settings/targeted_settings'
 require 'process_settings/hash_path'
+require 'process_settings/helpers/watchdog'
+require 'exception_handling'
 
 module ProcessSettings
   class FileMonitor < AbstractMonitor
@@ -24,10 +26,39 @@ module ProcessSettings
       start_internal(enable_listen_thread?(environment))
     end
 
+    def start_watchdog_thread(file_path = :missing)
+      if file_path == :missing
+        ActiveSupport::Deprecation.warn("ProcessEnvSetup.start_watchdog_thread with no arguments is deprecated")
+        file_path = ProcessSettings::Monitor.file_path
+      end
+
+      @watchdog_thread and raise ArgumentError, "watchdog thread already running!"
+      @watchdog_thread = Thread.new do
+        watchdog = ProcessSettings::Watchdog.new(file_path)
+        loop do
+          ExceptionHandling.ensure_safe("ProcessSettings::Watchdog thread") do
+            sleep(1.minute)
+            watchdog.check
+          end
+        end
+      end
+    end
+
+    def stop_watchdog_thread
+      if @watchdog_thread
+        Thread.kill(@watchdog_thread)
+        @watchdog_thread = nil
+      end
+    end
+
     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/helpers/watchdog.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/numeric/time'
+
+module ProcessSettings
+  class Watchdog
+    class OutOfSync < StandardError; end
+
+    MAX_MTIME_DIFFERENCE = 2.minutes
+
+    def initialize(process_settings_file_path)
+      @process_settings_file_path = process_settings_file_path or raise ArgumentError, "process_settings_file_path must be passed"
+    end
+
+    def check
+      if version_from_memory != version_from_disk && (Time.now - mtime_from_disk) > MAX_MTIME_DIFFERENCE
+        raise ProcessSettings::OutOfSync.new("ProcessSettings versions are out of sync!\n Version from Disk: #{version_from_disk}\n Version from Memory: #{version_from_memory}\n mtime of file: #{mtime_from_disk}")
+      end
+    end
+
+    private
+
+    attr_reader :process_settings_file_path
+
+    def version_from_memory
+      ProcessSettings.instance.untargeted_settings.version
+    end
+
+    def version_from_disk
+      ProcessSettings::TargetedSettings.from_file(process_settings_file_path, only_meta: true).version
+    end
+
+    def mtime_from_disk
+      File.mtime(process_settings_file_path)
+    end
+  end
+end

data/lib/process_settings/monitor.rb

@@ -46,7 +46,7 @@ module ProcessSettings
       def logger=(new_logger)
         ActiveSupport::Deprecation.warn("ProcessSettings::Monitor.logger is deprecated and will be removed in v1.0.")
         @logger = new_logger
-        Listen.logger ||= new_logger
+        Listen.logger = new_logger unless Listen.instance_variable_get(:@logger)
       end
 
       deprecate :logger, :logger=, :file_path, :file_path=, deprecator: ActiveSupport::Deprecation.new('1.0', 'ProcessSettings')

data/lib/process_settings/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_settings
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.18.0.pre.1
 platform: ruby
 authors:
 - Invoca
@@ -94,6 +94,7 @@ files:
 - lib/process_settings/file_monitor.rb
 - lib/process_settings/hash_path.rb
 - lib/process_settings/hash_with_hash_path.rb
+- lib/process_settings/helpers/watchdog.rb
 - lib/process_settings/monitor.rb
 - lib/process_settings/replace_versioned_file.rb
 - lib/process_settings/settings.rb
@@ -122,9 +123,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: