Add space and message_type to Subscribe Message + tests

Author: seba-aln

pubnub/endpoints/pubsub/publish.py

@@ -15,7 +15,7 @@ class Publish(Endpoint, TimeTokenOverrideMixin):
     def __init__(self, pubnub):
         super(Publish, self).__init__(pubnub)
         self._channel = None
-        self._space = None
+        self._space_id = None
         self._message = None
         self._message_type = None
         self._should_store = None
@@ -29,8 +29,8 @@ def channel(self, channel):
         self._channel = str(channel)
         return self
 
-    def space(self, space):
-        self._space = str(space)
+    def space_id(self, space_id):
+        self._space_id = str(space_id)
         return self
 
     def message(self, message):
@@ -104,8 +104,8 @@ def custom_params(self):
         if self._message_type is not None:
             params['type'] = str(self._message_type)
 
-        if self._space is not None:
-            params['space-id'] = str(self._space)
+        if self._space_id is not None:
+            params['space-id'] = str(self._space_id)
 
         return params
 

pubnub/models/consumer/pubsub.py

@@ -2,8 +2,8 @@
 
 
 class PNMessageResult(object):
-    def __init__(self, message, subscription, channel, timetoken, user_metadata=None, publisher=None):
-
+    def __init__(self, message, subscription, channel, timetoken, user_metadata=None, publisher=None, message_type=None,
+                 space_id=None):
         if subscription is not None:
             assert isinstance(subscription, str)
 
@@ -29,6 +29,8 @@ def __init__(self, message, subscription, channel, timetoken, user_metadata=None
         self.timetoken = timetoken
         self.user_metadata = user_metadata
         self.publisher = publisher
+        self.type = message_type
+        self.space_id = space_id
 
 
 class PNSignalMessageResult(PNMessageResult):

pubnub/models/server/subscribe.py

@@ -1,3 +1,6 @@
+from pubnub.models.consumer.message_type import PNMessageType
+
+
 class SubscribeEnvelope:
     def __init__(self, messages=None, metadata=None):
         assert isinstance(messages, (list, None))
@@ -30,6 +33,8 @@ def __init__(self):
         self.publish_metadata = None
         self.only_channel_subscription = False
         self.type = 0
+        self.message_type = None
+        self.space_id = None
 
     @classmethod
     def from_json(cls, json_input):
@@ -49,6 +54,16 @@ def from_json(cls, json_input):
         message.publish_metadata = PublishMetadata.from_json(json_input['p'])
         if 'e' in json_input:
             message.type = json_input['e']
+
+        if 'si' in json_input:
+            message.space_id = json_input['si']
+
+        if 'mt' in json_input:
+            if 'e' in json_input:
+                message.message_type = PNMessageType.from_response(json_input['mt'], json_input['e'])
+            else:
+                message.message_type = PNMessageType(json_input['mt'])
+
         return message
 
 

pubnub/workers.py

@@ -172,6 +172,8 @@ def _process_incoming_payload(self, message):
                     channel=channel,
                     subscription=subscription_match,
                     timetoken=publish_meta_data.publish_timetoken,
-                    publisher=publisher
+                    publisher=publisher,
+                    message_type=message.message_type,
+                    space_id=message.space_id
                 )
                 self._listener_manager.announce_message(pn_message_result)

tests/integrational/asyncio/test_subscribe.py

@@ -5,6 +5,7 @@
 
 from unittest.mock import patch
 from pubnub.models.consumer.pubsub import PNMessageResult
+from pubnub.models.consumer.message_type import PNMessageType
 from pubnub.pubnub_asyncio import PubNubAsyncio, AsyncioEnvelope, SubscribeListener
 from tests.helper import pnconf_sub_copy, pnconf_enc_sub_copy
 from tests.integrational.vcr_asyncio_sleeper import get_sleeper, VCR599Listener, VCR599ReconnectionManager
@@ -382,3 +383,119 @@ async def test_unsubscribe_all(event_loop, sleeper=asyncio.sleep):
     assert envelope.status.original_response['status'] == 200
 
     await pubnub.stop()
