diff --git a/apps/labrinth/.sqlx/query-6f5b0c2681ac4a622533f037e80ed0bd06f7bc12907c16ef91bf2c095917fab8.json b/apps/labrinth/.sqlx/query-6f5b0c2681ac4a622533f037e80ed0bd06f7bc12907c16ef91bf2c095917fab8.json new file mode 100644 index 00000000000..9e7f52815a0 --- /dev/null +++ b/apps/labrinth/.sqlx/query-6f5b0c2681ac4a622533f037e80ed0bd06f7bc12907c16ef91bf2c095917fab8.json @@ -0,0 +1,16 @@ +{ + "db_name": "PostgreSQL", + "query": "\n\t\t\tUPDATE mods\n\t\t\tSET status = $1,\n\t\t\t approved_because = CASE\n\t\t\t WHEN approved IS NULL THEN $3::jsonb\n\t\t\t ELSE approved_because\n\t\t\t END,\n\t\t\t approved = COALESCE(approved, NOW())\n\t\t\tWHERE id = $2\n\t\t\t", + "describe": { + "columns": [], + "parameters": { + "Left": [ + "Varchar", + "Int8", + "Jsonb" + ] + }, + "nullable": [] + }, + "hash": "6f5b0c2681ac4a622533f037e80ed0bd06f7bc12907c16ef91bf2c095917fab8" +} diff --git a/apps/labrinth/.sqlx/query-86f062b5801e9a7e62ab6760e13327713f6116c827a39d451db32804c10e464a.json b/apps/labrinth/.sqlx/query-86f062b5801e9a7e62ab6760e13327713f6116c827a39d451db32804c10e464a.json new file mode 100644 index 00000000000..8bdefb0ed1d --- /dev/null +++ b/apps/labrinth/.sqlx/query-86f062b5801e9a7e62ab6760e13327713f6116c827a39d451db32804c10e464a.json @@ -0,0 +1,15 @@ +{ + "db_name": "PostgreSQL", + "query": "\n UPDATE mods\n SET approved_because = CASE\n WHEN approved IS NULL THEN $2::jsonb\n ELSE approved_because\n END,\n approved = COALESCE(approved, NOW()),\n initial_queued = NULL\n WHERE id = $1\n ", + "describe": { + "columns": [], + "parameters": { + "Left": [ + "Int8", + "Jsonb" + ] + }, + "nullable": [] + }, + "hash": "86f062b5801e9a7e62ab6760e13327713f6116c827a39d451db32804c10e464a" +} diff --git a/apps/labrinth/.sqlx/query-9e1d4fca7ba37cfbc1c3437d78b56c778905419b5edc2fb6c93acb71dcabc075.json b/apps/labrinth/.sqlx/query-9e1d4fca7ba37cfbc1c3437d78b56c778905419b5edc2fb6c93acb71dcabc075.json deleted file mode 100644 index 2ccbb6d9f19..00000000000 --- a/apps/labrinth/.sqlx/query-9e1d4fca7ba37cfbc1c3437d78b56c778905419b5edc2fb6c93acb71dcabc075.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "db_name": "PostgreSQL", - "query": "\n\t\t\tUPDATE mods\n\t\t\tSET status = $1, approved = COALESCE(approved, NOW())\n\t\t\tWHERE id = $2\n\t\t\t", - "describe": { - "columns": [], - "parameters": { - "Left": [ - "Varchar", - "Int8" - ] - }, - "nullable": [] - }, - "hash": "9e1d4fca7ba37cfbc1c3437d78b56c778905419b5edc2fb6c93acb71dcabc075" -} diff --git a/apps/labrinth/.sqlx/query-bf298f827d1a56b319b1c0c91711830f16cc27d714b9a0a52f392ca2720effd2.json b/apps/labrinth/.sqlx/query-bf298f827d1a56b319b1c0c91711830f16cc27d714b9a0a52f392ca2720effd2.json deleted file mode 100644 index c857dede8ab..00000000000 --- a/apps/labrinth/.sqlx/query-bf298f827d1a56b319b1c0c91711830f16cc27d714b9a0a52f392ca2720effd2.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "db_name": "PostgreSQL", - "query": "\n UPDATE mods\n SET approved = COALESCE(approved, NOW()), initial_queued = NULL\n WHERE id = $1\n ", - "describe": { - "columns": [], - "parameters": { - "Left": [ - "Int8" - ] - }, - "nullable": [] - }, - "hash": "bf298f827d1a56b319b1c0c91711830f16cc27d714b9a0a52f392ca2720effd2" -} diff --git a/apps/labrinth/migrations/20261116120000_project_approved_because.sql b/apps/labrinth/migrations/20261116120000_project_approved_because.sql new file mode 100644 index 00000000000..547c6d7ec44 --- /dev/null +++ b/apps/labrinth/migrations/20261116120000_project_approved_because.sql @@ -0,0 +1,2 @@ +ALTER TABLE mods +ADD COLUMN approved_because JSONB; diff --git a/apps/labrinth/src/models/v2/threads.rs b/apps/labrinth/src/models/v2/threads.rs index 892dbf6e9d4..2589c9030e8 100644 --- a/apps/labrinth/src/models/v2/threads.rs +++ b/apps/labrinth/src/models/v2/threads.rs @@ -96,6 +96,7 @@ impl From for LegacyMessageBody { | crate::models::v3::threads::MessageBody::AutoApproval { new_status, old_status, + .. } => LegacyMessageBody::StatusChange { new_status, old_status, diff --git a/apps/labrinth/src/models/v3/projects.rs b/apps/labrinth/src/models/v3/projects.rs index c0d0e834bd7..2c1e0e6b79f 100644 --- a/apps/labrinth/src/models/v3/projects.rs +++ b/apps/labrinth/src/models/v3/projects.rs @@ -5,7 +5,7 @@ use crate::database::models::version_item::VersionQueryResult; use crate::models::exp; use crate::models::ids::{ FileId, GalleryImageId, OrganizationId, ProjectId, TeamId, ThreadId, - VersionId, + ThreadIssueId, VersionId, }; use crate::models::minecraft::legacy_game_version_name; use crate::routes::{FileHash, HashAlgorithm}; @@ -17,6 +17,32 @@ use serde::{Deserialize, Serialize}; use url::Url; use validator::Validate; +#[derive(Debug, Clone, Serialize, Deserialize, utoipa::ToSchema)] +pub enum ApprovalReason { + ByUser(UserId), + Auto(ApprovalProvenance), +} + +/// Evidence captured when a project is automatically approved. +#[derive(Debug, Clone, Serialize, Deserialize, utoipa::ToSchema)] +pub struct ApprovalProvenance { + pub trigger: AutoApprovalCause, + pub previous_status: ProjectStatus, + pub resolved_issue_ids: Vec, +} + +#[derive(Debug, Clone, Serialize, Deserialize, utoipa::ToSchema)] +#[serde(tag = "type", rename_all = "snake_case")] +pub enum AutoApprovalCause { + Resubmission { user_id: UserId }, + TechnicalReviewNoDetails, + ScanCompleted { report_id: i64, scan_id: String }, + RulesChanged { revision: i64, user_id: UserId }, + ModeratorTechnicalReviewPass { user_id: UserId }, + LocalVerdictsUpdated { user_id: UserId }, + GlobalVerdictsUpdated { user_id: UserId }, +} + /// A project returned from the API #[derive(Debug, Clone, Serialize, Deserialize, utoipa::ToSchema)] pub struct Project { diff --git a/apps/labrinth/src/models/v3/threads.rs b/apps/labrinth/src/models/v3/threads.rs index e695ec57c37..2bd81d14c48 100644 --- a/apps/labrinth/src/models/v3/threads.rs +++ b/apps/labrinth/src/models/v3/threads.rs @@ -4,7 +4,7 @@ use crate::models::ids::{ ImageId, ProjectId, ReportId, ThreadId, ThreadMessageId, }; use crate::models::pats::Scopes; -use crate::models::projects::ProjectStatus; +use crate::models::projects::{ApprovalProvenance, ProjectStatus}; use crate::models::thread_issues::ThreadIssue; use crate::models::users::User; use ariadne::ids::UserId; @@ -53,6 +53,8 @@ pub enum MessageBody { AutoApproval { new_status: ProjectStatus, old_status: ProjectStatus, + #[serde(default, skip_serializing_if = "Option::is_none")] + provenance: Option, }, TechReview { verdict: DelphiVerdict, diff --git a/apps/labrinth/src/routes/internal/delphi/mod.rs b/apps/labrinth/src/routes/internal/delphi/mod.rs index 1607157f28a..443187174bf 100644 --- a/apps/labrinth/src/routes/internal/delphi/mod.rs +++ b/apps/labrinth/src/routes/internal/delphi/mod.rs @@ -1,3 +1,4 @@ +use crate::models::projects::AutoApprovalCause; use crate::util::MinecraftMeta; use crate::util::error::ApiContext as _; use std::{collections::HashMap, fmt::Write, time::Instant}; @@ -328,6 +329,10 @@ async fn ingest_report_deserialized( let prepared = crate::routes::v3::projects::mutation::prepare_technical_review_exits( &exited_projects, + AutoApprovalCause::ScanCompleted { + report_id: report_id.0, + scan_id: report.identifier.to_string(), + }, &mut transaction, &pool, &redis, diff --git a/apps/labrinth/src/routes/internal/moderation/tech_review.rs b/apps/labrinth/src/routes/internal/moderation/tech_review.rs index ff7a59b99ff..f6a0a86447a 100644 --- a/apps/labrinth/src/routes/internal/moderation/tech_review.rs +++ b/apps/labrinth/src/routes/internal/moderation/tech_review.rs @@ -11,6 +11,7 @@ use serde::{Deserialize, Serialize}; use super::ownership::get_projects_ownership; use crate::database::models::{DBOrganization, DBOrganizationId}; use crate::models::ids::OrganizationId; +use crate::models::projects::AutoApprovalCause; use crate::routes::v3::organizations::OrganizationIds; use crate::routes::v3::users::UserIds; use crate::{ @@ -1323,7 +1324,13 @@ pub async fn submit_report( if prepared.is_none() && removed.rows_affected() > 0 { prepared = Some(crate::routes::v3::projects::mutation::prepare_technical_review_exits( - &[project_id], &mut txn, &pool, &redis, + &[project_id], + AutoApprovalCause::ModeratorTechnicalReviewPass { + user_id: user.user.id, + }, + &mut txn, + &pool, + &redis, ).await?); } @@ -1384,7 +1391,7 @@ pub async fn update_issue_details( session_queue: web::Data, update_reqs: web::Json>, ) -> Result<(), ApiError> { - get_user_from_headers( + let user = get_user_from_headers( &req, &**pool, &redis, @@ -1519,6 +1526,9 @@ pub async fn update_issue_details( let prepared = crate::routes::v3::projects::mutation::prepare_technical_review_exits( &exited_projects, + AutoApprovalCause::LocalVerdictsUpdated { + user_id: user.user.id, + }, &mut txn, &pool, &redis, @@ -1547,7 +1557,7 @@ pub async fn update_global_issue_details( session_queue: web::Data, update_reqs: web::Json>, ) -> Result<(), ApiError> { - get_user_from_headers( + let user = get_user_from_headers( &req, &**pool, &redis, @@ -1660,6 +1670,9 @@ pub async fn update_global_issue_details( let prepared = crate::routes::v3::projects::mutation::prepare_technical_review_exits( &exited_projects, + AutoApprovalCause::GlobalVerdictsUpdated { + user_id: user.user.id, + }, &mut txn, &pool, &redis, diff --git a/apps/labrinth/src/routes/internal/moderation/tech_review/rules_scan.rs b/apps/labrinth/src/routes/internal/moderation/tech_review/rules_scan.rs index 82846b3a982..05a60a7b009 100644 --- a/apps/labrinth/src/routes/internal/moderation/tech_review/rules_scan.rs +++ b/apps/labrinth/src/routes/internal/moderation/tech_review/rules_scan.rs @@ -17,6 +17,7 @@ use utoipa::{PartialSchema, ToSchema}; use xredis::RedisPool; use super::rules::{DelphiRuleEffect, DelphiRuleOutput}; +use crate::models::projects::AutoApprovalCause; use crate::routes::internal::delphi::tech_review_queue::{ self, TechReviewRemovalReason, }; @@ -353,7 +354,7 @@ pub async fn scan_rules( redis: web::Data, session_queue: web::Data, ) -> Result { - get_user_from_headers( + let user = get_user_from_headers( &req, &**pool, &redis, @@ -400,8 +401,9 @@ pub async fn scan_rules( let (sender, receiver) = mpsc::unbounded_channel(); let _ = sender.send(Bytes::from_static(b": connected\n\n")); + let user_id = user.user.id; actix_web::rt::spawn(async move { - match run_scan(transaction, &sender, &pool, &redis).await { + match run_scan(transaction, &sender, &pool, &redis, user_id).await { Ok(summary) => { let event = RuleScanEvent { phase: "complete", @@ -463,6 +465,7 @@ async fn run_scan( sender: &mpsc::UnboundedSender, pool: &PgPool, redis: &RedisPool, + user_id: ariadne::ids::UserId, ) -> Result { let project_ids = sqlx::query!( r#" @@ -797,6 +800,7 @@ async fn run_scan( let prepared = crate::routes::v3::projects::mutation::prepare_technical_review_exits( &exited_projects, + AutoApprovalCause::RulesChanged { revision, user_id }, &mut transaction, pool, redis, diff --git a/apps/labrinth/src/routes/v3/projects/mod.rs b/apps/labrinth/src/routes/v3/projects/mod.rs index 73d092b6fbf..4790782c19b 100644 --- a/apps/labrinth/src/routes/v3/projects/mod.rs +++ b/apps/labrinth/src/routes/v3/projects/mod.rs @@ -27,7 +27,8 @@ use crate::models::link_platform::LinkPlatform; use crate::models::notifications::NotificationBody; use crate::models::pats::Scopes; use crate::models::projects::{ - MonetizationStatus, Project, ProjectStatus, SideTypesMigrationReviewStatus, + ApprovalReason, AutoApprovalCause, MonetizationStatus, Project, + ProjectStatus, SideTypesMigrationReviewStatus, }; use crate::models::teams::{DEFAULT_ROLE, ProjectPermissions}; use crate::models::threads::MessageBody; @@ -731,13 +732,24 @@ pub async fn project_edit_internal( if status.is_approved() && !project_item.inner.status.is_approved() { + let reason = + serde_json::to_value(ApprovalReason::ByUser(user.user.id)) + .wrap_internal_err( + "serializing project approval reason", + )?; sqlx::query!( " UPDATE mods - SET approved = COALESCE(approved, NOW()), initial_queued = NULL + SET approved_because = CASE + WHEN approved IS NULL THEN $2::jsonb + ELSE approved_because + END, + approved = COALESCE(approved, NOW()), + initial_queued = NULL WHERE id = $1 ", id as db_ids::DBProjectId, + reason, ) .execute(&mut transaction) .await @@ -1614,7 +1626,15 @@ async fn submit_project_for_review( state.status(), ProjectStatus::Rejected | ProjectStatus::Withheld ) - && state.try_auto_approve(transaction, redis).await? + && state + .try_auto_approve( + AutoApprovalCause::Resubmission { + user_id: user.user.id, + }, + transaction, + redis, + ) + .await? { return Ok(true); } diff --git a/apps/labrinth/src/routes/v3/projects/mutation.rs b/apps/labrinth/src/routes/v3/projects/mutation.rs index eafbc23bcbf..566fd7c1a33 100644 --- a/apps/labrinth/src/routes/v3/projects/mutation.rs +++ b/apps/labrinth/src/routes/v3/projects/mutation.rs @@ -13,7 +13,10 @@ use crate::database::{PgPool, PgTransaction, models as db_models}; use crate::models::ids::ProjectId; use crate::models::notifications::NotificationBody; use crate::models::pats::Scopes; -use crate::models::projects::{Project, ProjectStatus, Version}; +use crate::models::projects::{ + ApprovalProvenance, ApprovalReason, AutoApprovalCause, Project, + ProjectStatus, Version, +}; use crate::models::thread_issues::{ ThreadIssueContext, ThreadIssueTarget, ThreadIssueTeamMember, ThreadIssueValueState, ThreadIssueVerdict, @@ -83,6 +86,7 @@ impl SyncedProjectState { pub(crate) async fn try_auto_approve( &mut self, + cause: AutoApprovalCause, transaction: &mut PgTransaction<'_>, redis: &RedisPool, ) -> Result { @@ -90,15 +94,35 @@ impl SyncedProjectState { return Ok(false); }; let old_status = self.project.status; + let provenance = ApprovalProvenance { + trigger: cause, + previous_status: old_status, + resolved_issue_ids: self + .thread_issues + .iter() + .map(|issue| issue.id.into()) + .collect(), + }; + let reason = + serde_json::to_value(ApprovalReason::Auto(provenance.clone())) + .wrap_internal_err( + "serializing project auto-approval reason", + )?; sqlx::query!( r#" UPDATE mods - SET status = $1, approved = COALESCE(approved, NOW()) + SET status = $1, + approved_because = CASE + WHEN approved IS NULL THEN $3::jsonb + ELSE approved_because + END, + approved = COALESCE(approved, NOW()) WHERE id = $2 "#, new_status.as_str(), self.data.inner.id as DBProjectId, + reason, ) .execute(&mut *transaction) .await @@ -111,6 +135,7 @@ impl SyncedProjectState { body: MessageBody::AutoApproval { old_status, new_status, + provenance: Some(provenance), }, thread_id: self.data.thread_id, hide_identity: false, @@ -199,7 +224,13 @@ pub(crate) async fn sync_project_state( if exited_projects.contains(&project_id) && state.status() == ProjectStatus::Processing { - state.try_auto_approve(transaction, redis).await?; + state + .try_auto_approve( + AutoApprovalCause::TechnicalReviewNoDetails, + transaction, + redis, + ) + .await?; } Ok(state) } @@ -416,6 +447,7 @@ pub(crate) struct PreparedMutations { pub(crate) async fn prepare_technical_review_exits( project_ids: &[DBProjectId], + cause: AutoApprovalCause, transaction: &mut PgTransaction<'_>, pool: &PgPool, redis: &RedisPool, @@ -429,7 +461,9 @@ pub(crate) async fn prepare_technical_review_exits( let mut state = load_project_state(project_id, transaction, pool, redis).await?; if state.status() == ProjectStatus::Processing { - state.try_auto_approve(transaction, redis).await?; + state + .try_auto_approve(cause.clone(), transaction, redis) + .await?; } states.push(state); } @@ -466,7 +500,13 @@ pub(crate) async fn prepare_mutations( if exited_projects.contains(&project_id) && state.status() == ProjectStatus::Processing { - state.try_auto_approve(transaction, redis).await?; + state + .try_auto_approve( + AutoApprovalCause::TechnicalReviewNoDetails, + transaction, + redis, + ) + .await?; } states.push(state); } @@ -600,3 +640,84 @@ pub(crate) async fn finalize_project_edit( Ok(()) } + +#[cfg(test)] +mod tests { + use super::*; + use crate::models::ids::ThreadIssueId; + use ariadne::ids::UserId; + use serde_json::json; + + #[test] + fn historical_auto_approval_message_has_no_provenance() { + let value = json!({ + "type": "auto_approval", + "old_status": "processing", + "new_status": "approved" + }); + let message: MessageBody = + serde_json::from_value(value.clone()).unwrap(); + assert!(matches!( + &message, + MessageBody::AutoApproval { + provenance: None, + .. + } + )); + assert_eq!(serde_json::to_value(message).unwrap(), value); + } + + #[test] + fn thread_and_database_share_approval_provenance() { + let provenance = ApprovalProvenance { + trigger: AutoApprovalCause::Resubmission { user_id: UserId(1) }, + previous_status: ProjectStatus::Rejected, + resolved_issue_ids: vec![ThreadIssueId(2)], + }; + let reason = + serde_json::to_value(ApprovalReason::Auto(provenance.clone())) + .unwrap(); + let message = MessageBody::AutoApproval { + old_status: ProjectStatus::Rejected, + new_status: ProjectStatus::Approved, + provenance: Some(provenance), + }; + let value = serde_json::to_value(message).unwrap(); + assert_eq!(reason["Auto"], value["provenance"]); + let round_trip: MessageBody = + serde_json::from_value(value.clone()).unwrap(); + assert_eq!(serde_json::to_value(round_trip).unwrap(), value); + } + + #[test] + fn manual_approval_reason_serializes_user_id() { + assert_eq!( + serde_json::to_value(ApprovalReason::ByUser(UserId(1))).unwrap(), + json!({ "ByUser": "1" }), + ); + } + + #[test] + fn auto_approval_reason_serializes_evidence() { + let reason = ApprovalReason::Auto(ApprovalProvenance { + trigger: AutoApprovalCause::ModeratorTechnicalReviewPass { + user_id: UserId(1), + }, + previous_status: ProjectStatus::Processing, + resolved_issue_ids: vec![ThreadIssueId(2)], + }); + assert_eq!( + serde_json::to_value(reason).unwrap(), + json!({ + "Auto": { + "trigger": { + "type": "moderator_technical_review_pass", + "user_id": "1" + }, + "previous_status": "processing", + "resolved_issue_ids": ["2"] + } + }), + ); + } +} diff --git a/packages/api-client/src/modules/labrinth/types.ts b/packages/api-client/src/modules/labrinth/types.ts index a24cddb9fec..73f40a36599 100644 --- a/packages/api-client/src/modules/labrinth/types.ts +++ b/packages/api-client/src/modules/labrinth/types.ts @@ -1068,6 +1068,21 @@ export namespace Labrinth { | 'client_or_server_prefers_both' | 'unknown' + export type AutoApprovalCause = + | { type: 'resubmission'; user_id: string } + | { type: 'technical_review_no_details' } + | { type: 'scan_completed'; report_id: number; scan_id: string } + | { type: 'rules_changed'; revision: number; user_id: string } + | { type: 'moderator_technical_review_pass'; user_id: string } + | { type: 'local_verdicts_updated'; user_id: string } + | { type: 'global_verdicts_updated'; user_id: string } + + export type ApprovalProvenance = { + trigger: AutoApprovalCause + previous_status: Projects.v2.ProjectStatus + resolved_issue_ids: string[] + } + export type GalleryItem = { id?: number url: string @@ -2305,6 +2320,7 @@ export namespace Labrinth { type: 'auto_approval' new_status: Projects.v2.ProjectStatus old_status: Projects.v2.ProjectStatus + provenance?: Projects.v3.ApprovalProvenance } | { type: 'tech_review'