mirror of
https://github.com/larksuite/cli.git
synced 2026-07-03 22:24:31 +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.
63 lines
2.0 KiB
Go
63 lines
2.0 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package event
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
|
|
"github.com/larksuite/cli/errs"
|
|
"github.com/larksuite/cli/internal/client"
|
|
"github.com/larksuite/cli/internal/core"
|
|
)
|
|
|
|
// consumeRuntime routes event.APIClient calls through the shared client.APIClient with a pinned identity.
|
|
type consumeRuntime struct {
|
|
client *client.APIClient
|
|
accessIdentity core.Identity
|
|
}
|
|
|
|
func (r *consumeRuntime) CallAPI(ctx context.Context, method, path string, body interface{}) (json.RawMessage, error) {
|
|
resp, err := r.client.DoAPI(ctx, client.RawApiRequest{
|
|
Method: method,
|
|
URL: path,
|
|
Data: body,
|
|
As: r.accessIdentity,
|
|
})
|
|
if err != nil {
|
|
if _, ok := errs.ProblemOf(err); ok {
|
|
return nil, err
|
|
}
|
|
return nil, errs.NewNetworkError(errs.SubtypeNetworkTransport,
|
|
"api %s %s: %s", method, path, err).WithCause(err)
|
|
}
|
|
// Non-JSON HTTP errors (gateway text/plain 404 etc.) skip OAPI envelope parsing.
|
|
ct := resp.Header.Get("Content-Type")
|
|
if resp.StatusCode >= 400 && !client.IsJSONContentType(ct) && ct != "" {
|
|
const maxBodyEcho = 256
|
|
body := string(resp.RawBody)
|
|
if len(body) > maxBodyEcho {
|
|
body = body[:maxBodyEcho] + "…(truncated)"
|
|
}
|
|
if resp.StatusCode >= 500 {
|
|
return nil, errs.NewNetworkError(errs.SubtypeNetworkServer,
|
|
"api %s %s returned %d: %s", method, path, resp.StatusCode, body).WithRetryable()
|
|
}
|
|
return nil, errs.NewInternalError(errs.SubtypeInvalidResponse,
|
|
"api %s %s returned %d: %s", method, path, resp.StatusCode, body)
|
|
}
|
|
result, err := client.ParseJSONResponse(resp)
|
|
if err != nil {
|
|
if _, ok := errs.ProblemOf(err); ok {
|
|
return nil, err
|
|
}
|
|
return nil, errs.NewInternalError(errs.SubtypeInvalidResponse,
|
|
"api %s %s: %s", method, path, err).WithCause(err)
|
|
}
|
|
if apiErr := r.client.CheckResponse(result, r.accessIdentity); apiErr != nil {
|
|
return json.RawMessage(resp.RawBody), apiErr
|
|
}
|
|
return json.RawMessage(resp.RawBody), nil
|
|
}
|