Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
5d08f23
feat: init Unleash provider
kikihakiem Aug 26, 2025
7cd1f29
feat(provider): implement Unleash get_metadata
kikihakiem Aug 27, 2025
37ea750
feat(provider): implement Unleash resolve_boolean_details
kikihakiem Aug 27, 2025
aa553ca
feat(provider): implement Unleash resolve_string_details, resolve_int…
kikihakiem Aug 27, 2025
c0ccb1b
feat(provider): implement Unleash async resolve() functions
kikihakiem Aug 27, 2025
d14585e
feat(provider): handle Unleash evaluation_context
kikihakiem Aug 27, 2025
cc46cbc
feat(provider): improve Unleash error handling
kikihakiem Aug 27, 2025
251dc26
feat(provider): add flag metadata and Unleash provider initializer
kikihakiem Aug 27, 2025
523a088
feat(provider): implement Unleash provider events
kikihakiem Aug 27, 2025
80dfd97
feat(provider): implement Unleash impression tracking
kikihakiem Aug 27, 2025
a103dce
refactor: unleash tracker
kikihakiem Aug 27, 2025
0be7f78
refactor: unleash events
kikihakiem Aug 27, 2025
05aac86
refactor: unleash flag evaluation
kikihakiem Aug 27, 2025
61ef3be
feat(provider): unleash specify environment when initializing client
kikihakiem Aug 27, 2025
3af7dbc
fix(provider): handle_unleash_event
kikihakiem Aug 27, 2025
232131d
test(provider): add unleash integration tests
kikihakiem Aug 27, 2025
104b8ef
test(provider): unleash integration test use testcontainers
kikihakiem Aug 28, 2025
286765f
feat(provider): improve type safety
kikihakiem Aug 28, 2025
348b145
style: fix issues reported by ruff check
kikihakiem Aug 28, 2025
966bd25
style: add ruff config
kikihakiem Aug 28, 2025
26d1c8f
docs: update README.md
kikihakiem Sep 2, 2025
75ae1c8
refactor(provider): remove impossible error handling for Unleash
kikihakiem Sep 3, 2025
06d58cd
feat(provider): allow injecting custom cache to Unleash client
kikihakiem Sep 4, 2025
07fe279
feat(provider): proper Unleash lifecycle event handling
kikihakiem Sep 10, 2025
93610f8
chore(ci): add Unleash to packages matrix
kikihakiem Sep 10, 2025
6f7f253
refactor(provider): remove unused exception handling
kikihakiem Sep 29, 2025
3d1fde8
feat(provider): resolve_boolean_details honors default_value
kikihakiem Sep 29, 2025
7f804ac
feat(provider): remove Unleash provider tracking
kikihakiem Oct 3, 2025
1021c2e
feat(provider): remove deprecated environment argument
kikihakiem Oct 3, 2025
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
3 changes: 3 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ jobs:
providers/openfeature-provider-ofrep:
- 'providers/openfeature-provider-ofrep/**'
- 'uv.lock'
providers/openfeature-provider-unleash:
- 'providers/openfeature-provider-unleash/**'
- 'uv.lock'

build:
needs: changes
Expand Down
3 changes: 2 additions & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@
"providers/openfeature-provider-flagd": "0.2.6",
"providers/openfeature-provider-ofrep": "0.2.0",
"providers/openfeature-provider-flipt": "0.1.3",
"providers/openfeature-provider-env-var": "0.1.0"
"providers/openfeature-provider-env-var": "0.1.0",
"providers/openfeature-provider-unleash": "0.1.0"
}
201 changes: 201 additions & 0 deletions providers/openfeature-provider-unleash/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
163 changes: 163 additions & 0 deletions providers/openfeature-provider-unleash/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
# Unleash Provider for OpenFeature

