ldclient-rb 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f3d50fce0854f03fc54889c382dff25d1bc7f07
-  data.tar.gz: 51dfad8e56e09fa7da457d55863223b3a64cd9f6
+  metadata.gz: 41869ab263a2b79a395f296f5bdc0be3ff7c6be5
+  data.tar.gz: 180e6a5ca71016e6776a1b3f484824a604b3cbfb
 SHA512:
-  metadata.gz: d3e036b4cf2ff3c032e3260be2fa73bb22c4ef0dc79467a8c877713d388b139ef4f76f3c5b666fdc0acf8455f909ef8b38b729d2950edb309fa8ee5d7db6ea30
-  data.tar.gz: 5d16aa332570cd295243e4ba507bfc99cbf8f30e12bca72d96767050d9ebfc3a16545bc118c0e8a36535dce447c81228913f536661d7f20c49be6aa270180dd0
+  metadata.gz: b9301b40618e1fd75e1edefcafc2207da147af8ad0ca03e2b945c2e623675cc88c1ad1d62672730aaf1a4f7f8a25a48e0577b8a6037d18cde486d4289b418c69
+  data.tar.gz: 94a9e852962fcdaf98f2a90b257c06ef3107fd59882d8e92e1ae44fc4239b4f1e37a8875ebaa7c14bafa0e33d453c118b8dca4aa734164496ac608e3f21f1258

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to the LaunchDarkly Ruby SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [3.0.2] - 2018-03-06
+## Fixed
+- Improved efficiency of logging by not constructing messages that won't be visible at the current log level. (Thanks, [julik](https://github.com/launchdarkly/ruby-client/pull/98)!)
+
+
 ## [3.0.1] - 2018-02-26
 ### Fixed
 - Fixed a bug that could prevent very large feature flags from being updated in streaming mode.

data/lib/ldclient-rb/evaluation.rb

@@ -156,7 +156,7 @@ module LaunchDarkly
               failed_prereq = true
             end
           rescue => exn
-            @config.logger.error("[LDClient] Error evaluating prerequisite: #{exn.inspect}")
+            @config.logger.error { "[LDClient] Error evaluating prerequisite: #{exn.inspect}" }
             failed_prereq = true
           end
         end

data/lib/ldclient-rb/events.rb

@@ -50,9 +50,9 @@ module LaunchDarkly
         req.options.open_timeout = @config.connect_timeout
       end
       if res.status < 200 || res.status >= 300
-        @config.logger.error("[LDClient] Unexpected status code while processing events: #{res.status}")
+        @config.logger.error { "[LDClient] Unexpected status code while processing events: #{res.status}" }
         if res.status == 401
-          @config.logger.error("[LDClient] Received 401 error, no further events will be posted since SDK key is invalid")
+          @config.logger.error { "[LDClient] Received 401 error, no further events will be posted since SDK key is invalid" }
           stop
         end
       end
@@ -78,14 +78,14 @@ module LaunchDarkly
 
       if @queue.length < @config.capacity
         event[:creationDate] = (Time.now.to_f * 1000).to_i
-        @config.logger.debug("[LDClient] Enqueueing event: #{event.to_json}")
+        @config.logger.debug { "[LDClient] Enqueueing event: #{event.to_json}" }
         @queue.push(event)
 
         if !@worker.alive?
           @worker = create_worker
         end
       else
-        @config.logger.warn("[LDClient] Exceeded event queue capacity. Increase capacity to avoid dropping events.")
+        @config.logger.warn { "[LDClient] Exceeded event queue capacity. Increase capacity to avoid dropping events." }
       end
     end
 

data/lib/ldclient-rb/ldclient.rb

@@ -31,7 +31,7 @@ module LaunchDarkly
       @event_processor = EventProcessor.new(sdk_key, config)
 
       if @config.use_ldd?
-        @config.logger.info("[LDClient] Started LaunchDarkly Client in LDD mode")
+        @config.logger.info { "[LDClient] Started LaunchDarkly Client in LDD mode" }
         return  # requestor and update processor are not used in this mode
       end
 
@@ -41,8 +41,8 @@ module LaunchDarkly
         if @config.stream?
           @update_processor = StreamProcessor.new(sdk_key, config, requestor)
         else
-          @config.logger.info("Disabling streaming API")
-          @config.logger.warn("You should only disable the streaming API if instructed to do so by LaunchDarkly support")
+          @config.logger.info { "Disabling streaming API" }
+          @config.logger.warn { "You should only disable the streaming API if instructed to do so by LaunchDarkly support" }
           @update_processor = PollingProcessor.new(config, requestor)
         end
         @update_processor.start
