launchdarkly-server-sdk 6.3.4 → 7.0.0

data/lib/ldclient-rb/reference.rb

@@ -0,0 +1,274 @@
+module LaunchDarkly
+  #
+  # Reference is an attribute name or path expression identifying a value
+  # within a Context.
+  #
+  # This type is mainly intended to be used internally by LaunchDarkly SDK and
+  # service code, where efficiency is a major concern so it's desirable to do
+  # any parsing or preprocessing just once. Applications are unlikely to need
+  # to use the Reference type directly.
+  #
+  # It can be used to retrieve a value with LDContext.get_value_for_reference()
+  # or to identify an attribute or nested value that should be considered
+  # private.
+  #
+  # Parsing and validation are done at the time that the Reference is
+  # constructed. If a Reference instance was created from an invalid string, it
+  # is considered invalid and its {Reference#error} attribute will return a
+  # non-nil error.
+  #
+  # ## Syntax
+  #
+  # The string representation of an attribute reference in LaunchDarkly JSON
+  # data uses the following syntax:
+  #
+  # If the first character is not a slash, the string is interpreted literally
+  # as an attribute name. An attribute name can contain any characters, but
+  # must not be empty.
+  #
+  # If the first character is a slash, the string is interpreted as a
+  # slash-delimited path where the first path component is an attribute name,
+  # and each subsequent path component is the name of a property in a JSON
+  # object. Any instances of the characters "/" or "~" in a path component are
+  # escaped as "~1" or "~0" respectively. This syntax deliberately resembles
+  # JSON Pointer, but no JSON Pointer behaviors other than those mentioned here
+  # are supported.
+  #
+  # ## Examples
+  #
+  # Suppose there is a context whose JSON implementation looks like this:
+  #
+  #	{
+  #	  "kind": "user",
+  #	  "key": "value1",
+  #	  "address": {
+  #	    "street": {
+  #	      "line1": "value2",
+  #	      "line2": "value3"
+  #	    },
+  #	    "city": "value4"
+  #	  },
+  #	  "good/bad": "value5"
+  #	}
+  #
+  # The attribute references "key" and "/key" would both point to "value1".
+  #
+  # The attribute reference "/address/street/line1" would point to "value2".
+  #
+  # The attribute references "good/bad" and "/good~1bad" would both point to
+  # "value5".
+  #
+  class Reference
+    ERR_EMPTY = 'empty reference'
+    private_constant :ERR_EMPTY
+
+    ERR_INVALID_ESCAPE_SEQUENCE = 'invalid escape sequence'
+    private_constant :ERR_INVALID_ESCAPE_SEQUENCE
+
+    ERR_DOUBLE_TRAILING_SLASH = 'double or trailing slash'
+    private_constant :ERR_DOUBLE_TRAILING_SLASH
+
+    #
+    # Returns nil for a valid Reference, or a non-nil error value for an
+    # invalid Reference.
+    #
+    # A Reference is invalid if the input string is empty, or starts with a
+    # slash but is not a valid slash-delimited path, or starts with a slash and
+    # contains an invalid escape sequence.
+    #
+    # Otherwise, the Reference is valid, but that does not guarantee that such
+    # an attribute exists in any given Context. For instance,
+    # Reference.create("name") is a valid Reference, but a specific Context
+    # might or might not have a name.
+    #
+    # See comments on the Reference type for more details of the attribute
+    # reference syntax.
+    #
+    # @return [String, nil]
+    #
+    attr_reader :error
+
+    #
+    # Returns the attribute reference as a string, in the same format provided
+    # to {#create}.
+    #
+    # If the Reference was created with {#create}, this value is identical to
+    # the original string. If it was created with {#create_literal}, the value
+    # may be different due to unescaping (for instance, an attribute whose name
+    # is "/a" would be represented as "~1a").
+    #
+    # @return [String, nil]
+    #
+    attr_reader :raw_path
+
+    def initialize(raw_path, components = [], error = nil)
+      @raw_path = raw_path
+      # @type [Array<Symbol>]
+      @components = components
+      @error = error
+    end
+    private_class_method :new
+
+    #
+    # Creates a Reference from a string. For the supported syntax and examples,
+    # see comments on the Reference type.
+    #
+    # This constructor always returns a Reference that preserves the original
+    # string, even if validation fails, so that accessing {#raw_path} (or
+    # serializing the Reference to JSON) will produce the original string. If
+    # validation fails, {#error} will return a non-nil error and any SDK method
+    # that takes this Reference as a parameter will consider it invalid.
+    #
+    # @param value [String, Symbol]
+    # @return [Reference]
+    #
+    def self.create(value)
+      unless value.is_a?(String) || value.is_a?(Symbol)
+        return new(value, [], ERR_EMPTY)
+      end
+
+      value = value.to_s if value.is_a?(Symbol)
+
+      return new(value, [], ERR_EMPTY) if value.empty? || value == "/"
+
+      unless value.start_with? "/"
+        return new(value, [value.to_sym])
+      end
+
+      if value.end_with? "/"
+        return new(value, [], ERR_DOUBLE_TRAILING_SLASH)
+      end
+
+      components = []
+      value[1..].split("/").each do |component|
+        if component.empty?
+          return new(value, [], ERR_DOUBLE_TRAILING_SLASH)
+        end
+
+        path, error = unescape_path(component)
+
+        if error
+          return new(value, [], error)
+        end
+
+        components << path.to_sym
+      end
+
+      new(value, components)
+    end
+
+    #
+    # create_literal is similar to {#create} except that it always
+    # interprets the string as a literal attribute name, never as a
+    # slash-delimited path expression. There is no escaping or unescaping, even
+    # if the name contains literal '/' or '~' characters. Since an attribute
+    # name can contain any characters, this method always returns a valid
+    # Reference unless the name is empty.
+    #
+    # For example: Reference.create_literal("name") is exactly equivalent to
+    # Reference.create("name"). Reference.create_literal("a/b") is exactly
+    # equivalent to Reference.create("a/b") (since the syntax used by {#create}
+    # treats the whole string as a literal as long as it does not start with a
+    # slash), or to Reference.create("/a~1b").
+    #
+    # @param value [String, Symbol]
+    # @return [Reference]
+    #
+    def self.create_literal(value)
+      unless value.is_a?(String) || value.is_a?(Symbol)
+        return new(value, [], ERR_EMPTY)
+      end
+
+      value = value.to_s if value.is_a?(Symbol)
+
+      return new(value, [], ERR_EMPTY) if value.empty?
+      return new(value, [value.to_sym]) if value[0] != '/'
+
+      escaped = "/" + value.gsub('~', '~0').gsub('/', '~1')
+      new(escaped, [value.to_sym])
+    end
+
+    #
+    # Returns the number of path components in the Reference.
+    #
+    # For a simple attribute reference such as "name" with no leading slash,
+    # this returns 1.
+    #
+    # For an attribute reference with a leading slash, it is the number of
+    # slash-delimited path components after the initial slash. For instance,
+    # NewRef("/a/b").Depth() returns 2.
+    #
+    # @return [Integer]
+    #
+    def depth
+      @components.size
+    end
+
+    #
+    # Retrieves a single path component from the attribute reference.
+    #
+    # For a simple attribute reference such as "name" with no leading slash, if
+    # index is zero, {#component} returns the attribute name as a symbol.
+    #
+    # For an attribute reference with a leading slash, if index is non-negative
+    # and less than {#depth}, Component returns the path component as a symbol.
+    #
+    # If index is out of range, it returns nil.
+    #
+    #	Reference.create("a").component(0)    # returns "a"
+    #	Reference.create("/a/b").component(1) # returns "b"
+    #
+    # @param index [Integer]
+    # @return [Symbol, nil]
+    #
+    def component(index)
+      return nil if index < 0 || index >= depth
+
+      @components[index]
+    end
+
+    #
+    # Performs unescaping of attribute reference path components:
+    #
+    # "~1" becomes "/"
+    # "~0" becomes "~"
+    # "~" followed by any character other than "0" or "1" is invalid
+    #
+    # This method returns an array of two values. The first element of the
+    # array is the path if unescaping was valid; otherwise, it will be nil. The
+    # second value is an error string, or nil if the unescaping was successful.
+    #
+    # @param path [String]
+    # @return [Array([String, nil], [String, nil])] Returns a fixed size array.
+    #
+    private_class_method def self.unescape_path(path)
+      # If there are no tildes then there's definitely nothing to do
+      return path, nil unless path.include? '~'
+
+      out = ""
+      i = 0
+      while i < path.size
+        if path[i] != "~"
+          out << path[i]
+          i += 1
+          next
+        end
+
+        return nil, ERR_INVALID_ESCAPE_SEQUENCE if i + 1 == path.size
+
+        case path[i + 1]
+        when '0'
+          out << "~"
+        when '1'
+          out << '/'
+        else
+          return nil, ERR_INVALID_ESCAPE_SEQUENCE
+        end
+
+        i += 2
+      end
+
+      [out, nil]
+    end
+  end
+end

