Add SynapseReader support for devices

Author: reivilibre

crates/syn2mas/src/synapse_reader/fixtures/devices_alice.sql

@@ -0,0 +1,38 @@
+INSERT INTO devices
+  (
+    user_id,
+    device_id,
+    display_name,
+    last_seen,
+    ip,
+    user_agent,
+    hidden
+  )
+  VALUES
+  (
+    '@alice:example.com',
+    'ADEVICE',
+    'Matrix Console',
+    1623366000000,
+    '203.0.113.1',
+    'Browser/5.0 (X12; ComputerOS 64; rv:1024.0)',
+    FALSE
+  ),
+  (
+    '@alice:example.com',
+    'master signing key',
+    NULL,
+    NULL,
+    NULL,
+    NULL,
+    TRUE
+  ),
+  (
+    '@alice:example.com',
+    'self_signing signing key',
+    NULL,
+    NULL,
+    NULL,
+    NULL,
+    TRUE
+  );

crates/syn2mas/src/synapse_reader/mod.rs

@@ -209,6 +209,17 @@ pub struct SynapseExternalId {
     pub external_id: String,
 }
 
+/// Row of the `devices` table in Synapse.
+#[derive(Clone, Debug, FromRow, PartialEq, Eq, PartialOrd, Ord)]
+pub struct SynapseDevice {
+    pub user_id: FullUserId,
+    pub device_id: String,
+    pub display_name: Option<String>,
+    pub last_seen: Option<MillisecondsTimestamp>,
+    pub ip: Option<String>,
+    pub user_agent: Option<String>,
+}
+
 /// Row of the `access_tokens` table in Synapse.
 #[derive(Clone, Debug, FromRow, PartialEq, Eq, PartialOrd, Ord)]
 pub struct SynapseAccessToken {
@@ -387,6 +398,22 @@ impl<'conn> SynapseReader<'conn> {
         .map_err(|err| err.into_database("reading Synapse user external IDs"))
     }
 
+    /// Reads devices from the Synapse database.
+    /// Does not include so-called 'hidden' devices, which are just a mechanism
+    /// for storing various signing keys shared between the real devices.
+    pub fn read_devices(&mut self) -> impl Stream<Item = Result<SynapseDevice, Error>> + '_ {
+        sqlx::query_as(
+            "
+            SELECT
+              user_id, device_id, display_name, last_seen, ip, user_agent
+            FROM devices
+            WHERE NOT hidden
+            ",
+        )
+        .fetch(&mut *self.txn)
+        .map_err(|err| err.into_database("reading Synapse devices"))
+    }
+
     /// Reads access tokens from the Synapse database.
     /// This does not include access tokens used for puppetting users, as those
     /// are not supported by MAS. This also does not include access tokens
@@ -446,8 +473,8 @@ mod test {
 
     use crate::{
         synapse_reader::{
-            SynapseAccessToken, SynapseExternalId, SynapseRefreshToken, SynapseThreepid,
-            SynapseUser,
+            SynapseAccessToken, SynapseDevice, SynapseExternalId, SynapseRefreshToken,
+            SynapseThreepid, SynapseUser,
         },
         SynapseReader,
     };
@@ -503,6 +530,22 @@ mod test {
         assert_debug_snapshot!(external_ids);
     }
 
+    #[sqlx::test(migrator = "MIGRATOR", fixtures("user_alice", "devices_alice"))]
+    async fn test_read_devices(pool: PgPool) {
+        let mut conn = pool.acquire().await.expect("failed to get connection");
+        let mut reader = SynapseReader::new(&mut conn, false)
+            .await
+            .expect("failed to make SynapseReader");
+
+        let devices: BTreeSet<SynapseDevice> = reader
+            .read_devices()
+            .try_collect()
+            .await
+            .expect("failed to read Synapse devices");
+
+        assert_debug_snapshot!(devices);
+    }
+
     #[sqlx::test(migrator = "MIGRATOR", fixtures("user_alice", "access_token_alice"))]
     async fn test_read_access_token(pool: PgPool) {
         let mut conn = pool.acquire().await.expect("failed to get connection");

crates/syn2mas/src/synapse_reader/snapshots/syn2mas__synapse_reader__test__read_devices.snap

@@ -0,0 +1,26 @@
+---
+source: crates/syn2mas/src/synapse_reader/mod.rs
+expression: devices
+---
+{
+    SynapseDevice {
+        user_id: FullUserId(
+            "@alice:example.com",
+        ),
+        device_id: "ADEVICE",
+        display_name: Some(
+            "Matrix Console",
+        ),
+        last_seen: Some(
+            MillisecondsTimestamp(
+                2021-06-10T23:00:00Z,
+            ),
+        ),
+        ip: Some(
+            "203.0.113.1",
+        ),
+        user_agent: Some(
+            "Browser/5.0 (X12; ComputerOS 64; rv:1024.0)",
+        ),
+    },
+}

crates/syn2mas/test_synapse_migrations/20250129140230_devices.sql

@@ -0,0 +1,15 @@
+-- Copyright 2025 New Vector Ltd.
+--
+-- SPDX-License-Identifier: AGPL-3.0-only
+-- Please see LICENSE in the repository root for full details.
+
+-- Brings in the `devices` table from Synapse
+CREATE TABLE devices (
+    user_id text NOT NULL,
+    device_id text NOT NULL,
+    display_name text,
+    last_seen bigint,
+    ip text,
+    user_agent text,
+    hidden boolean DEFAULT false
+);