Merge pull request #21 from geode-sdk/superseded

Fleeym · web-flow · commit 7eee019f7b80 · 2024-05-30T19:18:13.000+03:00
Add support for replacing mods through incompatibilities
diff --git a/migrations/20240529222223_change_version_collation.up.sql b/migrations/20240529222223_change_version_collation.up.sql
@@ -0,0 +1,21 @@
+-- Add up migration script here
+
+CREATE COLLATION IF NOT EXISTS en_natural (
+   LOCALE = 'en-US-u-kn-true',
+   PROVIDER = 'icu'
+);
+
+ALTER TABLE incompatibilities
+ALTER COLUMN version 
+    SET DATA TYPE TEXT 
+    COLLATE "en_natural";
+
+ALTER TABLE dependencies 
+ALTER COLUMN version 
+    SET DATA TYPE TEXT 
+    COLLATE "en_natural";
+
+ALTER TABLE mod_versions
+ALTER COLUMN version 
+    SET DATA TYPE TEXT 
+    COLLATE "en_natural";
diff --git a/openapi.yml b/openapi.yml
@@ -452,7 +452,13 @@ paths:
           content:
             application/json:
               schema:
-                type: string
+                type: object
+                properties:
+                  error:
+                    type: "null"
+                  payload:
+                    type: array
+                    items: "#/components/schemas/ModUpdate"
 
   /v1/mods/{id}/developers:
     post:
@@ -677,6 +683,80 @@ components:
             - type: "null"
             - $ref: "#/components/schemas/GDVersionString"
 
+    ModUpdate:
+      type: object
+      properties:
+        id:
+          $ref: "#/components/schemas/ModID"
+        version:
+          $ref: "#/components/schemas/ModVersionString"
+        download_link:
+          type: string
+          examples:
+            - "https://api.geode-sdk.com/v1/mods/geode.nodeids/versions/1.0.0/download"
+            - "https://api.geode-sdk.com/v1/mods/geode.devtools/versions/1.0.0/download"
+        replacement:
+          oneOf:
+            - "null"
+            - $ref: "#/components/schemas/ModReplacement"
+        dependencies:
+          type: array
+          items:
+            $ref: "#/components/schemas/ModDependency"
+        incompatibilities:
+          type: array
+          items:
+            $ref: "#/components/schemas/ModIncompatibility"
+
+    ModReplacement:
+      type: object
+      properties:
+        id:
+          $ref: "#/components/schemas/ModID"
+        version:
+          $ref: "#/components/schemas/ModVersionString"
+        download_link:
+          type: string
+          examples:
+            - "https://api.geode-sdk.com/v1/mods/geode.nodeids/versions/1.0.0/download"
+            - "https://api.geode-sdk.com/v1/mods/geode.devtools/versions/1.0.0/download"
+        dependencies:
+          type: array
+          items:
+            $ref: "#/components/schemas/ModDependency"
+        incompatibilities:
+          type: array
+          items:
+            $ref: "#/components/schemas/ModIncompatibility"
+
+    ModDependency:
+      type: object
+      properties:
+        mod_id:
+          $ref: "#/components/schemas/ModID"
+        version:
+          type: string
+          examples:
+            - ">1.0.0"
+            - "*"
+            - "<=2.0.0"
+        importance:
+          $ref: "#/components/schemas/DependencyImportance"
+
+    ModIncompatibility:
+      type: object
+      properties:
+        mod_id:
+          $ref: "#/components/schemas/ModID"
+        version:
+          type: string
+          examples:
+            - ">1.0.0"
+            - "*"
+            - "<=2.0.0"
+        importance:
+          $ref: "#/components/schemas/IncompatibilityImportance"
+
     Mod:
       type: object
       properties:
@@ -756,9 +836,16 @@ components:
           type: array
           items:
             type: string
-
         mod_id:
           $ref: "#/components/schemas/ModID"
+        dependencies:
+          type: array
+          items:
+            $ref: "#/components/schemas/ModDependency"
+        incompatibilities:
+          type: array
+          items:
+            $ref: "#/components/schemas/ModIncompatibility"
 
     ModVersionStatus:
       type: string
@@ -768,6 +855,20 @@ components:
         - pending
         - unlisted
 
+    DependencyImportance:
+      type: string
+      enum:
+        - suggested
+        - recommended
+        - required
+
+    IncompatibilityImportance:
+      type: string
+      enum:
+        - breaking
+        - conflicting
+        - superseded
+
     ModDeveloper:
       type: object
       properties:
