From e25e9d76b6f4dd94a05d6bce9dcca94cf99b1457 Mon Sep 17 00:00:00 2001 From: Matthew Keeler Date: Tue, 12 May 2026 09:39:53 -0400 Subject: [PATCH] chore: remove FDv2 pre-release warnings for GA promotion FDv2 / data-saving mode is going GA per the SDK release-standards spec. Removes the pre-release warning prose ("not stable, and not subject to any backwards compatibility guarantees", "not suitable for production usage", "in early access. ...join the EAP") from FDv2-related YARD comments. Descriptive comments are preserved. SDK-2349 --- lib/ldclient-rb/config.rb | 3 -- .../impl/data_system/protocolv2.rb | 12 ----- lib/ldclient-rb/integrations/file_data.rb | 3 -- lib/ldclient-rb/integrations/test_data_v2.rb | 3 -- lib/ldclient-rb/interfaces/data_system.rb | 54 ------------------- 5 files changed, 75 deletions(-) diff --git a/lib/ldclient-rb/config.rb b/lib/ldclient-rb/config.rb index 55a676ad..fb1c2170 100644 --- a/lib/ldclient-rb/config.rb +++ b/lib/ldclient-rb/config.rb @@ -697,9 +697,6 @@ def initialize(store:, context_cache_size: nil, context_cache_time: nil, status_ # # Configuration for LaunchDarkly's data acquisition strategy. # - # This is not stable and is not subject to any backwards compatibility guarantees - # or semantic versioning. It is not suitable for production usage. - # class DataSystemConfig # # @param initializers [Array<#build(String, Config)>, nil] The (optional) array of builders diff --git a/lib/ldclient-rb/impl/data_system/protocolv2.rb b/lib/ldclient-rb/impl/data_system/protocolv2.rb index 05d832da..ef6b5ad3 100644 --- a/lib/ldclient-rb/impl/data_system/protocolv2.rb +++ b/lib/ldclient-rb/impl/data_system/protocolv2.rb @@ -12,9 +12,6 @@ module ProtocolV2 # # DeleteObject specifies the deletion of a particular object. # - # This type is not stable, and not subject to any backwards - # compatibility guarantees or semantic versioning. It is not suitable for production usage. - # class DeleteObject # @return [Integer] The version attr_reader :version @@ -79,9 +76,6 @@ def self.from_h(data) # # PutObject specifies the addition of a particular object with upsert semantics. # - # This type is not stable, and not subject to any backwards - # compatibility guarantees or semantic versioning. It is not suitable for production usage. - # class PutObject # @return [Integer] The version attr_reader :version @@ -153,9 +147,6 @@ def self.from_h(data) # # Goodbye represents a goodbye event. # - # This type is not stable, and not subject to any backwards - # compatibility guarantees or semantic versioning. It is not suitable for production usage. - # class Goodbye # @return [String] The reason for goodbye attr_reader :reason @@ -197,9 +188,6 @@ def self.from_h(data) # # Error represents an error event. # - # This type is not stable, and not subject to any backwards - # compatibility guarantees or semantic versioning. It is not suitable for production usage. - # class Error # @return [String] The payload ID attr_reader :payload_id diff --git a/lib/ldclient-rb/integrations/file_data.rb b/lib/ldclient-rb/integrations/file_data.rb index 256c360a..e371a8f9 100644 --- a/lib/ldclient-rb/integrations/file_data.rb +++ b/lib/ldclient-rb/integrations/file_data.rb @@ -108,9 +108,6 @@ def self.data_source(options={}) # # 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 diff --git a/lib/ldclient-rb/integrations/test_data_v2.rb b/lib/ldclient-rb/integrations/test_data_v2.rb index 52ed6500..fe2da447 100644 --- a/lib/ldclient-rb/integrations/test_data_v2.rb +++ b/lib/ldclient-rb/integrations/test_data_v2.rb @@ -9,9 +9,6 @@ module Integrations # A mechanism for providing dynamically updatable feature flag state in a # simplified form to an SDK client in test scenarios using the FDv2 protocol. # - # This class 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 - # # Unlike {LaunchDarkly::Integrations::FileData}, this mechanism does not use any external resources. It # provides only the data that the application has put into it using the {#update} method. # diff --git a/lib/ldclient-rb/interfaces/data_system.rb b/lib/ldclient-rb/interfaces/data_system.rb index 72e52e56..ef517a85 100644 --- a/lib/ldclient-rb/interfaces/data_system.rb +++ b/lib/ldclient-rb/interfaces/data_system.rb @@ -6,9 +6,6 @@ module DataSystem # # EventName represents the name of an event that can be sent by the server for FDv2. # - # This type 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 - # module EventName # Specifies that an object should be added to the data set with upsert semantics. PUT_OBJECT = :"put-object" @@ -35,9 +32,6 @@ module EventName # # ObjectKind represents the kind of object. # - # This type 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 - # module ObjectKind # Represents a feature flag. FLAG = "flag" @@ -49,9 +43,6 @@ module ObjectKind # # ChangeType specifies if an object is being upserted or deleted. # - # This type 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 - # module ChangeType # Represents an object being upserted. PUT = "put" @@ -63,9 +54,6 @@ module ChangeType # # IntentCode represents the various intents that can be sent by the server. # - # This type 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 - # module IntentCode # The server intends to send a full data set. TRANSFER_FULL = "xfer-full" @@ -80,9 +68,6 @@ module IntentCode # # DataStoreMode represents the mode of operation of a Data Store in FDV2 mode. # - # This type 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 - # module DataStoreMode # Indicates that the data store is read-only. Data will never be written back to the store by the SDK. READ_ONLY = :read_only @@ -95,9 +80,6 @@ module DataStoreMode # # Selector represents a particular snapshot of data. # - # This type 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 - # class Selector # @return [String] The state attr_reader :state @@ -196,9 +178,6 @@ def hash # # Change represents a change to a piece of data, such as an update or deletion. # - # This type 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 - # class Change # @return [String] The action ({ChangeType}) attr_reader :action @@ -234,9 +213,6 @@ def initialize(action:, kind:, key:, version:, object: nil) # # ChangeSet represents a list of changes to be applied. # - # This type 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 - # class ChangeSet # @return [String] The intent code ({IntentCode}) attr_reader :intent_code @@ -262,9 +238,6 @@ def initialize(intent_code:, changes:, selector:) # # Basis represents the initial payload of data that a data source can provide. # - # This type 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 - # class Basis # @return [ChangeSet] The change set attr_reader :change_set @@ -290,9 +263,6 @@ def initialize(change_set:, persist:, environment_id: nil) # # Payload represents a payload delivered in a streaming response. # - # This type 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 - # class Payload # @return [String] The payload ID attr_reader :id @@ -357,9 +327,6 @@ def self.from_h(data) # # ServerIntent represents the type of change associated with the payload. # - # This type 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 - # class ServerIntent # @return [Payload] The payload attr_reader :payload @@ -405,9 +372,6 @@ def self.from_h(data) # # ChangeSetBuilder is a helper for constructing a ChangeSet. # - # This type 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 - # class ChangeSetBuilder # @return [String, nil] The current intent ({IntentCode}) attr_accessor :intent @@ -546,9 +510,6 @@ def add_delete(kind, key, version) # # Update represents the results of a synchronizer's ongoing sync method. # - # This type 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 - # class Update # @return [Symbol] The data source state ({LaunchDarkly::Interfaces::DataSource::Status}) attr_reader :state @@ -592,9 +553,6 @@ def initialize(state:, change_set: nil, error: nil, fallback_to_fdv1: false, env # Surfacing this signal alongside the {LaunchDarkly::Result} ensures # callers cannot silently drop it. # - # This type 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 - # class FetchResult # @return [LaunchDarkly::Result] A Result containing either a {Basis} or an error. attr_reader :result @@ -635,9 +593,6 @@ def exception # # SelectorStore represents a component capable of providing Selectors for data retrieval. # - # This type 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 - # module SelectorStore # # Returns a Selector object that defines the criteria for data retrieval. @@ -652,9 +607,6 @@ def selector # # ReadOnlyStore represents a read-only store interface for retrieving data. # - # This type 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 - # module ReadOnlyStore # # Retrieves an item by kind and key. @@ -690,9 +642,6 @@ def initialized? # # Initializer represents a component capable of retrieving a single data result. # - # This type 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 - # module Initializer # # Returns the name of the initializer. @@ -723,9 +672,6 @@ def fetch(selector_store) # # Synchronizer represents a component capable of synchronizing data from an external source. # - # This type 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 - # module Synchronizer # # Returns the name of the synchronizer.