launchdarkly-server-sdk 8.11.2-java → 8.12.0-java

data/lib/ldclient-rb/integrations/file_data.rb

@@ -1,4 +1,5 @@
 require 'ldclient-rb/impl/integrations/file_data_source'
+require 'ldclient-rb/impl/integrations/file_data_source_v2'
 
 module LaunchDarkly
   module Integrations
@@ -103,6 +104,72 @@ module LaunchDarkly
         lambda { |sdk_key, config|
           Impl::Integrations::FileDataSourceImpl.new(config.feature_store, config.data_source_update_sink, config.logger, options) }
       end
+
+      #
+      # Returns a builder for the FDv2-compatible file data source.
+      #
+      # This method is not stable, and not subject to any backwards compatibility guarantees or semantic versioning.
+      # It is in early access. If you want access to this feature please join the EAP. https://launchdarkly.com/docs/sdk/features/data-saving-mode
+      #
+      # This method returns a builder proc that can be used with the FDv2 data system
+      # configuration as both an Initializer and a Synchronizer. When used as an Initializer
+      # (via `fetch`), it reads files once. When used as a Synchronizer (via `sync`), it
+      # watches for file changes and automatically updates when files are modified.
+      #
+      # @param options [Hash] the configuration options
+      # @option options [Array<String>, String] :paths  The paths of the source files for loading flag data. These
+      #   may be absolute paths or relative to the current working directory. (Required)
+      # @option options [Float] :poll_interval  The minimum interval, in seconds, between checks for
+      #   file modifications - used only if the native file-watching mechanism from 'listen' is not
+      #   being used. The default value is 1 second.
+      # @return [FileDataSourceV2Builder] a builder that can be used as an FDv2 initializer or synchronizer
+      #
+      # @example Using as an initializer
+      #   file_source = LaunchDarkly::Integrations::FileData.data_source_v2(paths: ['flags.json'])
+      #   data_system_config = LaunchDarkly::DataSystemConfig.new(
+      #     initializers: [file_source]
+      #   )
+      #   config = LaunchDarkly::Config.new(data_system: data_system_config)
+      #
+      # @example Using as a synchronizer
+      #   file_source = LaunchDarkly::Integrations::FileData.data_source_v2(paths: ['flags.json'])
+      #   data_system_config = LaunchDarkly::DataSystemConfig.new(
+      #     synchronizers: [file_source]
+      #   )
+      #   config = LaunchDarkly::Config.new(data_system: data_system_config)
+      #
+      # @example Using as both initializer and synchronizer
+      #   file_source = LaunchDarkly::Integrations::FileData.data_source_v2(paths: ['flags.json'])
+      #   data_system_config = LaunchDarkly::DataSystemConfig.new(
+      #     initializers: [file_source],
+      #     synchronizers: [file_source]
+      #   )
+      #   config = LaunchDarkly::Config.new(data_system: data_system_config)
+      #
+      def self.data_source_v2(options = {})
+        paths = options[:paths] || []
+        poll_interval = options[:poll_interval] || 1
+
+        FileDataSourceV2Builder.new(paths, poll_interval)
+      end
+    end
+
+    #
+    # Builder for FileDataSourceV2.
+    #
+    class FileDataSourceV2Builder
+      def initialize(paths, poll_interval)
+        @paths = paths
+        @poll_interval = poll_interval
+      end
+
+      def build(_sdk_key, config)
+        Impl::Integrations::FileDataSourceV2.new(
+          config.logger,
+          paths: @paths,
+          poll_interval: @poll_interval
+        )
+      end
     end
   end
 end

data/lib/ldclient-rb/integrations/test_data/flag_builder.rb

@@ -12,14 +12,14 @@ module LaunchDarkly
       class FlagBuilder
         attr_reader :key
 
-        # @private
+        # @api private
         def initialize(key)
           @key = key
           @on = true
           @variations = []
         end
 
-        # @private
+        # @api private
         def initialize_copy(other)
           super(other)
           @variations = @variations.clone
@@ -357,7 +357,7 @@ module LaunchDarkly
           self
         end
 
-        # @private
+        # @api private
         def add_rule(rule)
           if @rules.nil?
             @rules = Array.new
