nedap.utils.spec.print-stack-frames option

[thumbnail]

Brief

Sometimes stacktraces are 'lost' by means of an eager or opaque capture of exceptions. While this is an issue for the consuming application, seeing check failed [...]-errors without a stacktrace can be frustrating and hard to track down.

By setting nedap.utils.spec.print-stack-frames to a positive integer, the defined amount of frames will be printed.

Locally this has been tested for a couple of weeks.

• replace dynvar with system property.
• add details in README.md

QA plan

1. lein repl + refresh
2. assert (System/getProperty "nedap.utils.spec.print-stack-frames") is 0 or nil
3. (unit.nedap.utils.spec.api/speced-f 42 :hoi)

• assert failure + exception is returned, but not frames are printed

1. (System/setProperty "nedap.utils.spec.print-stack-frames" "99")
2. (unit.nedap.utils.spec.api/speced-f 42 :hoi)

• assert failure + exception is returned and frames are printed

Author checklist

• I have QAed the functionality
• The PR has a reasonably reviewable size and a meaningful commit history
• I have run the branch formatter and observed no new/significative warnings
• The build passes
• I have self-reviewed the PR prior to assignment
• Additionally, I have code-reviewed iteratively the PR considering the following aspects in isolation:
  • Correctness
  • Robustness (red paths, failure handling etc)
  • Modular design
  • Test coverage
  • Spec coverage
  • Documentation
  • Security
  • Performance
  • Breaking API changes
  • Cross-compatibility (Clojure/ClojureScript)
    • ⚠️ this is a clojure only feature for now.

Reviewer checklist

• I have checked out this branch and reviewed it locally, running it
• I have QAed the functionality
• I have reviewed the PR
• Additionally, I have code-reviewed iteratively the PR considering the following aspects in isolation:
  • Correctness
  • Robustness (red paths, failure handling etc)
  • Modular design
  • Test coverage
  • Spec coverage
  • Documentation
  • Security
  • Performance
  • Breaking API changes
  • Cross-compatibility (Clojure/ClojureScript)

[thumbnail]

There's no clojurescript compatibility; because clojurescript stacktraces are either missing (?) or not available in the repl i tried ((cljs.repl/repl (cljs.repl.browser/browser-env))).

I think this is RTM imo.