Structure, refactor and clean up trace messages #751
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jorisdral
requested review from
dcoutts,
mheinzel,
recursion-ninja and
wenkokke
as code owners
jorisdral
force-pushed
the
jdral/trace-messages
branch
7 times, most recently
from
c2602db to
ff9b0df
Compare
We give the trace message datatypes more structure (see the `$traces` Haddock section), and we add few new messages. In the process, we apply some minor refactorings to tracer calls and surrounding code.
The idea is to cover as much of the public API as possible to trace most (if not all) unique trace messages at least once. The trace output is useful in two ways: * By using golden tests based on the trace output we can help to ensure that trace datatypes and their printing do not change unexpectedly. * The trace output serves as an example that can be manually inspected to see whether the trace messages are printed correctly and whether they are useful.
This helps troubleshoot golden test failures that can't be reproduced locally. For example, if a golden test fails on a Windows machine, then I can not reproduce it locally on an Ubuntu machine.
jorisdral
force-pushed
the
jdral/trace-messages
branch
from
ff9b0df to
0abae6b
Compare
jorisdral
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See the commit messages
I'm unsure whether abae6ba6d643580299bdaf985da168c94673f21 is useful, so let me know if we should include it or not.