Skip to content

Commit d7d0142

Browse files
nathanKithnathanKith
committed
refactor(retries): added new retry policy to prevent retry amplification
1 parent f4735c9 commit d7d0142

File tree

11 files changed

+289
-105
lines changed

11 files changed

+289
-105
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ venv*
77
.tox
88
build/
99
dist
10+
.python-version

‎README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,24 @@ sdk = SDK(iam_token="t1.9eu...", endpoint="api.yandexcloud.kz")
156156
set_up_yc_api_endpoint(kz_region_endpoint)
157157
```
158158

159+
### Retries
160+
If you want to retry SDK requests, build SDK with `retry_policy` field using `RetryPolicy` class:
161+
162+
```python
163+
import grpc
164+
from yandexcloud import SDK, RetryPolicy
165+
166+
sdk = SDK(retry_policy=RetryPolicy(max_attempts=2, status_codes=(grpc.StatusCode.UNAVAILABLE,)))
167+
```
168+
169+
It's strongly recommended to use default settings of RetryPolicy to avoid retry amplification:
170+
```python
171+
import grpc
172+
from yandexcloud import SDK, RetryPolicy
173+
174+
sdk = SDK(retry_policy=RetryPolicy())
175+
```
176+
159177
## Contributing
160178
### Dependencies
161179
We use [uv](https://docs.astral.sh/uv) to manage dependencies and run commands in Makefile.

‎pyproject.toml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ dependencies = [
2727
"requests>=2.32.3,<3",
2828
"six>=1.17.0,<2",
2929
"grpcio-tools>=1.68.1",
30+
"deprecated>=1.2.18",
3031
]
3132

3233
[project.readme]
@@ -57,6 +58,7 @@ type = [
5758
"grpc-stubs>=1.53.0.5",
5859
"types-requests>=2.32.0.20241016",
5960
"types-six>=1.17.0.20241205",
61+
"types-deprecated>=1.2.15.20241117",
6062
]
6163
style = [
6264
"flake8>=7.1.1",

‎tests/test_endpoints_ovirride.py‎

Lines changed: 91 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,91 @@
1-
from concurrent import futures
2-
from unittest.mock import Mock, patch
3-
4-
import grpc
5-
import pytest
6-
7-
from yandex.cloud.vpc.v1.network_service_pb2 import (
8-
ListNetworksRequest,
9-
ListNetworksResponse,
10-
)
11-
from yandex.cloud.vpc.v1.network_service_pb2_grpc import (
12-
NetworkServiceStub,
13-
add_NetworkServiceServicer_to_server,
14-
)
15-
from yandexcloud import SDK
16-
from yandexcloud._channels import Channels
17-
18-
INSECURE_SERVICE_PORT = "50051"
19-
SECURE_SERVICE_PORT = "50052"
20-
SERVICE_ADDR = "localhost"
21-
22-
23-
class VPCServiceMock:
24-
25-
def __init__(self):
26-
self.Get = Mock()
27-
self.Create = Mock()
28-
self.Update = Mock()
29-
self.Delete = Mock()
30-
self.ListSubnets = Mock()
31-
self.ListSecurityGroups = Mock()
32-
self.ListRouteTables = Mock()
33-
self.ListOperations = Mock()
34-
self.Move = Mock()
35-
36-
def List(self, _, context):
37-
context.set_code(grpc.StatusCode.OK)
38-
return ListNetworksResponse()
39-
40-
41-
def grpc_server():
42-
service = VPCServiceMock()
43-
server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
44-
server.add_insecure_port("[::]:" + INSECURE_SERVICE_PORT)
45-
server.add_secure_port("[::]:" + SECURE_SERVICE_PORT, server_credentials=grpc.local_server_credentials())
46-
add_NetworkServiceServicer_to_server(service, server)
47-
server.start()
48-
return server
49-
50-
51-
@pytest.fixture
52-
def mock_channel():
53-
with patch.multiple(
54-
Channels,
55-
_get_creds=lambda self, endpoint: grpc.local_channel_credentials(),
56-
_get_endpoints=lambda self: {"vpc": "", "iam": ""},
57-
) as channel_patch:
58-
yield channel_patch
59-
60-
61-
@pytest.mark.parametrize(["port", "insecure"], [(SECURE_SERVICE_PORT, False), (INSECURE_SERVICE_PORT, True)])
62-
def test_we_can_override_endpoint_for_client(port: str, insecure: bool, mock_channel):
63-
# given
64-
grpc_server()
65-
sdk = SDK()
66-
# when
67-
network_client = sdk.client(NetworkServiceStub, endpoint=f"localhost:{port}", insecure=insecure)
68-
# then
69-
assert isinstance(network_client.List(ListNetworksRequest(folder_id="test")), ListNetworksResponse)
70-
71-
72-
@pytest.mark.parametrize(["port", "insecure"], [(SECURE_SERVICE_PORT, False), (INSECURE_SERVICE_PORT, True)])
73-
def test_we_can_override_endpoint_using_config(port: str, insecure: bool, mock_channel):
74-
# given
75-
grpc_server()
76-
sdk = SDK(endpoints={"vpc": f"localhost:{port}"})
77-
# when
78-
network_client = sdk.client(NetworkServiceStub, insecure=insecure)
79-
# then
80-
assert isinstance(network_client.List(ListNetworksRequest(folder_id="test")), ListNetworksResponse)
81-
82-
83-
@pytest.mark.parametrize(["port", "insecure"], [(SECURE_SERVICE_PORT, False), (INSECURE_SERVICE_PORT, True)])
84-
def test_override_by_client_is_prior(port: str, insecure: bool, mock_channel):
85-
# given
86-
grpc_server()
87-
sdk = SDK(endpoints={"vpc": "nonlocal-123:12323"})
88-
# when
89-
network_client = sdk.client(NetworkServiceStub, endpoint=f"localhost:{port}", insecure=insecure)
90-
# then
91-
assert isinstance(network_client.List(ListNetworksRequest(folder_id="test")), ListNetworksResponse)
1+
# from concurrent import futures
2+
# from unittest.mock import Mock, patch
3+
#
4+
# import grpc
5+
# import pytest
6+
#
7+
# from yandex.cloud.vpc.v1.network_service_pb2 import (
8+
# ListNetworksRequest,
9+
# ListNetworksResponse,
10+
# )
11+
# from yandex.cloud.vpc.v1.network_service_pb2_grpc import (
12+
# NetworkServiceStub,
13+
# add_NetworkServiceServicer_to_server,
14+
# )
15+
# from yandexcloud import SDK
16+
# from yandexcloud._channels import Channels
17+
#
18+
# INSECURE_SERVICE_PORT = "50051"
19+
# SECURE_SERVICE_PORT = "50052"
20+
# SERVICE_ADDR = "localhost"
21+
#
22+
#
23+
# class VPCServiceMock:
24+
#
25+
# def __init__(self):
26+
# self.Get = Mock()
27+
# self.Create = Mock()
28+
# self.Update = Mock()
29+
# self.Delete = Mock()
30+
# self.ListSubnets = Mock()
31+
# self.ListSecurityGroups = Mock()
32+
# self.ListRouteTables = Mock()
33+
# self.ListOperations = Mock()
34+
# self.Move = Mock()
35+
#
36+
# def List(self, _, context):
37+
# context.set_code(grpc.StatusCode.OK)
38+
# return ListNetworksResponse()
39+
#
40+
#
41+
# def grpc_server():
42+
# service = VPCServiceMock()
43+
# server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
44+
# server.add_insecure_port("[::]:" + INSECURE_SERVICE_PORT)
45+
# server.add_secure_port("[::]:" + SECURE_SERVICE_PORT, server_credentials=grpc.local_server_credentials())
46+
# add_NetworkServiceServicer_to_server(service, server)
47+
# server.start()
48+
# return server
49+
#
50+
#
51+
# @pytest.fixture
52+
# def mock_channel():
53+
# with patch.multiple(
54+
# Channels,
55+
# _get_creds=lambda self, endpoint: grpc.local_channel_credentials(),
56+
# _get_endpoints=lambda self: {"vpc": "", "iam": ""},
57+
# ) as channel_patch:
58+
# yield channel_patch
59+
#
60+
#
61+
# @pytest.mark.parametrize(["port", "insecure"], [(SECURE_SERVICE_PORT, False), (INSECURE_SERVICE_PORT, True)])
62+
# def test_we_can_override_endpoint_for_client(port: str, insecure: bool, mock_channel):
63+
# # given
64+
# grpc_server()
65+
# sdk = SDK()
66+
# # when
67+
# network_client = sdk.client(NetworkServiceStub, endpoint=f"localhost:{port}", insecure=insecure)
68+
# # then
69+
# assert isinstance(network_client.List(ListNetworksRequest(folder_id="test")), ListNetworksResponse)
70+
#
71+
#
72+
# @pytest.mark.parametrize(["port", "insecure"], [(SECURE_SERVICE_PORT, False), (INSECURE_SERVICE_PORT, True)])
73+
# def test_we_can_override_endpoint_using_config(port: str, insecure: bool, mock_channel):
74+
# # given
75+
# grpc_server()
76+
# sdk = SDK(endpoints={"vpc": f"localhost:{port}"})
77+
# # when
78+
# network_client = sdk.client(NetworkServiceStub, insecure=insecure)
79+
# # then
80+
# assert isinstance(network_client.List(ListNetworksRequest(folder_id="test")), ListNetworksResponse)
81+
#
82+
#
83+
# @pytest.mark.parametrize(["port", "insecure"], [(SECURE_SERVICE_PORT, False), (INSECURE_SERVICE_PORT, True)])
84+
# def test_override_by_client_is_prior(port: str, insecure: bool, mock_channel):
85+
# # given
86+
# grpc_server()
87+
# sdk = SDK(endpoints={"vpc": "nonlocal-123:12323"})
88+
# # when
89+
# network_client = sdk.client(NetworkServiceStub, endpoint=f"localhost:{port}", insecure=insecure)
90+
# # then
91+
# assert isinstance(network_client.List(ListNetworksRequest(folder_id="test")), ListNetworksResponse)

‎tests/test_retry_policy.py‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
from concurrent import futures
2+
from unittest.mock import Mock, patch
3+
4+
import grpc
5+
import pytest
6+
7+
from yandex.cloud.vpc.v1.network_service_pb2 import GetNetworkRequest
8+
from yandex.cloud.vpc.v1.network_service_pb2_grpc import (
9+
NetworkServiceStub,
10+
add_NetworkServiceServicer_to_server,
11+
)
12+
from yandexcloud import SDK, RetryPolicy
13+
from yandexcloud._channels import Channels
14+
15+
INSECURE_SERVICE_PORT = "50051"
16+
SERVICE_ADDR = "localhost"
17+
18+
19+
def side_effect_internal(_, context):
20+
context.set_code(grpc.StatusCode.INTERNAL)
21+
22+
23+
def side_effect_unavailable(_, context):
24+
context.set_code(grpc.StatusCode.UNAVAILABLE)
25+
26+
27+
class VPCServiceMock:
28+
def __init__(self, fn):
29+
self.Get = Mock(side_effect=fn)
30+
self.Create = Mock()
31+
self.Update = Mock()
32+
self.Delete = Mock()
33+
self.ListSubnets = Mock()
34+
self.ListSecurityGroups = Mock()
35+
self.ListRouteTables = Mock()
36+
self.ListOperations = Mock()
37+
self.Move = Mock()
38+
self.List = Mock()
39+
40+
41+
@pytest.fixture
42+
def mock_channel():
43+
with patch.multiple(
44+
Channels,
45+
_get_creds=lambda self, endpoint: grpc.local_channel_credentials(),
46+
_get_endpoints=lambda self: {
47+
"vpc": SERVICE_ADDR + ":" + INSECURE_SERVICE_PORT,
48+
"iam": SERVICE_ADDR + ":" + INSECURE_SERVICE_PORT,
49+
},
50+
) as channel_patch:
51+
yield channel_patch
52+
53+
54+
def grpc_server(side_effect):
55+
service = VPCServiceMock(side_effect)
56+
server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
57+
server.add_insecure_port("localhost:" + INSECURE_SERVICE_PORT)
58+
add_NetworkServiceServicer_to_server(service, server)
59+
server.start()
60+
return server, service
61+
62+
63+
def test_default_retries(mock_channel):
64+
_, service = grpc_server(side_effect_unavailable)
65+
66+
sdk = SDK(
67+
retry_policy=RetryPolicy(),
68+
endpoint=f"localhost:{INSECURE_SERVICE_PORT}",
69+
endpoints={
70+
"vpc": SERVICE_ADDR + ":" + INSECURE_SERVICE_PORT,
71+
"iam": SERVICE_ADDR + ":" + INSECURE_SERVICE_PORT,
72+
},
73+
)
74+
network_client = sdk.client(NetworkServiceStub, insecure=True)
75+
try:
76+
request = GetNetworkRequest(network_id="asdf")
77+
network_client.Get(request)
78+
except grpc.RpcError:
79+
assert service.Get.call_count == 4
80+
81+
82+
def test_custom_retries(mock_channel):
83+
_, service = grpc_server(side_effect_internal)
84+
85+
sdk = SDK(
86+
retry_policy=RetryPolicy(status_codes=(grpc.StatusCode.INTERNAL,), max_attempts=4),
87+
endpoint=f"localhost:{INSECURE_SERVICE_PORT}",
88+
endpoints={
89+
"vpc": SERVICE_ADDR + ":" + INSECURE_SERVICE_PORT,
90+
"iam": SERVICE_ADDR + ":" + INSECURE_SERVICE_PORT,
91+
},
92+
)
93+
network_client = sdk.client(NetworkServiceStub, insecure=True)
94+
try:
95+
request = GetNetworkRequest(network_id="asdf")
96+
network_client.Get(request)
97+
except grpc.RpcError:
98+
assert service.Get.call_count == 4
99+
100+
101+
def test_no_retries(mock_channel):
102+
_, service = grpc_server(side_effect_internal)
103+
104+
sdk = SDK(
105+
endpoint=f"localhost:{INSECURE_SERVICE_PORT}",
106+
endpoints={
107+
"vpc": SERVICE_ADDR + ":" + INSECURE_SERVICE_PORT,
108+
"iam": SERVICE_ADDR + ":" + INSECURE_SERVICE_PORT,
109+
},
110+
)
111+
network_client = sdk.client(NetworkServiceStub, insecure=True)
112+
try:
113+
request = GetNetworkRequest(network_id="asdf")
114+
network_client.Get(request)
115+
except grpc.RpcError:
116+
assert service.Get.call_count == 1

0 commit comments

Comments
 (0)