Shopify / Shopify/rubydex

Use a graph flag to control whether the graph should be used without resolution

Open
#703 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
355
Forks
24
Avg merge
2d 6h
Merged PRs (30d)
17

Description

We don't have a use case for this kind of usage yet, but if we want to support using rubydex without resolution, we want to let user explicitly configure that so the resolution items don't accumulate and waste memory.

Based on our discussion, the design should look like this:

graph = Graph.new(without_resolution: true) # or `resolution: false`?
# there will be no setter to change this
graph.index_source(...) # doesn't create pending work items

graph.resolve() # raise

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the Graph.new, graph.index_source(...), and graph.resolve() entry points to understand where resolution work is created. Confirm the flag name and verify that indexing without resolution does not accumulate pending items, while resolve() raises in that mode.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby, rust
Domain
devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.