ldclient-rb 5.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a11c0c98ebb0903ef634be9bab4779e88fac992
-  data.tar.gz: 6248ed0604ba3ef0c4c7a871d7803d4fec026c9a
+  metadata.gz: 6a6cfa6490a0f46a455e7d65cbb9cdab695692e3
+  data.tar.gz: 6a749bb22220adfde7323876fa7174e50da15e70
 SHA512:
-  metadata.gz: 0dd10cb337613fb44efb0492090ecedc08bdae9c279ce05af2578cdcbd199b20c7b2d314e7d6e31ce8b09c092e74ffb9187b011d5a76672c20a6ad760db445b7
-  data.tar.gz: 4105be290c1951b38d569cea473422ad5178a7ddab511e9df7accf2e1ef7d9ee60d6d3774063278f2cb45ae3aba831dc95aba62503d4acb21ac4af0f182a6620
+  metadata.gz: f05eb914183f31142ef03bbad0319dda44cd25cbbd2723619aca74ba70f6e2a2043db40da35480da65c5ac64bd6bc6a08afb3b8379787c58e51a7a8ed6fed9c8
+  data.tar.gz: 53d7974ab225003f95e9fe636dff25b30c706873a13b4a1e24a33914f309ab66a8bce7438fd2382b43afc4e1ca8cc159e6b640b7cf0733ebd62c361aa42d11e2

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 All notable changes to the LaunchDarkly Ruby SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [5.1.0] - 2018-08-27
+### Added:
+- The new `LDClient` method `all_flags_state()` should be used instead of `all_flags()` if you are passing flag data to the front end for use with the JavaScript SDK. It preserves some flag metadata that the front end requires in order to send analytics events correctly. Versions 2.5.0 and above of the JavaScript SDK are able to use this metadata, but the output of `all_flags_state()` will still work with older versions.
+- The `all_flags_state()` method also allows you to select only client-side-enabled flags to pass to the front end, by using the option `client_side_only: true`.
+
+### Changed:
+- Unexpected exceptions are now logged at `ERROR` level, and exception stacktraces at `DEBUG` level. Previously, both were being logged at `WARN` level.
+
+### Deprecated:
+- `LDClient.all_flags()`
+
+
+## [5.1.0] - 2018-08-27
+### Added:
+- The new `LDClient` method `all_flags_state()` should be used instead of `all_flags()` if you are passing flag data to the front end for use with the JavaScript SDK. It preserves some flag metadata that the front end requires in order to send analytics events correctly. Versions 2.5.0 and above of the JavaScript SDK are able to use this metadata, but the output of `all_flags_state()` will still work with older versions.
+- The `all_flags_state()` method also allows you to select only client-side-enabled flags to pass to the front end, by using the option `client_side_only: true`.
+
+### Changed:
+- Unexpected exceptions are now logged at `ERROR` level, and exception stacktraces at `DEBUG` level. Previously, both were being logged at `WARN` level.
+
+### Deprecated:
+- `LDClient.all_flags()`
+
+
 ## [5.0.1] - 2018-07-02
 ### Fixed:
 Fixed a regression in version 5.0.0 that could prevent the client from reconnecting if the stream connection was dropped by the server.

data/CODEOWNERS

@@ -1 +1 @@
-* @ashanbrown
+

data/lib/ldclient-rb.rb

@@ -1,6 +1,7 @@
 require "ldclient-rb/version"
 require "ldclient-rb/util"
 require "ldclient-rb/evaluation"
+require "ldclient-rb/flags_state"
 require "ldclient-rb/ldclient"
 require "ldclient-rb/cache_store"
 require "ldclient-rb/expiring_cache"

data/lib/ldclient-rb/events.rb

@@ -142,7 +142,7 @@ module LaunchDarkly
             message.completed
           end
         rescue => e
-          @config.logger.warn { "[LDClient] Unexpected error in event processor: #{e.inspect}. \nTrace: #{e.backtrace}" }
+          Util.log_exception(@config.logger, "Unexpected error in event processor", e)
         end
       end
     end
@@ -226,7 +226,7 @@ module LaunchDarkly
             resp = EventPayloadSendTask.new.run(@sdk_key, @config, @client, payload, @formatter)
             handle_response(resp) if !resp.nil?
           rescue => e
-            @config.logger.warn { "[LDClient] Unexpected error in event processor: #{e.inspect}. \nTrace: #{e.backtrace}" }
+            Util.log_exception(@config.logger, "Unexpected error in event processor", e)
           end
         end
         buffer.clear if success # Reset our internal state, these events now belong to the flush worker

