mirror of
https://github.com/larksuite/cli.git
synced 2026-07-03 14:02:43 +08:00
5e6a3eb857
* feat(mail): return typed error envelopes across the mail domain Replace every produced error path in shortcuts/mail with typed errs.* envelopes, so consumers get stable category, subtype, param/params, hint, retryable, and log_id metadata for classification and recovery instead of free-form message text. - Locally constructed mail errors move from output.Err* / output.Errorf / final fmt.Errorf / common legacy helpers to errs.* builders, with structured params on multi-flag validation and failed-precondition states kept non-retryable. - API-call failures move from runtime.CallAPI / DoAPIJSON legacy boundaries to runtime.CallAPITyped or runtime.ClassifyAPIResponse, and mail-specific enrichers read errs.ProblemOf so typed code, subtype, hint, and log_id metadata are preserved. - Batch draft-send partial failures now use runtime.OutPartialFailure so successful and failed draft sends stay in stdout while the command exits through a typed multi-status signal. - Add mail-domain typed helpers, mail API code metadata, and guard wiring to keep shortcuts/mail from reintroducing legacy envelopes or legacy API calls. - Keep genuine intermediate fmt.Errorf wraps in parser/builder layers annotated with nolint comments; command-facing paths wrap them into typed validation, API, network, or internal errors. * fix(mail): report aborted draft-send batches as a single failure result When an account-level failure interrupts a batch send after some drafts already went out, the command previously produced two machine-readable failure results: the partial-failure ledger on stdout and a second error envelope on stderr. Consumers could not tell which one to recover from. The batch ledger is now the only failure result for that case: it gains aborted and abort_error fields carrying the typed cause, so callers can see which drafts were sent, which failed, why the batch stopped, and how to recover — all from stdout. A --stop-on-error stop keeps these fields unset because stopping early there is the caller's own choice.
77 lines
2.1 KiB
Go
77 lines
2.1 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package mail
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/larksuite/cli/errs"
|
|
"github.com/larksuite/cli/extension/fileio"
|
|
)
|
|
|
|
func mailValidationError(format string, args ...any) *errs.ValidationError {
|
|
return errs.NewValidationError(errs.SubtypeInvalidArgument, format, args...)
|
|
}
|
|
|
|
func mailValidationParamError(param, format string, args ...any) *errs.ValidationError {
|
|
return mailValidationError(format, args...).WithParam(param)
|
|
}
|
|
|
|
func mailInvalidParam(name, reason string) errs.InvalidParam {
|
|
return errs.InvalidParam{Name: name, Reason: reason}
|
|
}
|
|
|
|
func mailFailedPreconditionError(format string, args ...any) *errs.ValidationError {
|
|
return errs.NewValidationError(errs.SubtypeFailedPrecondition, format, args...)
|
|
}
|
|
|
|
func mailInvalidResponseError(format string, args ...any) *errs.InternalError {
|
|
return errs.NewInternalError(errs.SubtypeInvalidResponse, format, args...)
|
|
}
|
|
|
|
func mailFileIOError(format string, err error, args ...any) *errs.InternalError {
|
|
return errs.NewInternalError(errs.SubtypeFileIO, format, args...).WithCause(err)
|
|
}
|
|
|
|
func mailInputStatError(err error) error {
|
|
if err == nil {
|
|
return nil
|
|
}
|
|
if errors.Is(err, fileio.ErrPathValidation) {
|
|
return mailValidationError("unsafe file path: %s", err).WithCause(err)
|
|
}
|
|
return mailValidationError("cannot read file: %s", err).WithCause(err)
|
|
}
|
|
|
|
func mailDecorateProblemMessage(err error, format string, args ...any) error {
|
|
if err == nil {
|
|
return nil
|
|
}
|
|
prefix := fmt.Sprintf(format, args...)
|
|
if p, ok := errs.ProblemOf(err); ok {
|
|
if strings.TrimSpace(prefix) != "" {
|
|
p.Message = prefix + ": " + p.Message
|
|
}
|
|
return err
|
|
}
|
|
return errs.NewInternalError(errs.SubtypeSDKError, "%s: %s", prefix, err.Error()).WithCause(err)
|
|
}
|
|
|
|
func mailAppendProblemHint(err error, hint string) error {
|
|
if err == nil {
|
|
return nil
|
|
}
|
|
if p, ok := errs.ProblemOf(err); ok {
|
|
if strings.TrimSpace(p.Hint) != "" {
|
|
p.Hint = p.Hint + "; " + hint
|
|
} else {
|
|
p.Hint = hint
|
|
}
|
|
return err
|
|
}
|
|
return errs.NewAPIError(errs.SubtypeUnknown, "%s", err.Error()).WithHint("%s", hint).WithCause(err)
|
|
}
|