prepare 8.0.0 release (#227)

## [8.0.0] - 2023-10-17
The latest version of this SDK supports the ability to manage migrations
or modernizations, using migration flags. You might use this
functionality if you are optimizing queries, upgrading to new tech
stacks, migrating from one database to another, or other similar
technology changes. Migration flags are part of LaunchDarkly's Early
Access Program. This feature is available to all LaunchDarkly customers
but may undergo additional changes before it is finalized.

For detailed information about this version, refer to the list below.
For information on how to upgrade from the previous version, read the
[migration
guide](https://docs.launchdarkly.com/sdk/server-side/ruby/migration-7-to-8).

### Added:
- A new `Migrator` type which provides an out-of-the-box configurable
migration framework.
- For more advanced use cases, added new `migration_variation` and
`track_migration_op` methods on `LDClient`.

### Removed:
- Ruby 2.7 support was removed.
- The legacy user format for contexts is no longer supported. To learn
more, read the [Contexts
documentation](https://docs.launchdarkly.com/guides/flags/intro-contexts).
- Previously deprecated config options `user_keys_capacity`,
`user_keys_flush_interval`, `private_attribute_names`,
`default_user_keys_capacity`, `user_cache_size`, `user_cache_time`, and
`default_user_keys_flush_interval` have been removed.
- Previously deprecated test data flag builder methods
`variation_for_all_users`, `value_for_all_users`, and
`clear_user_targets` have been removed.

---------

Co-authored-by: Jacob Smith <[email protected]>
Co-authored-by: Eli Bishop <[email protected]>
Co-authored-by: LaunchDarklyCI <[email protected]>
Co-authored-by: Elliot <[email protected]>
Co-authored-by: Ben Woskow <[email protected]>
Co-authored-by: Ben Woskow <[email protected]>
Co-authored-by: hroederld <[email protected]>
Co-authored-by: Kerrie Martinez <[email protected]>
Co-authored-by: pellyg-ld <[email protected]>
Co-authored-by: Sam Stokes <[email protected]>
Co-authored-by: LaunchDarklyReleaseBot <[email protected]>
Co-authored-by: Ember Stevens <[email protected]>
Co-authored-by: ember-stevens <[email protected]>
Co-authored-by: Louis Chan <[email protected]>
Co-authored-by: Matthew M. Keeler <[email protected]>
Co-authored-by: Ben Levy <[email protected]>
Co-authored-by: Ben Levy <[email protected]>
Co-authored-by: Matthew M. Keeler <[email protected]>
Co-authored-by: Louis Chan <[email protected]>
Co-authored-by: Matt Hooks <[email protected]>

Author: 16 people

Diff for: .circleci/config.yml

@@ -12,9 +12,6 @@ workflows:
           after-install-rubocop:
             - run: gem install rubocop-performance
       - build-test-windows
-      - build-test-linux:
-          name: Ruby 2.7
-          docker-image: cimg/ruby:2.7
       - build-test-linux:
           name: Ruby 3.0
           docker-image: cimg/ruby:3.0

Diff for: .ldrelease/config.yml

@@ -18,7 +18,7 @@ publications:
 
 jobs:
   - docker:
-      image: ruby:2.7-buster
+      image: ruby:3.0-buster
     template:
       name: ruby
 

Diff for: .rubocop.yml

@@ -2,7 +2,7 @@ require:
   - rubocop-performance
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
   Include:
     - lib/**/*.rb
     - spec/**/*.rb

Diff for: contract-tests/Gemfile

@@ -6,7 +6,8 @@ gem 'sinatra', '~> 2.1'
 # Sinatra can work with several server frameworks. In JRuby, we have to use glassfish (which
 # is only available in JRuby). Otherwise we use thin (which is not available in JRuby).
 gem 'glassfish', :platforms => :jruby
-gem 'thin', :platforms => :ruby
+gem 'http', '~> 5.1'
 gem 'json'
 gem 'rubocop', '~> 1.37', group: 'development'
 gem 'rubocop-performance', '~> 1.15', group: 'development'
+gem 'thin', :platforms => :ruby

Diff for: contract-tests/client_entity.rb

@@ -3,6 +3,7 @@
 require 'net/http'
 require 'launchdarkly-server-sdk'
 require './big_segment_store_fixture'
+require 'http'
 
 class ClientEntity
   def initialize(log, config)
@@ -77,12 +78,12 @@ def evaluate(params)
     response = {}
 
     if params[:detail]
-      detail = @client.variation_detail(params[:flagKey], params[:context] || params[:user], params[:defaultValue])
+      detail = @client.variation_detail(params[:flagKey], params[:context], params[:defaultValue])
       response[:value] = detail.value
       response[:variationIndex] = detail.variation_index
       response[:reason] = detail.reason
     else
-      response[:value] = @client.variation(params[:flagKey], params[:context] || params[:user], params[:defaultValue])
+      response[:value] = @client.variation(params[:flagKey], params[:context], params[:defaultValue])
     end
 
     response
@@ -94,19 +95,65 @@ def evaluate_all(params)
     opts[:with_reasons] = params[:withReasons] || false
     opts[:details_only_for_tracked_flags] = params[:detailsOnlyForTrackedFlags] || false
 
-    @client.all_flags_state(params[:context] || params[:user], opts)
+    @client.all_flags_state(params[:context], opts)
+  end
+
+  def migration_variation(params)
+    default_stage = params[:defaultStage]
+    default_stage = default_stage.to_sym if default_stage.respond_to? :to_sym
+    stage, _ = @client.migration_variation(params[:key], params[:context], default_stage)
+    stage
+  end
+
+  def migration_operation(params)
+    builder = LaunchDarkly::Migrations::MigratorBuilder.new(@client)
+    builder.read_execution_order(params[:readExecutionOrder].to_sym)
+    builder.track_latency(params[:trackLatency])
+    builder.track_errors(params[:trackErrors])
+
+    callback = ->(endpoint) {
+      ->(payload) {
+        response = HTTP.post(endpoint, body: payload)
+
+        if response.status.success?
+          LaunchDarkly::Result.success(response.body.to_s)
+        else
+          LaunchDarkly::Result.fail("requested failed with status code #{response.status}")
+        end
+      }
+    }
+
+    consistency = nil
+    if params[:trackConsistency]
+      consistency = ->(lhs, rhs) { lhs == rhs }
+    end
+
+    builder.read(callback.call(params[:oldEndpoint]), callback.call(params[:newEndpoint]), consistency)
+    builder.write(callback.call(params[:oldEndpoint]), callback.call(params[:newEndpoint]))
+
+    migrator = builder.build
+
+    return migrator if migrator.is_a? String
+
+    if params[:operation] == LaunchDarkly::Migrations::OP_READ.to_s
+      result = migrator.read(params[:key], params[:context], params[:defaultStage].to_sym, params[:payload])
+      result.success? ? result.value : result.error
+    else
+      result = migrator.write(params[:key], params[:context], params[:defaultStage].to_sym, params[:payload])
+      result.authoritative.success? ? result.authoritative.value : result.authoritative.error
+    end
   end
 
   def secure_mode_hash(params)
-    @client.secure_mode_hash(params[:context] || params[:user])
+    @client.secure_mode_hash(params[:context])
   end
 
   def track(params)
-    @client.track(params[:eventKey], params[:context] || params[:user], params[:data], params[:metricValue])
+    @client.track(params[:eventKey], params[:context], params[:data], params[:metricValue])
   end
 
   def identify(params)
-    @client.identify(params[:context] || params[:user])
+    @client.identify(params[:context])
   end
 
   def flush_events

Diff for: contract-tests/service.rb

@@ -32,8 +32,9 @@
       'all-flags-details-only-for-tracked-flags',
       'filtering',
       'secure-mode-hash',
-      'user-type',
       'tags',
+      'migrations',
+      'event-sampling',
     ],
   }.to_json
 end
@@ -102,6 +103,12 @@
   when "getBigSegmentStoreStatus"
     status = client.get_big_segment_store_status
     return [200, nil, status.to_json]
+  when "migrationVariation"
+    response = {:result => client.migration_variation(params[:migrationVariation]).to_s}
+    return [200, nil, response.to_json]
+  when "migrationOperation"
+    response = {:result => client.migration_operation(params[:migrationOperation]).to_s}
+    return [200, nil, response.to_json]
   end
 
   return [400, nil, {:error => "Unknown command requested"}.to_json]

Diff for: launchdarkly-server-sdk.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.files         = FileList["lib/**/*", "README.md", "LICENSE.txt"]
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.add_development_dependency "aws-sdk-dynamodb", "~> 1.57"
   spec.add_development_dependency "bundler", "2.2.33"

Diff for: lib/ldclient-rb.rb

@@ -9,6 +9,7 @@ module LaunchDarkly
 require "ldclient-rb/interfaces"
 require "ldclient-rb/util"
 require "ldclient-rb/flags_state"
+require "ldclient-rb/migrations"
 require "ldclient-rb/ldclient"
 require "ldclient-rb/cache_store"
 require "ldclient-rb/expiring_cache"

Diff for: lib/ldclient-rb/config.rb

@@ -13,18 +13,6 @@ class Config
     #
     # Constructor for creating custom LaunchDarkly configurations.
     #
-    # `user_keys_capacity` and `user_keys_flush_interval` are deprecated
-    # configuration options. They exist to maintain backwards compatibility
-    # with previous configurations. Newer code should prefer their replacement
-    # options -- `context_keys_capacity` and `context_keys_flush_interval`.
-    #
-    # In the event both the user and context variations are provided, the
-    # context specific configuration option will take precedence.
-    #
-    # Similarly, `private_attribute_names` is deprecated. Newer code should
-    # prefer `private_attributes`. If both are provided, `private_attributes`
-    # will take precedence.
-    #
     # @param opts [Hash] the configuration options
     # @option opts [Logger] :logger See {#logger}.
     # @option opts [String] :base_uri ("https://sdk.launchdarkly.com") See {#base_uri}.
@@ -42,12 +30,9 @@ class Config
     # @option opts [Float] :poll_interval (30) See {#poll_interval}.
     # @option opts [Boolean] :stream (true) See {#stream?}.
     # @option opts [Boolean] all_attributes_private (false) See {#all_attributes_private}.
-    # @option opts [Array] :private_attribute_names See {#private_attribute_names}.
     # @option opts [Array] :private_attributes See {#private_attributes}.
     # @option opts [Boolean] :send_events (true) See {#send_events}.
-    # @option opts [Integer] :user_keys_capacity (1000) See {#user_keys_capacity}.
     # @option opts [Integer] :context_keys_capacity (1000) See {#context_keys_capacity}.
-    # @option opts [Float] :user_keys_flush_interval (300) See {#user_keys_flush_interval}.
     # @option opts [Float] :context_keys_flush_interval (300) See {#context_keys_flush_interval}.
     # @option opts [Object] :data_source See {#data_source}.
     # @option opts [Boolean] :diagnostic_opt_out (false) See {#diagnostic_opt_out?}.
@@ -76,10 +61,10 @@ def initialize(opts = {})
       @offline = opts.has_key?(:offline) ? opts[:offline] : Config.default_offline
       @poll_interval = opts.has_key?(:poll_interval) && opts[:poll_interval] > Config.default_poll_interval ? opts[:poll_interval] : Config.default_poll_interval
       @all_attributes_private = opts[:all_attributes_private] || false
-      @private_attributes = opts[:private_attributes] || opts[:private_attribute_names] || []
+      @private_attributes = opts[:private_attributes] || []
       @send_events = opts.has_key?(:send_events) ? opts[:send_events] : Config.default_send_events
-      @context_keys_capacity = opts[:context_keys_capacity] || opts[:user_keys_capacity] || Config.default_context_keys_capacity
-      @context_keys_flush_interval = opts[:context_keys_flush_interval] || opts[:user_keys_flush_interval] || Config.default_user_keys_flush_interval
+      @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]
       @diagnostic_opt_out = opts.has_key?(:diagnostic_opt_out) && opts[:diagnostic_opt_out]
       @diagnostic_recording_interval = opts.has_key?(:diagnostic_recording_interval) && opts[:diagnostic_recording_interval] > Config.minimum_diagnostic_recording_interval ?
