Support reading and writing guests

Author: reivilibre

crates/storage-pg/migrations/20250130170011_user_is_guest.sql

@@ -0,0 +1,10 @@
+-- Copyright 2025 New Vector Ltd.
+--
+-- SPDX-License-Identifier: AGPL-3.0-only
+-- Please see LICENSE in the repository root for full details.
+
+ALTER TABLE users
+  -- Track whether users are guests.
+  -- Although guest support is not present in MAS yet, syn2mas should import
+  -- these users and therefore we should track their state.
+  ADD COLUMN is_guest BOOLEAN NOT NULL DEFAULT FALSE;

crates/syn2mas/.sqlx/query-06cd6bff12000db3e64e98c344cc9e3b5de7af6a497ad84036ae104576ae0575.json

@@ -199,6 +199,9 @@ pub struct MasNewUser {
     pub created_at: DateTime<Utc>,
     pub locked_at: Option<DateTime<Utc>>,
     pub can_request_admin: bool,
+    /// Whether the user was a Synapse guest.
+    /// Although MAS doesn't support guest access, it's still useful to track for the future.
+    pub is_guest: bool,
 }
 
 pub struct MasNewUserPassword {
@@ -563,52 +566,65 @@ impl<'conn> MasWriter<'conn> {
     #[allow(clippy::missing_panics_doc)] // not a real panic
     #[tracing::instrument(skip_all, level = Level::DEBUG)]
     pub fn write_users(&mut self, users: Vec<MasNewUser>) -> BoxFuture<'_, Result<(), Error>> {
-        self.writer_pool.spawn_with_connection(move |conn| Box::pin(async move {
-            // `UNNEST` is a fast way to do bulk inserts, as it lets us send multiple rows in one statement
-            // without having to change the statement SQL thus altering the query plan.
-            // See <https://github.com/launchbadge/sqlx/blob/main/FAQ.md#how-can-i-bind-an-array-to-a-values-clause-how-can-i-do-bulk-inserts>.
-            // In the future we could consider using sqlx's support for `PgCopyIn` / the `COPY FROM STDIN` statement,
-            // which is allegedly the best for insert performance, but is less simple to encode.
-            if users.is_empty() {
-                return Ok(());
-            }
-
-            let mut user_ids: Vec<Uuid> = Vec::with_capacity(users.len());
-            let mut usernames: Vec<String> = Vec::with_capacity(users.len());
-            let mut created_ats: Vec<DateTime<Utc>> = Vec::with_capacity(users.len());
-            let mut locked_ats: Vec<Option<DateTime<Utc>>> = Vec::with_capacity(users.len());
-            let mut can_request_admins: Vec<bool> = Vec::with_capacity(users.len());
-            for MasNewUser {
-                user_id,
-                username,
-                created_at,
-                locked_at,
-                can_request_admin,
-            } in users
-            {
-                user_ids.push(user_id);
-                usernames.push(username);
-                created_ats.push(created_at);
-                locked_ats.push(locked_at);
-                can_request_admins.push(can_request_admin);
-            }
+        self.writer_pool
+            .spawn_with_connection(move |conn| {
+                Box::pin(async move {
+                    // `UNNEST` is a fast way to do bulk inserts, as it lets us send multiple rows in one statement
+                    // without having to change the statement SQL thus altering the query plan.
+                    // See <https://github.com/launchbadge/sqlx/blob/main/FAQ.md#how-can-i-bind-an-array-to-a-values-clause-how-can-i-do-bulk-inserts>.
+                    // In the future we could consider using sqlx's support for `PgCopyIn` / the `COPY FROM STDIN` statement,
+                    // which is allegedly the best for insert performance, but is less simple to encode.
+                    let mut user_ids: Vec<Uuid> = Vec::with_capacity(users.len());
+                    let mut usernames: Vec<String> = Vec::with_capacity(users.len());
+                    let mut created_ats: Vec<DateTime<Utc>> = Vec::with_capacity(users.len());
+                    let mut locked_ats: Vec<Option<DateTime<Utc>>> =
+                        Vec::with_capacity(users.len());
+                    let mut can_request_admins: Vec<bool> = Vec::with_capacity(users.len());
+                    let mut is_guests: Vec<bool> = Vec::with_capacity(users.len());
+                    for MasNewUser {
+                        user_id,
+                        username,
+                        created_at,
+                        locked_at,
+                        can_request_admin,
+                        is_guest,
+                    } in users
+                    {
+                        user_ids.push(user_id);
+                        usernames.push(username);
+                        created_ats.push(created_at);
+                        locked_ats.push(locked_at);
+                        can_request_admins.push(can_request_admin);
+                        is_guests.push(is_guest);
+                    }
 
-            sqlx::query!(
-                r#"
-                INSERT INTO syn2mas__users
-                (user_id, username, created_at, locked_at, can_request_admin)
-                SELECT * FROM UNNEST($1::UUID[], $2::TEXT[], $3::TIMESTAMP WITH TIME ZONE[], $4::TIMESTAMP WITH TIME ZONE[], $5::BOOL[])
-                "#,
-                &user_ids[..],
-                &usernames[..],
-                &created_ats[..],
-                // We need to override the typing for arrays of optionals (sqlx limitation)
-                &locked_ats[..] as &[Option<DateTime<Utc>>],
-                &can_request_admins[..],
-            ).execute(&mut *conn).await.into_database("writing users to MAS")?;
+                    sqlx::query!(
+                        r#"
+                        INSERT INTO syn2mas__users (
+                          user_id, username,
+                          created_at, locked_at,
+                          can_request_admin, is_guest)
+                        SELECT * FROM UNNEST(
+                          $1::UUID[], $2::TEXT[],
+                          $3::TIMESTAMP WITH TIME ZONE[], $4::TIMESTAMP WITH TIME ZONE[],
+                          $5::BOOL[], $6::BOOL[])
+                        "#,
+                        &user_ids[..],
+                        &usernames[..],
+                        &created_ats[..],
+                        // We need to override the typing for arrays of optionals (sqlx limitation)
+                        &locked_ats[..] as &[Option<DateTime<Utc>>],
+                        &can_request_admins[..],
+                        &is_guests[..],
+                    )
+                    .execute(&mut *conn)
+                    .await
+                    .into_database("writing users to MAS")?;
 
-            Ok(())
-        })).boxed()
+                    Ok(())
+                })
+            })
+            .boxed()
     }
 
     /// Write a batch of user passwords to the database.
@@ -1197,6 +1213,7 @@ mod test {
                 created_at: DateTime::default(),
                 locked_at: None,
                 can_request_admin: false,
+                is_guest: false,
             }])
             .await
             .expect("failed to write user");
