Decode global access errors on HTTP 403

Author: AndreyVMarkelov

dropbox/dropbox_client.py

@@ -20,6 +20,7 @@
 
 from datetime import datetime, timedelta
 from dropbox.auth import (
+    AccessError_validator,
     AuthError_validator,
     RateLimitError_validator,
 )
@@ -51,7 +52,7 @@
     pinned_session,
     DEFAULT_TIMEOUT
 )
-from stone.backends.python_rsrc import stone_serializers
+from stone.backends.python_rsrc import stone_serializers, stone_validators
 
 PATH_ROOT_HEADER = 'Dropbox-API-Path-Root'
 HTTP_STATUS_INVALID_PATH_ROOT = 422
@@ -698,7 +699,28 @@ def raise_dropbox_error_for_resp(self, res):
                 else:
                     retry_after = None
             raise RateLimitError(request_id, err, retry_after)
-        elif res.status_code in (403, 404, 409):
+        elif res.status_code == 403:
+            # Access errors are global API errors rather than errors from the
+            # individual route. Decode strictly so a route-specific error that
+            # happens to use HTTP 403 can still be handled by the requester.
+            try:
+                body = res.json()
+                err = stone_serializers.json_compat_obj_decode(
+                    AccessError_validator, body['error'], strict=True)
+            except (ValueError, TypeError, KeyError,
+                    stone_validators.ValidationError):
+                return
+
+            user_message = body.get('user_message')
+            if isinstance(user_message, dict):
+                user_message_text = user_message.get('text')
+                user_message_locale = user_message.get('locale')
+            else:
+                user_message_text = None
+                user_message_locale = None
+            raise ApiError(request_id, err,
+                           user_message_text, user_message_locale)
+        elif res.status_code in (404, 409):
             # special case handled by requester
             return
         elif not (200 <= res.status_code <= 299):

test/unit/test_dropbox_unit.py

@@ -15,7 +15,7 @@
 )
 from dropbox.content_hash import content_hash
 from dropbox.common import PathRoot
-from dropbox.exceptions import AuthError, BadInputError
+from dropbox.exceptions import ApiError, AuthError, BadInputError
 from dropbox.oauth import OAuth2FlowNoRedirectResult, DropboxOAuth2FlowNoRedirect
 from datetime import datetime, timedelta
 
@@ -509,6 +509,62 @@ def test_refresh_raises_after_exhausting_retries(self, server_error_session_inst
         # Initial attempt + 2 retries.
         assert server_error_session_instance.post.call_count == 3
 
+    def test_upload_decodes_global_access_error(self, mocker):
+        payload = {
+            'error': {
+                '.tag': 'invalid_account_type',
+                'invalid_account_type': {'.tag': 'feature'},
+            },
+            'error_summary': 'invalid_account_type/feature/',
+            'user_message': {
+                'text': 'Uploads are unavailable for this account.',
+                'locale': 'en',
+            },
+        }
+        response = mock.MagicMock(status_code=403)
+        response.headers = {
+            'content-type': 'application/json',
+            'x-dropbox-request-id': 'request-id',
+        }
+        response.json.return_value = payload
+        response.content = json.dumps(payload).encode('utf-8')
+        response.text = json.dumps(payload)
+        session_obj = create_session()
+        mocker.patch.object(session_obj, 'post', return_value=response)
+        dbx = Dropbox(oauth2_access_token=ACCESS_TOKEN, session=session_obj)
+
+        with pytest.raises(ApiError) as exc_info:
+            dbx.files_upload(b'test', '/test.txt')
+
+        assert exc_info.value.request_id == 'request-id'
+        assert exc_info.value.error.is_invalid_account_type()
+        assert exc_info.value.error.get_invalid_account_type().is_feature()
+        assert exc_info.value.user_message_text == \
+            'Uploads are unavailable for this account.'
+        assert exc_info.value.user_message_locale == 'en'
+
+    def test_upload_preserves_route_specific_403_error(self, mocker):
+        payload = {
+            'error': {'.tag': 'payload_too_large'},
+            'error_summary': 'payload_too_large/',
+        }
+        response = mock.MagicMock(status_code=403)
+        response.headers = {
+            'content-type': 'application/json',
+            'x-dropbox-request-id': 'request-id',
+        }
+        response.json.return_value = payload
+        response.content = json.dumps(payload).encode('utf-8')
+        response.text = json.dumps(payload)
+        session_obj = create_session()
+        mocker.patch.object(session_obj, 'post', return_value=response)
+        dbx = Dropbox(oauth2_access_token=ACCESS_TOKEN, session=session_obj)
+
+        with pytest.raises(ApiError) as exc_info:
+            dbx.files_upload(b'test', '/test.txt')
+
+        assert exc_info.value.error.is_payload_too_large()
+
 
 class TestAutoContentHash: