nullkey
e623e8208f
Removes the entire envelope machinery now that every success path
emits bare JSON:
- cli/internal/format/envelope.go (Envelope, Success, Failure,
SuccessWithRisk, WriteEnvelope, Meta, Notice, UpdateNotice,
VersionSkewNotice, Risk, RiskLevel, ErrorBody) + tests.
- cli/internal/format/filter.go envelope-specific helpers
(WriteEnvelopeFiltered, marshalEnvelope, applyFieldFilter,
filterDataPayload, filterObjectData); the reusable
filterArrayItems / filterObjectKeys / writeJQ stay for bare.go.
- cli/internal/cmdutil/exporter.go + tests (envelope-only).
- cli/internal/cmdutil/PrintErrorEnvelope + ToErrorBody +
operationRiskOf + Error.OperationRisk field + OperationRisk struct.
Error path: all errors now go to stderr via cmdutil.PrintError in
`code: message\nhint: ...` form, regardless of --json. Stdout stays
empty (or holds the partial-success the command already wrote) so
downstream `--json | jq` pipelines never have to filter error shapes
out of the success stream. Typed exit codes (3 auth.* / 4
resource.not_found / 5 input.* / 6 server.rate_limited / 7 server.*
+ network.* / 10 input.confirmation_required) carry the failure
class for agents that branch on it.
Acceptance contract:
- envelope_test.go → wire_test.go (TestEnvelopeGolden → TestWireGolden).
- testdata/envelopes/ → testdata/wire/.
- Error-path cases assert the typed code substring on stderr.
- Orphan whoami.*.json goldens deleted.
AGENTS.md + README.md rewritten for the bare-data contract:
- Drop envelope schema section + dry-run rule.
- Document bare JSON on stdout + `code: msg\nhint: …` on stderr.
- ADR-3 reframed around bare data and why error separation matters
for `--json | jq` pipelines.
WriteJSONFiltered short-circuits to WriteJSON when both filters are
empty (skip the marshal-buffer round-trip for the common case).
Final review pass:
- Fix wire-contract bug: `--json id,name` (space form) is broken by
pflag's NoOptDefVal; AGENTS.md / README.md / SetAgentHelp + the
field-discovery help text all switched to `--json=id,name`.
- Fix `weknora api --jq` silently ignored: api.go now routes through
WriteJSONFiltered with jopts.JQ.
- AGENTS.md: drop the false claim that `auth logout` honors `-y`
(logout is local-only with no ConfirmDestructive guard); list the
actual destructive commands instead.
- Rewrite cli/acceptance/e2e/e2e_test.go for the bare-data wire shape
(was still parsing `out["data"]` / `env["ok"]`).
- Add `JSONOptions.Emit(w, v)` helper; collapse ~33 repeated
`format.WriteJSONFiltered(iostreams.IO.Out, X, jopts.Fields,
jopts.JQ)` sites to `jopts.Emit(iostreams.IO.Out, X)` — drops the
format import from 22 cmd/* files.
- Delete single-caller `cmdutil.MustRequireFlag`; inline as
`_ = cmd.MarkFlagRequired(...)` everywhere.
- Add `_ = cmd.MarkFlagRequired("name")` to `kb create`; it was the
only write command relying on runtime --name validation while
`context add` already used the cobra-level mark.
- `context use`: register `--json` / `--jq` (was always emitting JSON
unconditionally with no human path and no flag — diverged from
every other write command); human mode now prints
`✓ Switched context to X (was Y)`.
- Replace per-package `confirmPrompter` / `scriptedConfirm` /
`errPrompter` test doubles with `testutil.ConfirmPrompter`.
- Rename `chatService` → `ChatService` (export to match siblings
`ListService` / `ViewService`); rename `printUploadSuccess` →
`renderUploadSuccess` (siblings use `render*`).
- `defaultHint(CodeResourceNotFound)`: drop the hardcoded
"list available with `weknora kb list`" — misleading on agent /
doc / session 404. Replaced with "verify the resource ID and try
again".
- Strip stale `v0.2/v0.3` / "envelope" / "v0.0/v0.1 supports only"
historical tags from production comments and a few test
descriptions.
103 lines
3.0 KiB
Go
103 lines
3.0 KiB
Go
package auth
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/aiclient"
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// authStatusFields enumerates the fields surfaced for `--json` discovery
|
|
// on `auth status`. Single-resource shape: filter applies to data itself.
|
|
var authStatusFields = []string{
|
|
"context", "user_id", "email", "tenant_id", "tenant_name",
|
|
}
|
|
|
|
// StatusService is the narrow SDK surface auth status depends on.
|
|
type StatusService interface {
|
|
GetCurrentUser(ctx context.Context) (*sdk.CurrentUserResponse, error)
|
|
}
|
|
|
|
// statusResult is the typed payload emitted by `--json`.
|
|
type statusResult struct {
|
|
Context string `json:"context"`
|
|
UserID string `json:"user_id,omitempty"`
|
|
Email string `json:"email,omitempty"`
|
|
TenantID uint64 `json:"tenant_id,omitempty"`
|
|
TenantName string `json:"tenant_name,omitempty"`
|
|
}
|
|
|
|
// NewCmdStatus builds the `weknora auth status` command.
|
|
func NewCmdStatus(f *cmdutil.Factory) *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "status",
|
|
Short: "Show the active context, principal, and token state",
|
|
Args: cobra.NoArgs,
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
jopts, err := cmdutil.CheckJSONFlags(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runStatus(c.Context(), jopts, f, cli)
|
|
},
|
|
}
|
|
cmdutil.AddJSONFlags(cmd, authStatusFields)
|
|
aiclient.SetAgentHelp(cmd, "Live-checks the active credential by calling /auth/me. Returns {context, user_id, email, tenant_id, tenant_name}. Errors: auth.unauthenticated when token is invalid or missing (run `auth login` / `auth refresh`).")
|
|
return cmd
|
|
}
|
|
|
|
func runStatus(ctx context.Context, jopts *cmdutil.JSONOptions, f *cmdutil.Factory, svc StatusService) error {
|
|
if svc == nil {
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated, "no SDK client available; run `weknora auth login`")
|
|
}
|
|
resp, err := svc.GetCurrentUser(ctx)
|
|
if err != nil {
|
|
return cmdutil.WrapHTTP(err, "fetch current user")
|
|
}
|
|
user := resp.Data.User
|
|
tenant := resp.Data.Tenant
|
|
|
|
cfg, err := f.Config()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if jopts.Enabled() {
|
|
result := statusResult{Context: cfg.CurrentContext}
|
|
if user != nil {
|
|
result.UserID = user.ID
|
|
result.Email = user.Email
|
|
result.TenantID = user.TenantID
|
|
}
|
|
if tenant != nil {
|
|
result.TenantName = tenant.Name
|
|
}
|
|
return jopts.Emit(iostreams.IO.Out, result)
|
|
}
|
|
|
|
host := ""
|
|
if c, ok := cfg.Contexts[cfg.CurrentContext]; ok {
|
|
host = c.Host
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "context: %s\n", cfg.CurrentContext)
|
|
fmt.Fprintf(iostreams.IO.Out, "host: %s\n", host)
|
|
if user != nil {
|
|
fmt.Fprintf(iostreams.IO.Out, "user: %s (%s)\n", user.Email, user.ID)
|
|
fmt.Fprintf(iostreams.IO.Out, "tenant: %d", user.TenantID)
|
|
if tenant != nil {
|
|
fmt.Fprintf(iostreams.IO.Out, " (%s)", tenant.Name)
|
|
}
|
|
fmt.Fprintln(iostreams.IO.Out)
|
|
}
|
|
return nil
|
|
}
|