chore: update aiohttp ClientSession to exit gracefully. (#53)

* update service and test client session

Author: jackwotherspoon

iam_groups_authn/sync.py

@@ -54,8 +54,11 @@ async def groups_sync(iam_groups, sql_instances, credentials, private_ip=False):
     # set ip_type to proper type for connector
     ip_type = IPTypes.PRIVATE if private_ip else IPTypes.PUBLIC
 
+    # create aiohttp client session for async API calls
+    client_session = ClientSession(headers={"Content-Type": "application/json"})
+
     # create UserService object for API calls
-    user_service = UserService(credentials)
+    user_service = UserService(client_session, credentials)
 
     # keep track of IAM group and database instance tasks
     group_tasks = {}
@@ -178,20 +181,23 @@ async def groups_sync(iam_groups, sql_instances, credentials, private_ip=False):
                 "[%s][%s] Users granted role: %s." % (instance, group, granted_users)
             )
 
+    # close aiohttp client session for graceful exit
+    if not client_session.closed:
+        await client_session.close()
+
 
 class UserService:
     """Helper class for building googleapis service calls."""
 
-    def __init__(self, creds):
+    def __init__(self, client_session, creds):
         """Initialize UserService instance.
 
         Args:
+            client_session: aiohttp client session object for API calls.
             creds: OAuth2 credentials to call admin APIs.
         """
+        self.client_session = client_session
         self.creds = creds
-        self.client_session = ClientSession(
-            headers={"Content-Type": "application/json"}
-        )
 
     async def get_group_members(self, group):
         """Get all members of an IAM group.
@@ -316,17 +322,6 @@ async def get_database_version(self, instance_connection_name):
                 f"Error: Failed to get the database version for `{instance_connection_name}`. Verify instance connection name and instance details."
             ) from e
 
-    def __del__(self):
-        """Deconstructor for UserService to close ClientSession and have
-        graceful exit.
-        """
-
-        async def deconstruct():
-            if not self.client_session.closed:
-                await self.client_session.close()
-
-        asyncio.run_coroutine_threadsafe(deconstruct(), loop=asyncio.get_event_loop())
-
 
 class RequestType(Enum):
     """Helper class for supported aiohttp request types."""

tests/integration/test_mysql_sync.py

@@ -17,6 +17,7 @@
 from google.auth import default
 from google.auth.transport.requests import Request
 import sqlalchemy
+from aiohttp import ClientSession
 from helpers import delete_database_user, delete_iam_member, add_iam_member
 from iam_groups_authn.iam_admin import get_iam_users
 from iam_groups_authn.mysql import init_mysql_connection_engine, mysql_username
@@ -89,8 +90,11 @@ async def test_service_mysql(credentials):
         - Verifies test user no longer has group role
     """
 
+    # create aiohttp client session for async API calls
+    client_session = ClientSession(headers={"Content-Type": "application/json"})
+
     # check that test_user is not a database user
-    user_service = UserService(credentials)
+    user_service = UserService(client_session, credentials)
     db_users = await get_instance_users(user_service, sql_instance)
     assert mysql_username(test_user) not in db_users
 
@@ -130,6 +134,6 @@ async def test_service_mysql(credentials):
     users_with_role = check_role_mysql(pool, mysql_username(iam_groups[0]))
     assert mysql_username(test_user) not in users_with_role
 
-    # close user_service session
-    if not user_service.client_session.closed:
-        await user_service.client_session.close()
+    # close aiohttp client session for graceful exit
+    if not client_session.closed:
+        await client_session.close()

tests/integration/test_postgres_sync.py

@@ -17,6 +17,7 @@
 from google.auth import default
 from google.auth.transport.requests import Request
 import sqlalchemy
+from aiohttp import ClientSession
 from helpers import delete_database_user, delete_iam_member, add_iam_member
 from iam_groups_authn.iam_admin import get_iam_users
 from iam_groups_authn.mysql import mysql_username
@@ -89,8 +90,12 @@ async def test_service_postgres(credentials):
         - Run GroupSync
         - Verifies test user no longer has group role
     """
+
+    # create aiohttp client session for async API calls
+    client_session = ClientSession(headers={"Content-Type": "application/json"})
+
     # check that test_user is not a database user
-    user_service = UserService(credentials)
+    user_service = UserService(client_session, credentials)
     db_users = await get_instance_users(user_service, sql_instance)
     assert test_user not in db_users
 
@@ -130,6 +135,6 @@ async def test_service_postgres(credentials):
     users_with_role = check_role_postgres(pool, mysql_username(iam_groups[0]))
     assert test_user not in users_with_role
 
-    # close user_service session
-    if not user_service.client_session.closed:
-        await user_service.client_session.close()
+    # close aiohttp client session for graceful exit
+    if client_session.closed:
+        await client_session.close()