@@ -54,7 +54,7 @@ module LaunchDarkly
             initialized?
           end
         rescue WaitUtil::TimeoutError
-          @config.logger.error("[LDClient] Timeout encountered waiting for LaunchDarkly client initialization")
+          @config.logger.error { "[LDClient] Timeout encountered waiting for LaunchDarkly client initialization" }
         end
       end
     end
@@ -64,7 +64,7 @@ module LaunchDarkly
     end
 
     def toggle?(key, user, default = False)
-      @config.logger.warn("[LDClient] toggle? is deprecated. Use variation instead")
+      @config.logger.warn { "[LDClient] toggle? is deprecated. Use variation instead" }
       variation(key, user, default)
     end
 
@@ -114,16 +114,16 @@ module LaunchDarkly
       return default if @config.offline?
 
       unless user
-        @config.logger.error("[LDClient] Must specify user")
+        @config.logger.error { "[LDClient] Must specify user" }
         @event_processor.add_event(kind: "feature", key: key, value: default, default: default, user: user)
         return default
       end
 
       if !initialized?
         if @store.initialized?
-          @config.logger.warn("[LDClient] Client has not finished initializing; using last known values from feature store")
+          @config.logger.warn { "[LDClient] Client has not finished initializing; using last known values from feature store" }
         else
-          @config.logger.error("[LDClient] Client has not finished initializing; feature store unavailable, returning default value")
+          @config.logger.error { "[LDClient] Client has not finished initializing; feature store unavailable, returning default value" }
           @event_processor.add_event(kind: "feature", key: key, value: default, default: default, user: user)
           return default
         end
@@ -133,7 +133,7 @@ module LaunchDarkly
       feature = @store.get(FEATURES, key)
 
       if feature.nil?
-        @config.logger.info("[LDClient] Unknown feature flag #{key}. Returning default value")
+        @config.logger.info { "[LDClient] Unknown feature flag #{key}. Returning default value" }
         @event_processor.add_event(kind: "feature", key: key, value: default, default: default, user: user)
         return default
       end
@@ -149,12 +149,12 @@ module LaunchDarkly
           @event_processor.add_event(kind: "feature", key: key, user: user, value: res[:value], default: default, version: feature[:version])
           return res[:value]
         else
-          @config.logger.debug("[LDClient] Result value is null in toggle")
+          @config.logger.debug { "[LDClient] Result value is null in toggle" }
           @event_processor.add_event(kind: "feature", key: key, user: user, value: default, default: default, version: feature[:version])
           return default
         end
       rescue => exn
-        @config.logger.warn("[LDClient] Error evaluating feature flag: #{exn.inspect}. \nTrace: #{exn.backtrace}")
+        @config.logger.warn { "[LDClient] Error evaluating feature flag: #{exn.inspect}. \nTrace: #{exn.backtrace}" }
         @event_processor.add_event(kind: "feature", key: key, user: user, value: default, default: default, version: feature[:version])
         return default
       end
@@ -192,7 +192,7 @@ module LaunchDarkly
       return Hash.new if @config.offline?
 
       unless user
-        @config.logger.error("[LDClient] Must specify user in all_flags")
+        @config.logger.error { "[LDClient] Must specify user in all_flags" }
         return Hash.new
       end
 
@@ -202,7 +202,7 @@ module LaunchDarkly
         # TODO rescue if necessary
         Hash[features.map{ |k, f| [k, evaluate(f, user, @store)[:value]] }]
       rescue => exn
-        @config.logger.warn("[LDClient] Error evaluating all flags: #{exn.inspect}. \nTrace: #{exn.backtrace}")
+        @config.logger.warn { "[LDClient] Error evaluating all flags: #{exn.inspect}. \nTrace: #{exn.backtrace}" }
         return Hash.new
       end
     end
@@ -212,7 +212,7 @@ module LaunchDarkly
     #
     # @return [void]
     def close
-      @config.logger.info("[LDClient] Closing LaunchDarkly client...")
+      @config.logger.info { "[LDClient] Closing LaunchDarkly client..." }
       if not @config.offline?
         @update_processor.stop
       end
@@ -223,7 +223,7 @@ module LaunchDarkly
     def log_exception(caller, exn)
       error_traceback = "#{exn.inspect} #{exn}\n\t#{exn.backtrace.join("\n\t")}"
       error = "[LDClient] Unexpected exception in #{caller}: #{error_traceback}"
-      @config.logger.error(error)
+      @config.logger.error { error }
     end
 
     def sanitize_user(user)

data/lib/ldclient-rb/polling.rb