+
+
+@get_sleeper('tests/integrational/fixtures/asyncio/subscription/publish_space_id.yaml')
+@pn_vcr.use_cassette(
+    'tests/integrational/fixtures/asyncio/subscription/publish_space_id.yaml',
+    filter_query_parameters=['pnsdk', 'l_cg', 'l_pres'],
+    match_on=['method', 'scheme', 'host', 'port', 'string_list_in_path', 'string_list_in_query'],
+)
+@pytest.mark.asyncio
+async def test_subscribe_publish_space_id(event_loop, sleeper=asyncio.sleep):
+    pubnub_sub = PubNubAsyncio(pnconf_sub_copy(), custom_event_loop=event_loop)
+    pubnub_pub = PubNubAsyncio(pnconf_sub_copy(), custom_event_loop=event_loop)
+
+    patch_pubnub(pubnub_sub)
+    patch_pubnub(pubnub_pub)
+
+    pubnub_sub.config.uuid = 'test-subscribe-asyncio-uuid-sub'
+    pubnub_pub.config.uuid = 'test-subscribe-asyncio-uuid-pub'
+
+    callback = VCR599Listener(1)
+    channel = "test-subscribe-asyncio-ch"
+    message = "hey"
+    space_id = "HelloSpace"
+    pubnub_sub.add_listener(callback)
+    pubnub_sub.subscribe().channels(channel).execute()
+
+    await callback.wait_for_connect()
+
+    publish_future = asyncio.ensure_future(
+        pubnub_pub.publish().channel(channel).message(message).space_id(space_id).future()
+    )
+    subscribe_message_future = asyncio.ensure_future(callback.wait_for_message_on(channel))
+
+    await asyncio.wait([
+        publish_future,
+        subscribe_message_future
+    ])
+
+    publish_envelope = publish_future.result()
+    subscribe_envelope = subscribe_message_future.result()
+
+    assert isinstance(subscribe_envelope, PNMessageResult)
+    assert subscribe_envelope.channel == channel
+    assert subscribe_envelope.subscription is None
+    assert subscribe_envelope.message == message
+    assert subscribe_envelope.space_id == space_id
+    assert subscribe_envelope.timetoken > 0
+
+    assert isinstance(publish_envelope, AsyncioEnvelope)
+    assert publish_envelope.result.timetoken > 0
+    assert publish_envelope.status.original_response[0] == 1
+
+    pubnub_sub.unsubscribe().channels(channel).execute()
+    # await callback.wait_for_disconnect()
+
+    pubnub_pub.stop()
+    pubnub_sub.stop()
+
+
+@get_sleeper('tests/integrational/fixtures/asyncio/subscription/publish_message_type.yaml')
+@pn_vcr.use_cassette(
+    'tests/integrational/fixtures/asyncio/subscription/publish_message_type.yaml',
+    filter_query_parameters=['pnsdk', 'l_cg', 'l_pres'],
+    match_on=['method', 'scheme', 'host', 'port', 'string_list_in_path', 'string_list_in_query'],
+)
+@pytest.mark.asyncio
+async def test_subscribe_publish_message_type(event_loop, sleeper=asyncio.sleep):
+    pubnub_sub = PubNubAsyncio(pnconf_sub_copy(), custom_event_loop=event_loop)
+    pubnub_pub = PubNubAsyncio(pnconf_sub_copy(), custom_event_loop=event_loop)
+
+    patch_pubnub(pubnub_sub)
+    patch_pubnub(pubnub_pub)
+
+    pubnub_sub.config.uuid = 'test-subscribe-asyncio-uuid-sub'
+    pubnub_pub.config.uuid = 'test-subscribe-asyncio-uuid-pub'
+
+    callback = VCR599Listener(1)
+    channel = "test-subscribe-asyncio-ch"
+    message = "hey"
+    message_type = "MyOwnCustomMessageType"
+    pubnub_sub.add_listener(callback)
+    pubnub_sub.subscribe().channels(channel).execute()
+
+    await callback.wait_for_connect()
+
+    publish_future = asyncio.ensure_future(
+        pubnub_pub.publish().channel(channel).message(message).message_type(message_type).future()
+    )
+    subscribe_message_future = asyncio.ensure_future(callback.wait_for_message_on(channel))
+
+    await asyncio.wait([
+        publish_future,
+        subscribe_message_future
+    ])
+
+    publish_envelope = publish_future.result()
+    subscribe_envelope = subscribe_message_future.result()
+
+    assert isinstance(subscribe_envelope, PNMessageResult)
+    assert subscribe_envelope.channel == channel
+    assert subscribe_envelope.subscription is None
+    assert subscribe_envelope.message == message
+
+    assert isinstance(subscribe_envelope.type, PNMessageType)
+    assert str(subscribe_envelope.type) == message_type
+    assert subscribe_envelope.timetoken > 0
+
+    assert isinstance(publish_envelope, AsyncioEnvelope)
+    assert publish_envelope.result.timetoken > 0
+    assert publish_envelope.status.original_response[0] == 1
+
+    pubnub_sub.unsubscribe().channels(channel).execute()
+    # await callback.wait_for_disconnect()
+
+    pubnub_pub.stop()
+    pubnub_sub.stop()

