refactor: drop the URL-based error classifier and hint lookups

Errors are named by the service call that failed: Classify,
NotFoundError and ConflictError at the call site. Remove the endpoint
parser that guessed the resource from the request path, and the
follow-up reads the explainer made at error time (repository state,
issue-vs-pull-request, the existing pull request's URL) together with
the credentialed transport each API error carried for them.

Calls that the endpoint parser covered and the services did not now
classify themselves: issues, pull requests, reviews, comments,
releases, branches, wiki pages, repositories, organizations and SSH
keys. Unclassified failures fall back to the generic
"not found (HTTP 404 GET ...)" text.

Signed-off-by: bircni <bircni@icloud.com>
This commit is contained in:
bircni committed 2026-10-12 10:40:45 +02:00
1 parent ea13c9e4f5
commit 27e39ec4be
20 files changed
+129 -495

No files matched your search

+11 -85
View File
@@ -10,7 +10,6 @@ import (
"fmt"
"net"
"net/http"
"strconv"
"strings"
"syscall"
"time"
@@ -19,9 +18,6 @@ import (
"gitea.dev/tea/internal/transport"
)
// lookupTimeout bounds the follow-up reads that explain a failed request.
const lookupTimeout = 5 * time.Second
// explainedError replaces the message of err and keeps err reachable for exit codes.
type explainedError struct {
text string
@@ -36,16 +32,15 @@ func explain(err error, format string, args ...any) error {
return &explainedError{text: fmt.Sprintf(format, args...), err: err}
}
// Explain words a command failure for people. It names the resource a failed request addressed
// ("issue #9 not found in alice/x"), tells a missing or inaccessible repository from a disabled
// feature, adds the next step to refusals Gitea explains, and words rejected credentials,
// unreachable servers and expired timeouts. Exit codes are unchanged.
// Explain words a command failure for people. It adds the next step to refusals Gitea explains,
// and words rejected credentials, unreachable servers and expired timeouts. Exit codes are
// unchanged.
func Explain(ctx context.Context, deps Dependencies, err error) error {
if err == nil || errors.As(err, new(*explainedError)) {
return err
}
if apiErr, ok := errors.AsType[*transport.APIError](err); ok {
return explainAPIError(ctx, deps, err, apiErr)
return explainAPIError(deps, err, apiErr)
}
if failure, ok := errors.AsType[*transport.RequestFailure](err); ok {
if reason := unreachable(failure.Err); reason != "" && failure.Server != "" {
@@ -58,7 +53,7 @@ func Explain(ctx context.Context, deps Dependencies, err error) error {
return err
}
func explainAPIError(ctx context.Context, deps Dependencies, err error, apiErr *transport.APIError) error {
func explainAPIError(deps Dependencies, err error, apiErr *transport.APIError) error {
if !explainable(err, apiErr) {
return err
}
@@ -69,27 +64,11 @@ func explainAPIError(ctx context.Context, deps Dependencies, err error, apiErr *
}
return explain(err, "authentication rejected by %s; run tea auth login", instance)
}
// Errors a service classified keep its wording; others are classified by their endpoint.
classified := err
if !errors.As(err, new(*services.NotFoundError)) && !errors.As(err, new(*services.ConflictError)) {
classified = services.ClassifyRequest(err)
}
ctx, cancel := context.WithTimeout(ctx, lookupTimeout)
defer cancel()
resource := services.RequestResource(apiErr.Endpoint)
if apiErr.Status == http.StatusNotFound && resource.Repository != "" {
if explained := explainRepositoryNotFound(ctx, apiErr, resource); explained != "" {
return explain(err, "%s", explained)
}
}
if conflict, ok := errors.AsType[*services.ConflictError](classified); ok && conflict.Hint == "" {
if hint := conflictHint(ctx, apiErr, conflict); hint != "" {
if conflict, ok := errors.AsType[*services.ConflictError](err); ok && conflict.Hint == "" {
if hint := conflictHint(apiErr, conflict); hint != "" {
return explain(err, "%s; %s", conflict.Error(), hint)
}
}
if classified != err {
return explain(err, "%s", classified.Error())
}
return err
}
@@ -111,47 +90,8 @@ func explainable(err error, apiErr *transport.APIError) bool {
return apiErr.Error() == text
}
// explainRepositoryNotFound tells why a request on a repository found nothing: the repository is
// missing or hidden, the feature is disabled, the repository is empty, or a pull request number
// names an issue. It returns "" when the resource itself is missing.
func explainRepositoryNotFound(ctx context.Context, apiErr *transport.APIError, resource services.Resource) string {
repo := resource.Repository
var state services.RepositoryState
status := http.StatusNotFound
if resource.Kind != "repository" {
state, status = services.LookupRepository(ctx, apiErr, repo)
}
switch status {
case http.StatusNotFound:
return fmt.Sprintf("repository %s not found on %s (or you don't have access)", repo, cmp.Or(apiErr.Instance, "the instance"))
case http.StatusOK:
default:
return ""
}
features := map[string]struct {
name string
enabled bool
}{
"issues": {"issues are", state.Issues}, "pulls": {"pull requests are", state.PullRequests},
"wiki": {"the wiki is", state.Wiki}, "releases": {"releases are", state.Releases},
"actions": {"Actions are", state.Actions}, "projects": {"projects are", state.Projects},
}
if feature, ok := features[resource.Section]; ok && !feature.enabled {
return feature.name + " disabled for " + repo
}
if state.Empty && resource.Section == "pulls" {
return repo + " is empty; it has no pull requests"
}
if number, ok := strings.CutPrefix(resource.Key, "#"); ok && resource.Kind == "pull request" {
if index, err := strconv.ParseInt(number, 10, 64); err == nil && services.LookupIsIssue(ctx, apiErr, repo, index) {
return fmt.Sprintf("#%s in %s is an issue, not a pull request; view it with: tea issue view %s", number, repo, number)
}
}
return ""
}
// conflictHint returns the next step for a refused request, or "".
func conflictHint(ctx context.Context, apiErr *transport.APIError, conflict *services.ConflictError) string {
func conflictHint(apiErr *transport.APIError, conflict *services.ConflictError) string {
number := strings.TrimPrefix(conflict.Key, "#")
switch conflict.Reason {
case services.ReasonArchived:
@@ -159,7 +99,9 @@ func conflictHint(ctx context.Context, apiErr *transport.APIError, conflict *ser
return "unarchive it with: tea repo unarchive " + conflict.Scope
}
case services.ReasonExists:
return existsHint(ctx, apiErr, conflict)
if conflict.Kind == "wiki page" {
return "edit it with: tea wiki edit " + conflict.Key
}
case services.ReasonMerged:
if apiErr.Method == http.MethodPatch {
return "its state can no longer change"
@@ -186,22 +128,6 @@ func conflictHint(ctx context.Context, apiErr *transport.APIError, conflict *ser
return ""
}
func existsHint(ctx context.Context, apiErr *transport.APIError, conflict *services.ConflictError) string {
switch conflict.Kind {
case "pull request":
head, base, ok := strings.Cut(strings.TrimPrefix(conflict.Key, "for "), " into ")
if !ok || conflict.Scope == "" {
return ""
}
if pullURL := services.LookupPullURL(ctx, apiErr, conflict.Scope, base, head); pullURL != "" {
return "see " + pullURL
}
case "wiki page":
return "edit it with: tea wiki edit " + conflict.Key
}
return ""
}
// unreachable words a failure to connect, or returns "" for other request failures.
func unreachable(err error) string {
var dnsErr *net.DNSError