open-feature-forking · aepfli · Feb 6, 2025 · Feb 7, 2025 · Feb 7, 2025 · Feb 8, 2025
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -25,7 +25,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
         package:
           - "hooks/openfeature-hooks-opentelemetry"
           - "providers/openfeature-provider-flagd"
@@ -50,15 +50,15 @@ jobs:
         working-directory: ${{ matrix.package }}
 
       - name: Type checking
-        if: matrix.python-version == '3.11'
+        if: matrix.python-version == '3.13'
         working-directory: ${{ matrix.package }}
         run: hatch run mypy:run
 
       - name: Test with pytest
         run: hatch test -c
         working-directory: ${{ matrix.package }}
 
-      - if: matrix.python-version == '3.11'
+      - if: matrix.python-version == '3.13'
         name: Upload coverage to Codecov
         uses: codecov/codecov-action@13ce06bfc6bbe3ecf90edbbf1bc32fe5978ca1d3 # v5.3.1
         with:
@@ -75,7 +75,7 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
       - uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5
         with:
-          python-version: "3.11"
+          python-version: "3.13"
           cache: "pip"
 
       - name: Run pre-commit
@@ -91,10 +91,10 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@dd746615b3b9d728a6a37ca2045b68ca76d4841a # v3
+        uses: github/codeql-action/init@9e8d0789d4a0fa9ceb6b1738f7e269594bdd67f0 # v3
         with:
           languages: python
           config-file: ./.github/codeql-config.yml
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@dd746615b3b9d728a6a37ca2045b68ca76d4841a # v3
+        uses: github/codeql-action/analyze@9e8d0789d4a0fa9ceb6b1738f7e269594bdd67f0 # v3
diff --git a/.gitmodules b/.gitmodules
@@ -5,7 +5,7 @@
 [submodule "providers/openfeature-provider-flagd/test-harness"]
 	path = providers/openfeature-provider-flagd/openfeature/test-harness
 	url = git@github.com:open-feature/flagd-testbed.git
-	branch = v0.5.21
+	branch = v2.2.0
 [submodule "providers/openfeature-provider-flagd/spec"]
 	path = providers/openfeature-provider-flagd/openfeature/spec
 	url = https://github.com/open-feature/spec
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,7 +1,7 @@
-default_stages: [commit]
+default_stages: [pre-commit]
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.4
+    rev: v0.9.6
     hooks:
       - id: ruff
         args: [--fix]

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,11 +4,11 @@
 
 ### System Requirements
 
-Python 3.8 and above are required.
+Python 3.9 and above are required.
 
 ### Target version(s)
 
-Python 3.8 and above are supported by the SDK.
+Python 3.9 and above are supported by the SDK.
 
 ### Installation and Dependencies
 
@@ -30,7 +30,13 @@ We use `pytest` for our unit testing, making use of `parametrized` to inject cas
 
 ### Integration tests
 
