Fix silent serialization failure when publishing non-JSON-serializable objects

Author: jguz-pubnub

pubnub/enums.py

@@ -39,6 +39,7 @@ class PNStatusCategory(Enum):
     PNInternalExceptionCategory = 17
     PNSubscriptionChangedCategory = 18
     PNConnectionErrorCategory = 19
+    PNSerializationErrorCategory = 20
 
 
 class PNOperationType(object):

pubnub/pubnub_asyncio.py

@@ -77,6 +77,7 @@ async def main():
 from pubnub.callbacks import SubscribeCallback, ReconnectionCallback
 from pubnub.errors import PNERR_REQUEST_CANCELLED, PNERR_CLIENT_TIMEOUT
 from pubnub.exceptions import PubNubAsyncioException, PubNubException
+from pubnub.models.consumer.pn_error_data import PNErrorData
 
 # flake8: noqa
 from pubnub.models.envelopes import AsyncioEnvelope
@@ -234,9 +235,16 @@ async def request_future(self, options_func, cancellation_event):
             res = await self._request_handler.async_request(options_func, cancellation_event)
             return res
         except PubNubException as e:
+            if e.status is not None:
+                status = e.status
+            else:
+                status = PNStatus()
+                status.category = PNStatusCategory.PNBadRequestCategory
+                status.error = True
+                status.error_data = PNErrorData(str(e), e)
             return PubNubAsyncioException(
                 result=None,
-                status=e.status
+                status=status
             )
         except asyncio.TimeoutError:
             return PubNubAsyncioException(

pubnub/utils.py

@@ -14,6 +14,7 @@
 from pubnub.models.consumer.common import PNStatus
 from pubnub.errors import PNERR_JSON_NOT_SERIALIZABLE
 from pubnub.exceptions import PubNubException
+from pubnub.models.consumer.pn_error_data import PNErrorData
 
 
 def get_data_for_user(data):
@@ -29,10 +30,17 @@ def get_data_for_user(data):
 def write_value_as_string(data):
     try:
         return json.dumps(data)
-    except TypeError:
-        raise PubNubException(
+    except TypeError as e:
+        exc = PubNubException(
+            errormsg=str(e),
             pn_error=PNERR_JSON_NOT_SERIALIZABLE
         )
+        status = PNStatus()
+        status.category = PNStatusCategory.PNSerializationErrorCategory
+        status.error = True
+        status.error_data = PNErrorData(str(exc), exc)
+        exc.status = status
+        raise exc
 
 
 def url_encode(data):

tests/integrational/asyncio/test_publish_serialization.py

@@ -0,0 +1,33 @@
+from datetime import datetime
+
+import pytest
+
+from pubnub.enums import PNStatusCategory
+from pubnub.exceptions import PubNubAsyncioException
+from pubnub.models.consumer.common import PNStatus
+from pubnub.models.consumer.pn_error_data import PNErrorData
+from pubnub.pubnub_asyncio import PubNubAsyncio
+from tests.helper import pnconf_copy
+
+
+@pytest.mark.asyncio
+async def test_publish_non_serializable_returns_usable_error():
+    pubnub = PubNubAsyncio(pnconf_copy())
+
+    result = await pubnub.publish().channel("ch1").message({
+        "text": "Hello",
+        "timestamp": datetime.now(),
+    }).future()
+
+    assert isinstance(result, PubNubAsyncioException)
+    assert result.is_error() is True
+    assert isinstance(result.status, PNStatus)
+    assert result.status.error is True
+    assert result.status.category == PNStatusCategory.PNSerializationErrorCategory
+    assert isinstance(result.status.error_data, PNErrorData)
+    assert str(result) == (
+        "Trying to publish not JSON serializable object: "
+        "Object of type datetime is not JSON serializable"
+    )
+
+    await pubnub.stop()