mas_handlers/admin/v1/user_emails/
delete.rs

1// Copyright 2025 New Vector Ltd.
2//
3// SPDX-License-Identifier: AGPL-3.0-only
4// Please see LICENSE in the repository root for full details.
5
6use aide::{NoApi, OperationIo, transform::TransformOperation};
7use axum::{Json, response::IntoResponse};
8use hyper::StatusCode;
9use mas_axum_utils::record_error;
10use mas_storage::{
11    BoxRng,
12    queue::{ProvisionUserJob, QueueJobRepositoryExt as _},
13};
14use ulid::Ulid;
15
16use crate::{
17    admin::{call_context::CallContext, params::UlidPathParam, response::ErrorResponse},
18    impl_from_error_for_route,
19};
20
21#[derive(Debug, thiserror::Error, OperationIo)]
22#[aide(output_with = "Json<ErrorResponse>")]
23pub enum RouteError {
24    #[error(transparent)]
25    Internal(Box<dyn std::error::Error + Send + Sync + 'static>),
26
27    #[error("User email ID {0} not found")]
28    NotFound(Ulid),
29}
30
31impl_from_error_for_route!(mas_storage::RepositoryError);
32
33impl IntoResponse for RouteError {
34    fn into_response(self) -> axum::response::Response {
35        let error = ErrorResponse::from_error(&self);
36        let sentry_event_id = record_error!(self, Self::Internal(_));
37        let status = match self {
38            Self::Internal(_) => StatusCode::INTERNAL_SERVER_ERROR,
39            Self::NotFound(_) => StatusCode::NOT_FOUND,
40        };
41        (status, sentry_event_id, Json(error)).into_response()
42    }
43}
44
45pub fn doc(operation: TransformOperation) -> TransformOperation {
46    operation
47        .id("deleteUserEmail")
48        .summary("Delete a user email")
49        .tag("user-email")
50        .response_with::<204, (), _>(|t| t.description("User email was found"))
51        .response_with::<404, RouteError, _>(|t| {
52            let response = ErrorResponse::from_error(&RouteError::NotFound(Ulid::nil()));
53            t.description("User email was not found").example(response)
54        })
55}
56
57#[tracing::instrument(name = "handler.admin.v1.user_emails.delete", skip_all)]
58pub async fn handler(
59    CallContext {
60        mut repo, clock, ..
61    }: CallContext,
62    NoApi(mut rng): NoApi<BoxRng>,
63    id: UlidPathParam,
64) -> Result<StatusCode, RouteError> {
65    let email = repo
66        .user_email()
67        .lookup(*id)
68        .await?
69        .ok_or(RouteError::NotFound(*id))?;
70
71    let job = ProvisionUserJob::new_for_id(email.user_id);
72    repo.user_email().remove(email).await?;
73
74    // Schedule a job to update the user
75    repo.queue_job().schedule_job(&mut rng, &clock, job).await?;
76
77    repo.save().await?;
78
79    Ok(StatusCode::NO_CONTENT)
80}
81
82#[cfg(test)]
83mod tests {
84    use hyper::{Request, StatusCode};
85    use sqlx::PgPool;
86    use ulid::Ulid;
87
88    use crate::test_utils::{RequestBuilderExt, ResponseExt, TestState, setup};
89    #[sqlx::test(migrator = "mas_storage_pg::MIGRATOR")]
90    async fn test_delete(pool: PgPool) {
91        setup();
92        let mut state = TestState::from_pool(pool).await.unwrap();
93        let token = state.token_with_scope("urn:mas:admin").await;
94        let mut rng = state.rng();
95
96        // Provision a user and an email
97        let mut repo = state.repository().await.unwrap();
98        let alice = repo
99            .user()
100            .add(&mut rng, &state.clock, "alice".to_owned())
101            .await
102            .unwrap();
103        let mas_data_model::UserEmail { id, .. } = repo
104            .user_email()
105            .add(
106                &mut rng,
107                &state.clock,
108                &alice,
109                "alice@example.com".to_owned(),
110            )
111            .await
112            .unwrap();
113
114        repo.save().await.unwrap();
115
116        let request = Request::delete(format!("/api/admin/v1/user-emails/{id}"))
117            .bearer(&token)
118            .empty();
119        let response = state.request(request).await;
120        response.assert_status(StatusCode::NO_CONTENT);
121
122        // Verify that the email was deleted
123        let request = Request::get(format!("/api/admin/v1/user-emails/{id}"))
124            .bearer(&token)
125            .empty();
126        let response = state.request(request).await;
127        response.assert_status(StatusCode::NOT_FOUND);
128    }
129
130    #[sqlx::test(migrator = "mas_storage_pg::MIGRATOR")]
131    async fn test_not_found(pool: PgPool) {
132        setup();
133        let mut state = TestState::from_pool(pool).await.unwrap();
134        let token = state.token_with_scope("urn:mas:admin").await;
135
136        let email_id = Ulid::nil();
137        let request = Request::delete(format!("/api/admin/v1/user-emails/{email_id}"))
138            .bearer(&token)
139            .empty();
140        let response = state.request(request).await;
141        response.assert_status(StatusCode::NOT_FOUND);
142    }
143}
mas_handlers/admin/v1/user_emails/delete.rs

mas_handlers/admin/v1/user_emails/
delete.rs
