Khan/genqlient

Redo error-formatting utilities to be a bit more idiomatic

Open

#118 aberto em 28 de set. de 2021

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

Métricas do repositório

Stars
 (1.310 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Explore as duas abordagens sugeridas: (1) formatar a posição no momento da chamada usando fmt.Errorf, ou (2) fazer com que errorf use %w e eleve a posição para o erro mais externo. Veja o uso atual de errorf em generate/errors.go e como os erros são usados em outros lugares.
Pilha de tecnologia
go
Domain
backend
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GoGo error handling
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75