[COD-360] fix: fixed parsing of negative ignores and added tests #76
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
shinin-light
changed the title
shinin-light
force-pushed
the
fix/negative_ignores
branch
from
9204dec to
18373a1
Compare
shinin-light
force-pushed
the
fix/negative_ignores
branch
from
18373a1 to
f44852c
Compare
j-sp4
reviewed
Apr 20, 2021
| } | ||
|
|
||
| function searchFiles( | ||
| async function* searchFiles( |
There was a problem hiding this comment.
I learn something new everyday function* cool thanks 😃
There was a problem hiding this comment.
It'a generator: instead of returning a value or a promise itself, it returns an async generator so you can then use for (await value of results)...
j-sp4
approved these changes
Apr 21, 2021
miiila
approved these changes
Apr 26, 2021
Arvi3d
approved these changes
Apr 26, 2021
|
🎉 This PR is included in version 3.5.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
COD-360
What does this PR do?
Our current
.gitignoreparsing doesn't work with negative ignores (!-rules). Long story short, it seems that the library on which we base our glob processing (https://github.com/micromatch/micromatch) is not working as expected.For example, an option we use called
basenameis described as "If set, then patterns without slashes will be matched against the basename of the path if it contains slashes", but in reality it always compares the pattern to the basename of the file, regardless if the pattern has a slash or not. This specific feature was already addressed by someone who wanted to use micromatch to parse.gitignorefiles, and it was briefly fixed in version 3.x, however they since reverted the change and now there is no mention of the tests that should have future-proofed this feature.Another issue is that positive glob matching (i.e. finding all the files matching our filters) and negative glob matching (i.e. excluding files following the .gitignore rules) cannot be unified in a single call to micromatch. Trying to use intersections with negations-of-negations would not work properly due to Set Theory. Therefore we need to first filter based on extension and then again based on ignores.
Where should the reviewer start?
Check implementation of
filterIgnoredFilesandparseFileIgnoresand their occurrences.How should this be manually tested?
SNYK_API_HOST=http://localhost:8080 SNYK_API_KEY=<a deepcode sessionToken from your GitHub account in the snyk org> npm run test