Merge branch 'feat/autogenerate_proto_files' into feat/grpc-sync-addition

Signed-off-by: Simon Schrottner <[email protected]>

Author: aepfli

.github/workflows/build.yml

@@ -38,16 +38,15 @@ jobs:
           python-version: ${{ matrix.python-version }}
           cache: "pip"
 
-      - uses: bufbuild/buf-action@v1
-        with:
-          github_token: ${{ github.token }}
-          setup_only: true
-
       - name: Install hatch
         run: pip install hatch
 
+      - name: Building first to generate files
+        run: hatch build
+        working-directory: ${{ matrix.package }}
+
       - name: Test with pytest
-        run: hatch run cov
+        run: hatch test -c
         working-directory: ${{ matrix.package }}
 
       - if: matrix.python-version == '3.11'

.gitmodules

@@ -1,9 +1,9 @@
 [submodule "schemas"]
-	path = providers/openfeature-provider-flagd/schemas
+	path = providers/openfeature-provider-flagd/openfeature/schemas
 	url = https://github.com/open-feature/schemas
 [submodule "providers/openfeature-provider-flagd/test-harness"]
-	path = providers/openfeature-provider-flagd/test-harness
+	path = providers/openfeature-provider-flagd/openfeature/test-harness
 	url = [email protected]:open-feature/flagd-testbed.git
 [submodule "providers/openfeature-provider-flagd/spec"]
-	path = providers/openfeature-provider-flagd/spec
+	path = providers/openfeature-provider-flagd/openfeature/spec
 	url = https://github.com/open-feature/spec

CONTRIBUTING.md

@@ -18,9 +18,13 @@ To install Hatch, just run `pip install hatch`.
 
 You will also need to setup the `pre-commit` hooks. Run `pre-commit install` in the root directory of the repository. If you don't have `pre-commit` installed, you can install it with `pip install pre-commit`.
 
+> **Note**
+> Currently our protobuf files will be generated during `hatch build`
+> Please run this command once, to generate all necessary files.
+
 ### Testing
 
-Run tests by entering the package directory and running `hatch run test`.
+Run tests by entering the package directory and running `hatch test`.
 
 We use `pytest` for our unit testing, making use of `parametrized` to inject cases at scale.
 
@@ -50,6 +54,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
@@ -60,7 +71,8 @@ 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.

hooks/openfeature-hooks-opentelemetry/pyproject.toml

@@ -27,17 +27,23 @@ Homepage = "https://github.com/open-feature/python-sdk-contrib"
 
 [tool.hatch]
 
-[tool.hatch.envs.default]
+[tool.hatch.envs.hatch-test]
 dependencies = [
   "coverage[toml]>=6.5",
   "pytest",
 ]
+pre-install-commands = [
+  "hatch build",
+]
 
-[tool.hatch.envs.default.scripts]
-test = "pytest {args:tests}"
-test-cov = "coverage run -m pytest {args:tests}"
+[tool.hatch.envs.hatch-test.scripts]
+run = "pytest {args:tests}"
+run-cov = "coverage run -m pytest {args:tests}"
+cov-combine = "coverage combine"
 cov-report = [
   "coverage xml",
+  "coverage html",
+  "coverage report",
 ]
 cov = [
   "test-cov",

providers/openfeature-provider-flagd/schemas renamed to providers/openfeature-provider-flagd/openfeature/schemas

@@ -33,7 +33,7 @@ Homepage = "https://github.com/open-feature/python-sdk-contrib"
 
 [tool.hatch]
 
-[tool.hatch.envs.default]
+[tool.hatch.envs.hatch-test]
 dependencies = [
   "coverage[toml]>=6.5",
   "pytest",
@@ -42,28 +42,47 @@ dependencies = [
   "asserts",
   "grpcio-health-checking==1.60.0",
 ]
+pre-install-commands = [
+  "hatch build",
+]
 
-[tool.hatch.envs.default.scripts]
-test = "pytest {args:tests}"
-test-cov = "coverage run -m pytest {args:tests}"
+[tool.hatch.envs.hatch-test.scripts]
+run = "pytest {args:tests}"
+run-cov = "coverage run -m pytest {args:tests}"
+cov-combine = "coverage combine"
 cov-report = [
   "coverage xml",
   "coverage html",
+  "coverage report",
 ]
 cov = [
   "test-cov",
   "cov-report",
 ]
 
 [tool.hatch.build.hooks.protobuf]
-dependencies = ["hatch-protobuf"]
-paths = ["schemas/protobuf/schema/v1/schema.proto", "schemas/protobuf/sync/v1/sync_service.proto"]
-output_path = "src"
+generate_pyi = false
+dependencies = [
+    "hatch-protobuf",
+    "mypy-protobuf~=3.0",
+]
+proto_paths = [
+  ".",
+]
+output_path = "src/"
+
+[[tool.hatch.build.hooks.protobuf.generators]]
+name = "mypy"
+outputs = ["{proto_path}/{proto_name}_pb2.pyi"]
+
+[[tool.hatch.build.hooks.protobuf.generators]]
+name = "mypy_grpc"
+outputs = ["{proto_path}/{proto_name}_pb2_grpc.pyi"]
 
 [tool.hatch.build.targets.sdist]
 exclude = [
   ".gitignore",
-  "schemas",
+  "/openfeature",
   "test-harness",
   "spec"
 ]

providers/openfeature-provider-flagd/spec renamed to providers/openfeature-provider-flagd/openfeature/spec

@@ -0,0 +1,2 @@
+
+schemas

providers/openfeature-provider-flagd/test-harness renamed to providers/openfeature-provider-flagd/openfeature/test-harness

@@ -7,10 +7,6 @@
 from cachebox import LRUCache  # type:ignore[import-not-found]
 from google.protobuf.json_format import MessageToDict
 from google.protobuf.struct_pb2 import Struct
-from schemas.protobuf.flagd.evaluation.v1 import (  # type:ignore[import-not-found]
-    evaluation_pb2,
-    evaluation_pb2_grpc,
-)
 
 from openfeature.evaluation_context import EvaluationContext
 from openfeature.event import ProviderEventDetails
@@ -24,6 +20,10 @@
     TypeMismatchError,
 )
 from openfeature.flag_evaluation import FlagResolutionDetails, Reason
+from openfeature.schemas.protobuf.flagd.evaluation.v1 import (  # type:ignore[import-not-found]
+    evaluation_pb2,
+    evaluation_pb2_grpc,
+)
 
 from ..config import CacheType, Config
 from ..flag_type import FlagType
@@ -217,6 +217,13 @@ def _resolve(  # noqa: PLR0915 C901
         context = self._convert_context(evaluation_context)
         call_args = {"timeout": self.deadline}
         try:
+            request: typing.Union[
+                evaluation_pb2.ResolveBooleanRequest,
+                evaluation_pb2.ResolveIntRequest,
+                evaluation_pb2.ResolveStringRequest,
+                evaluation_pb2.ResolveObjectRequest,
+                evaluation_pb2.ResolveFloatRequest,
+            ]
             if flag_type == FlagType.BOOLEAN:
                 request = evaluation_pb2.ResolveBooleanRequest(
                     flag_key=flag_key, context=context