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.
100 lines
3.2 KiB
Go
100 lines
3.2 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package consume
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"io"
|
|
"net"
|
|
"strconv"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/larksuite/cli/errs"
|
|
"github.com/larksuite/cli/internal/event"
|
|
)
|
|
|
|
// failDialTransport refuses every dial so EnsureBus falls through to the
|
|
// remote-connection check without a local bus.
|
|
type failDialTransport struct{}
|
|
|
|
func (failDialTransport) Listen(string) (net.Listener, error) { return nil, errors.New("no listen") }
|
|
func (failDialTransport) Dial(string) (net.Conn, error) { return nil, errors.New("refused") }
|
|
func (failDialTransport) Address(string) string { return "guard-test-addr" }
|
|
func (failDialTransport) Cleanup(string) {}
|
|
|
|
// remoteBusyAPIClient reports active remote WebSocket connections.
|
|
type remoteBusyAPIClient struct{ count int }
|
|
|
|
func (c remoteBusyAPIClient) CallAPI(context.Context, string, string, interface{}) (json.RawMessage, error) {
|
|
return json.RawMessage(`{"code":0,"msg":"ok","data":{"online_instance_cnt":` +
|
|
strconv.Itoa(c.count) + `}}`), nil
|
|
}
|
|
|
|
func TestEnsureBus_RemoteBusAlreadyConnectedIsFailedPrecondition(t *testing.T) {
|
|
conn, err := EnsureBus(context.Background(), failDialTransport{},
|
|
"cli_guard_test", "", "", remoteBusyAPIClient{count: 2}, io.Discard)
|
|
if conn != nil {
|
|
t.Fatal("expected nil conn when a remote bus is already connected")
|
|
}
|
|
if err == nil {
|
|
t.Fatal("expected single-bus guard error")
|
|
}
|
|
var ve *errs.ValidationError
|
|
if !errors.As(err, &ve) {
|
|
t.Fatalf("expected *errs.ValidationError, got %T: %v", err, err)
|
|
}
|
|
if ve.Subtype != errs.SubtypeFailedPrecondition {
|
|
t.Errorf("subtype = %s, want %s", ve.Subtype, errs.SubtypeFailedPrecondition)
|
|
}
|
|
if !strings.Contains(ve.Hint, "event stop") {
|
|
t.Errorf("hint should point at `event stop`, got: %q", ve.Hint)
|
|
}
|
|
}
|
|
|
|
func TestRun_UnknownEventKeyIsTypedValidation(t *testing.T) {
|
|
err := Run(context.Background(), failDialTransport{}, "cli_x", "", "", Options{
|
|
EventKey: "bogus.run.key",
|
|
ErrOut: io.Discard,
|
|
})
|
|
if err == nil {
|
|
t.Fatal("expected unknown EventKey error")
|
|
}
|
|
var ve *errs.ValidationError
|
|
if !errors.As(err, &ve) {
|
|
t.Fatalf("expected *errs.ValidationError, got %T: %v", err, err)
|
|
}
|
|
if ve.Subtype != errs.SubtypeInvalidArgument {
|
|
t.Errorf("subtype = %s, want %s", ve.Subtype, errs.SubtypeInvalidArgument)
|
|
}
|
|
if !strings.Contains(ve.Hint, "event list") {
|
|
t.Errorf("hint should point at `event list`, got: %q", ve.Hint)
|
|
}
|
|
}
|
|
|
|
func TestRun_InvalidJQFailsBeforeAnySideEffect(t *testing.T) {
|
|
event.RegisterKey(event.KeyDefinition{
|
|
Key: "consume.runtest.jq",
|
|
EventType: "consume.runtest.jq_v1",
|
|
Schema: event.SchemaDef{Custom: &event.SchemaSpec{Raw: json.RawMessage(`{}`)}},
|
|
})
|
|
err := Run(context.Background(), failDialTransport{}, "cli_x", "", "", Options{
|
|
EventKey: "consume.runtest.jq",
|
|
JQExpr: "[invalid{{{",
|
|
ErrOut: io.Discard,
|
|
})
|
|
if err == nil {
|
|
t.Fatal("expected jq validation error")
|
|
}
|
|
var ve *errs.ValidationError
|
|
if !errors.As(err, &ve) {
|
|
t.Fatalf("expected *errs.ValidationError, got %T: %v", err, err)
|
|
}
|
|
if ve.Param != "--jq" {
|
|
t.Errorf("param = %q, want %q", ve.Param, "--jq")
|
|
}
|
|
}
|