process_settings 0.15.1 → 0.19.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37586770d262584d6b5f6b2b4a8a7824eb351d9da15d6577dc0591223c0074f0
-  data.tar.gz: 8c61aa64d76749381c1311f7c08f2778a0c99134778c09d45aebd32d1ca10ff5
+  metadata.gz: de51169a9cf26a44ceb6b123fcd2aadef73f8303b0fc3e0fb704b284b6f00b58
+  data.tar.gz: 307e88409813d063891eb8e6015fd0d208b17d7280cf561d97300fbfb1f0b8dc
 SHA512:
-  metadata.gz: 212169ce11e8ce4c15f056ffc14c15de1e46fadbc93878c922a577b44217bc8c84d3ecfa49773580bbbf06bdae4cb9a58caf55e570c334282e14ed26c9045ff6
-  data.tar.gz: 7afc6259634fba9c6a8e0ebe63ab4ffa361c79fdfb5dde63d4f39168222cb790cfa706989e43eaee5ea7b0f9625d393f4411b673bff68e11e0e609c694372adc
+  metadata.gz: cb53b7565b37fae70ca9509b42dcc15fbab8ffa03122392b9fb780f8b721dc9c6eb33ba0844525d82b038328afd368d764ac16748e5313234824991f78942c1b
+  data.tar.gz: ed9ac91c42392da4f26f01fb732a72b0cf7321b4ba6843dd0ada7cf022ed6eeded1457f0efec377a50a1182442b12aa5ce8a112f2124c871970345620a7461aa

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
@@ -133,15 +137,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.1'
+  VERSION = '0.19.0.pre.1'
 end

metadata

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