fix: optional python dependencies #614
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
gitphill
force-pushed
the
fix/optional-python-dependencies
branch
from
a72733d
to
0b6ddbb
Compare
gitphill
force-pushed
the
fix/optional-python-dependencies
branch
from
0b6ddbb
to
b71e613
Compare
Optional Python dependencies are being over connected. When building Python dep-graphs the current algorithm does not consider whether a transitive should be traversed based on 'extra' definitions. When a Python dependency uses extras, this means that dependency is optional and will only be installed when the installer asks. For example if 'my-package' has the following METADATA snippet: ``` Requires-Dist: logger>=1.0 Provides-Extra: test Requires-Dist: tester>=0.5.0; extra == 'test' ``` This means 'logger' is always installed, but 'tester' is only installed if 'my-package' is installed with extra 'test' dependencies, like so: ``` my-package[test]==1.2.3 ``` The current algorithm sometimes gets away with this lack of accuracy because the dependency is skipped if the METADATA file doesn't even exist. However in many cases what's optional in one transitive line is not in another and this can mean the METADATA file does exists. This results in the current algorithm accidentally associating potentially large sub-graphs to transitive lines that should be terminated when extras are not being used. The first change here introduces code that firstly parses out these extra definitions in both requirements.txt and METADATA files. Then also parsers that pick out the Provides-Extra and Requires-Dist extra environment markers. The second change adapts the pip dep-graph builder to take into account extra properties to decide whether a dependency should be traversed or not.
gitphill
force-pushed
the
fix/optional-python-dependencies
branch
from
b71e613
to
8a8f796
Compare
adrobuta
approved these changes
Nov 15, 2024
|
🎉 This PR is included in version 6.13.15 🎉 The release is available on: Your semantic-release bot 📦🚀 |
gitphill
added a commit
to snyk/cli
that referenced
this pull request
Nov 15, 2024
See snyk/snyk-docker-plugin#614 Fixing a bug in snyk-docker-plugin so that optional dependencies are properly connected in the dep-graph. This could mean that 'snyk container monitor' commands that previously timed out or errored may now start working. The fix reduces unecessary (optional) paths in the dep-graph and so reduce the work Snyk needs to do when scanning for vulnerabilities.
gitphill
added a commit
to snyk/cli
that referenced
this pull request
Nov 15, 2024
See snyk/snyk-docker-plugin#614 Fixing a bug in snyk-docker-plugin so that optional dependencies are properly connected in the dep-graph. This could mean that 'snyk container monitor' commands that previously timed out or errored may now start working. The fix reduces unnecessary (optional) paths in the dep-graph and so reduce the work Snyk needs to do when scanning for vulnerabilities.
7 tasks
7 tasks
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 does this PR do?
Optional Python dependencies are being over connected.
When building Python dep-graphs the current algorithm does not consider whether a transitive should be traversed based on 'extra' definitions.
When a Python dependency uses extras, this means that dependency is optional and will only be installed when the installer asks.
For example if 'my-package' has the following METADATA snippet:
This means 'logger' is always installed, but 'tester' is only installed if 'my-package' is installed with extra 'test' dependencies, like so:
The current algorithm sometimes gets away with this lack of accuracy because if the dependency is not used at all the the METADATA file doesn't even exist and we don't attach any node to the graph. However in many cases what's optional in one transitive line is not in another and this can mean the METADATA file does exists. This results in the current algorithm accidentally associating potentially large sub-graphs to transitive lines that should be terminated when extras are not being used.
The first change here introduces code that firstly parses out these extra definitions in both requirements.txt and METADATA files. Then also parsers that pick out the Provides-Extra and Requires-Dist extra environment markers.
The second change adapts the pip dep-graph builder to take into account extra properties to decide whether a dependency should be traversed or not.
Screenshots