feat: optimize server codes (#34)

* feat: optimize server codes

* chore: bump version

.changes/optimize.md

@@ -0,0 +1,7 @@
+---
+"algohub-server": patch:feat
+---
+
+Optimize data structures and code for better performance.
+
+Also, make the codes more readable and easier to maintain.

.github/workflows/test.yaml

@@ -21,4 +21,7 @@ jobs:
             --user root --pass root
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
-      - run: cargo test --verbose --all-features
+      - name: Test
+        run: cargo test --verbose --all-features
+      - name: Lint
+        run: cargo fmt --all -- --check && cargo clippy --all-features -- -D warnings

src/models/account.rs

@@ -86,3 +86,11 @@ pub struct Session {
     pub account_id: Thing,
     pub token: String,
 }
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+#[serde(crate = "rocket::serde")]
+pub struct MergeProfile<'r> {
+    pub id: &'r str,
+    pub token: &'r str,
+    pub profile: Profile,
+}

src/models/asset.rs

@@ -1,6 +1,9 @@
 use std::path::PathBuf;
 
-use rocket::fs::TempFile;
+use rocket::{
+    fs::{NamedFile, TempFile},
+    response::Responder,
+};
 use serde::{Deserialize, Serialize};
 use surrealdb::sql::Thing;
 
@@ -25,3 +28,13 @@ pub struct CreateAsset<'a> {
 pub struct UserContent {
     pub id: String,
 }
+
+pub struct AssetFile(pub(crate) NamedFile);
+
+impl<'r, 'o: 'r> Responder<'r, 'o> for AssetFile {
+    fn respond_to(self, req: &rocket::Request) -> rocket::response::Result<'o> {
+        rocket::Response::build_from(self.0.respond_to(req)?)
+            .raw_header("Cache-control", "max-age=86400") //  24h (24*60*60)
+            .ok()
+    }
+}

src/models/category.rs

@@ -14,7 +14,21 @@ pub struct Category {
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(crate = "rocket::serde")]
-pub struct CreateCategory {
-    pub name: String,
+pub struct CategoryData<'c> {
+    pub name: &'c str,
+    pub owner: UserRecordId,
+}
+
+#[derive(Serialize, Deserialize)]
+#[serde(crate = "rocket::serde")]
+pub struct CreateCategory<'r> {
+    pub id: &'r str,
+    pub token: &'r str,
+
+    pub data: CategoryData<'r>,
+}
+
+#[derive(Serialize, Deserialize)]
+pub struct ListCategories {
     pub owner: UserRecordId,
 }

src/models/organization.rs

@@ -9,8 +9,8 @@ pub struct Organization {
 
     pub description: Option<String>,
 
-    pub owner: Vec<Thing>,
-    pub member: Vec<Thing>,
+    pub owners: Vec<Thing>,
+    pub members: Vec<Thing>,
 
     pub creator: String,
 
@@ -20,8 +20,17 @@ pub struct Organization {
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(crate = "rocket::serde")]
-pub struct CreateOrganization {
-    pub name: String,
+pub struct OrganizationData<'c> {
+    pub name: &'c str,
     pub display_name: Option<String>,
     pub description: Option<String>,
 }
+
+#[derive(Serialize, Deserialize)]
+#[serde(crate = "rocket::serde")]
+pub struct CreateOrganization<'r> {
+    pub id: &'r str,
+    pub token: &'r str,
+
+    pub org: OrganizationData<'r>,
+}

src/models/shared.rs

@@ -69,6 +69,12 @@ pub struct OwnedCredentials {
     pub token: String,
 }
 
+#[derive(Serialize, Deserialize)]
+#[serde(crate = "rocket::serde")]
+pub struct OwnedId {
+    pub id: String,
+}
+
 #[derive(Serialize, Deserialize)]
 #[serde(crate = "rocket::serde")]
 pub struct Token<'r> {

src/routes/account.rs

@@ -1,12 +1,11 @@
 use std::path::Path;
 
 use rocket::{get, post, serde::json::Json, tokio::fs::remove_dir_all, State};