@@ -386,7 +386,7 @@ module LaunchDarkly
           end
         end
 
-        # @private
+        # @api private
         def build(version)
           res = { key: @key,
                   version: version,
@@ -486,16 +486,16 @@ module LaunchDarkly
         # Finally, call {#then_return} to finish defining the rule.
         #
         class FlagRuleBuilder
-          # @private
+          # @api private
           FlagRuleClause = Struct.new(:contextKind, :attribute, :op, :values, :negate, keyword_init: true) # rubocop:disable Naming/MethodName:
 
-          # @private
+          # @api private
           def initialize(flag_builder)
             @flag_builder = flag_builder
             @clauses = Array.new
           end
 
-          # @private
+          # @api private
           def intialize_copy(other)
             super(other)
             @clauses = @clauses.clone
@@ -612,7 +612,7 @@ module LaunchDarkly
             end
           end
 
-          # @private
+          # @api private
           def build(ri)
             {
               id: 'rule' + ri.to_s,
@@ -622,7 +622,7 @@ module LaunchDarkly
           end
         end
 
-        # @private
+        # @api private
         def variation_for_boolean(variation)
           variation ? TRUE_VARIATION_INDEX : FALSE_VARIATION_INDEX
         end

data/lib/ldclient-rb/integrations/test_data.rb

@@ -42,7 +42,7 @@ module LaunchDarkly
         self.new
       end
 
-      # @private
+      # @api private
       def initialize
         @flag_builders = Hash.new
         @current_flags = Hash.new
@@ -56,7 +56,7 @@ module LaunchDarkly
       # Called internally by the SDK to determine what arguments to pass to call
       # You do not need to call this method.
       #
-      # @private
+      # @api private
       def arity
         2
       end
@@ -65,7 +65,7 @@ module LaunchDarkly
       # Called internally by the SDK to associate this test data source with an {@code LDClient} instance.
       # You do not need to call this method.
       #
-      # @private
+      # @api private
       def call(_, config)
         impl = LaunchDarkly::Impl::Integrations::TestData::TestDataSource.new(config.feature_store, self)
         @instances_lock.with_write_lock { @instances.push(impl) }
@@ -121,10 +121,10 @@ module LaunchDarkly
           if @current_flags[flag_key]
             version = @current_flags[flag_key][:version]
           end
-          new_flag = Impl::Model.deserialize(FEATURES, flag_builder.build(version+1))
+          new_flag = LaunchDarkly::Impl::Model.deserialize(LaunchDarkly::Impl::DataStore::FEATURES, flag_builder.build(version+1))
           @current_flags[flag_key] = new_flag
         end
-        update_item(FEATURES, new_flag)
+        update_item(LaunchDarkly::Impl::DataStore::FEATURES, new_flag)
         self
       end
 
@@ -147,7 +147,7 @@ module LaunchDarkly
       # @return [TestData] the TestData instance
       #
       def use_preconfigured_flag(flag)
-        use_preconfigured_item(FEATURES, flag, @current_flags)
+        use_preconfigured_item(LaunchDarkly::Impl::DataStore::FEATURES, flag, @current_flags)
       end
 
       #
@@ -167,7 +167,7 @@ module LaunchDarkly
       # @return [TestData] the TestData instance
       #
       def use_preconfigured_segment(segment)
-        use_preconfigured_item(SEGMENTS, segment, @current_segments)
+        use_preconfigured_item(LaunchDarkly::Impl::DataStore::SEGMENTS, segment, @current_segments)
       end
 
       private def use_preconfigured_item(kind, item, current)
@@ -194,17 +194,17 @@ module LaunchDarkly
         end
       end
 
-      # @private
+      # @api private
       def make_init_data
         @lock.with_read_lock do
           {
-            FEATURES => @current_flags.clone,
-            SEGMENTS => @current_segments.clone,
+            LaunchDarkly::Impl::DataStore::FEATURES => @current_flags.clone,
+            LaunchDarkly::Impl::DataStore::SEGMENTS => @current_segments.clone,
           }
         end
       end
 
-      # @private
+      # @api private
       def closed_instance(instance)
         @instances_lock.with_write_lock { @instances.delete(instance) }
       end