Data model and storage layer for storing user registrations

crates/data-model/src/lib.rs

@@ -48,6 +48,6 @@ pub use self::{
     users::{
         Authentication, AuthenticationMethod, BrowserSession, Password, User, UserEmail,
         UserEmailAuthentication, UserEmailAuthenticationCode, UserRecoverySession,
-        UserRecoveryTicket,
+        UserRecoveryTicket, UserRegistration, UserRegistrationPassword,
     },
 };

crates/data-model/src/users.rs

@@ -10,6 +10,7 @@ use chrono::{DateTime, Utc};
 use rand::Rng;
 use serde::Serialize;
 use ulid::Ulid;
+use url::Url;
 
 use crate::UserAgent;
 
@@ -112,6 +113,7 @@ impl UserRecoveryTicket {
 pub struct UserEmailAuthentication {
     pub id: Ulid,
     pub user_session_id: Option<Ulid>,
+    pub user_registration_id: Option<Ulid>,
     pub email: String,
     pub created_at: DateTime<Utc>,
     pub completed_at: Option<DateTime<Utc>>,
@@ -192,3 +194,23 @@ impl UserEmail {
         ]
     }
 }
+
+#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
+pub struct UserRegistrationPassword {
+    pub hashed_password: String,
+    pub version: u16,
+}
+
+#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
+pub struct UserRegistration {
+    pub id: Ulid,
+    pub username: Option<String>,
+    pub display_name: Option<String>,
+    pub terms_url: Option<Url>,
+    pub email_authentication_id: Option<Ulid>,
+    pub password: Option<UserRegistrationPassword>,
+    pub ip_address: Option<IpAddr>,
+    pub user_agent: Option<UserAgent>,
+    pub created_at: DateTime<Utc>,
+    pub completed_at: Option<DateTime<Utc>>,
+}

crates/storage-pg/migrations/20250113102144_user_registrations.sql

@@ -0,0 +1,27 @@
+-- Copyright 2025 New Vector Ltd.
+--
+-- SPDX-License-Identifier: AGPL-3.0-only
+-- Please see LICENSE in the repository root for full details.
+
+-- Add a table for storing user registrations
+CREATE TABLE "user_registrations" (
+  "user_registration_id" UUID PRIMARY KEY,
+  "ip_address" INET,
+  "user_agent" TEXT,
+  "username" TEXT,
+  "display_name" TEXT,
+  "terms_url" TEXT,
+  "email_authentication_id" UUID
+    REFERENCES "user_email_authentications" ("user_email_authentication_id")
+    ON DELETE SET NULL,
+  "hashed_password" TEXT,
+  "hashed_password_version" INTEGER,
+  "created_at" TIMESTAMP WITH TIME ZONE NOT NULL,
+  "completed_at" TIMESTAMP WITH TIME ZONE
+);
+
+-- Allow using user email authentications for user registrations
+ALTER TABLE "user_email_authentications"
+  ADD COLUMN "user_registration_id" UUID
+    REFERENCES "user_registrations" ("user_registration_id")
+    ON DELETE CASCADE;

crates/storage-pg/src/repository.rs

@@ -49,7 +49,8 @@ use crate::{
     },
     user::{
         PgBrowserSessionRepository, PgUserEmailRepository, PgUserPasswordRepository,
-        PgUserRecoveryRepository, PgUserRepository, PgUserTermsRepository,
+        PgUserRecoveryRepository, PgUserRegistrationRepository, PgUserRepository,
+        PgUserTermsRepository,
     },
     DatabaseError,
 };
@@ -191,6 +192,12 @@ where
         Box::new(PgUserTermsRepository::new(self.conn.as_mut()))
     }
 
+    fn user_registration<'c>(
+        &'c mut self,
+    ) -> Box<dyn mas_storage::user::UserRegistrationRepository<Error = Self::Error> + 'c> {
+        Box::new(PgUserRegistrationRepository::new(self.conn.as_mut()))
+    }
+
     fn browser_session<'c>(
         &'c mut self,
     ) -> Box<dyn BrowserSessionRepository<Error = Self::Error> + 'c> {