launchdarkly-server-sdk 7.0.3 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 196e3ec78782e9929809473f79c82acbd38969ad6c24304cc6bcd88e3976ad27
-  data.tar.gz: '088b4f929f60fc54d87deb703d565dd750e5737470504ae93eff955689d57dd2'
+  metadata.gz: 4c7c60035c46d6e2284ad78f0f4e33637f804faf9c90229e09b9d7c5b64c3bf8
+  data.tar.gz: 38f330a730ce6459d7a50bf0afec0db47462afafa7f927f09a2978ae3bd1cf18
 SHA512:
-  metadata.gz: a3709d4c9e8455f606463b1827b831035b088cfb4c110401d09aee178379a4ff26a874177b579a4e2127bce8ee91d3fb5927493af1e8a110549abeca62715f64
-  data.tar.gz: ca67d5d1f7b5711762313a5538556b4cafdb2f9745ed7b51cce5c0a22f056cdbf4d78c33c4d980b1d8ddb814e283c4f7d442660be6a324e5c321b42100281013
+  metadata.gz: c15f778108d9fdc2d47b51846d068e553be322d4e072498368d9c8cc7161f2e15c8977ccc5dcf8e565a707d727029901bbd6e0a7780bb42c0407f21cbef959ec
+  data.tar.gz: c7eca9b4edb6c458b1a034161ca9adaac955d81155308c23f913c434cf02a6479e15a7df35ea9ae4cf4d5e21b288c485a3ef1c380f90d6e4581e8993a7bc1e37

data/lib/ldclient-rb/config.rb

@@ -57,6 +57,7 @@ module LaunchDarkly
     # @option opts [#open] :socket_factory See {#socket_factory}.
     # @option opts [BigSegmentsConfig] :big_segments See {#big_segments}.
     # @option opts [Hash] :application See {#application}
+    # @option opts [String] :payload_filter_key See {#payload_filter_key}
     #
     def initialize(opts = {})
       @base_uri = (opts[:base_uri] || Config.default_base_uri).chomp("/")
@@ -88,6 +89,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]
     end
 
     #
@@ -330,6 +332,21 @@ module LaunchDarkly
     #
     attr_reader :application
 
+    #
+    # LaunchDarkly Server SDKs historically downloaded all flag configuration and segments for a particular environment
+    # during initialization.
+    #
+    # For some customers, this is an unacceptably large amount of data, and has contributed to performance issues within
+    # their products.
+    #
+    # Filtered environments aim to solve this problem. By allowing customers to specify subsets of an environment's
+    # flags using a filter key, SDKs will initialize faster and use less memory.
+    #
+    # This payload filter key only applies to the default streaming and polling data sources. It will not affect TestData or FileData
+    # data sources, nor will it be applied to any data source provided through the {#data_source} config property.
+    #
+    attr_reader :payload_filter_key
+
     #
     # Set to true to opt out of sending diagnostics data.
     #

data/lib/ldclient-rb/ldclient.rb

@@ -387,7 +387,7 @@ module LaunchDarkly
 
       context = Impl::Context::make_context(context)
       unless context.valid?
-        @config.logger.error { "[LDClient] Context was invalid for flag evaluation (#{context.error}); returning default value" }
+        @config.logger.error { "[LDClient] Context was invalid for evaluation of flag '#{key}' (#{context.error}); returning default value" }
         detail = Evaluator.error_result(EvaluationReason::ERROR_USER_NOT_SPECIFIED, default)
         return detail
       end

data/lib/ldclient-rb/requestor.rb

@@ -43,12 +43,10 @@ module LaunchDarkly
 
     private
 
-    def request_single_item(kind, path)
-      Impl::Model.deserialize(kind, make_request(path), @config.logger)
-    end
-
     def make_request(path)
-      uri = URI(@config.base_uri + path)
+      uri = URI(
+        Util.add_payload_filter_key(@config.base_uri + path, @config)
+      )
       headers = {}
       Impl::Util.default_http_headers(@sdk_key, @config).each { |k, v| headers[k] = v }
       headers["Connection"] = "keep-alive"

data/lib/ldclient-rb/stream.rb

@@ -51,7 +51,9 @@ module LaunchDarkly
         reconnect_time: @config.initial_reconnect_delay,
       }
       log_connection_started
-      @es = SSE::Client.new(@config.stream_uri + "/all", **opts) do |conn|
+
+      uri = Util.add_payload_filter_key(@config.stream_uri + "/all", @config)
+      @es = SSE::Client.new(uri, **opts) do |conn|
         conn.on_event { |event| process_message(event) }
         conn.on_error { |err|
           log_connection_result(false)

data/lib/ldclient-rb/util.rb

@@ -4,6 +4,32 @@ require "http"
 module LaunchDarkly
   # @private
   module Util
+    #
+    # Append the payload filter key query parameter to the provided URI.
+    #
+    # @param uri [String]
+    # @param config [Config]
+    # @return [String]
+    #
+    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]
+        parsed.query = URI.encode_www_form(new_query_params)
+        parsed.to_s
+      rescue URI::InvalidURIError
+        config.logger.warn { "[LDClient] URI could not be parsed. No filtering will be applied." }
+        uri
+      end
+    end
+
     def self.new_http_client(uri_s, config)
       http_client_options = {}
       if config.socket_factory

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "7.0.3"
+  VERSION = "7.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly-server-sdk
 version: !ruby/object:Gem::Version
-  version: 7.0.3
+  version: 7.1.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -338,7 +338,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.4.12
 signing_key: 
 specification_version: 4
 summary: LaunchDarkly SDK for Ruby