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: avoid outputting potentially very large JSON objects #5147

Merged
merged 1 commit into from Apr 3, 2024

Conversation

j-luong
Copy link
Contributor

@j-luong j-luong commented Apr 3, 2024

Risk

Low - minor change to a debug log message

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?

This PR removes the response body output as part of a debug message. This response body is of unknown size and can potentially be very large, causing unexpected failures and timeouts if so.

Where should the reviewer start?

Review the small line change

How should this be manually tested?

If we run DEBUG=* snyk test we should see the debug output no longer contains the response body:

  • Before:
2024-04-03T08:28:07.461Z snyk:req response (200):  {
  "result": {
    "affectedPkgs": {
      "got@11.8.2": {
        "pkg": {
          "name": "got",
          "version": "11.8.2"
        },
        "issues": { ...
  • Now:
2024-04-03T08:29:04.656Z snyk:req response (200)

Any background context you want to provide?

What are the relevant tickets?

Screenshots

Additional questions

Copy link
Contributor

github-actions bot commented Apr 3, 2024

Warnings
⚠️

You've modified files in src/ directory, but haven't updated anything in test folder. Is there something that could be tested?

Generated by 🚫 dangerJS against c02dd4b

@j-luong j-luong marked this pull request as ready for review April 3, 2024 08:31
@j-luong j-luong requested a review from a team as a code owner April 3, 2024 08:31
@thisislawatts thisislawatts enabled auto-merge (squash) April 3, 2024 08:33
@thisislawatts
Copy link
Member

praise: Good catch @j-luong, great to fix these potential memory problems

@j-luong j-luong force-pushed the fix/doNotOutputVeryLargeJson branch from a48a7e5 to c02dd4b Compare April 3, 2024 10:12
@j-luong j-luong disabled auto-merge April 3, 2024 10:31
@j-luong j-luong enabled auto-merge (squash) April 3, 2024 10:31
@j-luong j-luong merged commit 84b5e8b into main Apr 3, 2024
14 checks passed
@j-luong j-luong deleted the fix/doNotOutputVeryLargeJson branch April 3, 2024 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants