mirror of
https://github.com/larksuite/cli.git
synced 2026-07-06 08:12:36 +08:00
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.
70 lines
1.8 KiB
Go
70 lines
1.8 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package event
|
|
|
|
import (
|
|
"fmt"
|
|
"sort"
|
|
"strings"
|
|
|
|
"github.com/larksuite/cli/errs"
|
|
eventlib "github.com/larksuite/cli/internal/event"
|
|
"github.com/larksuite/cli/internal/suggest"
|
|
)
|
|
|
|
const maxSuggestions = 3
|
|
|
|
// suggestEventKeys returns up to maxSuggestions keys resembling input (substring match beats edit distance).
|
|
func suggestEventKeys(input string) []string {
|
|
type match struct {
|
|
key string
|
|
dist int
|
|
}
|
|
var hits []match
|
|
threshold := max(2, len(input)/5)
|
|
|
|
for _, def := range eventlib.ListAll() {
|
|
if strings.Contains(def.Key, input) {
|
|
hits = append(hits, match{def.Key, 0})
|
|
continue
|
|
}
|
|
if d := suggest.Levenshtein(input, def.Key); d <= threshold {
|
|
hits = append(hits, match{def.Key, d})
|
|
}
|
|
}
|
|
sort.Slice(hits, func(i, j int) bool { return hits[i].dist < hits[j].dist })
|
|
|
|
n := min(maxSuggestions, len(hits))
|
|
out := make([]string, n)
|
|
for i := range out {
|
|
out[i] = hits[i].key
|
|
}
|
|
return out
|
|
}
|
|
|
|
// formatSuggestions renders keys as a human-readable quoted tail.
|
|
func formatSuggestions(keys []string) string {
|
|
if len(keys) == 0 {
|
|
return ""
|
|
}
|
|
quoted := make([]string, len(keys))
|
|
for i, k := range keys {
|
|
quoted[i] = fmt.Sprintf("%q", k)
|
|
}
|
|
if len(quoted) == 1 {
|
|
return quoted[0]
|
|
}
|
|
return "one of: " + strings.Join(quoted, ", ")
|
|
}
|
|
|
|
// unknownEventKeyErr builds the shared "unknown EventKey" error with a suggestion tail when available.
|
|
func unknownEventKeyErr(key string) error {
|
|
msg := fmt.Sprintf("unknown EventKey: %s", key)
|
|
if guesses := suggestEventKeys(key); len(guesses) > 0 {
|
|
msg += " — did you mean " + formatSuggestions(guesses) + "?"
|
|
}
|
|
return errs.NewValidationError(errs.SubtypeInvalidArgument, "%s", msg).
|
|
WithHint("Run 'lark-cli event list' to see available keys.")
|
|
}
|