launchdarkly-server-sdk 8.6.0 → 8.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a732ff00a5e21bfc907dff44adc5bd3f1651bd80c2483273a1a9730f443448f
-  data.tar.gz: 1ca26bf847c2387ed585e07b18c6aa42a78496110a7bf9643751a0e2b04d2908
+  metadata.gz: 1692535bf245c0627c6e08cb87f168b11d7518d895bf9faacb2858da227f9d70
+  data.tar.gz: fa60f044217ac286dd817b325ea87c431ce0399decc5ee84741638959b1a5697
 SHA512:
-  metadata.gz: 901e6f7562f0861916bf06fd07088561713579633cc5e052ae5cf86c6acdbdd0497b55e273c2f92244a5653d0fa806c9776f92a853bad22232634489c630f85d
-  data.tar.gz: a325418b21c256a8b2d846d187e8bc91ba1e323955f460a418732b77f30354b64fc2dbfdadd04c4be4a41217779a4f217d522799ace4ce46a3ebc5019baf060c
+  metadata.gz: 92fc2011f8a0a8ca594863155081e60abfdeec0be8d50a1ebf051ed0a7a97406eac7560a12cf9a5c2beed7de71b58ff0dc720569b67f65f2f582fb2f7b1528c0
+  data.tar.gz: e6a8b529997e0df8dfdf2a1b82c716211661bbeece2b50777146b5c6fdb7c8d97f69d23057ad6586b0730c9717fcb15b07a9808213da21ad7f9fbc91595c91f9

data/lib/ldclient-rb/config.rb

@@ -65,6 +65,7 @@ module LaunchDarkly
       @all_attributes_private = opts[:all_attributes_private] || false
       @private_attributes = opts[:private_attributes] || []
       @send_events = opts.has_key?(:send_events) ? opts[:send_events] : Config.default_send_events
+      @compress_events = opts.has_key?(:compress_events) ? opts[:compress_events] : Config.default_compress_events
       @context_keys_capacity = opts[:context_keys_capacity] || Config.default_context_keys_capacity
       @context_keys_flush_interval = opts[:context_keys_flush_interval] || Config.default_context_keys_flush_interval
       @data_source = opts[:data_source]
@@ -76,7 +77,7 @@ module LaunchDarkly
       @socket_factory = opts[:socket_factory]
       @big_segments = opts[:big_segments] || BigSegmentsConfig.new(store: nil)
       @application = LaunchDarkly::Impl::Util.validate_application_info(opts[:application] || {}, @logger)
-      @payload_filter_key = opts[:payload_filter_key]
+      @payload_filter_key = LaunchDarkly::Impl::Util.validate_payload_filter_key(opts[:payload_filter_key] , @logger)
       @hooks = (opts[:hooks] || []).keep_if { |hook| hook.is_a? Interfaces::Hooks::Hook }
       @omit_anonymous_contexts = opts.has_key?(:omit_anonymous_contexts) && opts[:omit_anonymous_contexts]
       @data_source_update_sink = nil
@@ -254,6 +255,17 @@ module LaunchDarkly
     #
     attr_reader :send_events
 
+    #
+    # Should the event payload sent to LaunchDarkly use gzip compression. By default this is false to prevent backward
+    # breaking compatibility issues with older versions of the relay proxy.
+    #
+    # Customers not using the relay proxy are strongly encouraged to enable this feature to reduce egress bandwidth
+    # cost.
+    #
+    # @return [Boolean]
+    #
+    attr_reader :compress_events
+
     #
     # The number of context keys that the event processor can remember at any one time. This reduces the
     # amount of duplicate context details sent in analytics events.
@@ -539,6 +551,14 @@ module LaunchDarkly
       true
     end
 
+    #
+    # The default value for {#compress_events}.
+    # @return [Boolean] false
+    #
+    def self.default_compress_events
+      false
+    end
+
     #
     # The default value for {#context_keys_capacity}.
     # @return [Integer] 1000

