Add a config option to limit the max amount of characters for a value shown in error messages #110
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
|
Do we have an example for how an error with 150+ characters will look like? |
mirpedrol
reviewed
Feb 17, 2025
plugins/nf-schema/src/main/nextflow/validation/config/ValidationConfig.groovy
Outdated
Show resolved
Hide resolved
You can see an error with a shorter max length in the docs. The value will basically be split up with |
…f-schema into fix/map-params-error-value
mirpedrol
reviewed
Feb 18, 2025
| failUnrecognisedParams = config.failUnrecognisedParams ?: false | ||
| failUnrecognisedHeaders = config.failUnrecognisedHeaders ?: false | ||
| showHiddenParams = config.showHiddenParams ?: false | ||
| maxErrValSize = config.maxErrValSize && config.maxErrValSize >= 1 ? config.maxErrValSize : 150 |
There was a problem hiding this comment.
sorry I had a new idea 😅 What do you think if by setting maxErrValSize to 0 we don't have a maximum?
There was a problem hiding this comment.
Maybe -1 might be better for this?
There was a problem hiding this comment.
But I like the idea!
There was a problem hiding this comment.
Thanks :p It's been implemented
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.
Fixes #80
This PR adds the
validation.maxValueLengthoption that takes an integer (bigger than or equal to 0) as input and uses this to limit the amount of characters that a value can be in error messages.Example:
with
validation.maxValueLength = 20Where the original value is 26 characters long (
abcdefghijklmnopqrstuvwxyz)The default of this option is
150which should prevent the loss of most data, but I'm of course open to discuss lowering or raising this default