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.
52 lines
1.3 KiB
Go
52 lines
1.3 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package consume
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
|
|
"github.com/itchyny/gojq"
|
|
|
|
"github.com/larksuite/cli/errs"
|
|
)
|
|
|
|
// CompileJQ compiles once for hot-path reuse; exported so callers can preflight before side effects.
|
|
func CompileJQ(expr string) (*gojq.Code, error) {
|
|
query, err := gojq.Parse(expr)
|
|
if err != nil {
|
|
return nil, errs.NewValidationError(errs.SubtypeInvalidArgument,
|
|
"invalid jq expression: %s", err).WithParam("--jq").WithCause(err)
|
|
}
|
|
code, err := gojq.Compile(query)
|
|
if err != nil {
|
|
return nil, errs.NewValidationError(errs.SubtypeInvalidArgument,
|
|
"jq compile error: %s", err).WithParam("--jq").WithCause(err)
|
|
}
|
|
return code, nil
|
|
}
|
|
|
|
// applyJQ returns (nil, nil) when the expression filters out the event (e.g. select).
|
|
func applyJQ(code *gojq.Code, data json.RawMessage) (json.RawMessage, error) {
|
|
var input interface{}
|
|
if err := json.Unmarshal(data, &input); err != nil {
|
|
return nil, fmt.Errorf("jq: unmarshal input: %w", err)
|
|
}
|
|
|
|
iter := code.Run(input)
|
|
v, ok := iter.Next()
|
|
if !ok {
|
|
return nil, nil
|
|
}
|
|
if err, isErr := v.(error); isErr {
|
|
return nil, fmt.Errorf("jq: %w", err)
|
|
}
|
|
|
|
result, err := json.Marshal(v)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("jq: marshal result: %w", err)
|
|
}
|
|
return json.RawMessage(result), nil
|
|
}
|