graphprotocol / graphprotocol/indexer

Improve error message on misconfigured indexer-cli

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

Nobody has claimed this yet.

enhancement indexer-cli
Dominant language
TypeScript
Stars
262
Forks
148
PR merge metrics
No merged PRs in 30d

Description

When the indexer-cli is configured to connect to the wrong url:port the error message returned is unclear, ✖ [Network] Not Found.

We should return a clear error message with a helpful hint. Something like:
Indexer management server not found at ${url}. Did you configure the connection correctly? Use `indexer connect <url>` to configure the connection.

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

Start in the indexer-cli code that handles connections to the indexer management server and inspect how a wrong URL:port becomes the [Network] Not Found error. Configure the CLI with an incorrect endpoint and verify that the completed change reports the endpoint, explains the likely configuration problem, and shows the indexer connect <url> command.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Bug
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.