data/lib/ldclient-rb/requestor.rb

@@ -31,9 +31,9 @@ module LaunchDarkly
 
     def request_all_data()
       all_data = JSON.parse(make_request("/sdk/latest-all"), symbolize_names: true)
-      Impl::Model.make_all_store_data(all_data)
+      Impl::Model.make_all_store_data(all_data, @config.logger)
     end
-    
+
     def stop
       begin
         @http_client.close
@@ -44,7 +44,7 @@ module LaunchDarkly
     private
 
     def request_single_item(kind, path)
-      Impl::Model.deserialize(kind, make_request(path))
+      Impl::Model.deserialize(kind, make_request(path), @config.logger)
     end
 
     def make_request(path)
@@ -53,11 +53,11 @@ module LaunchDarkly
       Impl::Util.default_http_headers(@sdk_key, @config).each { |k, v| headers[k] = v }
       headers["Connection"] = "keep-alive"
       cached = @cache.read(uri)
-      if !cached.nil?
+      unless cached.nil?
         headers["If-None-Match"] = cached.etag
       end
       response = @http_client.request("GET", uri, {
-        headers: headers
+        headers: headers,
       })
       status = response.status.code
       # must fully read body for persistent connections
@@ -72,7 +72,7 @@ module LaunchDarkly
         end
         body = fix_encoding(body, response.headers["content-type"])
         etag = response.headers["etag"]
