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

feat: enable cocoapods to send graphs for cli monitor #5487

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

JCheung2004
Copy link
Member

@JCheung2004 JCheung2004 commented Sep 13, 2024

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?

Enables Cocoapods projects to always send depGraph when used with snyk monitor instead of depTrees.

Relevant registry PR linked here for reference, as they do not work without both being in tandem.

Risk Assessment [LOW]

Where should the reviewer start?

depGraph has always been supported by snyk test and snyk monitor when used with -p to pruneSubrepeatedDependencies, where a conversion from depTree to depGraph is configured. This just forces this to always come as a depGraph. The reviewer can check both the registry PR and also this CLI PR.

How should this be manually tested?

This can be tested by using an older version of registry + cli combination where you can see that any default Cocoapods scan is always sent as a depTree first.

Any background context you want to provide?

This was adjusted to help solve the issues in regards to 'Invalid String Length' issues where a depTree for some Cocoapods projects would provide this JSON error, but depGraphs more workable and do not provide this potential error.

Copy link
Contributor

github-actions bot commented Sep 13, 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-monitor.acceptance.test.ts
⚠️ There are multiple commits on your branch, please squash them locally before merging!

Generated by 🚫 dangerJS against 924bc8c

@JCheung2004 JCheung2004 force-pushed the OSM-1933/cocoapods-post-graph-monitor branch 5 times, most recently from b553433 to bdee499 Compare September 20, 2024 13:45
@JCheung2004 JCheung2004 self-assigned this Sep 20, 2024
@JCheung2004 JCheung2004 force-pushed the OSM-1933/cocoapods-post-graph-monitor branch from 9278f27 to 0e48191 Compare September 20, 2024 13:56
@JCheung2004 JCheung2004 marked this pull request as ready for review September 20, 2024 14:06
@JCheung2004 JCheung2004 requested a review from a team as a code owner September 20, 2024 14:06
@JCheung2004 JCheung2004 force-pushed the OSM-1933/cocoapods-post-graph-monitor branch from 58252d6 to 4f2960b Compare September 20, 2024 14:53
@JCheung2004 JCheung2004 force-pushed the OSM-1933/cocoapods-post-graph-monitor branch from 4f2960b to 924bc8c Compare September 20, 2024 15:02
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.

1 participant