mirror of
https://github.com/larksuite/cli.git
synced 2026-07-05 15:47:54 +08:00
99e314fe0b
Every failure on the authentication, authorization, and configuration
path now surfaces as a typed structured error instead of an ad-hoc
envelope. Users and scripts that consume CLI output get:
- a fixed nine-category taxonomy on the wire, each mapped to a
stable shell exit code (authentication/authorization/config = 3,
network = 4, internal = 5, policy = 6, confirmation = 10)
- identity-aware detail fields (missing_scopes, requested_scopes,
granted_scopes, console_url, log_id, retryable, hint) carried
uniformly on the envelope
- a single canonical policy envelope at exit 6; the legacy
auth_error carve-out is retired
- per-subtype canonical message + hint that preserves Lark's
diagnostic phrasing and routes recovery to the right actor:
app developer (app_scope_not_applied), user (missing_scope,
token_scope_insufficient, user_unauthorized), or tenant admin
(app_unavailable, app_disabled)
- wrong app credentials classify as config/invalid_client whether
surfaced by the Open API endpoint (99991543) or the tenant
access-token mint endpoint (10003 / 10014), instead of
collapsing to a transport error or api/unknown
- local shortcut scope preflight emits the same
authorization/missing_scope envelope (identity + deterministic
missing-scope set) used by the post-call permission path, so AI
consumers read the same structured shape from precheck and from
server-returned permission denial
- streaming download/upload failures keep the same network subtype
split (timeout / TLS / DNS / transport) as the non-stream path
instead of collapsing every cause to a generic transport failure
- console_url is carried only on the bot-perspective
app_scope_not_applied envelope (where the recovery action is
"developer applies the scope at the developer console"); the
user-perspective missing_scope envelope drops the field, since
the only actionable user recovery is `lark-cli auth login --scope`
and pointing an end user at a console they cannot modify is
misleading
- bind workflows (Hermes / OpenClaw / lark-channel) flatten dynamic
Type tags to wire 'config' with the original module name kept
as a metric label
All 10 typed errors are cause-bearing, nil-safe on .Error() and
.Unwrap(), and defensively clone slice setter inputs. Four lint
rules (CheckNilSafeError / CheckBuilderImmutable / CheckUnwrapSymmetry
/ CheckBuildAPIErrorArms) lock these invariants on migrated paths.
49 lines
1.8 KiB
Go
49 lines
1.8 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
// Package errcompat provides boundary helpers that bridge legacy error types
|
|
// to the typed errs/ taxonomy. These helpers run at the dispatcher boundary
|
|
// (cmd/root.go.handleRootError) before the typed envelope writer, converting
|
|
// pre-typed-taxonomy errors (*core.ConfigError, *internalauth.NeedAuthorizationError)
|
|
// into typed *errs.* errors while preserving the original error in the Cause
|
|
// chain so existing `errors.As` callers continue to match.
|
|
package errcompat
|
|
|
|
import (
|
|
"strings"
|
|
|
|
"github.com/larksuite/cli/errs"
|
|
"github.com/larksuite/cli/internal/core"
|
|
)
|
|
|
|
// PromoteConfigError converts a legacy *core.ConfigError into the matching
|
|
// typed errs.*Error based on cfgErr.Type. Called from cmd/root.go.handleRootError
|
|
// before the typed envelope writer. The original *core.ConfigError is preserved
|
|
// in the Cause chain so external `errors.As(&core.ConfigError{})` callers
|
|
// (cmd/auth/list.go, cmd/doctor/doctor.go, etc.) still match.
|
|
func PromoteConfigError(cfgErr *core.ConfigError) error {
|
|
if cfgErr == nil {
|
|
return nil
|
|
}
|
|
switch cfgErr.Type {
|
|
case "auth":
|
|
return errs.NewAuthenticationError(errs.SubtypeTokenMissing, "%s", cfgErr.Message).
|
|
WithHint("%s", cfgErr.Hint).
|
|
WithCause(cfgErr)
|
|
case "config":
|
|
subtype := errs.SubtypeNotConfigured
|
|
lower := strings.ToLower(cfgErr.Message)
|
|
if strings.Contains(lower, "parse") || strings.Contains(lower, "invalid") {
|
|
subtype = errs.SubtypeInvalidConfig
|
|
}
|
|
return errs.NewConfigError(subtype, "%s", cfgErr.Message).
|
|
WithHint("%s", cfgErr.Hint).
|
|
WithCause(cfgErr)
|
|
default:
|
|
// dynamic Type (e.g. workspace name like "bind"/"hermes"/"openclaw") → NotConfigured
|
|
return errs.NewConfigError(errs.SubtypeNotConfigured, "%s", cfgErr.Message).
|
|
WithHint("%s", cfgErr.Hint).
|
|
WithCause(cfgErr)
|
|
}
|
|
}
|