openfga / openfga/cli

Display progress when running `fga tuple read`

Open
#570 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
102
Forks
49
Avg merge
1d 1h
Merged PRs (30d)
16

Description

fga tuple read reads all tuples sequentially, which can take a lot of time for large tuple counts.

We should display progress. Every 50k tuples, we should display the number of tuples read, tuples per second and read calls per second, so it's possible for users to understand how long it will take.

We can only display progress when the --output-file option is specified (see https://github.com/openfga/cli/issues/569).

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 with the implementation and tests for the fga tuple read command, then check how --output-file is handled and review issue 569 for the output constraint. Done means that, when writing to an output file, the command reports every 50k tuples read with tuple count, tuples per second, and read calls per second.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, performance
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.