-use serde::{Deserialize, Serialize};
 use surrealdb::{engine::remote::ws::Client, Surreal};
 
 use crate::{
     models::{
-        account::{Login, Profile, Register},
+        account::{Login, MergeProfile, Profile, Register},
         error::{Error, ErrorResponse},
         response::{Empty, Response},
         OwnedCredentials, Record, Token,
@@ -50,14 +49,6 @@ pub async fn register(
     }
 }
 
-#[derive(Serialize, Deserialize, Clone, Debug)]
-#[serde(crate = "rocket::serde")]
-pub struct MergeProfile<'r> {
-    pub id: &'r str,
-    pub token: &'r str,
-    pub profile: Profile,
-}
-
 #[post("/profile", data = "<profile>")]
 pub async fn profile(
     db: &State<Surreal<Client>>,
@@ -122,22 +113,19 @@ pub async fn delete(db: &State<Surreal<Client>>, id: &str, auth: Json<Token<'_>>
     .into())
 }
 
-#[derive(Serialize, Deserialize)]
-pub struct LoginResponse {
-    pub id: String,
-    pub token: String,
-}
-
 #[post("/login", data = "<login>")]
-pub async fn login(db: &State<Surreal<Client>>, login: Json<Login<'_>>) -> Result<LoginResponse> {
+pub async fn login(
+    db: &State<Surreal<Client>>,
+    login: Json<Login<'_>>,
+) -> Result<OwnedCredentials> {
     let session = session::authenticate(db, login.identity, login.password)
         .await
         .map_err(|e| Error::ServerError(Json(e.to_string().into())))?
         .ok_or(Error::Unauthorized(Json("Invalid credentials".into())))?;
     Ok(Response {
         success: true,
         message: "Login successful".into(),
-        data: Some(LoginResponse {
+        data: Some(OwnedCredentials {
             id: session.account_id.id.to_string(),
             token: session.token.clone(),
         }),

src/routes/asset.rs

@@ -1,7 +1,6 @@
 use rocket::{
     form::Form,
     fs::NamedFile,
-    response::Responder,
     serde::json::Json,
     tokio::fs::{create_dir_all, File},
     State,
@@ -10,7 +9,7 @@ use surrealdb::{engine::remote::ws::Client, Surreal};
 
 use crate::{
     models::{
-        asset::{CreateAsset, UserContent},
+        asset::{AssetFile, CreateAsset, UserContent},
         error::Error,
         response::{Empty, Response},
         Credentials,
@@ -82,16 +81,6 @@ pub async fn upload(
     }))
 }
 
-pub struct AssetFile(NamedFile);
-
-impl<'r, 'o: 'r> Responder<'r, 'o> for AssetFile {
-    fn respond_to(self, req: &rocket::Request) -> rocket::response::Result<'o> {
-        rocket::Response::build_from(self.0.respond_to(req)?)
-            .raw_header("Cache-control", "max-age=86400") //  24h (24*60*60)
-            .ok()
-    }
-}
-
 #[get("/<id>")]
 pub async fn get(db: &State<Surreal<Client>>, id: &str) -> Option<AssetFile> {
     let asset = asset::get_by_id(db, id).await.ok()??;
@@ -113,7 +102,7 @@ pub async fn delete(
 
     let asset = asset::get_by_id(db, id)
         .await
-        .map_err(|e| Error::from(e))?
+        .map_err(Error::from)?
         .ok_or(Error::NotFound(Json("Asset not found".into())))?;
 
     rocket::tokio::fs::remove_file(&asset.path)

src/routes/category.rs

@@ -1,36 +1,21 @@
 use crate::{
     models::{
-        category::{Category, CreateCategory},
+        category::{Category, CreateCategory, ListCategories},
         error::Error,
         response::{Empty, Response},
-        UserRecordId,
+        OwnedId,
     },
     utils::{category, session},
     Result,
 };
 use rocket::{post, serde::json::Json, State};
-use serde::{Deserialize, Serialize};
 use surrealdb::{engine::remote::ws::Client, Surreal};
 
-#[derive(Serialize, Deserialize)]
-#[serde(crate = "rocket::serde")]
-pub struct CategoryData<'r> {
-    pub id: &'r str,
-    pub token: &'r str,
-
-    pub data: CreateCategory,
-}
-
-#[derive(Serialize, Deserialize)]
-pub struct CreateCatResponse {
-    pub id: String,
-}
-
 #[post("/create", data = "<category>")]
 pub async fn create(
     db: &State<Surreal<Client>>,
-    category: Json<CategoryData<'_>>,
-) -> Result<CreateCatResponse> {
+    category: Json<CreateCategory<'_>>,
+) -> Result<OwnedId> {
     if !session::verify(db, category.id, category.token).await {
         return Err(Error::Unauthorized(Json(
             "Failed to grant permission".into(),
@@ -45,7 +30,7 @@ pub async fn create(
     Ok(Json(Response {
         success: true,
         message: "Category created successfully".into(),
-        data: Some(CreateCatResponse {
+        data: Some(OwnedId {
             id: data.id.unwrap().id.to_string(),
         }),
     }))
@@ -55,7 +40,7 @@ pub async fn create(
 pub async fn delete(
     db: &State<Surreal<Client>>,
     id: &str,
-    category: Json<CategoryData<'_>>,
+    category: Json<CreateCategory<'_>>,
 ) -> Result<Empty> {
     if !session::verify(db, category.id, category.token).await {
         return Err(Error::Unauthorized(Json(
@@ -75,11 +60,6 @@ pub async fn delete(
     .into())
 }
 
-#[derive(Serialize, Deserialize)]
-pub struct ListCategories {
-    pub owner: UserRecordId,
-}
-
 #[post("/list", data = "<data>")]
 pub async fn list(
     db: &State<Surreal<Client>>,

src/routes/contest.rs

@@ -1,27 +1,19 @@
 use rocket::{serde::json::Json, State};
-use serde::{Deserialize, Serialize};
 use surrealdb::{engine::remote::ws::Client, sql::Thing, Surreal};
 
 use crate::{
     models::{
         contest::{AddProblems, CreateContest},
         error::Error,
         response::{Empty, Response},
+        OwnedId,
     },
     utils::{contest, session},
     Result,
 };
 
-#[derive(Serialize, Deserialize)]
-pub struct CreateResponse {
-    pub id: String,
-}
-
 #[post("/create", data = "<contest>")]
-pub async fn create(
-    db: &State<Surreal<Client>>,
-    contest: Json<CreateContest>,
-) -> Result<CreateResponse> {
+pub async fn create(db: &State<Surreal<Client>>, contest: Json<CreateContest>) -> Result<OwnedId> {
     if !session::verify(db, &contest.auth.id, &contest.auth.token).await {
         return Err(Error::Unauthorized(Json("Invalid session".into())));
     }
@@ -35,7 +27,7 @@ pub async fn create(
     Ok(Json(Response {
         success: true,
         message: "Contest created successfully".into(),
-        data: Some(CreateResponse {
+        data: Some(OwnedId {
             id: contest.id.unwrap().id.to_string(),
         }),
     }))

src/routes/index.rs

@@ -1,15 +1,16 @@
 use std::path::{Path, PathBuf};
 
 use super::asset;
+use super::category;
 use super::contest;
 use super::organization;
 use super::problem;
 use super::submission;
-use super::category;
 use crate::{cors::CORS, routes::account};
 use anyhow::Result;
 use rocket::fs::NamedFile;
 use surrealdb::{engine::remote::ws::Ws, opt::auth::Root, Surreal};
+
 #[get("/")]
 async fn index() -> Result<NamedFile, std::io::Error> {
     NamedFile::open("dist/index.html").await
@@ -43,7 +44,6 @@ pub async fn rocket() -> rocket::Rocket<rocket::Build> {
         .mount("/problem", problem::routes())
         .mount("/org", organization::routes())
         .mount("/category", category::routes())
-
         .mount("/contest", contest::routes())
         .mount("/code", submission::routes())
         .manage(db)