@@ -258,14 +243,6 @@ def offline?
     #
     attr_reader :private_attributes
 
-    #
-    # @deprecated Backwards compatibility alias for #private_attributes.
-    #
-    # @return [Integer]
-    # @see #private_attributes
-    #
-    alias :private_attribute_names :private_attributes
-
     #
     # Whether to send events back to LaunchDarkly. This differs from {#offline?} in that it affects
     # only the sending of client-side events, not streaming or polling for events from the server.
@@ -281,29 +258,13 @@ def offline?
     #
     attr_reader :context_keys_capacity
 
-    #
-    # @deprecated Backwards compatibility alias for #context_keys_capacity.
-    #
-    # @return [Integer]
-    # @see #context_keys_flush_interval
-    #
-    alias :user_keys_capacity :context_keys_capacity
-
     #
     # The interval in seconds at which the event processor will reset its set of known context keys.
     # @return [Float]
     # @see #context_keys_capacity
     #
     attr_reader :context_keys_flush_interval
 
-    #
-    # @deprecated Backwards compatibility alias for #context_keys_flush_interval.
-    #
-    # @return [Integer]
-    # @see #context_keys_flush_interval
-    #
-    alias :user_keys_flush_interval :context_keys_flush_interval
-
     #
     # An object that is responsible for receiving feature flag data from LaunchDarkly. By default,
     # the client uses its standard polling or streaming implementation; this is customizable for