-        @cache.write(uri, CacheEntry.new(etag, body)) if !etag.nil?
+        @cache.write(uri, CacheEntry.new(etag, body)) unless etag.nil?
       end
       body
     end
@@ -96,7 +96,7 @@ module LaunchDarkly
           break
         end
       end
-      return [parts[0], charset]
+      [parts[0], charset]
     end
   end
 end

data/lib/ldclient-rb/stream.rb

@@ -17,7 +17,7 @@ module LaunchDarkly
   # @private
   KEY_PATHS = {
     FEATURES => "/flags/",
-    SEGMENTS => "/segments/"
+    SEGMENTS => "/segments/",
   }
 
   # @private
@@ -41,14 +41,14 @@ module LaunchDarkly
       return @ready unless @started.make_true
 
       @config.logger.info { "[LDClient] Initializing stream connection" }
-      
+
       headers = Impl::Util.default_http_headers(@sdk_key, @config)
       opts = {
         headers: headers,
         read_timeout: READ_TIMEOUT_SECONDS,
         logger: @config.logger,
         socket_factory: @config.socket_factory,
-        reconnect_time: @config.initial_reconnect_delay
+        reconnect_time: @config.initial_reconnect_delay,
       }
       log_connection_started
       @es = SSE::Client.new(@config.stream_uri + "/all", **opts) do |conn|
@@ -60,14 +60,14 @@ module LaunchDarkly
             status = err.status
             message = Util.http_error_message(status, "streaming connection", "will retry")
             @config.logger.error { "[LDClient] #{message}" }
