mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-09-01 14:53:07 +08:00
d3c03b2f34
A hardening + finalization pass over the agent-first CLI: correctness fixes,
richer machine-readable signals, flag/naming consistency, and a symmetric
config surface. Pre-1.0, so it includes breaking renames.
Correctness:
- agent update: resolve/validate --model/--rerank-model (was storing a bogus
name verbatim, corrupting config.model_id).
- doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports
"no host configured").
- session ask / MCP session_ask: text answer was empty on non-TTY — the agent
stream sets Done=true on an intermediate agent_query frame before the answer,
and AgentAccumulator treated the first Done as terminal. Terminate on the
`complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done.
- batch exit codes: any per-item failure collapses to operation.failed (exit 1),
including `doc upload --recursive` partial failures — a permanent per-file
failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent
would loop on; per-item typed errors stay in the envelope.
Agent-first signals & discovery:
- error.exit_code in the envelope (type + exit_code disambiguate the
input.invalid_argument exit-2-vs-5 split in one JSON read).
- meta.hint on empty content search and on draft doc create; doc wait fails fast
on a never-parsing draft instead of hanging to --timeout.
- retrieval-readiness is visible in the natural flow: kb status / kb check emit
retrieval_ready, and kb create hints the fix when no embedding model is bound
— an unconfigured KB no longer looks silently healthy.
- schema contract completeness: every leaf declares output + >=1 example
(drift-guarded); output strings match the meta actually emitted; chunk list
and search docs now emit meta.total_count (both previously dropped it).
- schema tolerates a quoted multi-word command label; zero-state auth — and
`link` with no profile — point at profile setup / the headless WEKNORA_KB_ID
path instead of looping on `auth login`.
- id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view
accept and ignore it, declared in schema) so a carried-over --kb doesn't
exit 2; streaming commands warn that --jq does not apply to an NDJSON stream.
- keep JSON-always as the default; --jq hints spell out the .data path.
Consistency & gating:
- doc create: drop the deprecated --name alias (--title only; pre-1.0 break).
- chunk list --limit aligned to 1..10000; model list --limit/-L with
has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install
expands a leading ~.
- docs corrected: search docs / doc list --keyword help is case-insensitive
(server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add
model.update / kb.config.set) and batch example (failed item carries `error`);
session resume --message id comes from `message list`, not the stream.
- auth/profile ergonomics: env credentials are now first-class — `auth token`
prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh
give an env-aware message instead of looping on "run auth login". `auth logout`
clears credentials but keeps the profile registered (host preserved for
re-login); deleting a profile is `profile remove`'s job (clean logout/remove
separation, matching gh / lark).
Config surface (symmetric read/write, in-place model edits):
- kb config now returns a secret-free KBModelConfigView (was {}); `kb config`
reads, new `kb config set` writes; `kb init` removed (misnomer).
- kb create --chat-model: retrieval-ready in one step.
- model update: edit a model in place (id preserved, references survive) —
rotate --api-key-stdin, change base-url / display-name / etc.
- session continue-stream renamed to session resume.
Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale
kb-init / continue-stream references removed; skill wire-vocab guard extended.
AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an
embedding model to be searchable), that --jq does not apply to NDJSON
streams, and the env-credential-first auth path; the KB quickstart example
now creates a retrieval-ready KB.
198 lines
6.9 KiB
Go
198 lines
6.9 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 {
|
|
All bool // --all: clear every profile
|
|
Yes bool // sourced from the global -y/--yes persistent flag
|
|
DryRun bool
|
|
}
|
|
|
|
// 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 # active profile
|
|
weknora --profile staging auth logout # 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")
|
|
// Pure-local validation runs before the dry-run gate so --dry-run
|
|
// rejects identically to the live path. Same typed errors as
|
|
// runLogout (kept there for direct-call callers).
|
|
cfg, cfgErr := f.Config()
|
|
if cfgErr != nil {
|
|
return cfgErr
|
|
}
|
|
if len(cfg.Profiles) == 0 {
|
|
if active, kind := cmdutil.EnvCredential(); active {
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated,
|
|
"authenticated via "+kind+" (stateless env credential) — nothing is stored to log out; unset "+kind+" to drop it")
|
|
}
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated, "no profiles configured; nothing to log out")
|
|
}
|
|
if _, err := pickLogoutTargets(opts, cfg); err != nil {
|
|
return err
|
|
}
|
|
if opts.DryRun {
|
|
planArgs := map[string]any{"profile": cfg.CurrentProfile}
|
|
if opts.All {
|
|
planArgs = map[string]any{"all": true}
|
|
}
|
|
if handled, err := cmdutil.HandleDryRun(c, true, cmdutil.DryRunPlan{
|
|
Action: "auth.logout",
|
|
Args: planArgs,
|
|
}); handled {
|
|
return err
|
|
}
|
|
}
|
|
return runLogout(opts, fopts, f)
|
|
},
|
|
}
|
|
cmd.Flags().BoolVar(&opts.All, "all", false, "Log out of every configured profile")
|
|
cmdutil.AddFormatFlag(cmd, authLogoutFields...)
|
|
cmdutil.AddDryRunFlag(cmd, &opts.DryRun)
|
|
cmdutil.SetRisk(cmd, "auth.logout")
|
|
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
|
|
UsedFor: "clear stored credentials for the active profile (or --all); the profile itself stays registered (host preserved) so `auth login` can re-auth it — use `profile remove` to delete the profile entirely",
|
|
Examples: []string{
|
|
"weknora auth logout",
|
|
"weknora --profile staging auth logout",
|
|
"weknora auth logout --all",
|
|
},
|
|
Output: "envelope.data is {removed: [profile names cleared]}",
|
|
Warnings: []string{
|
|
"Requires explicit user approval (exit 10 / input.confirmation_required); never auto-add -y.",
|
|
"auth logout clears local credentials for this profile; server-side session continues until expiry.",
|
|
},
|
|
})
|
|
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.Profiles) == 0 {
|
|
if active, kind := cmdutil.EnvCredential(); active {
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated,
|
|
"authenticated via "+kind+" (stateless env credential) — nothing is stored to log out; unset "+kind+" to drop it")
|
|
}
|
|
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 := []string{"weknora", "auth", "logout", "-y"}
|
|
if opts.All {
|
|
retryCmd = []string{"weknora", "auth", "logout", "--all", "-y"}
|
|
}
|
|
if err := cmdutil.ConfirmDestructive(f.Prompter(), opts.Yes, fopts.WantsJSON(), "delete", "auth credentials", scope, "auth.logout", retryCmd); err != nil {
|
|
return err
|
|
}
|
|
|
|
store, err := f.Secrets()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
for _, name := range targets {
|
|
clearProfileSecrets(store, cfg.Profiles[name], name)
|
|
// Keep the profile registered (its host stays) — only clear the
|
|
// credential refs so it reads as logged-out and can be re-authed with
|
|
// `auth login`. Deleting the profile entirely is `profile remove`'s job;
|
|
// that clean logout(who)/remove(what) split matches gh / lark.
|
|
p := cfg.Profiles[name]
|
|
p.APIKeyRef = ""
|
|
p.TokenRef = ""
|
|
p.RefreshRef = ""
|
|
cfg.Profiles[name] = p
|
|
}
|
|
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.Profiles))
|
|
for n := range cfg.Profiles {
|
|
names = append(names, n)
|
|
}
|
|
return names, nil
|
|
}
|
|
name := cfg.CurrentProfile
|
|
if name == "" {
|
|
return nil, cmdutil.NewError(cmdutil.CodeInputMissingFlag,
|
|
"no active profile set; use the global --profile <profile> or --all")
|
|
}
|
|
if _, ok := cfg.Profiles[name]; !ok {
|
|
return nil, cmdutil.NewError(cmdutil.CodeLocalProfileNotFound,
|
|
fmt.Sprintf("profile %q not found in config", name))
|
|
}
|
|
return []string{name}, nil
|
|
}
|
|
|
|
// clearProfileSecrets 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 clearProfileSecrets(store secrets.Store, c config.Profile, name string) {
|
|
if c.TokenRef != "" {
|
|
_ = store.Delete(name, "access")
|
|
}
|
|
if c.RefreshRef != "" {
|
|
_ = store.Delete(name, "refresh")
|
|
}
|
|
if c.APIKeyRef != "" {
|
|
_ = store.Delete(name, "api_key")
|
|
}
|
|
}
|