data/lib/ldclient-rb/flags_state.rb

@@ -0,0 +1,66 @@
+require 'json'
+
+module LaunchDarkly
+  #
+  # A snapshot of the state of all feature flags with regard to a specific user, generated by
+  # calling the client's all_flags_state method. Serializing this object to JSON using
+  # JSON.generate (or the to_json method) will produce the appropriate data structure for
+  # bootstrapping the LaunchDarkly JavaScript client.
+  #
+  class FeatureFlagsState
+    def initialize(valid)
+      @flag_values = {}
+      @flag_metadata = {}
+      @valid = valid
+    end
+
+    # Used internally to build the state map.
+    def add_flag(flag, value, variation)
+      key = flag[:key]
+      @flag_values[key] = value
+      meta = { version: flag[:version], trackEvents: flag[:trackEvents] }
+      meta[:variation] = variation if !variation.nil?
+      meta[:debugEventsUntilDate] = flag[:debugEventsUntilDate] if flag[:debugEventsUntilDate]
+      @flag_metadata[key] = meta
+    end
+
+    # Returns true if this object contains a valid snapshot of feature flag state, or false if the
+    # state could not be computed (for instance, because the client was offline or there was no user).
+    def valid?
+      @valid
+    end
+
+    # Returns the value of an individual feature flag at the time the state was recorded.
+    # Returns nil if the flag returned the default value, or if there was no such flag.
+    def flag_value(key)
+      @flag_values[key]
+    end
+
+    # Returns a map of flag keys to flag values. If a flag would have evaluated to the default value,
+    # its value will be nil.
+    #
+    # Do not use this method if you are passing data to the front end to "bootstrap" the JavaScript client.
+    # Instead, use as_json.
+    def values_map
+      @flag_values
+    end
+
+    # Returns a hash that can be used as a JSON representation of the entire state map, in the format
+    # used by the LaunchDarkly JavaScript SDK. Use this method if you are passing data to the front end
+    # in order to "bootstrap" the JavaScript client.
+    #
+    # Do not rely on the exact shape of this data, as it may change in future to support the needs of
+    # the JavaScript client.
+    def as_json(*) # parameter is unused, but may be passed if we're using the json gem
+      ret = @flag_values.clone
+      ret['$flagsState'] = @flag_metadata
+      ret['$valid'] = @valid
+      ret
+    end
+
+    # Same as as_json, but converts the JSON structure into a string.
+    def to_json(*a)
+      as_json.to_json(a)
+    end
+  end
+end

data/lib/ldclient-rb/ldclient.rb

@@ -162,7 +162,7 @@ module LaunchDarkly
         @event_processor.add_event(make_feature_event(feature, user, res[:variation], value, default))
         return value
       rescue => exn
-        @config.logger.warn { "[LDClient] Error evaluating feature flag: #{exn.inspect}. \nTrace: #{exn.backtrace}" }
+        Util.log_exception(@config.logger, "Error evaluating feature flag", exn)
         @event_processor.add_event(make_feature_event(feature, user, nil, default, default))
         return default
       end
@@ -193,26 +193,61 @@ module LaunchDarkly
     end
 
     #
-    # Returns all feature flag values for the given user
+    # Returns all feature flag values for the given user. This method is deprecated - please use
+    # {#all_flags_state} instead. Current versions of the client-side SDK will not generate analytics
+    # events correctly if you pass the result of all_flags.
+    #
+    # @param user [Hash] The end user requesting the feature flags
+    # @return [Hash] a hash of feature flag keys to values
     #
     def all_flags(user)
-      sanitize_user(user)
-      return Hash.new if @config.offline?
+      all_flags_state(user).values_map
+    end
 
-      unless user
-        @config.logger.error { "[LDClient] Must specify user in all_flags" }
-        return Hash.new
+    #
+    # Returns a FeatureFlagsState object that encapsulates the state of all feature flags for a given user,
+    # including the flag values and also metadata that can be used on the front end. This method does not
+    # send analytics events back to LaunchDarkly.
+    #
+    # @param user [Hash] The end user requesting the feature flags
+    # @param options={} [Hash] Optional parameters to control how the state is generated
+    # @option options [Boolean] :client_side_only (false) True if only flags marked for use with the
+    #   client-side SDK should be included in the state. By default, all flags are included.
+    # @return [FeatureFlagsState] a FeatureFlagsState object which can be serialized to JSON
+    #
+    def all_flags_state(user, options={})
+      return FeatureFlagsState.new(false) if @config.offline?
+
+      unless user && !user[:key].nil?
+        @config.logger.error { "[LDClient] User and user key must be specified in all_flags_state" }
+        return FeatureFlagsState.new(false)
       end
 
