[CHAT-1319] Added ability to provide sort options as list to guarantee field order (#42)

Co-authored-by: Guyon Morée <[email protected]>

Author: AnatolyRugalev

stream_chat/channel.py

@@ -107,7 +107,7 @@ def query_members(self, filter_conditions, sort=None, **options):
 
         eg.
         channel.query_members(filter_conditions={"name": "tommaso"},
-                              sort=[{"field": "created_at", "direction": -1}],
+                              sort=[{"created_at": -1}, {"updated_at": 1}],
                               offset=0,
                               limit=10)
         """
@@ -116,7 +116,7 @@ def query_members(self, filter_conditions, sort=None, **options):
             "id": self.id,
             "type": self.channel_type,
             "filter_conditions": filter_conditions,
-            "sort": sort or [],
+            "sort": self.client.normalize_sort(sort),
             **options,
         }
         response = self.client.get("members", params={"payload": json.dumps(payload)})

stream_chat/client.py

@@ -1,3 +1,4 @@
+import collections
 from urllib.parse import urlparse
 import hmac
 import hashlib
@@ -75,6 +76,19 @@ def _make_request(self, method, relative_url, params=None, data=None):
         )
         return self._parse_response(response)
 
+    def normalize_sort(self, sort=None):
+        sort_fields = []
+        if isinstance(sort, collections.abc.Mapping):
+            sort = [sort]
+        if isinstance(sort, list):
+            for item in sort:
+                if "field" in item and "direction" in item:
+                    sort_fields.append(item)
+                else:
+                    for k, v in item.items():
+                        sort_fields.append({"field": k, "direction": v})
+        return sort_fields
+
     def put(self, relative_url, params=None, data=None):
         return self._make_request(self.session.put, relative_url, params, data)
 
@@ -189,20 +203,18 @@ def get_message(self, message_id):
         return self.get("messages/{}".format(message_id))
 
     def query_users(self, filter_conditions, sort=None, **options):
-        sort_fields = []
-        if sort is not None:
-            sort_fields = [{"field": k, "direction": v} for k, v in sort.items()]
         params = options.copy()
-        params.update({"filter_conditions": filter_conditions, "sort": sort_fields})
+        params.update(
+            {"filter_conditions": filter_conditions, "sort": self.normalize_sort(sort)}
+        )
         return self.get("users", params={"payload": json.dumps(params)})
 
     def query_channels(self, filter_conditions, sort=None, **options):
         params = {"state": True, "watch": False, "presence": False}
-        sort_fields = []
-        if sort is not None:
-            sort_fields = [{"field": k, "direction": v} for k, v in sort.items()]
         params.update(options)
-        params.update({"filter_conditions": filter_conditions, "sort": sort_fields})
+        params.update(
+            {"filter_conditions": filter_conditions, "sort": self.normalize_sort(sort)}
+        )
         return self.get("channels", params={"payload": json.dumps(params)})
 
     def create_channel_type(self, data):

stream_chat/tests/conftest.py

@@ -76,7 +76,9 @@ def command(client):
         dict(name=str(uuid.uuid4()), description="My command")
     )
 
-    return response["command"]
+    yield response["command"]
+
+    client.delete_command(response["command"]["name"])
 
 
 @pytest.fixture(scope="module")

stream_chat/tests/test_client.py

@@ -1,12 +1,36 @@
+from operator import itemgetter
+
 import jwt
 import pytest
+import sys
 import uuid
 from stream_chat import StreamChat
 from stream_chat.exceptions import StreamAPIException
 
 
 @pytest.mark.incremental
 class TestClient(object):
+    def test_normalize_sort(self, client):
+        expected = [
+            {"field": "field1", "direction": 1},
+            {"field": "field2", "direction": -1},
+        ]
+        actual = client.normalize_sort([{"field1": 1}, {"field2": -1}])
+        assert actual == expected
+        actual = client.normalize_sort(
+            [{"field": "field1", "direction": 1}, {"field": "field2", "direction": -1}]
+        )
+        assert actual == expected
+        actual = client.normalize_sort({"field1": 1})
+        assert actual == [{"field": "field1", "direction": 1}]
+        # The following example is not recommended because the order of the fields is not guaranteed in Python < 3.7
+        actual = client.normalize_sort({"field1": 1, "field2": -1})
+        if sys.version_info >= (3, 7):
+            assert actual == expected
+        else:
+            # Compare elements regardless of the order
+            assert sorted(actual, key=itemgetter("field")) == expected
+
     def test_mute_user(self, client, random_users):
         response = client.mute_user(random_users[0]["id"], random_users[1]["id"])
         assert "mute" in response
@@ -61,11 +85,6 @@ def test_update_command(self, client, command):
         assert "command" in response
         assert "My new command" == response["command"]["description"]
 
-    def test_delete_command(self, client, command):
-        response = client.delete_command(command["name"])
-        with pytest.raises(StreamAPIException):
-            client.get_command(command["name"])
-
     def test_list_commands(self, client):
         response = client.list_commands()
         assert "commands" in response