mirror of
https://github.com/larksuite/cli.git
synced 2026-07-03 14:02:43 +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.
74 lines
2.1 KiB
Go
74 lines
2.1 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package config
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/larksuite/cli/errs"
|
|
"github.com/larksuite/cli/internal/auth"
|
|
"github.com/larksuite/cli/internal/cmdutil"
|
|
"github.com/larksuite/cli/internal/core"
|
|
"github.com/larksuite/cli/internal/output"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// ConfigRemoveOptions holds all inputs for config remove.
|
|
type ConfigRemoveOptions struct {
|
|
Factory *cmdutil.Factory
|
|
}
|
|
|
|
// NewCmdConfigRemove creates the config remove subcommand.
|
|
func NewCmdConfigRemove(f *cmdutil.Factory, runF func(*ConfigRemoveOptions) error) *cobra.Command {
|
|
opts := &ConfigRemoveOptions{Factory: f}
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "remove",
|
|
Short: "Remove app configuration (clears all tokens and config)",
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
if runF != nil {
|
|
return runF(opts)
|
|
}
|
|
return configRemoveRun(opts)
|
|
},
|
|
}
|
|
cmdutil.SetRisk(cmd, "write")
|
|
|
|
return cmd
|
|
}
|
|
|
|
func configRemoveRun(opts *ConfigRemoveOptions) error {
|
|
f := opts.Factory
|
|
|
|
config, err := core.LoadMultiAppConfig()
|
|
if err != nil || config == nil || len(config.Apps) == 0 {
|
|
return errs.NewConfigError(errs.SubtypeNotConfigured, "not configured yet")
|
|
}
|
|
|
|
// Save empty config first. If this fails, keep secrets and tokens intact so the
|
|
// existing config can still be retried instead of ending up half-removed.
|
|
empty := &core.MultiAppConfig{Apps: []core.AppConfig{}}
|
|
if err := core.SaveMultiAppConfig(empty); err != nil {
|
|
return errs.NewInternalError(errs.SubtypeStorage, "failed to save config: %v", err).WithCause(err)
|
|
}
|
|
|
|
// Clean up keychain entries for all apps after config is cleared.
|
|
for _, app := range config.Apps {
|
|
core.RemoveSecretStore(app.AppSecret, f.Keychain)
|
|
for _, user := range app.Users {
|
|
_ = auth.RemoveStoredToken(app.AppId, user.UserOpenId)
|
|
}
|
|
}
|
|
|
|
output.PrintSuccess(f.IOStreams.ErrOut, "Configuration removed")
|
|
userCount := 0
|
|
for _, app := range config.Apps {
|
|
userCount += len(app.Users)
|
|
}
|
|
if userCount > 0 {
|
|
fmt.Fprintf(f.IOStreams.ErrOut, "Cleared tokens for %d users\n", userCount)
|
|
}
|
|
return nil
|
|
}
|