+      sanitize_user(user)
+
       begin
         features = @store.all(FEATURES)
-
-        # TODO rescue if necessary
-        Hash[features.map{ |k, f| [k, evaluate(f, user, @store, @config.logger)[:value]] }]
       rescue => exn
-        @config.logger.warn { "[LDClient] Error evaluating all flags: #{exn.inspect}. \nTrace: #{exn.backtrace}" }
-        return Hash.new
+        Util.log_exception(@config.logger, "Unable to read flags for all_flags_state", exn)
+        return FeatureFlagsState.new(false)
       end
+
+      state = FeatureFlagsState.new(true)
+      client_only = options[:client_side_only] || false
+      features.each do |k, f|
+        if client_only && !f[:clientSide]
+          next
+        end
+        begin
+          result = evaluate(f, user, @store, @config.logger)
+          state.add_flag(f, result[:value], result[:variation])
+        rescue => exn
+          Util.log_exception(@config.logger, "Error evaluating flag \"#{k}\" in all_flags_state", exn)
+          state.add_flag(f, nil, nil)
+        end
+      end
+
+      state
     end
 
     #
@@ -226,12 +261,6 @@ module LaunchDarkly
       @store.stop
     end
 
-    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 }
-    end
-
     def sanitize_user(user)
       if user[:key]
         user[:key] = user[:key].to_s
@@ -252,7 +281,7 @@ module LaunchDarkly
       }
     end
 
-    private :evaluate, :log_exception, :sanitize_user, :make_feature_event
+    private :evaluate, :sanitize_user, :make_feature_event
   end
 
   #

data/lib/ldclient-rb/util.rb

@@ -1,6 +1,11 @@
 
 module LaunchDarkly
   module Util
+    def self.log_exception(logger, message, exc)
+      logger.error { "[LDClient] #{message}: #{exc.inspect}" }
+      logger.debug { "[LDClient] Exception trace: #{exc.backtrace}" }
+    end
+
     def self.http_error_recoverable?(status)
       if status >= 400 && status < 500
         status == 400 || status == 408 || status == 429

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "5.0.1"
+  VERSION = "5.1.0"
 end

data/spec/flags_state_spec.rb

@@ -0,0 +1,82 @@
+require "spec_helper"
+require "json"
+
+describe LaunchDarkly::FeatureFlagsState do
+  subject { LaunchDarkly::FeatureFlagsState }
+
+  it "can get flag value" do
+    state = subject.new(true)
+    flag = { key: 'key' }
+    state.add_flag(flag, 'value', 1)
+
+    expect(state.flag_value('key')).to eq 'value'
+  end
+
+  it "returns nil for unknown flag" do
+    state = subject.new(true)
+
+    expect(state.flag_value('key')).to be nil
+  end
+
+  it "can be converted to values map" do
+    state = subject.new(true)
+    flag1 = { key: 'key1' }
+    flag2 = { key: 'key2' }
+    state.add_flag(flag1, 'value1', 0)
+    state.add_flag(flag2, 'value2', 1)
+
+    expect(state.values_map).to eq({ 'key1' => 'value1', 'key2' => 'value2' })
+  end
+
+  it "can be converted to JSON structure" do
+    state = subject.new(true)
+    flag1 = { key: "key1", version: 100, offVariation: 0, variations: [ 'value1' ], trackEvents: false }
+    flag2 = { key: "key2", version: 200, offVariation: 1, variations: [ 'x', 'value2' ], trackEvents: true, debugEventsUntilDate: 1000 }
+    state.add_flag(flag1, 'value1', 0)
+    state.add_flag(flag2, 'value2', 1)
+    
+    result = state.as_json
+    expect(result).to eq({
+      'key1' => 'value1',
+      'key2' => 'value2',
+      '$flagsState' => {
+        'key1' => {
+          :variation => 0,
+          :version => 100,
+          :trackEvents => false
+        },
+        'key2' => {
+          :variation => 1,
+          :version => 200,
+          :trackEvents => true,
+          :debugEventsUntilDate => 1000
+        }
+      },
+      '$valid' => true
+    })
+  end
+
+  it "can be converted to JSON string" do
+    state = subject.new(true)
+    flag1 = { key: "key1", version: 100, offVariation: 0, variations: [ 'value1' ], trackEvents: false }
+    flag2 = { key: "key2", version: 200, offVariation: 1, variations: [ 'x', 'value2' ], trackEvents: true, debugEventsUntilDate: 1000 }
+    state.add_flag(flag1, 'value1', 0)
+    state.add_flag(flag2, 'value2', 1)
+    
+    object = state.as_json
+    str = state.to_json
+    expect(object.to_json).to eq(str)
+  end
+
+  it "uses our custom serializer with JSON.generate" do
+    state = subject.new(true)
+    flag1 = { key: "key1", version: 100, offVariation: 0, variations: [ 'value1' ], trackEvents: false }
+    flag2 = { key: "key2", version: 200, offVariation: 1, variations: [ 'x', 'value2' ], trackEvents: true, debugEventsUntilDate: 1000 }
+    state.add_flag(flag1, 'value1', 0)
+    state.add_flag(flag2, 'value2', 1)
+    
+    stringFromToJson = state.to_json
+    stringFromGenerate = JSON.generate(state)
+    expect(stringFromGenerate).to eq(stringFromToJson)
+  end
+end

