Merge branch 'release/v0.13.4'

ja573 · ja573 · commit 2e496210ac75 · 2024-12-11T10:30:23.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+
+## [[0.13.4]](https://github.com/thoth-pub/thoth/releases/tag/v0.13.4) - 2024-12-11
+### Added
+  - [661](https://github.com/thoth-pub/thoth/pull/661) - Implement caching errors in export API
+
 ## [[0.13.3]](https://github.com/thoth-pub/thoth/releases/tag/v0.13.3) - 2024-12-02
 ### Changed
   - [660](https://github.com/thoth-pub/thoth/pull/660) - Upgrade rust to `1.83.0` in production `Dockerfile`
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "thoth"
-version = "0.13.3"
+version = "0.13.4"
 authors = ["Javier Arias <javi@thoth.pub>", "Ross Higman <ross@thoth.pub>"]
 edition = "2021"
 license = "Apache-2.0"
@@ -15,11 +15,11 @@ maintenance = { status = "actively-developed" }
 members = ["thoth-api", "thoth-api-server", "thoth-app", "thoth-app-server", "thoth-client", "thoth-errors", "thoth-export-server"]
 
 [dependencies]
-thoth-api = { version = "=0.13.3", path = "thoth-api", features = ["backend"] }
-thoth-api-server = { version = "=0.13.3", path = "thoth-api-server" }
-thoth-app-server = { version = "=0.13.3", path = "thoth-app-server" }
-thoth-errors = { version = "=0.13.3", path = "thoth-errors" }
-thoth-export-server = { version = "=0.13.3", path = "thoth-export-server" }
+thoth-api = { version = "=0.13.4", path = "thoth-api", features = ["backend"] }
+thoth-api-server = { version = "=0.13.4", path = "thoth-api-server" }
+thoth-app-server = { version = "=0.13.4", path = "thoth-app-server" }
+thoth-errors = { version = "=0.13.4", path = "thoth-errors" }
+thoth-export-server = { version = "=0.13.4", path = "thoth-export-server" }
 clap = { version = "4.5.21", features = ["cargo", "env"] }
 dialoguer = { version = "0.11.0", features = ["password"] }
 dotenv = "0.15.0"
diff --git a/thoth-api-server/Cargo.toml b/thoth-api-server/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "thoth-api-server"
-version = "0.13.3"
+version = "0.13.4"
 authors = ["Javier Arias <javi@thoth.pub>", "Ross Higman <ross@thoth.pub>"]
 edition = "2021"
 license = "Apache-2.0"
@@ -9,8 +9,8 @@ repository = "https://github.com/thoth-pub/thoth"
 readme = "README.md"
 
 [dependencies]
-thoth-api = { version = "=0.13.3", path = "../thoth-api", features = ["backend"] }
-thoth-errors = { version = "=0.13.3", path = "../thoth-errors" }
+thoth-api = { version = "=0.13.4", path = "../thoth-api", features = ["backend"] }
+thoth-errors = { version = "=0.13.4", path = "../thoth-errors" }
 actix-web = "4.9"
 actix-cors = "0.7.0"
 actix-http = "3.9.0"
diff --git a/thoth-api/Cargo.toml b/thoth-api/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "thoth-api"
-version = "0.13.3"
+version = "0.13.4"
 authors = ["Javier Arias <javi@thoth.pub>", "Ross Higman <ross@thoth.pub>"]
 edition = "2021"
 license = "Apache-2.0"
@@ -15,7 +15,7 @@ maintenance = { status = "actively-developed" }
 backend = ["diesel", "diesel-derive-enum", "diesel_migrations", "futures", "actix-web", "jsonwebtoken", "deadpool-redis"]
 
 [dependencies]
-thoth-errors = { version = "=0.13.3", path = "../thoth-errors" }
+thoth-errors = { version = "=0.13.4", path = "../thoth-errors" }
 actix-web = { version = "4.9", optional = true }
 argon2rs = "0.2.5"
 isbn2 = "0.4.0"
diff --git a/thoth-api/src/model/subject/mod.rs b/thoth-api/src/model/subject/mod.rs
@@ -123,22 +123,13 @@ pub struct NewSubjectHistory {
 }
 
 pub fn check_subject(subject_type: &SubjectType, code: &str) -> ThothResult<()> {
-    let valid = match &subject_type {
-        SubjectType::Bic => true,
-        SubjectType::Bisac => true,
-        SubjectType::Thema => THEMA_CODES.contains_key::<str>(code),
-        SubjectType::Lcc => true,
-        SubjectType::Custom => true,
-        SubjectType::Keyword => true,
-    };
-    if valid {
-        Ok(())
-    } else {
-        Err(ThothError::InvalidSubjectCode(
-            code.to_string(),
-            subject_type.to_string(),
-        ))
+    if matches!(subject_type, SubjectType::Thema) && !THEMA_CODES.contains_key(code) {
+        return Err(ThothError::InvalidSubjectCode {
+            input: code.to_string(),
+            subject_type: subject_type.to_string(),
+        });
     }
+    Ok(())
 }
 
 impl Default for Subject {
diff --git a/thoth-api/src/redis.rs b/thoth-api/src/redis.rs
@@ -26,6 +26,11 @@ pub async fn get(pool: &RedisPool, key: &str) -> ThothResult<String> {
     con.get(key).await.map_err(Into::into)
 }
 
+pub async fn del(pool: &RedisPool, key: &str) -> ThothResult<String> {
+    let mut con = create_connection(pool).await?;
+    con.del(key).await.map_err(Into::into)
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
diff --git a/thoth-app-server/Cargo.toml b/thoth-app-server/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "thoth-app-server"
-version = "0.13.3"
+version = "0.13.4"
 authors = ["Javier Arias <javi@thoth.pub>", "Ross Higman <ross@thoth.pub>"]
 edition = "2021"
 license = "Apache-2.0"
diff --git a/thoth-app/Cargo.toml b/thoth-app/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "thoth-app"
-version = "0.13.3"
+version = "0.13.4"
 authors = ["Javier Arias <javi@thoth.pub>", "Ross Higman <ross@thoth.pub>"]
 edition = "2021"
 license = "Apache-2.0"
@@ -29,8 +29,8 @@ semver = "1.0.23"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 uuid = { version = "1.11.0", features = ["serde", "v4", "js"] }
-thoth-api = { version = "=0.13.3", path = "../thoth-api"  }
-thoth-errors = { version = "=0.13.3", path = "../thoth-errors" }
+thoth-api = { version = "=0.13.4", path = "../thoth-api"  }
+thoth-errors = { version = "=0.13.4", path = "../thoth-errors" }
 
 [build-dependencies]
 dotenv = "0.15.0"
diff --git a/thoth-client/Cargo.toml b/thoth-client/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "thoth-client"
-version = "0.13.3"
+version = "0.13.4"
 authors = ["Javier Arias <javi@thoth.pub>", "Ross Higman <ross@thoth.pub>"]
 edition = "2021"
 license = "Apache-2.0"
@@ -10,8 +10,8 @@ readme = "README.md"
 build = "build.rs"
 
 [dependencies]
-thoth-api = {version = "=0.13.3", path = "../thoth-api" }
-thoth-errors = {version = "=0.13.3", path = "../thoth-errors" }
+thoth-api = {version = "=0.13.4", path = "../thoth-api" }
+thoth-errors = {version = "=0.13.4", path = "../thoth-errors" }
 graphql_client = "0.14.0"
 chrono = { version = "0.4.38", features = ["serde"] }
 reqwest = { version = "0.12", features = ["json"] }
@@ -22,4 +22,4 @@ serde_json = "1.0"
 uuid = { version = "1.11.0", features = ["serde"] }
 
 [build-dependencies]
-thoth-api = { version = "=0.13.3", path = "../thoth-api", features = ["backend"] }
+thoth-api = { version = "=0.13.4", path = "../thoth-api", features = ["backend"] }
diff --git a/thoth-errors/Cargo.toml b/thoth-errors/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "thoth-errors"
-version = "0.13.3"
+version = "0.13.4"
 authors = ["Javier Arias <javi@thoth.pub>", "Ross Higman <ross@thoth.pub>"]
 edition = "2021"
 license = "Apache-2.0"
diff --git a/thoth-errors/src/database_errors.rs b/thoth-errors/src/database_errors.rs
@@ -1,5 +1,5 @@
-use phf::phf_map;
-use phf::Map;
+use phf::{phf_map, Map};
+use std::borrow::Cow;
 
 use crate::ThothError;
 
@@ -173,7 +173,7 @@ impl From<diesel::result::Error> for ThothError {
             Error::DatabaseError(_kind, info) => {
                 if let Some(constraint_name) = info.constraint_name() {
                     if let Some(error) = DATABASE_CONSTRAINT_ERRORS.get(constraint_name) {
-                        return ThothError::DatabaseConstraintError(error);
+                        return ThothError::DatabaseConstraintError(Cow::Borrowed(error));
                     }
                 }
                 ThothError::DatabaseError(info.message().to_string())
@@ -251,9 +251,9 @@ mod tests {
                 DatabaseErrorKind::UniqueViolation,
                 error_information
             )),
-            ThothError::DatabaseConstraintError(
+            ThothError::DatabaseConstraintError(Cow::Borrowed(
                 "A contribution with this ordinal number already exists."
-            )
+            ))
         )
     }
     #[test]
diff --git a/thoth-errors/src/lib.rs b/thoth-errors/src/lib.rs
@@ -2,27 +2,27 @@
 mod database_errors;
 
 use core::convert::From;
-use serde::Deserialize;
-use std::fmt;
+use serde::{Deserialize, Serialize};
+use std::{borrow::Cow, fmt};
 use thiserror::Error;
 
 /// A specialised result type for returning Thoth data
-pub type ThothResult<T> = std::result::Result<T, ThothError>;
+pub type ThothResult<T> = Result<T, ThothError>;
 
-#[derive(Error, Debug, PartialEq, Eq)]
+#[derive(Error, Debug, PartialEq, Eq, Serialize, Deserialize)]
 /// Represents anything that can go wrong in Thoth
 ///
 /// This type is not intended to be exhaustively matched, and new variants may
 /// be added in the future without a major version bump.
 pub enum ThothError {
-    #[error("{0} is not a valid {1} code")]
-    InvalidSubjectCode(String, String),
+    #[error("{input:?} is not a valid {subject_type:?} code")]
+    InvalidSubjectCode { input: String, subject_type: String },
     #[error("Database error: {0}")]
     DatabaseError(String),
     #[error("Redis error: {0}")]
     RedisError(String),
     #[error("{0}")]
-    DatabaseConstraintError(&'static str),
+    DatabaseConstraintError(Cow<'static, str>),
     #[error("Internal error: {0}")]
     InternalError(String),
     #[error("Invalid credentials.")]
@@ -109,6 +109,18 @@ pub enum ThothError {
     ThothUpdateCanonicalError,
 }
 
+impl ThothError {
+    /// Serialise to JSON
+    pub fn to_json(&self) -> ThothResult<String> {
+        serde_json::to_string(&self).map_err(Into::into)
+    }
+
+    /// Deserialise from JSON
+    pub fn from_json(s: &str) -> ThothResult<ThothError> {
+        serde_json::from_str(s).map_err(Into::into)
+    }
+}
+
 #[cfg(not(target_arch = "wasm32"))]
 impl juniper::IntoFieldError for ThothError {
     fn into_field_error(self) -> juniper::FieldError {
@@ -293,6 +305,12 @@ impl From<Box<dyn std::error::Error + Send + Sync>> for ThothError {
     }
 }
 
+impl From<serde_json::Error> for ThothError {
+    fn from(e: serde_json::Error) -> Self {
+        ThothError::InternalError(e.to_string())
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -331,4 +349,35 @@ mod tests {
             ThothError::GraphqlError("A relation with this ordinal already exists.".to_string())
         )
     }
+
+    #[test]
+    fn test_round_trip_serialisation() {
+        let original_error = ThothError::InvalidSubjectCode {
+            input: "002".to_string(),
+            subject_type: "BIC".to_string(),
+        };
+        let json = original_error.to_json().unwrap();
+        let deserialised_error = ThothError::from_json(&json).unwrap();
+        assert_eq!(original_error, deserialised_error);
+    }
+
+    #[test]
+    fn test_to_json_valid_error() {
+        let error = ThothError::InvalidSubjectCode {
+            input: "001".to_string(),
+            subject_type: "BIC".to_string(),
+        };
+        let json = error.to_json().unwrap();
+
+        assert!(json.contains("\"InvalidSubjectCode\""));
+        assert!(json.contains("\"001\""));
+        assert!(json.contains("\"BIC\""));
+    }
+
+    #[test]
+    fn test_invalid_json_deserialisation() {
+        let invalid_json = r#"{"UnknownError":"Unexpected field"}"#;
+        let error = ThothError::from_json(invalid_json);
+        assert!(error.is_err());
+    }
 }
diff --git a/thoth-export-server/Cargo.toml b/thoth-export-server/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "thoth-export-server"
-version = "0.13.3"
+version = "0.13.4"
 authors = ["Javier Arias <javi@thoth.pub>", "Ross Higman <ross@thoth.pub>"]
 edition = "2021"
 license = "Apache-2.0"
@@ -10,9 +10,9 @@ readme = "README.md"
 build = "build.rs"
 
 [dependencies]
-thoth-api = { version = "=0.13.3", path = "../thoth-api" }
-thoth-errors = { version = "=0.13.3", path = "../thoth-errors" }
-thoth-client = { version = "=0.13.3", path = "../thoth-client" }
+thoth-api = { version = "=0.13.4", path = "../thoth-api" }
+thoth-errors = { version = "=0.13.4", path = "../thoth-errors" }
+thoth-client = { version = "=0.13.4", path = "../thoth-client" }
 actix-web = "4.9"
 actix-cors = "0.7.0"
 cc_license = "0.1.0"
diff --git a/thoth-export-server/src/record.rs b/thoth-export-server/src/record.rs
diff --git a/thoth-export-server/src/specification/handler.rs b/thoth-export-server/src/specification/handler.rs
