add unread_count and unread_count_batch prep (#153)

* add unread_count and unread_count_batch prep

* lint-fix

* add await

* await and str(uuid)

* lint-fix

* fix deprecation warnings

* upsert_user_partial -> update_user_partial

* require 0.21.1 of pytest-asyncio https://pytest-asyncio.readthedocs.io/en/latest/reference/changelog.html\#known-issues

* drop support for 3.7, add support for 3.11 and 3.12 (#154)

* enable tests for batch unread endpoint

* fix: add tests for unread threads

* fix: lint

Author: JimmyPettersson85

.github/workflows/ci.yml

@@ -17,15 +17,15 @@ jobs:
       fail-fast: false
       max-parallel: 1
       matrix:
-        python: ["3.7", "3.8", "3.9", "3.10"]
+        python: ["3.8", "3.9", "3.10", "3.11", "3.12"]
     steps:
       - name: Checkout
         uses: actions/checkout@v3
         with:
           fetch-depth: 0 # gives the commit message linter access to all previous commits
 
       - name: Commit lint
-        if: ${{ matrix.python == '3.7' && github.ref == 'refs/heads/master' }}
+        if: ${{ matrix.python == '3.8' && github.ref == 'refs/heads/master' }}
         uses: wagoid/commitlint-github-action@v4
 
       - uses: actions/setup-python@v3
@@ -36,7 +36,7 @@ jobs:
         run: pip install ".[test, ci]"
 
       - name: Lint with ${{ matrix.python }}
-        if: ${{ matrix.python == '3.7' }}
+        if: ${{ matrix.python == '3.8' }}
         run: make lint
 
       - name: Test with ${{ matrix.python }}

setup.py

@@ -8,7 +8,7 @@
     "pyjwt>=2.0.0,<3",
     "typing_extensions; python_version < '3.8'",
 ]
-tests_require = ["pytest", "pytest-asyncio"]
+tests_require = ["pytest", "pytest-asyncio <= 0.21.1"]
 ci_require = [
     "black",
     "flake8",
@@ -48,7 +48,7 @@
     install_requires=install_requires,
     extras_require={"test": tests_require, "ci": ci_require},
     include_package_data=True,
-    python_requires=">=3.7",
+    python_requires=">=3.8",
     classifiers=[
         "Intended Audience :: Developers",
         "Intended Audience :: System Administrators",
@@ -57,10 +57,11 @@
         "Development Status :: 5 - Production/Stable",
         "Natural Language :: English",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],
 )

stream_chat/async_chat/client.py

@@ -791,6 +791,12 @@ async def get_import(self, id: str) -> StreamResponse:
     async def list_imports(self, options: Dict = None) -> StreamResponse:
         return await self.get("imports", params=options)
 
+    async def unread_counts(self, user_id: str) -> StreamResponse:
+        return await self.get("unread", params={"user_id": user_id})
+
+    async def unread_counts_batch(self, user_ids: List[str]) -> StreamResponse:
+        return await self.post("unread_batch", data={"user_ids": user_ids})
+
     async def close(self) -> None:
         await self.session.close()
 

stream_chat/base/client.py

@@ -1318,6 +1318,24 @@ def list_imports(
         """
         pass
 
+    @abc.abstractmethod
+    def unread_counts(
+        self, user_id: str
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Get unread counts for a single user.
+        """
+        pass
+
+    @abc.abstractmethod
+    def unread_counts_batch(
+        self, user_ids: List[str]
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Get unread counts for multiple users at once.
+        """
+        pass
+
     #####################
     #  Private methods  #
     #####################

stream_chat/client.py

@@ -753,3 +753,9 @@ def get_import(self, id: str) -> StreamResponse:
 
     def list_imports(self, options: Dict = None) -> StreamResponse:
         return self.get("imports", params=options)
+
+    def unread_counts(self, user_id: str) -> StreamResponse:
+        return self.get("unread", params={"user_id": user_id})
+
+    def unread_counts_batch(self, user_ids: List[str]) -> StreamResponse:
+        return self.post("unread_batch", data={"user_ids": user_ids})

stream_chat/tests/async_chat/conftest.py

@@ -50,7 +50,7 @@ async def client():
 @pytest.fixture(scope="function")
 async def random_user(client: StreamChatAsync):
     user = {"id": str(uuid.uuid4())}
-    response = await client.update_user(user)
+    response = await client.upsert_user(user)
     assert "users" in response
     assert user["id"] in response["users"]
     yield user
@@ -60,7 +60,7 @@ async def random_user(client: StreamChatAsync):
 @pytest.fixture(scope="function")
 async def server_user(client: StreamChatAsync):
     user = {"id": str(uuid.uuid4())}
-    response = await client.update_user(user)
+    response = await client.upsert_user(user)
     assert "users" in response
     assert user["id"] in response["users"]
     yield user

stream_chat/tests/async_chat/test_channel.py

@@ -276,7 +276,7 @@ async def test_channel_hide_show(
 
     async def test_invites(self, client: StreamChatAsync, channel: Channel):
         members = ["john", "paul", "george", "pete", "ringo", "eric"]
-        await client.update_users([{"id": m} for m in members])
+        await client.upsert_users([{"id": m} for m in members])
         channel = client.channel(
             "team",
             "beatles-" + str(uuid.uuid4()),
@@ -305,7 +305,7 @@ async def test_invites(self, client: StreamChatAsync, channel: Channel):
 
     async def test_query_members(self, client: StreamChatAsync, channel: Channel):
         members = ["paul", "george", "john", "jessica", "john2"]
-        await client.update_users([{"id": m, "name": m} for m in members])
+        await client.upsert_users([{"id": m, "name": m} for m in members])
         for member in members:
             await channel.add_members([member])
 

stream_chat/tests/async_chat/test_client.py

@@ -136,7 +136,7 @@ async def test_get_app_settings(self, client: StreamChatAsync):
 
     async def test_update_user(self, client: StreamChatAsync):
         user = {"id": str(uuid.uuid4())}
-        response = await client.update_user(user)
+        response = await client.upsert_user(user)
         assert "users" in response
         assert user["id"] in response["users"]
 
@@ -148,7 +148,7 @@ async def test_update_users(self, client: StreamChatAsync):
 
     async def test_update_user_partial(self, client: StreamChatAsync):
         user_id = str(uuid.uuid4())
-        await client.update_user({"id": user_id, "field": "value"})
+        await client.upsert_user({"id": user_id, "field": "value"})
 
         response = await client.update_user_partial(
             {"id": user_id, "set": {"field": "updated"}}
@@ -785,7 +785,7 @@ async def test_imports_end2end(self, client: StreamChatAsync):
             headers={"Content-Type": "application/json"},
         ) as resp:
             assert resp.status == 200
-        sess.close()
+        await sess.close()
 
         create_resp = await client.create_import(url_resp["path"], "upsert")
         assert create_resp["import_task"]["id"]
@@ -795,3 +795,64 @@ async def test_imports_end2end(self, client: StreamChatAsync):
 
         list_resp = await client.list_imports({"limit": 1})
         assert len(list_resp["import_tasks"]) == 1
+
+    async def test_unread_counts(
+        self, client: StreamChatAsync, channel, random_user: Dict
+    ):
+        await channel.add_members([random_user["id"]])
+        msg_id = str(uuid.uuid4())
+        await channel.send_message(
+            {"id": msg_id, "text": "helloworld"}, str(uuid.uuid4())
+        )
+        response = await client.unread_counts(random_user["id"])
+        assert "total_unread_count" in response
+        assert "channels" in response
+        assert "channel_type" in response
+        assert response["total_unread_count"] == 1
+        assert len(response["channels"]) == 1
+        assert response["channels"][0]["channel_id"] == channel.cid
+        assert len(response["channel_type"]) == 1
+
+        # test threads unread counts
+        await channel.send_message(
+            {"parent_id": msg_id, "text": "helloworld"}, random_user["id"]
+        )
+        await channel.send_message(
+            {"parent_id": msg_id, "text": "helloworld"}, str(uuid.uuid4())
+        )
+        response = await client.unread_counts(random_user["id"])
+        assert "total_unread_threads_count" in response
+        assert "threads" in response
+        assert response["total_unread_threads_count"] == 1
+        assert len(response["threads"]) == 1
+        assert response["threads"][0]["parent_message_id"] == msg_id
+
+    async def test_unread_counts_batch(
+        self, client: StreamChatAsync, channel, random_users: Dict
+    ):
+        await channel.add_members([x["id"] for x in random_users])
+        msg_id = str(uuid.uuid4())
+        await channel.send_message(
+            {"id": msg_id, "text": "helloworld"}, str(uuid.uuid4())
+        )
+        response = await client.unread_counts_batch([x["id"] for x in random_users])
+        assert "counts_by_user" in response
+        for user_id in [x["id"] for x in random_users]:
+            assert user_id in response["counts_by_user"]
+            assert response["counts_by_user"][user_id]["total_unread_count"] == 1
+
+            # send this message to add user to the thread
+            await channel.send_message(
+                {"parent_id": msg_id, "text": "helloworld"}, user_id
+            )
+
+        # test threads unread counts
+        await channel.send_message(
+            {"parent_id": msg_id, "text": "helloworld"}, str(uuid.uuid4())
+        )
+        response = await client.unread_counts_batch([x["id"] for x in random_users])
+        for user_id in [x["id"] for x in random_users]:
+            assert user_id in response["counts_by_user"]
+            assert (
+                response["counts_by_user"][user_id]["total_unread_threads_count"] == 1
+            )

stream_chat/tests/conftest.py

@@ -40,7 +40,7 @@ def client():
 @pytest.fixture(scope="function")
 def random_user(client: StreamChat):
     user = {"id": str(uuid.uuid4())}
-    response = client.update_user(user)
+    response = client.upsert_user(user)
     assert "users" in response
     assert user["id"] in response["users"]
     yield user
@@ -50,7 +50,7 @@ def random_user(client: StreamChat):
 @pytest.fixture(scope="function")
 def server_user(client: StreamChat):
     user = {"id": str(uuid.uuid4())}
-    response = client.update_user(user)
+    response = client.upsert_user(user)
     assert "users" in response
     assert user["id"] in response["users"]
     yield user
@@ -62,7 +62,7 @@ def random_users(client: StreamChat):
     user1 = {"id": str(uuid.uuid4())}
     user2 = {"id": str(uuid.uuid4())}
     user3 = {"id": str(uuid.uuid4())}
-    client.update_users([user1, user2, user3])
+    client.upsert_users([user1, user2, user3])
     yield [user1, user2, user3]
     hard_delete_users(client, [user1["id"], user2["id"], user3["id"]])
 
@@ -111,7 +111,7 @@ def fellowship_of_the_ring(client: StreamChat):
         },
         {"id": "peregrin-took", "name": "Peregrin Took", "race": "Hobbit", "age": 28},
     ]
-    client.update_users(members)
+    client.upsert_users(members)
     channel = client.channel(
         "team", "fellowship-of-the-ring", {"members": [m["id"] for m in members]}
     )

stream_chat/tests/test_channel.py

@@ -276,7 +276,7 @@ def test_channel_hide_show(
 
     def test_invites(self, client: StreamChat, channel: Channel):
         members = ["john", "paul", "george", "pete", "ringo", "eric"]
-        client.update_users([{"id": m} for m in members])
+        client.upsert_users([{"id": m} for m in members])
         channel = client.channel(
             "team",
             "beatles-" + str(uuid.uuid4()),
@@ -305,7 +305,7 @@ def test_invites(self, client: StreamChat, channel: Channel):
 
     def test_query_members(self, client: StreamChat, channel: Channel):
         members = ["paul", "george", "john", "jessica", "john2"]
-        client.update_users([{"id": m, "name": m} for m in members])
+        client.upsert_users([{"id": m, "name": m} for m in members])
         for member in members:
             channel.add_members([member])