feat: Report provider name and version to LaunchDarkly - #51
Draft
kinyoklion wants to merge 2 commits into
Draft
Conversation
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
3 tasks
Co-Authored-By: rlamb@launchdarkly.com <4955475+kinyoklion@users.noreply.github.com>
kinyoklion
added a commit
to launchdarkly/python-server-sdk
that referenced
this pull request
Aug 20, 2026
Adds `Config.with_wrapper_information`, so wrapper libraries can derive a config that identifies themselves without reaching into `Config` internals. - New public method returning a copy of the config with `wrapper_name`/`wrapper_version` replaced - The original config is left unmodified - Mirrors `Configuration.Builder(config).WrapperInfo(...)` in .NET and `LDConfig.Builder.fromConfig(config).wrapper(...)` in Java **Requirements** - [x] I have added test coverage for new or changed functionality - [x] I have followed the repository's [pull request submission guidelines](../blob/main/CONTRIBUTING.md#submitting-pull-requests) - [x] I have validated my changes against all supported platform versions <details> <summary>Implementation details</summary> **Related issues** Needed by [openfeature-python-server#51](launchdarkly/openfeature-python-server#51), where the OpenFeature provider must report itself as the wrapper. Wrapper information can only be supplied to the `Config` constructor today, so a provider that accepts an application-supplied `Config` has no supported way to add it. The .NET and Java providers do this through their SDK's builder-from-config API; Python has no equivalent. `copy_with_new_sdk_key` is the closest existing method, but it is deprecated and rebuilds the config by hand, so it silently drops anything added since it was written (`application`, `hooks`, `plugins`, `datasystem_config`, and others). **Describe the solution you've provided** ```python def with_wrapper_information(self, wrapper_name, wrapper_version=None) -> 'Config': updated = copy.copy(self) updated.__wrapper_name = wrapper_name updated.__wrapper_version = wrapper_version return updated ``` Shallow-copying avoids the maintenance hazard of re-listing every constructor parameter: fields added later are carried over automatically. Component references (feature store, hooks, plugins) are shared with the original config, which matches how a config is used — the derived config is what gets handed to `LDClient`, and the original is not used to build a second client. **Describe alternatives you've considered** - A general `copy_with(**kwargs)`: broader surface area than needed, and re-exposes the constructor's parameter list to the same drift problem. - A `Config.Builder`-style API matching .NET/Java: a much larger change to a long-standing public API, and not required to unblock the providers. - Letting wrappers keep assigning the name-mangled private fields: works, but depends on implementation details of the SDK. **Testing** `test_with_wrapper_information` covers replacing both fields while leaving unrelated settings and the original config intact; `test_with_wrapper_information_defaults_the_version` covers omitting the version. </details> Link to Devin session: https://app.devin.ai/sessions/0c452d209ec54b068ba120b4c92b8f6c Requested by: @kinyoklion <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Overview** > Adds `Config.with_wrapper_information` so wrapper libraries (e.g. OpenFeature providers) can stamp `wrapper_name` / `wrapper_version` onto an application-supplied config without reconstructing it or touching private fields. > > The method shallow-copies the existing `Config`, replaces those two fields, and leaves the original instance unchanged. Shared objects such as the feature store and HTTP config are not cloned. Tests cover replacement of both fields and omitting the version. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 6db02bf. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The provider now identifies itself as the wrapper, so requests it makes are attributed to the OpenFeature provider rather than to the Python SDK.
wrapper_nametoopen-feature-python-serverandwrapper_versionto the provider versionConfig.with_wrapper_information, added in python-server-sdk#501 — blocked until that is released>=9.17.0, the release expected to contain that methodld_openfeature/version.py, kept current by release-pleaseRequirements
Implementation details
Describe the solution you've provided
This matches the Java and .NET providers, which derive a config from the application-supplied one:
The provider version comes from a new
ld_openfeature/version.py, added toextra-filesinrelease-please-config.jsonso the constant is bumped with each release the same waydocs/conf.pyalready is.Describe alternatives you've considered
An earlier revision of this PR copied the
Configand assigned its name-mangled private wrapper fields, because wrapper information could only be supplied to the constructor. That depends on SDK internals, hence the SDK change instead.Additional context
The floor of
>=9.17.0is a guess at the version that will carrywith_wrapper_information(current release is 9.16.1, and the SDK change is afeat:). It needs confirming once that release goes out, and CI here will fail until then since no published SDK has the method.Testing
test_provider_identifies_itself_as_the_wrapperasserts the client's config carries the provider's name and version, and that the config passed in by the caller is unchanged. Verified locally against the SDK branch installed from source (67 tests pass, mypy clean).Link to Devin session: https://app.devin.ai/sessions/0c452d209ec54b068ba120b4c92b8f6c
Requested by: @kinyoklion