Add fancy output implementation for error-stack

packages/libs/error-stack/.gitattributes

@@ -0,0 +1,3 @@
+tests/snapshots/*.snap linguist-generated=true
+tests/snapshots/doc/*.snap linguist-generated=true
+tests/snapshots/ linguist-generated=true

packages/libs/error-stack/Cargo.toml

@@ -14,32 +14,40 @@ categories = ["rust-patterns", "no-std"]
 
 [dependencies]
 tracing-error = { version = "0.2", optional = true, default_features = false }
-once_cell = { version = "1.10.0", optional = true, default_features = false }
 pin-project = { version = "1.0.10", optional = true, default_features = false }
 futures-core = { version = "0.3", optional = true, default-features = false }
 smallvec = { version = "1", optional = true, default_features = false, features = ['union'] }
 anyhow = { version = "1", default-features = false, optional = true }
 eyre = { version = "0.6", default-features = false, optional = true }
 
+owo-colors = { version = "3.4.0", default-features = false, optional = true, features = ['supports-colors'] }
+
 [dev-dependencies]
 serde = { version = "1.0.137", features = ["derive"] }
 serde_json = "1.0.81"
 futures = { version = "0.3.21", default-features = false, features = ["executor"] }
 trybuild = "1.0.63"
 tracing = "0.1.35"
 tracing-subscriber = "0.3.14"
+insta = { version = "1.18.0", features = ['filters'] }
+regex = "1.6.0"
+expect-test = "1.4.0"
+ansi-to-html = "0.1.0"
 once_cell = "1.13.0"
 
 [build-dependencies]
 rustc_version = "0.4"
 
 [features]
-default = ["std", "small"]
-std = ["anyhow?/std", "once_cell?/std"]
-hooks = ["dep:once_cell", "std"]
-spantrace = ["dep:tracing-error"]
+default = ["std", "small", "pretty-print"]
+
 futures = ["dep:pin-project", "dep:futures-core"]
+hooks = ["std"]
+pretty-print = ["dep:owo-colors"]
 small = ["dep:smallvec"]
+spantrace = ["dep:tracing-error"]
+std = ["anyhow?/std"]
+unstable = []
 
 [package.metadata.docs.rs]
 all-features = true
@@ -48,7 +56,7 @@ targets = ["x86_64-unknown-linux-gnu"]
 
 [[example]]
 name = "json_output"
-required-features = ["hooks"]
+required-features = ["std"]
 
 [[example]]
 name = "demo"
@@ -62,6 +70,7 @@ required-features = ["std"]
 name = "parse_config"
 required-features = ["std"]
 
+
 [[test]]
 name = "common"
 test = false

packages/libs/error-stack/Makefile.toml

@@ -6,6 +6,10 @@ CARGO_CLIPPY_HACK_FLAGS = "${CARGO_CLIPPY_HACK_FLAGS_BASE} --group-features anyh
 CARGO_TEST_HACK_FLAGS_BASE = "--workspace --feature-powerset --exclude-features default --optional-deps eyre,anyhow"
 CARGO_TEST_HACK_FLAGS = "${CARGO_TEST_HACK_FLAGS_BASE} --group-features anyhow,eyre --group-features spantrace,futures,small"
 CARGO_MIRI_FLAGS = "--tests --lib"
+CARGO_INSTA_TEST_FLAGS = "--no-fail-fast"
+# The only features that are of relevance are: spantrace, pretty-print, std, hooks
+# all others do not change the output
+CARGO_INSTA_TEST_HACK_FLAGS = "--workspace --keep-going --feature-powerset --include-features spantrace,pretty-print,std,unstable"
 
 [env.release]
 CARGO_CLIPPY_HACK_FLAGS = "${CARGO_CLIPPY_HACK_FLAGS_BASE}"
@@ -18,3 +22,41 @@ dependencies = ["install-rust-src"]
 [tasks.install-rust-src]
 private = true
 install_crate = { rustup_component_name = "rust-src" }
+
+# Snapshot Tests
+# ==============
+#
+# Several features make use of snapshots for acceptance/integration tests, these are files
+# with expected output for a specific input.
+# We use insta for tests https://github.com/mitsuhiko/insta and expect-test https://docs.rs/expect-test/latest/expect_test/ for doc tests.
+# expect-test enables us to directly include the snapshot in documentation, while insta provides a more complete feature-set.
+#
+# You should invoke this task whenever you change `test_debug`, a file which includes a doctest with `expect_test`, or change the formatting of a `Report`.
+#
+# Reviewing Tests
+# ---------------
+#
+# To review snapshots generated by insta install `cargo-insta` (https://github.com/mitsuhiko/insta) and invoke `cargo insta review`,
+# you will be led through all changes one-by-one and need to compare them to see if they are what you expected the outcome to be.
+#
+# To review snapshots generated by expect-test use gits diffing capabilities.
+[tasks.update-snapshots]
+category = "Test"
+description = "Test against insta to update snapshots"
+run_task = { name = ['update-snapshots-task'] }
+
+[tasks.update-snapshots-task]
+private = true
+run_task = { name = ['update-snapshots-task-lib', 'update-snapshots-task-doc'] }
+
+[tasks.update-snapshots-task-lib]
+extend = "task"
+args = ["hack", "@@split(CARGO_INSTA_TEST_HACK_FLAGS, )", "nextest", "run", "--cargo-profile", "${CARGO_MAKE_CARGO_PROFILE}", "@@split(CARGO_TEST_FLAGS, )", "@@split(CARGO_INSTA_TEST_FLAGS, )", "${@}"]
+env = { "INSTA_FORCE_PASS" = "1", "RUST_BACKTRACE" = "1", "INSTA_UPDATE" = "new" }
+
+[tasks.update-snapshots-task-doc]
+# only run on nightly, as backtraces are otherwise not included
+condition = { channels = ["nightly"] }
+extend = "task"
+args = ["test", "--profile", "${CARGO_MAKE_CARGO_PROFILE}", "@@split(CARGO_DOC_TEST_FLAGS, )", "--doc", "${@}"]
+env = { "UPDATE_EXPECT" = "1", "RUST_BACKTRACE" = "1" }

packages/libs/error-stack/README.md

@@ -95,20 +95,36 @@ fn main() -> Result<(), ExperimentError> {
 
 This will most likely result in an error and print
 
-```text
-Error: Experiment error: Could not run experiment
-             at examples/demo.rs:54:18
-      - Unable to set up experiments
-
-Caused by:
-   0: invalid experiment description
-             at examples/demo.rs:24:10
-      - Experiment 2 could not be parsed
-   1: invalid digit found in string
-             at examples/demo.rs:22:10
-      - "3o" could not be parsed as experiment
+<pre>
+Error: <span style="font-weight:bold;">Experiment error: Could not run experiment</span>
+<span style="color:red;">├</span><span style="color:red;">╴</span><span style="filter: contrast(70%) brightness(190%);color:dimgray;">examples/demo.rs:54:18</span>
+<span style="color:red;">├</span><span style="color:red;">╴</span>Unable to set up experiments
+<span style="color:red;">│</span>
+<span style="color:red;">├</span><span style="color:red;">─</span><span style="color:red;">▶</span><span style="color:red;"> </span><span style="font-weight:bold;">invalid experiment description</span>
+<span style="color:red;">│</span><span style="color:red;"> </span><span style="color:red;"> </span><span style="color:red;"> </span><span style="color:red;">├</span><span style="color:red;">╴</span><span style="filter: contrast(70%) brightness(190%);color:dimgray;">examples/demo.rs:24:10</span>
+<span style="color:red;">│</span><span style="color:red;"> </span><span style="color:red;"> </span><span style="color:red;"> </span><span style="color:red;">╰</span><span style="color:red;">╴</span>Experiment 2 could not be parsed
+<span style="color:red;">│</span>
+<span style="color:red;">╰</span><span style="color:red;">─</span><span style="color:red;">▶</span><span style="color:red;"> </span><span style="font-weight:bold;">invalid digit found in string</span>
+<span style="color:red;"> </span><span style="color:red;"> </span><span style="color:red;"> </span><span style="color:red;"> </span><span style="color:red;">├</span><span style="color:red;">╴</span><span style="filter: contrast(70%) brightness(190%);color:dimgray;">examples/demo.rs:22:10</span>
+<span style="color:red;"> </span><span style="color:red;"> </span><span style="color:red;"> </span><span style="color:red;"> </span><span style="color:red;">├</span><span style="color:red;">╴</span>&quot;3o&quot; could not be parsed as experiment
+<span style="color:red;"> </span><span style="color:red;"> </span><span style="color:red;"> </span><span style="color:red;"> </span><span style="color:red;">╰</span><span style="color:red;">╴</span>backtrace with 28 frames (1)
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+Backtrace No. 1
+<span style="color: gray; font-style: italic"><5 internal calls></span>
+   6: demo::parse_experiment
+             at ./examples/demo.rs:20:17
+   7: demo::start_experiments::{{closure}}
+             at ./examples/demo.rs:52:30
+<span style="color: gray; font-style: italic"><16 internal calls></span>
+  24: demo::start_experiments
+             at ./examples/demo.rs:44:23
+  25: demo::main
+             at ./examples/demo.rs:67:5
+<span style="color: gray; font-style: italic"><13 internal calls></span>
+</pre>
 
-```
 
 Please see the [documentation] for a full description.
 

packages/libs/error-stack/build.rs

@@ -4,4 +4,10 @@ fn main() {
     if version_meta().unwrap().channel == Channel::Nightly {
         println!("cargo:rustc-cfg=nightly")
     }
+
+    #[cfg(feature = "hooks")]
+    println!(
+        "cargo:warning=The `hooks` feature for `error-stack` is deprecated as it's not required \
+         anymore"
+    )
 }