Add cursor parameter to Audit Logs API method (#1147)

Author: seratch

integration_tests/audit_logs/test_pagination.py

@@ -0,0 +1,29 @@
+import logging
+import os
+import unittest
+
+from integration_tests.env_variable_names import (
+    SLACK_SDK_TEST_GRID_ORG_ADMIN_USER_TOKEN,
+)
+from slack_sdk.audit_logs import AuditLogsClient
+
+
+class TestAuditLogsClient(unittest.TestCase):
+    def setUp(self):
+        self.client = AuditLogsClient(
+            token=os.environ[SLACK_SDK_TEST_GRID_ORG_ADMIN_USER_TOKEN]
+        )
+
+    def tearDown(self):
+        pass
+
+    def test_pagination(self):
+        call_count = 0
+        response = None
+        ids = []
+        while call_count < 10 and (response is None or response.status_code != 429):
+            cursor = response.body["response_metadata"]["next_cursor"] if response is not None else None
+            response = self.client.logs(action="user_login", limit=1, cursor=cursor)
+            ids += map(lambda v: v["id"], response.body.get("entries", []))
+            call_count += 1
+        self.assertGreaterEqual(len(set(ids)), 10)

slack_sdk/audit_logs/v1/async_client.py

@@ -151,6 +151,7 @@ async def logs(
         action: Optional[str] = None,
         actor: Optional[str] = None,
         entity: Optional[str] = None,
+        cursor: Optional[str] = None,
         additional_query_params: Optional[Dict[str, Any]] = None,
         headers: Optional[Dict[str, str]] = None,
     ) -> AuditLogsResponse:
@@ -171,6 +172,7 @@ async def logs(
             action: Name of the action.
             actor: User ID who initiated the action.
             entity: ID of the target entity of the action (such as a channel, workspace, organization, file).
+            cursor: The next page cursor of pagination
             additional_query_params: Add anything else if you need to use the ones this library does not support
             headers: Additional request headers
 
@@ -184,6 +186,7 @@ async def logs(
             "action": action,
             "actor": actor,
             "entity": entity,
+            "cursor": cursor,
         }
         if additional_query_params is not None:
             query_params.update(additional_query_params)

slack_sdk/audit_logs/v1/client.py

@@ -140,6 +140,7 @@ def logs(
         action: Optional[str] = None,
         actor: Optional[str] = None,
         entity: Optional[str] = None,
+        cursor: Optional[str] = None,
         additional_query_params: Optional[Dict[str, Any]] = None,
         headers: Optional[Dict[str, str]] = None,
     ) -> AuditLogsResponse:
@@ -160,6 +161,7 @@ def logs(
             action: Name of the action.
             actor: User ID who initiated the action.
             entity: ID of the target entity of the action (such as a channel, workspace, organization, file).
+            cursor: The next page cursor of pagination
             additional_query_params: Add anything else if you need to use the ones this library does not support
             headers: Additional request headers
 
@@ -173,6 +175,7 @@ def logs(
             "action": action,
             "actor": actor,
             "entity": entity,
+            "cursor": cursor,
         }
         if additional_query_params is not None:
             query_params.update(additional_query_params)

slack_sdk/audit_logs/v1/response.py

@@ -4,6 +4,7 @@
 from slack_sdk.audit_logs.v1.logs import LogsResponse
 
 
+# TODO: Unlike WebClient's responses, this class has not yet provided __iter__ method
 class AuditLogsResponse:
     url: str
     status_code: int

tests/slack_sdk/audit_logs/mock_web_api_server.py

@@ -49,7 +49,7 @@ def do_GET(self):
                 return
             if "ratelimited" in pattern:
                 self.send_response(429)
-                self.send_header("Retry-After", 1)
+                self.send_header("retry-after", 1)
                 self.set_common_headers()
                 self.wfile.write(
                     """{"ok": false, "error": "ratelimited"}""".encode("utf-8")

tests/slack_sdk/audit_logs/test_client.py

@@ -23,6 +23,15 @@ def test_logs(self):
 
         self.assertEqual(resp.typed_body.entries[0].id, "xxx-yyy-zzz-111")
 
+    def test_logs_pagination(self):
+        resp: AuditLogsResponse = self.client.logs(
+            limit=1, action="user_login", cursor="xxxxxxx"
+        )
+        self.assertEqual(200, resp.status_code)
+        self.assertIsNotNone(resp.body.get("entries"))
+
+        self.assertEqual(resp.typed_body.entries[0].id, "xxx-yyy-zzz-111")
+
     def test_actions(self):
         resp: AuditLogsResponse = self.client.actions()
         self.assertEqual(200, resp.status_code)

tests/slack_sdk_async/audit_logs/test_async_client.py

@@ -27,6 +27,16 @@ async def test_logs(self):
 
         self.assertEqual(resp.typed_body.entries[0].id, "xxx-yyy-zzz-111")
 
+    @async_test
+    async def test_logs_pagination(self):
+        resp: AuditLogsResponse = await self.client.logs(
+            limit=1, action="user_login", cursor="XXXXXXXXXXX"
+        )
+        self.assertEqual(200, resp.status_code)
+        self.assertIsNotNone(resp.body.get("entries"))
+
+        self.assertEqual(resp.typed_body.entries[0].id, "xxx-yyy-zzz-111")
+
     @async_test
     async def test_actions(self):
         resp: AuditLogsResponse = await self.client.actions()