Refactor: Move SingleOrVec to a dedicated module and update imports

Author: lovasoa

src/webserver/database/execute_queries.rs

@@ -15,8 +15,8 @@ use super::sql::{
 use crate::dynamic_component::parse_dynamic_rows;
 use crate::utils::add_value_to_map;
 use crate::webserver::database::sql_to_json::row_to_string;
-use crate::webserver::http::SingleOrVec;
 use crate::webserver::http_request_info::RequestInfo;
+use crate::webserver::single_or_vec::SingleOrVec;
 
 use super::syntax_tree::{extract_req_param, StmtParam};
 use super::{error_highlighting::display_db_error, Database, DbItem};

src/webserver/database/sqlpage_functions/functions.rs

@@ -4,9 +4,9 @@ use crate::webserver::{
         blob_to_data_url::vec_to_data_uri_with_mime, execute_queries::DbConn,
         sqlpage_functions::url_parameter_deserializer::URLParameters,
     },
-    http::SingleOrVec,
     http_client::make_http_client,
     request_variables::ParamMap,
+    single_or_vec::SingleOrVec,
     ErrorWithStatus,
 };
 use anyhow::{anyhow, Context};

src/webserver/database/syntax_tree.rs

@@ -16,8 +16,8 @@ use std::str::FromStr;
 
 use sqlparser::ast::FunctionArg;
 
-use crate::webserver::http::SingleOrVec;
 use crate::webserver::http_request_info::RequestInfo;
