Merge pull request slackapi#727 from NoAnyLove/unclosed-client-session

Fix slackapi#645 Unclosed client session

slack/web/base_client.py

@@ -294,18 +294,23 @@ async def _request(self, *, http_verb, api_url, req_args):
             )
 
         response = None
-        async with session.request(http_verb, api_url, **req_args) as res:
-            data = {}
-            try:
-                data = await res.json()
-            except aiohttp.ContentTypeError:
-                self._logger.debug(
-                    f"No response data returned from the following API call: {api_url}."
-                )
-            response = {"data": data, "headers": res.headers, "status_code": res.status}
-
-        if not use_running_session:
-            await session.close()
+        try:
+            async with session.request(http_verb, api_url, **req_args) as res:
+                data = {}
+                try:
+                    data = await res.json()
+                except aiohttp.ContentTypeError:
+                    self._logger.debug(
+                        f"No response data returned from the following API call: {api_url}."
+                    )
+                response = {
+                    "data": data,
+                    "headers": res.headers,
+                    "status_code": res.status,
+                }
+        finally:
+            if not use_running_session:
+                await session.close()
         return response
 
     # =================================================================

tests/web/test_web_client.py

@@ -1,4 +1,5 @@
 import asyncio
+import gc
 import re
 import socket
 import unittest
@@ -223,3 +224,23 @@ async def test_timeout_issue_712_async(self):
         client = WebClient(base_url="http://localhost:8888", timeout=1, run_async=True)
         with self.assertRaises(asyncio.TimeoutError):
             await client.users_list(token="xoxb-timeout")
+
+    def test_unclosed_client_session_issue_645_in_async_mode(self):
+        def exception_handler(_, context):
+            nonlocal session_unclosed
+            if context["message"] == "Unclosed client session":
+                session_unclosed = True
+
+        async def issue_645():
+            client = WebClient(base_url="http://localhost:8888", timeout=1, run_async=True)
+            try:
+                await client.users_list(token="xoxb-timeout")
+            except asyncio.TimeoutError:
+                pass
+
+        session_unclosed = False
+        loop = asyncio.get_event_loop()
+        loop.set_exception_handler(exception_handler)
+        loop.run_until_complete(issue_645())
+        gc.collect()  # force Python to gc unclosed client session
+        self.assertFalse(session_unclosed, "Unclosed client session")