diff --git a/src/endpoints/mods.rs b/src/endpoints/mods.rs
@@ -5,6 +5,7 @@ use sqlx::Acquire;
 use crate::extractors::auth::Auth;
 use crate::types::api::{create_download_link, ApiError, ApiResponse};
 use crate::types::mod_json::ModJson;
+use crate::types::models::incompatibility::Incompatibility;
 use crate::types::models::mod_entity::{download_geode_file, Mod, ModUpdate};
 use crate::types::models::mod_gd_version::{GDVersionEnum, VerPlatform};
 use crate::types::models::mod_version_status::ModVersionStatusEnum;
@@ -139,8 +140,15 @@ pub async fn get_mod_updates(
 
     let platforms: Vec<VerPlatform> = vec![];
 
-    let mut result: Vec<ModUpdate> = Mod::get_updates(ids, platforms, &mut pool).await?;
+    let mut result: Vec<ModUpdate> = Mod::get_updates(&ids, platforms, &mut pool).await?;
+    let replacements = Incompatibility::get_supersedes_for(&ids, &mut pool).await?;
+
     for i in &mut result {
+        if let Some(replacement) = replacements.get(&i.id) {
+            let mut clone = replacement.clone();
+            clone.download_link = create_download_link(&data.app_url, &clone.id, &clone.version);
+            i.replacement = Some(clone);
+        }
         i.download_link = create_download_link(&data.app_url, &i.id, &i.version);
     }
 
diff --git a/src/types/models/incompatibility.rs b/src/types/models/incompatibility.rs
@@ -5,6 +5,8 @@ use crate::types::models::dependency::ModVersionCompare;
 use serde::{Deserialize, Serialize};
 use sqlx::{PgConnection, Postgres, QueryBuilder};
 
+use super::dependency::ResponseDependency;
+
 #[derive(sqlx::FromRow, Clone, Debug)]
 pub struct FetchedIncompatibility {
     pub mod_id: i32,
@@ -29,7 +31,18 @@ pub struct Incompatibility {
     pub importance: IncompatibilityImportance,
 }
 
-#[derive(sqlx::Type, Debug, Serialize, Clone, Copy, Deserialize)]
+#[derive(Debug, Serialize, Clone)]
+pub struct Replacement {
+    pub id: String,
+    pub version: String,
+    #[serde(skip_serializing)]
+    pub replacement_id: i32,
+    pub download_link: String,
+    pub dependencies: Vec<ResponseDependency>,
+    pub incompatibilities: Vec<ResponseIncompatibility>,
+}
+
+#[derive(sqlx::Type, Debug, Serialize, Clone, Copy, Deserialize, PartialEq)]
 #[sqlx(type_name = "incompatibility_importance", rename_all = "lowercase")]
 #[serde(rename_all = "lowercase")]
 pub enum IncompatibilityImportance {
@@ -128,7 +141,7 @@ impl Incompatibility {
             icp.incompatibility_id, icp.mod_id, icp.version FROM incompatibilities icp
             INNER JOIN mod_versions mv ON mv.id = icp.mod_id
             WHERE mv.id = ANY($1)"#,
-            &ids
+            &ids,
         )
         .fetch_all(&mut *pool)
         .await
@@ -147,4 +160,63 @@ impl Incompatibility {
 
         Ok(ret)
     }
+
+    pub async fn get_supersedes_for(
+        ids: &Vec<String>,
+        pool: &mut PgConnection,
+    ) -> Result<HashMap<String, Replacement>, ApiError> {
+        let mut ret: HashMap<String, Replacement> = HashMap::new();
+        let r = match sqlx::query!(
+            r#"
+            SELECT 
+                q.replaced,
+                q.replacement,
+                q.replacement_version,
+                q.replacement_id
+            FROM (
+                SELECT 
+                    replaced.incompatibility_id AS replaced, 
+                    replacement.mod_id AS replacement, 
+                    replacement.version AS replacement_version,
+                    replacement.id AS replacement_id,
+                    ROW_NUMBER() OVER(
+                        partition by replacement.mod_id 
+                        order by replacement.version desc
+                    ) rn
+                FROM incompatibilities replaced
+                INNER JOIN mod_versions replacement ON replacement.id = replaced.mod_id
+                INNER JOIN mod_version_statuses replacement_status 
+                    ON replacement.status_id = replacement_status.id
+                WHERE replaced.importance = 'superseded'
+                AND replacement_status.status = 'accepted'
+                AND replaced.incompatibility_id = ANY($1)
+                ORDER BY replacement.id DESC, replacement.version DESC
+            ) q
+            WHERE q.rn = 1
+            "#,
+            ids
+        )
+        .fetch_all(&mut *pool)
+        .await
+        {
+            Err(e) => {
+                log::error!("Failed to fetch supersedes. ERR: {}", e);
+                return Err(ApiError::DbError);
+            }
+            Ok(r) => r,
+        };
+
+        for i in r.iter() {
+            ret.entry(i.replaced.clone()).or_insert(Replacement {
+                id: i.replacement.clone(),
+                version: i.replacement_version.clone(),
+                replacement_id: i.replacement_id,
+                // Should be completed later
+                download_link: "".to_string(),
+                dependencies: vec![],
+                incompatibilities: vec![],
+            });
+        }
+        Ok(ret)
+    }
 }
diff --git a/src/types/models/mod_entity.rs b/src/types/models/mod_entity.rs
@@ -8,7 +8,7 @@ use crate::{
         mod_json::ModJson,
         models::{
             dependency::{Dependency, FetchedDependency},
-            incompatibility::{FetchedIncompatibility, Incompatibility},
+            incompatibility::{FetchedIncompatibility, Incompatibility, IncompatibilityImportance},
             mod_version::ModVersion, mod_version_status::ModVersionStatusEnum,
         },
     },
@@ -26,7 +26,7 @@ use std::{collections::HashMap, io::Cursor, str::FromStr};
 use super::{
     dependency::ResponseDependency,
     developer::{Developer, FetchedDeveloper},
-    incompatibility::ResponseIncompatibility,
+    incompatibility::{Replacement, ResponseIncompatibility},
     mod_gd_version::{DetailedGDVersion, GDVersionEnum, ModGDVersion, VerPlatform},
     tag::Tag,
 };
@@ -50,7 +50,10 @@ pub struct Mod {
 pub struct ModUpdate {
     pub id: String,
     pub version: String,
+    #[serde(skip_serializing)]
+    pub mod_version_id: i32,
     pub download_link: String,
+    pub replacement: Option<Replacement>,
     pub dependencies: Vec<ResponseDependency>,
     pub incompatibilities: Vec<ResponseIncompatibility>,
 }
@@ -1092,18 +1095,27 @@ impl Mod {
     }
 
     pub async fn get_updates(
-        ids: Vec<String>,
+        ids: &Vec<String>,
         platforms: Vec<VerPlatform>,
         pool: &mut PgConnection,
     ) -> Result<Vec<ModUpdate>, ApiError> {
         let mut query_builder: QueryBuilder<Postgres> = QueryBuilder::new(
-            "SELECT q.id, q.version, q.mod_version_id FROM (SELECT m.id, mv.version, mv.id as mod_version_id,
-            row_number() over (partition by m.id order by mv.id desc) rn FROM mods m
-            INNER JOIN mod_versions mv ON mv.mod_id = m.id 
-            INNER JOIN mod_version_statuses mvs ON mvs.mod_version_id = mv.id
-            WHERE mvs.status = 'accepted' AND m.id = ANY(",
+            r#"SELECT 
+                q.id, 
+                q.inner_version as version, 
+                q.mod_version_id
+            FROM (
+                SELECT m.id, 
+                    mv.id as mod_version_id,
+                    mv.version as inner_version,
+                    row_number() over (partition by m.id order by mv.version desc) rn 
+                FROM mods m
+                INNER JOIN mod_versions mv ON mv.mod_id = m.id 
+                INNER JOIN mod_version_statuses mvs ON mvs.mod_version_id = mv.id
+                WHERE mvs.status = 'accepted' 
+                    AND m.id = ANY("#,
         );
-        query_builder.push_bind(&ids);
+        query_builder.push_bind(ids);
         query_builder.push(") ");
 
         if !platforms.is_empty() {
@@ -1150,8 +1162,9 @@ impl Mod {
 
         for r in result {
             let update = ModUpdate {
-                id: r.id,
+                id: r.id.clone(),
                 version: r.version,
+                mod_version_id: r.mod_version_id,
                 download_link: "".to_string(),
                 dependencies: deps
                     .get(&r.mod_version_id)
@@ -1167,6 +1180,7 @@ impl Mod {
                     .iter()
                     .map(|x| x.to_response())
                     .collect(),
+                replacement: None
             };
             ret.push(update);
         }
@@ -1213,4 +1227,4 @@ async fn get_download_size(url: &str) -> Result<u64, ApiError> {
             "Couldn't extract download size from URL".to_string(),
         )),
     }
-}
+}
diff --git a/src/types/models/mod_version.rs b/src/types/models/mod_version.rs
