feat: scaffold services/january

crates/core/models/Cargo.toml

@@ -11,9 +11,10 @@ description = "Revolt Backend: API Models"
 [features]
 serde = ["dep:serde", "revolt-permissions/serde", "indexmap/serde"]
 schemas = ["dep:schemars", "revolt-permissions/schemas"]
+utoipa = ["dep:utoipa"]
 validator = ["dep:validator"]
 rocket = ["dep:rocket"]
-partials = ["dep:revolt_optional_struct", "serde", "schemas"]
+partials = ["dep:revolt_optional_struct", "serde", "schemas", "utoipa"]
 
 default = ["serde", "partials", "rocket"]
 
@@ -37,6 +38,7 @@ iso8601-timestamp = { version = "0.2.11", features = ["schema", "bson"] }
 
 # Spec Generation
 schemars = { version = "0.8.8", optional = true, features = ["indexmap1"] }
+utoipa = { version = "4.2.3", optional = true }
 
 # Validation
 validator = { version = "0.16.0", optional = true, features = ["derive"] }

crates/core/models/src/lib.rs

@@ -6,6 +6,10 @@ extern crate serde;
 #[macro_use]
 extern crate schemars;
 
+#[cfg(feature = "utoipa")]
+#[macro_use]
+extern crate utoipa;
+
 #[cfg(feature = "partials")]
 #[macro_use]
 extern crate revolt_optional_struct;
