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.
74 lines
2.1 KiB
Go
74 lines
2.1 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package calendar
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
|
|
"github.com/larksuite/cli/internal/output"
|
|
)
|
|
|
|
const (
|
|
errCodeInvalidParamsWithDetail = 190014
|
|
)
|
|
|
|
// getErrorDetailValue extracts the first detail value from the output.ErrDetail.
|
|
// It assumes Detail is a map containing a "details" array of objects with "value" string fields.
|
|
// For example: {"details": [{"value": "error message 1"}, {"value": "error message 2"}]}
|
|
// Returns an empty string if the structure doesn't match or the array is empty.
|
|
//
|
|
// Deprecated: getErrorDetailValue reads from the legacy *output.ErrDetail
|
|
// that predates the typed error contract introduced by errs/. New code MUST
|
|
// NOT use it — typed errs.* errors expose Message, Hint, and extension
|
|
// fields directly on the typed struct via errors.As / errs.ProblemOf. This
|
|
// helper is retained only while existing call sites are migrated; it will
|
|
// be removed once they have moved to the typed surface.
|
|
func getErrorDetailValue(e *output.ErrDetail) string {
|
|
if e == nil || e.Detail == nil {
|
|
return ""
|
|
}
|
|
|
|
errMap, ok := e.Detail.(map[string]interface{})
|
|
if !ok {
|
|
return ""
|
|
}
|
|
|
|
details, ok := errMap["details"].([]interface{})
|
|
if !ok || len(details) == 0 {
|
|
return ""
|
|
}
|
|
|
|
detailObj, ok := details[0].(map[string]interface{})
|
|
if !ok {
|
|
return ""
|
|
}
|
|
|
|
val, _ := detailObj["value"].(string)
|
|
return val
|
|
}
|
|
|
|
// wrapPredefinedError wraps an error into *output.ExitError if it matches predefined error codes.
|
|
// Currently handles error code 190014 (invalid params with detail), extracting the detail value into the message.
|
|
// If the error is nil or doesn't match predefined codes, returns the original error.
|
|
func wrapPredefinedError(err error) error {
|
|
if err == nil {
|
|
return nil
|
|
}
|
|
|
|
var exitErr *output.ExitError
|
|
if !errors.As(err, &exitErr) || exitErr.Detail == nil {
|
|
return err
|
|
}
|
|
|
|
if exitErr.Detail.Code == errCodeInvalidParamsWithDetail {
|
|
if val := getErrorDetailValue(exitErr.Detail); val != "" {
|
|
fullMsg := fmt.Sprintf("%s: %s", exitErr.Detail.Message, val)
|
|
return output.ErrAPI(exitErr.Detail.Code, fullMsg, exitErr.Detail.Detail)
|
|
}
|
|
}
|
|
|
|
return err
|
|
}
|