Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix: add operation name to x-goog-request-params in async client #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 12, 2021
Merged

fix: add operation name to x-goog-request-params in async client #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c22b246
fix: add operation name to x-goog-request-params
busunkim96 Jan 19, 2021
7c66c88
fix: append to list
busunkim96 Jan 25, 2021
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
19 changes: 19 additions & 0 deletions google/api_core/operations_v1/operations_async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,11 @@ async def get_operation(
subclass will be raised.
"""
request = operations_pb2.GetOperationRequest(name=name)

# Add routing header
metadata = metadata or []
metadata.append(gapic_v1.routing_header.to_grpc_metadata({"name": name}))

return await self._get_operation(request, retry=retry, timeout=timeout, metadata=metadata)

async def list_operations(
Expand Down Expand Up @@ -182,6 +187,10 @@ async def list_operations(
# Create the request object.
request = operations_pb2.ListOperationsRequest(name=name, filter=filter_)

# Add routing header
metadata = metadata or []
metadata.append(gapic_v1.routing_header.to_grpc_metadata({"name": name}))

# Create the method used to fetch pages
method = functools.partial(self._list_operations, retry=retry, timeout=timeout, metadata=metadata)

Expand Down Expand Up @@ -246,6 +255,11 @@ async def cancel_operation(
"""
# Create the request object.
request = operations_pb2.CancelOperationRequest(name=name)

# Add routing header
metadata = metadata or []
metadata.append(gapic_v1.routing_header.to_grpc_metadata({"name": name}))

await self._cancel_operation(request, retry=retry, timeout=timeout, metadata=metadata)

async def delete_operation(
Expand Down Expand Up @@ -292,4 +306,9 @@ async def delete_operation(
"""
# Create the request object.
request = operations_pb2.DeleteOperationRequest(name=name)

# Add routing header
metadata = metadata or []
metadata.append(gapic_v1.routing_header.to_grpc_metadata({"name": name}))

await self._delete_operation(request, retry=retry, timeout=timeout, metadata=metadata)
19 changes: 19 additions & 0 deletions google/api_core/operations_v1/operations_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,11 @@ def get_operation(
subclass will be raised.
"""
request = operations_pb2.GetOperationRequest(name=name)

# Add routing header
metadata = metadata or []
metadata.append(gapic_v1.routing_header.to_grpc_metadata({"name": name}))

return self._get_operation(request, retry=retry, timeout=timeout, metadata=metadata)

def list_operations(
Expand Down Expand Up @@ -196,6 +201,10 @@ def list_operations(
# Create the request object.
request = operations_pb2.ListOperationsRequest(name=name, filter=filter_)

# Add routing header
metadata = metadata or []
metadata.append(gapic_v1.routing_header.to_grpc_metadata({"name": name}))

# Create the method used to fetch pages
method = functools.partial(self._list_operations, retry=retry, timeout=timeout, metadata=metadata)

Expand Down Expand Up @@ -260,6 +269,11 @@ def cancel_operation(
"""
# Create the request object.
request = operations_pb2.CancelOperationRequest(name=name)

# Add routing header
metadata = metadata or []
metadata.append(gapic_v1.routing_header.to_grpc_metadata({"name": name}))

self._cancel_operation(request, retry=retry, timeout=timeout, metadata=metadata)

def delete_operation(
Expand Down Expand Up @@ -306,4 +320,9 @@ def delete_operation(
"""
# Create the request object.
request = operations_pb2.DeleteOperationRequest(name=name)

# Add routing header
metadata = metadata or []
metadata.append(gapic_v1.routing_header.to_grpc_metadata({"name": name}))

self._delete_operation(request, retry=retry, timeout=timeout, metadata=metadata)
20 changes: 12 additions & 8 deletions tests/asyncio/operations_v1/test_operations_async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,11 @@ async def test_get_operation():
operations_pb2.Operation(name="meep"))
client = operations_v1.OperationsAsyncClient(mocked_channel)

response = await client.get_operation("name", metadata=[("x-goog-request-params", "foo")])
response = await client.get_operation("name", metadata=[("header", "foo")])
assert method.call_count == 1
assert tuple(method.call_args_list[0])[0][0].name == "name"
assert ("x-goog-request-params", "foo") in tuple(method.call_args_list[0])[1]["metadata"]
assert ("header", "foo") in tuple(method.call_args_list[0])[1]["metadata"]
assert ("x-goog-request-params", "name=name") in tuple(method.call_args_list[0])[1]["metadata"]
assert response == fake_call.response


Expand All @@ -54,7 +55,7 @@ async def test_list_operations():
mocked_channel, method, fake_call = _mock_grpc_objects(list_response)
client = operations_v1.OperationsAsyncClient(mocked_channel)

pager = await client.list_operations("name", "filter", metadata=[("x-goog-request-params", "foo")])
pager = await client.list_operations("name", "filter", metadata=[("header", "foo")])

assert isinstance(pager, page_iterator_async.AsyncIterator)
responses = []
Expand All @@ -64,7 +65,8 @@ async def test_list_operations():
assert responses == operations

assert method.call_count == 1
assert ("x-goog-request-params", "foo") in tuple(method.call_args_list[0])[1]["metadata"]
assert ("header", "foo") in tuple(method.call_args_list[0])[1]["metadata"]
assert ("x-goog-request-params", "name=name") in tuple(method.call_args_list[0])[1]["metadata"]
request = tuple(method.call_args_list[0])[0][0]
assert isinstance(request, operations_pb2.ListOperationsRequest)
assert request.name == "name"
Expand All @@ -77,11 +79,12 @@ async def test_delete_operation():
empty_pb2.Empty())
client = operations_v1.OperationsAsyncClient(mocked_channel)

await client.delete_operation("name", metadata=[("x-goog-request-params", "foo")])
await client.delete_operation("name", metadata=[("header", "foo")])

assert method.call_count == 1
assert tuple(method.call_args_list[0])[0][0].name == "name"
assert ("x-goog-request-params", "foo") in tuple(method.call_args_list[0])[1]["metadata"]
assert ("header", "foo") in tuple(method.call_args_list[0])[1]["metadata"]
assert ("x-goog-request-params", "name=name") in tuple(method.call_args_list[0])[1]["metadata"]


@pytest.mark.asyncio
Expand All @@ -90,8 +93,9 @@ async def test_cancel_operation():
empty_pb2.Empty())
client = operations_v1.OperationsAsyncClient(mocked_channel)

await client.cancel_operation("name", metadata=[("x-goog-request-params", "foo")])
await client.cancel_operation("name", metadata=[("header", "foo")])

assert method.call_count == 1
assert tuple(method.call_args_list[0])[0][0].name == "name"
assert ("x-goog-request-params", "foo") in tuple(method.call_args_list[0])[1]["metadata"]
assert ("header", "foo") in tuple(method.call_args_list[0])[1]["metadata"]
assert ("x-goog-request-params", "name=name") in tuple(method.call_args_list[0])[1]["metadata"]
20 changes: 12 additions & 8 deletions tests/unit/operations_v1/test_operations_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ def test_get_operation():
client = operations_v1.OperationsClient(channel)
channel.GetOperation.response = operations_pb2.Operation(name="meep")

response = client.get_operation("name", metadata=[("x-goog-request-params", "foo")])
response = client.get_operation("name", metadata=[("header", "foo")])

assert ("x-goog-request-params", "foo") in channel.GetOperation.calls[0].metadata
assert ("header", "foo") in channel.GetOperation.calls[0].metadata
assert ("x-goog-request-params", "name=name") in channel.GetOperation.calls[0].metadata
assert len(channel.GetOperation.requests) == 1
assert channel.GetOperation.requests[0].name == "name"
assert response == channel.GetOperation.response
Expand All @@ -42,12 +43,13 @@ def test_list_operations():
list_response = operations_pb2.ListOperationsResponse(operations=operations)
channel.ListOperations.response = list_response

response = client.list_operations("name", "filter", metadata=[("x-goog-request-params", "foo")])
response = client.list_operations("name", "filter", metadata=[("header", "foo")])

assert isinstance(response, page_iterator.Iterator)
assert list(response) == operations

assert ("x-goog-request-params", "foo") in channel.ListOperations.calls[0].metadata
assert ("header", "foo") in channel.ListOperations.calls[0].metadata
assert ("x-goog-request-params", "name=name") in channel.ListOperations.calls[0].metadata
assert len(channel.ListOperations.requests) == 1
request = channel.ListOperations.requests[0]
assert isinstance(request, operations_pb2.ListOperationsRequest)
Expand All @@ -60,9 +62,10 @@ def test_delete_operation():
client = operations_v1.OperationsClient(channel)
channel.DeleteOperation.response = empty_pb2.Empty()

client.delete_operation("name", metadata=[("x-goog-request-params", "foo")])
client.delete_operation("name", metadata=[("header", "foo")])

assert ("x-goog-request-params", "foo") in channel.DeleteOperation.calls[0].metadata
assert ("header", "foo") in channel.DeleteOperation.calls[0].metadata
assert ("x-goog-request-params", "name=name") in channel.DeleteOperation.calls[0].metadata
assert len(channel.DeleteOperation.requests) == 1
assert channel.DeleteOperation.requests[0].name == "name"

Expand All @@ -72,8 +75,9 @@ def test_cancel_operation():
client = operations_v1.OperationsClient(channel)
channel.CancelOperation.response = empty_pb2.Empty()

client.cancel_operation("name", metadata=[("x-goog-request-params", "foo")])
client.cancel_operation("name", metadata=[("header", "foo")])

assert ("x-goog-request-params", "foo") in channel.CancelOperation.calls[0].metadata
assert ("header", "foo") in channel.CancelOperation.calls[0].metadata
assert ("x-goog-request-params", "name=name") in channel.CancelOperation.calls[0].metadata
assert len(channel.CancelOperation.requests) == 1
assert channel.CancelOperation.requests[0].name == "name"