Merge pull request #227 from reportportal/develop

Release

Author: HardNorth

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
 ## [Unreleased]
+### Added
+- Issue [#225](https://github.com/reportportal/client-Python/issues/225): JSON decoding error logging, by @HardNorth
+### Fixed
+- Issue [#226](https://github.com/reportportal/client-Python/issues/226): Logging batch flush on client close, by @HardNorth
+
+## [5.5.3]
 ### Fixed
 - Python 3.7 support, by @HardNorth
 - Launch UUID attribute for AIO clients, by @HardNorth

reportportal_client/_internal/aio/tasks.py

@@ -23,7 +23,6 @@
 
 _T = TypeVar('_T')
 
-
 DEFAULT_TASK_TRIGGER_NUM: int = 10
 DEFAULT_TASK_TRIGGER_INTERVAL: float = 1.0
 

reportportal_client/_internal/services/client_id.py

@@ -22,7 +22,6 @@
 from .constants import CLIENT_ID_PROPERTY, RP_FOLDER_PATH, \
     RP_PROPERTIES_FILE_PATH
 
-
 logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 

reportportal_client/_internal/services/client_id.pyi

@@ -13,11 +13,11 @@
 
 from typing import Optional, Text
 
-def _read_client_id() -> Optional[Text]:
-    pass
 
-def _store_client_id(client_id: Text) -> None:
-    pass
+def _read_client_id() -> Optional[Text]: ...
 
-def get_client_id() -> Text:
-    pass
+
+def _store_client_id(client_id: Text) -> None: ...
+
+
+def get_client_id() -> Text: ...

reportportal_client/_internal/services/statistics.py

@@ -22,9 +22,9 @@
 import certifi
 import requests
 
-from reportportal_client.helpers import get_package_parameters
 from reportportal_client._internal.services.client_id import get_client_id
 from reportportal_client._internal.services.constants import CLIENT_INFO, ENDPOINT
+from reportportal_client.helpers import get_package_parameters
 
 logger = logging.getLogger(__name__)
 

reportportal_client/_internal/static/defines.py

@@ -14,8 +14,8 @@
 """This module provides RP client static objects and variables."""
 
 import aenum as enum
-from reportportal_client.helpers import ATTRIBUTE_LENGTH_LIMIT as ATTRIBUTE_LIMIT
 
+from reportportal_client.helpers import ATTRIBUTE_LENGTH_LIMIT as ATTRIBUTE_LIMIT
 
 RP_LOG_LEVELS = {
     60000: 'UNKNOWN',

reportportal_client/aio/client.py

@@ -924,6 +924,7 @@ def clone(self) -> 'AsyncRPClient':
 
     async def close(self) -> None:
         """Close current client connections."""
+        await self.__client.log_batch(self._log_batcher.flush())
         await self.__client.close()
 
 
@@ -1307,6 +1308,7 @@ def log(self, time: str, message: str, level: Optional[Union[int, str]] = None,
 
     def close(self) -> None:
         """Close current client connections."""
+        self.finish_tasks()
         if self.own_client:
             self.create_task(self.__client.close()).blocking_result()
 

reportportal_client/client.py

@@ -886,6 +886,7 @@ def clone(self) -> 'RPClient':
 
     def close(self) -> None:
         """Close current client connections."""
+        self._log(self._log_batcher.flush())
         self.session.close()
 
     def __getstate__(self) -> Dict[str, Any]:

reportportal_client/core/rp_responses.py

@@ -20,7 +20,7 @@
 
 import logging
 from json import JSONDecodeError
-from typing import Any, Optional, Generator, Mapping, Tuple
+from typing import Any, Optional, Generator, Mapping, Tuple, Union
 
 from aiohttp import ClientResponse
 from requests import Response
@@ -41,6 +41,12 @@ def _iter_json_messages(json: Any) -> Generator[str, None, None]:
             yield message
 
 
+def _get_json_decode_error_message(response: Union[Response, ClientResponse]) -> str:
+    status = getattr(response, 'status', getattr(response, 'status_code'))
+    return f'Unable to decode JSON response, got {"passed" if response.ok else "failed"} ' \
+           f'response with code "{status}" please check your endpoint configuration or API key'
+
+
 class RPResponse:
     """Class representing ReportPortal API response."""
 
@@ -82,7 +88,8 @@ def json(self) -> Any:
         if self.__json is NOT_SET:
             try:
                 self.__json = self._resp.json()
-            except (JSONDecodeError, TypeError):
+            except (JSONDecodeError, TypeError) as exc:
+                logger.error(_get_json_decode_error_message(self._resp), exc_info=exc)
                 self.__json = None
         return self.__json
 
@@ -149,7 +156,8 @@ async def json(self) -> Any:
         if self.__json is NOT_SET:
             try:
                 self.__json = await self._resp.json()
-            except (JSONDecodeError, TypeError):
+            except (JSONDecodeError, TypeError) as exc:
+                logger.error(_get_json_decode_error_message(self._resp), exc_info=exc)
                 self.__json = None
         return self.__json
 

setup.py

@@ -4,7 +4,7 @@
 
 from setuptools import setup, find_packages
 
-__version__ = '5.5.3'
+__version__ = '5.5.4'
 
 TYPE_STUBS = ['*.pyi']