ipfs/kubo

Provide sentinel errors in the HTTP API

Open

#7,307 opened on May 12, 2020

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)Go (2,725 forks)batch import
P3help wantedkind/enhancementstatus/readytopic/rpc-api

Repository metrics

Stars
 (13,906 stars)
PR merge metrics
 (PR metrics pending)

Description

Matching errors against concrete types would be nice vs. fragile error string matching, e.g.,

if err.Error() == "'from' cid was not recursively pinned already" { ...

Or, maybe using more fine grained error codes would be even better. I believe the above error will come with a code: ErrNormal or similar.

Contributor guide

Research direction
Examine the HTTP API handler for pinning. Identify places using fragile string matching on errors (e.g., err.Error() == "'from' cid was not recursively pinned already"). Determine if sentinel errors or custom error types are already defined (like ErrNormal). Then replace string comparisons with errors.Is() or errors.As() using those sentinel errors.
Tech stack
go
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GoError handling in Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60