feat: dep graph json output #5610
Draft
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
feat/dep-graph-json-file-output
branch
2 times, most recently
from
a1f9df6
to
1eaec7e
Compare
Changes dependency JSON output for snyk test and snyk container test. When using either `--json` or `--json-file-output` together with `--print-deps` attached a `depGraph` property to the output JSON. Previously using `--json` and `--print-deps` together would produce invalid JSON. Prevent any warning logs from invalidating JSON output when `--json` is being used.
gitphill
force-pushed
the
feat/dep-graph-json-file-output
branch
from
1eaec7e
to
3d7c9ec
Compare
gitphill
commented
Dec 5, 2024
| '--print-deps --json option not yet supported for large projects. Displaying graph json output instead', | ||
| ); | ||
| // TODO @boost: add as output graphviz 'dot' file to visualize? | ||
| console.log(jsonStringifyLargeObject(depGraph.toJSON())); |
There was a problem hiding this comment.
this is a potentially breaking change, if anyone was using --print-deps with --json on a project with more than 40k vulnerable paths, and also working around the fact that we produce invalid JSON 😅
gitphill
commented
Dec 5, 2024
| if (options['print-deps']) { | ||
| if (options.json) { | ||
| // Will produce 2 JSON outputs, one for the deps, one for the vuln scan. | ||
| console.log(jsonStringifyLargeObject(rootPackage)); |
There was a problem hiding this comment.
this is a potentially breaking change if anyone was using --print-deps with --json on a project with less than 40k paths and has implemented a depTree JSON parser, and also working around the fact that we produce invalid JSON 😅
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.
Pull Request Submission Checklist
What does this PR do?
To help diagnose problems during dependency resolution and surface details
on what dependencies have been detected during the plugin inspect phase.
Changes dependency JSON output for snyk test and snyk container test.
When using either
--jsonor--json-file-outputtogether with--print-depsattached adepGraphproperty to the output JSON.Previously using
--jsonand--print-depstogether would produceinvalid JSON.
Prevent any warning logs from invalidating JSON output when
--jsonis being used.
Where should the reviewer start?
How should this be manually tested?