extract mime types into subcrate

Author: syphar

Cargo.lock

@@ -30,6 +30,7 @@ derive_more = { version = "2.0.0", features = ["display", "deref", "from", "into
 futures-util = "0.3.5"
 http = "1.0.0"
 itertools = { version = "0.14.0" }
+mime = "0.3.16"
 mockito = "1.0.2"
 opentelemetry = "0.31.0"
 opentelemetry-otlp = { version = "0.31.0", features = ["grpc-tonic",  "metrics"] }
@@ -54,6 +55,7 @@ docs_rs_env_vars = { path = "crates/lib/docs_rs_env_vars" }
 docs_rs_fastly = { path = "crates/lib/docs_rs_fastly" }
 docs_rs_headers = { path = "crates/lib/docs_rs_headers" }
 docs_rs_logging = { path = "crates/lib/docs_rs_logging" }
+docs_rs_mimes = { path = "crates/lib/docs_rs_mimes" }
 docs_rs_opentelemetry = { path = "crates/lib/docs_rs_opentelemetry" }
 docs_rs_registry_api = { path = "crates/lib/docs_rs_registry_api" }
 docs_rs_repository_stats = { path = "crates/lib/docs_rs_repository_stats" }
@@ -84,7 +86,6 @@ toml = "0.9.2"
 opentelemetry = { workspace = true }
 opentelemetry_sdk = { workspace = true }
 rustwide = { version = "0.21.0", features = ["unstable-toolchain-ci", "unstable"] }
-mime_guess = "2"
 zstd = "0.13.0"
 flate2 = "1.1.1"
 hostname = "0.4.0"
@@ -125,7 +126,7 @@ axum = { version = "0.8.1", features = ["macros"] }
 axum-extra = { workspace = true }
 tower = "0.5.1"
 tower-http = { version = "0.6.0", features = ["fs", "trace", "timeout", "catch-panic"] }
-mime = "0.3.16"
+mime = { workspace = true }
 
 tempfile = "3.1.0"
 fn-error-context = "0.2.0"

Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "docs_rs_mimes"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+mime_guess = "2"
+mime = { workspace = true }
+
+[dev-dependencies]
+test-case = { workspace = true }

crates/lib/docs_rs_mimes/Cargo.toml

@@ -0,0 +1,52 @@
+use mime::{self, Mime};
+use std::{ffi::OsStr, path::Path};
+
+pub fn detect_mime(file_path: impl AsRef<Path>) -> Mime {
+    let mime = mime_guess::from_path(file_path.as_ref())
+        .first()
+        .unwrap_or(mime::TEXT_PLAIN);
+
+    match mime.as_ref() {
+        "text/plain" | "text/troff" | "text/x-markdown" | "text/x-rust" | "text/x-toml" => {
+            match file_path.as_ref().extension().and_then(OsStr::to_str) {
+                Some("md") => crate::TEXT_MARKDOWN.clone(),
+                Some("rs") => crate::TEXT_RUST.clone(),
+                Some("markdown") => crate::TEXT_MARKDOWN.clone(),
+                Some("css") => mime::TEXT_CSS,
+                Some("toml") => crate::TEXT_TOML.clone(),
+                Some("js") => mime::TEXT_JAVASCRIPT,
+                Some("json") => mime::APPLICATION_JSON,
+                Some("gz") => crate::APPLICATION_GZIP.clone(),
+                Some("zst") => crate::APPLICATION_ZSTD.clone(),
+                _ => mime,
+            }
+        }
+        "image/svg" => mime::IMAGE_SVG,
+
+        _ => mime,
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use test_case::test_case;
+
+    // some standard mime types that mime-guess handles
+    #[test_case("txt", &mime::TEXT_PLAIN)]
+    #[test_case("html", &mime::TEXT_HTML)]
+    // overrides of other mime types and defaults for
+    // types mime-guess doesn't know about
+    #[test_case("md", &crate::TEXT_MARKDOWN)]
+    #[test_case("rs", &crate::TEXT_RUST)]
+    #[test_case("markdown", &crate::TEXT_MARKDOWN)]
+    #[test_case("css", &mime::TEXT_CSS)]
+    #[test_case("toml", &crate::TEXT_TOML)]
+    #[test_case("js", &mime::TEXT_JAVASCRIPT)]
+    #[test_case("json", &mime::APPLICATION_JSON)]
+    #[test_case("zst", &crate::APPLICATION_ZSTD)]
+    #[test_case("gz", &crate::APPLICATION_GZIP)]
+    fn test_detect_mime(ext: &str, expected: &Mime) {
+        assert_eq!(&detect_mime(format!("something.{ext}")), expected);
+    }
+}

crates/lib/docs_rs_mimes/src/detect.rs

@@ -1,9 +1,13 @@
+mod detect;
+
+pub use detect::detect_mime;
+
 use mime::Mime;
 use std::sync::LazyLock;
 
 macro_rules! mime {
     ($id:ident, $mime:expr) => {
-        pub(crate) static $id: LazyLock<Mime> = LazyLock::new(|| $mime.parse().unwrap());
+        pub static $id: LazyLock<Mime> = LazyLock::new(|| $mime.parse().unwrap());
     };
 }
 

src/db/mimes.rs crates/lib/docs_rs_mimes/src/lib.rssrc/db/mimes.rs renamed to crates/lib/docs_rs_mimes/src/lib.rs

@@ -8,13 +8,10 @@
 //! However, postgres is still available for testing and backwards compatibility.
 
 use crate::error::Result;
-use crate::{
-    db::mimes,
-    storage::{AsyncStorage, CompressionAlgorithm},
-};
+use crate::storage::{AsyncStorage, CompressionAlgorithm};
+use docs_rs_mimes::detect_mime;
 use mime::Mime;
 use serde_json::Value;
-use std::ffi::OsStr;
 use std::path::{Path, PathBuf};
 use tracing::instrument;
 
@@ -32,32 +29,6 @@ impl FileEntry {
     }
 }
 
-pub(crate) fn detect_mime(file_path: impl AsRef<Path>) -> Mime {
-    let mime = mime_guess::from_path(file_path.as_ref())
-        .first()
-        .unwrap_or(mime::TEXT_PLAIN);
-
-    match mime.as_ref() {
-        "text/plain" | "text/troff" | "text/x-markdown" | "text/x-rust" | "text/x-toml" => {
-            match file_path.as_ref().extension().and_then(OsStr::to_str) {
-                Some("md") => mimes::TEXT_MARKDOWN.clone(),
-                Some("rs") => mimes::TEXT_RUST.clone(),
-                Some("markdown") => mimes::TEXT_MARKDOWN.clone(),
-                Some("css") => mime::TEXT_CSS,
-                Some("toml") => mimes::TEXT_TOML.clone(),
-                Some("js") => mime::TEXT_JAVASCRIPT,
-                Some("json") => mime::APPLICATION_JSON,
-                Some("gz") => mimes::APPLICATION_GZIP.clone(),
-                Some("zst") => mimes::APPLICATION_ZSTD.clone(),
-                _ => mime,
-            }
-        }
-        "image/svg" => mime::IMAGE_SVG,
-
-        _ => mime,
-    }
-}
-
 /// Store all files in a directory and return [[mimetype, filename]] as Json
 ///
 /// If there is an S3 Client configured, store files into an S3 bucket;
@@ -101,27 +72,3 @@ pub(crate) fn file_list_to_json(files: impl IntoIterator<Item = FileEntry>) -> V
             .collect(),
     )
 }
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-    use test_case::test_case;
-
-    // some standard mime types that mime-guess handles
-    #[test_case("txt", &mime::TEXT_PLAIN)]
-    #[test_case("html", &mime::TEXT_HTML)]
-    // overrides of other mime types and defaults for
-    // types mime-guess doesn't know about
-    #[test_case("md", &mimes::TEXT_MARKDOWN)]
-    #[test_case("rs", &mimes::TEXT_RUST)]
-    #[test_case("markdown", &mimes::TEXT_MARKDOWN)]
-    #[test_case("css", &mime::TEXT_CSS)]
-    #[test_case("toml", &mimes::TEXT_TOML)]
-    #[test_case("js", &mime::TEXT_JAVASCRIPT)]
-    #[test_case("json", &mime::APPLICATION_JSON)]
-    #[test_case("zst", &mimes::APPLICATION_ZSTD)]
-    #[test_case("gz", &mimes::APPLICATION_GZIP)]
-    fn test_detect_mime(ext: &str, expected: &Mime) {
-        assert_eq!(&detect_mime(format!("something.{ext}")), expected);
-    }
-}

