Skip to content

feat: Support provider initialization and shutdown#28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kinyoklion merged 1 commit into from
Aug 21, 2026
Merged

feat: Support provider initialization and shutdown #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions lib/ldclient-openfeature/provider.rb
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,31 @@ def initialize(sdk_key, config = LaunchDarkly::Config.default, wait_for_seconds
@metadata = ::OpenFeature::SDK::Provider::ProviderMetadata.new(name: "launchdarkly-openfeature-server").freeze
end

#
# Called by the OpenFeature SDK when this provider is set. The LaunchDarkly client has already been given the
# opportunity to initialize, so this only reports whether that succeeded.
#
# @param _evaluation_context [::OpenFeature::SDK::EvaluationContext, nil]
#
# @return [void]
#
def init(_evaluation_context = nil)
return if @client.initialized?

state = @client.data_source_status_provider.status.state
raise "the LaunchDarkly client was unable to initialize; the data source state is #{state}"

@kinyoklionkinyoklionAug 21, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The OpenFeature SDK will catch this exception? I want to double check that raising is the expectation.

@devin-ai-integrationdevin-ai-integrationBotAug 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes — raising is the mechanism the OpenFeature Ruby SDK expects. Configuration#init_provider wraps the init call in a rescue, dispatches PROVIDER_ERROR (which moves provider state to ERROR), and only re-raises — as ProviderInitializationError — when the caller used set_provider_and_wait. With set_provider the init runs on its own thread and the exception is swallowed after the error event (v0.6.5 configuration.rb):

definit_provider(provider,context,raise_on_error: false)
...
dispatch_provider_event(provider,ProviderEvent::PROVIDER_READY)rescue=>eerror_code=(e.error_codeife.respond_to?(:error_code) && e.error_code) || Provider::ErrorCode::GENERALdispatch_provider_event(provider,ProviderEvent::PROVIDER_ERROR,error_code:,message: e.message)raiseProviderInitializationError.new(...,original_error: e)ifraise_on_errorend

So a failed initialization ends in the ERROR state rather than FATAL, matching the mapping we settled on in the spec: the LaunchDarkly client can still serve whatever data it has, so the OpenFeature SDK should keep calling the provider. Note the SDK also reads error_code off the exception if it exposes one, so we could raise a custom error later if we want something more specific than GENERAL.

end

#
# Called by the OpenFeature SDK when this provider is replaced or the SDK is shut down. The LaunchDarkly client
# cannot be restarted, so a new provider instance is required afterward.
#
# @return [void]
#
def shutdown
@client.close
end

def fetch_boolean_value(flag_key:, default_value:, evaluation_context: nil)
resolve_value(:boolean, flag_key, default_value, evaluation_context)
end
Expand Down
20 changes: 20 additions & 0 deletions spec/provider_spec.rb
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,26 @@
expect(provider.client).not_to have_received(:track)
end

it "init succeeds when the client is initialized" do
expect { provider.init(evaluation_context) }.not_to raise_error
end

it "init raises when the client failed to initialize" do
status = LaunchDarkly::Interfaces::DataSource::Status.new(LaunchDarkly::Interfaces::DataSource::Status::OFF, Time.now, nil)
status_provider = double(status: status)
allow(provider.client).to receive_messages(initialized?: false, data_source_status_provider: status_provider)

expect { provider.init(evaluation_context) }.to raise_error(/unable to initialize/)
end

it "shutdown closes the client" do
allow(provider.client).to receive(:close)

provider.shutdown

expect(provider.client).to have_received(:close)
end

it "not providing context returns error" do
resolution_details = provider.fetch_boolean_value(flag_key: "flag-key", default_value: true)

Expand Down
Loading