MSC2918: make access_tokens.used nullable

This avoids rewriting the whole table on disk on Postgres < 11

Signed-off-by: Quentin Gliech <[email protected]>

Author: sandhose

synapse/storage/databases/main/registration.py

@@ -477,8 +477,15 @@ def _query_for_auth(self, txn, token: str) -> Optional[TokenLookupResult]:
 
         txn.execute(sql, (token,))
         rows = self.db_pool.cursor_to_dict(txn)
+
         if rows:
-            return TokenLookupResult(**rows[0])
+            row = rows[0]
+
+            # This field is nullable, ensure it comes out as a boolean
+            if row["token_used"] is None:
+                row["token_used"] = False
+
+            return TokenLookupResult(**row)
 
         return None
 
@@ -1157,7 +1164,8 @@ def _lookup_refresh_token_txn(txn) -> Optional[RefreshTokenLookupResult]:
                 device_id=row[2],
                 next_token_id=row[3],
                 has_next_refresh_token_been_refreshed=row[4],
-                has_next_access_token_been_used=row[5],
+                # This column is nullable, ensure it's a boolean
+                has_next_access_token_been_used=(row[5] or False),
             )
 
         return await self.db_pool.runInteraction(
@@ -1435,6 +1443,7 @@ async def add_access_token_to_user(
                 "puppets_user_id": puppets_user_id,
                 "last_validated": now,
                 "refresh_token_id": refresh_token_id,
+                "used": False,
             },
             desc="add_access_token_to_user",
         )

synapse/storage/schema/main/delta/59/14refresh_tokens.sql

@@ -28,3 +28,7 @@ CREATE TABLE refresh_tokens (
 -- Add a reference to the refresh token generated alongside each access token
 ALTER TABLE "access_tokens"
   ADD COLUMN refresh_token_id BIGINT REFERENCES refresh_tokens (id) ON DELETE CASCADE;
+
+-- Add a flag whether the token was already used or not
+ALTER TABLE "access_tokens"
+  ADD COLUMN used BOOLEAN;