src/db/file.rs

@@ -18,7 +18,6 @@ mod add_package;
 pub mod blacklist;
 pub mod delete;
 pub(crate) mod file;
-pub(crate) mod mimes;
 mod overrides;
 
 static MIGRATOR: Migrator = sqlx::migrate!();

src/db/mod.rs

@@ -10,18 +10,12 @@ use self::{
     database::DatabaseBackend,
     s3::S3Backend,
 };
-use crate::{
-    Config,
-    db::{
-        file::{FileEntry, detect_mime},
-        mimes,
-    },
-    error::Result,
-};
+use crate::{Config, db::file::FileEntry, error::Result};
 use axum_extra::headers;
 use chrono::{DateTime, Utc};
 use dashmap::DashMap;
 use docs_rs_database::Pool;
+use docs_rs_mimes::{self as mimes, detect_mime};
 use docs_rs_opentelemetry::AnyMeterProvider;
 use docs_rs_types::{BuildId, Version};
 use docs_rs_utils::spawn_blocking;

src/storage/mod.rs

@@ -1,6 +1,5 @@
 use crate::{
     Config,
-    db::mimes,
     docbuilder::Limits,
     impl_axum_webpage,
     utils::{ConfigName, get_config, report_error},
@@ -22,6 +21,7 @@ use axum::{
 };
 use axum_extra::{TypedHeader, headers::ContentType};
 use chrono::{TimeZone, Utc};
+use docs_rs_mimes as mimes;
 use futures_util::{StreamExt as _, pin_mut};
 use std::sync::Arc;
 use tracing::{Span, error};

src/web/sitemap.rs

@@ -1,5 +1,5 @@
 use super::{cache::CachePolicy, metrics::request_recorder, routes::get_static};
-use crate::{db::mimes::APPLICATION_OPENSEARCH_XML, web::cache::STATIC_ASSET_CACHE_POLICY};
+use crate::web::cache::STATIC_ASSET_CACHE_POLICY;
 use axum::{
     Router as AxumRouter,
     extract::{Extension, Request},
@@ -12,6 +12,7 @@ use axum_extra::{
     typed_header::TypedHeader,
 };
 use docs_rs_headers::IfNoneMatch;
+use docs_rs_mimes::APPLICATION_OPENSEARCH_XML;
 use http::{StatusCode, Uri};
 use tower_http::services::ServeDir;