@@ -17,7 +17,7 @@ module LaunchDarkly
 
     def start
       return unless @started.make_true
-      @config.logger.info("[LDClient] Initializing polling connection")
+      @config.logger.info { "[LDClient] Initializing polling connection" }
       create_worker
     end
 
@@ -26,7 +26,7 @@ module LaunchDarkly
         if @worker && @worker.alive?
           @worker.raise "shutting down client"
         end
-        @config.logger.info("[LDClient] Polling connection stopped")
+        @config.logger.info { "[LDClient] Polling connection stopped" }
       end
     end
 
@@ -38,14 +38,14 @@ module LaunchDarkly
           SEGMENTS => all_data[:segments]
         })
         if @initialized.make_true
-          @config.logger.info("[LDClient] Polling connection initialized")
+          @config.logger.info { "[LDClient] Polling connection initialized" }
         end
       end
     end
 
     def create_worker
       @worker = Thread.new do
-        @config.logger.debug("[LDClient] Starting polling worker")
+        @config.logger.debug { "[LDClient] Starting polling worker" }
         while !@stopped.value do
           begin
             started_at = Time.now
@@ -55,10 +55,10 @@ module LaunchDarkly
               sleep(delta)
             end
           rescue InvalidSDKKeyError
-            @config.logger.error("[LDClient] Received 401 error, no further polling requests will be made since SDK key is invalid");
+            @config.logger.error { "[LDClient] Received 401 error, no further polling requests will be made since SDK key is invalid" };
             stop
           rescue StandardError => exn
-            @config.logger.error("[LDClient] Exception while polling: #{exn.inspect}")
+            @config.logger.error { "[LDClient] Exception while polling: #{exn.inspect}" }
             # TODO: log_exception(__method__.to_s, exn)
           end
         end

data/lib/ldclient-rb/redis_store.rb

@@ -94,12 +94,12 @@ and prefix: #{@prefix}")
     def get(kind, key)
       f = @cache[cache_key(kind, key)]
       if f.nil?
-        @logger.debug("RedisFeatureStore: no cache hit for #{key} in '#{kind[:namespace]}', requesting from Redis")
+        @logger.debug { "RedisFeatureStore: no cache hit for #{key} in '#{kind[:namespace]}', requesting from Redis" }
         f = with_connection do |redis|
           begin
             get_redis(kind, redis, key.to_sym)
           rescue => e
-            @logger.error("RedisFeatureStore: could not retrieve #{key} from Redis in '#{kind[:namespace]}', with error: #{e}")
+            @logger.error { "RedisFeatureStore: could not retrieve #{key} from Redis in '#{kind[:namespace]}', with error: #{e}" }
             nil
           end
         end
@@ -108,10 +108,10 @@ and prefix: #{@prefix}")
         end
       end
       if f.nil?
-        @logger.debug("RedisFeatureStore: #{key} not found in '#{kind[:namespace]}'")
+        @logger.debug { "RedisFeatureStore: #{key} not found in '#{kind[:namespace]}'" }
         nil
       elsif f[:deleted]
-        @logger.debug("RedisFeatureStore: #{key} was deleted in '#{kind[:namespace]}', returning nil")
+        @logger.debug { "RedisFeatureStore: #{key} was deleted in '#{kind[:namespace]}', returning nil" }
         nil
       else
         f
@@ -124,7 +124,7 @@ and prefix: #{@prefix}")
         begin
           hashfs = redis.hgetall(items_key(kind))
         rescue => e
-          @logger.error("RedisFeatureStore: could not retrieve all '#{kind[:namespace]}' items from Redis with error: #{e}; returning none")
+          @logger.error { "RedisFeatureStore: could not retrieve all '#{kind[:namespace]}' items from Redis with error: #{e}; returning none" }
           hashfs = {}
         end
         hashfs.each do |k, jsonItem|
@@ -169,7 +169,7 @@ and prefix: #{@prefix}")
         end
       end
       @inited.set(true)
-      @logger.info("RedisFeatureStore: initialized with #{count} items")
+      @logger.info { "RedisFeatureStore: initialized with #{count} items" }
     end
 
     def upsert(kind, item)
@@ -219,7 +219,7 @@ and prefix: #{@prefix}")
         json_item = redis.hget(items_key(kind), key)
         JSON.parse(json_item, symbolize_names: true) if json_item
       rescue => e
-        @logger.error("RedisFeatureStore: could not retrieve #{key} from Redis, error: #{e}")
+        @logger.error { "RedisFeatureStore: could not retrieve #{key} from Redis, error: #{e}" }
         nil
       end
     end
