process_settings 0.15.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17af8e8b00a219e790b36fc20282e0c4c7d7c04cfd7f911ea636f056b675cf70
-  data.tar.gz: 198665150f57b95634698ab3474dd587dbefbc48ecf41d10084a6f872a0a3949
+  metadata.gz: aab773e1074ed3b357a5938e9366b56e69bdc6e36ace59835fdea8bbbe49516d
+  data.tar.gz: 3fe8bb70b1e59498420c878abb86cf2e1b0289694e4ed941a0a11b1a6abc5bce
 SHA512:
-  metadata.gz: ea2bf7c35886a10807a3b8ab171133776c1381371b628ac08cbe413a2cbc8d4bc8c600142fc44c0734fb1e2dc6bb2143be40c68c5b99217404fa6a085ccf2326
-  data.tar.gz: b92dbd32b2935e7d3ba4b8b95f33dc032e018a273505f7daaba4126d1ef7f132fe40e79535780c45a3283df9daa3c006ce1312c2cf2c2eb472b7b123f09fa10f
+  metadata.gz: 939389ccdfaf3fb4880251e34abc36f15e11963ef1ce69e102208a04e084df0c870eeb906103f9859d6ce7af1e27938d713e153ab16768ee6bbaf0e6c6bb5262
+  data.tar.gz: bf6190c8812f0fcb73507bfc4b1cda3e2f9370e5c398df8cdbda2a112a23c80479dcf7189d8fb157ae4725b3bcfafe9bef1bb23a63a27eb3351b33d6644e2d04

data/README.md

@@ -167,6 +167,32 @@ 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
+```
+
+### Start Watchdog
+When using `ProcessSettings` you can start a watchdog thread using `start_watchdog_thread` on a particular file path. The watchdog will poll once a minute to double-check if any changes have been missed due to a bug in the `listen` gem or the supporting OS drivers like `inotify`.
+You may not start the watchdog thread it has already been started. 
+```ruby
+ProcessSettings.instance.start_watchdog_thread(file_path)
+```
+
+### Stop Watchdog
+When using `ProcessSettings` you can stop a watchdog thread using `stop_watchdog_thread`. Once stopped you may start a new watchdog thread.
+```ruby
+ProcessSettings.instance.stop_watchdog_thread
+```
+
 ### 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 +207,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

@@ -133,15 +133,11 @@ module ProcessSettings
 
     def full_context_from_cache(dynamic_context)
       if (full_context = full_context_cache[dynamic_context])
-        logger.info("cache hit ...")
         full_context
       else
-        logger.info("cache miss ...")
         dynamic_context.deep_merge(static_context).tap do |full_context|
           if full_context_cache.size <= 1000
             full_context_cache[dynamic_context] = full_context
-          else
-            logger.info("cache limit reached ...")
           end
         end
       end

data/lib/process_settings/file_monitor.rb

@@ -8,6 +8,7 @@ require 'active_support/deprecation'
 require 'process_settings/abstract_monitor'
 require 'process_settings/targeted_settings'
 require 'process_settings/hash_path'
+require 'process_settings/helpers/watchdog'
 
 module ProcessSettings
   class FileMonitor < AbstractMonitor
@@ -24,10 +25,32 @@ module ProcessSettings
       start_internal(enable_listen_thread?(environment))
     end
 
+    def start_watchdog_thread(file_path)
+      @watchdog_thread and raise ArgumentError, "watchdog thread already running!"
+      @watchdog_thread = Thread.new do
+        watchdog = Watchdog.new(file_path)
+        loop do
+          sleep(1.minute)
+          watchdog.check
+        rescue => ex
+          logger.error("ProcessSettings::Watchdog thread: #{ex.class.name}: #{ex.message}")
+        end
+      end
+    end
+
+    def stop_watchdog_thread
+      @watchdog_thread&.kill
+      @watchdog_thread = nil
+    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.15.0'
+  VERSION = '0.18.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_settings
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.18.0
 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