-
Notifications
You must be signed in to change notification settings - Fork 1
[Snyk] Fix for 3 vulnerabilities #11548
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
base: master
Are you sure you want to change the base?
Conversation
The following vulnerabilities are fixed with an upgrade: - https://snyk.io/vuln/SNYK-JS-TAR-15032660 - https://snyk.io/vuln/SNYK-JS-TAR-15127355 - https://snyk.io/vuln/SNYK-JS-ESLINT-15102420
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
Summary of ChangesHello @q1blue, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request, automatically generated by Snyk, aims to enhance the project's security posture by resolving critical vulnerabilities within its Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
WalkthroughThis PR updates dependency management for the techdocs-node plugin by transitioning from workspace protocol references to fixed version specifications. Two Backstage packages are affected: Changes
Sequence DiagramThis diagram shows the interactions between components: sequenceDiagram
participant Dev as Developer
participant PM as Package Manager
participant Deps as Dependencies
Note over Dev,Deps: Dependency Version Update Process
Dev->>PM: Update package.json
Note right of Dev: Pin @backstage/backend-common to 0.24.1<br/>Pin @backstage/plugin-search-common to 0.3.1
PM->>Deps: Resolve dependencies
Deps-->>PM: Return specific versions
PM->>PM: Install pinned versions
Note over PM: Replace workspace references<br/>with fixed versions
PM-->>Dev: Dependencies updated
Note over Dev,Deps: No runtime behavior changes<br/>Only build-time dependency resolution affected
Note for WindsurfPlease change the default marketplace provider to the following in the windsurf settings:Marketplace Extension Gallery Service URL: https://marketplace.visualstudio.com/_apis/public/gallery Marketplace Gallery Item URL: https://marketplace.visualstudio.com/items Entelligence.ai can learn from your feedback. Simply add 👍 / 👎 emojis to teach it your preferences. More shortcuts belowEmoji Descriptions:
Interact with the Bot:
Also you can trigger various commands with the bot by doing The current supported commands are
More commands to be added soon. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request from Snyk aims to fix three security vulnerabilities by pinning two @backstage dependencies to specific versions. While the intent is good, the pull request is incomplete as it's missing the yarn.lock update, which is a critical part of the fix. Additionally, pinning workspace dependencies to registry versions is a workaround that breaks the monorepo development flow and should be avoided in favor of a more integrated fix. My review includes a critical comment about the missing lockfile and a high-severity comment explaining the issue with pinning and suggesting a better approach.
| "@backstage/backend-common": "0.24.1", | ||
| "@backstage/catalog-model": "workspace:^", | ||
| "@backstage/config": "workspace:^", | ||
| "@backstage/errors": "workspace:^", | ||
| "@backstage/integration": "workspace:^", | ||
| "@backstage/integration-aws-node": "workspace:^", | ||
| "@backstage/plugin-search-common": "workspace:^", | ||
| "@backstage/plugin-search-common": "0.3.1", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| "@backstage/backend-common": "0.24.1", | ||
| "@backstage/catalog-model": "workspace:^", | ||
| "@backstage/config": "workspace:^", | ||
| "@backstage/errors": "workspace:^", | ||
| "@backstage/integration": "workspace:^", | ||
| "@backstage/integration-aws-node": "workspace:^", | ||
| "@backstage/plugin-search-common": "workspace:^", | ||
| "@backstage/plugin-search-common": "0.3.1", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pinning workspace packages like @backstage/backend-common and @backstage/plugin-search-common to specific versions from the registry breaks the monorepo development workflow. This means local changes in those packages will be ignored when working on techdocs-node, which can lead to confusion and bugs.
While this might be a quick way to fix a security issue, it's a workaround. The proper fix is to update the dependency that introduces the vulnerability, while keeping the workspace:^ reference. You can use yarn why <vulnerable-package> to trace the dependency path.
If this is intended as a temporary hotfix, I recommend creating a follow-up ticket to address this properly. For a permanent fix, the workspace: protocol should be restored.
"@backstage/backend-common": "workspace:^",
"@backstage/catalog-model": "workspace:^",
"@backstage/config": "workspace:^",
"@backstage/errors": "workspace:^",
"@backstage/integration": "workspace:^",
"@backstage/integration-aws-node": "workspace:^",
"@backstage/plugin-search-common": "workspace:^"
Snyk has created this PR to fix 3 vulnerabilities in the yarn dependencies of this project.
Snyk changed the following file(s):
plugins/techdocs-node/package.jsonNote for zero-installs users
If you are using the Yarn feature zero-installs that was introduced in Yarn V2, note that this PR does not update the
.yarn/cache/directory meaning this code cannot be pulled and immediately developed on as one would expect for a zero-install project - you will need to runyarnto update the contents of the./yarn/cachedirectory.If you are not using zero-install you can ignore this as your flow should likely be unchanged.
Vulnerabilities that will be fixed with an upgrade:
SNYK-JS-TAR-15032660
SNYK-JS-TAR-15127355
SNYK-JS-ESLINT-15102420
Important
Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open fix PRs.
For more information:
🧐 View latest project report
📜 Customise PR templates
🛠 Adjust project settings
📚 Read about Snyk's upgrade logic
Learn how to fix vulnerabilities with free interactive lessons:
🦉 Directory Traversal
EntelligenceAI PR Summary
This PR pins Backstage dependencies to specific versions in the techdocs-node plugin package configuration.
@backstage/backend-commonfromworkspace:^to fixed version0.24.1@backstage/plugin-search-commonfromworkspace:^to fixed version0.3.1plugins/techdocs-node/package.json