CSC-6771 Implement handling of HTTP 429 and 503 errors for Outlook clients

Author: smihaylishin-sugarcrm

office365_api/v2/exceptions.py

@@ -41,6 +41,21 @@ def __repr__(self):
             'Office365ClientError', self.status_code, self.error_code, self.error_message)
 
 
+class Office365QuotaExceededError(Office365ClientError):
+    '''
+    Exception raised when quota limit is exceeded (HTTP status code 429).
+    Attributes:
+        data -- error data returned by the server
+        error_message -- explanation of the error returned by the server
+        retry_after -- time in seconds to wait before retrying the request
+    '''
+
+    def __init__(self, data=None, error_message=None, retry_after: str | int | None = None):
+
+        super(Office365QuotaExceededError, self).__init__(
+            status_code=429, data=data, error_message=error_message)
+        self.retry_after = retry_after
+
 class Office365ServerError(Exception):
 
     def __init__(self, status_code, body):

office365_api/v2/services/base.py

@@ -1,10 +1,15 @@
-import urllib.parse
 import logging
+import urllib.parse
+
 from requests import HTTPError
-from requests.exceptions import ChunkedEncodingError, ConnectionError as RequestsConnectionError, JSONDecodeError as RequestsJSONDecodeError
+from requests.exceptions import ChunkedEncodingError
+from requests.exceptions import ConnectionError as RequestsConnectionError
+from requests.exceptions import JSONDecodeError as RequestsJSONDecodeError
 
-from ..exceptions import Office365ClientError, Office365ServerError
-from ..consts import DEFAULT_MAX_ENTRIES, RETRIES_COUNT, RESPONSE_FORMAT_ODATA, RESPONSE_FORMAT_RAW
+from ..consts import (DEFAULT_MAX_ENTRIES, RESPONSE_FORMAT_ODATA,
+                      RESPONSE_FORMAT_RAW, RETRIES_COUNT)
+from ..exceptions import (Office365ClientError, Office365QuotaExceededError,
+                          Office365ServerError)
 
 logger = logging.getLogger(__name__)
 
@@ -63,6 +68,16 @@ def execute_request(self, method, path, query_params=None, headers=None, body=No
                         error_data = e.response.json()
                     except (ValueError, RequestsJSONDecodeError):
                         error_data = {'error': {'message': e.response.content, 'code': 'unknown'}}
+                    if e.response.status_code == 429:
+                        retry_after = None
+                        try:
+                            retry_after = int(
+                                e.response.headers.get('Retry-After'))
+                        except Exception as ex:
+                            logger.error(
+                                'Error parsing Retry-After header: %s', ex)
+                        raise Office365QuotaExceededError(
+                            data=error_data, retry_after=retry_after) from e
                     raise Office365ClientError(e.response.status_code, error_data) from e
                 else:
                     raise Office365ServerError(e.response.status_code, e.response.content) from e

office365_api/v2/services/batch.py

@@ -4,12 +4,14 @@
 from requests.exceptions import JSONDecodeError as RequestsJSONDecodeError
 
 from office365_api.v2.exceptions import (Office365ClientError,
+                                         Office365QuotaExceededError,
                                          Office365ServerError)
 
 from .base import BaseService
 
 logger = logging.getLogger(__name__)
 
+
 class BatchService(BaseService):
     def __init__(self, client, beta=True):
         self.client = client
@@ -35,7 +37,8 @@ def add(self, request, callback=None):
 
     def _execute(self, requests):
         if self.is_empty:
-            raise Office365ClientError(error_message='No requests to execute in a batch')
+            raise Office365ClientError(
+                error_message='No requests to execute in a batch')
         method = 'POST'
         default_headers = {'Content-Type': 'application/json'}
         logger.info('{}: {} with {}x requests'.format(
@@ -54,6 +57,16 @@ def _execute(self, requests):
                 except (ValueError, RequestsJSONDecodeError):
                     error_data = {
                         'error': {'message': e.response.content, 'code': 'unknown'}}
+                if e.response.status_code == 429:
+                    retry_after = None
+                    try:
+                        retry_after = int(
+                            e.response.headers.get('Retry-After'))
+                    except Exception as ex:
+                        logger.error(
+                            'Error parsing Retry-After header: %s', ex)
+                    raise Office365QuotaExceededError(
+                        data=error_data, retry_after=retry_after) from e
                 raise Office365ClientError(e.response.status_code, error_data)
             else:
                 raise Office365ServerError(
@@ -76,6 +89,16 @@ def execute(self):
             try:
                 if response['status'] >= 300:
                     error_data = response.get('body')
+                    if response['status'] == 429:
+                        retry_after = None
+                        try:
+                            retry_after = int(
+                                response['headers'].get('Retry-After'))
+                        except Exception as ex:
+                            logger.warning(
+                                'Error parsing Retry-After header: %s', ex)
+                        raise Office365QuotaExceededError(
+                            data=error_data, retry_after=retry_after)
                     raise Office365ClientError(response['status'], error_data)
             except Office365ClientError as e:
                 exception = e

setup.py

@@ -2,8 +2,8 @@
 from setuptools import find_packages, setup
 
 setup(name='office365-rest-client',
-      version='3.5.1',
-      description='Python api wrapper for Office365 API v3.5.1',
+      version='3.5.2',
+      description='Python api wrapper for Office365 API v3.5.2',
       author='SugarCRM',
       packages=find_packages(),
       zip_safe=False)