fix: remove token_info call from token refresh path

google/oauth2/credentials.py

@@ -32,7 +32,6 @@
 """
 
 from datetime import datetime
-import http.client as http_client
 import io
 import json
 import logging
@@ -351,33 +350,6 @@ def with_universe_domain(self, universe_domain):
     def _metric_header_for_usage(self):
         return metrics.CRED_TYPE_USER
 
-    def _set_account_from_access_token(self, request):
-        """Obtain the account from token info endpoint and set the account field.
-
-        Args:
-            request (google.auth.transport.Request): A callable used to make
-                HTTP requests.
-        """
-        # We only set the account if it's not yet set.
-        if self._account:
-            return
-
-        if not self.token:
-            return
-
-        # Make request to token info endpoint with the access token.
-        # If the token is invalid, it returns 400 error code.
-        # If the token is valid, it returns 200 status with a JSON. The account
-        # is the "email" field of the JSON.
-        token_info_url = "{}?access_token={}".format(
-            _GOOGLE_OAUTH2_TOKEN_INFO_ENDPOINT, self.token
-        )
-        response = request(method="GET", url=token_info_url)
-
-        if response.status == http_client.OK:
-            response_data = json.loads(response.data.decode("utf-8"))
-            self._account = response_data.get("email")
-
     @_helpers.copy_docstring(credentials.Credentials)
     def refresh(self, request):
         if self._universe_domain != credentials.DEFAULT_UNIVERSE_DOMAIN:
@@ -414,7 +386,6 @@ def refresh(self, request):
                 )
             self.token = token
             self.expiry = expiry
-            self._set_account_from_access_token(request)
             return
 
         if (
@@ -451,7 +422,6 @@ def refresh(self, request):
         self._refresh_token = refresh_token
         self._id_token = grant_response.get("id_token")
         self._rapt_token = rapt_token
-        self._set_account_from_access_token(request)
 
         if scopes and "scope" in grant_response:
             requested_scopes = frozenset(scopes)

tests/oauth2/test_credentials.py

@@ -71,48 +71,6 @@ def test_default_state(self):
         assert credentials.rapt_token == self.RAPT_TOKEN
         assert credentials.refresh_handler is None
 
-    def test__set_account_from_access_token_no_token(self):
-        credentials = self.make_credentials()
-        assert not credentials.token
-        assert not credentials.account
-
-        credentials._set_account_from_access_token(mock.Mock())
-        assert not credentials.account
-
-    def test__set_account_from_access_token_account_already_set(self):
-        credentials = self.make_credentials()
-        credentials.token = "fake-token"
-        credentials._account = "fake-account"
-
-        credentials._set_account_from_access_token(mock.Mock())
-        assert credentials.account == "fake-account"
-
-    def test__set_account_from_access_token_error_response(self):
-        credentials = self.make_credentials()
-        credentials.token = "fake-token"
-        assert not credentials.account
-
-        mock_response = mock.Mock()
-        mock_response.status = 400
-        mock_request = mock.Mock(return_value=mock_response)
-        credentials._set_account_from_access_token(mock_request)
-        assert not credentials.account
-
-    def test__set_account_from_access_token_success(self):
-        credentials = self.make_credentials()
-        credentials.token = "fake-token"
-        assert not credentials.account
-
-        mock_response = mock.Mock()
-        mock_response.status = 200
-        mock_response.data = (
-            b'{"aud": "aud", "sub": "sub", "scope": "scope", "email": "fake-account"}'
-        )
-
-        mock_request = mock.Mock(return_value=mock_response)
-        credentials._set_account_from_access_token(mock_request)
-        assert credentials.account == "fake-account"
-
     def test_get_cred_info(self):
         credentials = self.make_credentials()
         credentials._account = "fake-account"
@@ -205,15 +163,12 @@ def test_refresh_with_non_default_universe_domain(self):
             "refresh is only supported in the default googleapis.com universe domain"
         )
 
-    @mock.patch.object(
-        credentials.Credentials, "_set_account_from_access_token", autospec=True
-    )
     @mock.patch("google.oauth2.reauth.refresh_grant", autospec=True)
     @mock.patch(
         "google.auth._helpers.utcnow",
         return_value=datetime.datetime.min + _helpers.REFRESH_THRESHOLD,
     )
-    def test_refresh_success(self, unused_utcnow, refresh_grant, set_account):
+    def test_refresh_success(self, unused_utcnow, refresh_grant):
         token = "token"
         new_rapt_token = "new_rapt_token"
         expiry = _helpers.utcnow() + datetime.timedelta(seconds=500)
@@ -259,8 +214,6 @@ def test_refresh_success(self, unused_utcnow, refresh_grant, set_account):
         # expired)
         assert credentials.valid
 
-        set_account.assert_called_once()
-
     def test_refresh_no_refresh_token(self):
         request = mock.create_autospec(transport.Request)
         credentials_ = credentials.Credentials(token=None, refresh_token=None)
@@ -270,16 +223,13 @@ def test_refresh_no_refresh_token(self):
 
         request.assert_not_called()
 
-    @mock.patch.object(
-        credentials.Credentials, "_set_account_from_access_token", autospec=True
-    )
     @mock.patch("google.oauth2.reauth.refresh_grant", autospec=True)
     @mock.patch(
         "google.auth._helpers.utcnow",
         return_value=datetime.datetime.min + _helpers.REFRESH_THRESHOLD,
     )
     def test_refresh_with_refresh_token_and_refresh_handler(
-        self, unused_utcnow, refresh_grant, set_account
+        self, unused_utcnow, refresh_grant
     ):
         token = "token"
         new_rapt_token = "new_rapt_token"
@@ -339,14 +289,9 @@ def test_refresh_with_refresh_token_and_refresh_handler(
         # higher priority.
         refresh_handler.assert_not_called()
 
-        set_account.assert_called_once()
-
-    @mock.patch.object(
-        credentials.Credentials, "_set_account_from_access_token", autospec=True
-    )
     @mock.patch("google.auth._helpers.utcnow", return_value=datetime.datetime.min)
     def test_refresh_with_refresh_handler_success_scopes(
-        self, unused_utcnow, set_account
+        self, unused_utcnow
     ):
         expected_expiry = datetime.datetime.min + datetime.timedelta(seconds=2800)
         refresh_handler = mock.Mock(return_value=("ACCESS_TOKEN", expected_expiry))
@@ -371,16 +316,12 @@ def test_refresh_with_refresh_handler_success_scopes(
         assert creds.expiry == expected_expiry
         assert creds.valid
         assert not creds.expired
-        set_account.assert_called_once()
         # Confirm refresh handler called with the expected arguments.
         refresh_handler.assert_called_with(request, scopes=scopes)
 
-    @mock.patch.object(
-        credentials.Credentials, "_set_account_from_access_token", autospec=True
-    )
     @mock.patch("google.auth._helpers.utcnow", return_value=datetime.datetime.min)
     def test_refresh_with_refresh_handler_success_default_scopes(
-        self, unused_utcnow, set_account
+        self, unused_utcnow
     ):
         expected_expiry = datetime.datetime.min + datetime.timedelta(seconds=2800)
         original_refresh_handler = mock.Mock(
@@ -409,7 +350,6 @@ def test_refresh_with_refresh_handler_success_default_scopes(
         assert creds.expiry == expected_expiry
         assert creds.valid
         assert not creds.expired
-        set_account.assert_called_once()
         # default_scopes should be used since no developer provided scopes
         # are provided.
         refresh_handler.assert_called_with(request, scopes=default_scopes)
@@ -503,16 +443,13 @@ def test_refresh_with_refresh_handler_expired_token(self, unused_utcnow):
         # Confirm refresh handler called with the expected arguments.
         refresh_handler.assert_called_with(request, scopes=scopes)
 
-    @mock.patch.object(
-        credentials.Credentials, "_set_account_from_access_token", autospec=True
-    )
     @mock.patch("google.oauth2.reauth.refresh_grant", autospec=True)
     @mock.patch(
         "google.auth._helpers.utcnow",
         return_value=datetime.datetime.min + _helpers.REFRESH_THRESHOLD,
     )
     def test_credentials_with_scopes_requested_refresh_success(
-        self, unused_utcnow, refresh_grant, set_account
+        self, unused_utcnow, refresh_grant
     ):
         scopes = ["email", "profile"]
         default_scopes = ["https://www.googleapis.com/auth/cloud-platform"]
@@ -568,22 +505,18 @@ def test_credentials_with_scopes_requested_refresh_success(
         assert creds.has_scopes(scopes)
         assert creds.rapt_token == new_rapt_token
         assert creds.granted_scopes == scopes
-        set_account.assert_called_once()
 
         # Check that the credentials are valid (have a token and are not
         # expired.)
         assert creds.valid
 
-    @mock.patch.object(
-        credentials.Credentials, "_set_account_from_access_token", autospec=True
-    )
     @mock.patch("google.oauth2.reauth.refresh_grant", autospec=True)
     @mock.patch(
         "google.auth._helpers.utcnow",
         return_value=datetime.datetime.min + _helpers.REFRESH_THRESHOLD,
     )
     def test_credentials_with_only_default_scopes_requested(
-        self, unused_utcnow, refresh_grant, set_account
+        self, unused_utcnow, refresh_grant
     ):
         default_scopes = ["email", "profile"]
         token = "token"
@@ -637,22 +570,18 @@ def test_credentials_with_only_default_scopes_requested(
         assert creds.has_scopes(default_scopes)
         assert creds.rapt_token == new_rapt_token
         assert creds.granted_scopes == default_scopes
-        set_account.assert_called_once()
 
         # Check that the credentials are valid (have a token and are not
         # expired.)
         assert creds.valid
 
-    @mock.patch.object(
-        credentials.Credentials, "_set_account_from_access_token", autospec=True
-    )
     @mock.patch("google.oauth2.reauth.refresh_grant", autospec=True)
     @mock.patch(
         "google.auth._helpers.utcnow",
         return_value=datetime.datetime.min + _helpers.REFRESH_THRESHOLD,
     )
     def test_credentials_with_scopes_returned_refresh_success(
-        self, unused_utcnow, refresh_grant, set_account
+        self, unused_utcnow, refresh_grant
     ):
         scopes = ["email", "profile"]
         token = "token"
@@ -706,22 +635,18 @@ def test_credentials_with_scopes_returned_refresh_success(
         assert creds.has_scopes(scopes)
         assert creds.rapt_token == new_rapt_token
         assert creds.granted_scopes == scopes
-        set_account.assert_called_once()
 
         # Check that the credentials are valid (have a token and are not
         # expired.)
         assert creds.valid
 
-    @mock.patch.object(
-        credentials.Credentials, "_set_account_from_access_token", autospec=True
-    )
     @mock.patch("google.oauth2.reauth.refresh_grant", autospec=True)
     @mock.patch(
         "google.auth._helpers.utcnow",
         return_value=datetime.datetime.min + _helpers.REFRESH_THRESHOLD,
     )
     def test_credentials_with_only_default_scopes_requested_different_granted_scopes(
-        self, unused_utcnow, refresh_grant, set_account
+        self, unused_utcnow, refresh_grant
     ):
         default_scopes = ["email", "profile"]
         token = "token"
@@ -775,22 +700,18 @@ def test_credentials_with_only_default_scopes_requested_different_granted_scopes
         assert creds.has_scopes(default_scopes)
         assert creds.rapt_token == new_rapt_token
         assert creds.granted_scopes == ["email"]
-        set_account.assert_called_once()
 
         # Check that the credentials are valid (have a token and are not
         # expired.)
         assert creds.valid
 
-    @mock.patch.object(
-        credentials.Credentials, "_set_account_from_access_token", autospec=True
-    )
     @mock.patch("google.oauth2.reauth.refresh_grant", autospec=True)
     @mock.patch(
         "google.auth._helpers.utcnow",
         return_value=datetime.datetime.min + _helpers.REFRESH_THRESHOLD,
     )
     def test_credentials_with_scopes_refresh_different_granted_scopes(
-        self, unused_utcnow, refresh_grant, set_account
+        self, unused_utcnow, refresh_grant
     ):
         scopes = ["email", "profile"]
         scopes_returned = ["email"]
@@ -848,7 +769,6 @@ def test_credentials_with_scopes_refresh_different_granted_scopes(
         assert creds.has_scopes(scopes)
         assert creds.rapt_token == new_rapt_token
         assert creds.granted_scopes == scopes_returned
-        set_account.assert_called_once()
 
         # Check that the credentials are valid (have a token and are not
         # expired.)