Downgrade required grpcio and protobuf versions (microsoft#36)

Signed-off-by: Elena Kolevska <[email protected]>
elena-kolevska · Jan 9, 2025 · 08a726f · 08a726f
1 parent bd1de2e
commit 08a726f
Show file tree

Hide file tree

Showing 8 changed files with 414 additions and 661 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `set_custom_status` orchestrator API ([#31](https://github.com/microsoft/durabletask-python/pull/31)) - contributed by [@famarting](https://github.com/famarting)
 - Added `purge_orchestration` client API ([#34](https://github.com/microsoft/durabletask-python/pull/34)) - contributed by [@famarting](https://github.com/famarting)
 
+### Changes
+
+- Protos are compiled with gRPC 1.62.3 / protobuf 3.25.X instead of the latest release. This ensures compatibility with a wider range of grpcio versions for better compatibility with other packages / libraries.
+
 ### Updates
 
 - Updated `durabletask-protobuf` submodule reference to latest

diff --git a/Makefile b/Makefile
@@ -11,7 +11,8 @@ install:
 	python3 -m pip install .
 
 gen-proto:
-# NOTE: There is currently a hand-edit that we make to the generated orchestrator_service_pb2.py file after it's generated to help resolve import problems.
-	python3 -m grpc_tools.protoc --proto_path=./submodules/durabletask-protobuf/protos  --python_out=./durabletask/internal --pyi_out=./durabletask/internal --grpc_python_out=./durabletask/internal orchestrator_service.proto
+	cp ./submodules/durabletask-protobuf/protos/orchestrator_service.proto durabletask/internal/orchestrator_service.proto
+	python3 -m grpc_tools.protoc --proto_path=.  --python_out=. --pyi_out=. --grpc_python_out=. ./durabletask/internal/orchestrator_service.proto
+	rm durabletask/internal/*.proto
 
 .PHONY: init test-unit test-e2e gen-proto install
diff --git a/README.md b/README.md
@@ -170,6 +170,7 @@ git submodule update --init
 Once the submodule is available, the corresponding source code can be regenerated using the following command from the project root:
 
 ```sh
+pip3 install -r dev-requirements.txt
 make gen-proto
 ```
 

diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -0,0 +1 @@
+grpcio-tools==1.62.3 # 1.62.X is the latest version before protobuf 1.26.X is used which has breaking changes for Python
diff --git a/durabletask/internal/__init__.py b/durabletask/internal/__init__.py
diff --git a/durabletask/internal/orchestrator_service_pb2.py b/durabletask/internal/orchestrator_service_pb2.py
diff --git a/durabletask/internal/orchestrator_service_pb2_grpc.py b/durabletask/internal/orchestrator_service_pb2_grpc.py
diff --git a/requirements.txt b/requirements.txt
@@ -1,6 +1,5 @@
 autopep8
-grpcio
-grpcio-tools
+grpcio>=1.60.0 # 1.60.0 is the version introducing protobuf 1.25.X support, newer versions are backwards compatible
 protobuf
 pytest
-pytest-cov
+pytest-cov
-Original file line number
+Diff line change
@@ Expand Up / @@ -170,6 +170,7 @@ git submodule update --init @@
     Once the submodule is available, the corresponding source code can be regenerated using the following command from the project root:
     ```sh
+    pip3 install -r dev-requirements.txt
     make gen-proto
     ```
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		grpcio-tools==1.62.3 # 1.62.X is the latest version before protobuf 1.26.X is used which has breaking changes for Python