[CHAT-2191] Async delete_users, delete_channels & get_task (#79)

Co-authored-by: ferhat elmas <[email protected]>

Author: gumuz

stream_chat/async_chat/client.py

@@ -107,6 +107,11 @@ async def update_user_partial(self, update):
     async def delete_user(self, user_id, **options):
         return await self.delete(f"users/{user_id}", options)
 
+    async def delete_users(self, user_ids, delete_type, **options):
+        return await self.post(
+            "users/delete", data=dict(options, user=delete_type, user_ids=user_ids)
+        )
+
     async def deactivate_user(self, user_id, **options):
         return await self.post(f"users/{user_id}/deactivate", data=options)
 
@@ -236,6 +241,9 @@ def channel(self, channel_type, channel_id=None, data=None):
         """
         return Channel(self, channel_type, channel_id, data)
 
+    async def delete_channels(self, cids, **options):
+        return await self.post(f"channels/delete", data=dict(options, cids=cids))
+
     async def list_commands(self):
         return await self.get("commands")
 
@@ -650,3 +658,6 @@ async def __aexit__(
         exc_tb: Optional[TracebackType],
     ) -> None:
         await self.close()
+
+    async def get_task(self, task_id):
+        return await self.get(f"tasks/{task_id}")

stream_chat/base/client.py

@@ -96,6 +96,18 @@ def update_user_partial(self, update):
     def delete_user(self, user_id, **options):
         pass
 
+    @abc.abstractmethod
+    def delete_users(self, user_ids, delete_type, **options):
+        """
+        Delete users asynchronously
+
+        :param user_ids: a list of user IDs to delete
+        :param delete_type: type of user delete (hard|soft)
+        :param options: additional delete options
+        :return: task_id
+        """
+        pass
+
     @abc.abstractmethod
     def deactivate_user(self, user_id, **options):
         pass
@@ -222,6 +234,10 @@ def channel(self, channel_type, channel_id=None, data=None):
         """
         pass
 
+    @abc.abstractmethod
+    def delete_channels(self, cids, **options):
+        pass
+
     @abc.abstractmethod
     def list_commands(self):
         pass
@@ -570,3 +586,10 @@ def get_export_channel_status(self, task_id):
         Retrieves status of export
         """
         pass
+
+    @abc.abstractmethod
+    def get_task(self, task_id):
+        """
+        Retrieves status of task
+        """
+        pass

stream_chat/client.py

@@ -103,6 +103,11 @@ def update_user_partial(self, update):
     def delete_user(self, user_id, **options):
         return self.delete(f"users/{user_id}", options)
 
+    def delete_users(self, user_ids, delete_type, **options):
+        return self.post(
+            "users/delete", data=dict(options, user=delete_type, user_ids=user_ids)
+        )
+
     def deactivate_user(self, user_id, **options):
         return self.post(f"users/{user_id}/deactivate", data=options)
 
@@ -232,6 +237,9 @@ def channel(self, channel_type, channel_id=None, data=None):
         """
         return Channel(self, channel_type, channel_id, data)
 
+    def delete_channels(self, cids, **options):
+        return self.post(f"channels/delete", data=dict(options, cids=cids))
+
     def list_commands(self):
         return self.get("commands")
 
@@ -629,3 +637,6 @@ def get_export_channel_status(self, task_id):
         :type task_id: str
         """
         return self.get(f"export_channels/{task_id}")
+
+    def get_task(self, task_id):
+        return self.get(f"tasks/{task_id}")

stream_chat/tests/async_chat/test_channel.py

@@ -324,5 +324,6 @@ async def test_export_channel(self, client, channel, random_users):
             if resp["status"] == "completed":
                 assert len(resp["result"]) != 0
                 assert resp["result"]["url"] != ""
+                assert "error" not in resp
                 break
             time.sleep(0.5)

stream_chat/tests/async_chat/test_client.py

@@ -150,6 +150,24 @@ async def test_delete_user(self, event_loop, client, random_user):
         assert "user" in response
         assert random_user["id"] == response["user"]["id"]
 
+    @pytest.mark.asyncio
+    async def test_delete_users(self, event_loop, client, random_user):
+        response = await client.delete_users(
+            [random_user["id"]], "hard", conversations="hard", messages="hard"
+        )
+        assert "task_id" in response
+
+        for _ in range(10):
+            response = await client.get_task(response["task_id"])
+            if response["status"] == "completed" and response["result"][
+                random_user["id"]
+            ] == {"status": "ok"}:
+                return
+
+            time.sleep(1)
+
+        assert False, "task did not succeed"
+
     @pytest.mark.asyncio
     async def test_deactivate_user(self, event_loop, client, random_user):
         response = await client.deactivate_user(random_user["id"])
@@ -504,3 +522,19 @@ def wait():
         wait()
         response = await client.list_roles()
         assert role not in response["roles"]
+
+    @pytest.mark.asyncio
+    async def test_delete_channels(self, event_loop, client, channel):
+        response = await client.delete_channels([channel.cid])
+        assert "task_id" in response
+
+        for _ in range(10):
+            response = await client.get_task(response["task_id"])
+            if response["status"] == "completed" and response["result"][
+                channel.cid
+            ] == {"status": "ok"}:
+                return
+
+            time.sleep(1)
+
+        assert False, "task did not succeed"

stream_chat/tests/test_channel.py

@@ -295,5 +295,6 @@ def test_export_channel(self, client, channel, random_users):
             if resp["status"] == "completed":
                 assert len(resp["result"]) != 0
                 assert resp["result"]["url"] != ""
+                assert "error" not in resp
                 break
             time.sleep(0.5)

stream_chat/tests/test_client.py

@@ -129,6 +129,23 @@ def test_delete_user(self, client, random_user):
         assert "user" in response
         assert random_user["id"] == response["user"]["id"]
 
+    def test_delete_users(self, client, random_user):
+        response = client.delete_users(
+            [random_user["id"]], "hard", conversations="hard", messages="hard"
+        )
+        assert "task_id" in response
+
+        for _ in range(10):
+            response = client.get_task(response["task_id"])
+            if response["status"] == "completed" and response["result"][
+                random_user["id"]
+            ] == {"status": "ok"}:
+                return
+
+            time.sleep(1)
+
+        assert False, "task did not succeed"
+
     def test_deactivate_user(self, client, random_user):
         response = client.deactivate_user(random_user["id"])
         assert "user" in response
@@ -430,3 +447,18 @@ def wait():
         wait()
         response = client.list_roles()
         assert role not in response["roles"]
+
+    def test_delete_channels(self, client, channel):
+        response = client.delete_channels([channel.cid])
+        assert "task_id" in response
+
+        for _ in range(10):
+            response = client.get_task(response["task_id"])
+            if response["status"] == "completed" and response["result"][
+                channel.cid
+            ] == {"status": "ok"}:
+                return
+
+            time.sleep(1)
+
+        assert False, "task did not succeed"