fix: Slugify app-names passed to the API -- (Fixes #158)

scotty-core/src/apps/create_app_request.rs

@@ -1,4 +1,5 @@
 use super::{app_data::AppSettings, file_list::FileList};
+use crate::utils::serde::{deserialize_app_name, serialize_app_name};
 
 #[derive(Debug, Clone, serde::Deserialize, serde::Serialize, utoipa::ToSchema)]
 pub struct CustomDomainMapping {
@@ -16,19 +17,3 @@ pub struct CreateAppRequest {
     pub files: FileList,
     pub custom_domains: Vec<CustomDomainMapping>,
 }
-
-fn serialize_app_name<S>(app_name: &str, serializer: S) -> Result<S::Ok, S::Error>
-where
-    S: serde::Serializer,
-{
-    let slugified_name = slug::slugify(app_name);
-    serializer.serialize_str(&slugified_name)
-}
-
-fn deserialize_app_name<'de, D>(deserializer: D) -> Result<String, D::Error>
-where
-    D: serde::Deserializer<'de>,
-{
-    let app_name: String = serde::Deserialize::deserialize(deserializer)?;
-    Ok(slug::slugify(app_name))
-}

scotty-core/src/notification_types/mod.rs

@@ -4,6 +4,7 @@ use async_trait::async_trait;
 use serde::{Deserialize, Serialize};
 
 use crate::apps::app_data::AppData;
+use crate::utils::serde::{deserialize_app_name, serialize_app_name};
 
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, utoipa::ToSchema, Hash, Eq)]
 pub struct GitlabContext {
@@ -99,12 +100,20 @@ mod tests {
 
 #[derive(Debug, Clone, Serialize, Deserialize, utoipa::ToSchema)]
 pub struct AddNotificationRequest {
+    #[serde(
+        serialize_with = "serialize_app_name",
+        deserialize_with = "deserialize_app_name"
+    )]
     pub app_name: String,
     pub service_ids: Vec<NotificationReceiver>,
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize, utoipa::ToSchema)]
 pub struct RemoveNotificationRequest {
+    #[serde(
+        serialize_with = "serialize_app_name",
+        deserialize_with = "deserialize_app_name"
+    )]
     pub app_name: String,
     pub service_ids: Vec<NotificationReceiver>,
 }

scotty-core/src/utils/mod.rs

@@ -1 +1,2 @@
 pub mod format;
+pub mod serde;

scotty-core/src/utils/serde.rs

@@ -0,0 +1,15 @@
+pub fn serialize_app_name<S>(app_name: &str, serializer: S) -> Result<S::Ok, S::Error>
+where
+    S: serde::Serializer,
+{
+    let slugified_name = slug::slugify(app_name);
+    serializer.serialize_str(&slugified_name)
+}
+
+pub fn deserialize_app_name<'de, D>(deserializer: D) -> Result<String, D::Error>
+where
+    D: serde::Deserializer<'de>,
+{
+    let app_name: String = serde::Deserialize::deserialize(deserializer)?;
+    Ok(slug::slugify(app_name))
+}

scotty/src/api/handlers/apps/run.rs

@@ -1,5 +1,4 @@
 use axum::{
-    debug_handler,
     extract::{Path, State},
     response::IntoResponse,
     Json,
@@ -30,6 +29,7 @@ pub async fn run_app_handler(
     Path(app_id): Path<String>,
     State(state): State<SharedAppState>,
 ) -> Result<impl IntoResponse, AppError> {
+    let app_id = slug::slugify(&app_id);
     let app_data = state.apps.get_app(&app_id).await;
     if app_data.is_none() {
         return Err(AppError::AppNotFound(app_id.clone()));
@@ -46,11 +46,11 @@ pub async fn run_app_handler(
     (status = 200, response = inline(RunningAppContext))
     )
 )]
-#[debug_handler]
 pub async fn stop_app_handler(
     Path(app_id): Path<String>,
     State(state): State<SharedAppState>,
 ) -> Result<impl IntoResponse, AppError> {
+    let app_id = slug::slugify(&app_id);
     let app_data = state.apps.get_app(&app_id).await;
     if app_data.is_none() {
         return Err(AppError::AppNotFound(app_id.clone()));
@@ -67,11 +67,11 @@ pub async fn stop_app_handler(
     (status = 200, response = inline(RunningAppContext))
     )
 )]
-#[debug_handler]
 pub async fn purge_app_handler(
     Path(app_id): Path<String>,
     State(state): State<SharedAppState>,
 ) -> Result<impl IntoResponse, AppError> {
+    let app_id = slug::slugify(&app_id);
     let app_data = state.apps.get_app(&app_id).await;
     if app_data.is_none() {
         return Err(AppError::AppNotFound(app_id.clone()));
@@ -88,11 +88,11 @@ pub async fn purge_app_handler(
     (status = 200, response = inline(AppData))
     )
 )]
-#[debug_handler]
 pub async fn info_app_handler(
     Path(app_id): Path<String>,
     State(state): State<SharedAppState>,
 ) -> Result<impl IntoResponse, AppError> {
+    let app_id = slug::slugify(&app_id);
     let app_data = state.apps.get_app(&app_id).await;
     if app_data.is_none() {
         return Err(AppError::AppNotFound(app_id.clone()));
@@ -108,11 +108,11 @@ pub async fn info_app_handler(
     (status = 200, response = inline(RunningAppContext))
     )
 )]
-#[debug_handler]
 pub async fn rebuild_app_handler(
     Path(app_id): Path<String>,
     State(state): State<SharedAppState>,
 ) -> Result<impl IntoResponse, AppError> {
+    let app_id = slug::slugify(&app_id);
     let app_data = state.apps.get_app(&app_id).await;
     if app_data.is_none() {
         return Err(AppError::AppNotFound(app_id.clone()));
@@ -130,11 +130,11 @@ pub async fn rebuild_app_handler(
     (status = 400, response = inline(AppError))
     )
 )]
-#[debug_handler]
 pub async fn destroy_app_handler(
     Path(app_id): Path<String>,
     State(state): State<SharedAppState>,
 ) -> Result<impl IntoResponse, AppError> {
+    let app_id = slug::slugify(&app_id);
     let app_data = state.apps.get_app(&app_id).await;
     if app_data.is_none() {
         return Err(AppError::AppNotFound(app_id.clone()));
@@ -155,11 +155,11 @@ pub async fn destroy_app_handler(
     (status = 400, response = inline(AppError))
     )
 )]
-#[debug_handler]
 pub async fn adopt_app_handler(
     Path(app_id): Path<String>,
     State(state): State<SharedAppState>,
 ) -> Result<impl IntoResponse, AppError> {
+    let app_id = slug::slugify(&app_id);
     let app_data = state.apps.get_app(&app_id).await;
     if app_data.is_none() {
         return Err(AppError::AppNotFound(app_id.clone()));