mirror of
https://github.com/larksuite/cli.git
synced 2026-07-03 22:24:31 +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.
73 lines
2.0 KiB
Go
73 lines
2.0 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package errs
|
|
|
|
import (
|
|
"reflect"
|
|
"testing"
|
|
)
|
|
|
|
func TestProblemError(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
p Problem
|
|
want string
|
|
}{
|
|
{"empty message", Problem{}, ""},
|
|
{"plain message", Problem{Message: "boom"}, "boom"},
|
|
{"message ignores hint", Problem{Message: "msg", Hint: "do x"}, "msg"},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
if got := (&tt.p).Error(); got != tt.want {
|
|
t.Errorf("Error() = %q, want %q", got, tt.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// TestProblemError_NilReceiverDoesNotPanic pins the nil-receiver guard on
|
|
// (*Problem).Error(). Without it, a nil *Problem stored in an error interface
|
|
// would panic when the root dispatcher calls err.Error() for logging.
|
|
func TestProblemError_NilReceiverDoesNotPanic(t *testing.T) {
|
|
var p *Problem // nil
|
|
defer func() {
|
|
if r := recover(); r != nil {
|
|
t.Fatalf("(*Problem)(nil).Error() panicked: %v", r)
|
|
}
|
|
}()
|
|
if got := p.Error(); got != "" {
|
|
t.Errorf("(*Problem)(nil).Error() = %q, want \"\"", got)
|
|
}
|
|
}
|
|
|
|
func TestProblemDetailReturnsReceiver(t *testing.T) {
|
|
p := &Problem{Message: "x"}
|
|
if got := p.ProblemDetail(); got != p {
|
|
t.Errorf("ProblemDetail() = %p, want receiver %p", got, p)
|
|
}
|
|
}
|
|
|
|
func TestProblemHasNoComponentField(t *testing.T) {
|
|
if f, ok := reflect.TypeOf(Problem{}).FieldByName("Component"); ok {
|
|
t.Errorf("Problem.Component must not exist; got field %#v", f)
|
|
}
|
|
}
|
|
|
|
func TestProblemHasNoDocURLField(t *testing.T) {
|
|
if f, ok := reflect.TypeOf(Problem{}).FieldByName("DocURL"); ok {
|
|
t.Errorf("Problem.DocURL must not exist on the base Problem (PermissionError carries ConsoleURL instead); got field %#v", f)
|
|
}
|
|
}
|
|
|
|
func TestProblemCategoryTagIsType(t *testing.T) {
|
|
f, ok := reflect.TypeOf(Problem{}).FieldByName("Category")
|
|
if !ok {
|
|
t.Fatalf("Problem.Category must exist")
|
|
}
|
|
if got := f.Tag.Get("json"); got != "type" {
|
|
t.Errorf("Problem.Category json tag = %q, want %q", got, "type")
|
|
}
|
|
}
|