Consider removing dependency on simple-websocket
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.5k
- Forks
- 228
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 48
Description
The simple-websocket package does not seem to be actively maintained as the last commit is from 5 years ago
This is a challenge because it impacts redocly-cli indirectly via transitive dependencies. For example, CVE-2024-37890 is a recent example
npm ls ws
└─┬ @redocly/cli@1.34.3
└─┬ simple-websocket@9.1.0
└── ws@7.5.
Although users can manually override ws to address this, it does not provide a great experience
Additional context: https://github.com/feross/simple-websocket/issues/67
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running npm ls ws in redocly-cli and tracing the transitive dependency through simple-websocket. No source file or test is named, so identify the dependency entry point and assess replacement or removal options. Done means redocly-cli no longer relies on the unmaintained package while avoiding the reported vulnerable ws dependency.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, security
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100