divviup / divviup/divviup-api

cli: incorrect helper-id error is confusing

Open
#1,141 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
10
Forks
5
Avg merge
2h 41m
Merged PRs (30d)
66

Description

I miskeyed a helper id while going through the README and the error made it sound like I didn't provide the flag when in fact I just had an incorrect ID. Also, it is weird the error message has underscores instead of dashes- some sort of CLI library thing?

$ divviup task create --name net-promoter-score --leader-aggregator-id c6a780d8-e0d3-4881-93dc-5b4af3712734 --helper-aggregator-id 96301951-c848-4a57-b4f5-32812e4db1be --collector-credential-id b24c97c9-1aff-4ff4-875c-cac4f6834b86 --vdaf histogram --categorical-buckets 0,1,2,3,4,5,6,7,8,9,10 --min-batch-size 100 --max-batch-size 200 --time-precision 60sec
Validation errors:
  - helper_aggregator_id:
    * required

$ 

Contributor guide

No contributing guide indexed for this repository

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

Reproduce the validation output from the README's divviup task create example using an incorrect helper aggregator ID. Trace the CLI validation entry point and check how missing and invalid IDs are distinguished. Done means an incorrect ID gets an accurate error and the displayed field name uses dashes rather than underscores.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.