mirror of
https://github.com/larksuite/cli.git
synced 2026-07-03 14:02:43 +08:00
fe72e41fb2
Introduce a typed error contract framework for lark-cli so in-process
Go callers can branch via errors.As(&errs.XxxError{}) and shell scripts,
AI agents, and protocol adapters can branch on stable JSON type/subtype
fields instead of regex-parsing free-form messages.
Adds:
- Canonical taxonomy under errs/ (9 categories + typed Error structs
embedding a shared Problem, RFC 7807-aligned)
- Centralized Lark code metadata + identity-aware BuildAPIError dispatch
- Typed JSON envelope writer alongside the legacy envelope writer
- MCP / OAuth (RFC 6750 Bearer) projection adapters
- Five CI lint guards preventing ad-hoc taxonomy drift
Backward compatibility: legacy *output.ExitError producers (ErrAPI,
ErrWithHint, Errorf, ErrBare) and business shortcuts that use them
continue to render the legacy envelope unchanged. SecurityPolicyError
wire format and exit code are preserved via a carve-out; taxonomy
migration is deferred to PR 2. Domain-specific business migration is
staged across PR 3+.
Framework-direct paths now return typed *errs.*Error: ErrAuth /
ErrValidation / ErrNetwork emit category literals on the wire
(authentication / validation / network), *core.ConfigError is promoted
at the cmd/root boundary with exit code aligned from 2 to 3, and Lark
API permission denials classified by BuildAPIError exit 3.
At the SDK boundary, WrapDoAPIError preserves any already-classified
error (legacy *output.ExitError or typed *errs.*) so output.ErrAuth
from missing credentials surfaces with the auth category and exit 3
intact instead of being downgraded to a network error. Policy responses
classified by BuildAPIError (codes 21000 / 21001) extract challenge_url
and the canonical hint from the response body, matching what the
auth transport already surfaces at the HTTP layer; non-https
challenge URLs are dropped.
First PR in the feat/error-contract-* series.
39 lines
1.4 KiB
Go
39 lines
1.4 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package errs
|
|
|
|
// Problem is the RFC 7807-aligned shared shape embedded by every typed error.
|
|
//
|
|
// Message is REQUIRED. Producers must populate it; an empty Message will make
|
|
// Error() return "" — a known Go footgun for fmt.Errorf("...: %v", err).
|
|
//
|
|
// Wire-format notes:
|
|
// - No Component field. Service / shortcut component is metric-only
|
|
// enrichment derived by the dispatcher from the cobra command path; it
|
|
// never appears on the wire.
|
|
// - No DocURL field. PermissionError carries the same intent via its typed
|
|
// ConsoleURL extension; other typed errors do not link out.
|
|
// - Retryable uses omitempty so only `true` is emitted; consumers treat
|
|
// absence as false.
|
|
type Problem struct {
|
|
Category Category `json:"type"`
|
|
Subtype Subtype `json:"subtype,omitempty"`
|
|
Code int `json:"code,omitempty"`
|
|
Message string `json:"message"`
|
|
Hint string `json:"hint,omitempty"`
|
|
LogID string `json:"log_id,omitempty"`
|
|
Retryable bool `json:"retryable,omitempty"`
|
|
}
|
|
|
|
// Error satisfies the standard `error` interface. A nil receiver is treated
|
|
// as the empty string so a stray nil *Problem stored in an error interface
|
|
// cannot panic the dispatcher.
|
|
func (p *Problem) Error() string {
|
|
if p == nil {
|
|
return ""
|
|
}
|
|
return p.Message
|
|
}
|
|
func (p *Problem) ProblemDetail() *Problem { return p }
|