feat(secretmanager): rename channel wrapper terminology to interceptor

Author: chalmerlowe

packages/google-cloud-secret-manager/google/cloud/secretmanager_v1/services/secret_manager_service/client.py

@@ -43,9 +43,8 @@
 from google.auth.exceptions import MutualTLSChannelError  # type: ignore
 from google.auth.transport import mtls  # type: ignore
 from google.auth.transport.grpc import SslCredentials  # type: ignore
-from google.oauth2 import service_account  # type: ignore
-
 from google.cloud.secretmanager_v1 import gapic_version as package_version
+from google.oauth2 import service_account  # type: ignore
 
 try:
     OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
@@ -68,7 +67,6 @@
 import google.protobuf.field_mask_pb2 as field_mask_pb2  # type: ignore
 import google.protobuf.timestamp_pb2 as timestamp_pb2  # type: ignore
 from google.cloud.location import locations_pb2  # type: ignore
-
 from google.cloud.secretmanager_v1.services.secret_manager_service import pagers
 from google.cloud.secretmanager_v1.types import resources, service
 
@@ -758,14 +756,14 @@ def __init__(
                 "api_audience": self._client_options.api_audience,
             }
 
-            # When OpenTelemetry tracing is enabled, obtain the channel wrapper
+            # When OpenTelemetry tracing is enabled, obtain the channel interceptor
             # and pass it to the transport.
             if transport_init is SecretManagerServiceGrpcTransport:
-                otel_wrapper = _observability.get_otel_channel_wrapper(
+                otel_interceptor = _observability.get_otel_interceptor(
                     self._client_options
                 )
-                if otel_wrapper is not None:
-                    transport_kwargs["wrappers"] = [otel_wrapper]
+                if otel_interceptor is not None:
+                    transport_kwargs["interceptors"] = [otel_interceptor]
 
             self._transport = transport_init(**transport_kwargs)
 

packages/google-cloud-secret-manager/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc.py

@@ -27,13 +27,12 @@
 import grpc  # type: ignore
 import proto  # type: ignore
 from google.api_core import gapic_v1, grpc_helpers
-from google.api_core.grpc_helpers import ChannelWrapper
+from google.api_core.grpc_helpers import ClientInterceptor
 from google.auth import credentials as ga_credentials  # type: ignore
 from google.auth.transport.grpc import SslCredentials  # type: ignore
 from google.cloud.location import locations_pb2  # type: ignore
-from google.protobuf.json_format import MessageToJson
-
 from google.cloud.secretmanager_v1.types import resources, service
+from google.protobuf.json_format import MessageToJson
 
 from .base import DEFAULT_CLIENT_INFO, SecretManagerServiceTransport
 
@@ -149,7 +148,14 @@ def __init__(
         client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
         always_use_jwt_access: Optional[bool] = False,
         api_audience: Optional[str] = None,
-        wrappers: Optional[Sequence[ChannelWrapper]] = None,
+        interceptors: Optional[
+            Sequence[
+                Union[
+                    ClientInterceptor,
+                    Callable[[grpc.Channel], grpc.Channel],
+                ]
+            ]
+        ] = None,
     ) -> None:
         """Instantiate the transport.
 
@@ -200,8 +206,8 @@ def __init__(
                 to the service that will be set when using certain 3rd party
                 authentication flows. Audience is typically a resource identifier.
                 If not set, the host value will be used as a default.
-            wrappers (Optional[Sequence[ChannelWrapper]]):
-                Additional channel wrappers (interceptors or callables) to apply to the
+            interceptors (Optional[Sequence[Union[ClientInterceptor, Callable[[grpc.Channel], grpc.Channel]]]]):
+                Additional interceptors (or callables that apply interceptors) to apply to the
                 gRPC channel.
 
         Raises:
@@ -279,8 +285,8 @@ def __init__(
                 ],
             )
 
-        self._grpc_channel = grpc_helpers.apply_channel_wrappers(
-            self._grpc_channel, wrappers
+        self._grpc_channel = grpc_helpers.apply_channel_interceptors(
+            self._grpc_channel, interceptors
         )
 
         self._interceptor = _LoggingClientInterceptor()

packages/google-cloud-secret-manager/tests/unit/gapic/secretmanager_v1/test_secret_manager_service.py

@@ -62,15 +62,14 @@
 from google.auth import credentials as ga_credentials
 from google.auth.exceptions import MutualTLSChannelError
 from google.cloud.location import locations_pb2
-from google.oauth2 import service_account
-
 from google.cloud.secretmanager_v1.services.secret_manager_service import (
     SecretManagerServiceAsyncClient,
     SecretManagerServiceClient,
     pagers,
     transports,
 )
 from google.cloud.secretmanager_v1.types import resources, service
+from google.oauth2 import service_account
 
 CRED_INFO_JSON = {
     "credential_source": "/path/to/file",
@@ -774,57 +773,57 @@ def test_secret_manager_service_client_client_options(
 def test_secret_manager_service_client_otel_channel_injection_enabled():
     """Proves that when OpenTelemetry tracing is enabled:
 
-    1. SecretManagerServiceClient obtains the channel wrapper via
-       _observability.get_otel_channel_wrapper passing client_options.
-    2. The wrapper is passed into transport kwargs under 'wrappers',
-       allowing the Transport to apply it via apply_channel_wrappers.
+    1. SecretManagerServiceClient obtains the channel interceptor via
+       _observability.get_otel_interceptor passing client_options.
+    2. The interceptor is passed into transport kwargs under 'interceptors',
+       allowing the Transport to apply it via apply_channel_interceptors.
     """
-    mock_wrapper = mock.Mock()
+    mock_interceptor = mock.Mock()
     with (
         mock.patch(
-            "google.cloud.secretmanager_v1.services.secret_manager_service.client._observability.get_otel_channel_wrapper",
-            return_value=mock_wrapper,
-        ) as mock_get_wrapper,
+            "google.cloud.secretmanager_v1.services.secret_manager_service.client._observability.get_otel_interceptor",
+            return_value=mock_interceptor,
+        ) as mock_get_interceptor,
         mock.patch.object(
             transports.SecretManagerServiceGrpcTransport, "__init__", return_value=None
         ) as patched_transport_init,
     ):
         client = SecretManagerServiceClient(transport="grpc")
 
-        mock_get_wrapper.assert_called_once_with(client._client_options)
+        mock_get_interceptor.assert_called_once_with(client._client_options)
         called_kwargs = patched_transport_init.call_args.kwargs
-        assert "wrappers" in called_kwargs
-        assert called_kwargs["wrappers"] == [mock_wrapper]
+        assert "interceptors" in called_kwargs
+        assert called_kwargs["interceptors"] == [mock_interceptor]
 
 
 def test_secret_manager_service_client_otel_channel_injection_disabled():
     """Proves that when OpenTelemetry tracing is disabled:
 
-    1. SecretManagerServiceClient checks for an OTel wrapper and receives None.
-    2. No 'wrappers' argument is passed to the transport constructor.
+    1. SecretManagerServiceClient checks for an OTel interceptor and receives None.
+    2. No 'interceptors' argument is passed to the transport constructor.
     """
     with (
         mock.patch(
-            "google.cloud.secretmanager_v1.services.secret_manager_service.client._observability.get_otel_channel_wrapper",
+            "google.cloud.secretmanager_v1.services.secret_manager_service.client._observability.get_otel_interceptor",
             return_value=None,
-        ) as mock_get_wrapper,
+        ) as mock_get_interceptor,
         mock.patch.object(
             transports.SecretManagerServiceGrpcTransport, "__init__", return_value=None
         ) as patched_transport_init,
     ):
         client = SecretManagerServiceClient(transport="grpc")
 
-        mock_get_wrapper.assert_called_once_with(client._client_options)
+        mock_get_interceptor.assert_called_once_with(client._client_options)
         called_kwargs = patched_transport_init.call_args.kwargs
-        assert "wrappers" not in called_kwargs
+        assert "interceptors" not in called_kwargs
 
 
-def test_secret_manager_service_grpc_transport_wrappers():
-    """Proves that SecretManagerServiceGrpcTransport accepts channel wrappers
-    and invokes grpc_helpers.apply_channel_wrappers to apply them to the underlying
+def test_secret_manager_service_grpc_transport_interceptors():
+    """Proves that SecretManagerServiceGrpcTransport accepts channel interceptors
+    and invokes grpc_helpers.apply_channel_interceptors to apply them to the underlying
     gRPC channel.
     """
-    mock_wrapper = mock.Mock()
+    mock_interceptor = mock.Mock()
     mock_channel = mock.Mock()
 
     with (
@@ -834,34 +833,38 @@ def test_secret_manager_service_grpc_transport_wrappers():
             return_value=mock_channel,
         ),
         mock.patch(
-            "google.api_core.grpc_helpers.apply_channel_wrappers",
+            "google.api_core.grpc_helpers.apply_channel_interceptors",
             return_value=mock_channel,
-        ) as mock_apply_wrappers,
+        ) as mock_apply_interceptors,
     ):
         transports.SecretManagerServiceGrpcTransport(
-            wrappers=[mock_wrapper],
+            interceptors=[mock_interceptor],
         )
 
