🚨 Help Needed: Testing Insta 1.18.0

[mitsuhiko]

I want to release insta 1.18.0 soon which is a major departure from earlier insta versions. In this version insta no longer uses serde by default. This has quite a bit of potential to introduce regressions so I would really appreciate early testing so that regressions are caught early.

How to Test

To test upgrade to insta 1.18.0-alpha.1 and let me know how this went. You should not notice anything but you will get deprecation warnings if you use assert_json_snapshot! or assert_yaml_snapshot!. This is because in the future these macros will require explicit opting into the json and yaml feature respectively.

If you are using cargo-insta I would also appreciate tests on that version though 1.17.x releases of cargo-insta should be compatible.

cargo install cargo-insta --version 1.18.0-alpha.1 --locked

Why do this at all?

There are a handful of reasons why this change came about. With the release of serde_yaml 0.9 all YAML snapshots broke which required me anyways to look into a future direction for how to emit snapshots. serde is an amazing serialization library but depending on the serialization format of serde for snapshot turns out to be problematic as serde does not guarantee any stability there. As such at least for the most common formats (JSON and YAML) I wanted to move to a first party maintained serializer anyways.

Additionally for users who do not need serde based formats, pulling in these heavy dependencies makes the build times unnecessarily slow. These changes mean that without any default dependencies insta is now an incredibly light library:

features = []
└── insta v1.18.0-alpha.1
    ├── linked-hash-map v0.5.6
    ├── once_cell v1.13.0
    ├── similar v2.2.0
    └── yaml-rust v0.4.5
        └── linked-hash-map v0.5.6

Even with serde it's now quite a bit lighter as it no longer depends on serde_yaml and serde_json:

features = ["yaml", "json", "colors"]
└── insta v1.18.0-alpha.1
    ├── console v0.15.1
    │   ├── libc v0.2.127
    │   ├── once_cell v1.13.0
    │   └── terminal_size v0.1.17
    │       └── libc v0.2.127
    ├── linked-hash-map v0.5.6
    ├── once_cell v1.13.0
    ├── serde v1.0.142
    ├── similar v2.2.0
    └── yaml-rust v0.4.5
        └── linked-hash-map v0.5.6

This would not have been possible without the contribution of @LovecraftianHorror who landed the initial changes in #255 to drop the serde dependency.

[untitaker]

two notes:

• the alpha was released as 0.18 even though the latest stable is 1.18
• i think this also causes split versions when trying to upgrade insta while insta-cmd depends on 1.x (breaking my tests for some reason)

[max-sixty]

I'm happy to spend more time investigating, but if anyone knows how to make this work already, lmk. Here's the diff for prql/prql and the error message:

diff --git a/book/Cargo.toml b/book/Cargo.toml
index 88ac156c..1c686252 100644
--- a/book/Cargo.toml
+++ b/book/Cargo.toml
@@ -25,7 +25,7 @@ walkdir = "2.3.2"
 
 [dev-dependencies]
 globset = "0.4.8"
-insta = {version = "1.17.0", features = ["colors", "glob"]}
+insta = {version = "1.18.0-alpha.1", features = ["colors", "glob"]}
 log = "0.4.17"
 pulldown-cmark = "0.9.1"
 pulldown-cmark-to-cmark = "10.0.1"
diff --git a/prql-compiler/Cargo.toml b/prql-compiler/Cargo.toml
index 13de6ea6..3f3047fe 100644
--- a/prql-compiler/Cargo.toml
+++ b/prql-compiler/Cargo.toml
@@ -48,7 +48,7 @@ version = "1.0.137"
 chrono = "0.4"
 criterion = "0.3.5"
 globset = "0.4.8"
-insta = {version = "1.17.0", features = ["colors", "glob"]}
+insta = {version = "1.18.0-alpha.1", features = ["colors", "glob"]}
 pulldown-cmark = "0.9.1"
 pulldown-cmark-to-cmark = "10.0.1"
 similar = "2.2.0"