+use crate::webserver::single_or_vec::SingleOrVec;
 
 use super::{
     execute_queries::DbConn, sql::function_args_to_stmt_params,

src/webserver/http.rs

@@ -34,9 +34,6 @@ use anyhow::{bail, Context};
 use chrono::{DateTime, Utc};
 use futures_util::stream::Stream;
 use futures_util::StreamExt;
-use serde::de::Error as _;
-use std::borrow::Cow;
-use std::mem;
 use std::path::PathBuf;
 use std::pin::Pin;
 use std::sync::Arc;
@@ -227,89 +224,6 @@ async fn render_sql(
     resp_recv.await.map_err(ErrorInternalServerError)
 }
 
-#[derive(Debug, serde::Serialize, PartialEq, Clone)]
-#[serde(untagged)]
-pub enum SingleOrVec {
-    Single(String),
-    Vec(Vec<String>),
-}
-
-impl<'de> serde::Deserialize<'de> for SingleOrVec {
-    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
-    where
-        D: serde::Deserializer<'de>,
-    {
-        let value = serde_json::Value::deserialize(deserializer)?;
-        match value {
-            serde_json::Value::String(s) => Ok(SingleOrVec::Single(s)),
-            serde_json::Value::Array(values) => {
-                let mut strings = Vec::with_capacity(values.len());
-                for (idx, item) in values.into_iter().enumerate() {
-                    match item {
-                        serde_json::Value::String(s) => strings.push(s),
-                        other => {
-                            return Err(D::Error::custom(format!(
-                                "expected an array of strings, but item at index {idx} is {other}"
-                            )))
-                        }
-                    }
-                }
-                Ok(SingleOrVec::Vec(strings))
-            }
-            other => Err(D::Error::custom(format!(
-                "expected a string or an array of strings, but found {other}"
-            ))),
-        }
-    }
-}
-
-impl std::fmt::Display for SingleOrVec {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        match self {
-            SingleOrVec::Single(x) => write!(f, "{x}"),
-            SingleOrVec::Vec(v) => {
-                write!(f, "[")?;
-                let mut it = v.iter();
-                if let Some(first) = it.next() {
-                    write!(f, "{first}")?;
-                }
-                for item in it {
-                    write!(f, ", {item}")?;
-                }
-                write!(f, "]")
-            }
-        }
-    }
-}
-
-impl SingleOrVec {
-    pub(crate) fn merge(&mut self, other: Self) {
-        match (self, other) {
-            (Self::Single(old), Self::Single(new)) => *old = new,
-            (old, mut new) => {
-                let mut v = old.take_vec();
-                v.extend_from_slice(&new.take_vec());
-                *old = Self::Vec(v);
-            }
-        }
-    }
-
-    fn take_vec(&mut self) -> Vec<String> {
-        match self {
-            SingleOrVec::Single(x) => vec![mem::take(x)],
-            SingleOrVec::Vec(v) => mem::take(v),
-        }
-    }
-
-    #[must_use]
-    pub fn as_json_str(&self) -> Cow<'_, str> {
-        match self {
-            SingleOrVec::Single(x) => Cow::Borrowed(x),
-            SingleOrVec::Vec(v) => Cow::Owned(serde_json::to_string(v).unwrap()),
-        }
-    }
-}
-
 async fn process_sql_request(
     req: &mut ServiceRequest,
     sql_path: PathBuf,

src/webserver/http_request_info.rs

@@ -278,8 +278,8 @@ async fn is_file_field_empty(
 
 #[cfg(test)]
 mod test {
-    use super::super::http::SingleOrVec;
     use super::*;
+    use crate::webserver::single_or_vec::SingleOrVec;
     use crate::{app_config::AppConfig, webserver::server_timing::ServerTiming};
     use actix_web::{http::header::ContentType, test::TestRequest};
 

src/webserver/mod.rs

@@ -48,4 +48,5 @@ pub use database::migrations::apply;
 pub mod oidc;
 pub mod response_writer;
 pub mod routing;
+mod single_or_vec;
 mod static_content;

src/webserver/request_variables.rs

@@ -1,6 +1,6 @@
 use std::collections::{hash_map::Entry, HashMap};
 
-use super::http::SingleOrVec;
+use crate::webserver::single_or_vec::SingleOrVec;
 
 pub type ParamMap = HashMap<String, SingleOrVec>;
 

src/webserver/single_or_vec.rs

@@ -0,0 +1,86 @@
+use serde::de::Error;
+use std::borrow::Cow;
+use std::mem;
+
+#[derive(Debug, serde::Serialize, PartialEq, Clone)]
+#[serde(untagged)]
+pub enum SingleOrVec {
+    Single(String),
+    Vec(Vec<String>),
+}
+
+impl<'de> serde::Deserialize<'de> for SingleOrVec {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: serde::Deserializer<'de>,
+    {
+        let value = serde_json::Value::deserialize(deserializer)?;
+        match value {
+            serde_json::Value::String(s) => Ok(SingleOrVec::Single(s)),
+            serde_json::Value::Array(values) => {
+                let mut strings = Vec::with_capacity(values.len());
+                for (idx, item) in values.into_iter().enumerate() {
+                    match item {
+                        serde_json::Value::String(s) => strings.push(s),
+                        other => {
+                            return Err(D::Error::custom(format!(
+                                "expected an array of strings, but item at index {idx} is {other}"
+                            )))
+                        }
+                    }
+                }
+                Ok(SingleOrVec::Vec(strings))
+            }
+            other => Err(D::Error::custom(format!(
+                "expected a string or an array of strings, but found {other}"
+            ))),
+        }
+    }
+}
+
+impl std::fmt::Display for SingleOrVec {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        match self {
+            SingleOrVec::Single(x) => write!(f, "{x}"),
+            SingleOrVec::Vec(v) => {
+                write!(f, "[")?;
+                let mut it = v.iter();
+                if let Some(first) = it.next() {
+                    write!(f, "{first}")?;
+                }
+                for item in it {
+                    write!(f, ", {item}")?;
+                }
+                write!(f, "]")
+            }
+        }
+    }
+}
+
+impl SingleOrVec {
+    pub(crate) fn merge(&mut self, other: Self) {
+        match (self, other) {
+            (Self::Single(old), Self::Single(new)) => *old = new,
+            (old, mut new) => {
+                let mut v = old.take_vec();
+                v.extend_from_slice(&new.take_vec());
+                *old = Self::Vec(v);
+            }
+        }
+    }
+
+    fn take_vec(&mut self) -> Vec<String> {
+        match self {
+            SingleOrVec::Single(x) => vec![mem::take(x)],
+            SingleOrVec::Vec(v) => mem::take(v),
+        }
+    }
+
+    #[must_use]
+    pub fn as_json_str(&self) -> Cow<'_, str> {
+        match self {
+            SingleOrVec::Single(x) => Cow::Borrowed(x),
+            SingleOrVec::Vec(v) => Cow::Owned(serde_json::to_string(v).unwrap()),
+        }
+    }
+}