@@ -232,7 +232,7 @@ and prefix: #{@prefix}")
       begin
         redis.hset(items_key(kind), key, item.to_json)
       rescue => e
-        @logger.error("RedisFeatureStore: could not store #{key} in Redis, error: #{e}")
+        @logger.error { "RedisFeatureStore: could not store #{key} in Redis, error: #{e}" }
       end
       put_cache(kind, key.to_sym, item)
     end

data/lib/ldclient-rb/requestor.rb

@@ -42,20 +42,20 @@ module LaunchDarkly
         end
       end
 
-      @config.logger.debug("[LDClient] Got response from uri: #{uri}\n\tstatus code: #{res.status}\n\theaders: #{res.headers}\n\tbody: #{res.body}")
+      @config.logger.debug { "[LDClient] Got response from uri: #{uri}\n\tstatus code: #{res.status}\n\theaders: #{res.headers}\n\tbody: #{res.body}" }
 
       if res.status == 401
-        @config.logger.error("[LDClient] Invalid SDK key")
+        @config.logger.error { "[LDClient] Invalid SDK key" }
         raise InvalidSDKKeyError
       end
 
       if res.status == 404
-        @config.logger.error("[LDClient] Resource not found")
+        @config.logger.error { "[LDClient] Resource not found" }
         return nil
       end
 
       if res.status < 200 || res.status >= 300
-        @config.logger.error("[LDClient] Unexpected status code #{res.status}")
+        @config.logger.error { "[LDClient] Unexpected status code #{res.status}" }
         return nil
       end
 

data/lib/ldclient-rb/stream.rb

@@ -33,7 +33,7 @@ module LaunchDarkly
     def start
       return unless @started.make_true
 
-      @config.logger.info("[LDClient] Initializing stream connection")
+      @config.logger.info { "[LDClient] Initializing stream connection" }
       
       headers = 
       {
@@ -48,9 +48,9 @@ module LaunchDarkly
         conn.on(INDIRECT_PUT) { |message| process_message(message, INDIRECT_PUT) }
         conn.on(INDIRECT_PATCH) { |message| process_message(message, INDIRECT_PATCH) }
         conn.on_error { |err|
-          @config.logger.error("[LDClient] Unexpected status code #{err[:status_code]} from streaming connection")
+          @config.logger.error { "[LDClient] Unexpected status code #{err[:status_code]} from streaming connection" }
           if err[:status_code] == 401
-            @config.logger.error("[LDClient] Received 401 error, no further streaming connection will be made since SDK key is invalid")
+            @config.logger.error { "[LDClient] Received 401 error, no further streaming connection will be made since SDK key is invalid" }
             stop
           end
         }
@@ -60,21 +60,21 @@ module LaunchDarkly
     def stop
       if @stopped.make_true
         @es.close
-        @config.logger.info("[LDClient] Stream connection stopped")
+        @config.logger.info { "[LDClient] Stream connection stopped" }
       end
     end
 
     def stop
       if @stopped.make_true
         @es.close
-        @config.logger.info("[LDClient] Stream connection stopped")
+        @config.logger.info { "[LDClient] Stream connection stopped" }
       end
     end
 
     private
 
     def process_message(message, method)
-      @config.logger.debug("[LDClient] Stream received #{method} message: #{message.data}")
+      @config.logger.debug { "[LDClient] Stream received #{method} message: #{message.data}" }
       if method == PUT
         message = JSON.parse(message.data, symbolize_names: true)
         @feature_store.init({
@@ -82,7 +82,7 @@ module LaunchDarkly
           SEGMENTS => message[:data][:segments]
         })
         @initialized.make_true
-        @config.logger.info("[LDClient] Stream initialized")
+        @config.logger.info { "[LDClient] Stream initialized" }
       elsif method == PATCH
         message = JSON.parse(message.data, symbolize_names: true)
         for kind in [FEATURES, SEGMENTS]
@@ -108,7 +108,7 @@ module LaunchDarkly
           SEGMENTS => all_data[:segments]
         })
         @initialized.make_true
-        @config.logger.info("[LDClient] Stream initialized (via indirect message)")
+        @config.logger.info { "[LDClient] Stream initialized (via indirect message)" }
       elsif method == INDIRECT_PATCH
         key = key_for_path(FEATURES, message.data)
         if key
@@ -120,7 +120,7 @@ module LaunchDarkly
           end
         end
       else
-        @config.logger.warn("[LDClient] Unknown message received: #{method}")
+        @config.logger.warn { "[LDClient] Unknown message received: #{method}" }
       end
     end
 

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "3.0.1"
+  VERSION = "3.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ldclient-rb
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler