config_skeleton 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a58d74e2627a2f4f0ac79fa05c9ce07d2b17b8500af7e38d59fd7a33ac22fe7
-  data.tar.gz: 8b1d8531cc3fcc1183d14c465b886833b97130326d891b9da00ef05780b36a2c
+  metadata.gz: 065e0e44c1b485dc5b32c9466cb68bd9f3c8c3af8704489a0f747951b714347c
+  data.tar.gz: 48518976b9d43abc868a0f1f8b6cb1a2ecefca7274f11d0be6578f035e7e1400
 SHA512:
-  metadata.gz: 351a846e41802b033bb217d3a574a5a8a18633cc51845313d15ef41220c036a92d068a6959fde5eea4fb25b8586974baf6e02ea62369342d911de5023bcc0863
-  data.tar.gz: ebbf67d572a03b463b40e0e359446fd1e76d64ad4a0200556ffb78a425130aebf0876c23b0090e9770c9b6921a0e370d22d9e11520ad875b12b59d95671d4e2b
+  metadata.gz: 7985e2e04988415a4435d25b233d4515256ca7c352fe9a2df9038d912e8448f1bc26ac582de28f7d39400936165856b31c4a914e7a872ea999dd53ed5debf1dc
+  data.tar.gz: 5a684bf24de1bcc0a8d2fc85b34a335c33c997f747787b02d870b8b5b0b19b87200d362d804752865377b75ec21352a8bd4fc655bf95d95e5d6f16628fb22e05

data/config_skeleton.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
   s.name = "config_skeleton"
 
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.platform = Gem::Platform::RUBY
 
   s.summary  = "Dynamically generate configs and reload servers"
 
-  s.authors  = ["Matt Palmer"]
-  s.email    = ["matt.palmer@discourse.org"]
+  s.authors  = ["Matt Palmer", "Discourse Team"]
+  s.email    = ["matt.palmer@discourse.org", "team@discourse.org"]
   s.homepage = "https://github.com/discourse/config_skeleton"
 
   s.files = `git ls-files -z`.split("\0").reject { |f| f =~ /^(G|spec|Rakefile)/ }

data/lib/config_skeleton.rb

@@ -5,6 +5,7 @@ require 'logger'
 require 'rb-inotify'
 require 'service_skeleton'
 require 'tempfile'
+require 'digest/md5'
 
 # Framework for creating config generation systems.
 #
@@ -23,8 +24,7 @@ require 'tempfile'
 #
 # 1. Implement service-specific config generation and reloading code, by
 #    overriding the private methods #config_file, #config_data, and #reload_server
-#    (and also potentially #config_ok?, #sleep_duration, #before_regenerate_config, and
-#    #after_regenerate_config).
+#    (and also potentially #config_ok?, #sleep_duration, #before_regenerate_config, and #after_regenerate_config).
 #    See the documentation for those methods for what they need to do.
 #
 # 1. Setup any file watchers you want with .watch and #watch.
@@ -366,16 +366,23 @@ class ConfigSkeleton < ServiceSkeleton
   # Run code before the config is regenerated and the config_file
   # is written.
   #
+  # @param force_reload [Boolean] Whether the regenerate_config was called with force_reload
+  # @param existing_config_hash [String] MD5 hash of the config file before regeneration.
+  #
   # @note this can optionally be implemented by subclasses.
   #
-  def before_regenerate_config(force_reload); end
+  def before_regenerate_config(force_reload:, existing_config_hash:); end
 
-  # Run code after the config is regenerated and if the regeneration
-  # was forced the new config has been cycled in.
+  # Run code after the config is regenerated and potentially a new file is written.
+  #
+  # @param force_reload [Boolean] Whether the regenerate_config was called with force_reload
+  # @param config_was_different [Boolean] Whether the diff of the old and new config was different.
+  # @param config_was_cycled [Boolean] Whether a new config file was cycled in.
+  # @param new_config_hash [String] MD5 hash of the new config file after write.
   #
   # @note this can optionally be implemented by subclasses.
   #
-  def after_regenerate_config(force_reload); end
+  def after_regenerate_config(force_reload:, config_was_different:, config_was_cycled:, new_config_hash:); end
 
   # Verify that the currently running config is acceptable.
   #
@@ -458,7 +465,8 @@ class ConfigSkeleton < ServiceSkeleton
   # @return [void]
   #
   def regenerate_config(force_reload: false)
-    before_regenerate_config(force_reload)
+    existing_config_hash = Digest::MD5.hexdigest(File.read(config_file))
+    before_regenerate_config(force_reload: force_reload, existing_config_hash: existing_config_hash)
 
     logger.debug(logloc) { "force? #{force_reload.inspect}" }
     tmpfile = Tempfile.new(service_name, File.dirname(config_file))
@@ -466,25 +474,38 @@ class ConfigSkeleton < ServiceSkeleton
     unless (new_config = instrumented_config_data).nil?
       File.write(tmpfile.path, new_config)
       tmpfile.close
-      logger.debug(logloc) { require 'digest/md5'; "Existing config hash: #{Digest::MD5.hexdigest(File.read(config_file))}, new config hash: #{Digest::MD5.hexdigest(File.read(tmpfile.path))}" }
+
+      new_config_hash = Digest::MD5.hexdigest(File.read(tmpfile.path))
+      logger.debug(logloc) do
+        "Existing config hash: #{existing_config_hash}, new config hash: #{new_config_hash}"
+      end
 
       match_perms(config_file, tmpfile.path)
 
-      diff = Diffy::Diff.new(config_file, tmpfile.path, source: 'files', context: 3, include_diff_info: true)
-      if diff.to_s != ""
-        logger.info(logloc) { "Config has changed.  Diff:\n#{diff.to_s}" }
+      diff = Diffy::Diff.new(config_file, tmpfile.path, source: 'files', context: 3, include_diff_info: true).to_s
+      config_was_different = diff != ""
+
+      if config_was_different
+        logger.info(logloc) { "Config has changed.  Diff:\n#{diff}" }
       end
 
       if force_reload
         logger.debug(logloc) { "Forcing config reload because force_reload == true" }
       end
 
-      if force_reload || diff.to_s != ""
+      config_was_cycled = false
+      if force_reload || config_was_different
         cycle_config(tmpfile.path)
+        config_was_cycled = true
       end
     end
 
-    after_regenerate_config(force_reload)
+    after_regenerate_config(
+      force_reload: force_reload,
+      config_was_different: config_was_different,
+      config_was_cycled: config_was_cycled,
+      new_config_hash: new_config_hash
+    )
   ensure
     metrics.last_change_timestamp.set({}, File.stat(config_file).mtime.to_f)
     tmpfile.close rescue nil

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: config_skeleton
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Matt Palmer
+- Discourse Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-27 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -195,6 +196,7 @@ dependencies:
 description: 
 email:
 - matt.palmer@discourse.org
+- team@discourse.org
 executables: []
 extensions: []
 extra_rdoc_files: []