UX: better error message for json errors while parsing options #4602
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
This predominantly tries to actually list the problematic part of the options.
joanlopez
previously approved these changes
Mar 5, 2025
joanlopez
reviewed
Mar 5, 2025
| nextNewLineIndex := max(bytes.IndexByte(data[e.Offset:], '\n'), len(data)-1) | ||
|
|
||
| info := strings.TrimSpace(string(data[previousNewLineIndex:nextNewLineIndex])) | ||
| err = fmt.Errorf("parsing options from script got error while parsing %q: %w", info, e) |
There was a problem hiding this comment.
Nit: The function name looks pretty generic, while in a large package, and while this error formatting operation is quite specific, thus I'm concerned someone could use it by mistake (expecting it to behave in a more generic way). Wdyt? Perhaps we can set a slightly more concrete name?
There was a problem hiding this comment.
If you don't mind longer functions, I usually find it useful to bring related functionality together. So, this function can go into a closure in the populateExport function if we want to avoid others using it as a generic function. Doing so will also save us from finding a better name for it. No strong opinion, though :)
joanlopez
approved these changes
Mar 5, 2025
inancgumus
approved these changes
Mar 7, 2025
mstoykov
added a commit
that referenced
this pull request
Mar 13, 2025
The original idea of #4602 was to report at least the key with potentially the option in question. Due to the lack of support from the error - it can't parse it. The commit was trying to get everything between the previous and next new line. But in practice was getting anything until the end, both because of error in the coed to get the index, but also because there were no newlines due to how we marshal the data before that. This should fix both and make it less likely we just get everything until the end.
8 tasks
mstoykov
added a commit
that referenced
this pull request
Mar 13, 2025
The original idea of #4602 was to report at least the key with potentially the option in question. Due to the lack of support from the error - it can't parse it. The commit was trying to get everything between the previous and next new line. But in practice was getting anything until the end, both because of error in the coed to get the index, but also because there were no newlines due to how we marshal the data before that. This should fix both and make it less likely we just get everything until the end. Co-authored-by: Oleg Bespalov <oleg.bespalov@grafana.com> Co-authored-by: Ivan <2103732+codebien@users.noreply.github.com>
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.
What?
This predominantly tries to actually list the problematic part of the options.
Why?
Hopefully help users figure out what the problem is
Checklist
make check) and all pass.Checklist: Documentation (only for k6 maintainers and if relevant)
Please do not merge this PR until the following items are filled out.
Related PR(s)/Issue(s)