data/spec/ldclient_spec.rb

@@ -99,6 +99,114 @@ describe LaunchDarkly::LDClient do
     end
   end
 
+  describe '#all_flags' do
+    let(:flag1) { { key: "key1", offVariation: 0, variations: [ 'value1' ] } }
+    let(:flag2) { { key: "key2", offVariation: 0, variations: [ 'value2' ] } }
+
+    it "returns flag values" do
+      config.feature_store.init({ LaunchDarkly::FEATURES => { 'key1' => flag1, 'key2' => flag2 } })
+
+      result = client.all_flags({ key: 'userkey' })
+      expect(result).to eq({ 'key1' => 'value1', 'key2' => 'value2' })
+    end
+
+    it "returns empty map for nil user" do
+      config.feature_store.init({ LaunchDarkly::FEATURES => { 'key1' => flag1, 'key2' => flag2 } })
+
+      result = client.all_flags(nil)
+      expect(result).to eq({})
+    end
+
+    it "returns empty map for nil user key" do
+      config.feature_store.init({ LaunchDarkly::FEATURES => { 'key1' => flag1, 'key2' => flag2 } })
+
+      result = client.all_flags({})
+      expect(result).to eq({})
+    end
+
+    it "returns empty map if offline" do
+      offline_config.feature_store.init({ LaunchDarkly::FEATURES => { 'key1' => flag1, 'key2' => flag2 } })
+
+      result = offline_client.all_flags(nil)
+      expect(result).to eq({})
+    end
+  end
+
+  describe '#all_flags_state' do
+    let(:flag1) { { key: "key1", version: 100, offVariation: 0, variations: [ 'value1' ], trackEvents: false } }
+    let(:flag2) { { key: "key2", version: 200, offVariation: 1, variations: [ 'x', 'value2' ], trackEvents: true, debugEventsUntilDate: 1000 } }
+
+    it "returns flags state" do
+      config.feature_store.init({ LaunchDarkly::FEATURES => { 'key1' => flag1, 'key2' => flag2 } })
+
+      state = client.all_flags_state({ key: 'userkey' })
+      expect(state.valid?).to be true
+
+      values = state.values_map
+      expect(values).to eq({ 'key1' => 'value1', 'key2' => 'value2' })
+      
+      result = state.as_json
+      expect(result).to eq({
+        'key1' => 'value1',
+        'key2' => 'value2',
+        '$flagsState' => {
+          'key1' => {
+            :variation => 0,
+            :version => 100,
+            :trackEvents => false
+          },
+          'key2' => {
+            :variation => 1,
+            :version => 200,
+            :trackEvents => true,
+            :debugEventsUntilDate => 1000
+          }
+        },
+        '$valid' => true
+      })
+    end
+
+    it "can be filtered for only client-side flags" do
+      flag1 = { key: "server-side-1", offVariation: 0, variations: [ 'a' ], clientSide: false }
+      flag2 = { key: "server-side-2", offVariation: 0, variations: [ 'b' ], clientSide: false }
+      flag3 = { key: "client-side-1", offVariation: 0, variations: [ 'value1' ], clientSide: true }
+      flag4 = { key: "client-side-2", offVariation: 0, variations: [ 'value2' ], clientSide: true }
+      config.feature_store.init({ LaunchDarkly::FEATURES => {
+        flag1[:key] => flag1, flag2[:key] => flag2, flag3[:key] => flag3, flag4[:key] => flag4
+      }})
+
+      state = client.all_flags_state({ key: 'userkey' }, client_side_only: true)
+      expect(state.valid?).to be true
+
+      values = state.values_map
+      expect(values).to eq({ 'client-side-1' => 'value1', 'client-side-2' => 'value2' })
+    end
+
+    it "returns empty state for nil user" do
+      config.feature_store.init({ LaunchDarkly::FEATURES => { 'key1' => flag1, 'key2' => flag2 } })
+
+      state = client.all_flags_state(nil)
+      expect(state.valid?).to be false
+      expect(state.values_map).to eq({})
+    end
+
+    it "returns empty state for nil user key" do
+      config.feature_store.init({ LaunchDarkly::FEATURES => { 'key1' => flag1, 'key2' => flag2 } })
+
+      state = client.all_flags_state({})
+      expect(state.valid?).to be false
+      expect(state.values_map).to eq({})
+    end
+
+    it "returns empty state if offline" do
+      offline_config.feature_store.init({ LaunchDarkly::FEATURES => { 'key1' => flag1, 'key2' => flag2 } })
+
+      state = offline_client.all_flags_state({ key: 'userkey' })
+      expect(state.valid?).to be false
+      expect(state.values_map).to eq({})
+    end
+  end
+
   describe '#secure_mode_hash' do
     it "will return the expected value for a known message and secret" do
       result = client.secure_mode_hash({key: :Message})
