nullkey
567d7ac74e
Adds the structured-output and agent-help surface plus root-level signal
handling so AI agents (and humans working through pipes) get a stable
wire contract.
* --format text|json|ndjson flag, registered per-command on outputs that
need it; default text on TTY, json on pipe. --jq <expr> pairs with json
/ ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON()
helper for the JSON dispatch.
* WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value
per line, arrays split element-per-line, empty slice → zero bytes).
* chat / agent invoke wire --format ndjson via SDK StreamResponse /
AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled
in every stream + session-create path and emit a stable
"operation.cancelled" code on Ctrl-C / SIGTERM.
* main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root
context so long-running commands run their cancellation cleanup
(re-emit auto-created session id, etc); the process exits 130 when
the context was signal-cancelled, matching Unix convention.
* MCP chat / agent_invoke output schemas extended with thinking /
tool_calls / assistant_message_id (server-side accumulated; MCP
tools/call has no standard partial-response). doc_view and doc_download
now use doc_id (not knowledge_id) so agents see a single id naming
convention across all tools — matches the chunk_list / search_chunks
schemas and the CLI's <doc-id> positional.
* SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help
payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list.
* kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets
the new KB's storage_provider_config.provider at creation time (server
does not expose it on update). Required on self-hosted deployments
where the server-side default doesn't pre-populate a provider —
without it, subsequent doc upload returns a misleading "kb not found".
58 lines
1.4 KiB
Go
58 lines
1.4 KiB
Go
package cmdutil
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"testing"
|
|
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
func TestSetAgentHelp_EmitsJSONWhenEnvSet(t *testing.T) {
|
|
t.Setenv("WEKNORA_AGENT_HELP", "1")
|
|
cmd := &cobra.Command{Use: "foo"}
|
|
ah := AgentHelp{
|
|
UsedFor: "frob a bar",
|
|
RequiredFlags: []string{"--name"},
|
|
Examples: []string{"weknora foo --name=x"},
|
|
}
|
|
SetAgentHelp(cmd, ah)
|
|
|
|
var buf bytes.Buffer
|
|
cmd.SetOut(&buf)
|
|
cmd.Help()
|
|
|
|
var got AgentHelp
|
|
if err := json.Unmarshal(buf.Bytes(), &got); err != nil {
|
|
t.Fatalf("output not JSON: %v\n%s", err, buf.String())
|
|
}
|
|
if got.UsedFor != "frob a bar" {
|
|
t.Errorf("UsedFor=%q, want %q", got.UsedFor, "frob a bar")
|
|
}
|
|
if len(got.RequiredFlags) != 1 || got.RequiredFlags[0] != "--name" {
|
|
t.Errorf("RequiredFlags=%v", got.RequiredFlags)
|
|
}
|
|
}
|
|
|
|
func TestSetAgentHelp_FallsThroughToHumanHelp(t *testing.T) {
|
|
t.Setenv("WEKNORA_AGENT_HELP", "")
|
|
cmd := &cobra.Command{
|
|
Use: "foo",
|
|
Short: "frob a bar",
|
|
Long: "Detailed human help here.",
|
|
}
|
|
SetAgentHelp(cmd, AgentHelp{UsedFor: "ignored"})
|
|
|
|
var buf bytes.Buffer
|
|
cmd.SetOut(&buf)
|
|
cmd.Help()
|
|
|
|
// Should NOT be JSON (human help is text)
|
|
if json.Valid(buf.Bytes()) {
|
|
t.Errorf("expected human text, got JSON:\n%s", buf.String())
|
|
}
|
|
if !bytes.Contains(buf.Bytes(), []byte("Detailed human help")) {
|
|
t.Errorf("human help missing from output:\n%s", buf.String())
|
|
}
|
|
}
|