@@ -1221,6 +1238,7 @@ mod test {
                 created_at: DateTime::default(),
                 locked_at: None,
                 can_request_admin: false,
+                is_guest: false,
             }])
             .await
             .expect("failed to write user");
@@ -1252,6 +1270,7 @@ mod test {
                 created_at: DateTime::default(),
                 locked_at: None,
                 can_request_admin: false,
+                is_guest: false,
             }])
             .await
             .expect("failed to write user");
@@ -1285,6 +1304,7 @@ mod test {
                 created_at: DateTime::default(),
                 locked_at: None,
                 can_request_admin: false,
+                is_guest: false,
             }])
             .await
             .expect("failed to write user");
@@ -1319,6 +1339,7 @@ mod test {
                 created_at: DateTime::default(),
                 locked_at: None,
                 can_request_admin: false,
+                is_guest: false,
             }])
             .await
             .expect("failed to write user");
@@ -1352,6 +1373,7 @@ mod test {
                 created_at: DateTime::default(),
                 locked_at: None,
                 can_request_admin: false,
+                is_guest: false,
             }])
             .await
             .expect("failed to write user");
@@ -1389,6 +1411,7 @@ mod test {
                 created_at: DateTime::default(),
                 locked_at: None,
                 can_request_admin: false,
+                is_guest: false,
             }])
             .await
             .expect("failed to write user");
@@ -1437,6 +1460,7 @@ mod test {
                 created_at: DateTime::default(),
                 locked_at: None,
                 can_request_admin: false,
+                is_guest: false,
             }])
             .await
             .expect("failed to write user");

crates/syn2mas/.sqlx/query-c7d2277606b4b326b0c375a056cd57488c930fe431311e53e5e1af6fb1d4e56f.json

@@ -5,6 +5,7 @@ expression: db_snapshot
 users:
   - can_request_admin: "false"
     created_at: "1970-01-01 00:00:00+00"
+    is_guest: "false"
     locked_at: ~
     primary_user_email_id: ~
     user_id: 00000000-0000-0000-0000-000000000001

crates/syn2mas/src/mas_writer/mod.rs

@@ -23,6 +23,7 @@ compat_sessions:
 users:
   - can_request_admin: "false"
     created_at: "1970-01-01 00:00:00+00"
+    is_guest: "false"
     locked_at: ~
     primary_user_email_id: ~
     user_id: 00000000-0000-0000-0000-000000000001

crates/syn2mas/src/mas_writer/snapshots/syn2mas__mas_writer__test__write_user.snap

@@ -17,6 +17,7 @@ compat_sessions:
 users:
   - can_request_admin: "false"
     created_at: "1970-01-01 00:00:00+00"
+    is_guest: "false"
     locked_at: ~
     primary_user_email_id: ~
     user_id: 00000000-0000-0000-0000-000000000001

crates/syn2mas/src/mas_writer/snapshots/syn2mas__mas_writer__test__write_user_with_access_token.snap

@@ -11,6 +11,7 @@ user_emails:
 users:
   - can_request_admin: "false"
     created_at: "1970-01-01 00:00:00+00"
+    is_guest: "false"
     locked_at: ~
     primary_user_email_id: ~
     user_id: 00000000-0000-0000-0000-000000000001

crates/syn2mas/src/mas_writer/snapshots/syn2mas__mas_writer__test__write_user_with_device.snap

@@ -12,6 +12,7 @@ user_passwords:
 users:
   - can_request_admin: "false"
     created_at: "1970-01-01 00:00:00+00"
+    is_guest: "false"
     locked_at: ~
     primary_user_email_id: ~
     user_id: 00000000-0000-0000-0000-000000000001

crates/syn2mas/src/mas_writer/snapshots/syn2mas__mas_writer__test__write_user_with_email.snap

@@ -30,6 +30,7 @@ compat_sessions:
 users:
   - can_request_admin: "false"
     created_at: "1970-01-01 00:00:00+00"
+    is_guest: "false"
     locked_at: ~
     primary_user_email_id: ~
     user_id: 00000000-0000-0000-0000-000000000001