Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-44541: Remove tokens from Redis if SQL write fails #1042

Merged
merged 1 commit into from
May 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions changelog.d/20240524_124119_rra_DM_44541.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
### Bug fixes

- When creating a new token, try to remove it from Redis if the SQL write fails. This will hopefully reduce the number of orphaned tokens created during SQL server or proxy restarts.
32 changes: 24 additions & 8 deletions src/gafaelfawr/services/token.py
Original file line number Diff line number Diff line change
Expand Up @@ -217,8 +217,12 @@ async def create_session_token(
)

await self._token_redis_store.store_data(data)
await self._token_db_store.add(data)
await self._token_change_store.add(history_entry)
try:
await self._token_db_store.add(data)
await self._token_change_store.add(history_entry)
except Exception:
await self._token_redis_store.delete(data.token.key)
raise

self._logger.info(
"Successfully authenticated user %s",
Expand Down Expand Up @@ -287,8 +291,12 @@ async def create_oidc_token(

# Store the new token in Redis and the database.
await self._token_redis_store.store_data(data)
await self._token_db_store.add(data, parent=auth_data.token.key)
await self._token_change_store.add(history_entry)
try:
await self._token_db_store.add(data, parent=auth_data.token.key)
await self._token_change_store.add(history_entry)
except Exception:
await self._token_redis_store.delete(data.token.key)
raise

# Log the token creation and return it.
self._logger.info(
Expand Down Expand Up @@ -388,8 +396,12 @@ async def create_user_token(
)

await self._token_redis_store.store_data(data)
await self._token_db_store.add(data, token_name=token_name)
await self._token_change_store.add(history_entry)
try:
await self._token_db_store.add(data, token_name=token_name)
await self._token_change_store.add(history_entry)
except Exception:
await self._token_redis_store.delete(data.token.key)
raise

self._logger.info(
"Created new user token",
Expand Down Expand Up @@ -480,8 +492,12 @@ async def create_token_from_admin_request(
)

await self._token_redis_store.store_data(data)
await self._token_db_store.add(data, token_name=request.token_name)
await self._token_change_store.add(history_entry)
try:
await self._token_db_store.add(data, token_name=request.token_name)
await self._token_change_store.add(history_entry)
except Exception:
await self._token_redis_store.delete(data.token.key)
raise

if data.token_type == TokenType.user:
self._logger.info(
Expand Down
20 changes: 14 additions & 6 deletions src/gafaelfawr/services/token_cache.py
Original file line number Diff line number Diff line change
Expand Up @@ -262,10 +262,14 @@ async def _create_internal_token(
)

await self._token_redis_store.store_data(data)
await self._token_db_store.add(
data, service=service, parent=token_data.token.key
)
await self._token_change_store.add(history_entry)
try:
await self._token_db_store.add(
data, service=service, parent=token_data.token.key
)
await self._token_change_store.add(history_entry)
except Exception:
await self._token_redis_store.delete(data.token.key)
raise

self._logger.info(
"Created new internal token",
Expand Down Expand Up @@ -346,8 +350,12 @@ async def _create_notebook_token(
)

await self._token_redis_store.store_data(data)
await self._token_db_store.add(data, parent=token_data.token.key)
await self._token_change_store.add(history_entry)
try:
await self._token_db_store.add(data, parent=token_data.token.key)
await self._token_change_store.add(history_entry)
except Exception:
await self._token_redis_store.delete(data.token.key)
raise

# Cache the token and return it.
self._logger.info(
Expand Down