Khan/genqlient

Redo error-formatting utilities to be a bit more idiomatic

Open

#118 ouverte le 28 sept. 2021

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Go (141 forks)github user discovery
good first issuehelp wantedinternal

Métriques du dépôt

Stars
 (1 310 stars)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Explorez les deux approches suggérées : (1) formater la position au moment de l'appel en utilisant fmt.Errorf, ou (2) faire en sorte que errorf utilise %w et remonte la position jusqu'à l'erreur la plus externe. Regardez l'utilisation actuelle de errorf dans generate/errors.go et comment les erreurs sont utilisées ailleurs.
Stack technique
go
Domaine
backend
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GoGo error handling
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75