[Snyk] Fix for 4 vulnerabilities #11889
Conversation
The following vulnerabilities are fixed with an upgrade: - https://snyk.io/vuln/SNYK-JS-BACKSTAGEPLUGINTECHDOCSNODE-15166604 - https://snyk.io/vuln/SNYK-JS-BACKSTAGEPLUGINTECHDOCSNODE-15166605 - https://snyk.io/vuln/SNYK-JS-WEBPACK-15235959 - https://snyk.io/vuln/SNYK-JS-WEBPACK-15235969
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 security posture of the project by upgrading several core Backstage dependencies within the Highlights
Changelog
Activity
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 the dependency management strategy for the techdocs-cli package by replacing workspace protocol references with explicit version numbers. Three Backstage dependencies are pinned to specific versions: backend-common (0.24.1), config (0.1.1), and plugin-techdocs-node (1.13.11). This change transitions from workspace-relative versioning to fixed version specifications, which ensures consistent dependency resolution across different environments and is typically done in preparation for package publication or standalone distribution. Changes
Sequence DiagramThis diagram shows the interactions between components: sequenceDiagram
participant PM as Package Manager
participant TechDocs as techdocs-cli
participant BC as @backstage/backend-common
participant Config as @backstage/config
participant TDNode as @backstage/plugin-techdocs-node
Note over PM,TDNode: Dependency Resolution Change (No Runtime Impact)
PM->>TechDocs: Install dependencies
Note over PM,BC: Previously: workspace:^<br/>Now: 0.24.1 (pinned)
PM->>BC: Resolve version 0.24.1
BC-->>PM: Package installed
Note over PM,Config: Previously: workspace:^<br/>Now: 0.1.1 (pinned)
PM->>Config: Resolve version 0.1.1
Config-->>PM: Package installed
Note over PM,TDNode: Previously: workspace:^<br/>Now: 1.13.11 (pinned)
PM->>TDNode: Resolve version 1.13.11
TDNode-->>PM: Package installed
PM-->>TechDocs: Dependencies ready
Note over TechDocs: Runtime behavior unchanged<br/>Only version resolution differs
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. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request, automatically generated by Snyk, aims to fix security vulnerabilities by updating dependencies. However, the proposed changes are problematic for this monorepo. Specifically, it replaces workspace: specifiers with pinned versions, and critically, it downgrades @backstage/config from 1.0.8 to 0.1.1. This downgrade is very likely to break the application. I've recommended reverting these changes and manually addressing the vulnerabilities in a way that is compatible with the monorepo's structure.
| "@backstage/backend-common": "0.24.1", | ||
| "@backstage/catalog-model": "workspace:^", | ||
| "@backstage/cli-common": "workspace:^", | ||
| "@backstage/config": "workspace:^", | ||
| "@backstage/plugin-techdocs-node": "workspace:^", | ||
| "@backstage/config": "0.1.1", | ||
| "@backstage/plugin-techdocs-node": "1.13.11", |
There was a problem hiding this comment.
These automated dependency updates from Snyk appear to be incorrect for this monorepo setup. Pinning versions instead of using workspace:^ can break the local development workflow and lead to inconsistencies.
Most critically, the version for @backstage/config is being downgraded from 1.0.8 to 0.1.1, which will almost certainly cause build failures or runtime errors.
The PR description also notes that it Failed to update the yarn.lock, which further indicates these changes are incomplete and require manual review.
It is strongly recommended to revert these changes. The security vulnerabilities should be addressed by correctly updating the package versions within the workspace, rather than applying these automated, and in this case incorrect, changes.
"@backstage/backend-common": "workspace:^",
"@backstage/catalog-model": "workspace:^",
"@backstage/cli-common": "workspace:^",
"@backstage/config": "workspace:^",
"@backstage/plugin-techdocs-node": "workspace:^"2 participants
Snyk has created this PR to fix 4 vulnerabilities in the yarn dependencies of this project.
Snyk changed the following file(s):
packages/techdocs-cli/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-BACKSTAGEPLUGINTECHDOCSNODE-15166604
SNYK-JS-BACKSTAGEPLUGINTECHDOCSNODE-15166605
SNYK-JS-WEBPACK-15235959
SNYK-JS-WEBPACK-15235969
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:
🦉 Arbitrary Code Injection
🦉 Directory Traversal
🦉 Server-side Request Forgery (SSRF)
EntelligenceAI PR Summary
This PR pins Backstage dependencies to explicit versions in the techdocs-cli package, replacing workspace protocol references.
@backstage/backend-commonfromworkspace:^to version0.24.1@backstage/configfromworkspace:^to version0.1.1@backstage/plugin-techdocs-nodefromworkspace:^to version1.13.11