matrix-org / matrix-org/pinecone
Sim Feature: Can start/stop the graph sim from running
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 486
- Forks
- 37
- PR merge metrics
- No merged PRs in 30d
Description
The visjs graph can consume a lot of processor time when simulating large networks. This results in two potentially undesirable behaviours.
1. simulation state update messages taking longer to be processed as they are received
2. processor usage gets really high
It would be beneficial to be able to "pause" the visjs simulation. This would greatly reduce the processing currently happening and allows the sim ui to quickly process new updates. Visjs already has this ability in the API, the sim just needs some added UI and to have it hooked up.
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
Locate the sim UI and its visjs simulation setup, then read the existing update flow and visjs pause/resume API. Add the UI control and connect it to starting and stopping the simulation; done when pausing reduces simulation work while updates remain responsive and resuming restarts it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100