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: project name when using assets-project-name flag #5077

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

37IulianPopovici
Copy link
Contributor

@37IulianPopovici 37IulianPopovici commented Feb 26, 2024

Pull Request Submission

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?

Fixes a bug regarding the usage of the --assets-project-name flag
Without this fix, when using the above flag, the name of the monitored project it's going to be: {{ProjectNameFromAssetsJsonFile}}:{{targetFile}}, which is the default behaviour.
With this fix, when using --assets-project-name flag flag, project name will be: {{ProjectNameFromAssetsJsonFile}}

Risk assessment

Even though project naming is a sensible place, this PR is not imposing any risk. The flag it's only used for dotnet projects.

Where should the reviewer start?

How should this be manually tested?

For manual testing, this fixture can be used along with snyk monitor --assets-project-name

Any background context you want to provide?

Client is complaining that --assets-project-name flag it's broken since CLI v.1.1225.0. That version included a fix for project naming along multiple ecosystems, but never for the --assets-project-name flag

What are the relevant tickets?

SUP-2285

Screenshots

Additional questions

@37IulianPopovici 37IulianPopovici self-assigned this Feb 26, 2024
@37IulianPopovici 37IulianPopovici requested a review from a team as a code owner February 26, 2024 11:50
Copy link
Contributor

github-actions bot commented Feb 26, 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:

  • src/cli/commands/monitor/index.ts

Generated by 🚫 dangerJS against 63b8238

@thisislawatts thisislawatts force-pushed the fix/project-name-when-using-assets-cli-option branch from cd1d541 to 7be7621 Compare March 6, 2024 08:54
@@ -47,6 +47,10 @@ export function getProjectName(
return scannedProject.meta.gradleProjectName;
}

if (meta.assetsProjectName) {
return scannedProject.depTree?.name;
}
Copy link
Member

Choose a reason for hiding this comment

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

question (non-blocking): Is it desired behaviour for this to return an undefined or do we want it always to return a string?

@37IulianPopovici 37IulianPopovici force-pushed the fix/project-name-when-using-assets-cli-option branch from 7be7621 to 4e6f907 Compare March 12, 2024 12:04
@37IulianPopovici 37IulianPopovici force-pushed the fix/project-name-when-using-assets-cli-option branch from 4e6f907 to 63b8238 Compare March 12, 2024 12:05
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