zk_recipes 0.2.0.pre1 → 0.2.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7750ecfcae437bf16df6dfbd4d23b769907f3209
-  data.tar.gz: ed8c8aef2d4cbe07cb669dd461230441c2537c8f
+  metadata.gz: 0b8809248fbdaf59b179335291fb0dbd4c720a5d
+  data.tar.gz: 94272b92ac88c8f58370d3d6e9f4a8d8ce2df2c3
 SHA512:
-  metadata.gz: 0c990d65e803782d5465e7bca85a877b3070dbff66086e70dbf6d7d6cbdf5fb6f356ee776f1d714d00d0ea07bc028a9c8f1a2ea54331090e46ea40f868101277
-  data.tar.gz: f25b27483c6a0d9f354694452d8304b20b54e928d9ad435904e829dbcd21907113d3122049a14c1f3266de5f048cbfec86969047bd8f8894d96ba266f1cc145f
+  metadata.gz: efb4cd174c22e51ea51258de0e25a3b34b97ac9ae1e779798f38023bd326fdd314571c95e7b3bbd0caaede333d2e77018c9f8be1f4b16dd3d678d6fc50501707
+  data.tar.gz: ada75f39f7481da1daa5fed9dcd5b9e2de7615befc8c59045e11893bb7bc690097452f5ae5b788a65ce87789a25690888764d07cfa8df6c71ed42bdf98001dfb

data/CHANGELOG.md

@@ -2,8 +2,9 @@
 
 ## 0.2.0
 
-BREAKING CHANGES
+This version includes BREAKING CHANGES. See below
 
+- cleanup logging
 - Make `on_connected` lighter: `on_connected` gets called for every watch when
   a connection flaps. Make the happy path `on_connected` faster.
 - Add `ZkRecipes::Cache#reopen` for resetting the cache after a `fork`

data/lib/zk_recipes/cache.rb

@@ -37,7 +37,7 @@ module ZkRecipes
     def register(path, default_value, &block)
       raise Error, "register only allowed before setup_callbacks called" unless @registerable
 
-      debug("added path=#{path} default_value=#{default_value.inspect}")
+      debug { "added path=#{path} default_value=#{default_value.inspect}" }
       @cache[path] = CachedPath.new(default_value)
       @registered_values[path] = RegisteredPath.new(default_value, block)
       ActiveSupport::Notifications.instrument(AS_NOTIFICATION, path: path, value: default_value)
@@ -55,13 +55,13 @@ module ZkRecipes
       @registered_values.each do |path, _value|
         @watches[path] = @zk.register(path) do |event|
           if event.node_event?
-            debug("node event=#{event.inspect} #{event.event_name} #{event.state_name}")
+            debug("node event path=#{event.path} #{event.event_name} #{event.state_name}")
             unless update_cache(event.path)
               @pending_updates[path] = nil
               @zk.defer { process_pending_updates }
             end
           else
-            warn("session event=#{event.inspect}")
+            warn("session event #{event.event_name} #{event.state_name}")
           end
         end
       end
@@ -87,11 +87,11 @@ module ZkRecipes
     end
 
     def wait_for_warm_cache(timeout = 30)
-      debug("waiting for cache to warm timeout=#{timeout}")
+      debug("waiting for cache to warm timeout=#{timeout.inspect}")
       if @latch.wait(timeout)
         true
       else
-        warn("didn't warm cache before timeout connected=#{@zk.connected?} timeout=#{timeout}")
+        warn("didn't warm cache before timeout connected=#{@zk.connected?} timeout=#{timeout.inspect}")
         false
       end
     end
@@ -143,8 +143,6 @@ module ZkRecipes
 
     # only called from ZK thread
     def update_cache(path)
-      debug("update_cache path=#{path}")
-
       stat = @zk.stat(path, watch: true)
 
       instrument_params = { path: path }
@@ -168,10 +166,7 @@ module ZkRecipes
         registered_value = @registered_values.fetch(path)
         instrument_params[:value] = registered_value.deserialize(raw_value)
       rescue => e
-        error(
-          "deserialization error raw_zookeeper_value=#{raw_value.inspect} zookeeper_stat=#{stat.inspect} "\
-          "exception=#{e.inspect} #{e.backtrace.inspect}"
-        )
+        error("deserialization error path=#{path} stat=#{stat.inspect} exception=#{e.inspect} #{e.backtrace.inspect}")
         instrument_params[:error] = e
         instrument_params[:raw_value] = raw_value
         registered_value.default_value
@@ -180,11 +175,8 @@ module ZkRecipes
       # TODO if there is a deserialization error, do we want to indicate that on the CachedPath?
       @cache[path] = CachedPath.new(value, stat)
 
-      debug(
-        "updated cache path=#{path} raw_value=#{raw_value.inspect} "\
-        "value=#{value.inspect} stat=#{stat.inspect}"
-      )
       ActiveSupport::Notifications.instrument(AS_NOTIFICATION, instrument_params)
+      debug { "update_cache path=#{path} raw_value=#{raw_value.inspect} value=#{value.inspect} stat=#{stat.inspect}" }
       true
     rescue ::ZK::Exceptions::ZKError => e
       warn("update_cache path=#{path} exception=#{e.inspect}, retrying")
@@ -196,19 +188,17 @@ module ZkRecipes
 
     def process_pending_updates
       return if @pending_updates.empty?
-      info("processing pending updates=#{@pending_updates.size}")
+      debug("processing pending updates=#{@pending_updates.size}")
       @pending_updates.reject! do |missed_path, _|
-        debug("update_cache with previously missed update path=#{missed_path}")
         update_cache(missed_path)
       end
-      info("pending updates not processed=#{@pending_updates.size}")
     end
 
     %w(debug info warn error).each do |m|
       module_eval <<~EOM, __FILE__, __LINE__
-        def #{m}(msg)
+        def #{m}(msg = nil)
           return unless @logger
-          @logger.#{m}("ZkRecipes::Cache") { msg }
+          @logger.#{m}("ZkRecipes::Cache") { msg || yield }
         end
       EOM
     end

data/lib/zk_recipes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZkRecipes
-  VERSION = "0.2.0.pre1"
+  VERSION = "0.2.0.pre2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zk_recipes
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre1
+  version: 0.2.0.pre2
 platform: ruby
 authors:
 - Andrew Lazarus