refactor: remove deprecated resource based routing support (#73)

Co-authored-by: larkee <[email protected]>

Author: larkee

google/cloud/spanner_v1/client.py

@@ -158,7 +158,6 @@ class Client(ClientWithProject):
 
     _instance_admin_api = None
     _database_admin_api = None
-    _endpoint_cache = {}
     user_agent = None
     _SET_PROJECT = True  # Used by from_service_account_json()
 

google/cloud/spanner_v1/database.py

@@ -17,16 +17,12 @@
 import copy
 import functools
 import grpc
-import os
 import re
 import threading
-import warnings
 
-from google.api_core.client_options import ClientOptions
 import google.auth.credentials
 from google.protobuf.struct_pb2 import Struct
 from google.cloud.exceptions import NotFound
-from google.api_core.exceptions import PermissionDenied
 import six
 
 # pylint: disable=ungrouped-imports
@@ -67,18 +63,6 @@
 
 _DATABASE_METADATA_FILTER = "name:{0}/operations/"
 
-_RESOURCE_ROUTING_PERMISSIONS_WARNING = (
-    "The client library attempted to connect to an endpoint closer to your Cloud Spanner data "
-    "but was unable to do so. The client library will fall back and route requests to the endpoint "
-    "given in the client options, which may result in increased latency. "
-    "We recommend including the scope https://www.googleapis.com/auth/spanner.admin so that the "
-    "client library can get an instance-specific endpoint and efficiently route requests."
-)
-
-
-class ResourceRoutingPermissionsWarning(Warning):
-    pass
-
 
 class Database(object):
     """Representation of a Cloud Spanner Database.
@@ -245,36 +229,6 @@ def spanner_api(self):
             credentials = self._instance._client.credentials
             if isinstance(credentials, google.auth.credentials.Scoped):
                 credentials = credentials.with_scopes((SPANNER_DATA_SCOPE,))
-            if (
-                os.getenv("GOOGLE_CLOUD_SPANNER_ENABLE_RESOURCE_BASED_ROUTING")
-                == "true"
-            ):
-                endpoint_cache = self._instance._client._endpoint_cache
-                if self._instance.name in endpoint_cache:
-                    client_options = ClientOptions(
-                        api_endpoint=endpoint_cache[self._instance.name]
-                    )
-                else:
-                    try:
-                        api = self._instance._client.instance_admin_api
-                        resp = api.get_instance(
-                            self._instance.name,
-                            field_mask={"paths": ["endpoint_uris"]},
-                            metadata=_metadata_with_prefix(self.name),
-                        )
-                        endpoints = resp.endpoint_uris
-                        if endpoints:
-                            endpoint_cache[self._instance.name] = list(endpoints)[0]
-                            client_options = ClientOptions(
-                                api_endpoint=endpoint_cache[self._instance.name]
-                            )
-                        # If there are no endpoints, use default endpoint.
-                    except PermissionDenied:
-                        warnings.warn(
-                            _RESOURCE_ROUTING_PERMISSIONS_WARNING,
-                            ResourceRoutingPermissionsWarning,
-                            stacklevel=2,
-                        )
             self._spanner_api = SpannerClient(
                 credentials=credentials,
                 client_info=client_info,

tests/system/test_system.py

@@ -56,9 +56,6 @@
 
 CREATE_INSTANCE = os.getenv("GOOGLE_CLOUD_TESTS_CREATE_SPANNER_INSTANCE") is not None
 USE_EMULATOR = os.getenv("SPANNER_EMULATOR_HOST") is not None
-USE_RESOURCE_ROUTING = (
-    os.getenv("GOOGLE_CLOUD_SPANNER_ENABLE_RESOURCE_BASED_ROUTING") == "true"
-)
 
 if CREATE_INSTANCE:
     INSTANCE_ID = "google-cloud" + unique_resource_id("-")
@@ -286,61 +283,6 @@ def tearDown(self):
         for doomed in self.to_delete:
             doomed.drop()
 
-    @unittest.skipUnless(USE_RESOURCE_ROUTING, "requires enabling resource routing")
-    def test_spanner_api_use_user_specified_endpoint(self):
-        # Clear cache.
-        Client._endpoint_cache = {}
-        api = Config.CLIENT.instance_admin_api
-        resp = api.get_instance(
-            Config.INSTANCE.name, field_mask={"paths": ["endpoint_uris"]}
-        )
-        if not resp or not resp.endpoint_uris:
-            return  # no resolved endpoint.
-        resolved_endpoint = resp.endpoint_uris[0]
-
-        client = Client(client_options={"api_endpoint": resolved_endpoint})
-
-        instance = client.instance(Config.INSTANCE.instance_id)
-        temp_db_id = "temp_db" + unique_resource_id("_")
-        temp_db = instance.database(temp_db_id)
-        temp_db.spanner_api
-
-        # No endpoint cache - Default endpoint used.
-        self.assertEqual(client._endpoint_cache, {})
-
-    @unittest.skipUnless(USE_RESOURCE_ROUTING, "requires enabling resource routing")
-    def test_spanner_api_use_resolved_endpoint(self):
-        # Clear cache.
-        Client._endpoint_cache = {}
-        api = Config.CLIENT.instance_admin_api
-        resp = api.get_instance(
-            Config.INSTANCE.name, field_mask={"paths": ["endpoint_uris"]}
-        )
-        if not resp or not resp.endpoint_uris:
-            return  # no resolved endpoint.
-        resolved_endpoint = resp.endpoint_uris[0]
-
-        client = Client(
-            client_options=Config.CLIENT._client_options
-        )  # Use same endpoint as main client.
-
-        instance = client.instance(Config.INSTANCE.instance_id)
-        temp_db_id = "temp_db" + unique_resource_id("_")
-        temp_db = instance.database(temp_db_id)
-        temp_db.spanner_api
-
-        # Endpoint is cached - resolved endpoint used.
-        self.assertIn(Config.INSTANCE.name, client._endpoint_cache)
-        self.assertEqual(
-            client._endpoint_cache[Config.INSTANCE.name], resolved_endpoint
-        )
-
-        # Endpoint is cached at a class level.
-        self.assertIn(Config.INSTANCE.name, Config.CLIENT._endpoint_cache)
-        self.assertEqual(
-            Config.CLIENT._endpoint_cache[Config.INSTANCE.name], resolved_endpoint
-        )
-
     def test_list_databases(self):
         # Since `Config.INSTANCE` is newly created in `setUpModule`, the
         # database created in `setUpClass` here will be the only one.