-        mock_apply_wrappers.assert_called_once_with(mock_channel, [mock_wrapper])
+        mock_apply_interceptors.assert_called_once_with(
+            mock_channel, [mock_interceptor]
+        )
 
 
-def test_secret_manager_service_grpc_transport_custom_channel_wrappers():
+def test_secret_manager_service_grpc_transport_custom_channel_interceptors():
     """Proves that SecretManagerServiceGrpcTransport wraps explicitly passed custom channels
-    using grpc_helpers.apply_channel_wrappers.
+    using grpc_helpers.apply_channel_interceptors.
     """
-    mock_wrapper = mock.Mock()
+    mock_interceptor = mock.Mock()
     mock_custom_channel = mock.Mock(spec=grpc.Channel)
 
     with mock.patch(
-        "google.api_core.grpc_helpers.apply_channel_wrappers",
+        "google.api_core.grpc_helpers.apply_channel_interceptors",
         return_value=mock_custom_channel,
-    ) as mock_apply_wrappers:
+    ) as mock_apply_interceptors:
         transports.SecretManagerServiceGrpcTransport(
             channel=mock_custom_channel,
-            wrappers=[mock_wrapper],
+            interceptors=[mock_interceptor],
         )
 
-        mock_apply_wrappers.assert_called_once_with(mock_custom_channel, [mock_wrapper])
+        mock_apply_interceptors.assert_called_once_with(
+            mock_custom_channel, [mock_interceptor]
+        )
 
 
 @pytest.mark.parametrize(