@@ -18,6 +22,7 @@ macro_rules! auto_derived {
         $(
             #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
             #[cfg_attr(feature = "schemas", derive(JsonSchema))]
+            #[cfg_attr(feature = "utoipa", derive(ToSchema))]
             #[derive(Debug, Clone, Eq, PartialEq)]
             $item
         )+

crates/core/result/Cargo.toml

@@ -11,7 +11,9 @@ description = "Revolt Backend: Result and Error types"
 [features]
 serde = ["dep:serde"]
 schemas = ["dep:schemars"]
+utoipa = ["dep:utoipa"]
 rocket = ["dep:rocket", "dep:serde_json"]
+axum = ["dep:axum", "dep:serde_json"]
 okapi = ["dep:revolt_rocket_okapi", "dep:revolt_okapi", "schemas"]
 
 default = ["serde"]
@@ -23,8 +25,12 @@ serde = { version = "1", features = ["derive"], optional = true }
 
 # Spec Generation
 schemars = { version = "0.8.8", optional = true }
+utoipa = { version = "4.2.3", optional = true }
 
 # Rocket
 rocket = { optional = true, version = "0.5.0-rc.2", default-features = false }
 revolt_rocket_okapi = { version = "0.9.1", optional = true }
 revolt_okapi = { version = "0.9.1", optional = true }
+
+# Axum
+axum = { version = "0.7.5", optional = true }

crates/core/result/src/axum.rs

@@ -0,0 +1,81 @@
+use axum::{http::StatusCode, response::IntoResponse, Json};
+
+use crate::{Error, ErrorType};
+
+/// HTTP response builder for Error enum
+impl IntoResponse for Error {
+    fn into_response(self) -> axum::response::Response {
+        let status = match self.error_type {
+            ErrorType::LabelMe => StatusCode::INTERNAL_SERVER_ERROR,
+
+            ErrorType::AlreadyOnboarded => StatusCode::FORBIDDEN,
+
+            ErrorType::UnknownUser => StatusCode::NOT_FOUND,
+            ErrorType::InvalidUsername => StatusCode::BAD_REQUEST,
+            ErrorType::UsernameTaken => StatusCode::CONFLICT,
+            ErrorType::DiscriminatorChangeRatelimited => StatusCode::TOO_MANY_REQUESTS,
+            ErrorType::AlreadyFriends => StatusCode::CONFLICT,
+            ErrorType::AlreadySentRequest => StatusCode::CONFLICT,
+            ErrorType::Blocked => StatusCode::CONFLICT,
+            ErrorType::BlockedByOther => StatusCode::FORBIDDEN,
+            ErrorType::NotFriends => StatusCode::FORBIDDEN,
+            ErrorType::TooManyPendingFriendRequests { .. } => StatusCode::BAD_REQUEST,
+
+            ErrorType::UnknownChannel => StatusCode::NOT_FOUND,
+            ErrorType::UnknownMessage => StatusCode::NOT_FOUND,
+            ErrorType::UnknownAttachment => StatusCode::BAD_REQUEST,
+            ErrorType::CannotEditMessage => StatusCode::FORBIDDEN,
+            ErrorType::CannotJoinCall => StatusCode::BAD_REQUEST,
+            ErrorType::TooManyAttachments { .. } => StatusCode::BAD_REQUEST,
+            ErrorType::TooManyReplies { .. } => StatusCode::BAD_REQUEST,
+            ErrorType::EmptyMessage => StatusCode::UNPROCESSABLE_ENTITY,
+            ErrorType::PayloadTooLarge => StatusCode::UNPROCESSABLE_ENTITY,
+            ErrorType::CannotRemoveYourself => StatusCode::BAD_REQUEST,
+            ErrorType::GroupTooLarge { .. } => StatusCode::FORBIDDEN,
+            ErrorType::AlreadyInGroup => StatusCode::CONFLICT,
+            ErrorType::NotInGroup => StatusCode::NOT_FOUND,
+            ErrorType::AlreadyPinned => StatusCode::BAD_REQUEST,
+            ErrorType::NotPinned => StatusCode::BAD_REQUEST,
+
+            ErrorType::UnknownServer => StatusCode::NOT_FOUND,
+            ErrorType::InvalidRole => StatusCode::NOT_FOUND,
+            ErrorType::Banned => StatusCode::FORBIDDEN,
+            ErrorType::AlreadyInServer => StatusCode::CONFLICT,
+
+            ErrorType::TooManyServers { .. } => StatusCode::BAD_REQUEST,
+            ErrorType::TooManyEmbeds { .. } => StatusCode::BAD_REQUEST,
+            ErrorType::TooManyEmoji { .. } => StatusCode::BAD_REQUEST,
+            ErrorType::TooManyChannels { .. } => StatusCode::BAD_REQUEST,
+            ErrorType::TooManyRoles { .. } => StatusCode::BAD_REQUEST,
+
+            ErrorType::ReachedMaximumBots => StatusCode::BAD_REQUEST,
+            ErrorType::IsBot => StatusCode::BAD_REQUEST,
+            ErrorType::BotIsPrivate => StatusCode::FORBIDDEN,
+
+            ErrorType::CannotReportYourself => StatusCode::BAD_REQUEST,
+
+            ErrorType::MissingPermission { .. } => StatusCode::FORBIDDEN,
+            ErrorType::MissingUserPermission { .. } => StatusCode::FORBIDDEN,
+            ErrorType::NotElevated => StatusCode::FORBIDDEN,
+            ErrorType::NotPrivileged => StatusCode::FORBIDDEN,
+            ErrorType::CannotGiveMissingPermissions => StatusCode::FORBIDDEN,
+            ErrorType::NotOwner => StatusCode::FORBIDDEN,
+
+            ErrorType::DatabaseError { .. } => StatusCode::INTERNAL_SERVER_ERROR,
+            ErrorType::InternalError => StatusCode::INTERNAL_SERVER_ERROR,
+            ErrorType::InvalidOperation => StatusCode::BAD_REQUEST,
+            ErrorType::InvalidCredentials => StatusCode::UNAUTHORIZED,
+            ErrorType::InvalidProperty => StatusCode::BAD_REQUEST,
+            ErrorType::InvalidSession => StatusCode::UNAUTHORIZED,
+            ErrorType::DuplicateNonce => StatusCode::CONFLICT,
+            ErrorType::VosoUnavailable => StatusCode::BAD_REQUEST,
+            ErrorType::NotFound => StatusCode::NOT_FOUND,
+            ErrorType::NoEffect => StatusCode::OK,
+            ErrorType::FailedValidation { .. } => StatusCode::BAD_REQUEST,
+
+            ErrorType::ProxyError => StatusCode::BAD_REQUEST,
+        };
+
+        (status, Json(&self)).into_response()
+    }
+}

crates/core/result/src/lib.rs

@@ -8,9 +8,16 @@ extern crate serde;
 #[macro_use]
 extern crate schemars;
 
+#[cfg(feature = "utoipa")]
+#[macro_use]
+extern crate utoipa;
+
 #[cfg(feature = "rocket")]
 pub mod rocket;
 
+#[cfg(feature = "axum")]
+pub mod axum;
+
 #[cfg(feature = "okapi")]
 pub mod okapi;
 
@@ -20,6 +27,7 @@ pub type Result<T, E = Error> = std::result::Result<T, E>;
 /// Error information
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "schemas", derive(JsonSchema))]
+#[cfg_attr(feature = "utoipa", derive(ToSchema))]
 #[derive(Debug, Clone)]
 pub struct Error {
     /// Type of error and additional information
@@ -42,6 +50,7 @@ impl std::error::Error for Error {}
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "serde", serde(tag = "type"))]
 #[cfg_attr(feature = "schemas", derive(JsonSchema))]
+#[cfg_attr(feature = "utoipa", derive(ToSchema))]
 #[derive(Debug, Clone)]
 pub enum ErrorType {
     /// This error was not labeled :(
@@ -145,6 +154,9 @@ pub enum ErrorType {
         error: String,
     },
 
+    // ? Micro-service errors
+    ProxyError,
+
     // ? Legacy errors
     VosoUnavailable,
 }

crates/core/result/src/rocket.rs

@@ -78,6 +78,8 @@ impl<'r> Responder<'r, 'static> for Error {
             ErrorType::NotFound => Status::NotFound,
             ErrorType::NoEffect => Status::Ok,
             ErrorType::FailedValidation { .. } => Status::BadRequest,
+
+            ErrorType::ProxyError => Status::BadRequest,
         };
 
         // Serialize the error data structure into JSON.