ldclient-rb 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aed3c4885f97dd1ad3f8dad1e9ea37ae53931fd6
-  data.tar.gz: a33110bc3288b9529aebc076e2fa5c6c405ea41d
+  metadata.gz: c11f5029a26f9320594fad4b3e580add838f46dd
+  data.tar.gz: e9d8569a3f7b96a0cdbbc7ecedc1f76b798c8f1f
 SHA512:
-  metadata.gz: 0e8fe67e4835f5a961a5bd65b3ef383f85910253c361202b75f18dff585dbb8e210b1bc388297cd771111409bf4f0620f8aeb9197d8db17da3a644976c87ff1d
-  data.tar.gz: 85ad89319527662c86f18c6d472476b887f0382715577bf6fcf105c32dce3f24b51ea888a0022daff017cb9ffe4f1a3601edaa24f4d85d073de35284e478ac5b
+  metadata.gz: 55780c3aec6537b3491fe4c960a7475a29c3ea529b337ad3f3556140c9faa949c2de44340837ef1d3f069b043aa2e80de05a790e575f0b868b5c3e382c076cb6
+  data.tar.gz: aac072bbc8e7dc99c64ee282da1dd735c87d5f76518dab6e5c1ca3e86dfd11148b4b53e44ac40624b0db61a2fba61acc1b9fa2dacec595d71d4082505f3e3f3a

data/CHANGELOG.md

@@ -2,6 +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).
 
+## [5.3.0] - 2018-10-24
+### Added:
+- The `all_flags_state` method now accepts a new option, `details_only_for_tracked_flags`, which reduces the size of the JSON representation of the flag state by omitting some metadata. Specifically, it omits any data that is normally used for generating detailed evaluation events if a flag does not have event tracking or debugging turned on.
+
+### Fixed:
+- JSON data from `all_flags_state` is now slightly smaller even if you do not use the new option described above, because it omits the flag property for event tracking unless that property is true.
+
 ## [5.2.0] - 2018-08-29
 ### Added:
 - The new `LDClient` method `variation_detail` allows you to evaluate a feature flag (using the same parameters as you would for `variation`) and receive more information about how the value was calculated. This information is returned in an `EvaluationDetail` object, which contains both the result value and a "reason" object which will tell you, for instance, if the user was individually targeted for the flag or was matched by one of the flag's rules, or if the flag returned the default value due to an error.

data/lib/ldclient-rb/flags_state.rb

@@ -15,13 +15,21 @@ module LaunchDarkly
     end
 
     # Used internally to build the state map.
-    def add_flag(flag, value, variation, reason = nil)
+    def add_flag(flag, value, variation, reason = nil, details_only_if_tracked = false)
       key = flag[:key]
       @flag_values[key] = value
-      meta = { version: flag[:version], trackEvents: flag[:trackEvents] }
+      meta = {}
+      with_details = !details_only_if_tracked || flag[:trackEvents]
+      if !with_details && flag[:debugEventsUntilDate]
+        with_details = flag[:debugEventsUntilDate] > (Time.now.to_f * 1000).to_i
+      end
+      if with_details
+        meta[:version] = flag[:version]
+        meta[:reason] = reason if !reason.nil?
+      end
       meta[:variation] = variation if !variation.nil?
+      meta[:trackEvents] = true if flag[:trackEvents]
       meta[:debugEventsUntilDate] = flag[:debugEventsUntilDate] if flag[:debugEventsUntilDate]
-      meta[:reason] = reason if !reason.nil?
       @flag_metadata[key] = meta
     end
 

data/lib/ldclient-rb/ldclient.rb

@@ -212,6 +212,10 @@ module LaunchDarkly
     #   client-side SDK should be included in the state. By default, all flags are included.
     # @option options [Boolean] :with_reasons (false) True if evaluation reasons should be included
     #   in the state (see `variation_detail`). By default, they are not included.