@@ -570,18 +531,6 @@ def self.default_context_keys_flush_interval
       300
     end
 
-    class << self
-      #
-      # @deprecated Backwards compatibility alias for #default_context_keys_capacity
-      #
-      alias :default_user_keys_capacity :default_context_keys_capacity
-
-      #
-      # @deprecated Backwards compatibility alias for #default_context_keys_flush_interval
-      #
-      alias :default_user_keys_flush_interval :default_context_keys_flush_interval
-    end
-
     #
     # The default value for {#diagnostic_recording_interval}.
     # @return [Float] 900
@@ -647,25 +596,11 @@ def initialize(store:, context_cache_size: nil, context_cache_time: nil, status_
     # @return [Integer]
     attr_reader :context_cache_size
 
-    #
-    # @deprecated Backwards compatibility alias for #context_cache_size
-    #
-    # @return [Integer]
-    #
-    alias :user_cache_size :context_cache_size
-
     # The maximum length of time (in seconds) that the Big Segment state for a context will be cached
     # by the SDK.
     # @return [Float]
     attr_reader :context_cache_time
 
-    #
-    # @deprecated Backwards compatibility alias for #context_cache_time
-    #
-    # @return [Float]
-    #
-    alias :user_cache_time :context_cache_time
-
     # The interval (in seconds) at which the SDK will poll the Big Segment store to make sure it is
     # available and to determine how long ago it was updated.
     # @return [Float]

Diff for: lib/ldclient-rb/context.rb

@@ -324,7 +324,6 @@ def self.with_key(key, kind = KIND_DEFAULT)
     #
     def self.create(data)
       return create_invalid_context(ERR_NOT_HASH) unless data.is_a?(Hash)
-      return create_legacy_context(data) unless data.has_key?(:kind)
 
       kind = data[:kind]
       if kind == KIND_MULTI
@@ -394,52 +393,6 @@ def self.create_multi(contexts)
       new(nil, nil, nil, nil, false, nil, nil, error)
     end
 
-    #
-    # @param data [Hash]
-    # @return [LDContext]
-    #
-    private_class_method def self.create_legacy_context(data)
-      warn("DEPRECATED: legacy user format will be removed in 8.0.0", uplevel: 1)
-
-      key = data[:key]
-
-      # Legacy users are allowed to have "" as a key but they cannot have nil as a key.
-      return create_invalid_context(ERR_KEY_EMPTY) if key.nil?
-
-      name = data[:name]
-      name_error = LaunchDarkly::Impl::Context.validate_name(name)
-      return create_invalid_context(name_error) unless name_error.nil?
-
-      anonymous = data[:anonymous]
-      anonymous_error = LaunchDarkly::Impl::Context.validate_anonymous(anonymous, true)
-      return create_invalid_context(anonymous_error) unless anonymous_error.nil?
-
-      custom = data[:custom]
-      unless custom.nil? || custom.is_a?(Hash)
-        return create_invalid_context(ERR_CUSTOM_NON_HASH)
-      end
-
-      # We only need to create an attribute hash if one of these keys exist.
-      # Everything else is stored in dedicated instance variables.
-      attributes = custom.clone
-      data.each do |k, v|
-        case k
-        when :ip, :email, :avatar, :firstName, :lastName, :country
-          attributes ||= {}
-          attributes[k] = v.clone
-        else
-          next
-        end
-      end
-
-      private_attributes = data[:privateAttributeNames]
-      if private_attributes && !private_attributes.is_a?(Array)
-        return create_invalid_context(ERR_PRIVATE_NON_ARRAY)
-      end
-
-      new(key.to_s, key.to_s, KIND_DEFAULT, name, anonymous, attributes, private_attributes)
-    end
-
     #
     # @param data [Hash]
     # @param kind [String]

Diff for: lib/ldclient-rb/evaluation_detail.rb

@@ -1,4 +1,3 @@
-
 module LaunchDarkly
 # An object returned by {LDClient#variation_detail}, combining the result of a flag evaluation with
   # an explanation of how it was calculated.
@@ -13,6 +12,7 @@ class EvaluationDetail
     def initialize(value, variation_index, reason)
       raise ArgumentError.new("variation_index must be a number") if !variation_index.nil? && !(variation_index.is_a? Numeric)
       raise ArgumentError.new("reason must be an EvaluationReason") unless reason.is_a? EvaluationReason
+
       @value = value
       @variation_index = variation_index
       @reason = reason
@@ -100,6 +100,10 @@ class EvaluationReason
     # a rule specified a nonexistent  variation. An error message will always be logged in this case.
     ERROR_MALFORMED_FLAG = :MALFORMED_FLAG
 
+    # Value for {#error_kind} indicating that there was an inconsistency between the expected type of the flag, and the
+    # actual type of the variation evaluated.
+    ERROR_WRONG_TYPE = :WRONG_TYPE
+
     # Value for {#error_kind} indicating that the caller passed `nil` for the context parameter, or the
     # context was invalid.
     ERROR_USER_NOT_SPECIFIED = :USER_NOT_SPECIFIED