feat: implement async rest mixin methods

googleapis · Sep 20, 2024 · d2b45c9 · d2b45c9
1 parent e9b6954
commit d2b45c9
Show file tree

Hide file tree

Showing 15 changed files with 979 additions and 29 deletions.
diff --git a/gapic/templates/%namespace/%name_%version/%sub/services/%service/_async_mixins.py.j2 b/gapic/templates/%namespace/%name_%version/%sub/services/%service/_async_mixins.py.j2
@@ -91,11 +91,16 @@
 
         # Wrap the RPC method; this adds retry and timeout information,
         # and friendly error handling.
-        rpc = gapic_v1.method_async.wrap_method(
+        TEMP_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
+            gapic_version=DEFAULT_CLIENT_INFO.gapic_version,
+            grpc_version=None,
+            rest_version=google.auth.__version__
+        )
+        rpc = self._client._transport._wrap_method(
             self._client._transport.get_operation,
             default_timeout=None,
-            client_info=DEFAULT_CLIENT_INFO,
-        )
+            client_info=TEMP_CLIENT_INFO,
+        )  # type: ignore
 
         # Certain fields should be provided within the metadata header;
         # add these here.

diff --git a/gapic/templates/%namespace/%name_%version/%sub/services/%service/_shared_macros.j2 b/gapic/templates/%namespace/%name_%version/%sub/services/%service/_shared_macros.j2
@@ -304,8 +304,6 @@ class {{ async_method_name_prefix }}{{ service.name }}RestInterceptor:
     {% endif %}{# if (not is_async) or (is_async and not method.lro and not method.extended_lro and not method.paged_result_field) #}
     {% endfor %}
 
-    {# TODO(https://github.com/googleapis/gapic-generator-python/issues/2148): Remove the condition below once mixins are supported for async rest transport. #}
-    {% if not is_async %}
     {% for name, signature in api.mixin_api_signatures.items() %}
     {{ async_prefix }}def pre_{{ name|snake_case }}(
         self, request: {{signature.request_type}}, metadata: Sequence[Tuple[str, str]]
@@ -328,7 +326,6 @@ class {{ async_method_name_prefix }}{{ service.name }}RestInterceptor:
         """
         return response
     {% endfor %}
-    {% endif %}
 {% endmacro %}
 
 {% macro generate_mixin_call_method(service, api, name, sig, is_async) %}

diff --git a/gapic/templates/%namespace/%name_%version/%sub/services/%service/async_client.py.j2 b/gapic/templates/%namespace/%name_%version/%sub/services/%service/async_client.py.j2
@@ -21,6 +21,7 @@ from google.api_core.client_options import ClientOptions
 from google.api_core import exceptions as core_exceptions
 from google.api_core import gapic_v1
 from google.api_core import retry_async as retries
+import google.auth
 from google.auth import credentials as ga_credentials   # type: ignore
 from google.oauth2 import service_account              # type: ignore
 

diff --git a/.../templates/%namespace/%name_%version/%sub/services/%service/transports/rest_asyncio.py.j2 b/.../templates/%namespace/%name_%version/%sub/services/%service/transports/rest_asyncio.py.j2
@@ -216,6 +216,9 @@ class Async{{service.name}}RestTransport(_Base{{ service.name }}RestTransport):
         return self._{{method.name}}(self._session, self._host, self._interceptor)  # type: ignore
 
     {% endfor %}
+    {% for name, sig in api.mixin_api_signatures.items() %} 
+    {{ shared_macros.generate_mixin_call_method(service, api, name, sig, is_async=True) | indent(4) }}
+    {% endfor %}
 
     @property
     def kind(self) -> str:

diff --git a/gapic/templates/tests/unit/gapic/%name_%version/%sub/test_macros.j2 b/gapic/templates/tests/unit/gapic/%name_%version/%sub/test_macros.j2
@@ -1910,11 +1910,8 @@ def test_unsupported_parameter_rest_asyncio():
 {% endfor %}{# for method in service.methods.values() #}
 {% for name, sig in api.mixin_api_signatures.items() %}
 {% if 'rest' in transport %}
-{# TODO: Remove the following condition as we implement async mixins #}
-{% if not is_async %}
 {{ bad_request_mixins_test(service, api, name, sig, transport, is_async) }}
 {{ call_success_mixins_test(service, api, name, sig, transport, is_async) }}
-{% endif %}{# if not is_async #}
 {% endif %}{# if 'rest' in transport #}
 {% endfor %}
 {{ initialize_client_with_transport_test(service, transport, is_async) }}

diff --git a/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/async_client.py b/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/async_client.py
@@ -23,6 +23,7 @@
 from google.api_core import exceptions as core_exceptions
 from google.api_core import gapic_v1
 from google.api_core import retry_async as retries
+import google.auth
 from google.auth import credentials as ga_credentials   # type: ignore
 from google.oauth2 import service_account              # type: ignore
 
@@ -3100,11 +3101,16 @@ async def get_operation(
 
         # Wrap the RPC method; this adds retry and timeout information,
         # and friendly error handling.
-        rpc = gapic_v1.method_async.wrap_method(
+        TEMP_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
+            gapic_version=DEFAULT_CLIENT_INFO.gapic_version,
+            grpc_version=None,
+            rest_version=google.auth.__version__
+        )
+        rpc = self._client._transport._wrap_method(
             self._client._transport.get_operation,
             default_timeout=None,
-            client_info=DEFAULT_CLIENT_INFO,
-        )
+            client_info=TEMP_CLIENT_INFO,
+        )  # type: ignore
 
         # Certain fields should be provided within the metadata header;
         # add these here.

diff --git a/...on/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/async_client.py b/...on/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/async_client.py
@@ -23,6 +23,7 @@
 from google.api_core import exceptions as core_exceptions
 from google.api_core import gapic_v1
 from google.api_core import retry_async as retries
+import google.auth
 from google.auth import credentials as ga_credentials   # type: ignore
 from google.oauth2 import service_account              # type: ignore
 

diff --git a/...s/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/async_client.py b/...s/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/async_client.py
@@ -23,6 +23,7 @@
 from google.api_core import exceptions as core_exceptions
 from google.api_core import gapic_v1
 from google.api_core import retry_async as retries
+import google.auth
 from google.auth import credentials as ga_credentials   # type: ignore
 from google.oauth2 import service_account              # type: ignore
 
@@ -2556,11 +2557,16 @@ async def get_operation(
 
         # Wrap the RPC method; this adds retry and timeout information,
         # and friendly error handling.
-        rpc = gapic_v1.method_async.wrap_method(
+        TEMP_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
+            gapic_version=DEFAULT_CLIENT_INFO.gapic_version,
+            grpc_version=None,
+            rest_version=google.auth.__version__
+        )
+        rpc = self._client._transport._wrap_method(
             self._client._transport.get_operation,
             default_timeout=None,
-            client_info=DEFAULT_CLIENT_INFO,
-        )
+            client_info=TEMP_CLIENT_INFO,
+        )  # type: ignore
 
         # Certain fields should be provided within the metadata header;
         # add these here.

diff --git a/...ration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/async_client.py b/...ration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/async_client.py
@@ -23,6 +23,7 @@
 from google.api_core import exceptions as core_exceptions
 from google.api_core import gapic_v1
 from google.api_core import retry_async as retries
+import google.auth
 from google.auth import credentials as ga_credentials   # type: ignore
 from google.oauth2 import service_account              # type: ignore
 
@@ -3876,11 +3877,16 @@ async def get_operation(
 
         # Wrap the RPC method; this adds retry and timeout information,
         # and friendly error handling.
-        rpc = gapic_v1.method_async.wrap_method(
+        TEMP_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
+            gapic_version=DEFAULT_CLIENT_INFO.gapic_version,
+            grpc_version=None,
+            rest_version=google.auth.__version__
+        )
+        rpc = self._client._transport._wrap_method(
             self._client._transport.get_operation,
             default_timeout=None,
-            client_info=DEFAULT_CLIENT_INFO,
-        )
+            client_info=TEMP_CLIENT_INFO,
+        )  # type: ignore
 
         # Certain fields should be provided within the metadata header;
         # add these here.

diff --git a/...ation/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/async_client.py b/...ation/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/async_client.py
@@ -23,6 +23,7 @@
 from google.api_core import exceptions as core_exceptions
 from google.api_core import gapic_v1
 from google.api_core import retry_async as retries
+import google.auth
 from google.auth import credentials as ga_credentials   # type: ignore
 from google.oauth2 import service_account              # type: ignore
 
@@ -1057,11 +1058,16 @@ async def get_operation(
 
         # Wrap the RPC method; this adds retry and timeout information,
         # and friendly error handling.
-        rpc = gapic_v1.method_async.wrap_method(
+        TEMP_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
+            gapic_version=DEFAULT_CLIENT_INFO.gapic_version,
+            grpc_version=None,
+            rest_version=google.auth.__version__
+        )
+        rpc = self._client._transport._wrap_method(
             self._client._transport.get_operation,
             default_timeout=None,
-            client_info=DEFAULT_CLIENT_INFO,
-        )
+            client_info=TEMP_CLIENT_INFO,
+        )  # type: ignore
 
         # Certain fields should be provided within the metadata header;
         # add these here.

diff --git a/...ation/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/async_client.py b/...ation/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/async_client.py
@@ -23,6 +23,7 @@
 from google.api_core import exceptions as core_exceptions
 from google.api_core import gapic_v1
 from google.api_core import retry_async as retries
+import google.auth
 from google.auth import credentials as ga_credentials   # type: ignore
 from google.oauth2 import service_account              # type: ignore
 
@@ -909,11 +910,16 @@ async def get_operation(
 
         # Wrap the RPC method; this adds retry and timeout information,
         # and friendly error handling.
-        rpc = gapic_v1.method_async.wrap_method(
+        TEMP_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
+            gapic_version=DEFAULT_CLIENT_INFO.gapic_version,
+            grpc_version=None,
+            rest_version=google.auth.__version__
+        )
+        rpc = self._client._transport._wrap_method(
             self._client._transport.get_operation,
             default_timeout=None,
-            client_info=DEFAULT_CLIENT_INFO,
-        )
+            client_info=TEMP_CLIENT_INFO,
+        )  # type: ignore
 
         # Certain fields should be provided within the metadata header;
         # add these here.

diff --git a/tests/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/async_client.py b/tests/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/async_client.py
@@ -23,6 +23,7 @@
 from google.api_core import exceptions as core_exceptions
 from google.api_core import gapic_v1
 from google.api_core import retry_async as retries
+import google.auth
 from google.auth import credentials as ga_credentials   # type: ignore
 from google.oauth2 import service_account              # type: ignore
 
@@ -1798,11 +1799,16 @@ async def get_operation(
 
         # Wrap the RPC method; this adds retry and timeout information,
         # and friendly error handling.
-        rpc = gapic_v1.method_async.wrap_method(
+        TEMP_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
+            gapic_version=DEFAULT_CLIENT_INFO.gapic_version,
+            grpc_version=None,
+            rest_version=google.auth.__version__
+        )
+        rpc = self._client._transport._wrap_method(
             self._client._transport.get_operation,
             default_timeout=None,
-            client_info=DEFAULT_CLIENT_INFO,
-        )
+            client_info=TEMP_CLIENT_INFO,
+        )  # type: ignore
 
         # Certain fields should be provided within the metadata header;
         # add these here.