mirror of
https://github.com/larksuite/cli.git
synced 2026-07-03 14:02:43 +08:00
a73c9ae27e
- Add internal/client/api_errors.go with WrapDoAPIError and WrapJSONResponseParseError to classify JSON decode issues vs generic network errors - Route cmd/api DoAPI errors and HandleResponse JSON parse errors through the new helpers - Add regression tests in cmd/api and internal/client Related: https://github.com/larksuite/cli/issues/215
69 lines
2.0 KiB
Go
69 lines
2.0 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package client
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"strings"
|
|
|
|
"github.com/larksuite/cli/internal/output"
|
|
)
|
|
|
|
const rawAPIJSONHint = "The endpoint may have returned an empty or non-standard JSON body. If it returns a file, rerun with --output."
|
|
|
|
// WrapDoAPIError upgrades malformed JSON decode errors from the SDK into
|
|
// actionable API errors for raw `lark-cli api` calls. All other failures
|
|
// remain network errors.
|
|
func WrapDoAPIError(err error) error {
|
|
if err == nil {
|
|
return nil
|
|
}
|
|
if isJSONDecodeError(err, false) {
|
|
return output.ErrWithHint(output.ExitAPI, "api_error",
|
|
fmt.Sprintf("API returned an invalid JSON response: %v", err), rawAPIJSONHint)
|
|
}
|
|
return output.ErrNetwork("API call failed: %v", err)
|
|
}
|
|
|
|
// WrapJSONResponseParseError upgrades empty or malformed JSON response bodies
|
|
// into API errors with hints instead of generic parse failures.
|
|
func WrapJSONResponseParseError(err error, body []byte) error {
|
|
if err == nil {
|
|
return nil
|
|
}
|
|
if len(bytes.TrimSpace(body)) == 0 {
|
|
return output.ErrWithHint(output.ExitAPI, "api_error",
|
|
"API returned an empty JSON response body", rawAPIJSONHint)
|
|
}
|
|
if isJSONDecodeError(err, true) {
|
|
return output.ErrWithHint(output.ExitAPI, "api_error",
|
|
fmt.Sprintf("API returned an invalid JSON response: %v", err), rawAPIJSONHint)
|
|
}
|
|
return output.ErrNetwork("API call failed: %v", err)
|
|
}
|
|
|
|
func isJSONDecodeError(err error, allowEOF bool) bool {
|
|
var syntaxErr *json.SyntaxError
|
|
var unmarshalTypeErr *json.UnmarshalTypeError
|
|
|
|
if errors.As(err, &syntaxErr) || errors.As(err, &unmarshalTypeErr) {
|
|
return true
|
|
}
|
|
if allowEOF && (errors.Is(err, io.EOF) || errors.Is(err, io.ErrUnexpectedEOF)) {
|
|
return true
|
|
}
|
|
|
|
msg := err.Error()
|
|
if allowEOF && strings.Contains(msg, "unexpected EOF") {
|
|
return true
|
|
}
|
|
return strings.Contains(msg, "unexpected end of JSON input") ||
|
|
strings.Contains(msg, "invalid character") ||
|
|
strings.Contains(msg, "cannot unmarshal")
|
|
}
|