process_settings 0.16.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe4e35a75d3c8a06396dbc7094874cf5e2509847f66c442ff5297e9c8011cebd
-  data.tar.gz: a7b18e595bde05fd56037570a80008bf3f0cc5d679810dce724a63977fec9a02
+  metadata.gz: 14973d0d1a4eb5ad4641db115a9eb439740761bbc4ae0bfd20a103a455c9eb82
+  data.tar.gz: 4d662530770cd4afba5792ec603c67f86681300d8aef0c4ed8d9b9e0d8975bca
 SHA512:
-  metadata.gz: 3f972dcfa9f6e7f988866ac290e71231f0a005842105a284e6a688123e74f9e970ec60749675d0855b47d13d344462169f29cd70b7251b799ae6a6ef4f82b6a6
-  data.tar.gz: e30ad37d7c7508c70471c75322ffcf98c981fb54bdf0e339e6ab512d95c04a8bcd2dad5917381c0a2fbd3ce468e1f04cc18bc0c7919bc9848be3f8b934155853
+  metadata.gz: 010056e43ab73c0a6838732c25fc4f23fcb598056cac740e81d27f5d9765b12740a1db2f587286d716613597393d49e9781150ff7bd186363c22fd0bc8b420c2
+  data.tar.gz: 4784757b38d3e80c41ec366ecccc0425069820a712e995927a82fffd02f177e3053cf274886259310d472cc314cdf526b8198531f965b15b24b89b520e14c612

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.

data/lib/process_settings/abstract_monitor.rb

@@ -114,7 +114,11 @@ module ProcessSettings
         # find last value from matching targets
         if target_and_settings.target.target_key_matches?(full_context)
           if (value = target_and_settings.settings.json_doc.mine(*path, not_found_value: :not_found)) != :not_found
-            latest_result = value
+            latest_result = if latest_result.is_a?(Hash) && value.is_a?(Hash)
+                              latest_result.deep_merge(value)
+                            else
+                              value
+                            end
           end
         end
         latest_result

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.16.0'
+  VERSION = '0.19.0'
 end

metadata

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