Redirect reporting

Cargo.toml

@@ -1,5 +1,5 @@
 [workspace]
-members = ["lychee-bin", "lychee-lib", "examples/*", "benches"]
+members = ["lychee-bin", "lychee-lib", "examples/*", "benches", "test-utils"]
 resolver = "2"
 
 [workspace.package]

fixtures/TEST.md

@@ -13,7 +13,8 @@ Test GZIP compression. (See https://github.com/analysis-tools-dev/static-analysi
 [LDRA](https://ldra.com)
 
 Some more complex formatting to test that Markdown parsing works.
-[![CC0](https://i.creativecommons.org/p/zero/1.0/88x31.png)](https://creativecommons.org/publicdomain/zero/1.0/)
+[![CC0](https://licensebuttons.net/p/zero/1.0/88x31.png)](https://creativecommons.org/publicdomain/zero/1.0/)
+
 
 Test HTTP and HTTPS for the same site.
 http://example.com

fixtures/TEST_GITHUB.md

@@ -1,3 +1,3 @@
 Test file: contains a single GitHub URL.
 
-Lychee: https://github.com/hello-rust/lychee
+Lychee: https://github.com/lycheeverse/lychee

lychee-bin/Cargo.toml

@@ -66,6 +66,7 @@ cookie_store = "0.22.0"
 predicates = "3.1.3"
 pretty_assertions = "1.4.1"
 tempfile = "3.20.0"
+test-utils = { path = "../test-utils" }
 tracing-subscriber = { version = "0.3.20", default-features = false, features = [
     "fmt",
     "registry",

lychee-bin/src/formatters/response/color.rs

@@ -1,6 +1,6 @@
 use lychee_lib::{CacheStatus, ResponseBody, Status};
 
-use crate::formatters::color::{DIM, GREEN, NORMAL, PINK, YELLOW};
+use crate::formatters::color::{DIM, GREEN, PINK, YELLOW};
 
 use super::{MAX_RESPONSE_OUTPUT_WIDTH, ResponseFormatter};
 
@@ -15,11 +15,10 @@ impl ColorFormatter {
     /// response.
     fn status_color(status: &Status) -> &'static std::sync::LazyLock<console::Style> {
         match status {
-            Status::Ok(_) | Status::Cached(CacheStatus::Ok(_)) => &GREEN,
+            Status::Ok(_) | Status::Cached(CacheStatus::Ok(_)) | Status::Redirected(_, _) => &GREEN,
             Status::Excluded
             | Status::Unsupported(_)
             | Status::Cached(CacheStatus::Excluded | CacheStatus::Unsupported) => &DIM,
-            Status::Redirected(_) => &NORMAL,
             Status::UnknownStatusCode(_) | Status::Timeout(_) => &YELLOW,
             Status::Error(_) | Status::Cached(CacheStatus::Error(_)) => &PINK,
         }

lychee-bin/src/formatters/response/emoji.rs

@@ -17,7 +17,7 @@ impl EmojiFormatter {
             Status::Excluded
             | Status::Unsupported(_)
             | Status::Cached(CacheStatus::Excluded | CacheStatus::Unsupported) => "🚫",
-            Status::Redirected(_) => "↪️",
+            Status::Redirected(_, _) => "↪️",
             Status::UnknownStatusCode(_) | Status::Timeout(_) => "⚠️",
             Status::Error(_) | Status::Cached(CacheStatus::Error(_)) => "❌",
         }
@@ -40,7 +40,7 @@ impl ResponseFormatter for EmojiFormatter {
 mod emoji_tests {
     use super::*;
     use http::StatusCode;
-    use lychee_lib::{ErrorKind, Status, Uri};
+    use lychee_lib::{ErrorKind, Redirects, Status, Uri};
 
     // Helper function to create a ResponseBody with a given status and URI
     fn mock_response_body(status: Status, uri: &str) -> ResponseBody {
@@ -84,7 +84,7 @@ mod emoji_tests {
     fn test_format_response_with_redirect_status() {
         let formatter = EmojiFormatter;
         let body = mock_response_body(
-            Status::Redirected(StatusCode::MOVED_PERMANENTLY),
+            Status::Redirected(StatusCode::MOVED_PERMANENTLY, Redirects::none()),
             "https://example.com/redirect",
         );
         assert_eq!(

lychee-bin/src/formatters/response/plain.rs

@@ -22,6 +22,7 @@ impl ResponseFormatter for PlainFormatter {
 mod plain_tests {
     use super::*;
     use http::StatusCode;
+    use lychee_lib::Redirects;
     use lychee_lib::{ErrorKind, Status, Uri};
 
     // Helper function to create a ResponseBody with a given status and URI
@@ -69,12 +70,12 @@ mod plain_tests {
     fn test_format_response_with_redirect_status() {
         let formatter = PlainFormatter;
         let body = mock_response_body(
-            Status::Redirected(StatusCode::MOVED_PERMANENTLY),
+            Status::Redirected(StatusCode::MOVED_PERMANENTLY, Redirects::none()),
             "https://example.com/redirect",
         );
         assert_eq!(
             formatter.format_response(&body),
-            "[301] https://example.com/redirect | Redirect (301 Moved Permanently): Moved Permanently"
+            "[301] https://example.com/redirect | Redirect: Followed 0 redirects resolving to the final status of: Moved Permanently"
         );
     }
 

lychee-bin/src/formatters/response/task.rs

@@ -13,7 +13,7 @@ impl ResponseFormatter for TaskFormatter {
 mod task_tests {
     use super::*;
     use http::StatusCode;
-    use lychee_lib::{ErrorKind, Status, Uri};
+    use lychee_lib::{ErrorKind, Redirects, Status, Uri};
 
     // Helper function to create a ResponseBody with a given status and URI
     fn mock_response_body(status: Status, uri: &str) -> ResponseBody {
@@ -60,12 +60,12 @@ mod task_tests {
     fn test_format_response_with_redirect_status() {
         let formatter = TaskFormatter;
         let body = mock_response_body(
-            Status::Redirected(StatusCode::MOVED_PERMANENTLY),
+            Status::Redirected(StatusCode::MOVED_PERMANENTLY, Redirects::none()),
             "https://example.com/redirect",
         );
         assert_eq!(
             formatter.format_response(&body),
-            "- [ ] [301] https://example.com/redirect | Redirect (301 Moved Permanently): Moved Permanently"
+            "- [ ] [301] https://example.com/redirect | Redirect: Followed 0 redirects resolving to the final status of: Moved Permanently"
         );
     }
 

lychee-bin/src/formatters/stats/compact.rs

@@ -55,7 +55,7 @@ impl Display for CompactResponseStats {
                     numeric_sort::cmp(&a, &b)
                 });
 
-                writeln!(f, "\n\u{2139} Suggestions")?;
+                writeln!(f, "\nℹ Suggestions")?;
                 for suggestion in sorted_suggestions {
                     writeln!(f, "{suggestion}")?;
                 }
@@ -81,6 +81,7 @@ impl Display for CompactResponseStats {
         write_if_any(stats.excludes, "👻", "Excluded", &BOLD_YELLOW, f)?;
         write_if_any(stats.timeouts, "⏳", "Timeouts", &BOLD_YELLOW, f)?;
         write_if_any(stats.unsupported, "⛔", "Unsupported", &BOLD_YELLOW, f)?;
+        write_if_any(stats.redirects, "🔀", "Redirects", &BOLD_YELLOW, f)?;
 
         Ok(())
     }
@@ -167,6 +168,7 @@ mod tests {
             duration_secs: 0,
             error_map,
             suggestion_map: HashMap::default(),
+            redirect_map: HashMap::default(),
             unsupported: 0,
             redirects: 0,
             cached: 0,

lychee-bin/src/formatters/stats/detailed.rs

@@ -36,16 +36,16 @@ impl Display for DetailedResponseStats {
         let stats = &self.stats;
         let separator = "-".repeat(MAX_PADDING + 1);
 
-        writeln!(f, "\u{1f4dd} Summary")?; // 📝
+        writeln!(f, "📝 Summary")?;
         writeln!(f, "{separator}")?;
-        write_stat(f, "\u{1f50d} Total", stats.total, true)?; // 🔍
-        write_stat(f, "\u{2705} Successful", stats.successful, true)?; // ✅
-        write_stat(f, "\u{23f3} Timeouts", stats.timeouts, true)?; // ⏳
-        write_stat(f, "\u{1f500} Redirected", stats.redirects, true)?; // 🔀
-        write_stat(f, "\u{1f47b} Excluded", stats.excludes, true)?; // 👻
-        write_stat(f, "\u{2753} Unknown", stats.unknown, true)?; //❓
-        write_stat(f, "\u{1f6ab} Errors", stats.errors, true)?; // 🚫
-        write_stat(f, "\u{26d4} Unsupported", stats.errors, false)?; // ⛔
+        write_stat(f, "🔍 Total", stats.total, true)?;
+        write_stat(f, "✅ Successful", stats.successful, true)?;
+        write_stat(f, "⏳ Timeouts", stats.timeouts, true)?;
+        write_stat(f, "🔀 Redirected", stats.redirects, true)?;
+        write_stat(f, "👻 Excluded", stats.excludes, true)?;
+        write_stat(f, "❓ Unknown", stats.unknown, true)?;
+        write_stat(f, "🚫 Errors", stats.errors, true)?;
+        write_stat(f, "⛔ Unsupported", stats.errors, false)?;
 
         let response_formatter = get_response_formatter(&self.mode);
 
@@ -138,6 +138,7 @@ mod tests {
             redirects: 0,
             cached: 0,
             suggestion_map: HashMap::default(),
+            redirect_map: HashMap::default(),
             success_map: HashMap::default(),
             error_map,
             excluded_map: HashMap::default(),

lychee-bin/src/formatters/stats/markdown.rs

@@ -26,35 +26,35 @@ struct StatsTableEntry {
 fn stats_table(stats: &ResponseStats) -> String {
     let stats = vec![
         StatsTableEntry {
-            status: "\u{1f50d} Total",
+            status: "🔍 Total",
             count: stats.total,
         },
         StatsTableEntry {
-            status: "\u{2705} Successful",
+            status: "✅ Successful",
             count: stats.successful,
         },
         StatsTableEntry {
-            status: "\u{23f3} Timeouts",
+            status: "⏳ Timeouts",
             count: stats.timeouts,
         },
         StatsTableEntry {
-            status: "\u{1f500} Redirected",
+            status: "🔀 Redirected",
             count: stats.redirects,
         },
         StatsTableEntry {
-            status: "\u{1f47b} Excluded",
+            status: "👻 Excluded",
             count: stats.excludes,
         },
         StatsTableEntry {
-            status: "\u{2753} Unknown",
+            status: "❓ Unknown",
             count: stats.unknown,
         },
         StatsTableEntry {
-            status: "\u{1f6ab} Errors",
+            status: "🚫 Errors",
             count: stats.errors,
         },
         StatsTableEntry {
-            status: "\u{26d4} Unsupported",
+            status: "⛔ Unsupported",
             count: stats.unsupported,
         },
     ];

lychee-bin/src/formatters/suggestion.rs

@@ -4,8 +4,8 @@ use crate::color::{GREEN, PINK, color};
 use serde::Serialize;
 use url::Url;
 
-#[derive(Debug, Serialize, Eq, Hash, PartialEq)]
 /// A suggestion on how to replace a broken link with a link hosted by a web archive service.
+#[derive(Debug, Serialize, Eq, Hash, PartialEq)]
 pub(crate) struct Suggestion {
     /// The original `Url` that was identified to be broken
     pub(crate) original: Url,

lychee-bin/src/main.rs

@@ -210,10 +210,10 @@ fn load_cookie_jar(cfg: &Config) -> Result<Option<CookieJar>> {
     }
 }
 
-#[must_use]
 /// Load cache (if exists and is still valid)
 /// This returns an `Option` as starting without a cache is a common scenario
 /// and we silently discard errors on purpose
+#[must_use]
 fn load_cache(cfg: &Config) -> Option<Cache> {
     if !cfg.cache {
         return None;

lychee-bin/src/stats.rs

@@ -37,13 +37,15 @@ pub(crate) struct ResponseStats {
     pub(crate) errors: usize,
     /// Number of responses that were cached from a previous run
     pub(crate) cached: usize,
-    /// Map to store successful responses (if `detailed_stats` is enabled)
+    /// Store successful responses (if `detailed_stats` is enabled)
     pub(crate) success_map: HashMap<InputSource, HashSet<ResponseBody>>,
-    /// Map to store failed responses (if `detailed_stats` is enabled)
+    /// Store failed responses (if `detailed_stats` is enabled)
     pub(crate) error_map: HashMap<InputSource, HashSet<ResponseBody>>,
     /// Replacement suggestions for failed responses (if `--suggest` is enabled)
     pub(crate) suggestion_map: HashMap<InputSource, HashSet<Suggestion>>,
-    /// Map to store excluded responses (if `detailed_stats` is enabled)
+    /// Store redirected responses (if `detailed_stats` is enabled)
+    pub(crate) redirect_map: HashMap<InputSource, HashSet<ResponseBody>>,
+    /// Store excluded responses (if `detailed_stats` is enabled)
     pub(crate) excluded_map: HashMap<InputSource, HashSet<ResponseBody>>,
     /// Used to store the duration of the run in seconds.
     pub(crate) duration_secs: u64,
@@ -72,7 +74,7 @@ impl ResponseStats {
             Status::Error(_) => self.errors += 1,
             Status::UnknownStatusCode(_) => self.unknown += 1,
             Status::Timeout(_) => self.timeouts += 1,
-            Status::Redirected(_) => self.redirects += 1,
+            Status::Redirected(_, _) => self.redirects += 1,
             Status::Excluded => self.excludes += 1,
             Status::Unsupported(_) => self.unsupported += 1,
             Status::Cached(cache_status) => {
@@ -95,6 +97,9 @@ impl ResponseStats {
             _ if status.is_error() => self.error_map.entry(source).or_default(),
             Status::Ok(_) if self.detailed_stats => self.success_map.entry(source).or_default(),
             Status::Excluded if self.detailed_stats => self.excluded_map.entry(source).or_default(),
+            Status::Redirected(_, _) if self.detailed_stats => {
+                self.redirect_map.entry(source).or_default()
+            }
             _ => return,
         };
         status_map_entry.insert(response.1);
@@ -110,7 +115,7 @@ impl ResponseStats {
     #[inline]
     /// Check if the entire run was successful
     pub(crate) const fn is_success(&self) -> bool {
-        self.total == self.successful + self.excludes + self.unsupported
+        self.total == self.successful + self.excludes + self.unsupported + self.redirects
     }
 
     #[inline]