feat(cli): --json field-select, --jq, auth token, doc --from-url
Output ergonomics:
- `--json` accepts a comma-separated field list (gh-parity); selects
named keys from the per-command payload. Bare `--json` keeps the
full shape.
- `--jq <expr>` evaluates a gojq expression over the JSON; pairs with
`--json field-list` so projection runs before jq.
- `--version` is a global cobra flag in addition to the `version`
subcommand; both render the same line.
- Per-command `--help` now renders the available JSON field list under
"JSON fields available via `--json id,name,...`" (field-discovery
parity with gh / kubectl `-o jsonpath`).
New commands:
- `auth token` — print the active context's credential to stdout for
shell command substitution (`WEKNORA_TOKEN=$(weknora auth token)`).
Default: raw secret, no trailing newline. `--json` emits
`{token, mode, context}`.
- `doc upload --from-url <URL>` — ingest a remote URL via the SDK
`CreateKnowledgeFromURL`. `--name` forwarded as `FileName` so the
server's known-extension heuristic upgrades crawl-mode to
file-download-mode where appropriate.
Includes the simplify post-review polish pass (field-filter unit
tests, --json/--jq compose check, agent_help copy fixes).
This commit is contained in:
@@ -0,0 +1,202 @@
|
||||
package format
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
|
||||
"github.com/itchyny/gojq"
|
||||
)
|
||||
|
||||
// WriteEnvelopeFiltered serializes env to w, optionally restricting
|
||||
// data.items[*] (for list envelopes) or data (for single-resource envelopes)
|
||||
// to the named fields, then applying a jq expression on the result.
|
||||
//
|
||||
// - len(fields) == 0 → no field filter (full envelope)
|
||||
// - jqExpr == "" → no jq filter (just write the envelope)
|
||||
//
|
||||
// The envelope structure (ok / data / error / _meta / risk / dry_run / _notice)
|
||||
// is preserved across field filtering — only Data is rewritten. jq operates
|
||||
// on the entire envelope JSON so users can `--jq '.data.items[].id'`.
|
||||
func WriteEnvelopeFiltered(w io.Writer, env Envelope, fields []string, jqExpr string) error {
|
||||
raw, err := marshalEnvelope(env)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if len(fields) > 0 {
|
||||
raw, err = applyFieldFilter(raw, fields)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
if jqExpr != "" {
|
||||
return writeJQ(w, raw, jqExpr)
|
||||
}
|
||||
_, err = w.Write(raw)
|
||||
return err
|
||||
}
|
||||
|
||||
// marshalEnvelope returns the canonical newline-terminated envelope JSON used
|
||||
// by the non-filtered path. Identical to WriteEnvelope but as bytes.
|
||||
func marshalEnvelope(env Envelope) ([]byte, error) {
|
||||
var buf bytes.Buffer
|
||||
enc := json.NewEncoder(&buf)
|
||||
enc.SetEscapeHTML(false)
|
||||
if err := enc.Encode(env); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return buf.Bytes(), nil
|
||||
}
|
||||
|
||||
// applyFieldFilter rewrites envelope.data so that nested objects keep only
|
||||
// the named keys. The shape rules:
|
||||
//
|
||||
// - data is an object with `items` (the standard list envelope shape):
|
||||
// filter each items[*] to the named fields.
|
||||
// - data is an object without `items` (single-resource envelope):
|
||||
// filter data itself.
|
||||
// - data is an array (uncommon — currently no command produces this, but
|
||||
// defensive): filter each [*].
|
||||
// - data is nil / scalar: unchanged.
|
||||
//
|
||||
// Unknown field names are silently ignored (consistent with gh — users may
|
||||
// pass an aspirational field set across heterogenous list outputs).
|
||||
func applyFieldFilter(envelopeJSON []byte, fields []string) ([]byte, error) {
|
||||
var raw map[string]json.RawMessage
|
||||
if err := json.Unmarshal(envelopeJSON, &raw); err != nil {
|
||||
return nil, fmt.Errorf("field filter: parse envelope: %w", err)
|
||||
}
|
||||
dataRaw, ok := raw["data"]
|
||||
if !ok || len(dataRaw) == 0 || string(dataRaw) == "null" {
|
||||
return envelopeJSON, nil
|
||||
}
|
||||
|
||||
filtered, err := filterDataPayload(dataRaw, fields)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
raw["data"] = filtered
|
||||
|
||||
var buf bytes.Buffer
|
||||
enc := json.NewEncoder(&buf)
|
||||
enc.SetEscapeHTML(false)
|
||||
if err := enc.Encode(raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return buf.Bytes(), nil
|
||||
}
|
||||
|
||||
// filterDataPayload dispatches on the shape of the data JSON value.
|
||||
func filterDataPayload(dataRaw json.RawMessage, fields []string) (json.RawMessage, error) {
|
||||
trimmed := bytes.TrimSpace(dataRaw)
|
||||
if len(trimmed) == 0 {
|
||||
return dataRaw, nil
|
||||
}
|
||||
switch trimmed[0] {
|
||||
case '{':
|
||||
return filterObjectData(dataRaw, fields)
|
||||
case '[':
|
||||
return filterArrayItems(dataRaw, fields)
|
||||
default:
|
||||
// scalar (number / string / bool / null) — nothing to filter
|
||||
return dataRaw, nil
|
||||
}
|
||||
}
|
||||
|
||||
// filterObjectData filters either data.items[*] (list shape) or data (single
|
||||
// resource).
|
||||
func filterObjectData(dataRaw json.RawMessage, fields []string) (json.RawMessage, error) {
|
||||
var obj map[string]json.RawMessage
|
||||
if err := json.Unmarshal(dataRaw, &obj); err != nil {
|
||||
return nil, fmt.Errorf("field filter: parse data object: %w", err)
|
||||
}
|
||||
if items, ok := obj["items"]; ok {
|
||||
filtered, err := filterArrayItems(items, fields)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
obj["items"] = filtered
|
||||
return json.Marshal(obj)
|
||||
}
|
||||
// Single-resource envelope: filter the data object itself.
|
||||
return filterObjectKeys(dataRaw, fields)
|
||||
}
|
||||
|
||||
// filterArrayItems applies filterObjectKeys to each element of an array.
|
||||
// Non-object elements (e.g. an array of strings) are passed through.
|
||||
func filterArrayItems(arrayRaw json.RawMessage, fields []string) (json.RawMessage, error) {
|
||||
var items []json.RawMessage
|
||||
if err := json.Unmarshal(arrayRaw, &items); err != nil {
|
||||
return nil, fmt.Errorf("field filter: parse data items: %w", err)
|
||||
}
|
||||
for i, item := range items {
|
||||
trimmed := bytes.TrimSpace(item)
|
||||
if len(trimmed) == 0 || trimmed[0] != '{' {
|
||||
continue
|
||||
}
|
||||
filtered, err := filterObjectKeys(item, fields)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
items[i] = filtered
|
||||
}
|
||||
return json.Marshal(items)
|
||||
}
|
||||
|
||||
// filterObjectKeys produces a new object containing only the listed keys
|
||||
// that were present in the source.
|
||||
func filterObjectKeys(objRaw json.RawMessage, fields []string) (json.RawMessage, error) {
|
||||
var src map[string]json.RawMessage
|
||||
if err := json.Unmarshal(objRaw, &src); err != nil {
|
||||
return nil, fmt.Errorf("field filter: parse object keys: %w", err)
|
||||
}
|
||||
dst := make(map[string]json.RawMessage, len(fields))
|
||||
for _, k := range fields {
|
||||
if v, ok := src[k]; ok {
|
||||
dst[k] = v
|
||||
}
|
||||
}
|
||||
return json.Marshal(dst)
|
||||
}
|
||||
|
||||
// writeJQ evaluates expr against envelopeJSON and writes each result line by
|
||||
// line to w. Mirrors gh's pkg/export/filter.go semantics: results that are
|
||||
// strings render without quotes; everything else uses encoding/json.
|
||||
//
|
||||
// Returns input.invalid_argument-shaped errors via plain errors.New + fmt;
|
||||
// the caller is responsible for wrapping with cmdutil.NewError if it wants
|
||||
// the typed envelope code.
|
||||
func writeJQ(w io.Writer, envelopeJSON []byte, expr string) error {
|
||||
query, err := gojq.Parse(expr)
|
||||
if err != nil {
|
||||
return fmt.Errorf("jq parse: %w", err)
|
||||
}
|
||||
var input any
|
||||
if err := json.Unmarshal(envelopeJSON, &input); err != nil {
|
||||
return fmt.Errorf("jq input parse: %w", err)
|
||||
}
|
||||
iter := query.Run(input)
|
||||
for {
|
||||
v, ok := iter.Next()
|
||||
if !ok {
|
||||
return nil
|
||||
}
|
||||
if e, ok := v.(error); ok {
|
||||
return fmt.Errorf("jq eval: %w", e)
|
||||
}
|
||||
if s, ok := v.(string); ok {
|
||||
if _, err := fmt.Fprintln(w, s); err != nil {
|
||||
return err
|
||||
}
|
||||
continue
|
||||
}
|
||||
out, err := json.Marshal(v)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if _, err := w.Write(append(out, '\n')); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,196 @@
|
||||
package format_test
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/Tencent/WeKnora/cli/internal/format"
|
||||
)
|
||||
|
||||
func TestWriteEnvelopeFiltered_NoFilter(t *testing.T) {
|
||||
env := format.Success(map[string]any{"items": []any{
|
||||
map[string]any{"id": "1", "name": "alpha"},
|
||||
}}, &format.Meta{KBID: "kb_x"})
|
||||
buf := &bytes.Buffer{}
|
||||
if err := format.WriteEnvelopeFiltered(buf, env, nil, ""); err != nil {
|
||||
t.Fatalf("err = %v", err)
|
||||
}
|
||||
var got map[string]any
|
||||
if err := json.Unmarshal(buf.Bytes(), &got); err != nil {
|
||||
t.Fatalf("parse: %v", err)
|
||||
}
|
||||
if got["ok"] != true {
|
||||
t.Errorf("ok = %v, want true", got["ok"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteEnvelopeFiltered_FieldsOnListItems(t *testing.T) {
|
||||
env := format.Success(map[string]any{"items": []any{
|
||||
map[string]any{"id": "1", "name": "alpha", "kb_id": "kb_x", "updated_at": "2026-01-01"},
|
||||
map[string]any{"id": "2", "name": "beta", "kb_id": "kb_x", "updated_at": "2026-01-02"},
|
||||
}}, nil)
|
||||
|
||||
buf := &bytes.Buffer{}
|
||||
if err := format.WriteEnvelopeFiltered(buf, env, []string{"id", "name"}, ""); err != nil {
|
||||
t.Fatalf("err = %v", err)
|
||||
}
|
||||
|
||||
var got struct {
|
||||
OK bool `json:"ok"`
|
||||
Data struct {
|
||||
Items []map[string]string `json:"items"`
|
||||
} `json:"data"`
|
||||
}
|
||||
if err := json.Unmarshal(buf.Bytes(), &got); err != nil {
|
||||
t.Fatalf("parse: %v\n%s", err, buf.String())
|
||||
}
|
||||
if len(got.Data.Items) != 2 {
|
||||
t.Fatalf("items len = %d, want 2", len(got.Data.Items))
|
||||
}
|
||||
for i, item := range got.Data.Items {
|
||||
if _, has := item["kb_id"]; has {
|
||||
t.Errorf("item[%d] should not have kb_id: %v", i, item)
|
||||
}
|
||||
if _, has := item["updated_at"]; has {
|
||||
t.Errorf("item[%d] should not have updated_at: %v", i, item)
|
||||
}
|
||||
if item["id"] == "" || item["name"] == "" {
|
||||
t.Errorf("item[%d] missing required keys: %v", i, item)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteEnvelopeFiltered_FieldsOnSingleObject(t *testing.T) {
|
||||
env := format.Success(map[string]any{
|
||||
"id": "kb_x",
|
||||
"name": "Engineering",
|
||||
"owner": "alice",
|
||||
}, nil)
|
||||
|
||||
buf := &bytes.Buffer{}
|
||||
if err := format.WriteEnvelopeFiltered(buf, env, []string{"id", "name"}, ""); err != nil {
|
||||
t.Fatalf("err = %v", err)
|
||||
}
|
||||
|
||||
var got struct {
|
||||
Data map[string]string `json:"data"`
|
||||
}
|
||||
if err := json.Unmarshal(buf.Bytes(), &got); err != nil {
|
||||
t.Fatalf("parse: %v\n%s", err, buf.String())
|
||||
}
|
||||
if _, has := got.Data["owner"]; has {
|
||||
t.Errorf("should not have owner: %v", got.Data)
|
||||
}
|
||||
if got.Data["id"] != "kb_x" || got.Data["name"] != "Engineering" {
|
||||
t.Errorf("missing kept fields: %v", got.Data)
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteEnvelopeFiltered_UnknownFieldSilent(t *testing.T) {
|
||||
env := format.Success(map[string]any{"id": "1"}, nil)
|
||||
buf := &bytes.Buffer{}
|
||||
if err := format.WriteEnvelopeFiltered(buf, env, []string{"id", "nonexistent"}, ""); err != nil {
|
||||
t.Fatalf("err = %v", err)
|
||||
}
|
||||
var got struct {
|
||||
Data map[string]string `json:"data"`
|
||||
}
|
||||
if err := json.Unmarshal(buf.Bytes(), &got); err != nil {
|
||||
t.Fatalf("parse: %v", err)
|
||||
}
|
||||
if got.Data["id"] != "1" {
|
||||
t.Errorf("id missing: %v", got.Data)
|
||||
}
|
||||
if _, has := got.Data["nonexistent"]; has {
|
||||
t.Errorf("nonexistent should be silently dropped: %v", got.Data)
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteEnvelopeFiltered_PreservesEnvelopeFields(t *testing.T) {
|
||||
// Even with field filter, meta/risk/dry_run/error must be preserved.
|
||||
env := format.Success(map[string]any{"items": []any{
|
||||
map[string]any{"id": "1", "name": "x", "kb_id": "kb"},
|
||||
}}, &format.Meta{KBID: "kb_x", RequestID: "req_123"})
|
||||
|
||||
buf := &bytes.Buffer{}
|
||||
if err := format.WriteEnvelopeFiltered(buf, env, []string{"id"}, ""); err != nil {
|
||||
t.Fatalf("err = %v", err)
|
||||
}
|
||||
var got struct {
|
||||
OK bool `json:"ok"`
|
||||
Meta *format.Meta `json:"_meta"`
|
||||
Data struct {
|
||||
Items []map[string]any `json:"items"`
|
||||
} `json:"data"`
|
||||
DryRun bool `json:"dry_run"`
|
||||
}
|
||||
if err := json.Unmarshal(buf.Bytes(), &got); err != nil {
|
||||
t.Fatalf("parse: %v\n%s", err, buf.String())
|
||||
}
|
||||
if got.Meta == nil || got.Meta.RequestID != "req_123" {
|
||||
t.Errorf("_meta lost or mangled: %+v", got.Meta)
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteEnvelopeFiltered_JQOnly(t *testing.T) {
|
||||
env := format.Success(map[string]any{"items": []any{
|
||||
map[string]any{"id": "1", "name": "alpha"},
|
||||
map[string]any{"id": "2", "name": "beta"},
|
||||
}}, nil)
|
||||
|
||||
buf := &bytes.Buffer{}
|
||||
if err := format.WriteEnvelopeFiltered(buf, env, nil, ".data.items[].id"); err != nil {
|
||||
t.Fatalf("err = %v", err)
|
||||
}
|
||||
// gh CLI parity: string results render without JSON quotes
|
||||
// (see https://github.com/cli/cli/blob/trunk/pkg/export/filter.go).
|
||||
lines := strings.Split(strings.TrimRight(buf.String(), "\n"), "\n")
|
||||
if len(lines) != 2 {
|
||||
t.Fatalf("expected 2 lines, got %d: %q", len(lines), buf.String())
|
||||
}
|
||||
if lines[0] != "1" || lines[1] != "2" {
|
||||
t.Errorf("wrong output: %q", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteEnvelopeFiltered_FieldsAndJQ(t *testing.T) {
|
||||
env := format.Success(map[string]any{"items": []any{
|
||||
map[string]any{"id": "1", "name": "alpha", "kb_id": "kb"},
|
||||
map[string]any{"id": "2", "name": "beta", "kb_id": "kb"},
|
||||
}}, nil)
|
||||
|
||||
buf := &bytes.Buffer{}
|
||||
if err := format.WriteEnvelopeFiltered(buf, env, []string{"id", "name"}, ".data.items | length"); err != nil {
|
||||
t.Fatalf("err = %v", err)
|
||||
}
|
||||
out := strings.TrimSpace(buf.String())
|
||||
if out != "2" {
|
||||
t.Errorf("expected '2', got %q", out)
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteEnvelopeFiltered_JQParseError(t *testing.T) {
|
||||
env := format.Success(map[string]any{"x": 1}, nil)
|
||||
buf := &bytes.Buffer{}
|
||||
err := format.WriteEnvelopeFiltered(buf, env, nil, ".[invalid jq")
|
||||
if err == nil {
|
||||
t.Fatal("expected parse error, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "jq parse") {
|
||||
t.Errorf("expected 'jq parse' in error, got %q", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteEnvelopeFiltered_ScalarDataPassThrough(t *testing.T) {
|
||||
// Defensive: scalar data should not crash field filter.
|
||||
env := format.Success("just a string", nil)
|
||||
buf := &bytes.Buffer{}
|
||||
if err := format.WriteEnvelopeFiltered(buf, env, []string{"id"}, ""); err != nil {
|
||||
t.Fatalf("err = %v", err)
|
||||
}
|
||||
if !strings.Contains(buf.String(), `"just a string"`) {
|
||||
t.Errorf("scalar data lost: %s", buf.String())
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user