+    # @option options [Boolean] :details_only_for_tracked_flags (false) True if any flag metadata that is
+    # normally only used for event generation - such as flag versions and evaluation reasons - should be
+    # omitted for any flag that does not have event tracking or debugging turned on. This reduces the size
+    # of the JSON data if you are passing the flag state to the front end.
     # @return [FeatureFlagsState] a FeatureFlagsState object which can be serialized to JSON
     #
     def all_flags_state(user, options={})
@@ -234,16 +238,18 @@ module LaunchDarkly
       state = FeatureFlagsState.new(true)
       client_only = options[:client_side_only] || false
       with_reasons = options[:with_reasons] || false
+      details_only_if_tracked = options[:details_only_for_tracked_flags] || 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.detail.value, result.detail.variation_index, with_reasons ? result.detail.reason : nil)
+          state.add_flag(f, result.detail.value, result.detail.variation_index, with_reasons ? result.detail.reason : nil,
+            details_only_if_tracked)
         rescue => exn
           Util.log_exception(@config.logger, "Error evaluating flag \"#{k}\" in all_flags_state", exn)
-          state.add_flag(f, nil, nil, with_reasons ? { kind: 'ERROR', errorKind: 'EXCEPTION' } : nil)
+          state.add_flag(f, nil, nil, with_reasons ? { kind: 'ERROR', errorKind: 'EXCEPTION' } : nil, details_only_if_tracked)
         end
       end
 

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "5.2.0"
+  VERSION = "5.3.0"
 end

data/spec/flags_state_spec.rb

@@ -42,8 +42,7 @@ describe LaunchDarkly::FeatureFlagsState do
       '$flagsState' => {
         'key1' => {
           :variation => 0,
-          :version => 100,
-          :trackEvents => false
+          :version => 100
         },
         'key2' => {
           :variation => 1,

data/spec/ldclient_spec.rb

@@ -233,8 +233,7 @@ describe LaunchDarkly::LDClient do
         '$flagsState' => {
           'key1' => {
             :variation => 0,
-            :version => 100,
-            :trackEvents => false
+            :version => 100
           },
           'key2' => {
             :variation => 1,
@@ -263,6 +262,44 @@ describe LaunchDarkly::LDClient do
       expect(values).to eq({ 'client-side-1' => 'value1', 'client-side-2' => 'value2' })
     end
 
+    it "can omit details for untracked flags" do
+      future_time = (Time.now.to_f * 1000).to_i + 100000
+      flag1 = { key: "key1", version: 100, offVariation: 0, variations: [ 'value1' ], trackEvents: false }
+      flag2 = { key: "key2", version: 200, offVariation: 1, variations: [ 'x', 'value2' ], trackEvents: true }
+      flag3 = { key: "key3", version: 300, offVariation: 1, variations: [ 'x', 'value3' ], debugEventsUntilDate: future_time }
+
+      config.feature_store.init({ LaunchDarkly::FEATURES => { 'key1' => flag1, 'key2' => flag2, 'key3' => flag3 } })
+
+      state = client.all_flags_state({ key: 'userkey' }, { details_only_for_tracked_flags: true })
+      expect(state.valid?).to be true
+
+      values = state.values_map
+      expect(values).to eq({ 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' })
+      
+      result = state.as_json
+      expect(result).to eq({
+        'key1' => 'value1',
+        'key2' => 'value2',
+        'key3' => 'value3',
+        '$flagsState' => {
+          'key1' => {
+            :variation => 0
+          },
+          'key2' => {
+            :variation => 1,
+            :version => 200,
+            :trackEvents => true
+          },
+          'key3' => {
+            :variation => 1,
+            :version => 300,
+            :debugEventsUntilDate => future_time
+          }
+        },
+        '$valid' => true
+      })
+    end
+
     it "returns empty state for nil user" do
       config.feature_store.init({ LaunchDarkly::FEATURES => { 'key1' => flag1, 'key2' => flag2 } })
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ldclient-rb
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2018-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler