mirror of
https://github.com/larksuite/cli.git
synced 2026-07-03 14:02:43 +08:00
fe72e41fb2
Introduce a typed error contract framework for lark-cli so in-process
Go callers can branch via errors.As(&errs.XxxError{}) and shell scripts,
AI agents, and protocol adapters can branch on stable JSON type/subtype
fields instead of regex-parsing free-form messages.
Adds:
- Canonical taxonomy under errs/ (9 categories + typed Error structs
embedding a shared Problem, RFC 7807-aligned)
- Centralized Lark code metadata + identity-aware BuildAPIError dispatch
- Typed JSON envelope writer alongside the legacy envelope writer
- MCP / OAuth (RFC 6750 Bearer) projection adapters
- Five CI lint guards preventing ad-hoc taxonomy drift
Backward compatibility: legacy *output.ExitError producers (ErrAPI,
ErrWithHint, Errorf, ErrBare) and business shortcuts that use them
continue to render the legacy envelope unchanged. SecurityPolicyError
wire format and exit code are preserved via a carve-out; taxonomy
migration is deferred to PR 2. Domain-specific business migration is
staged across PR 3+.
Framework-direct paths now return typed *errs.*Error: ErrAuth /
ErrValidation / ErrNetwork emit category literals on the wire
(authentication / validation / network), *core.ConfigError is promoted
at the cmd/root boundary with exit code aligned from 2 to 3, and Lark
API permission denials classified by BuildAPIError exit 3.
At the SDK boundary, WrapDoAPIError preserves any already-classified
error (legacy *output.ExitError or typed *errs.*) so output.ErrAuth
from missing credentials surfaces with the auth category and exit 3
intact instead of being downgraded to a network error. Policy responses
classified by BuildAPIError (codes 21000 / 21001) extract challenge_url
and the canonical hint from the response body, matching what the
auth transport already surfaces at the HTTP layer; non-https
challenge URLs are dropped.
First PR in the feat/error-contract-* series.
50 lines
1.4 KiB
Go
50 lines
1.4 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package event
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
|
|
"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 {
|
|
return nil, 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)"
|
|
}
|
|
return nil, fmt.Errorf("api %s %s returned %d: %s", method, path, resp.StatusCode, body)
|
|
}
|
|
result, err := client.ParseJSONResponse(resp)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if apiErr := r.client.CheckResponse(result, r.accessIdentity); apiErr != nil {
|
|
return json.RawMessage(resp.RawBody), apiErr
|
|
}
|
|
return json.RawMessage(resp.RawBody), nil
|
|
}
|