mirror of
https://github.com/larksuite/cli.git
synced 2026-07-06 08:12:36 +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.
33 lines
1.2 KiB
Go
33 lines
1.2 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package errcompat
|
|
|
|
import (
|
|
"github.com/larksuite/cli/errs"
|
|
internalauth "github.com/larksuite/cli/internal/auth"
|
|
)
|
|
|
|
// PromoteAuthError converts a legacy *internalauth.NeedAuthorizationError into
|
|
// *errs.AuthenticationError{Subtype: TokenMissing}. The Message field MUST
|
|
// contain "need_user_authorization" so the marker invariant guardrail in
|
|
// cmd/root_test.go and internal/auth/errors_test.go still holds.
|
|
//
|
|
// Hint mirrors newTokenMissingError in internal/client/client.go so both
|
|
// token-missing surfaces converge on the same recovery vocabulary. cmd's
|
|
// applyNeedAuthorizationHint appends per-command scopes onto this Hint with
|
|
// a "\n" join, so the action prompt is preserved even when scopes are added.
|
|
//
|
|
// Called from cmd/root.go.handleRootError when errors.As matches
|
|
// *NeedAuthorizationError, before WriteTypedErrorEnvelope.
|
|
func PromoteAuthError(err *internalauth.NeedAuthorizationError) error {
|
|
if err == nil {
|
|
return nil
|
|
}
|
|
return errs.NewAuthenticationError(errs.SubtypeTokenMissing,
|
|
"need_user_authorization (user: %s)", err.UserOpenId).
|
|
WithUserOpenID(err.UserOpenId).
|
|
WithHint("run: lark-cli auth login to re-authorize").
|
|
WithCause(err)
|
|
}
|