ldclient-rb 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 074163fec07d0e90f8f0aadb30bcf43adb132983
-  data.tar.gz: 5f6a6c1649125810cd59b314d44c83f57a7eb91e
+  metadata.gz: a18dfb629edba5ddd3ba6662289a8cf90b54e452
+  data.tar.gz: ba95bca6cbea4c808fadb06e04e66d3df39ab0a5
 SHA512:
-  metadata.gz: f9f4d473ee40827436698307aec2455d08cf822072a0795752fb824bad9b04100505e3d42665413ae38f07590b7e7e2149887e486103670c16f057cf13790eef
-  data.tar.gz: 353e502f66a7fcb3e07daf97a629139adb4fcdb76e648fb95e4447d9563f4aa21879816cc1e40c10e50fa3f31241c2757502c7dee365519374dffc35884086d2
+  metadata.gz: e5c7b818184d3b961f6894579356f6cd624cf3cf74f109ded02004d5e5ca9c17582a93bfec01316e7fce47de3d6fbfc4618f2967d43d52a94904f70f1db8d67c
+  data.tar.gz: 3d7126f29afd904557ceb9a0f4f6c115659db399894eb6f8bdf69fe65e1f9b9bb468d9d24a09610d1a1f390f2feb165da54f9400edc0b8e53baf09553ef4375c

data/CHANGELOG.md

@@ -2,7 +2,13 @@
 
 All notable changes to the LaunchDarkly Ruby SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
-## 2.3.2 - 2017-12-02
+## [2.4.0] - 2018-01-12
+## Changed
+- Will use feature store if already initialized even if connection to service could not be established.  This is useful when flags have been initialized in redis.
+- Increase default and  minimum polling interval to 30s
+- Strip out unknown top-level attributes
+
+## [2.3.2] - 2017-12-02
 
 ### Fixed
 - Make sure redis store initializations are atomic

data/README.md

