ad150c7126
Sweep every CLI output path through the v0.7 envelope contract.
FormatOptions.Emit signature changes to (w, data, meta *output.Meta)
so list commands surface meta.count / has_more in the wire envelope.
TTY indent decision plumbed via FormatOptions.TTY (set by
ResolveDefault). --format and --jq promoted to persistent root flags
so unknown-subcommand paths still reach the typed-envelope guard
(per-command registration would have rejected --format on unknown
commands as cobra-prose exit 2). WEKNORA_FORMAT env-var fallback
honored before TTY-resolved default. AddFormatFlag retained for the
per-command --jq field-hint Long-text addendum.
~55 production Emit call sites swept across cli/cmd/**: list paths
populate meta.count; mutation paths pass nil meta; envelope.profile
threaded via globalProfile. Existing JSON-shape tests migrated to
decode the envelope wrapper.
Multi-target batch operations get a unified shape via new helpers:
- output.BatchItem + output.WriteBatchEnvelope (§4.5 per-item ok
pattern; data:[{id, ok, result?|error?}], meta:{count, successes*,
failures*}; Successes/Failures *int so explicit zero survives
omitempty in all-fail case).
- cmdutil.RunBatch + cmdutil.EmitBatch + cmdutil.DeletedAtNow +
cmdutil.ClassifyContextErr collapse the three previously-duplicated
multi-delete pipelines (doc / chunk / session) into one call site
pattern. doc upload --recursive uses the same helpers with a per-
file resultFn. Summary error sets Silent:true so the stderr
envelope path doesn't duplicate the stdout batch detail (exit 1
preserved via Code → ExitCode).
ConfirmDestructive / ConfirmDestructiveBatch extended with action +
retryCmd parameters. Every destructive command (kb delete, kb edit,
doc delete, doc delete --all, agent delete, agent edit, session
delete, chunk delete, auth logout, api -X DELETE) now attaches
error.risk.{level:"destructive", action:"<noun.verb>"} +
error.retry_command on the exit-10 envelope. kb edit / agent edit
also gain the destructive guard wiring (CHANGELOG listed them as
gated but they were silently executing without -y).
MCP tool handlers' 31 error paths return CallToolResult with
IsError + Content text fallback + StructuredContent (envelope.error
shape via cmdutil.ErrorToDetail). Handler Out type changed from
typed *sdk.X to any so the go-sdk auto-marshal doesn't overwrite
StructuredContent with a zero-struct on error returns. Success path
manually populates CallToolResult.StructuredContent via successResult
helper.
weknora api cleanup:
- -d/--data flag removed; body via --input <file> or --input -
(stdin) only. Aligns with gh / curl convention.
- HTTP method whitelist removed; any non-empty method accepted.
- HTTP Retry-After header → cmdutil.Error.RetryAfterSeconds →
envelope.error.retry_after_seconds.
- runAPIPaginated raw-passthrough fallback now wraps response in
envelope so --paginate never emits bare JSON to stdout.
Test sweep: ~60 cmd/** tests migrated to decode envelope shape.
9 wire-contract goldens updated under cli/acceptance/testdata/wire/.
Spec: docs/superpowers/specs/2026-05-20-weknora-cli-v0.7-design.md §4 / §5
167 lines
5.5 KiB
Go
167 lines
5.5 KiB
Go
package auth
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/config"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/secrets"
|
|
)
|
|
|
|
type LogoutOptions struct {
|
|
Name string // --name: target a specific profile (default: current)
|
|
All bool // --all: clear every profile
|
|
Yes bool // sourced from the global -y/--yes persistent flag
|
|
}
|
|
|
|
// authLogoutFields enumerates the fields surfaced for `--format json` discovery
|
|
// on `auth logout`. The result is the list of profile names that were
|
|
// logged out.
|
|
var authLogoutFields = []string{"removed"}
|
|
|
|
// logoutResult is the typed payload emitted under data.
|
|
type logoutResult struct {
|
|
Removed []string `json:"removed"`
|
|
}
|
|
|
|
// NewCmdLogout builds `weknora auth logout`. Clears stored credentials
|
|
// (keyring + file fallback) and removes the profile entry from config.yaml.
|
|
// No server-side revocation - local-only credential clear.
|
|
func NewCmdLogout(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &LogoutOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "logout",
|
|
Short: "Remove stored credentials for a profile",
|
|
Long: `Clear keyring + file-fallback secrets for one profile (or all of
|
|
them with --all) and drop the profile entry from ~/.config/weknora/config.yaml.
|
|
|
|
Note: this does NOT revoke the credential server-side - for API keys, you
|
|
must rotate them in the server UI; for JWT, the token will continue to be
|
|
accepted until it expires.`,
|
|
Example: ` weknora auth logout # current profile
|
|
weknora auth logout --name staging # specific profile
|
|
weknora auth logout --all`,
|
|
Args: cobra.NoArgs,
|
|
RunE: func(c *cobra.Command, _ []string) error {
|
|
fopts, err := cmdutil.CheckFormatFlag(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
fopts.ResolveDefault(iostreams.IO.IsStdoutTTY())
|
|
opts.Yes, _ = c.Flags().GetBool("yes")
|
|
return runLogout(opts, fopts, f)
|
|
},
|
|
}
|
|
cmd.Flags().StringVar(&opts.Name, "name", "", "Profile to log out (defaults to the current profile)")
|
|
cmd.Flags().BoolVar(&opts.All, "all", false, "Log out of every configured profile")
|
|
cmdutil.AddFormatFlag(cmd, authLogoutFields...)
|
|
cmd.MarkFlagsMutuallyExclusive("name", "all")
|
|
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
|
|
UsedFor: "clear stored credentials for one profile (or all) and remove the profile from config",
|
|
Examples: []string{
|
|
"weknora auth logout",
|
|
"weknora auth logout --name staging",
|
|
"weknora auth logout --all",
|
|
},
|
|
Warnings: []string{
|
|
"auth logout drops stored credentials. The user will need to re-authenticate. Confirm scope before invoking.",
|
|
},
|
|
})
|
|
return cmd
|
|
}
|
|
|
|
func runLogout(opts *LogoutOptions, fopts *cmdutil.FormatOptions, f *cmdutil.Factory) error {
|
|
cfg, err := f.Config()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if len(cfg.Contexts) == 0 {
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated, "no profiles configured; nothing to log out")
|
|
}
|
|
|
|
targets, err := pickLogoutTargets(opts, cfg)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Destructive-write protocol: confirm before clearing credentials.
|
|
scope := fmt.Sprintf("%d profile(s) [%s]", len(targets), strings.Join(targets, ", "))
|
|
retryCmd := "weknora auth logout -y"
|
|
if opts.All {
|
|
retryCmd = "weknora auth logout --all -y"
|
|
} else if opts.Name != "" {
|
|
retryCmd = fmt.Sprintf("weknora auth logout --name %s -y", opts.Name)
|
|
}
|
|
if err := cmdutil.ConfirmDestructive(f.Prompter(), opts.Yes, fopts.WantsJSON(), "auth credentials", scope, "auth.logout", retryCmd); err != nil {
|
|
return err
|
|
}
|
|
|
|
store, err := f.Secrets()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
for _, name := range targets {
|
|
clearContextSecrets(store, cfg.Contexts[name], name)
|
|
delete(cfg.Contexts, name)
|
|
}
|
|
// If we removed the active context, pick a remaining one (deterministic by
|
|
// map order would be flaky - leave CurrentContext empty so the next
|
|
// invocation surfaces a clear "no current context" error rather than
|
|
// silently switching).
|
|
if _, stillExists := cfg.Contexts[cfg.CurrentContext]; !stillExists {
|
|
cfg.CurrentContext = ""
|
|
}
|
|
if err := config.Save(cfg); err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "save config")
|
|
}
|
|
|
|
if fopts.WantsJSON() {
|
|
return fopts.Emit(iostreams.IO.Out, logoutResult{Removed: targets}, nil)
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Logged out of %d profile(s): %s\n", len(targets), strings.Join(targets, ", "))
|
|
return nil
|
|
}
|
|
|
|
// pickLogoutTargets resolves the set of profiles to clear from flags + config.
|
|
func pickLogoutTargets(opts *LogoutOptions, cfg *config.Config) ([]string, error) {
|
|
if opts.All {
|
|
names := make([]string, 0, len(cfg.Contexts))
|
|
for n := range cfg.Contexts {
|
|
names = append(names, n)
|
|
}
|
|
return names, nil
|
|
}
|
|
name := opts.Name
|
|
if name == "" {
|
|
name = cfg.CurrentContext
|
|
}
|
|
if name == "" {
|
|
return nil, cmdutil.NewError(cmdutil.CodeInputMissingFlag,
|
|
"no current profile set; pass --name <profile> or --all")
|
|
}
|
|
if _, ok := cfg.Contexts[name]; !ok {
|
|
return nil, cmdutil.NewError(cmdutil.CodeLocalProfileNotFound,
|
|
fmt.Sprintf("profile %q not found in config", name))
|
|
}
|
|
return []string{name}, nil
|
|
}
|
|
|
|
// clearContextSecrets best-effort deletes every secret slot the profile
|
|
// references. Errors are swallowed because a missing secret is a no-op
|
|
// (tested in keyring_test.go) - we don't want a stale ref to block logout.
|
|
func clearContextSecrets(store secrets.Store, c config.Context, name string) {
|
|
if c.TokenRef != "" {
|
|
_ = store.Delete(name, "access")
|
|
}
|
|
if c.RefreshRef != "" {
|
|
_ = store.Delete(name, "refresh")
|
|
}
|
|
if c.APIKeyRef != "" {
|
|
_ = store.Delete(name, "api_key")
|
|
}
|
|
}
|