From c50eef61664e0614255d02924d43f18c4630e447 Mon Sep 17 00:00:00 2001
From: Rob Ede <robjtede@icloud.com>
Date: Tue, 31 Aug 2021 04:07:53 +0100
Subject: [PATCH] "deprecate" calls to NormalizePath::default

---
 MIGRATION.md                |  3 ++-
 src/middleware/normalize.rs | 24 +++++++++++++++++++++---
 2 files changed, 23 insertions(+), 4 deletions(-)

diff --git a/MIGRATION.md b/MIGRATION.md
index 785974366..9a70adb95 100644
--- a/MIGRATION.md
+++ b/MIGRATION.md
@@ -3,7 +3,8 @@
 * The default `NormalizePath` behavior now strips trailing slashes by default. This was
   previously documented to be the case in v3 but the behavior now matches. The effect is that
   routes defined with trailing slashes will become inaccessible when
-  using `NormalizePath::default()`.
+  using `NormalizePath::default()`. As such, calling `NormalizePath::default()` will log a warning.
+  It is advised that the `new` method be used instead.
   
   Before: `#[get("/test/")]`  
   After:  `#[get("/test")]`  
diff --git a/src/middleware/normalize.rs b/src/middleware/normalize.rs
index 219af1c6a..8ad0bb3f0 100644
--- a/src/middleware/normalize.rs
+++ b/src/middleware/normalize.rs
@@ -59,7 +59,7 @@ impl Default for TrailingSlash {
 ///
 /// # actix_web::rt::System::new().block_on(async {
 /// let app = App::new()
-///     .wrap(middleware::NormalizePath::default())
+///     .wrap(middleware::NormalizePath::trim())
 ///     .route("/test", web::get().to(|| async { "test" }))
 ///     .route("/unmatchable/", web::get().to(|| async { "unmatchable" }));
 ///
@@ -85,13 +85,31 @@ impl Default for TrailingSlash {
 /// assert_eq!(res.status(), StatusCode::NOT_FOUND);
 /// # })
 /// ```
-#[derive(Debug, Clone, Copy, Default)]
+#[derive(Debug, Clone, Copy)]
 pub struct NormalizePath(TrailingSlash);
 
+impl Default for NormalizePath {
+    fn default() -> Self {
+        log::warn!(
+            "`NormalizePath::default()` is deprecated. The default trailing slash behavior changed \
+            in v4 from `Always` to `Trim`. Update your call to `NormalizePath::new(...)`."
+        );
+
+        Self(TrailingSlash::Trim)
+    }
+}
+
 impl NormalizePath {
     /// Create new `NormalizePath` middleware with the specified trailing slash style.
     pub fn new(trailing_slash_style: TrailingSlash) -> Self {
-        NormalizePath(trailing_slash_style)
+        Self(trailing_slash_style)
+    }
+
+    /// Constructs a new `NormalizePath` middleware with [trim](TrailingSlash::Trim) semantics.
+    ///
+    /// Use this instead of `NormalizePath::default()` to avoid deprecation warning.
+    pub fn trim() -> Self {
+        Self::new(TrailingSlash::Trim)
     }
 }