@@ -77,6 +77,23 @@ Rails.application.config.ld_client.variation('your.flag.key', launchdarkly_setti
 
 Note that this gem will automatically switch to using the Rails logger it is detected.
 
+
+HTTPS proxy
+------------
+The Ruby SDK uses Faraday to handle all of its network traffic. Faraday provides a built-in HTTPS proxy. If the HTTPS_PROXY environment variable is present then the SDK will proxy all network requests through the URL provided.
+
+How to set the HTTPS_PROXY environment variable on Mac/Linux systems:
+```
+export HTTPS_PROXY=https://web-proxy.domain.com:8080
+```
+
+
+How to set the HTTPS_PROXY environment variable on Windows systems:
+```
+set HTTPS_PROXY=https://web-proxy.domain.com:8080
+```
+
+
 Your first feature flag
 -----------------------
 

data/lib/ldclient-rb.rb

@@ -2,6 +2,7 @@ require "ldclient-rb/version"
 require "ldclient-rb/evaluation"
 require "ldclient-rb/ldclient"
 require "ldclient-rb/cache_store"
+require "ldclient-rb/memoized_value"
 require "ldclient-rb/config"
 require "ldclient-rb/newrelic"
 require "ldclient-rb/stream"

data/lib/ldclient-rb/config.rb

@@ -41,9 +41,10 @@ module LaunchDarkly
     # @option opts [Boolean] :offline (false) Whether the client should be initialized in 
     #   offline mode. In offline mode, default values are returned for all flags and no 
     #   remote network requests are made.
-    # @option opts [Float] :poll_interval (1) The number of seconds between polls for flag updates
+    # @option opts [Float] :poll_interval (30) The number of seconds between polls for flag updates
     #   if streaming is off.
     # @option opts [Boolean] :stream (true) Whether or not the streaming API should be used to receive flag updates.
+    #   Streaming should only be disabled on the advice of LaunchDarkly support.
     # @option opts [Boolean] all_attributes_private (false) If true, all user attributes (other than the key)
     #   will be private, not just the attributes specified in `private_attribute_names`.
     # @option opts [Array] :private_attribute_names  Marks a set of attribute names private. Any users sent to
@@ -68,7 +69,7 @@ module LaunchDarkly
       @stream = opts.has_key?(:stream) ? opts[:stream] : Config.default_stream
       @use_ldd = opts.has_key?(:use_ldd) ? opts[:use_ldd] : Config.default_use_ldd
       @offline = opts.has_key?(:offline) ? opts[:offline] : Config.default_offline
-      @poll_interval = opts.has_key?(:poll_interval) && opts[:poll_interval] > 1 ? opts[:poll_interval] : Config.default_poll_interval
+      @poll_interval = opts.has_key?(:poll_interval) && opts[:poll_interval] > Config.default_poll_interval ? opts[:poll_interval] : Config.default_poll_interval
       @proxy = opts[:proxy] || Config.default_proxy
       @all_attributes_private = opts[:all_attributes_private] || false
       @private_attribute_names = opts[:private_attribute_names] || []
@@ -256,7 +257,7 @@ module LaunchDarkly
     end
 
     def self.default_poll_interval
-      1
+      30
     end
 
     def self.default_send_events

data/lib/ldclient-rb/event_serializer.rb

@@ -17,14 +17,18 @@ module LaunchDarkly
 
     private
 
-    IGNORED_TOP_LEVEL_KEYS = Set.new([:custom, :key, :privateAttributeNames])
-    STRIPPED_TOP_LEVEL_KEYS = Set.new([:privateAttributeNames])
+    ALLOWED_TOP_LEVEL_KEYS = Set.new([:key, :secondary, :ip, :country, :email,
+                :firstName, :lastName, :avatar, :name, :anonymous, :custom])
+    IGNORED_TOP_LEVEL_KEYS = Set.new([:custom, :key, :anonymous])
 
-    def filter_values(props, user_private_attrs, ignore=[])
+    def filter_values(props, user_private_attrs, allowed_keys = [], keys_to_leave_as_is = [])
+      is_valid_key = lambda { |key| allowed_keys.empty? || allowed_keys.include?(key) }
       removed_keys = Set.new(props.keys.select { |key|
-        !ignore.include?(key) && private_attr?(key, user_private_attrs)
+        # Note that if is_valid_key returns false, we don't explicitly *remove* the key (which would place
+        # it in the privateAttrs list) - we just silently drop it when we calculate filtered_hash.
+        is_valid_key.call(key) && !keys_to_leave_as_is.include?(key) && private_attr?(key, user_private_attrs)
       })
-      filtered_hash = props.select { |key, value| !removed_keys.include?(key) && !STRIPPED_TOP_LEVEL_KEYS.include?(key) }
+      filtered_hash = props.select { |key, value| !removed_keys.include?(key) && is_valid_key.call(key) }
       [filtered_hash, removed_keys]
     end
 
@@ -35,7 +39,7 @@ module LaunchDarkly
     def transform_user_props(user_props)
       user_private_attrs = Set.new((user_props[:privateAttributeNames] || []).map(&:to_sym))
 
-      filtered_user_props, removed = filter_values(user_props, user_private_attrs, IGNORED_TOP_LEVEL_KEYS)
+      filtered_user_props, removed = filter_values(user_props, user_private_attrs, ALLOWED_TOP_LEVEL_KEYS, IGNORED_TOP_LEVEL_KEYS)
       if user_props.has_key?(:custom)
         filtered_user_props[:custom], removed_custom = filter_values(user_props[:custom], user_private_attrs)
         removed.merge(removed_custom)

data/lib/ldclient-rb/ldclient.rb

@@ -41,6 +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")
           @update_processor = PollingProcessor.new(config, requestor)
         end
         @update_processor.start
@@ -49,7 +51,7 @@ module LaunchDarkly
       if !@config.offline? && wait_for_sec > 0
         begin
           WaitUtil.wait_for_condition("LaunchDarkly client initialization", timeout_sec: wait_for_sec, delay_sec: 0.1) do
-            @update_processor.initialized?
+            initialized?
           end
         rescue WaitUtil::TimeoutError
           @config.logger.error("[LDClient] Timeout encountered waiting for LaunchDarkly client initialization")
@@ -117,10 +119,14 @@ module LaunchDarkly
         return default
       end
 
-      if !@update_processor.nil? && !@update_processor.initialized?
-        @config.logger.error("[LDClient] Client has not finished initializing. Returning default value")
-        @event_processor.add_event(kind: "feature", key: key, value: default, default: default, user: user)
-        return default
+      if !initialized?
+        if @store.initialized?
+          @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")
+          @event_processor.add_event(kind: "feature", key: key, value: default, default: default, user: user)
+          return default
+        end
       end
 
       sanitize_user(user)

data/lib/ldclient-rb/memoized_value.rb

@@ -0,0 +1,30 @@
+
+module LaunchDarkly
+  # Simple implementation of a thread-safe memoized value whose generator function will never be
+  # run more than once, and whose value can be overridden by explicit assignment.
+  class MemoizedValue
+    def initialize(&generator)
+      @generator = generator
+      @mutex = Mutex.new
+      @inited = false
+      @value = nil
+    end
+
+    def get
+      @mutex.synchronize do
+        if !@inited
+          @value = @generator.call
+          @inited = true
+        end
+      end
+      @value
+    end
+
+    def set(value)
+      @mutex.synchronize do
+        @value = value
+        @inited = true
+      end
+    end
+  end
+end

data/lib/ldclient-rb/redis_feature_store.rb

@@ -13,8 +13,6 @@ module LaunchDarkly
   # property of your client configuration.
   #
   class RedisFeatureStore
-    INIT_KEY = :"$initialized"
-
     begin
       require "redis"
       require "connection_pool"
@@ -68,6 +66,9 @@ module LaunchDarkly
       end
 
       @stopped = Concurrent::AtomicBoolean.new(false)
+      @inited = MemoizedValue.new {
+        query_inited
+      }
 
       with_connection do |redis|
         @logger.info("RedisFeatureStore: using Redis instance at #{redis.connection[:host]}:#{redis.connection[:port]} \
@@ -163,7 +164,7 @@ and prefix: #{@prefix}")
           fs.each { |k, f| put_redis_and_cache(multi, k, f) }
         end
       end
-      put_cache(INIT_KEY, true)
+      @inited.set(true)
       @logger.info("RedisFeatureStore: initialized with #{fs.count} feature flags")
     end
 
@@ -180,16 +181,7 @@ and prefix: #{@prefix}")
     end
 
     def initialized?
-      if @cache[INIT_KEY].nil?
-        if with_connection { |redis| redis.exists(@features_key) }
-          put_cache(INIT_KEY, true)
-          true
-        else
-          false
-        end
-      else
-        put_cache(INIT_KEY, true)  # reset TTL
-      end
+      @inited.get
     end
 
     def stop
@@ -232,5 +224,9 @@ and prefix: #{@prefix}")
       end
       put_cache(key.to_sym, feature)
     end
+
+    def query_inited
+      with_connection { |redis| redis.exists(@features_key) }
+    end
   end
 end

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "2.3.2"
+  VERSION = "2.4.0"
 end

data/spec/config_spec.rb

@@ -52,4 +52,12 @@ describe LaunchDarkly::Config do
       expect(subject.default_logger).to be_an_instance_of Logger
     end
   end
+  describe ".poll_interval" do
+    it "can be set to greater than the default" do
+      expect(subject.new(poll_interval: 31).poll_interval).to eq 31
+    end
+    it "cannot be set to less than the default" do
+      expect(subject.new(poll_interval: 29).poll_interval).to eq 30
+    end
+  end
 end

data/spec/event_serializer_spec.rb

@@ -19,6 +19,14 @@ describe LaunchDarkly::EventSerializer do
     u
   }
 
