graphprotocol / graphprotocol/indexer
Indexer-common: Improve error passing through to graphQL response
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 262
- Forks
- 148
- PR merge metrics
- No merged PRs in 30d
Description
IndexerError includes an error code (IndexerErrorCode), a general explanation for that specific error code (string) and a cause (IndexerErrorCause) for that specific instance of the error. Only the error code and generalized explanation are currently passed back in the graphQL response upon a failure; this makes it difficult to identify the cause of the issue without digging into the backend logs.
Let's find a way to pass the cause back to the client along with the error code and explanation.
Contributor guide
No contributing guide indexed for this repository
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 tracing IndexerError, IndexerErrorCode, and IndexerErrorCause through the GraphQL error-response path. Identify where the error code and explanation are serialized; done means failed responses also expose the instance-specific cause alongside them, with the relevant failure behavior verified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100