mirror of
https://github.com/larksuite/cli.git
synced 2026-07-06 00:06:28 +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.
40 lines
1.7 KiB
Go
40 lines
1.7 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package errscontract
|
|
|
|
import "strings"
|
|
|
|
// RunAll executes all four checks on the given source. allowlist controls CheckDeclaredSubtype;
|
|
// pass nil to skip it. Use RunAllWithNames to enable strengthened CheckDeclaredSubtype name
|
|
// resolution.
|
|
func RunAll(path, src string, allowlist map[string]struct{}) []Violation {
|
|
return RunAllWithNames(path, src, allowlist, nil)
|
|
}
|
|
|
|
// RunAllWithNames is RunAll with the strengthened CheckDeclaredSubtype. nameset, when
|
|
// non-nil, lets CheckDeclaredSubtype reject typo'd `errs.SubtypeBogus` selectors that
|
|
// reference no declared constant.
|
|
func RunAllWithNames(path, src string, allowlist, nameset map[string]struct{}) []Violation {
|
|
var out []Violation
|
|
if strings.HasPrefix(path, "errs/") || strings.Contains(path, "/errs/") {
|
|
// CheckProblemEmbed fires on errs/ files only (caller may also enforce parity
|
|
// across directory via CheckErrsContract).
|
|
out = append(out, CheckProblemEmbed(path, src)...)
|
|
// The next three rules also scope to errs/ files internally — they
|
|
// guard the typed wrappers that live exclusively in this package.
|
|
out = append(out, CheckNilSafeError(path, src)...)
|
|
out = append(out, CheckUnwrapSymmetry(path, src)...)
|
|
out = append(out, CheckBuilderImmutable(path, src)...)
|
|
}
|
|
// CheckBuildAPIErrorArms self-scopes to internal/errclass/classify.go.
|
|
out = append(out, CheckBuildAPIErrorArms(path, src)...)
|
|
out = append(out, CheckNoRegistrar(path, src)...)
|
|
out = append(out, CheckAdHocSubtype(path, src)...)
|
|
out = append(out, CheckTypedErrorCompleteness(path, src)...)
|
|
if allowlist != nil {
|
|
out = append(out, CheckDeclaredSubtypeWithNames(path, src, allowlist, nameset)...)
|
|
}
|
|
return out
|
|
}
|