-These are planned once the SDK has been stabilized and a Flagd provider implemented. At that point, we will utilize the [gherkin integration tests](https://github.com/open-feature/test-harness/blob/main/features/evaluation.feature) to validate against a live, seeded Flagd instance.
+The Flagd provider utilizes the [gherkin integration tests](https://github.com/open-feature/test-harness/blob/main/features/evaluation.feature) to validate against a live, seeded Flagd instance.
+
+To run the integration tests you need to have a container runtime, like docker, ranger, etc. installed.
+
+```bash
+hatch run test
+```
 
 ### Type checking
 
@@ -52,6 +58,13 @@ Navigate to the repository folder
 cd python-sdk-contrib
 ```
 
+Checkout submodules
+
+```bash
+git submodule update --init --recursive
+```
+
+
 Add your fork as an origin
 
 ```bash
@@ -62,15 +75,16 @@ Ensure your development environment is all set up by building and testing
 
 ```bash
 cd <package>
-hatch run test
+hatch build
+hatch test
 ```
 
 To start working on a new feature or bugfix, create a new branch and start working on it.
 
 ```bash
 git checkout -b feat/NAME_OF_FEATURE
 # Make your changes
-git commit
+git commit -s -m "feat: my feature"
 git push fork feat/NAME_OF_FEATURE
 ```
 

diff --git a/hooks/openfeature-hooks-opentelemetry/pyproject.toml b/hooks/openfeature-hooks-opentelemetry/pyproject.toml
@@ -20,7 +20,7 @@ dependencies = [
     "openfeature-sdk>=0.6.0",
     "opentelemetry-api",
 ]
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 
 [project.urls]
 Homepage = "https://github.com/open-feature/python-sdk-contrib"
@@ -70,7 +70,7 @@ packages = ["src/openfeature"]
 mypy_path = "src"
 files = "src"
 
-python_version = "3.8" # should be identical to the minimum supported version
+python_version = "3.9" # should be identical to the minimum supported version
 namespace_packages = true
 explicit_package_bases = true
 local_partial_types = true

diff --git a/providers/openfeature-provider-flagd/README.md b/providers/openfeature-provider-flagd/README.md
@@ -1,6 +1,6 @@
 # flagd Provider for OpenFeature
 
-This provider is designed to use flagd's [evaluation protocol](https://github.com/open-feature/schemas/blob/main/protobuf/schema/v1/schema.proto).
+This provider is designed to use flagd's [evaluation protocol](https://github.com/open-feature/schemas/blob/main/protobuf/schema/v1/schema.proto), or locally evaluate flags defined in a flagd [flag definition](https://github.com/open-feature/schemas/blob/main/json/flagd-definitions.json) via the OpenFeature Python SDK.
 
 ## Installation
 
@@ -29,7 +29,9 @@ api.set_provider(FlagdProvider())
 
 ### In-process resolver
 
-This mode performs flag evaluations locally (in-process).
+This mode performs flag evaluations locally (in-process). Flag configurations for evaluation are obtained via gRPC protocol using [sync protobuf schema](https://buf.build/open-feature/flagd/file/main:sync/v1/sync_service.proto) service definition.
+
+Consider the following example to create a `FlagdProvider` with in-process evaluations,
 
 ```python
 from openfeature import api
@@ -38,10 +40,39 @@ from openfeature.contrib.provider.flagd.config import ResolverType
 
 api.set_provider(FlagdProvider(
     resolver_type=ResolverType.IN_PROCESS,
+))
+```
+
+In the above example, in-process handlers attempt to connect to a sync service on address `localhost:8013` to obtain [flag definitions](https://github.com/open-feature/schemas/blob/main/json/flags.json).
+
+<!--
+#### Sync-metadata
+
+To support the injection of contextual data configured in flagd for in-process evaluation, the provider exposes a `getSyncMetadata` accessor which provides the most recent value returned by the [GetMetadata RPC](https://buf.build/open-feature/flagd/docs/main:flagd.sync.v1#flagd.sync.v1.FlagSyncService.GetMetadata).
+The value is updated with every (re)connection to the sync implementation.
+This can be used to enrich evaluations with such data.
+If the `in-process` mode is not used, and before the provider is ready, the `getSyncMetadata` returns an empty map.
+-->
+### File mode
+
+In-process resolvers can also work in an offline mode.
+To enable this mode, you should provide a valid flag configuration file with the option `offlineFlagSourcePath`.
+
+```python
+from openfeature import api
+from openfeature.contrib.provider.flagd import FlagdProvider
+from openfeature.contrib.provider.flagd.config import ResolverType
+
+api.set_provider(FlagdProvider(
+    resolver_type=ResolverType.FILE,
     offline_flag_source_path="my-flag.json",
 ))
 ```
 
+Provider will attempt to detect file changes using polling.
+Polling happens at 5 second intervals and this is currently unconfigurable.
+This mode is useful for local development, tests and offline applications.
+
 ### Configuration options
 
 The default options can be defined in the FlagdProvider constructor.

diff --git a/providers/openfeature-provider-flagd/openfeature/spec b/providers/openfeature-provider-flagd/openfeature/spec
diff --git a/providers/openfeature-provider-flagd/openfeature/test-harness b/providers/openfeature-provider-flagd/openfeature/test-harness
diff --git a/providers/openfeature-provider-flagd/pyproject.toml b/providers/openfeature-provider-flagd/pyproject.toml
@@ -18,15 +18,15 @@ classifiers = [
 keywords = []
 dependencies = [
   "openfeature-sdk>=0.6.0",
-  "grpcio>=1.68.0",
-  "protobuf>=4.25.2",
+  "grpcio>=1.68.1",
+  "protobuf>=4.29.2",
   "mmh3>=4.1.0",
   "panzi-json-logic>=1.0.1",
   "semver>=3,<4",
   "pyyaml>=6.0.1",
   "cachebox"
 ]
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 
 [project.urls]
 Homepage = "https://github.com/open-feature/python-sdk-contrib"
@@ -113,7 +113,7 @@ omit = [
 mypy_path = "src"
 files = "src"
 
-python_version = "3.8" # should be identical to the minimum supported version
+python_version = "3.9" # should be identical to the minimum supported version
 namespace_packages = true
 explicit_package_bases = true
 local_partial_types = true

diff --git a/providers/openfeature-provider-flagd/pytest.ini b/providers/openfeature-provider-flagd/pytest.ini
@@ -1,10 +1,22 @@
 [pytest]
 markers =
     rpc: tests for rpc mode.
-    in-process: tests for rpc mode.
+    in-process: tests for in-process mode.
+    file: tests for file mode.
+    unavailable: tests for unavailable providers.
     customCert: Supports custom certs.
     unixsocket: Supports unixsockets.
+    targetURI: Supports targetURI.
+    grace: Supports grace attempts.
+    targeting: Supports targeting.
+    fractional: Supports fractional.
+    string: Supports string.
+    semver: Supports semver.
+    reconnect: Supports reconnect.
     events: Supports events.
     sync: Supports sync.
     caching: Supports caching.
     offline: Supports offline.
+    os.linux: linux mark.
+    stream: Supports streams.
+bdd_features_base_dir = tests/features
diff --git a/providers/openfeature-provider-flagd/src/openfeature/contrib/provider/flagd/config.py b/providers/openfeature-provider-flagd/src/openfeature/contrib/provider/flagd/config.py
@@ -7,6 +7,7 @@
 class ResolverType(Enum):
     RPC = "rpc"
     IN_PROCESS = "in-process"
+    FILE = "file"
 
 
 class CacheType(Enum):
@@ -43,6 +44,7 @@ class CacheType(Enum):
 ENV_VAR_RETRY_BACKOFF_MS = "FLAGD_RETRY_BACKOFF_MS"
 ENV_VAR_RETRY_BACKOFF_MAX_MS = "FLAGD_RETRY_BACKOFF_MAX_MS"
 ENV_VAR_RETRY_GRACE_PERIOD_SECONDS = "FLAGD_RETRY_GRACE_PERIOD"
+ENV_VAR_SELECTOR = "FLAGD_SOURCE_SELECTOR"
 ENV_VAR_STREAM_DEADLINE_MS = "FLAGD_STREAM_DEADLINE_MS"
 ENV_VAR_TLS = "FLAGD_TLS"
 ENV_VAR_TLS_CERT = "FLAGD_SERVER_CERT_PATH"
@@ -78,6 +80,7 @@ def __init__(  # noqa: PLR0913
         host: typing.Optional[str] = None,
         port: typing.Optional[int] = None,
         tls: typing.Optional[bool] = None,
+        selector: typing.Optional[str] = None,
         resolver: typing.Optional[ResolverType] = None,
         offline_flag_source_path: typing.Optional[str] = None,
         offline_poll_interval_ms: typing.Optional[int] = None,
@@ -158,6 +161,17 @@ def __init__(  # noqa: PLR0913
             else offline_flag_source_path
         )
 
+        if (
+            self.offline_flag_source_path is not None
+            and self.resolver is ResolverType.IN_PROCESS
+        ):
+            self.resolver = ResolverType.FILE
+
+        if self.resolver is ResolverType.FILE and self.offline_flag_source_path is None:
+            raise AttributeError(
+                "Resolver Type 'FILE' requires a offlineFlagSourcePath"
+            )
+
         self.offline_poll_interval_ms: int = (
             int(
                 env_or_default(
@@ -209,3 +223,7 @@ def __init__(  # noqa: PLR0913
             if cert_path is None
             else cert_path
         )
+
+        self.selector = (
+            env_or_default(ENV_VAR_SELECTOR, None) if selector is None else selector
+        )
+1 −1		specification/assets/gherkin/evaluation.feature
+49 −0		specification/assets/gherkin/hooks.feature
+2 −2		.gherkin-lintrc
+2 −25		.github/workflows/ci.yml
+2 −2		.github/workflows/lint-pr.yml
+4 −39		.github/workflows/release-please.yml
+1 −2		.gitignore
+1 −1		.release-please-manifest.json
+141 −0		CHANGELOG.md
+2 −2		README.md
+22 −30		flagd/Dockerfile
+0 −0		flags/changing-flag.json
+2 −2		flags/selector-flags.json
+155 −109		gherkin/config.feature
+59 −0		gherkin/connection.feature
+34 −0		gherkin/evaluation.feature
+35 −18		gherkin/events.feature
+0 −126		gherkin/flagd-json-evaluator.feature
+0 −15		gherkin/flagd-reconnect.feature
+0 −44		gherkin/flagd-rpc-caching.feature
+0 −36		gherkin/flagd.feature
+60 −0		gherkin/rpc-caching.feature
+23 −0		gherkin/selector.feature
+146 −0		gherkin/targeting.feature
+101 −0		launchpad/README.md
+12 −0		launchpad/configs/default.json
+14 −0		launchpad/configs/ssl.json
+ −		launchpad/flagd
+7 −0		launchpad/go.mod
+4 −0		launchpad/go.sum
+363 −0		launchpad/main.go
+55 −1		release-please-config.json
+0 −22		scripts/change-flag-wrapper.sh
+0 −15		scripts/change-flag.sh
+0 −34		scripts/restart-wrapper.sh
+1 −1		version.txt