Struct SynapseReader

pub struct SynapseReader<'c> { /* private fields */ }

Implementations

impl<'conn> SynapseReader<'conn>

pub async fn new( synapse_connection: &'conn mut PgConnection, dry_run: bool, ) -> Result<Self, Error>

Create a new Synapse reader, which entails creating a transaction and locking Synapse tables.

Errors

Errors are returned under the following circumstances:

• An underlying database error
• If we can’t lock the Synapse tables (pointing to the fact that Synapse may still be running)

pub async fn finish(self) -> Result<(), Error>

Finishes the Synapse reader, committing the transaction.

Errors

Errors are returned under the following circumstances:

• An underlying database error whilst committing the transaction.

pub async fn count_rows(&mut self) -> Result<SynapseRowCounts, Error>

Counts the rows in the Synapse database to get an estimate of how large the migration is going to be.

Errors

Errors are returned under the following circumstances:

• An underlying database error

pub fn read_users( &mut self, ) -> impl Stream<Item = Result<SynapseUser, Error>> + '_

Reads Synapse users, excluding application service users (which do not need to be migrated), from the database.

pub fn read_threepids( &mut self, ) -> impl Stream<Item = Result<SynapseThreepid, Error>> + '_

Reads threepids (such as e-mail and phone number associations) from Synapse.

pub fn read_user_external_ids( &mut self, ) -> impl Stream<Item = Result<SynapseExternalId, Error>> + '_

Read associations between Synapse users and external identity providers

pub fn read_devices( &mut self, ) -> impl Stream<Item = Result<SynapseDevice, Error>> + '_

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_unrefreshable_access_tokens( &mut self, ) -> impl Stream<Item = Result<SynapseAccessToken, Error>> + '_

Reads unrefreshable 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 excludes access tokens whose referenced device ID does not exist, except for deviceless access tokens. (It’s unclear what mechanism led to these, but since Synapse has no foreign key constraints and is not consistently atomic about this, it should be no surprise really)

pub fn read_refreshable_token_pairs( &mut self, ) -> impl Stream<Item = Result<SynapseRefreshableTokenPair, Error>> + '_

Reads (access token, refresh token) pairs from the Synapse database. This does not include token pairs which have been made obsolete by using the refresh token and then acknowledging the successor access token by using it to authenticate a request.

The expiry_ts and ultimate_session_expiry_ts columns are ignored as they are not implemented in MAS. Further, they are unused by any real-world deployment to the best of our knowledge.