Merge pull request #148

feat!: Accept `auto_accept=true` on route `POST /v1/invitations`

Author: RemiBardon

crates/rest-api/src/features/invitations/invite_member.rs

@@ -4,7 +4,7 @@
 // License: Mozilla Public License v2.0 (MPL v2.0)
 
 #[cfg(debug_assertions)]
-use axum::extract::State;
+use axum::extract::{Query, State};
 use axum::{http::HeaderValue, Json};
 #[cfg(debug_assertions)]
 use axum_extra::either::Either;
@@ -55,22 +55,41 @@ pub struct InviteMemberRequest {
     pub contact: InvitationContact,
 }
 
+#[cfg(debug_assertions)]
+#[derive(Deserialize)]
+pub struct InviteMemberQuery {
+    #[serde(default)]
+    pub auto_accept: bool,
+}
+
 /// Invite a new member and auto-accept the invitation if enabled.
 pub async fn invite_member_route(
     #[cfg(debug_assertions)] State(AppState { db, .. }): State<AppState>,
     app_config: AppConfig,
     server_config: ServerConfig,
     notification_service: NotificationService,
     invitation_service: InvitationService,
+    #[cfg(debug_assertions)] Query(InviteMemberQuery { auto_accept }): Query<InviteMemberQuery>,
     Json(req): Json<InviteMemberRequest>,
 ) -> InviteMemberResponse {
+    #[cfg(not(debug_assertions))]
     let invitation = invitation_service
         .invite_member(&app_config, &server_config, &notification_service, req)
         .await?;
+    #[cfg(debug_assertions)]
+    let invitation = invitation_service
+        .invite_member(
+            &app_config,
+            &server_config,
+            &notification_service,
+            req,
+            auto_accept,
+        )
+        .await?;
 
     #[cfg(debug_assertions)]
     {
-        if app_config.debug_only.automatically_accept_invitations {
+        if auto_accept {
             let jid = invitation.jid;
             let resource_uri = format!("/v1/members/{jid}");
             let member = MemberRepository::get(&db, &jid).await?.unwrap();

crates/service/src/features/app_config/mod.rs

@@ -338,8 +338,6 @@ impl Default for ConfigDebug {
 #[cfg(debug_assertions)]
 #[derive(Debug, Clone, Deserialize, Default)]
 pub struct ConfigDebugOnly {
-    #[serde(default)]
-    pub automatically_accept_invitations: bool,
     /// When automatically accepting invitations during testing, one might want to authenticate
     /// the created member. With this flag turned on, the member's password will be their JID.
     #[serde(default)]

crates/service/src/features/invitations/invitation_service.rs

@@ -62,6 +62,7 @@ impl InvitationService {
         server_config: &ServerConfig,
         notification_service: &NotificationService,
         form: impl Into<InviteMemberForm>,
+        #[cfg(debug_assertions)] auto_accept: bool,
     ) -> Result<Invitation, InviteMemberError> {
         let form = form.into();
         let jid = form.jid(&server_config)?;
@@ -136,11 +137,8 @@ impl InvitationService {
             })?;
 
         #[cfg(debug_assertions)]
-        if app_config.debug_only.automatically_accept_invitations {
-            warn!(
-                "Config `{}` is turned on. The created invitation will be automatically accepted.",
-                stringify!(debug_only.automatically_accept_invitations),
-            );
+        if auto_accept {
+            warn!("As requested, the created invitation will be automatically accepted.");
 
             let password: SecretString = if app_config
                 .debug_only

scripts/integration-test

@@ -106,8 +106,6 @@ for arg in "$@"; do
 	fi
 
 	case $arg in
-		members|workspace)
-			stepci_run "$test_file" test-auto_accept_invitations ;;
 		*dns-configured-correctly-dynamic)
 			DNS_ZONE_FILE="${DNS_ZONES_DIR:?}"/working-dynamic.zone stepci_run "$test_file" ;;
 		*)

tests/integration/Prose-test-auto_accept_invitations.toml

@@ -13,3 +13,6 @@ pod_address = "pod@prose.org.local"
 
 smtp_host = "mailpit"
 smtp_encrypt = false
+
+[debug_only]
+insecure_password_on_auto_accept_invitation = true

tests/integration/Prose-test.toml

@@ -236,6 +236,8 @@ components:
       http:
         method: POST
         url: /v1/invitations
+        params:
+          auto_accept: true
         auth:
           bearer:
             token: ${{ captures.token }}

tests/integration/step-ci/members.yaml

@@ -9,7 +9,7 @@ before:
     - $ref: "init.yaml#/components/steps/create_first_admin"
     - $ref: "init.yaml#/components/steps/init_workspace"
     - $ref: "init.yaml#/components/steps/log_admin_in"
-    - $ref: "#/components/steps/add_member"
+    - $ref: "members.yaml#/components/steps/add_member"
 
 tests:
   getWorkspaceDetailsAsAdmin:
@@ -79,30 +79,6 @@ components:
           status: 200
           schema:
             $ref: openapi.json#/components/schemas/GetWorkspaceAccentColorResponse
-
-    add_member:
-      name: Add member (via auto-accepted invitation)
-      http:
-        method: POST
-        url: /v1/invitations
-        auth:
-          bearer:
-            token: ${{ captures.token }}
-        json:
-          username: ${{ internet.userName | fake }}
-          pre_assigned_role: MEMBER
-          channel: email
-          email_address: ${{ internet.email | fake }}
-        captures:
-          lastInvitationJid:
-            jsonpath: $.jid
-        check:
-          status: 201
-          headers:
-            Content-Type: application/json
-            Location: /.+/
-          schema:
-            $ref: openapi.json#/components/schemas/Member
     log_member_in:
       $ref: "invitations.yaml#/components/steps/log_last_invited_member_in"