Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: option to limit max vulnerable paths per vuln #5454

Merged
merged 1 commit into from
Sep 24, 2024

Conversation

cmars
Copy link
Contributor

@cmars cmars commented Aug 30, 2024

In CLI-261 an out-of-memory condition occurs when trying to report SCA
findings on a container test. This happens due to an unusually large
number of dependency paths to some vulnerabilities.

Such a large number of paths is unlikely to be useful or helpful.

If the user has specifically requested all vulnerable paths with
--show-vulnerable-paths=all, this takes precedence and the limit is
ignored.

Otherwise the user may opt-in to limiting the max number of vulnerable paths
with --max-vulnerable-paths=N.
  • Fill out boilerplate PR form
  • Tests

Pull Request Submission

Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

What does this PR do?

See top posting.

Where should the reviewer start?

See also CLI-261

How should this be manually tested?

Try testing a container image that normally OOMs with --max-vulnerable-paths=10

Any background context you want to provide?

What are the relevant tickets?

Screenshots

Additional questions

Copy link
Contributor

github-actions bot commented Aug 30, 2024

Warnings
⚠️

Since the CLI is unifying on a standard and improved tooling, we're starting to migrate old-style imports and exports to ES6 ones.
A file you've modified is using either module.exports or require(). If you can, please update them to ES6 import syntax and export syntax.
Files found:

  • test/tap/cli-test/cli-test.docker.spec.ts
⚠️

"fix: default limit to max vulnerable paths per vuln, add override option" is too long. Keep the first line of your commit message under 72 characters.

Generated by 🚫 dangerJS against 302d7ac

@cmars cmars force-pushed the fix/cli-261-max-vuln-paths-option branch 2 times, most recently from 9b5ca04 to c65de60 Compare September 24, 2024 15:24
@cmars cmars marked this pull request as ready for review September 24, 2024 15:25
@cmars cmars requested a review from a team as a code owner September 24, 2024 15:25
@cmars cmars changed the title fix: default limit to max vulnerable paths per vuln, add override option fix: option to limit max vulnerable paths per vuln Sep 24, 2024
Copy link
Contributor

@sandor-trombitas sandor-trombitas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@cmars cmars force-pushed the fix/cli-261-max-vuln-paths-option branch 3 times, most recently from 9104016 to 0836ef9 Compare September 24, 2024 16:01
In CLI-261 an out-of-memory condition occurs when trying to report SCA
findings on a container test. This happens due to an unusually large
number of dependency paths to some vulnerabilities.

Such a large number of paths is unlikely to be useful or helpful.

If the user has specifically requested all vulnerable paths with
--show-vulnerable-paths=all, this takes precedence and the limit is
ignored.

Otherwise the user may opt-in to limiting the max number of vulnerable paths
with --max-vulnerable-paths=N.
@cmars cmars force-pushed the fix/cli-261-max-vuln-paths-option branch from 0836ef9 to 302d7ac Compare September 24, 2024 16:27
@cmars cmars merged commit c24eecb into main Sep 24, 2024
9 checks passed
@cmars cmars deleted the fix/cli-261-max-vuln-paths-option branch September 24, 2024 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants