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.
69 lines
1.9 KiB
Go
69 lines
1.9 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package output
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/larksuite/cli/errs"
|
|
)
|
|
|
|
func TestExitCodeForCategory(t *testing.T) {
|
|
cases := []struct {
|
|
name string
|
|
cat errs.Category
|
|
want int
|
|
}{
|
|
{"validation", errs.CategoryValidation, 2},
|
|
{"authentication", errs.CategoryAuthentication, 3},
|
|
{"authorization", errs.CategoryAuthorization, 3},
|
|
{"config", errs.CategoryConfig, 3},
|
|
{"network", errs.CategoryNetwork, 4},
|
|
{"api", errs.CategoryAPI, 1},
|
|
{"policy", errs.CategoryPolicy, 6},
|
|
{"internal", errs.CategoryInternal, 5},
|
|
{"confirmation", errs.CategoryConfirmation, 10},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
if got := ExitCodeForCategory(tc.cat); got != tc.want {
|
|
t.Errorf("ExitCodeForCategory(%q) = %d, want %d", tc.cat, got, tc.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestExitCodeForCategory_UnknownDefaults(t *testing.T) {
|
|
if got := ExitCodeForCategory(errs.Category("not_a_real_category")); got != ExitInternal {
|
|
t.Errorf("ExitCodeForCategory(unknown) = %d, want %d (ExitInternal)", got, ExitInternal)
|
|
}
|
|
}
|
|
|
|
func TestExitCodeOf_Nil(t *testing.T) {
|
|
if got := ExitCodeOf(nil); got != 0 {
|
|
t.Errorf("ExitCodeOf(nil) = %d, want 0", got)
|
|
}
|
|
}
|
|
|
|
func TestExitCodeOf_PermissionError(t *testing.T) {
|
|
err := &errs.PermissionError{Problem: errs.Problem{Category: errs.CategoryAuthorization}}
|
|
if got := ExitCodeOf(err); got != 3 {
|
|
t.Errorf("ExitCodeOf(PermissionError) = %d, want 3", got)
|
|
}
|
|
}
|
|
|
|
func TestExitCodeOf_APIError(t *testing.T) {
|
|
err := &errs.APIError{Problem: errs.Problem{Category: errs.CategoryAPI}}
|
|
if got := ExitCodeOf(err); got != 1 {
|
|
t.Errorf("ExitCodeOf(APIError) = %d, want 1", got)
|
|
}
|
|
}
|
|
|
|
func TestExitCodeOf_UntypedFallsBackToInternal(t *testing.T) {
|
|
if got := ExitCodeOf(fmt.Errorf("plain")); got != 5 {
|
|
t.Errorf("ExitCodeOf(plain) = %d, want 5 (untyped → CategoryInternal → ExitInternal)", got)
|
|
}
|
|
}
|