Remove redundant and outdated validation from depends extraction regex
#124
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
Library dependencies may be specified in the `depends` field of the library.properties library metadata file. A regular expression is used to separate the dependency name and optional version constraint from each element of the field during parsing of the file to add new releases to the DB. The supported version constraint syntax for use in this field was recently expanded. This included adding support for grouping constraints using parentheses. The previous regular expression did not allow parentheses in the constraint, which unnecessarily limited the capabilities of the library dependencies system. The updated regular expression will match against invalid constraint syntax (e.g., `depends=FooLib (>1.2.3)(<2.3.4)`). However, this is not a problem because the syntax is already validated separately via the dedicated tool for such things: Arduino Lint. The DB update only occurs after the release has passed full validation by Arduino Lint. Given the data which has already been validated by Arduino Lint, this new regular expression will reliably extract the dependency components from the field.
Library dependencies may be specified in the `depends` field of the library.properties library metadata file. A regular expression is used to separate the dependency name and optional version constraint from each element of the field during parsing of the file to add new releases to the DB. A check is done to make sure the specified library names have a valid format. This project was originally solely responsible for such checks. Since that time, a dedicated tool was created for validation of the library releases: Arduino Lint. Since Arduino Lint already does this check, and the DB entries are only added for releases which pass that check, the validation via the extraction regular expression is superfluous and only increases the maintenance burden for no benefit. The regular expression has a single purpose: extracting the components of the depends field elements. This more simple regular expression will accomplish that, given the data which has already been validated by Arduino Lint.
Codecov Report
@@ Coverage Diff @@
## main #124 +/- ##
=======================================
Coverage 41.58% 41.58%
=======================================
Files 26 26
Lines 1450 1450
=======================================
Hits 603 603
Misses 790 790
Partials 57 57
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
umbynos
approved these changes
May 27, 2022
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.
Library dependencies may be specified in the
dependsfield of thelibrary.propertieslibrary metadata file.A regular expression is used to separate the library dependency name and optional version constraint from each element of the field during parsing of the file to add new releases to the DB.
This regular expression is also configured to validate the library name as well as some minimal attempt at validating the version constraint.
The latter is not compatible with the recently introduced more powerful constraint syntax.
This project was originally solely responsible for validation of the library releases. Since that time, a dedicated tool was created for this purpose: Arduino Lint.
Since Arduino Lint already fully validates each release, including the
dependsfield contents, and the DB entries are only added for releases which have passed that check, the validation via the extraction regular expression is superfluous and only increases the maintenance burden for no benefit.The regular expression is now configured for its a single purpose: extracting the components of the
dependsfield elements. This can be done via a more simple regular expression, given that the data being parsed has already been validated by Arduino Lint.