This provider is designed to use [Unleash](https://www.getunleash.io/).

## Installation

```
pip install openfeature-provider-unleash
```

### Requirements

- Python 3.9+
- `openfeature-sdk>=0.8.2`
- `UnleashClient>=6.3.0`

## Configuration and Usage

Instantiate a new UnleashProvider instance and configure the OpenFeature SDK to use it:

```python
from openfeature import api
from openfeature.contrib.provider.unleash import UnleashProvider

# Initialize the provider with your Unleash configuration
provider = UnleashProvider(
url="https://my-unleash-instance.com",
app_name="my-python-app",
api_token="my-api-token",
)

# Initialize the provider (required before use)
provider.initialize()

api.set_provider(provider)
```

### Configuration options

- `url`: The URL of your Unleash server
- `app_name`: The name of your application
- `api_token`: The API token for authentication

### Evaluation context mapping

When evaluating flags, the OpenFeature `EvaluationContext` is mapped to the Unleash context as follows:

- `EvaluationContext.targeting_key` → Unleash `userId`
- `EvaluationContext.attributes` → merged into the Unleash context as-is

### Event handling

The Unleash provider supports OpenFeature events for monitoring provider state changes:

```python
from openfeature.event import ProviderEvent

def on_provider_ready(event_details):
print(f"Provider {event_details['provider_name']} is ready")

def on_provider_error(event_details):
print(f"Provider error: {event_details['error_message']}")

def on_configuration_changed(event_details):
print(f"Configuration changed, flags: {event_details.get('flag_keys', [])}")

# Add event handlers
provider.add_handler(ProviderEvent.PROVIDER_READY, on_provider_ready)
provider.add_handler(ProviderEvent.PROVIDER_ERROR, on_provider_error)
provider.add_handler(
ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, on_configuration_changed
)

# Remove event handlers
provider.remove_handler(ProviderEvent.PROVIDER_READY, on_provider_ready)
```

**Supported events:**
- `ProviderEvent.PROVIDER_READY`: Emitted when the provider is ready to evaluate flags
- `ProviderEvent.PROVIDER_ERROR`: Emitted when the provider encounters an error
- `ProviderEvent.PROVIDER_CONFIGURATION_CHANGED`: Emitted when flag configurations are updated

Note: `ProviderEvent.PROVIDER_STALE` handlers can be registered but are not currently emitted by this provider.

### Supported flag types

This provider supports resolving the following types via the OpenFeature client:

- Boolean (`get_boolean_value`/`details`): uses `UnleashClient.is_enabled`
- String (`get_string_value`/`details`): from variant payload
- Integer (`get_integer_value`/`details`): from variant payload
- Float (`get_float_value`/`details`): from variant payload
- Object (`get_object_value`/`details`): from variant payload, JSON-parsed if needed

### Example usage

```python
from openfeature import api
from openfeature.contrib.provider.unleash import UnleashProvider
from openfeature.evaluation_context import EvaluationContext

# Initialize the provider
provider = UnleashProvider(
url="https://your-unleash-instance.com",
app_name="my-python-app",
api_token="my-token"
)
provider.initialize()
api.set_provider(provider)

# Get a client and evaluate flags
client = api.get_client()

# Boolean flag evaluation
is_enabled = client.get_boolean_value("my-feature", False)
print(f"Feature is enabled: {is_enabled}")

# String flag evaluation with context
context = EvaluationContext(targeting_key="user123", attributes={"sessionId": "session456"})
variant = client.get_string_value("my-variant-flag", "default", context)
print(f"Variant: {variant}")

# Shutdown when done
provider.shutdown()
```

## Development

### Running tests

```bash
uv run test --frozen
```

Integration tests require Docker to be installed and running. To run only integration tests:

```bash
uv run test -m integration --frozen
```

To skip integration tests:

```bash
uv run test -m "not integration" --frozen
```

### Type checking

```bash
uv run mypy-check
```

### Linting

Run Ruff checks:

```bash
uv run ruff check
```

## License

Apache 2.0 - See [LICENSE](./LICENSE) for more information.
Loading