Return KeyRefreshResponse from primary/secondary instead of tuples

Author: JBorrow

soauth/api/login.py

@@ -194,12 +194,7 @@ async def code(
 
     # Create the codes!
     app = await app_service.read_by_id(app_id=login_request.app_id, conn=conn)
-    (
-        auth_key,
-        refresh_key,
-        auth_key_expires,
-        refresh_key_expires,
-    ) = await flow_service.primary(
+    key_content = await flow_service.primary(
         user=user, app=app, settings=settings, conn=conn, log=log
     )
 
@@ -218,10 +213,10 @@ async def code(
     )
 
     return KeyRefreshResponse(
-        access_token=auth_key,
-        refresh_token=refresh_key,
-        access_token_expires=auth_key_expires,
-        refresh_token_expires=refresh_key_expires,
+        access_token=key_content.access_token,
+        refresh_token=key_content.refresh_token,
+        access_token_expires=key_content.access_token_expires,
+        refresh_token_expires=key_content.refresh_token_expires,
         redirect=redirect,
     )
 
@@ -250,12 +245,7 @@ async def exchange(
     refresh_token = content.refresh_token
 
     try:
-        (
-            auth_key,
-            refresh_key,
-            auth_key_expires,
-            refresh_key_expires,
-        ) = await flow_service.secondary(
+        key_content = await flow_service.secondary(
             encoded_refresh_key=refresh_token, settings=settings, conn=conn, log=log
         )
     except refresh_service.AuthorizationError as e:
@@ -271,12 +261,7 @@ async def exchange(
             status_code=status.HTTP_401_UNAUTHORIZED, detail="Refresh token expired"
         )
 
-    return KeyRefreshResponse(
-        access_token=auth_key,
-        refresh_token=refresh_key,
-        access_token_expires=auth_key_expires,
-        refresh_token_expires=refresh_key_expires,
-    )
+    return key_content
 
 
 @login_app.post(

soauth/service/flow.py

@@ -4,12 +4,12 @@
 a new access token.
 """
 
-from datetime import datetime
 
 from sqlalchemy.ext.asyncio import AsyncSession
 from structlog.typing import FilteringBoundLogger
 
 from soauth.config.settings import Settings
+from soauth.core.models import KeyRefreshResponse
 from soauth.core.uuid import UUID
 from soauth.database.app import App
 from soauth.database.user import User
@@ -31,7 +31,7 @@ async def primary(
     settings: Settings,
     conn: AsyncSession,
     log: FilteringBoundLogger,
-) -> tuple[str, str, datetime, datetime]:
+) -> KeyRefreshResponse:
     """
     Primary authentication flow - assumes that you just created the 'user'
     and that the 'user' has _all required credentials, grants and groups_.
@@ -82,11 +82,11 @@ async def primary(
     )
     await log.ainfo("primary.auth_key_created")
 
-    return (
-        encoded_auth_key,
-        encoded_refresh_key,
-        auth_key_expires,
-        refresh_key.expires_at,
+    return KeyRefreshResponse(
+        access_token=encoded_auth_key,
+        refresh_token=encoded_refresh_key,
+        access_token_expires=auth_key_expires,
+        refresh_token_expires=refresh_key.expires_at,
     )
 
 
@@ -95,7 +95,7 @@ async def secondary(
     settings: Settings,
     conn: AsyncSession,
     log: FilteringBoundLogger,
-) -> tuple[str, str, datetime, datetime]:
+) -> KeyRefreshResponse:
     """
     Secondary authentication flow - turn in your encoded refresh key
     for a new one and an authentication key. This checks against
@@ -156,11 +156,11 @@ async def secondary(
 
     await log.ainfo("secondary.auth_key_created")
 
-    return (
-        encoded_auth_key,
-        encoded_refresh_key,
-        auth_key_expires,
-        refresh_key.expires_at,
+    return KeyRefreshResponse(
+        access_token=encoded_auth_key,
+        refresh_token=encoded_refresh_key,
+        access_token_expires=auth_key_expires,
+        refresh_token_expires=refresh_key.expires_at,
     )
 
 

tests/test_service/test_flow.py

@@ -18,14 +18,19 @@ async def test_primary_then_secondary(
         async with conn.begin():
             application = await app_service.read_by_id(app_id=app, conn=conn)
             user_obj = await user_service.read_by_id(user_id=user, conn=conn)
-            auth, refresh, ake, rke = await flow_service.primary(
+            key_content = await flow_service.primary(
                 user=user_obj,
                 app=application,
                 settings=server_settings,
                 conn=conn,
                 log=logger,
             )
 
+            auth = key_content.access_token
+            refresh = key_content.refresh_token
+            ake = key_content.access_token_expires
+            rke = key_content.refresh_token_expires
+
             APP_PUBLIC_KEY = application.public_key
             APP_KEY_PAIR_TYPE = application.key_pair_type
             USER_ID = user_obj.user_id
@@ -40,13 +45,18 @@ async def test_primary_then_secondary(
     # Ok, now let's refresh it!
     async with session_manager.session() as conn:
         async with conn.begin():
-            auth, refresh, nake, nrke = await flow_service.secondary(
+            key_content = await flow_service.secondary(
                 encoded_refresh_key=refresh,
                 settings=server_settings,
                 conn=conn,
                 log=logger,
             )
 
+            auth = key_content.access_token
+            refresh = key_content.refresh_token
+            nake = key_content.access_token_expires
+            nrke = key_content.refresh_token_expires
+
             # Refresh key expiry doesnt change, auth key does.
             assert nake > ake
             assert nrke == rke

tests/test_service/test_refresh.py

@@ -60,7 +60,7 @@ async def test_create_refresh_key(user, app, session_manager, logger, server_set
                     encoded_payload=encoded, conn=conn
                 )
                 await refresh_service.refresh_refresh_key(
-                    payload=decoded, settings=server_settings, conn=conn
+                    payload=decoded, settings=server_settings, conn=conn, log=logger
                 )
 
     # Now let's refresh our new refresh key.
@@ -73,7 +73,7 @@ async def test_create_refresh_key(user, app, session_manager, logger, server_set
                 refreshed_encoded,
                 refreshed_refresh_key,
             ) = await refresh_service.refresh_refresh_key(
-                payload=decoded, settings=server_settings, conn=conn
+                payload=decoded, settings=server_settings, conn=conn, log=logger
             )
             REFRESHED_KEY_ID = refreshed_refresh_key.refresh_key_id
             assert refreshed_refresh_key.previous == NEW_REFRESH_KEY_ID