tests/integrational/fixtures/asyncio/subscription/publish_message_type.yaml

@@ -0,0 +1,91 @@
+interactions:
+- request:
+    body: null
+    headers:
+      User-Agent:
+      - PubNub-Python-Asyncio/7.1.0
+    method: GET
+    uri: https://ps.pndsn.com/v2/subscribe/sub-c-33f55052-190b-11e6-bfbc-02ee2ddab7fe/test-subscribe-asyncio-ch/0?tt=0&uuid=test-subscribe-asyncio-uuid-sub
+  response:
+    body:
+      string: '{"t":{"t":"16745835146497675","r":43},"m":[]}'
+    headers:
+      Access-Control-Allow-Methods:
+      - GET
+      Access-Control-Allow-Origin:
+      - '*'
+      Cache-Control:
+      - no-cache
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '45'
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Date:
+      - Tue, 24 Jan 2023 18:09:50 GMT
+    status:
+      code: 200
+      message: OK
+    url: https://ps.pndsn.com/v2/subscribe/sub-c-33f55052-190b-11e6-bfbc-02ee2ddab7fe/test-subscribe-asyncio-ch/0?tt=0&pnsdk=PubNub-Python-Asyncio%2F7.1.0&uuid=test-subscribe-asyncio-uuid-sub
+- request:
+    body: null
+    headers:
+      User-Agent:
+      - PubNub-Python-Asyncio/7.1.0
+    method: GET
+    uri: https://ps.pndsn.com/publish/pub-c-739aa0fc-3ed5-472b-af26-aca1b333ec52/sub-c-33f55052-190b-11e6-bfbc-02ee2ddab7fe/0/test-subscribe-asyncio-ch/0/%22hey%22?seqn=1&type=MyOwnCustomMessageType&uuid=test-subscribe-asyncio-uuid-pub
+  response:
+    body:
+      string: '[1,"Sent","16745837903154482"]'
+    headers:
+      Access-Control-Allow-Methods:
+      - GET
+      Access-Control-Allow-Origin:
+      - '*'
+      Cache-Control:
+      - no-cache
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '30'
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Date:
+      - Tue, 24 Jan 2023 18:09:50 GMT
+    status:
+      code: 200
+      message: OK
+    url: https://ps.pndsn.com/publish/pub-c-739aa0fc-3ed5-472b-af26-aca1b333ec52/sub-c-33f55052-190b-11e6-bfbc-02ee2ddab7fe/0/test-subscribe-asyncio-ch/0/%22hey%22?type=MyOwnCustomMessageType&seqn=1&pnsdk=PubNub-Python-Asyncio%2F7.1.0&uuid=test-subscribe-asyncio-uuid-pub
+- request:
+    body: null
+    headers:
+      User-Agent:
+      - PubNub-Python-Asyncio/7.1.0
+    method: GET
+    uri: https://ps.pndsn.com/v2/subscribe/sub-c-33f55052-190b-11e6-bfbc-02ee2ddab7fe/test-subscribe-asyncio-ch/0?tr=43&tt=16745835146497675&uuid=test-subscribe-asyncio-uuid-sub
+  response:
+    body:
+      string: '{"t":{"t":"16745837903154482","r":43},"m":[{"a":"2","f":0,"i":"test-subscribe-asyncio-uuid-pub","s":1,"p":{"t":"16745837903154482","r":43},"k":"sub-c-33f55052-190b-11e6-bfbc-02ee2ddab7fe","c":"test-subscribe-asyncio-ch","d":"hey","mt":"MyOwnCustomMessageType"}]}'
+    headers:
+      Access-Control-Allow-Methods:
+      - GET
+      Access-Control-Allow-Origin:
+      - '*'
+      Cache-Control:
+      - no-cache
+      Connection:
+      - keep-alive
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - text/javascript; charset="UTF-8"
+      Date:
+      - Tue, 24 Jan 2023 18:09:50 GMT
+      Transfer-Encoding:
+      - chunked
+    status:
+      code: 200
+      message: OK
+    url: https://ps.pndsn.com/v2/subscribe/sub-c-33f55052-190b-11e6-bfbc-02ee2ddab7fe/test-subscribe-asyncio-ch/0?tt=16745835146497675&tr=43&pnsdk=PubNub-Python-Asyncio%2F7.1.0&uuid=test-subscribe-asyncio-uuid-sub
+version: 1