Explore caching index for gems
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 2k
- Forks
- 281
- Avg merge
- 2h 14m
- Merged PRs (30d)
- 6
Description
Caching the index for gems is easier than caching the entire index because we know the files will only change if the version of the gem has changed.
I think we can get a considerable performance improvement on indexing if we cache the entries for gems. Something like
.ruby-lsp/
Gemfile
Gemfile.lock
cache/
rails-7.1.0
yarp-0.12.0
Where each gem cache is basically a Marshal dump of the index. This may require defining a way to merge different indices.
For the long term, it would be amazing if rubygems could generate the index cache during packaging, so that all gems are exported with an index by default. By doing the work ahead of time, we would be guaranteed to always have cached indices for all gems, significantly speeding up indexing.
### Tasks
- [ ] https://github.com/Shopify/ruby-lsp/issues/1919
- [ ] Cache indexed gems
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 reviewing linked issue #1919 and the existing gem-indexing entry point; this issue does not name specific files or tests. Define the per-gem cache format, invalidation behavior, and index-merging approach. Done means indexed gem entries can be reused safely and performance is verified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- performance
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100