-            if !Util.http_error_recoverable?(status)
+            unless Util.http_error_recoverable?(status)
               @ready.set  # if client was waiting on us, make it stop waiting - has no effect if already set
               stop
             end
           end
         }
       end
-      
+
       @ready
     end
 
@@ -86,7 +86,7 @@ module LaunchDarkly
       @config.logger.debug { "[LDClient] Stream received #{method} message: #{message.data}" }
       if method == PUT
         message = JSON.parse(message.data, symbolize_names: true)
-        all_data = Impl::Model.make_all_store_data(message[:data])
+        all_data = Impl::Model.make_all_store_data(message[:data], @config.logger)
         @feature_store.init(all_data)
         @initialized.make_true
         @config.logger.info { "[LDClient] Stream initialized" }
@@ -96,9 +96,8 @@ module LaunchDarkly
         for kind in [FEATURES, SEGMENTS]
           key = key_for_path(kind, data[:path])
           if key
-            data = data[:data]
-            Impl::Model.postprocess_item_after_deserializing!(kind, data)
-            @feature_store.upsert(kind, data)
+            item = Impl::Model.deserialize(kind, data[:data], @config.logger)
+            @feature_store.upsert(kind, item)
             break
           end
         end

data/lib/ldclient-rb/util.rb

@@ -4,39 +4,24 @@ require "http"
 module LaunchDarkly
   # @private
   module Util
-    def self.stringify_attrs(hash, attrs)
-      return hash if hash.nil?
-      ret = hash
-      changed = false
-      attrs.each do |attr|
-        value = hash[attr]
-        if !value.nil? && !value.is_a?(String)
-          ret = hash.clone if !changed
-          ret[attr] = value.to_s
-          changed = true
-        end
-      end
-      ret
-    end
-
     def self.new_http_client(uri_s, config)
       http_client_options = {}
       if config.socket_factory
         http_client_options["socket_class"] = config.socket_factory
       end
       proxy = URI.parse(uri_s).find_proxy
-      if !proxy.nil?
+      unless proxy.nil?
         http_client_options["proxy"] = {
           proxy_address: proxy.host,
           proxy_port: proxy.port,
           proxy_username: proxy.user,
-          proxy_password: proxy.password
+          proxy_password: proxy.password,
         }
       end
-      return HTTP::Client.new(http_client_options)
+      HTTP::Client.new(http_client_options)
         .timeout({
           read: config.read_timeout,
-          connect: config.connect_timeout
+          connect: config.connect_timeout,
         })
         .persistent(uri_s)
     end

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "6.3.4"
+  VERSION = "7.0.0"
 end

data/lib/ldclient-rb.rb

@@ -15,13 +15,12 @@ require "ldclient-rb/expiring_cache"
 require "ldclient-rb/memoized_value"
 require "ldclient-rb/in_memory_store"
 require "ldclient-rb/config"
-require "ldclient-rb/newrelic"
+require "ldclient-rb/context"
+require "ldclient-rb/reference"
 require "ldclient-rb/stream"
 require "ldclient-rb/polling"
-require "ldclient-rb/user_filter"
 require "ldclient-rb/simple_lru_cache"
 require "ldclient-rb/non_blocking_thread_pool"
 require "ldclient-rb/events"
 require "ldclient-rb/requestor"
-require "ldclient-rb/file_data_source"
 require "ldclient-rb/integrations"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly-server-sdk
 version: !ruby/object:Gem::Version
-  version: 6.3.4
+  version: 7.0.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-30 00:00:00.000000000 Z
+date: 2022-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.2
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.2
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -151,19 +151,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: oga
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: semantic
   requirement: !ruby/object:Gem::Requirement
@@ -253,16 +267,19 @@ files:
 - lib/ldclient-rb.rb
 - lib/ldclient-rb/cache_store.rb
 - lib/ldclient-rb/config.rb
+- lib/ldclient-rb/context.rb
 - lib/ldclient-rb/evaluation_detail.rb
 - lib/ldclient-rb/events.rb
 - lib/ldclient-rb/expiring_cache.rb