error: failed to select a version for `insta`.
    ... required by package `mdbook-prql v0.2.6 (/Users/maximilian/workspace/prql/book)`
versions that meet the requirements `^1.17.0` are: 1.17.0, 1.17.2, 1.17.1

all possible versions conflict with previously selected packages.

  previously selected package `insta v1.18.0-alpha.1`
    ... which satisfies dependency `insta = "^1.18.0-alpha.1"` of package `mdbook-prql v0.2.6 (/Users/maximilian/workspace/prql/book)`

failed to select a version for `insta` which could resolve this conflict
warning: non snapshot tests failed, not accepted changes
[[Command exited with 1]]

[CosmicHorrorDev]

book has insta in both its [dependencies] and [dev-dependencies] for some reason. I was able to get cargo test to pass without warnings with this diff

diff --git a/book/Cargo.toml b/book/Cargo.toml
index 88ac156..0303b28 100644
--- a/book/Cargo.toml
+++ b/book/Cargo.toml
@@ -11,7 +11,7 @@ version = "0.2.6"
 anyhow = "1.0.57"
 clap = {version = "3.2.3", default-features = false}
 globset = "0.4.8"
-insta = {version = "1.17.0", features = ["colors", "glob"]}
+insta = {version = "1.18.0-alpha.1", features = ["colors", "glob"]}
 itertools = "0.10.3"
 mdbook = {version = "0.4.18", default-features = false}
 mdbook-preprocessor-boilerplate = "0.1.1"
@@ -25,7 +25,7 @@ walkdir = "2.3.2"
 
 [dev-dependencies]
 globset = "0.4.8"
-insta = {version = "1.17.0", features = ["colors", "glob"]}
+insta = {version = "1.18.0-alpha.1", features = ["colors", "glob"]}
 log = "0.4.17"
 pulldown-cmark = "0.9.1"
 pulldown-cmark-to-cmark = "10.0.1"
diff --git a/prql-compiler/Cargo.toml b/prql-compiler/Cargo.toml
index 13de6ea..d23946e 100644
--- a/prql-compiler/Cargo.toml
+++ b/prql-compiler/Cargo.toml
@@ -48,7 +48,7 @@ version = "1.0.137"
 chrono = "0.4"
 criterion = "0.3.5"
 globset = "0.4.8"
-insta = {version = "1.17.0", features = ["colors", "glob"]}
+insta = {version = "1.18.0-alpha.1", features = ["colors", "glob", "yaml"]}
 pulldown-cmark = "0.9.1"
 pulldown-cmark-to-cmark = "10.0.1"
 similar = "2.2.0"

[mitsuhiko]

I think running cargo update -p insta probably resolves the mismatch.

[max-sixty]

Thanks @LovecraftianHorror ! And I'll fix that on my end

[max-sixty]

PRQL/prql#917

[CosmicHorrorDev]

So I've checked a decent chunk of insta's dependents to see if their existing test suites still pass (wasn't keeping count, probably 30-40 crates)

The only issue I noticed that wasn't also reproducible on earlier versions of insta was zellij which depended on the backtrace feature which was removed. It should probably just be deprecated for 1.18.0 instead

Other than that all crates seemed fine in that both the existing test suites still passed, and snapshot files weren't updated with any changes 👍

[mitsuhiko]

I'm surprised the backtrace feature still ends up being used but I added it back with a deprecation that now fires if someone still uses it.

[joshuataylor]

This worked out of the box for me on 2 projects I tested on, both using a mix of redactions (for the sorted fix). Didn't need to update the snaps either 👍. I test using insta::assert_yaml_snapshot.

Only change was this:

-insta = { version = "1.16.0", features = ["serialization", "redactions"] }
+insta = { version = "1.18.0-alpha.1", features = ["redactions"] }

:D

[mitsuhiko]

Thanks. I added a deprecation warning for serialization now too.

[mitsuhiko]

Thanks for all the testing, 1.18.0 is now released.