data/lib/ldclient-rb/events.rb

@@ -513,13 +513,13 @@ module LaunchDarkly
           evaluation: {
             key: event.key,
             value: event.evaluation.value,
+            reason: event.evaluation.reason,
           },
         }
 
         out[:evaluation][:version] = event.version unless event.version.nil?
         out[:evaluation][:default] = event.default unless event.default.nil?
         out[:evaluation][:variation] = event.evaluation.variation_index unless event.evaluation.variation_index.nil?
-        out[:evaluation][:reason] = event.evaluation.reason unless event.evaluation.reason.nil?
         out[:samplingRatio] = event.sampling_ratio unless event.sampling_ratio.nil? || event.sampling_ratio == 1
 
         measurements = []

data/lib/ldclient-rb/impl/event_sender.rb

@@ -2,6 +2,8 @@ require "ldclient-rb/impl/unbounded_pool"
 
 require "securerandom"
 require "http"
+require "stringio"
+require "zlib"
 
 module LaunchDarkly
   module Impl
@@ -42,14 +44,24 @@ module LaunchDarkly
               @logger.debug { "[LDClient] sending #{description}: #{event_data}" }
               headers = {}
               headers["content-type"] = "application/json"
+              headers["content-encoding"] = "gzip" if @config.compress_events
               Impl::Util.default_http_headers(@sdk_key, @config).each { |k, v| headers[k] = v }
               unless is_diagnostic
                 headers["X-LaunchDarkly-Event-Schema"] = CURRENT_SCHEMA_VERSION.to_s
                 headers["X-LaunchDarkly-Payload-ID"] = payload_id
               end
+
+              body = event_data
+              if @config.compress_events
+                gzip = Zlib::GzipWriter.new(StringIO.new)
+                gzip << event_data
+
+                body = gzip.close.string
+              end
+
               response = http_client.request("POST", uri, {
                 headers: headers,
-                body: event_data,
+                body: body,
               })
             rescue StandardError => exn
               @logger.warn { "[LDClient] Error sending events: #{exn.inspect}." }

data/lib/ldclient-rb/impl/util.rb

@@ -75,6 +75,21 @@ module LaunchDarkly
           version: validate_application_value(app[:version], :version, logger),
         }
       end
+
+      #
+      # @param value [String, nil]
+      # @param logger [Logger]
+      # @return [String, nil]
+      #
+      def self.validate_payload_filter_key(value, logger)
+        return nil if value.nil?
+        return value if value.is_a?(String) && /^[a-zA-Z0-9][._\-a-zA-Z0-9]*$/.match?(value)
+
+        logger.warn {
+          "Invalid payload filter configured, full environment will be fetched. Ensure the filter key is not empty and was copied correctly from LaunchDarkly settings."
+        }
+        nil
+      end
     end
   end
 end

data/lib/ldclient-rb/util.rb

@@ -77,11 +77,6 @@ module LaunchDarkly
     def self.add_payload_filter_key(uri, config)
       return uri if config.payload_filter_key.nil?
 
-      unless config.payload_filter_key.is_a?(String) && !config.payload_filter_key.empty?
-        config.logger.warn { "[LDClient] Filter key must be a non-empty string. No filtering will be applied." }
-        return uri
-      end
-
       begin
         parsed = URI.parse(uri)
         new_query_params = URI.decode_www_form(String(parsed.query)) << ["filter", config.payload_filter_key]

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "8.6.0" # x-release-please-version
+  VERSION = "8.7.1" # x-release-please-version
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly-server-sdk
 version: !ruby/object:Gem::Version
-  version: 8.6.0
+  version: 8.7.1
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-26 00:00:00.000000000 Z
+date: 2024-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -24,6 +24,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.57'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -248,6 +268,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: zlib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -376,7 +410,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
 summary: LaunchDarkly SDK for Ruby