Revert sort_maps sequence sorting, release 1.47.1 (#891)

max-sixty · claude · web-flow · commit fdbfc1508499 · 2026-03-28T22:28:17.000-07:00
Reverts #876 — the `sort_maps` change in 1.47.0 sorted all `Seq` values (including `Vec`), not just non-deterministic collections like `HashSet`. This was a breaking change for anyone relying on ordered sequence output with `sort_maps` enabled. Thanks to @spinda for reporting in #876. > _This was written by Claude Code on behalf of max-sixty_ --------- Co-authored-by: Claude <noreply@anthropic.com>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 All notable changes to insta and cargo-insta are documented here.
 
+## 1.47.1
+
+- Revert sorting of sequences in `sort_maps`. The change in 1.47.0 sorted all
+  `Seq` values (including `Vec`), not just non-deterministic collections like
+  `HashSet`, which was a breaking change. #876
+
 ## 1.47.0
 
 - Add `Comparator` trait for customizing how snapshot values are compared. #872 (@dstu)
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/cargo-insta/Cargo.toml b/cargo-insta/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "cargo-insta"
-version = "1.47.0"
+version = "1.47.1"
 license = "Apache-2.0"
 authors = ["Armin Ronacher <armin.ronacher@active-4.com>"]
 description = "A review tool for the insta snapshot testing library for Rust"
@@ -14,7 +14,7 @@ readme = "README.md"
 rust-version = "1.66.0"
 
 [dependencies]
-insta = { version = "=1.47.0", path = "../insta", features = [
+insta = { version = "=1.47.1", path = "../insta", features = [
     "json",
     "yaml",
     "redactions",
diff --git a/insta/Cargo.toml b/insta/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "insta"
-version = "1.47.0"
+version = "1.47.1"
 license = "Apache-2.0"
 authors = ["Armin Ronacher <armin.ronacher@active-4.com>"]
 description = "A snapshot testing library for Rust"
diff --git a/insta/src/content/serialization.rs b/insta/src/content/serialization.rs
@@ -94,23 +94,18 @@ impl Content {
         }
     }
 
-    fn cmp_as_key(&self, other: &Content) -> Ordering {
-        match (self.as_key(), other.as_key()) {
-            (Key::Other, _) | (_, Key::Other) => self.partial_cmp(other).unwrap_or(Ordering::Equal),
-            (ref a, ref b) => a.cmp(b),
-        }
-    }
-
     pub(crate) fn sort_maps(&mut self) {
         self.walk(&mut |content| {
-            match content {
-                Content::Map(ref mut items) => {
-                    items.sort_by(|a, b| a.0.cmp_as_key(&b.0));
-                }
-                Content::Seq(ref mut items) => {
-                    items.sort_by(|a, b| a.cmp_as_key(b));
-                }
-                _ => {}
+            if let Content::Map(ref mut items) = content {
+                // try to compare by key first, if that fails compare by the
+                // object value.  That way some values normalize, and if we
+                // can't normalize we still have a stable order.
+                items.sort_by(|a, b| match (a.0.as_key(), b.0.as_key()) {
+                    (Key::Other, _) | (_, Key::Other) => {
+                        a.0.partial_cmp(&b.0).unwrap_or(Ordering::Equal)
+                    }
+                    (ref a, ref b) => a.cmp(b),
+                })
             }
             true
         })
diff --git a/insta/src/settings.rs b/insta/src/settings.rs
@@ -235,11 +235,7 @@ impl Settings {
         Rc::make_mut(&mut self.inner)
     }
 
-    /// Enables forceful sorting of maps and sequences before serialization.
-    ///
-    /// This is particularly useful for ensuring deterministic snapshots of
-    /// non-ordered collections like [`HashMap`](std::collections::HashMap) and
-    /// [`HashSet`](std::collections::HashSet).
+    /// Enables forceful sorting of maps before serialization.
     ///
     /// Note that this only applies to snapshots that undergo serialization
     /// (eg: does not work for [`assert_debug_snapshot!`](crate::assert_debug_snapshot!)).
@@ -249,7 +245,7 @@ impl Settings {
         self._private_inner_mut().sort_maps = value;
     }
 
-    /// Returns the current value for map and sequence sorting.
+    /// Returns the current value for map sorting.
     pub fn sort_maps(&self) -> bool {
         self.inner.sort_maps
     }
diff --git a/insta/tests/test_settings.rs b/insta/tests/test_settings.rs
@@ -1,5 +1,3 @@
-#[cfg(feature = "json")]
-use insta::assert_json_snapshot;
 #[cfg(feature = "yaml")]
 use insta::assert_yaml_snapshot;
 use similar_asserts::assert_eq;
@@ -130,33 +128,6 @@ fn test_snapshot_with_description_and_info() {
     });
 }
 
-#[cfg(feature = "json")]
-#[test]
-fn test_sort_maps_sorts_hashset() {
-    with_settings!({sort_maps => true}, {
-        assert_json_snapshot!(
-            (
-                std::collections::HashSet::from([2, 1, 3]),
-                std::collections::HashMap::from([("one", 1), ("two", 2), ("three", 3)]),
-            ),
-            @r###"
-        [
-          [
-            1,
-            2,
-            3
-          ],
-          {
-            "one": 1,
-            "three": 3,
-            "two": 2
-          }
-        ]
-        "###
-        );
-    });
-}
-
 #[test]
 fn test_with_settings_inherit() {
     with_settings!({sort_maps => true}, {

Original file line number	Diff line number	Diff line change
`@@ -235,11 +235,7 @@ impl Settings {`
`235`	`235`	`Rc::make_mut(&mut self.inner)`
`236`	`236`	`}`
`237`	`237`
`238`		`- /// Enables forceful sorting of maps and sequences before serialization.`
`239`		`- ///`
`240`		`- /// This is particularly useful for ensuring deterministic snapshots of`
`241`		- /// non-ordered collections like [`HashMap`](std::collections::HashMap) and
`242`		- /// [`HashSet`](std::collections::HashSet).
	`238`	`+ /// Enables forceful sorting of maps before serialization.`
`243`	`239`	`///`
`244`	`240`	`/// Note that this only applies to snapshots that undergo serialization`
`245`	`241`	/// (eg: does not work for [`assert_debug_snapshot!`](crate::assert_debug_snapshot!)).
`@@ -249,7 +245,7 @@ impl Settings {`
`249`	`245`	`self._private_inner_mut().sort_maps = value;`
`250`	`246`	`}`
`251`	`247`
`252`		`- /// Returns the current value for map and sequence sorting.`
	`248`	`+ /// Returns the current value for map sorting.`
`253`	`249`	`pub fn sort_maps(&self) -> bool {`
`254`	`250`	`self.inner.sort_maps`
`255`	`251`	`}`