mirror of
https://github.com/larksuite/cli.git
synced 2026-07-04 22:59:02 +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.
89 lines
2.5 KiB
Go
89 lines
2.5 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package auth
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/larksuite/cli/errs"
|
|
"github.com/larksuite/cli/internal/cmdutil"
|
|
"github.com/larksuite/cli/internal/output"
|
|
)
|
|
|
|
// ScopesOptions holds all inputs for auth scopes.
|
|
type ScopesOptions struct {
|
|
Factory *cmdutil.Factory
|
|
Ctx context.Context
|
|
Format string
|
|
}
|
|
|
|
// NewCmdAuthScopes creates the auth scopes subcommand.
|
|
func NewCmdAuthScopes(f *cmdutil.Factory, runF func(*ScopesOptions) error) *cobra.Command {
|
|
opts := &ScopesOptions{Factory: f}
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "scopes",
|
|
Short: "Query scopes enabled for the app",
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
opts.Ctx = cmd.Context()
|
|
if runF != nil {
|
|
return runF(opts)
|
|
}
|
|
return authScopesRun(opts)
|
|
},
|
|
}
|
|
|
|
cmd.Flags().StringVar(&opts.Format, "format", "json", "output format: json (default) | pretty")
|
|
cmdutil.SetRisk(cmd, "read")
|
|
|
|
return cmd
|
|
}
|
|
|
|
func authScopesRun(opts *ScopesOptions) error {
|
|
f := opts.Factory
|
|
|
|
config, err := f.Config()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
fmt.Fprintf(f.IOStreams.ErrOut, "Querying app scopes...\n\n")
|
|
appInfo, err := getAppInfoFn(opts.Ctx, f, config.AppID)
|
|
if err != nil {
|
|
// Discriminate by error type so transport / parse failures are not
|
|
// reclassified as PermissionError(MissingScope) — re-auth does not
|
|
// fix network / 5xx / JSON parse errors and misclassifying them
|
|
// here would mislead agents into re-auth loops.
|
|
// - typed errors pass through unchanged
|
|
// - bare errors become InternalError(SubtypeSDKError) with Cause
|
|
// preserved so callers (errors.Is) can still see the underlying
|
|
// transport/parse failure.
|
|
// Genuine permission failures are surfaced from appInfo *content*,
|
|
// not from this transport-level error path.
|
|
if errs.IsTyped(err) {
|
|
return err
|
|
}
|
|
return errs.NewInternalError(errs.SubtypeSDKError,
|
|
"failed to get app scope info: %v", err).WithCause(err)
|
|
}
|
|
if opts.Format == "pretty" {
|
|
fmt.Fprintf(f.IOStreams.ErrOut, "App ID: %s\n", config.AppID)
|
|
fmt.Fprintf(f.IOStreams.ErrOut, "Enabled scopes (%d):\n\n", len(appInfo.UserScopes))
|
|
for _, s := range appInfo.UserScopes {
|
|
fmt.Fprintf(f.IOStreams.ErrOut, " • %s\n", s)
|
|
}
|
|
} else {
|
|
output.PrintJson(f.IOStreams.Out, map[string]interface{}{
|
|
"appId": config.AppID,
|
|
"brand": config.Brand,
|
|
"tokenType": "user",
|
|
"userScopes": appInfo.UserScopes,
|
|
"count": len(appInfo.UserScopes),
|
|
})
|
|
}
|
|
return nil
|
|
}
|