Enrich label custom reporting data #1152
Merged
Conversation
This file contains 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
yannham
force-pushed
the
task/label-interface
branch
2 times, most recently
from
9e8dea8
to
76b772c
Compare
yannham
force-pushed
the
task/label-interface
branch
from
cb67807
to
85cbe73
Compare
yannham
changed the title
Add a `notes` field to the custom error reporting data carried by contract labels. Move the tag (now renamed `message`) into a dedicated data structure. A label now holds a stack of such custom contract diagnostic, in order to avoid having subcontracts erase the previous message and notes set by parent contracts. This commits adapt error reporting to handle those new contract custom diagnostics. Note that this commit doesn't yet add user-code functions and primops to access this new interface: it's mostly internal for now.
yannham
force-pushed
the
task/label-interface
branch
from
85cbe73
to
1621d50
Compare
vkleen
reviewed
Mar 3, 2023
vkleen
reviewed
Mar 3, 2023
vkleen
reviewed
Mar 3, 2023
vkleen
reviewed
Mar 3, 2023
vkleen
reviewed
Mar 3, 2023
vkleen
approved these changes
Mar 3, 2023
|
Oops, d77577b was pushed on the wrong branch. Will drop it and force push. |
The contract diagnostics are set by usercode during evaluation. However, the LSP was branching of the presence of such diagnostics to enrich its error message. It doesn't make sense, as the LSP doesn't evaluate any Nickel code, so contract diagnostics are always empty. This commit remove the corresponding useless if.
yannham
force-pushed
the
task/label-interface
branch
from
d77577b
to
43c4a70
Compare
This was referenced Mar 3, 2023
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.
First step of #1052. Enrich the label interface for custom error reporting, with the additional
notesfield. Put this field, together with the previoustag(nowmessage) to a dedicated data structure,ContractDiagnostic. Finally,Labelnow stores a stack of such diagnostic, to help fix one issue of #1052 which is that subcontract might erase the message previously set by parent contract, although it could be relevant.This PR doesn't add any primop to access this new interface yet: it mostly update the error reporting code to handle it. Adding primops is postponed to a subsequent PR.
I'm not totally sure yet what should go in the
ContractDiagnostics (should we also includetype_pathandarg_idx, to store the type path and argument to parent contracts as well, and enrich the corresponding "parent" diagnostics) ?. Should we add more fields thannotesto thelabelinterface?.However, those questions need not be answered right away. We can improve later in a backward compatible manner: for now, the plan is to add at least
notesto make it accessible to the user (in a subsequent PR), with a backward-compatible API. We can always:LabeltoContractDiagnostic, allowing to store a stack of value instead of just the latest one, to improve the reporting of blame errors that have several contract diagnostics. This is invisible to user code, and thus can't break backward compatibility.