mirror of
https://github.com/larksuite/cli.git
synced 2026-09-14 18:42:53 +08:00
evandance
2b4c6349a1
Replace every command-facing error path in the event domain — the consume/schema command layer, the +subscribe shortcut, EventKey definitions, and the consume orchestration — with typed errs.* envelopes, so consumers get stable type, subtype, param, hint, and missing_scopes metadata for classification and recovery instead of free-form message text. - Input validation (--jq, --param, --output-dir, --filter, --route, unknown EventKey, EventKey params) reports validation / invalid_argument with the offending flag in param and an actionable hint. - Scope preflight reports authorization / missing_scope with the machine-readable missing_scopes list; console-subscription and single-bus preconditions report failed_precondition with recovery hints. - The consume API boundary passes already-typed errors through and classifies transport, non-JSON HTTP, and unparsable responses; the vc note-detail retry now matches the not-found code on typed errors (it silently never fired against the legacy envelope shape). - Previously-bare failures exited 1 with a plain-text "Error:" line and now exit with their category code (validation 2, auth 3, network 4, internal 5) alongside the typed stderr envelope. - forbidigo and errscontract guards now cover the event paths so regressions fail lint; AGENTS.md and the lark-event skill document the typed contract for agent consumers. Validation: make unit-test (race) green; event unit and e2e suites assert category/subtype/param/hint and cause preservation against the real binary; errscontract and golangci lint clean.
65 lines
1.8 KiB
Go
65 lines
1.8 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package consume
|
|
|
|
import (
|
|
"errors"
|
|
"testing"
|
|
|
|
"github.com/larksuite/cli/errs"
|
|
"github.com/larksuite/cli/internal/event"
|
|
)
|
|
|
|
func requireParamValidationError(t *testing.T, err error) {
|
|
t.Helper()
|
|
if err == nil {
|
|
t.Fatal("expected validation error, got nil")
|
|
}
|
|
var ve *errs.ValidationError
|
|
if !errors.As(err, &ve) {
|
|
t.Fatalf("expected *errs.ValidationError, got %T: %v", err, err)
|
|
}
|
|
if ve.Subtype != errs.SubtypeInvalidArgument || ve.Param != "--param" {
|
|
t.Errorf("subtype/param = %s/%q, want %s/%q", ve.Subtype, ve.Param, errs.SubtypeInvalidArgument, "--param")
|
|
}
|
|
if ve.Hint == "" {
|
|
t.Error("param validation error should hint at `lark-cli event schema`")
|
|
}
|
|
}
|
|
|
|
func TestValidateParams_RequiredMissing(t *testing.T) {
|
|
def := &event.KeyDefinition{
|
|
Key: "x.test",
|
|
Params: []event.ParamDef{{Name: "chat_id", Required: true}},
|
|
}
|
|
requireParamValidationError(t, validateParams(def, map[string]string{}))
|
|
}
|
|
|
|
func TestValidateParams_UnknownParam(t *testing.T) {
|
|
def := &event.KeyDefinition{
|
|
Key: "x.test",
|
|
Params: []event.ParamDef{{Name: "chat_id"}},
|
|
}
|
|
requireParamValidationError(t, validateParams(def, map[string]string{"nope": "1"}))
|
|
}
|
|
|
|
func TestValidateParams_UnknownParamNoParamsAccepted(t *testing.T) {
|
|
def := &event.KeyDefinition{Key: "x.test"}
|
|
requireParamValidationError(t, validateParams(def, map[string]string{"nope": "1"}))
|
|
}
|
|
|
|
func TestValidateParams_DefaultAppliedAndValidPasses(t *testing.T) {
|
|
def := &event.KeyDefinition{
|
|
Key: "x.test",
|
|
Params: []event.ParamDef{{Name: "mode", Required: true, Default: "all"}},
|
|
}
|
|
params := map[string]string{}
|
|
if err := validateParams(def, params); err != nil {
|
|
t.Fatalf("default should satisfy required param, got: %v", err)
|
|
}
|
|
if params["mode"] != "all" {
|
|
t.Errorf("default not applied, params=%v", params)
|
|
}
|
|
}
|