+  let(:user_with_unknown_top_level_attrs) {
+    { key: 'abc', firstName: 'Sue', species: 'human', hatSize: 6, custom: { bizzle: 'def', dizzle: 'ghi' }}
+  }
+
+  let(:anon_user) {
+    { key: 'abc', anonymous: 'true', custom: { bizzle: 'def', dizzle: 'ghi' }}
+  }
+
   # expected results from serializing user
 
   let(:user_with_all_attrs_hidden) {
@@ -33,6 +41,10 @@ describe LaunchDarkly::EventSerializer do
     { key: 'abc', firstName: 'Sue', custom: { bizzle: 'def' }, privateAttrs: [ 'dizzle' ]}
   }
 
+  let(:anon_user_with_all_attrs_hidden) {
+    { key: 'abc', anonymous: 'true', custom: { }, privateAttrs: [ 'bizzle', 'dizzle' ]}
+  }
+
 
   def make_event(user)
     {
@@ -82,5 +94,19 @@ describe LaunchDarkly::EventSerializer do
       j = es.serialize_events([event])
       expect(parse_results(j)).to eq [make_event(user_with_all_attrs_hidden)]
     end
+
+    it "strips out any unknown top-level attributes" do
+      es = LaunchDarkly::EventSerializer.new(base_config)
+      event = make_event(user_with_unknown_top_level_attrs)
+      j = es.serialize_events([event])
+      expect(parse_results(j)).to eq [make_event(user)]
+    end
+
+    it "leaves the anonymous attribute as is" do
+      es = LaunchDarkly::EventSerializer.new(config_with_all_attrs_private)
+      event = make_event(anon_user)
+      j = es.serialize_events([event])
+      expect(parse_results(j)).to eq [make_event(anon_user_with_all_attrs_hidden)]
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ldclient-rb
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-02 00:00:00.000000000 Z
+date: 2018-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -293,6 +293,7 @@ files:
 - lib/ldclient-rb/events.rb
 - lib/ldclient-rb/feature_store.rb
 - lib/ldclient-rb/ldclient.rb
+- lib/ldclient-rb/memoized_value.rb
 - lib/ldclient-rb/newrelic.rb
 - lib/ldclient-rb/polling.rb
 - lib/ldclient-rb/redis_feature_store.rb