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(test, monitor): fixed support for pnpm alias packages #5426

Merged
merged 1 commit into from
Aug 20, 2024

Conversation

gemaxim
Copy link
Contributor

@gemaxim gemaxim commented Aug 15, 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?

It bumps nodejs plugins with version that includes:

  1. fixed support for pnpm aliases - fix: [OSM-1996] support pnpm packages aliases nodejs-lockfile-parser#248
  2. earlier fail for Out Of Sync errors for pnpm - fix: fail early for top level deps out of sync pnpm and updated tests nodejs-lockfile-parser#249

Where should the reviewer start?

Read the descriptions for the PRs mentioned above.
Overall functionality is covered by existing tests specified below.
This fix is covering an edge case for how some pnpm packages are mentioned as aliases (e.g. string-width-cjs: string-width@4.2.3 in a pnpm lockfile).
Unit testing has been added for these fixes (see PRs) and the snyk-nodejs-plugin also runs the testing pipeline on multiple OSs to ensure no breaking changes.

How should this be manually tested?

Overall functionality for pnpm is covered by acceptance tests here:

Run snyk test locally with enablePnpmCli feature flag enabled on any of the pnpm projects added as fixtures here

Any background context you want to provide?

The bug was discovered here

What are the relevant tickets?

Thread for the cause of this needed fix.
JIRA Ticket

Screenshots

Additional questions

@gemaxim gemaxim requested a review from a team as a code owner August 15, 2024 18:15
@gemaxim gemaxim self-assigned this Aug 15, 2024
@gemaxim gemaxim force-pushed the fix/pnpm-alias-support branch from 4633acc to 6e02555 Compare August 15, 2024 18:16
@gemaxim gemaxim changed the title fix: fixed support for pnpm alias packages fix(test, monitor): fixed support for pnpm alias packages Aug 15, 2024
@gemaxim gemaxim force-pushed the fix/pnpm-alias-support branch from 6e02555 to d506de1 Compare August 16, 2024 13:55
@sandor-trombitas sandor-trombitas merged commit 87abc41 into main Aug 20, 2024
11 checks passed
@sandor-trombitas sandor-trombitas deleted the fix/pnpm-alias-support branch August 20, 2024 11:24
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