Khan/genqlient

Redo error-formatting utilities to be a bit more idiomatic

Open

#118 opened on Sep 28, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (141 forks)github user discovery
good first issuehelp wantedinternal

Repository metrics

Stars
 (1,310 stars)
PR merge metrics
 (PR metrics pending)

Description

We have our own errorf (in generate/errors.go) so that we can do structured errors with positions. But our errorf is a bit un-idiomatic (which caused confusion in #117) -- it just wraps the first error argument it finds rather than using %w -- and it also doesn't actually format wrapped errors in a very good way (e.g. here). We could probably do better, either having our wrapper do an ordinary fmt.Errorf (by formatting the position at call-time), or by making it a bit more idiomatic and using its extra structure to hoist the position to the outermost error.

Contributor guide

Research direction
Explore the two suggested approaches: (1) format position at call time using fmt.Errorf, or (2) make errorf use %w and hoist position to outermost error. Look at current usage of errorf in generate/errors.go and how errors are used elsewhere.
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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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.
Clear
Prerequisites
GoGo error handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75