@@ -130,17 +238,6 @@ describe LaunchDarkly::LDClient do
     end
   end
 
-  describe '#log_exception' do
-    it "log error data" do
-      expect(client.instance_variable_get(:@config).logger).to receive(:error)
-      begin
-        raise StandardError.new 'asdf'
-      rescue StandardError => exn
-        client.send(:log_exception, 'caller', exn)
-      end
-    end
-  end
-
   describe 'with send_events: false' do
     let(:config) { LaunchDarkly::Config.new({offline: true, send_events: false, update_processor: update_processor}) }
     let(:client) { subject.new("secret", config) }

data/spec/util_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe LaunchDarkly::Util do
+  describe 'log_exception' do
+    let(:logger) { double() }
+
+    it "logs error data" do
+      expect(logger).to receive(:error)
+      expect(logger).to receive(:debug)
+      begin
+        raise StandardError.new 'asdf'
+      rescue StandardError => exn
+        LaunchDarkly::Util.log_exception(logger, "message", exn)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ldclient-rb
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.1.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-03 00:00:00.000000000 Z
+date: 2018-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -310,6 +310,7 @@ files:
 - lib/ldclient-rb/event_summarizer.rb
 - lib/ldclient-rb/events.rb
 - lib/ldclient-rb/expiring_cache.rb
+- lib/ldclient-rb/flags_state.rb
 - lib/ldclient-rb/in_memory_store.rb
 - lib/ldclient-rb/ldclient.rb
 - lib/ldclient-rb/memoized_value.rb
@@ -340,6 +341,7 @@ files:
 - spec/fixtures/numeric_key_user.json
 - spec/fixtures/sanitized_numeric_key_user.json
 - spec/fixtures/user.json
+- spec/flags_state_spec.rb
 - spec/in_memory_feature_store_spec.rb
 - spec/ldclient_spec.rb
 - spec/newrelic_spec.rb
@@ -356,6 +358,7 @@ files:
 - spec/store_spec.rb
 - spec/stream_spec.rb
 - spec/user_filter_spec.rb
+- spec/util_spec.rb
 - spec/version_spec.rb
 homepage: https://github.com/launchdarkly/ruby-client
 licenses:
@@ -393,6 +396,7 @@ test_files:
 - spec/fixtures/numeric_key_user.json
 - spec/fixtures/sanitized_numeric_key_user.json
 - spec/fixtures/user.json
+- spec/flags_state_spec.rb
 - spec/in_memory_feature_store_spec.rb
 - spec/ldclient_spec.rb
 - spec/newrelic_spec.rb
@@ -409,4 +413,5 @@ test_files:
 - spec/store_spec.rb
 - spec/stream_spec.rb
 - spec/user_filter_spec.rb
+- spec/util_spec.rb
 - spec/version_spec.rb