diff --git a/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/_compat.py.j2 b/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/_compat.py.j2 index 39f188d6b403..0716f72decba 100644 --- a/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/_compat.py.j2 +++ b/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/_compat.py.j2 @@ -13,6 +13,7 @@ falling back to the local implementation if not present. #} {# TODO(https://github.com/googleapis/google-cloud-python/issues/17883): Backfill compatibility functions being removed from the client layer. #} +import inspect import os import json {% if has_auto_populated_fields %} @@ -99,6 +100,14 @@ ASYNC_WRAP_METHOD_SUPPORTS_KIND = WRAP_METHOD_SUPPORTS_TRACING or hasattr( gapic_v1.method_async, "_DEFAULT_ASYNC_TRANSPORT_KIND" ) +# The `default_host` parameter in gapic_v1.method.wrap_method, +# gapic_v1.method_async.wrap_method, _observability.get_otel_interceptor, and +# _observability.apply_otel_async_channel_interceptors allows transports to pass +# their resolved default host without mutating caller-owned client_options. +SUPPORTS_DEFAULT_HOST = ( + "default_host" in inspect.signature(gapic_v1.method.wrap_method).parameters +) + try: from google.api_core import grpc_helpers except ImportError: # pragma: NO COVER diff --git a/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/base.py.j2 b/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/base.py.j2 index 9c93aaea9c1d..f74aee2690d4 100644 --- a/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/base.py.j2 +++ b/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/base.py.j2 @@ -9,6 +9,7 @@ from typing import {% if service.any_extended_operations_methods %}Any, {% endif from {{package_path}} import gapic_version as package_version from {{package_path}}._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -128,6 +129,8 @@ class {{ service.name }}Transport(abc.ABC): self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -163,6 +166,12 @@ class {{ service.name }}Transport(abc.ABC): self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -181,6 +190,8 @@ class {{ service.name }}Transport(abc.ABC): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -193,7 +204,7 @@ class {{ service.name }}Transport(abc.ABC): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -220,6 +231,8 @@ class {{ service.name }}Transport(abc.ABC): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -232,7 +245,7 @@ class {{ service.name }}Transport(abc.ABC): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/grpc.py.j2 b/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/grpc.py.j2 index c6ea02ef3317..1d689771a549 100644 --- a/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/grpc.py.j2 +++ b/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/grpc.py.j2 @@ -12,7 +12,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING {% set package_path = api.naming.module_namespace|join('.') + "." + api.naming.versioned_module_name %} -from {{package_path}}._compat import _observability, apply_channel_interceptors +from {{package_path}}._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib {% if service.has_resumable_upload_methods %} @@ -231,6 +235,7 @@ class {{ service.name }}GrpcTransport({{ service.name }}Transport): self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -287,9 +292,12 @@ class {{ service.name }}GrpcTransport({{ service.name }}Transport): ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/grpc_asyncio.py.j2 b/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/grpc_asyncio.py.j2 index 7e35880bfd7e..c6ebfa185723 100644 --- a/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/grpc_asyncio.py.j2 +++ b/packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/grpc_asyncio.py.j2 @@ -13,7 +13,11 @@ from typing import {% if service.has_resumable_upload_methods %}Any, {% endif %} from typing import TYPE_CHECKING {% set package_path = api.naming.module_namespace|join('.') + "." + api.naming.versioned_module_name %} -from {{package_path}}._compat import _observability, apply_async_channel_interceptors +from {{package_path}}._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -279,6 +283,7 @@ class {{ service.grpc_asyncio_transport_name }}({{ service.name }}Transport): self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -349,8 +354,11 @@ class {{ service.grpc_asyncio_transport_name }}({{ service.name }}Transport): # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/gapic/templates/tests/unit/gapic/%name_%version/%sub/test_%service.py.j2 b/packages/gapic-generator/gapic/templates/tests/unit/gapic/%name_%version/%sub/test_%service.py.j2 index 136319c7ced0..ab53d4699321 100644 --- a/packages/gapic-generator/gapic/templates/tests/unit/gapic/%name_%version/%sub/test_%service.py.j2 +++ b/packages/gapic-generator/gapic/templates/tests/unit/gapic/%name_%version/%sub/test_%service.py.j2 @@ -996,7 +996,14 @@ def test_{{ service.name|snake_case }}_grpc_transport_otel_channel_interceptor() client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -1070,7 +1077,14 @@ def test_{{ service.name|snake_case }}_grpc_asyncio_transport_otel_channel_inter client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -1692,6 +1706,8 @@ def test_{{ service.name|snake_case }}_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_{{ service.name|snake_case }}_grpc_asyncio_transport_channel(): @@ -1705,6 +1721,8 @@ def test_{{ service.name|snake_case }}_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None {% if service.has_resumable_upload_methods and 'grpc' in opts.transport %} @@ -2475,27 +2493,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_{{ service.name|snake_case }}_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "{{ opts.transport[0] }}", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_{{ service.name|snake_case }}_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="{{ opts.transport[0] }}" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.{{ service.name }}{{ opts.transport[0].capitalize() }}Transport + if is_concrete + else transports.{{ service.name }}Transport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.{{ service.name }}{{ opts.transport[0].capitalize() }}Transport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "{{ opts.transport[0] }}" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_{{ service.name|snake_case }}_base_transport_client_options_none(): + transport = transports.{{ service.name }}Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_{{ service.name|snake_case }}_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.{{ service.name }}Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.{{ service.name }}Transport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_{{ service.name|snake_case }}_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.{{ service.name }}Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_{{ service.name|snake_case }}_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.{{ service.name }}Transport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_{{ service.name|snake_case }}_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -2573,27 +2697,52 @@ def test_{{ service.name|snake_case }}_base_transport_wrap_method_older_api_core {% if 'grpc' in opts.transport %} -def test_{{ service.name|snake_case }}_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_{{ service.name|snake_case }}_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.{{ service.grpc_asyncio_transport_name }} + if is_concrete + else transports.{{ service.name }}Transport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.{{ service.grpc_asyncio_transport_name }}( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.{{ service.name }}Transport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_{{ service.name|snake_case }}_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/_compat.py b/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/_compat.py index a4347392b042..2545f6fe872e 100755 --- a/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/_compat.py +++ b/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/_compat.py @@ -15,6 +15,7 @@ # """A compatibility module for older versions of google-api-core.""" +import inspect import os import json @@ -90,6 +91,14 @@ def trace_http_request(*args: Any, **kwargs: Any) -> _FallbackTraceContext: # t gapic_v1.method_async, "_DEFAULT_ASYNC_TRANSPORT_KIND" ) +# The `default_host` parameter in gapic_v1.method.wrap_method, +# gapic_v1.method_async.wrap_method, _observability.get_otel_interceptor, and +# _observability.apply_otel_async_channel_interceptors allows transports to pass +# their resolved default host without mutating caller-owned client_options. +SUPPORTS_DEFAULT_HOST = ( + "default_host" in inspect.signature(gapic_v1.method.wrap_method).parameters +) + try: from google.api_core import grpc_helpers except ImportError: # pragma: NO COVER diff --git a/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/base.py b/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/base.py index 515c173224af..47a94f1959b4 100755 --- a/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/base.py @@ -19,6 +19,7 @@ from google.cloud.asset_v1 import gapic_version as package_version from google.cloud.asset_v1._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -102,6 +103,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -134,6 +137,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -152,6 +161,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -164,7 +175,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -191,6 +202,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -203,7 +216,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/grpc.py index 53964d2306d1..b7e7d2fb3cf3 100755 --- a/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.asset_v1._compat import _observability, apply_channel_interceptors +from google.cloud.asset_v1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -221,6 +225,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -277,9 +282,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/grpc_asyncio.py index 2d4465adcf4a..ed98a87ac789 100755 --- a/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.asset_v1._compat import _observability, apply_async_channel_interceptors +from google.cloud.asset_v1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -265,6 +269,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -335,8 +340,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/asset/tests/unit/gapic/asset_v1/test_asset_service.py b/packages/gapic-generator/tests/integration/goldens/asset/tests/unit/gapic/asset_v1/test_asset_service.py index 17fc4c8a5c07..b9dd7e19527a 100755 --- a/packages/gapic-generator/tests/integration/goldens/asset/tests/unit/gapic/asset_v1/test_asset_service.py +++ b/packages/gapic-generator/tests/integration/goldens/asset/tests/unit/gapic/asset_v1/test_asset_service.py @@ -851,7 +851,14 @@ def test_asset_service_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -925,7 +932,14 @@ def test_asset_service_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -17794,6 +17808,8 @@ def test_asset_service_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_asset_service_grpc_asyncio_transport_channel(): @@ -17807,6 +17823,8 @@ def test_asset_service_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -18410,27 +18428,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_asset_service_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_asset_service_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.AssetServiceGrpcTransport + if is_concrete + else transports.AssetServiceTransport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.AssetServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_asset_service_base_transport_client_options_none(): + transport = transports.AssetServiceTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_asset_service_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.AssetServiceTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.AssetServiceTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_asset_service_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.AssetServiceTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_asset_service_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.AssetServiceTransport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_asset_service_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -18507,27 +18631,52 @@ def test_asset_service_base_transport_wrap_method_older_api_core_fallbacks(monke assert "is_streaming" not in kwargs -def test_asset_service_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_asset_service_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.AssetServiceGrpcAsyncIOTransport + if is_concrete + else transports.AssetServiceTransport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.AssetServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.AssetServiceTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_asset_service_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/_compat.py b/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/_compat.py index a4347392b042..2545f6fe872e 100755 --- a/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/_compat.py +++ b/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/_compat.py @@ -15,6 +15,7 @@ # """A compatibility module for older versions of google-api-core.""" +import inspect import os import json @@ -90,6 +91,14 @@ def trace_http_request(*args: Any, **kwargs: Any) -> _FallbackTraceContext: # t gapic_v1.method_async, "_DEFAULT_ASYNC_TRANSPORT_KIND" ) +# The `default_host` parameter in gapic_v1.method.wrap_method, +# gapic_v1.method_async.wrap_method, _observability.get_otel_interceptor, and +# _observability.apply_otel_async_channel_interceptors allows transports to pass +# their resolved default host without mutating caller-owned client_options. +SUPPORTS_DEFAULT_HOST = ( + "default_host" in inspect.signature(gapic_v1.method.wrap_method).parameters +) + try: from google.api_core import grpc_helpers except ImportError: # pragma: NO COVER diff --git a/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/base.py b/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/base.py index 9ad2c974a10c..3bec6ad0cc33 100755 --- a/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/base.py @@ -19,6 +19,7 @@ from google.iam.credentials_v1 import gapic_version as package_version from google.iam.credentials_v1._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -99,6 +100,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -131,6 +134,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -149,6 +158,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -161,7 +172,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -188,6 +199,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -200,7 +213,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/grpc.py index 31fbf17d91cb..8dae63762125 100755 --- a/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.iam.credentials_v1._compat import _observability, apply_channel_interceptors +from google.iam.credentials_v1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -226,6 +230,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -282,9 +287,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/grpc_asyncio.py index 2465db4b3328..caa5530bb88e 100755 --- a/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.iam.credentials_v1._compat import _observability, apply_async_channel_interceptors +from google.iam.credentials_v1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -270,6 +274,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -340,8 +345,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/credentials/tests/unit/gapic/credentials_v1/test_iam_credentials.py b/packages/gapic-generator/tests/integration/goldens/credentials/tests/unit/gapic/credentials_v1/test_iam_credentials.py index f39f23ababfa..8c7601cf7d18 100755 --- a/packages/gapic-generator/tests/integration/goldens/credentials/tests/unit/gapic/credentials_v1/test_iam_credentials.py +++ b/packages/gapic-generator/tests/integration/goldens/credentials/tests/unit/gapic/credentials_v1/test_iam_credentials.py @@ -841,7 +841,14 @@ def test_iam_credentials_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -915,7 +922,14 @@ def test_iam_credentials_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -4151,6 +4165,8 @@ def test_iam_credentials_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_iam_credentials_grpc_asyncio_transport_channel(): @@ -4164,6 +4180,8 @@ def test_iam_credentials_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -4456,27 +4474,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_iam_credentials_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_iam_credentials_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.IAMCredentialsGrpcTransport + if is_concrete + else transports.IAMCredentialsTransport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.IAMCredentialsGrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_iam_credentials_base_transport_client_options_none(): + transport = transports.IAMCredentialsTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_iam_credentials_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.IAMCredentialsTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.IAMCredentialsTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_iam_credentials_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.IAMCredentialsTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_iam_credentials_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.IAMCredentialsTransport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_iam_credentials_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -4553,27 +4677,52 @@ def test_iam_credentials_base_transport_wrap_method_older_api_core_fallbacks(mon assert "is_streaming" not in kwargs -def test_iam_credentials_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_iam_credentials_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.IAMCredentialsGrpcAsyncIOTransport + if is_concrete + else transports.IAMCredentialsTransport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.IAMCredentialsGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.IAMCredentialsTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_iam_credentials_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/_compat.py b/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/_compat.py index a4347392b042..2545f6fe872e 100755 --- a/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/_compat.py +++ b/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/_compat.py @@ -15,6 +15,7 @@ # """A compatibility module for older versions of google-api-core.""" +import inspect import os import json @@ -90,6 +91,14 @@ def trace_http_request(*args: Any, **kwargs: Any) -> _FallbackTraceContext: # t gapic_v1.method_async, "_DEFAULT_ASYNC_TRANSPORT_KIND" ) +# The `default_host` parameter in gapic_v1.method.wrap_method, +# gapic_v1.method_async.wrap_method, _observability.get_otel_interceptor, and +# _observability.apply_otel_async_channel_interceptors allows transports to pass +# their resolved default host without mutating caller-owned client_options. +SUPPORTS_DEFAULT_HOST = ( + "default_host" in inspect.signature(gapic_v1.method.wrap_method).parameters +) + try: from google.api_core import grpc_helpers except ImportError: # pragma: NO COVER diff --git a/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/base.py b/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/base.py index 963fc7ddb134..0643a95575f6 100755 --- a/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/base.py @@ -19,6 +19,7 @@ from google.cloud.eventarc_v1 import gapic_version as package_version from google.cloud.eventarc_v1._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -114,6 +115,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -146,6 +149,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -164,6 +173,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -176,7 +187,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -203,6 +214,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -215,7 +228,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/grpc.py index f4cf2bfdbaff..684cac7b9145 100755 --- a/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.eventarc_v1._compat import _observability, apply_channel_interceptors +from google.cloud.eventarc_v1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -235,6 +239,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -291,9 +296,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/grpc_asyncio.py index 1656b15c6881..344511242b78 100755 --- a/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.eventarc_v1._compat import _observability, apply_async_channel_interceptors +from google.cloud.eventarc_v1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -279,6 +283,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -349,8 +354,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/eventarc/tests/unit/gapic/eventarc_v1/test_eventarc.py b/packages/gapic-generator/tests/integration/goldens/eventarc/tests/unit/gapic/eventarc_v1/test_eventarc.py index b5e055c25ec9..86fef1613499 100755 --- a/packages/gapic-generator/tests/integration/goldens/eventarc/tests/unit/gapic/eventarc_v1/test_eventarc.py +++ b/packages/gapic-generator/tests/integration/goldens/eventarc/tests/unit/gapic/eventarc_v1/test_eventarc.py @@ -872,7 +872,14 @@ def test_eventarc_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -946,7 +953,14 @@ def test_eventarc_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -31283,6 +31297,8 @@ def test_eventarc_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_eventarc_grpc_asyncio_transport_channel(): @@ -31296,6 +31312,8 @@ def test_eventarc_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -33513,27 +33531,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_eventarc_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_eventarc_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.EventarcGrpcTransport + if is_concrete + else transports.EventarcTransport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.EventarcGrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_eventarc_base_transport_client_options_none(): + transport = transports.EventarcTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_eventarc_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.EventarcTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.EventarcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_eventarc_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.EventarcTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_eventarc_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.EventarcTransport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_eventarc_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -33610,27 +33734,52 @@ def test_eventarc_base_transport_wrap_method_older_api_core_fallbacks(monkeypatc assert "is_streaming" not in kwargs -def test_eventarc_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_eventarc_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.EventarcGrpcAsyncIOTransport + if is_concrete + else transports.EventarcTransport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.EventarcGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.EventarcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_eventarc_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/_compat.py b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/_compat.py index a4347392b042..2545f6fe872e 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/_compat.py +++ b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/_compat.py @@ -15,6 +15,7 @@ # """A compatibility module for older versions of google-api-core.""" +import inspect import os import json @@ -90,6 +91,14 @@ def trace_http_request(*args: Any, **kwargs: Any) -> _FallbackTraceContext: # t gapic_v1.method_async, "_DEFAULT_ASYNC_TRANSPORT_KIND" ) +# The `default_host` parameter in gapic_v1.method.wrap_method, +# gapic_v1.method_async.wrap_method, _observability.get_otel_interceptor, and +# _observability.apply_otel_async_channel_interceptors allows transports to pass +# their resolved default host without mutating caller-owned client_options. +SUPPORTS_DEFAULT_HOST = ( + "default_host" in inspect.signature(gapic_v1.method.wrap_method).parameters +) + try: from google.api_core import grpc_helpers except ImportError: # pragma: NO COVER diff --git a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/base.py b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/base.py index 4a5dbf0b6ca1..1236732d3cef 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/base.py @@ -19,6 +19,7 @@ from google.cloud.logging_v2 import gapic_version as package_version from google.cloud.logging_v2._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -105,6 +106,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -137,6 +140,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -155,6 +164,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -167,7 +178,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -194,6 +205,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -206,7 +219,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/grpc.py index 543032611b9f..e53299a7cf04 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.logging_v2._compat import _observability, apply_channel_interceptors +from google.cloud.logging_v2._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -221,6 +225,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -277,9 +282,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/grpc_asyncio.py index c03327f2585e..9997dc6d9ef7 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.logging_v2._compat import _observability, apply_async_channel_interceptors +from google.cloud.logging_v2._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -265,6 +269,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -335,8 +340,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/transports/base.py b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/transports/base.py index 4f1882897e01..a49276230595 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/transports/base.py @@ -19,6 +19,7 @@ from google.cloud.logging_v2 import gapic_version as package_version from google.cloud.logging_v2._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -105,6 +106,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -137,6 +140,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -155,6 +164,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -167,7 +178,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -194,6 +205,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -206,7 +219,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/transports/grpc.py index b4508ffcde56..266d9083b341 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.logging_v2._compat import _observability, apply_channel_interceptors +from google.cloud.logging_v2._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -219,6 +223,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -275,9 +280,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/transports/grpc_asyncio.py index 26b8c349c478..77a8d69009b3 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.logging_v2._compat import _observability, apply_async_channel_interceptors +from google.cloud.logging_v2._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -263,6 +267,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -333,8 +338,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/base.py b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/base.py index 98e6b8826af6..0e7cf329fac0 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/base.py @@ -19,6 +19,7 @@ from google.cloud.logging_v2 import gapic_version as package_version from google.cloud.logging_v2._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -105,6 +106,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -137,6 +140,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -155,6 +164,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -167,7 +178,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -194,6 +205,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -206,7 +219,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc.py index f72fc2e40ee4..aa746fb22171 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.logging_v2._compat import _observability, apply_channel_interceptors +from google.cloud.logging_v2._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -219,6 +223,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -275,9 +280,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc_asyncio.py index 54ba2dbe7b1d..6effe18f939b 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.logging_v2._compat import _observability, apply_async_channel_interceptors +from google.cloud.logging_v2._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -263,6 +267,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -333,8 +338,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_config_service_v2.py b/packages/gapic-generator/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_config_service_v2.py index acea90dd0a47..f2a5fbe88df5 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_config_service_v2.py +++ b/packages/gapic-generator/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_config_service_v2.py @@ -827,7 +827,14 @@ def test_config_service_v2_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -901,7 +908,14 @@ def test_config_service_v2_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -13059,6 +13073,8 @@ def test_config_service_v2_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_config_service_v2_grpc_asyncio_transport_channel(): @@ -13072,6 +13088,8 @@ def test_config_service_v2_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -14007,27 +14025,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_config_service_v2_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_config_service_v2_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.ConfigServiceV2GrpcTransport + if is_concrete + else transports.ConfigServiceV2Transport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.ConfigServiceV2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_config_service_v2_base_transport_client_options_none(): + transport = transports.ConfigServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_config_service_v2_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.ConfigServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.ConfigServiceV2Transport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_config_service_v2_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.ConfigServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_config_service_v2_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.ConfigServiceV2Transport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_config_service_v2_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -14104,27 +14228,52 @@ def test_config_service_v2_base_transport_wrap_method_older_api_core_fallbacks(m assert "is_streaming" not in kwargs -def test_config_service_v2_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_config_service_v2_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.ConfigServiceV2GrpcAsyncIOTransport + if is_concrete + else transports.ConfigServiceV2Transport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.ConfigServiceV2GrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.ConfigServiceV2Transport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_config_service_v2_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_logging_service_v2.py b/packages/gapic-generator/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_logging_service_v2.py index 433ff946bd8b..6173c39bb9bf 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_logging_service_v2.py +++ b/packages/gapic-generator/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_logging_service_v2.py @@ -828,7 +828,14 @@ def test_logging_service_v2_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -902,7 +909,14 @@ def test_logging_service_v2_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -3653,6 +3667,8 @@ def test_logging_service_v2_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_logging_service_v2_grpc_asyncio_transport_channel(): @@ -3666,6 +3682,8 @@ def test_logging_service_v2_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -4447,27 +4465,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_logging_service_v2_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_logging_service_v2_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.LoggingServiceV2GrpcTransport + if is_concrete + else transports.LoggingServiceV2Transport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.LoggingServiceV2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_logging_service_v2_base_transport_client_options_none(): + transport = transports.LoggingServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_logging_service_v2_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.LoggingServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.LoggingServiceV2Transport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_logging_service_v2_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.LoggingServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_logging_service_v2_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.LoggingServiceV2Transport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_logging_service_v2_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -4544,27 +4668,52 @@ def test_logging_service_v2_base_transport_wrap_method_older_api_core_fallbacks( assert "is_streaming" not in kwargs -def test_logging_service_v2_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_logging_service_v2_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.LoggingServiceV2GrpcAsyncIOTransport + if is_concrete + else transports.LoggingServiceV2Transport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.LoggingServiceV2GrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.LoggingServiceV2Transport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_logging_service_v2_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_metrics_service_v2.py b/packages/gapic-generator/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_metrics_service_v2.py index c3809e05816a..62b10a0b4b79 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_metrics_service_v2.py +++ b/packages/gapic-generator/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_metrics_service_v2.py @@ -826,7 +826,14 @@ def test_metrics_service_v2_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -900,7 +907,14 @@ def test_metrics_service_v2_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -3453,6 +3467,8 @@ def test_metrics_service_v2_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_metrics_service_v2_grpc_asyncio_transport_channel(): @@ -3466,6 +3482,8 @@ def test_metrics_service_v2_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -4247,27 +4265,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_metrics_service_v2_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_metrics_service_v2_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.MetricsServiceV2GrpcTransport + if is_concrete + else transports.MetricsServiceV2Transport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.MetricsServiceV2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_metrics_service_v2_base_transport_client_options_none(): + transport = transports.MetricsServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_metrics_service_v2_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.MetricsServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.MetricsServiceV2Transport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_metrics_service_v2_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.MetricsServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_metrics_service_v2_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.MetricsServiceV2Transport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_metrics_service_v2_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -4344,27 +4468,52 @@ def test_metrics_service_v2_base_transport_wrap_method_older_api_core_fallbacks( assert "is_streaming" not in kwargs -def test_metrics_service_v2_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_metrics_service_v2_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.MetricsServiceV2GrpcAsyncIOTransport + if is_concrete + else transports.MetricsServiceV2Transport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.MetricsServiceV2GrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.MetricsServiceV2Transport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_metrics_service_v2_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/_compat.py b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/_compat.py index a4347392b042..2545f6fe872e 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/_compat.py +++ b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/_compat.py @@ -15,6 +15,7 @@ # """A compatibility module for older versions of google-api-core.""" +import inspect import os import json @@ -90,6 +91,14 @@ def trace_http_request(*args: Any, **kwargs: Any) -> _FallbackTraceContext: # t gapic_v1.method_async, "_DEFAULT_ASYNC_TRANSPORT_KIND" ) +# The `default_host` parameter in gapic_v1.method.wrap_method, +# gapic_v1.method_async.wrap_method, _observability.get_otel_interceptor, and +# _observability.apply_otel_async_channel_interceptors allows transports to pass +# their resolved default host without mutating caller-owned client_options. +SUPPORTS_DEFAULT_HOST = ( + "default_host" in inspect.signature(gapic_v1.method.wrap_method).parameters +) + try: from google.api_core import grpc_helpers except ImportError: # pragma: NO COVER diff --git a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/config_service_v2/transports/base.py b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/config_service_v2/transports/base.py index 4a5dbf0b6ca1..1236732d3cef 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/config_service_v2/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/config_service_v2/transports/base.py @@ -19,6 +19,7 @@ from google.cloud.logging_v2 import gapic_version as package_version from google.cloud.logging_v2._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -105,6 +106,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -137,6 +140,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -155,6 +164,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -167,7 +178,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -194,6 +205,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -206,7 +219,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/config_service_v2/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/config_service_v2/transports/grpc.py index 543032611b9f..e53299a7cf04 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/config_service_v2/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/config_service_v2/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.logging_v2._compat import _observability, apply_channel_interceptors +from google.cloud.logging_v2._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -221,6 +225,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -277,9 +282,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/config_service_v2/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/config_service_v2/transports/grpc_asyncio.py index c03327f2585e..9997dc6d9ef7 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/config_service_v2/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/config_service_v2/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.logging_v2._compat import _observability, apply_async_channel_interceptors +from google.cloud.logging_v2._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -265,6 +269,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -335,8 +340,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/logging_service_v2/transports/base.py b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/logging_service_v2/transports/base.py index 4f1882897e01..a49276230595 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/logging_service_v2/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/logging_service_v2/transports/base.py @@ -19,6 +19,7 @@ from google.cloud.logging_v2 import gapic_version as package_version from google.cloud.logging_v2._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -105,6 +106,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -137,6 +140,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -155,6 +164,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -167,7 +178,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -194,6 +205,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -206,7 +219,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/logging_service_v2/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/logging_service_v2/transports/grpc.py index b4508ffcde56..266d9083b341 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/logging_service_v2/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/logging_service_v2/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.logging_v2._compat import _observability, apply_channel_interceptors +from google.cloud.logging_v2._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -219,6 +223,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -275,9 +280,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/logging_service_v2/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/logging_service_v2/transports/grpc_asyncio.py index 26b8c349c478..77a8d69009b3 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/logging_service_v2/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/logging_service_v2/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.logging_v2._compat import _observability, apply_async_channel_interceptors +from google.cloud.logging_v2._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -263,6 +267,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -333,8 +338,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/metrics_service_v2/transports/base.py b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/metrics_service_v2/transports/base.py index 98e6b8826af6..0e7cf329fac0 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/metrics_service_v2/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/metrics_service_v2/transports/base.py @@ -19,6 +19,7 @@ from google.cloud.logging_v2 import gapic_version as package_version from google.cloud.logging_v2._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -105,6 +106,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -137,6 +140,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -155,6 +164,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -167,7 +178,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -194,6 +205,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -206,7 +219,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc.py index f72fc2e40ee4..aa746fb22171 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.logging_v2._compat import _observability, apply_channel_interceptors +from google.cloud.logging_v2._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -219,6 +223,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -275,9 +280,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc_asyncio.py index 54ba2dbe7b1d..6effe18f939b 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/metrics_service_v2/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.logging_v2._compat import _observability, apply_async_channel_interceptors +from google.cloud.logging_v2._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -263,6 +267,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -333,8 +338,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_config_service_v2.py b/packages/gapic-generator/tests/integration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_config_service_v2.py index 5d7d971258ae..c6052913a6f3 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_config_service_v2.py +++ b/packages/gapic-generator/tests/integration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_config_service_v2.py @@ -827,7 +827,14 @@ def test_config_service_v2_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -901,7 +908,14 @@ def test_config_service_v2_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -13059,6 +13073,8 @@ def test_config_service_v2_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_config_service_v2_grpc_asyncio_transport_channel(): @@ -13072,6 +13088,8 @@ def test_config_service_v2_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -14007,27 +14025,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_config_service_v2_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_config_service_v2_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.ConfigServiceV2GrpcTransport + if is_concrete + else transports.ConfigServiceV2Transport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.ConfigServiceV2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_config_service_v2_base_transport_client_options_none(): + transport = transports.ConfigServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_config_service_v2_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.ConfigServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.ConfigServiceV2Transport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_config_service_v2_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.ConfigServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_config_service_v2_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.ConfigServiceV2Transport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_config_service_v2_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -14104,27 +14228,52 @@ def test_config_service_v2_base_transport_wrap_method_older_api_core_fallbacks(m assert "is_streaming" not in kwargs -def test_config_service_v2_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_config_service_v2_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.ConfigServiceV2GrpcAsyncIOTransport + if is_concrete + else transports.ConfigServiceV2Transport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.ConfigServiceV2GrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.ConfigServiceV2Transport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_config_service_v2_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_logging_service_v2.py b/packages/gapic-generator/tests/integration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_logging_service_v2.py index 433ff946bd8b..6173c39bb9bf 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_logging_service_v2.py +++ b/packages/gapic-generator/tests/integration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_logging_service_v2.py @@ -828,7 +828,14 @@ def test_logging_service_v2_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -902,7 +909,14 @@ def test_logging_service_v2_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -3653,6 +3667,8 @@ def test_logging_service_v2_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_logging_service_v2_grpc_asyncio_transport_channel(): @@ -3666,6 +3682,8 @@ def test_logging_service_v2_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -4447,27 +4465,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_logging_service_v2_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_logging_service_v2_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.LoggingServiceV2GrpcTransport + if is_concrete + else transports.LoggingServiceV2Transport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.LoggingServiceV2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_logging_service_v2_base_transport_client_options_none(): + transport = transports.LoggingServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_logging_service_v2_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.LoggingServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.LoggingServiceV2Transport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_logging_service_v2_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.LoggingServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_logging_service_v2_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.LoggingServiceV2Transport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_logging_service_v2_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -4544,27 +4668,52 @@ def test_logging_service_v2_base_transport_wrap_method_older_api_core_fallbacks( assert "is_streaming" not in kwargs -def test_logging_service_v2_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_logging_service_v2_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.LoggingServiceV2GrpcAsyncIOTransport + if is_concrete + else transports.LoggingServiceV2Transport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.LoggingServiceV2GrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.LoggingServiceV2Transport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_logging_service_v2_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_metrics_service_v2.py b/packages/gapic-generator/tests/integration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_metrics_service_v2.py index 5fc12c22406b..5eca8fde6778 100755 --- a/packages/gapic-generator/tests/integration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_metrics_service_v2.py +++ b/packages/gapic-generator/tests/integration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_metrics_service_v2.py @@ -826,7 +826,14 @@ def test_metrics_service_v2_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -900,7 +907,14 @@ def test_metrics_service_v2_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -3453,6 +3467,8 @@ def test_metrics_service_v2_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_metrics_service_v2_grpc_asyncio_transport_channel(): @@ -3466,6 +3482,8 @@ def test_metrics_service_v2_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -4247,27 +4265,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_metrics_service_v2_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_metrics_service_v2_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.MetricsServiceV2GrpcTransport + if is_concrete + else transports.MetricsServiceV2Transport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.MetricsServiceV2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_metrics_service_v2_base_transport_client_options_none(): + transport = transports.MetricsServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_metrics_service_v2_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.MetricsServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.MetricsServiceV2Transport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_metrics_service_v2_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.MetricsServiceV2Transport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_metrics_service_v2_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.MetricsServiceV2Transport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_metrics_service_v2_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -4344,27 +4468,52 @@ def test_metrics_service_v2_base_transport_wrap_method_older_api_core_fallbacks( assert "is_streaming" not in kwargs -def test_metrics_service_v2_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_metrics_service_v2_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.MetricsServiceV2GrpcAsyncIOTransport + if is_concrete + else transports.MetricsServiceV2Transport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.MetricsServiceV2GrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.MetricsServiceV2Transport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_metrics_service_v2_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/_compat.py b/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/_compat.py index a4347392b042..2545f6fe872e 100755 --- a/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/_compat.py +++ b/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/_compat.py @@ -15,6 +15,7 @@ # """A compatibility module for older versions of google-api-core.""" +import inspect import os import json @@ -90,6 +91,14 @@ def trace_http_request(*args: Any, **kwargs: Any) -> _FallbackTraceContext: # t gapic_v1.method_async, "_DEFAULT_ASYNC_TRANSPORT_KIND" ) +# The `default_host` parameter in gapic_v1.method.wrap_method, +# gapic_v1.method_async.wrap_method, _observability.get_otel_interceptor, and +# _observability.apply_otel_async_channel_interceptors allows transports to pass +# their resolved default host without mutating caller-owned client_options. +SUPPORTS_DEFAULT_HOST = ( + "default_host" in inspect.signature(gapic_v1.method.wrap_method).parameters +) + try: from google.api_core import grpc_helpers except ImportError: # pragma: NO COVER diff --git a/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/transports/base.py b/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/transports/base.py index 7164fc0bfe5f..6daa5eb339c6 100755 --- a/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/transports/base.py @@ -19,6 +19,7 @@ from google.cloud.redis_v1 import gapic_version as package_version from google.cloud.redis_v1._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -102,6 +103,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -134,6 +137,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -152,6 +161,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -164,7 +175,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -191,6 +202,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -203,7 +216,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/transports/grpc.py index 1a36444c1eb2..53dc638ad6d3 100755 --- a/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.redis_v1._compat import _observability, apply_channel_interceptors +from google.cloud.redis_v1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -241,6 +245,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -297,9 +302,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/transports/grpc_asyncio.py index 6f5ff0d28056..4c95082b021d 100755 --- a/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/redis/google/cloud/redis_v1/services/cloud_redis/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.redis_v1._compat import _observability, apply_async_channel_interceptors +from google.cloud.redis_v1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -285,6 +289,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -355,8 +360,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/redis/tests/unit/gapic/redis_v1/test_cloud_redis.py b/packages/gapic-generator/tests/integration/goldens/redis/tests/unit/gapic/redis_v1/test_cloud_redis.py index e2215a295660..88e200e064a5 100755 --- a/packages/gapic-generator/tests/integration/goldens/redis/tests/unit/gapic/redis_v1/test_cloud_redis.py +++ b/packages/gapic-generator/tests/integration/goldens/redis/tests/unit/gapic/redis_v1/test_cloud_redis.py @@ -859,7 +859,14 @@ def test_cloud_redis_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -933,7 +940,14 @@ def test_cloud_redis_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -11778,6 +11792,8 @@ def test_cloud_redis_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_cloud_redis_grpc_asyncio_transport_channel(): @@ -11791,6 +11807,8 @@ def test_cloud_redis_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -13301,27 +13319,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_cloud_redis_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_cloud_redis_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.CloudRedisGrpcTransport + if is_concrete + else transports.CloudRedisTransport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.CloudRedisGrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_cloud_redis_base_transport_client_options_none(): + transport = transports.CloudRedisTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_cloud_redis_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.CloudRedisTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.CloudRedisTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_cloud_redis_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.CloudRedisTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_cloud_redis_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.CloudRedisTransport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_cloud_redis_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -13398,27 +13522,52 @@ def test_cloud_redis_base_transport_wrap_method_older_api_core_fallbacks(monkeyp assert "is_streaming" not in kwargs -def test_cloud_redis_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_cloud_redis_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.CloudRedisGrpcAsyncIOTransport + if is_concrete + else transports.CloudRedisTransport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.CloudRedisGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.CloudRedisTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_cloud_redis_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/_compat.py b/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/_compat.py index a4347392b042..2545f6fe872e 100755 --- a/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/_compat.py +++ b/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/_compat.py @@ -15,6 +15,7 @@ # """A compatibility module for older versions of google-api-core.""" +import inspect import os import json @@ -90,6 +91,14 @@ def trace_http_request(*args: Any, **kwargs: Any) -> _FallbackTraceContext: # t gapic_v1.method_async, "_DEFAULT_ASYNC_TRANSPORT_KIND" ) +# The `default_host` parameter in gapic_v1.method.wrap_method, +# gapic_v1.method_async.wrap_method, _observability.get_otel_interceptor, and +# _observability.apply_otel_async_channel_interceptors allows transports to pass +# their resolved default host without mutating caller-owned client_options. +SUPPORTS_DEFAULT_HOST = ( + "default_host" in inspect.signature(gapic_v1.method.wrap_method).parameters +) + try: from google.api_core import grpc_helpers except ImportError: # pragma: NO COVER diff --git a/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/services/cloud_redis/transports/base.py b/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/services/cloud_redis/transports/base.py index da37256c19e4..8f14810c51c4 100755 --- a/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/services/cloud_redis/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/services/cloud_redis/transports/base.py @@ -19,6 +19,7 @@ from google.cloud.redis_v1 import gapic_version as package_version from google.cloud.redis_v1._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -102,6 +103,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -134,6 +137,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -152,6 +161,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -164,7 +175,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -191,6 +202,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -203,7 +216,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/services/cloud_redis/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/services/cloud_redis/transports/grpc.py index 287bcfc447cb..e313f7b527d7 100755 --- a/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/services/cloud_redis/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/services/cloud_redis/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.redis_v1._compat import _observability, apply_channel_interceptors +from google.cloud.redis_v1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -241,6 +245,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -297,9 +302,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/services/cloud_redis/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/services/cloud_redis/transports/grpc_asyncio.py index 9a64d47d80aa..9d170d41dec2 100755 --- a/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/services/cloud_redis/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/redis_selective/google/cloud/redis_v1/services/cloud_redis/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.redis_v1._compat import _observability, apply_async_channel_interceptors +from google.cloud.redis_v1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -285,6 +289,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -355,8 +360,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/redis_selective/tests/unit/gapic/redis_v1/test_cloud_redis.py b/packages/gapic-generator/tests/integration/goldens/redis_selective/tests/unit/gapic/redis_v1/test_cloud_redis.py index 7b29386993ee..e91d07951808 100755 --- a/packages/gapic-generator/tests/integration/goldens/redis_selective/tests/unit/gapic/redis_v1/test_cloud_redis.py +++ b/packages/gapic-generator/tests/integration/goldens/redis_selective/tests/unit/gapic/redis_v1/test_cloud_redis.py @@ -859,7 +859,14 @@ def test_cloud_redis_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -933,7 +940,14 @@ def test_cloud_redis_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -6998,6 +7012,8 @@ def test_cloud_redis_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_cloud_redis_grpc_asyncio_transport_channel(): @@ -7011,6 +7027,8 @@ def test_cloud_redis_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -8521,27 +8539,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_cloud_redis_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_cloud_redis_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.CloudRedisGrpcTransport + if is_concrete + else transports.CloudRedisTransport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.CloudRedisGrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_cloud_redis_base_transport_client_options_none(): + transport = transports.CloudRedisTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_cloud_redis_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.CloudRedisTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.CloudRedisTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_cloud_redis_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.CloudRedisTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_cloud_redis_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.CloudRedisTransport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_cloud_redis_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -8618,27 +8742,52 @@ def test_cloud_redis_base_transport_wrap_method_older_api_core_fallbacks(monkeyp assert "is_streaming" not in kwargs -def test_cloud_redis_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_cloud_redis_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.CloudRedisGrpcAsyncIOTransport + if is_concrete + else transports.CloudRedisTransport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.CloudRedisGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.CloudRedisTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_cloud_redis_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/_compat.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/_compat.py index 31817dab22a1..6fa1a43d9af7 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/_compat.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/_compat.py @@ -15,6 +15,7 @@ # """A compatibility module for older versions of google-api-core.""" +import inspect import os import json import uuid @@ -95,6 +96,14 @@ def trace_http_request(*args: Any, **kwargs: Any) -> _FallbackTraceContext: # t gapic_v1.method_async, "_DEFAULT_ASYNC_TRANSPORT_KIND" ) +# The `default_host` parameter in gapic_v1.method.wrap_method, +# gapic_v1.method_async.wrap_method, _observability.get_otel_interceptor, and +# _observability.apply_otel_async_channel_interceptors allows transports to pass +# their resolved default host without mutating caller-owned client_options. +SUPPORTS_DEFAULT_HOST = ( + "default_host" in inspect.signature(gapic_v1.method.wrap_method).parameters +) + try: from google.api_core import grpc_helpers except ImportError: # pragma: NO COVER diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/echo/transports/base.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/echo/transports/base.py index f5e34a9f9aa7..d93594895ac0 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/echo/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/echo/transports/base.py @@ -19,6 +19,7 @@ from google.showcase_v1beta1 import gapic_version as package_version from google.showcase_v1beta1._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -103,6 +104,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -135,6 +138,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -153,6 +162,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -165,7 +176,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -192,6 +203,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -204,7 +217,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/echo/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/echo/transports/grpc.py index 4d5fc8e2ebcd..6fed4c1dd2f9 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/echo/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/echo/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.showcase_v1beta1._compat import _observability, apply_channel_interceptors +from google.showcase_v1beta1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -230,6 +234,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -286,9 +291,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/echo/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/echo/transports/grpc_asyncio.py index c2dd99d6b774..dd650b16ad33 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/echo/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/echo/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.showcase_v1beta1._compat import _observability, apply_async_channel_interceptors +from google.showcase_v1beta1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -274,6 +278,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -344,8 +349,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/identity/transports/base.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/identity/transports/base.py index 8f44d529f6dd..3c6d76262f2c 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/identity/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/identity/transports/base.py @@ -19,6 +19,7 @@ from google.showcase_v1beta1 import gapic_version as package_version from google.showcase_v1beta1._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -103,6 +104,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -135,6 +138,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -153,6 +162,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -165,7 +176,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -192,6 +203,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -204,7 +217,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/identity/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/identity/transports/grpc.py index 3a72ba37662e..1c44b011abfd 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/identity/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/identity/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.showcase_v1beta1._compat import _observability, apply_channel_interceptors +from google.showcase_v1beta1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -222,6 +226,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -278,9 +283,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/identity/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/identity/transports/grpc_asyncio.py index 90527f137ad8..3d1e93a2a8cf 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/identity/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/identity/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.showcase_v1beta1._compat import _observability, apply_async_channel_interceptors +from google.showcase_v1beta1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -266,6 +270,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -336,8 +341,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/messaging/transports/base.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/messaging/transports/base.py index c783a24ea331..4626ad60f627 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/messaging/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/messaging/transports/base.py @@ -19,6 +19,7 @@ from google.showcase_v1beta1 import gapic_version as package_version from google.showcase_v1beta1._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -104,6 +105,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -136,6 +139,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -154,6 +163,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -166,7 +177,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -193,6 +204,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -205,7 +218,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/messaging/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/messaging/transports/grpc.py index 4da466085716..9eabd7fd246d 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/messaging/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/messaging/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.showcase_v1beta1._compat import _observability, apply_channel_interceptors +from google.showcase_v1beta1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -227,6 +231,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -283,9 +288,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/messaging/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/messaging/transports/grpc_asyncio.py index 318dff105c1a..db5dca52d7f1 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/messaging/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/messaging/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.showcase_v1beta1._compat import _observability, apply_async_channel_interceptors +from google.showcase_v1beta1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -271,6 +275,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -341,8 +346,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/resumable_upload_service/transports/base.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/resumable_upload_service/transports/base.py index b9ca386076b2..64bbaa97f3ea 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/resumable_upload_service/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/resumable_upload_service/transports/base.py @@ -19,6 +19,7 @@ from google.showcase_v1beta1 import gapic_version as package_version from google.showcase_v1beta1._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -103,6 +104,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -136,6 +139,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -154,6 +163,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -166,7 +177,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -193,6 +204,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -205,7 +218,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/resumable_upload_service/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/resumable_upload_service/transports/grpc.py index 66a696e695f0..fd81936460f7 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/resumable_upload_service/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/resumable_upload_service/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.showcase_v1beta1._compat import _observability, apply_channel_interceptors +from google.showcase_v1beta1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import exceptions as core_exceptions @@ -232,6 +236,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -288,9 +293,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/resumable_upload_service/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/resumable_upload_service/transports/grpc_asyncio.py index 48a2dc9140a1..c49c8aaf5b1b 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/resumable_upload_service/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/resumable_upload_service/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Any, Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.showcase_v1beta1._compat import _observability, apply_async_channel_interceptors +from google.showcase_v1beta1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -279,6 +283,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -349,8 +354,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/sequence_service/transports/base.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/sequence_service/transports/base.py index f6b79c09fa5f..c5bd5a1d904f 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/sequence_service/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/sequence_service/transports/base.py @@ -19,6 +19,7 @@ from google.showcase_v1beta1 import gapic_version as package_version from google.showcase_v1beta1._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -104,6 +105,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -136,6 +139,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -154,6 +163,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -166,7 +177,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -193,6 +204,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -205,7 +218,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/sequence_service/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/sequence_service/transports/grpc.py index c26a4d8ec34c..38a445e24e6c 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/sequence_service/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/sequence_service/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.showcase_v1beta1._compat import _observability, apply_channel_interceptors +from google.showcase_v1beta1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -225,6 +229,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -281,9 +286,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/sequence_service/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/sequence_service/transports/grpc_asyncio.py index 033643cbf9bd..a6eefa915155 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/sequence_service/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/sequence_service/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.showcase_v1beta1._compat import _observability, apply_async_channel_interceptors +from google.showcase_v1beta1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -269,6 +273,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -339,8 +344,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/testing/transports/base.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/testing/transports/base.py index f0fc08e3ef55..5029de28173b 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/testing/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/testing/transports/base.py @@ -19,6 +19,7 @@ from google.showcase_v1beta1 import gapic_version as package_version from google.showcase_v1beta1._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -103,6 +104,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -135,6 +138,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -153,6 +162,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -165,7 +176,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -192,6 +203,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -204,7 +217,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/testing/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/testing/transports/grpc.py index 81aa2400356c..43b9ea5b7c3d 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/testing/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/testing/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.showcase_v1beta1._compat import _observability, apply_channel_interceptors +from google.showcase_v1beta1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -228,6 +232,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -284,9 +289,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/testing/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/testing/transports/grpc_asyncio.py index 0ce4f859b8df..0595983ce44c 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/testing/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/google/showcase_v1beta1/services/testing/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.showcase_v1beta1._compat import _observability, apply_async_channel_interceptors +from google.showcase_v1beta1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -272,6 +276,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -342,8 +347,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_echo.py b/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_echo.py index 526eb660d4ff..11c8bc0ee587 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_echo.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_echo.py @@ -1148,7 +1148,14 @@ def test_echo_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -1222,7 +1229,14 @@ def test_echo_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -7876,6 +7890,8 @@ def test_echo_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_echo_grpc_asyncio_transport_channel(): @@ -7889,6 +7905,8 @@ def test_echo_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -9780,27 +9798,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_echo_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_echo_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.EchoGrpcTransport + if is_concrete + else transports.EchoTransport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.EchoGrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_echo_base_transport_client_options_none(): + transport = transports.EchoTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_echo_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.EchoTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.EchoTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_echo_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.EchoTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_echo_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.EchoTransport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_echo_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -9877,27 +10001,52 @@ def test_echo_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): assert "is_streaming" not in kwargs -def test_echo_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_echo_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.EchoGrpcAsyncIOTransport + if is_concrete + else transports.EchoTransport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.EchoGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.EchoTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_echo_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_identity.py b/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_identity.py index 28a7dd420d23..556c1228c6cb 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_identity.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_identity.py @@ -849,7 +849,14 @@ def test_identity_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -923,7 +930,14 @@ def test_identity_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -5000,6 +5014,8 @@ def test_identity_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_identity_grpc_asyncio_transport_channel(): @@ -5013,6 +5029,8 @@ def test_identity_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -6887,27 +6905,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_identity_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_identity_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.IdentityGrpcTransport + if is_concrete + else transports.IdentityTransport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.IdentityGrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_identity_base_transport_client_options_none(): + transport = transports.IdentityTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_identity_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.IdentityTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.IdentityTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_identity_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.IdentityTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_identity_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.IdentityTransport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_identity_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -6984,27 +7108,52 @@ def test_identity_base_transport_wrap_method_older_api_core_fallbacks(monkeypatc assert "is_streaming" not in kwargs -def test_identity_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_identity_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.IdentityGrpcAsyncIOTransport + if is_concrete + else transports.IdentityTransport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.IdentityGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.IdentityTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_identity_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_messaging.py b/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_messaging.py index 84906c414aa2..0dc1fa615d4d 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_messaging.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_messaging.py @@ -853,7 +853,14 @@ def test_messaging_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -927,7 +934,14 @@ def test_messaging_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -9828,6 +9842,8 @@ def test_messaging_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_messaging_grpc_asyncio_transport_channel(): @@ -9841,6 +9857,8 @@ def test_messaging_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -11787,27 +11805,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_messaging_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_messaging_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.MessagingGrpcTransport + if is_concrete + else transports.MessagingTransport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.MessagingGrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_messaging_base_transport_client_options_none(): + transport = transports.MessagingTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_messaging_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.MessagingTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.MessagingTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_messaging_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.MessagingTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_messaging_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.MessagingTransport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_messaging_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -11884,27 +12008,52 @@ def test_messaging_base_transport_wrap_method_older_api_core_fallbacks(monkeypat assert "is_streaming" not in kwargs -def test_messaging_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_messaging_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.MessagingGrpcAsyncIOTransport + if is_concrete + else transports.MessagingTransport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.MessagingGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.MessagingTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_messaging_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_resumable_upload_service.py b/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_resumable_upload_service.py index 3d2f99ea1ef7..f354e167b850 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_resumable_upload_service.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_resumable_upload_service.py @@ -854,7 +854,14 @@ def test_resumable_upload_service_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -928,7 +935,14 @@ def test_resumable_upload_service_grpc_asyncio_transport_otel_channel_intercepto client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -2273,6 +2287,8 @@ def test_resumable_upload_service_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_resumable_upload_service_grpc_asyncio_transport_channel(): @@ -2286,6 +2302,8 @@ def test_resumable_upload_service_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_resumable_upload_service_upload_media_grpc_channel_without_credentials_error(): @@ -4480,27 +4498,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_resumable_upload_service_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_resumable_upload_service_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.ResumableUploadServiceGrpcTransport + if is_concrete + else transports.ResumableUploadServiceTransport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.ResumableUploadServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_resumable_upload_service_base_transport_client_options_none(): + transport = transports.ResumableUploadServiceTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_resumable_upload_service_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.ResumableUploadServiceTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.ResumableUploadServiceTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_resumable_upload_service_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.ResumableUploadServiceTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_resumable_upload_service_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.ResumableUploadServiceTransport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_resumable_upload_service_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -4577,27 +4701,52 @@ def test_resumable_upload_service_base_transport_wrap_method_older_api_core_fall assert "is_streaming" not in kwargs -def test_resumable_upload_service_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_resumable_upload_service_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.ResumableUploadServiceGrpcAsyncIOTransport + if is_concrete + else transports.ResumableUploadServiceTransport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.ResumableUploadServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.ResumableUploadServiceTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_resumable_upload_service_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_sequence_service.py b/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_sequence_service.py index 444a6f91969a..1b64c7e1e271 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_sequence_service.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_sequence_service.py @@ -850,7 +850,14 @@ def test_sequence_service_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -924,7 +931,14 @@ def test_sequence_service_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -5631,6 +5645,8 @@ def test_sequence_service_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_sequence_service_grpc_asyncio_transport_channel(): @@ -5644,6 +5660,8 @@ def test_sequence_service_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -7569,27 +7587,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_sequence_service_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_sequence_service_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.SequenceServiceGrpcTransport + if is_concrete + else transports.SequenceServiceTransport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.SequenceServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_sequence_service_base_transport_client_options_none(): + transport = transports.SequenceServiceTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_sequence_service_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.SequenceServiceTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.SequenceServiceTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_sequence_service_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.SequenceServiceTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_sequence_service_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.SequenceServiceTransport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_sequence_service_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -7666,27 +7790,52 @@ def test_sequence_service_base_transport_wrap_method_older_api_core_fallbacks(mo assert "is_streaming" not in kwargs -def test_sequence_service_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_sequence_service_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.SequenceServiceGrpcAsyncIOTransport + if is_concrete + else transports.SequenceServiceTransport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.SequenceServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.SequenceServiceTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_sequence_service_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_testing.py b/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_testing.py index dbda59a14f09..e453f8c98db9 100755 --- a/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_testing.py +++ b/packages/gapic-generator/tests/integration/goldens/showcase/tests/unit/gapic/showcase_v1beta1/test_testing.py @@ -847,7 +847,14 @@ def test_testing_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -921,7 +928,14 @@ def test_testing_grpc_asyncio_transport_otel_channel_interceptor(): client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -5831,6 +5845,8 @@ def test_testing_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_testing_grpc_asyncio_transport_channel(): @@ -5844,6 +5860,8 @@ def test_testing_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -7758,27 +7776,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_testing_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_testing_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.TestingGrpcTransport + if is_concrete + else transports.TestingTransport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.TestingGrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_testing_base_transport_client_options_none(): + transport = transports.TestingTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_testing_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.TestingTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.TestingTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_testing_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.TestingTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_testing_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.TestingTransport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_testing_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -7855,27 +7979,52 @@ def test_testing_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch assert "is_streaming" not in kwargs -def test_testing_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_testing_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.TestingGrpcAsyncIOTransport + if is_concrete + else transports.TestingTransport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.TestingGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.TestingTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_testing_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/_compat.py b/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/_compat.py index 31817dab22a1..6fa1a43d9af7 100755 --- a/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/_compat.py +++ b/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/_compat.py @@ -15,6 +15,7 @@ # """A compatibility module for older versions of google-api-core.""" +import inspect import os import json import uuid @@ -95,6 +96,14 @@ def trace_http_request(*args: Any, **kwargs: Any) -> _FallbackTraceContext: # t gapic_v1.method_async, "_DEFAULT_ASYNC_TRANSPORT_KIND" ) +# The `default_host` parameter in gapic_v1.method.wrap_method, +# gapic_v1.method_async.wrap_method, _observability.get_otel_interceptor, and +# _observability.apply_otel_async_channel_interceptors allows transports to pass +# their resolved default host without mutating caller-owned client_options. +SUPPORTS_DEFAULT_HOST = ( + "default_host" in inspect.signature(gapic_v1.method.wrap_method).parameters +) + try: from google.api_core import grpc_helpers except ImportError: # pragma: NO COVER diff --git a/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/base.py b/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/base.py index 5cf929454825..e6bd0fca7be7 100755 --- a/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/base.py +++ b/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/base.py @@ -19,6 +19,7 @@ from google.cloud.storagebatchoperations_v1 import gapic_version as package_version from google.cloud.storagebatchoperations_v1._compat import ( ASYNC_WRAP_METHOD_SUPPORTS_KIND as _ASYNC_WRAP_METHOD_SUPPORTS_KIND, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, WRAP_METHOD_SUPPORTS_TRACING as _WRAP_METHOD_SUPPORTS_TRACING, ) _ASYNC_WRAP_METHOD_SUPPORTS_TRACING = _WRAP_METHOD_SUPPORTS_TRACING @@ -104,6 +105,8 @@ def __init__( self._scopes = scopes if not hasattr(self, "_ignore_credentials"): self._ignore_credentials: bool = False + if not hasattr(self, "_user_provided_channel"): + self._user_provided_channel: bool = False # If no credentials are provided, then determine the appropriate # defaults. @@ -136,6 +139,12 @@ def __init__( self._host = host self._client_options = client_options + # If a pre-constructed gRPC channel was provided to the subclass before + # super().__init__, self._host is not used to create the channel and + # cannot be trusted as the default span endpoint. + self._default_host: Optional[str] = ( + None if self._user_provided_channel else self._host + ) self._wrapped_methods: Dict[Callable, Callable] = {} @property @@ -154,6 +163,8 @@ def _wrap_method(self, func, *args, **kwargs): """ if _WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -166,7 +177,7 @@ def _wrap_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: @@ -193,6 +204,8 @@ def _wrap_async_method(self, func, *args, **kwargs): """ if _ASYNC_WRAP_METHOD_SUPPORTS_TRACING: kwargs["client_options"] = self._client_options + if _SUPPORTS_DEFAULT_HOST: + kwargs["default_host"] = self._default_host try: kind = self.kind except NotImplementedError: @@ -205,7 +218,7 @@ def _wrap_async_method(self, func, *args, **kwargs): # - Era 2 (>= 2.29.0, < 2.36.0): `kind` is supported (prevents REST from # falling back to gRPC wrapping), but tracing args are not. # (These fallbacks can be removed once google-api-core < 2.36.0 is no longer supported.) - for k in ["client_options", "method_name", "is_streaming"]: + for k in ["client_options", "method_name", "is_streaming", "default_host"]: kwargs.pop(k, None) try: diff --git a/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/grpc.py b/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/grpc.py index 16792a55723a..aa31ac481fe9 100755 --- a/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/grpc.py +++ b/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/grpc.py @@ -20,7 +20,11 @@ from typing import Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.storagebatchoperations_v1._compat import _observability, apply_channel_interceptors +from google.cloud.storagebatchoperations_v1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import grpc_helpers @@ -227,6 +231,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: @@ -283,9 +288,12 @@ def __init__(self, *, ) channel_interceptors = list(interceptors) if interceptors else [] + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) if ( _observability is not None - and (otel_interceptor := _observability.get_otel_interceptor(self._client_options)) is not None + and (otel_interceptor := _observability.get_otel_interceptor(self._client_options, **_otel_interceptor_kwargs)) is not None and otel_interceptor not in channel_interceptors and not any(getattr(i, "_is_otel_interceptor", None) is True for i in channel_interceptors) ): diff --git a/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/grpc_asyncio.py b/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/grpc_asyncio.py index 364bc887126e..d16cf16fd63b 100755 --- a/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/grpc_asyncio.py +++ b/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/grpc_asyncio.py @@ -20,7 +20,11 @@ from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union from typing import TYPE_CHECKING -from google.cloud.storagebatchoperations_v1._compat import _observability, apply_async_channel_interceptors +from google.cloud.storagebatchoperations_v1._compat import ( + _observability, + SUPPORTS_DEFAULT_HOST as _SUPPORTS_DEFAULT_HOST, + apply_async_channel_interceptors, +) from google.api_core import client_options as client_options_lib from google.api_core import gapic_v1 @@ -271,6 +275,7 @@ def __init__(self, *, self._ignore_credentials = True # If a channel was explicitly provided, set it. self._grpc_channel = channel + self._user_provided_channel = True self._ssl_channel_credentials = None else: if api_mtls_endpoint: @@ -341,8 +346,11 @@ def __init__(self, *, # NOTE: Coverage tool ignores async interceptors in environments running # legacy google-api-core (< 2.36.0) where OpenTelemetry is unavailable. # TODO (Issue #18657): Remove once lowest constraints require google-api-core >= v2.43.0. + _otel_interceptor_kwargs = ( + {"default_host": self._default_host} if _SUPPORTS_DEFAULT_HOST else {} + ) # pragma: NO COVER self._grpc_channel = _observability.apply_otel_async_channel_interceptors( - self._grpc_channel, self._client_options + self._grpc_channel, self._client_options, **_otel_interceptor_kwargs ) # pragma: NO COVER self._logged_channel = self._grpc_channel diff --git a/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/tests/unit/gapic/storagebatchoperations_v1/test_storage_batch_operations.py b/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/tests/unit/gapic/storagebatchoperations_v1/test_storage_batch_operations.py index c1f5ed51ac5c..522152f1acbc 100755 --- a/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/tests/unit/gapic/storagebatchoperations_v1/test_storage_batch_operations.py +++ b/packages/gapic-generator/tests/integration/goldens/storagebatchoperations/tests/unit/gapic/storagebatchoperations_v1/test_storage_batch_operations.py @@ -851,7 +851,14 @@ def test_storage_batch_operations_grpc_transport_otel_channel_interceptor(): client_options=options, ) - mock_get_interceptor.assert_called_once_with(options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_get_interceptor.assert_called_once_with( + transport._client_options, **expected_kwargs + ) mock_apply_interceptors.assert_called_once_with( mock_channel, [mock_otel_interceptor] ) @@ -925,7 +932,14 @@ def test_storage_batch_operations_grpc_asyncio_transport_otel_channel_intercepto client_options=options, ) - mock_apply_async_interceptors.assert_called_once_with(mock_channel, options) + expected_kwargs = ( + {"default_host": transport._default_host} + if transports.grpc_asyncio._SUPPORTS_DEFAULT_HOST + else {} + ) + mock_apply_async_interceptors.assert_called_once_with( + mock_channel, transport._client_options, **expected_kwargs + ) assert mock_create_channel.call_count == 1 assert transport.grpc_channel == mock_channel @@ -7069,6 +7083,8 @@ def test_storage_batch_operations_grpc_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_storage_batch_operations_grpc_asyncio_transport_channel(): @@ -7082,6 +7098,8 @@ def test_storage_batch_operations_grpc_asyncio_transport_channel(): assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" assert transport._ssl_channel_credentials == None + assert transport._user_provided_channel is True + assert transport._default_host is None # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are @@ -8457,27 +8475,133 @@ def test_api_key_credentials(client_class, transport_class): ) -def test_storage_batch_operations_base_transport_wrap_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_storage_batch_operations_base_transport_wrap_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.StorageBatchOperationsGrpcTransport + if is_concrete + else transports.StorageBatchOperationsTransport + ) with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - transport = transports.StorageBatchOperationsGrpcTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc" + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs + + +def test_storage_batch_operations_base_transport_client_options_none(): + transport = transports.StorageBatchOperationsTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=None, + ) + assert transport._client_options is None + assert transport._default_host == "default.example.com:443" + + +@pytest.mark.parametrize( + "initial_endpoint", + [ + pytest.param(None, id="unset_api_endpoint"), + pytest.param("custom.example.com:443", id="explicit_api_endpoint"), + ], +) +def test_storage_batch_operations_base_transport_client_options_object( + initial_endpoint, +): + options = client_options.ClientOptions(api_endpoint=initial_endpoint) + transport = transports.StorageBatchOperationsTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint == initial_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method, "wrap_method") as mock_wrap: - base_transport = transports.StorageBatchOperationsTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_method(func) - assert "kind" not in mock_wrap.call_args.kwargs - assert "client_options" in mock_wrap.call_args.kwargs + +@pytest.mark.parametrize( + "initial_options,expected_endpoint", + [ + pytest.param( + {}, + None, + id="unset_api_endpoint", + ), + pytest.param( + {"api_endpoint": "custom.example.com:443"}, + "custom.example.com:443", + id="explicit_api_endpoint", + ), + ], +) +def test_storage_batch_operations_base_transport_client_options_dict( + initial_options, expected_endpoint +): + options = dict(initial_options) + transport = transports.StorageBatchOperationsTransport( + host="default.example.com:443", + credentials=ga_credentials.AnonymousCredentials(), + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.get("api_endpoint") == expected_endpoint + assert transport._user_provided_channel is False + assert transport._default_host == "default.example.com:443" + assert options == initial_options + + +def test_storage_batch_operations_base_transport_default_host_ignored_when_custom_grpc_channel(): + class _CustomChannelTransport(transports.StorageBatchOperationsTransport): + def __init__(self, **kwargs): + self._ignore_credentials = True + self._user_provided_channel = True + super().__init__(**kwargs) + + options = client_options.ClientOptions() + transport = _CustomChannelTransport( + host="default.example.com:443", + client_options=options, + ) + assert transport._client_options is options + assert transport._client_options.api_endpoint is None + assert transport._user_provided_channel is True + assert transport._default_host is None def test_storage_batch_operations_base_transport_wrap_method_older_api_core_fallbacks(monkeypatch): @@ -8554,27 +8678,52 @@ def test_storage_batch_operations_base_transport_wrap_method_older_api_core_fall assert "is_streaming" not in kwargs -def test_storage_batch_operations_base_transport_wrap_async_method_modern_api_core(monkeypatch): +@pytest.mark.parametrize( + "supports_default_host,is_concrete,expected_kind,expected_has_default_host", + [ + pytest.param( + True, + True, + "grpc_asyncio", + True, + id="concrete_transport_supports_default_host", + ), + pytest.param( + False, + False, + None, + False, + id="base_transport_no_default_host", + ), + ], +) +def test_storage_batch_operations_base_transport_wrap_async_method_modern_api_core( + monkeypatch, + supports_default_host, + is_concrete, + expected_kind, + expected_has_default_host, +): monkeypatch.setattr(transports.base, "_ASYNC_WRAP_METHOD_SUPPORTS_TRACING", True) - # 1. Concrete transport: passes client_options=None and kind="grpc_asyncio" + monkeypatch.setattr(transports.base, "_SUPPORTS_DEFAULT_HOST", supports_default_host) + transport_cls = ( + transports.StorageBatchOperationsGrpcAsyncIOTransport + if is_concrete + else transports.StorageBatchOperationsTransport + ) with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - transport = transports.StorageBatchOperationsGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials() - ) + transport = transport_cls(credentials=ga_credentials.AnonymousCredentials()) func = mock.MagicMock() transport._wrap_async_method(func) - assert mock_wrap.call_args.kwargs["kind"] == "grpc_asyncio" - assert "client_options" in mock_wrap.call_args.kwargs - - # 2. Base transport: kind raises NotImplementedError and is cleanly omitted - with mock.patch.object(transports.base.gapic_v1.method_async, "wrap_method") as mock_wrap: - base_transport = transports.StorageBatchOperationsTransport( - credentials=ga_credentials.AnonymousCredentials() - ) - func = mock.MagicMock() - base_transport._wrap_async_method(func) - assert "kind" not in mock_wrap.call_args.kwargs + if expected_kind: + assert mock_wrap.call_args.kwargs["kind"] == expected_kind + else: + assert "kind" not in mock_wrap.call_args.kwargs assert "client_options" in mock_wrap.call_args.kwargs + if expected_has_default_host: + assert mock_wrap.call_args.kwargs["default_host"] == transport._default_host + else: + assert "default_host" not in mock_wrap.call_args.kwargs def test_storage_batch_operations_base_transport_wrap_async_method_older_api_core_fallbacks(monkeypatch): diff --git a/packages/gapic-generator/tests/system/conftest.py b/packages/gapic-generator/tests/system/conftest.py index 0f5643241f4f..cd9ef16be7c0 100644 --- a/packages/gapic-generator/tests/system/conftest.py +++ b/packages/gapic-generator/tests/system/conftest.py @@ -248,6 +248,7 @@ def construct_client( credentials=ga_credentials.AnonymousCredentials(), transport_endpoint="localhost:7469", client_options=None, + channel=None, ): if use_mtls: with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): @@ -267,10 +268,10 @@ def construct_client( transport_cls = client_class.get_transport_class(transport_name) if transport_name in ["grpc", "grpc_asyncio"]: # TODO(gapic-generator-python/issues/1914): Need to test grpc transports without a channel_creator - assert channel_creator + assert channel or channel_creator transport_kwargs = { "credentials": credentials, - "channel": channel_creator(transport_endpoint), + "channel": channel or channel_creator(transport_endpoint), "client_options": client_options, } transport = transport_cls(**transport_kwargs) diff --git a/packages/gapic-generator/tests/system/telemetry_requirements_matrix.csv b/packages/gapic-generator/tests/system/telemetry_requirements_matrix.csv index 6b52380bc2c6..9aa07baf72aa 100644 --- a/packages/gapic-generator/tests/system/telemetry_requirements_matrix.csv +++ b/packages/gapic-generator/tests/system/telemetry_requirements_matrix.csv @@ -6,28 +6,28 @@ F1.4,Client Timeout (HTTP),T4,0,HTTP/REST,Client Timeout,1,CLIENT,POST /v1beta1/ F1.5a,Retry Recovery - Attempt 1 (HTTP),T4,0,HTTP/REST,Retry Recovery,2,CLIENT,POST /v1beta1/{name=sequences/*},ERROR,http,NOT SET,NOT SET,POST,503,NOT SET,googleapis.com,/v1beta1/{name=sequences/*},localhost,7469,503,Temporary glitch,NOT SET,T3.span_id,url.full F1.5b,Retry Recovery - Attempt 2 (HTTP),T4,1,HTTP/REST,Retry Recovery,2,CLIENT,POST /v1beta1/{name=sequences/*},UNSET,http,NOT SET,NOT SET,POST,200,NOT SET,googleapis.com,/v1beta1/{name=sequences/*},localhost,7469,NOT SET,NOT SET,NOT SET,T3.span_id,url.full F1.6,Tracing Off (gRPC),T4,N/A,gRPC,Tracing Off,0,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,No spans emitted -F1.7,Unary Success (gRPC),T4,0,gRPC,Happy Path,1,CLIENT,google.showcase.v1beta1.Echo/Echo,UNSET,grpc,google.showcase.v1beta1.Echo/Echo,OK,NOT SET,NOT SET,0,googleapis.com,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,T3.span_id,"rpc.system, rpc.service" -F1.8,Server Error (gRPC),T4,0,gRPC,Server Failure,1,CLIENT,google.showcase.v1beta1.Echo/Echo,ERROR,grpc,google.showcase.v1beta1.Echo/Echo,NOT SET,NOT SET,NOT SET,3,googleapis.com,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,T3.span_id,"rpc.system, rpc.service" -F1.9,Client Timeout (gRPC),T4,0,gRPC,Client Timeout,1,CLIENT,google.showcase.v1beta1.Echo/Block,ERROR,grpc,google.showcase.v1beta1.Echo/Block,NOT SET,NOT SET,NOT SET,4,googleapis.com,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,T3.span_id,"rpc.system, rpc.service" -F1.10a,Retry Recovery - Attempt 1 (gRPC),T4,0,gRPC,Retry Recovery,2,CLIENT,google.showcase.v1beta1.SequenceService/AttemptSequence,ERROR,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,NOT SET,NOT SET,NOT SET,14,googleapis.com,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,T3.span_id,"rpc.system, rpc.service" -F1.10b,Retry Recovery - Attempt 2 (gRPC),T4,1,gRPC,Retry Recovery,2,CLIENT,google.showcase.v1beta1.SequenceService/AttemptSequence,UNSET,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,OK,NOT SET,NOT SET,0,googleapis.com,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,T3.span_id,"rpc.system, rpc.service" +F1.7,Unary Success (gRPC),T4,0,gRPC,Happy Path,1,CLIENT,google.showcase.v1beta1.Echo/Echo,UNSET,grpc,google.showcase.v1beta1.Echo/Echo,OK,NOT SET,NOT SET,0,googleapis.com,NOT SET,localhost,7469,NOT SET,NOT SET,NOT SET,T3.span_id,"rpc.system, rpc.service" +F1.8,Server Error (gRPC),T4,0,gRPC,Server Failure,1,CLIENT,google.showcase.v1beta1.Echo/Echo,ERROR,grpc,google.showcase.v1beta1.Echo/Echo,NOT SET,NOT SET,NOT SET,3,googleapis.com,NOT SET,localhost,7469,NOT SET,NOT SET,NOT SET,T3.span_id,"rpc.system, rpc.service" +F1.9,Client Timeout (gRPC),T4,0,gRPC,Client Timeout,1,CLIENT,google.showcase.v1beta1.Echo/Block,ERROR,grpc,google.showcase.v1beta1.Echo/Block,NOT SET,NOT SET,NOT SET,4,googleapis.com,NOT SET,localhost,7469,NOT SET,NOT SET,NOT SET,T3.span_id,"rpc.system, rpc.service" +F1.10a,Retry Recovery - Attempt 1 (gRPC),T4,0,gRPC,Retry Recovery,2,CLIENT,google.showcase.v1beta1.SequenceService/AttemptSequence,ERROR,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,NOT SET,NOT SET,NOT SET,14,googleapis.com,NOT SET,localhost,7469,NOT SET,NOT SET,NOT SET,T3.span_id,"rpc.system, rpc.service" +F1.10b,Retry Recovery - Attempt 2 (gRPC),T4,1,gRPC,Retry Recovery,2,CLIENT,google.showcase.v1beta1.SequenceService/AttemptSequence,UNSET,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,OK,NOT SET,NOT SET,0,googleapis.com,NOT SET,localhost,7469,NOT SET,NOT SET,NOT SET,T3.span_id,"rpc.system, rpc.service" F2.1,Tracing Off (HTTP),T3,N/A,HTTP/REST,Tracing Off,0,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,No spans emitted -F2.2,Unary Success (HTTP),T3,0,HTTP/REST,Happy Path,1,INTERNAL,google.showcase.v1beta1.Echo/Echo,UNSET,http,google.showcase.v1beta1.Echo/Echo,OK,NOT SET,200,NOT SET,googleapis.com,/v1beta1/echo:echo,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,None (Root),Strict ceiling (no unknown attrs) -F2.3,Server Error (HTTP),T3,0,HTTP/REST,Server Failure,1,INTERNAL,google.showcase.v1beta1.Echo/Echo,ERROR,http,google.showcase.v1beta1.Echo/Echo,BAD_REQUEST,NOT SET,400,NOT SET,googleapis.com,/v1beta1/echo:echo,NOT SET,NOT SET,400,Simulated unretryable invalid argument error.,NOT SET,None (Root),"gcp.errors.domain, gcp.errors.metadata.*" -F2.4,Client Timeout (HTTP),T3,0,HTTP/REST,Client Timeout,1,INTERNAL,google.showcase.v1beta1.Echo/Block,ERROR,http,google.showcase.v1beta1.Echo/Block,ReadTimeout,NOT SET,NOT SET,NOT SET,googleapis.com,/v1beta1/echo:block,NOT SET,NOT SET,ReadTimeout,"HTTPConnectionPool(host='localhost', port=7469): Read timed out. (read timeout=0.2)",NOT SET,None (Root),gcp.errors.domain +F2.2,Unary Success (HTTP),T3,0,HTTP/REST,Happy Path,1,INTERNAL,google.showcase.v1beta1.Echo/Echo,UNSET,http,google.showcase.v1beta1.Echo/Echo,OK,NOT SET,200,NOT SET,googleapis.com,/v1beta1/echo:echo,localhost,7469,NOT SET,NOT SET,NOT SET,None (Root),Strict ceiling (no unknown attrs) +F2.3,Server Error (HTTP),T3,0,HTTP/REST,Server Failure,1,INTERNAL,google.showcase.v1beta1.Echo/Echo,ERROR,http,google.showcase.v1beta1.Echo/Echo,BAD_REQUEST,NOT SET,400,NOT SET,googleapis.com,/v1beta1/echo:echo,localhost,7469,400,Simulated unretryable invalid argument error.,NOT SET,None (Root),"gcp.errors.domain, gcp.errors.metadata.*" +F2.4,Client Timeout (HTTP),T3,0,HTTP/REST,Client Timeout,1,INTERNAL,google.showcase.v1beta1.Echo/Block,ERROR,http,google.showcase.v1beta1.Echo/Block,ReadTimeout,NOT SET,NOT SET,NOT SET,googleapis.com,/v1beta1/echo:block,localhost,7469,ReadTimeout,"HTTPConnectionPool(host='localhost', port=7469): Read timed out. (read timeout=0.2)",NOT SET,None (Root),gcp.errors.domain F2.5,Tracing Off (gRPC),T3,N/A,gRPC,Tracing Off,0,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,No spans emitted -F2.6,Unary Success (gRPC),T3,0,gRPC,Happy Path,1,INTERNAL,google.showcase.v1beta1.Echo/Echo,UNSET,grpc,google.showcase.v1beta1.Echo/Echo,OK,NOT SET,NOT SET,NOT SET,googleapis.com,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,None (Root),Strict ceiling (no unknown attrs) -F2.7,Server Error (gRPC),T3,0,gRPC,Server Failure,1,INTERNAL,google.showcase.v1beta1.Echo/Echo,ERROR,grpc,google.showcase.v1beta1.Echo/Echo,INVALID_ARGUMENT,NOT SET,NOT SET,NOT SET,googleapis.com,NOT SET,NOT SET,NOT SET,INVALID_ARGUMENT,Simulated unretryable invalid argument error.,NOT SET,None (Root),"gcp.errors.domain, gcp.errors.metadata.*" -F2.8,Client Timeout (gRPC),T3,0,gRPC,Client Timeout,1,INTERNAL,google.showcase.v1beta1.Echo/Block,ERROR,grpc,google.showcase.v1beta1.Echo/Block,DEADLINE_EXCEEDED,NOT SET,NOT SET,NOT SET,googleapis.com,NOT SET,NOT SET,NOT SET,DEADLINE_EXCEEDED,Deadline Exceeded,NOT SET,None (Root),gcp.errors.domain -F3.1a,Retry Succeeds - Root (HTTP),T3,0,HTTP/REST,Retry Recovery,1,INTERNAL,google.showcase.v1beta1.SequenceService/AttemptSequence,UNSET,http,google.showcase.v1beta1.SequenceService/AttemptSequence,OK,NOT SET,200,NOT SET,googleapis.com,/v1beta1/{name=sequences/*},NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,None (Root),Parent aggregates OK; T4 children nested under T3 +F2.6,Unary Success (gRPC),T3,0,gRPC,Happy Path,1,INTERNAL,google.showcase.v1beta1.Echo/Echo,UNSET,grpc,google.showcase.v1beta1.Echo/Echo,OK,NOT SET,NOT SET,NOT SET,googleapis.com,NOT SET,localhost,7469,NOT SET,NOT SET,NOT SET,None (Root),Strict ceiling (no unknown attrs) +F2.7,Server Error (gRPC),T3,0,gRPC,Server Failure,1,INTERNAL,google.showcase.v1beta1.Echo/Echo,ERROR,grpc,google.showcase.v1beta1.Echo/Echo,INVALID_ARGUMENT,NOT SET,NOT SET,NOT SET,googleapis.com,NOT SET,localhost,7469,INVALID_ARGUMENT,Simulated unretryable invalid argument error.,NOT SET,None (Root),"gcp.errors.domain, gcp.errors.metadata.*" +F2.8,Client Timeout (gRPC),T3,0,gRPC,Client Timeout,1,INTERNAL,google.showcase.v1beta1.Echo/Block,ERROR,grpc,google.showcase.v1beta1.Echo/Block,DEADLINE_EXCEEDED,NOT SET,NOT SET,NOT SET,googleapis.com,NOT SET,localhost,7469,DEADLINE_EXCEEDED,Deadline Exceeded,NOT SET,None (Root),gcp.errors.domain +F3.1a,Retry Succeeds - Root (HTTP),T3,0,HTTP/REST,Retry Recovery,1,INTERNAL,google.showcase.v1beta1.SequenceService/AttemptSequence,UNSET,http,google.showcase.v1beta1.SequenceService/AttemptSequence,OK,NOT SET,200,NOT SET,googleapis.com,/v1beta1/{name=sequences/*},localhost,7469,NOT SET,NOT SET,NOT SET,None (Root),Parent aggregates OK; T4 children nested under T3 F3.1b,Retry Succeeds - Attempt 1 (HTTP),T4,0,HTTP/REST,Retry Recovery,2,CLIENT,POST /v1beta1/{name=sequences/*},ERROR,http,NOT SET,NOT SET,POST,503,NOT SET,googleapis.com,/v1beta1/{name=sequences/*},localhost,7469,503,Temporary glitch,NOT SET,T3.span_id,Parent aggregates OK; T4 children nested under T3 F3.1c,Retry Succeeds - Attempt 2 (HTTP),T4,1,HTTP/REST,Retry Recovery,2,CLIENT,POST /v1beta1/{name=sequences/*},UNSET,http,NOT SET,NOT SET,POST,200,NOT SET,googleapis.com,/v1beta1/{name=sequences/*},localhost,7469,NOT SET,NOT SET,NOT SET,T3.span_id,Parent aggregates OK; T4 children nested under T3 -F3.2a,Retries Exhausted - Root (HTTP),T3,0,HTTP/REST,Retries Exhausted,1,INTERNAL,google.showcase.v1beta1.SequenceService/AttemptSequence,ERROR,http,google.showcase.v1beta1.SequenceService/AttemptSequence,UNAVAILABLE,NOT SET,503,NOT SET,googleapis.com,/v1beta1/{name=sequences/*},NOT SET,NOT SET,503,Persistent outage,NOT SET,None (Root),Parent aggregates UNAVAILABLE; all T4 children nested under T3 +F3.2a,Retries Exhausted - Root (HTTP),T3,0,HTTP/REST,Retries Exhausted,1,INTERNAL,google.showcase.v1beta1.SequenceService/AttemptSequence,ERROR,http,google.showcase.v1beta1.SequenceService/AttemptSequence,UNAVAILABLE,NOT SET,503,NOT SET,googleapis.com,/v1beta1/{name=sequences/*},localhost,7469,503,Persistent outage,NOT SET,None (Root),Parent aggregates UNAVAILABLE; all T4 children nested under T3 F3.2b,Retries Exhausted - Attempt 1 (HTTP),T4,0,HTTP/REST,Retries Exhausted,2,CLIENT,POST /v1beta1/{name=sequences/*},ERROR,http,NOT SET,NOT SET,POST,503,NOT SET,googleapis.com,/v1beta1/{name=sequences/*},localhost,7469,503,Persistent outage,NOT SET,T3.span_id,Parent aggregates UNAVAILABLE; all T4 children nested under T3 F3.2c,Retries Exhausted - Attempt 2 (HTTP),T4,1,HTTP/REST,Retries Exhausted,2,CLIENT,POST /v1beta1/{name=sequences/*},ERROR,http,NOT SET,NOT SET,POST,503,NOT SET,googleapis.com,/v1beta1/{name=sequences/*},localhost,7469,503,Persistent outage,NOT SET,T3.span_id,Parent aggregates UNAVAILABLE; all T4 children nested under T3 -F3.3a,Retry Succeeds - Root (gRPC),T3,0,gRPC,Retry Recovery,1,INTERNAL,google.showcase.v1beta1.SequenceService/AttemptSequence,UNSET,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,OK,NOT SET,NOT SET,NOT SET,googleapis.com,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,None (Root),Parent aggregates OK; T4 children nested under T3 -F3.3b,Retry Succeeds - Attempt 1 (gRPC),T4,0,gRPC,Retry Recovery,2,CLIENT,google.showcase.v1beta1.SequenceService/AttemptSequence,ERROR,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,NOT SET,NOT SET,NOT SET,14,googleapis.com,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,T3.span_id,Parent aggregates OK; T4 children nested under T3 -F3.3c,Retry Succeeds - Attempt 2 (gRPC),T4,1,gRPC,Retry Recovery,2,CLIENT,google.showcase.v1beta1.SequenceService/AttemptSequence,UNSET,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,OK,NOT SET,NOT SET,0,googleapis.com,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,T3.span_id,Parent aggregates OK; T4 children nested under T3 -F3.4a,Retries Exhausted - Root (gRPC),T3,0,gRPC,Retries Exhausted,1,INTERNAL,google.showcase.v1beta1.SequenceService/AttemptSequence,ERROR,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,UNAVAILABLE,NOT SET,NOT SET,NOT SET,googleapis.com,NOT SET,NOT SET,NOT SET,UNAVAILABLE,Persistent outage,NOT SET,None (Root),Parent aggregates UNAVAILABLE; all T4 children nested under T3 -F3.4b,Retries Exhausted - Attempt 1 (gRPC),T4,0,gRPC,Retries Exhausted,2,CLIENT,google.showcase.v1beta1.SequenceService/AttemptSequence,ERROR,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,NOT SET,NOT SET,NOT SET,14,googleapis.com,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,T3.span_id,Parent aggregates UNAVAILABLE; all T4 children nested under T3 -F3.4c,Retries Exhausted - Attempt 2 (gRPC),T4,1,gRPC,Retries Exhausted,2,CLIENT,google.showcase.v1beta1.SequenceService/AttemptSequence,ERROR,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,NOT SET,NOT SET,NOT SET,14,googleapis.com,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,NOT SET,T3.span_id,Parent aggregates UNAVAILABLE; all T4 children nested under T3 +F3.3a,Retry Succeeds - Root (gRPC),T3,0,gRPC,Retry Recovery,1,INTERNAL,google.showcase.v1beta1.SequenceService/AttemptSequence,UNSET,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,OK,NOT SET,NOT SET,NOT SET,googleapis.com,NOT SET,localhost,7469,NOT SET,NOT SET,NOT SET,None (Root),Parent aggregates OK; T4 children nested under T3 +F3.3b,Retry Succeeds - Attempt 1 (gRPC),T4,0,gRPC,Retry Recovery,2,CLIENT,google.showcase.v1beta1.SequenceService/AttemptSequence,ERROR,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,NOT SET,NOT SET,NOT SET,14,googleapis.com,NOT SET,localhost,7469,NOT SET,NOT SET,NOT SET,T3.span_id,Parent aggregates OK; T4 children nested under T3 +F3.3c,Retry Succeeds - Attempt 2 (gRPC),T4,1,gRPC,Retry Recovery,2,CLIENT,google.showcase.v1beta1.SequenceService/AttemptSequence,UNSET,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,OK,NOT SET,NOT SET,0,googleapis.com,NOT SET,localhost,7469,NOT SET,NOT SET,NOT SET,T3.span_id,Parent aggregates OK; T4 children nested under T3 +F3.4a,Retries Exhausted - Root (gRPC),T3,0,gRPC,Retries Exhausted,1,INTERNAL,google.showcase.v1beta1.SequenceService/AttemptSequence,ERROR,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,UNAVAILABLE,NOT SET,NOT SET,NOT SET,googleapis.com,NOT SET,localhost,7469,UNAVAILABLE,Persistent outage,NOT SET,None (Root),Parent aggregates UNAVAILABLE; all T4 children nested under T3 +F3.4b,Retries Exhausted - Attempt 1 (gRPC),T4,0,gRPC,Retries Exhausted,2,CLIENT,google.showcase.v1beta1.SequenceService/AttemptSequence,ERROR,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,NOT SET,NOT SET,NOT SET,14,googleapis.com,NOT SET,localhost,7469,NOT SET,NOT SET,NOT SET,T3.span_id,Parent aggregates UNAVAILABLE; all T4 children nested under T3 +F3.4c,Retries Exhausted - Attempt 2 (gRPC),T4,1,gRPC,Retries Exhausted,2,CLIENT,google.showcase.v1beta1.SequenceService/AttemptSequence,ERROR,grpc,google.showcase.v1beta1.SequenceService/AttemptSequence,NOT SET,NOT SET,NOT SET,14,googleapis.com,NOT SET,localhost,7469,NOT SET,NOT SET,NOT SET,T3.span_id,Parent aggregates UNAVAILABLE; all T4 children nested under T3 diff --git a/packages/gapic-generator/tests/system/test_span_compliance.py b/packages/gapic-generator/tests/system/test_span_compliance.py index cc1a87a66a5a..bc5063d8b355 100644 --- a/packages/gapic-generator/tests/system/test_span_compliance.py +++ b/packages/gapic-generator/tests/system/test_span_compliance.py @@ -64,6 +64,7 @@ from pathlib import Path from typing import Any +import grpc import pytest try: @@ -201,6 +202,18 @@ def span_exporter(monkeypatch): # --------------------------------------------------------------------------- +def _insecure_channel_factory(host: str, **kwargs: Any) -> Any: + """Callable channel factory for local Showcase gRPC daemon testing. + + Passing a callable factory instead of a pre-constructed ``grpc.Channel`` + instance ensures ``EchoGrpcTransport`` resolves ``self._host`` from its + ``DEFAULT_HOST`` ("localhost:7469") through the standard host-managed path + (``self._grpc_channel`` created from ``self._host``) while still creating an + insecure channel to the local Showcase server. + """ + return grpc.insecure_channel(host) + + def construct_observability_client( client_class, transport: str, @@ -214,9 +227,9 @@ def construct_observability_client( transport configuration and OpenTelemetry client_options. Design Note: - Rather than modifying the shared system test fixture helper (`conftest.construct_client`), - wrapping it locally insulates this compliance suite with zero blast radius on existing - Showcase tests. + Wrapping the shared system test fixture helper (`conftest.construct_client`) + supplies observability test defaults (`use_mtls=False` and `_insecure_channel_factory` + for host-managed gRPC channels) without altering defaults for other Showcase tests. Args: client_class: The GAPIC client class to instantiate (e.g. EchoClient). @@ -227,11 +240,15 @@ def construct_observability_client( Returns: An instantiated, ready-to-call Showcase client instance. """ + channel = ( + _insecure_channel_factory if (transport == "grpc" and not use_mtls) else None + ) return conftest.construct_client( client_class, use_mtls=use_mtls, transport_name=transport, client_options=client_options, + channel=channel, ) diff --git a/packages/google-api-core/google/api_core/_observability.py b/packages/google-api-core/google/api_core/_observability.py index 38874b666b6e..34e1ca152c37 100644 --- a/packages/google-api-core/google/api_core/_observability.py +++ b/packages/google-api-core/google/api_core/_observability.py @@ -76,27 +76,32 @@ def is_otel_capabilities_enabled( def _extract_endpoint_attributes( client_options: ClientOptions | dict[str, Any] | None = None, + default_host: str | None = None, ) -> dict[str, Any]: """Extracts server.address, server.port (if non-default), and url.domain from client options if present. Args: client_options (Optional[Union[ClientOptions, dict[str, Any]]]): The client options object or dictionary. + default_host (Optional[str]): Fallback transport host when ``api_endpoint`` is not + set on ``client_options``. Returns: - dict[str, Any]: A dictionary containing url.domain and, if an api_endpoint is configured, - server.address and non-default server.port. + dict[str, Any]: A dictionary containing url.domain and, if an api_endpoint or default_host + is configured, server.address and non-default server.port. """ attrs: dict[str, Any] = {} endpoint = None universe_domain = None if isinstance(client_options, dict): - endpoint = client_options.get("api_endpoint") + endpoint = client_options.get("api_endpoint") or default_host universe_domain = client_options.get("universe_domain") elif client_options is not None: - endpoint = getattr(client_options, "api_endpoint", None) + endpoint = getattr(client_options, "api_endpoint", None) or default_host universe_domain = getattr(client_options, "universe_domain", None) + else: + endpoint = default_host attrs["url.domain"] = universe_domain or "googleapis.com" @@ -367,12 +372,15 @@ async def intercept_stream_stream( def get_otel_interceptor( client_options: ClientOptions | dict[str, Any] | None = None, + default_host: str | None = None, ) -> Callable[[grpc.Channel], grpc.Channel] | None: """Returns an interceptor callable that wraps a sync gRPC channel with OpenTelemetry tracing. Args: client_options (Optional[Union[ClientOptions, dict[str, Any]]]): The client options object or dictionary used for feature gating and extracting the tracer provider. + default_host (Optional[str]): Fallback transport host when ``api_endpoint`` is not + set on ``client_options``. Returns: Callable[[grpc.Channel], grpc.Channel] | None: An interceptor callable if OpenTelemetry @@ -383,7 +391,9 @@ def get_otel_interceptor( import opentelemetry.instrumentation.grpc as otel_grpc # type: ignore[import-not-found] - endpoint_attrs = _extract_endpoint_attributes(client_options) + endpoint_attrs = _extract_endpoint_attributes( + client_options, default_host=default_host + ) request_hook = _make_grpc_client_request_hook(endpoint_attrs) interceptor: ClientInterceptor = otel_grpc.client_interceptor( @@ -408,12 +418,15 @@ def otel_interceptor(channel: grpc.Channel) -> grpc.Channel: def get_otel_async_interceptor( client_options: ClientOptions | dict[str, Any] | None = None, + default_host: str | None = None, ) -> Sequence[grpc.aio.ClientInterceptor] | None: """Returns async gRPC client interceptors for OpenTelemetry tracing. Args: client_options (Optional[Union[ClientOptions, dict[str, Any]]]): The client options object or dictionary used for feature gating and extracting the tracer provider. + default_host (Optional[str]): Fallback transport host when ``api_endpoint`` is not + set on ``client_options``. Returns: Sequence[grpc.aio.ClientInterceptor] | None: Instantiated OpenTelemetry async @@ -425,7 +438,9 @@ def get_otel_async_interceptor( # Ignored by mypy: Optional dependency only loaded if early-return is skipped import opentelemetry.instrumentation.grpc as otel_grpc # type: ignore[import-not-found] - endpoint_attrs = _extract_endpoint_attributes(client_options) + endpoint_attrs = _extract_endpoint_attributes( + client_options, default_host=default_host + ) request_hook = _make_grpc_client_request_hook(endpoint_attrs) raw_interceptors = otel_grpc.aio_client_interceptors( @@ -454,6 +469,7 @@ def get_otel_async_interceptor( def apply_otel_async_channel_interceptors( channel: Any, client_options: ClientOptions | dict[str, Any] | Sequence[Any] | None = None, + default_host: str | None = None, ) -> Any: """Creates and attaches OpenTelemetry client interceptors to the front of an async gRPC channel. @@ -467,6 +483,8 @@ def apply_otel_async_channel_interceptors( client_options (Optional[Union[ClientOptions, dict[str, Any], Sequence[Any]]]): The client options used to resolve feature flags and tracer provider, or a sequence of pre-resolved interceptors. + default_host (Optional[str]): Fallback transport host when ``api_endpoint`` is not + set on ``client_options``. Returns: The channel with interceptors prepended to its internal lists, @@ -474,7 +492,9 @@ def apply_otel_async_channel_interceptors( """ otel_interceptors: Sequence[Any] | None if isinstance(client_options, (ClientOptions, dict)) or client_options is None: - otel_interceptors = get_otel_async_interceptor(client_options) + otel_interceptors = get_otel_async_interceptor( + client_options, default_host=default_host + ) elif isinstance(client_options, Sequence): otel_interceptors = client_options else: diff --git a/packages/google-api-core/google/api_core/gapic_v1/method.py b/packages/google-api-core/google/api_core/gapic_v1/method.py index 873e925ec1f7..c154d0173320 100644 --- a/packages/google-api-core/google/api_core/gapic_v1/method.py +++ b/packages/google-api-core/google/api_core/gapic_v1/method.py @@ -295,6 +295,8 @@ class _GapicCallable(object): Client information used for metadata headers. Defaults to None. kind (str): The transport kind for the RPC method. Defaults to "grpc". Allowed values for OpenTelemetry method tracing are "grpc" and "rest". + default_host (Optional[str]): Fallback transport host when ``api_endpoint`` + is not set on ``client_options``. Defaults to None. """ _SUPPORTED_TRACING_KINDS = (_TRANSPORT_KIND_GRPC, _TRANSPORT_KIND_REST) @@ -311,6 +313,7 @@ def __init__( is_streaming=False, client_info=None, kind=_DEFAULT_TRANSPORT_KIND, + default_host=None, ): self._target = target self._retry = retry @@ -352,7 +355,7 @@ def __init__( span_name, _, _ = _extract_rpc_identity(method_name) endpoint_attrs = _observability._extract_endpoint_attributes( - client_options + client_options, default_host=default_host ) span_attributes = { "rpc.system.name": "http" if kind.startswith("rest") else "grpc", @@ -452,6 +455,7 @@ def wrap_method( method_name=None, is_streaming=False, kind=_DEFAULT_TRANSPORT_KIND, + default_host=None, ): """Wrap an RPC method with common behavior. @@ -546,6 +550,8 @@ def get_topic(name, timeout=None): Streaming methods are currently gated and do not generate Tier 3 spans. kind (str): The transport kind for the RPC method. Defaults to "grpc". Allowed values for OpenTelemetry method tracing are "grpc" and "rest". + default_host (Optional[str]): Fallback transport host when ``api_endpoint`` + is not set on ``client_options``. Defaults to None. Returns: Callable: A new callable that takes optional ``retry``, ``timeout``, @@ -578,5 +584,6 @@ def get_topic(name, timeout=None): is_streaming=is_streaming, client_info=client_info, kind=kind, + default_host=default_host, ) ) diff --git a/packages/google-api-core/google/api_core/gapic_v1/method_async.py b/packages/google-api-core/google/api_core/gapic_v1/method_async.py index 2402f9f3ff95..aa7c79ea2e10 100644 --- a/packages/google-api-core/google/api_core/gapic_v1/method_async.py +++ b/packages/google-api-core/google/api_core/gapic_v1/method_async.py @@ -64,6 +64,7 @@ def wrap_method( client_options=None, method_name=None, is_streaming=False, + default_host=None, ): """Wrap an async RPC method with common behavior. @@ -93,6 +94,8 @@ def wrap_method( Used to identify the RPC for observability. is_streaming (bool): Whether the RPC method is streaming. Defaults to False. Streaming methods are currently gated and do not generate Tier 3 spans. + default_host (Optional[str]): Fallback transport host when ``api_endpoint`` + is not set on ``client_options``. Defaults to None. Returns: Callable: A new callable that takes optional ``retry``, ``timeout``, @@ -116,5 +119,6 @@ def wrap_method( is_streaming=is_streaming, client_info=client_info, kind=kind, + default_host=default_host, ) ) diff --git a/packages/google-api-core/tests/asyncio/gapic/test_method_async.py b/packages/google-api-core/tests/asyncio/gapic/test_method_async.py index 159eee84af8e..0108d9e8417a 100644 --- a/packages/google-api-core/tests/asyncio/gapic/test_method_async.py +++ b/packages/google-api-core/tests/asyncio/gapic/test_method_async.py @@ -469,6 +469,33 @@ async def test_wrap_method_async_otel_tracing_client_options( mock_provider.get_tracer.assert_called_once_with("google.api_core") +@pytest.mark.asyncio +async def test_wrap_method_async_otel_tracing_default_host(mock_otel): + """Proves that async wrap_method falls back to default_host when api_endpoint is unset.""" + mock_target = mock.AsyncMock(return_value="success") + + wrapped = gapic_v1.method_async.wrap_method( + mock_target, + client_options=client_options_lib.ClientOptions(), + method_name="/google.showcase.v1beta1.Echo/Echo", + default_host="localhost:7469", + ) + result = await wrapped() + + assert result == "success" + mock_otel.tracer.start_as_current_span.assert_called_once_with( + "google.showcase.v1beta1.Echo/Echo", + kind="INTERNAL", + attributes={ + "rpc.system.name": "grpc", + "rpc.method": "google.showcase.v1beta1.Echo/Echo", + "url.domain": "googleapis.com", + "server.address": "localhost", + "server.port": 7469, + }, + ) + + @pytest.mark.asyncio async def test_wrap_method_async_otel_tracing_enabled_error(mock_otel): """Proves that on async error, status code and error attributes are recorded and exception is raised.""" diff --git a/packages/google-api-core/tests/asyncio/test_observability_async.py b/packages/google-api-core/tests/asyncio/test_observability_async.py index 2a2bfec7dc77..3d7e2087c26f 100644 --- a/packages/google-api-core/tests/asyncio/test_observability_async.py +++ b/packages/google-api-core/tests/asyncio/test_observability_async.py @@ -113,24 +113,30 @@ def test_apply_otel_async_channel_interceptors_sequence_prepending( def test_apply_otel_async_channel_interceptors_client_options_prepending( mock_async_channel, monkeypatch ): - """Proves that interceptors resolved from ClientOptions are prepended in order.""" + """Proves that interceptors resolved from ClientOptions and default_host are prepended in order.""" existing_interceptor = mock.Mock() mock_async_channel._unary_unary_interceptors = [existing_interceptor] interceptor1 = mock.Mock(spec=["intercept_unary_unary"]) interceptor2 = mock.Mock(spec=["intercept_unary_unary"]) - monkeypatch.setenv("GOOGLE_SDK_EXPERIMENTAL_PYTHON_TRACING_ENABLED", "true") + mock_get_interceptor = mock.create_autospec( + _observability.get_otel_async_interceptor, + spec_set=True, + return_value=[interceptor1, interceptor2], + ) monkeypatch.setattr( _observability, "get_otel_async_interceptor", - lambda opts: [interceptor1, interceptor2], + mock_get_interceptor, ) + options = _observability.ClientOptions() result = _observability.apply_otel_async_channel_interceptors( - mock_async_channel, _observability.ClientOptions() + mock_async_channel, options, default_host="localhost:7469" ) assert result is mock_async_channel + mock_get_interceptor.assert_called_once_with(options, default_host="localhost:7469") assert mock_async_channel._unary_unary_interceptors == [ interceptor1, interceptor2, diff --git a/packages/google-api-core/tests/unit/gapic/test_method.py b/packages/google-api-core/tests/unit/gapic/test_method.py index a4a5f805ac91..1a2d85bc12c8 100644 --- a/packages/google-api-core/tests/unit/gapic/test_method.py +++ b/packages/google-api-core/tests/unit/gapic/test_method.py @@ -753,6 +753,33 @@ def test_wrap_method_otel_tracing_endpoint_attributes_from_client_options( ) +def test_wrap_method_otel_tracing_endpoint_attributes_from_default_host( + mock_otel, +): + """Proves that T3 spans fall back to default_host when client_options.api_endpoint is unset.""" + mock_target = mock.Mock(return_value="ok") + options = client_options_lib.ClientOptions() + wrapped = google.api_core.gapic_v1.method.wrap_method( + mock_target, + client_options=options, + method_name="/google.showcase.v1beta1.Echo/Echo", + kind="grpc", + default_host="localhost:7469", + ) + assert wrapped() == "ok" + mock_otel.tracer.start_as_current_span.assert_called_once_with( + "google.showcase.v1beta1.Echo/Echo", + kind="INTERNAL", + attributes={ + "rpc.system.name": "grpc", + "rpc.method": "google.showcase.v1beta1.Echo/Echo", + "url.domain": "googleapis.com", + "server.address": "localhost", + "server.port": 7469, + }, + ) + + def test_extract_error_attributes_standard_exception(): """Proves that _extract_error_attributes returns fallback error.type for exceptions without ErrorInfo.""" assert google.api_core.gapic_v1.method._extract_error_attributes( diff --git a/packages/google-api-core/tests/unit/test_observability.py b/packages/google-api-core/tests/unit/test_observability.py index 1f18428102b8..7cd31e95070f 100644 --- a/packages/google-api-core/tests/unit/test_observability.py +++ b/packages/google-api-core/tests/unit/test_observability.py @@ -379,6 +379,91 @@ def test_extract_endpoint_attributes(client_options, expected_attrs): assert _observability._extract_endpoint_attributes(client_options) == expected_attrs +@pytest.mark.parametrize( + "client_options,default_host,expected_attrs", + [ + pytest.param( + None, + "localhost:7469", + { + "server.address": "localhost", + "server.port": 7469, + "url.domain": "googleapis.com", + }, + id="none_options_uses_default_host", + ), + pytest.param( + {}, + "localhost:7469", + { + "server.address": "localhost", + "server.port": 7469, + "url.domain": "googleapis.com", + }, + id="empty_dict_uses_default_host", + ), + pytest.param( + ClientOptions(api_endpoint=None), + "localhost:7469", + { + "server.address": "localhost", + "server.port": 7469, + "url.domain": "googleapis.com", + }, + id="client_options_without_endpoint_uses_default_host", + ), + pytest.param( + ClientOptions(api_endpoint="custom.example.com:8443"), + "localhost:7469", + { + "server.address": "custom.example.com", + "server.port": 8443, + "url.domain": "googleapis.com", + }, + id="client_options_endpoint_overrides_default_host", + ), + pytest.param( + {"api_endpoint": "custom.example.com:8443"}, + "localhost:7469", + { + "server.address": "custom.example.com", + "server.port": 8443, + "url.domain": "googleapis.com", + }, + id="dict_endpoint_overrides_default_host", + ), + pytest.param( + ClientOptions(api_endpoint=""), + "", + { + "url.domain": "googleapis.com", + }, + id="empty_string_endpoint_and_default_host", + ), + pytest.param( + ClientOptions(api_endpoint=""), + "localhost:7469", + { + "server.address": "localhost", + "server.port": 7469, + "url.domain": "googleapis.com", + }, + id="empty_string_endpoint_falls_back_to_default_host", + ), + ], +) +def test_extract_endpoint_attributes_default_host( + client_options, default_host, expected_attrs +): + """Proves that _extract_endpoint_attributes falls back to default_host when api_endpoint is not set.""" + assert ( + _observability._extract_endpoint_attributes( + client_options, default_host=default_host + ) + == expected_attrs + ) + + def test_grpc_client_request_hook(): """Proves that _grpc_client_request_hook attaches extracted T4 attributes to recording spans, normalizes span names, sets fully qualified rpc.method, and allows legacy rpc.system to coexist.