-- lib/ldclient-rb/file_data_source.rb
 - lib/ldclient-rb/flags_state.rb
 - lib/ldclient-rb/impl.rb
 - lib/ldclient-rb/impl/big_segments.rb
+- lib/ldclient-rb/impl/context.rb
+- lib/ldclient-rb/impl/context_filter.rb
 - lib/ldclient-rb/impl/diagnostic_events.rb
 - lib/ldclient-rb/impl/evaluator.rb
 - lib/ldclient-rb/impl/evaluator_bucketing.rb
+- lib/ldclient-rb/impl/evaluator_helpers.rb
 - lib/ldclient-rb/impl/evaluator_operators.rb
 - lib/ldclient-rb/impl/event_sender.rb
 - lib/ldclient-rb/impl/event_summarizer.rb
@@ -272,6 +289,10 @@ files:
 - lib/ldclient-rb/impl/integrations/file_data_source.rb
 - lib/ldclient-rb/impl/integrations/redis_impl.rb
 - lib/ldclient-rb/impl/integrations/test_data/test_data_source.rb
+- lib/ldclient-rb/impl/model/clause.rb
+- lib/ldclient-rb/impl/model/feature_flag.rb
+- lib/ldclient-rb/impl/model/preprocessed_data.rb
+- lib/ldclient-rb/impl/model/segment.rb
 - lib/ldclient-rb/impl/model/serialization.rb
 - lib/ldclient-rb/impl/repeating_task.rb
 - lib/ldclient-rb/impl/store_client_wrapper.rb
@@ -290,14 +311,12 @@ files:
 - lib/ldclient-rb/interfaces.rb
 - lib/ldclient-rb/ldclient.rb
 - lib/ldclient-rb/memoized_value.rb
-- lib/ldclient-rb/newrelic.rb
 - lib/ldclient-rb/non_blocking_thread_pool.rb
 - lib/ldclient-rb/polling.rb
-- lib/ldclient-rb/redis_store.rb
+- lib/ldclient-rb/reference.rb
 - lib/ldclient-rb/requestor.rb
 - lib/ldclient-rb/simple_lru_cache.rb
 - lib/ldclient-rb/stream.rb
-- lib/ldclient-rb/user_filter.rb
 - lib/ldclient-rb/util.rb
 - lib/ldclient-rb/version.rb
 homepage: https://github.com/launchdarkly/ruby-server-sdk
@@ -312,14 +331,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.17
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: LaunchDarkly SDK for Ruby

data/lib/ldclient-rb/file_data_source.rb

@@ -1,23 +0,0 @@
-require "ldclient-rb/integrations/file_data"
-
-module LaunchDarkly
-  #
-  # Deprecated entry point for the file data source feature.
-  #
-  # The new preferred usage is {LaunchDarkly::Integrations::FileData#data_source}.
-  #
-  # @deprecated This is replaced by {LaunchDarkly::Integrations::FileData}.
-  #
-  class FileDataSource
-    #
-    # Deprecated entry point for the file data source feature.
-    #
-    # The new preferred usage is {LaunchDarkly::Integrations::FileData#data_source}.
-    #
-    # @deprecated This is replaced by {LaunchDarkly::Integrations::FileData#data_source}.
-    #
-    def self.factory(options={})
-      LaunchDarkly::Integrations::FileData.data_source(options)
-    end
-  end
-end

data/lib/ldclient-rb/newrelic.rb

@@ -1,17 +0,0 @@
-module LaunchDarkly
-  # @private
-  class LDNewRelic
-    begin
-      require "newrelic_rpm"
-      NR_ENABLED = defined?(::NewRelic::Agent.add_custom_parameters)
-    rescue ScriptError, StandardError
-      NR_ENABLED = false
-    end
-
-    def self.annotate_transaction(key, value)
-      if NR_ENABLED
-        ::NewRelic::Agent.add_custom_parameters(key.to_s => value.to_s)
-      end
-    end
-  end
-end