mirror of
https://github.com/larksuite/cli.git
synced 2026-07-06 00:06:28 +08:00
f2a4c95665
Wiki write-path operations (most commonly `wiki +node-create` against the same parent) surface code 131009 "lock contention" under concurrent calls. Currently this falls through to the generic "api_error" classification, giving users no hint that it is transient and safe to retry. Mirror the existing `LarkErrDriveResourceContention` (1061045) treatment: add a named constant, classify as "conflict", and emit a hint that points the caller toward exponential backoff or serializing sibling-node writes. Refs: #1012
114 lines
3.3 KiB
Go
114 lines
3.3 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package output
|
|
|
|
import (
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
// TestClassifyLarkError_DriveCreateShortcutConstraints verifies known Drive shortcut errors map to actionable hints.
|
|
func TestClassifyLarkError_DriveCreateShortcutConstraints(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tests := []struct {
|
|
name string
|
|
code int
|
|
wantExitCode int
|
|
wantType string
|
|
wantHint string
|
|
}{
|
|
{
|
|
name: "resource contention",
|
|
code: LarkErrDriveResourceContention,
|
|
wantExitCode: ExitAPI,
|
|
wantType: "conflict",
|
|
wantHint: "avoid concurrent duplicate requests",
|
|
},
|
|
{
|
|
name: "cross tenant unit",
|
|
code: LarkErrDriveCrossTenantUnit,
|
|
wantExitCode: ExitAPI,
|
|
wantType: "cross_tenant_unit",
|
|
wantHint: "same tenant and region/unit",
|
|
},
|
|
{
|
|
name: "cross brand",
|
|
code: LarkErrDriveCrossBrand,
|
|
wantExitCode: ExitAPI,
|
|
wantType: "cross_brand",
|
|
wantHint: "same brand environment",
|
|
},
|
|
{
|
|
name: "sheets float image invalid dims",
|
|
code: LarkErrSheetsFloatImageInvalidDims,
|
|
wantExitCode: ExitAPI,
|
|
wantType: "invalid_params",
|
|
wantHint: "--width / --height / --offset-x / --offset-y",
|
|
},
|
|
{
|
|
name: "drive permission apply rate limit",
|
|
code: LarkErrDrivePermApplyRateLimit,
|
|
wantExitCode: ExitAPI,
|
|
wantType: "rate_limit",
|
|
wantHint: "5 times per day",
|
|
},
|
|
{
|
|
name: "drive permission apply not applicable",
|
|
code: LarkErrDrivePermApplyNotApplicable,
|
|
wantExitCode: ExitAPI,
|
|
wantType: "invalid_params",
|
|
wantHint: "does not accept a permission-apply request",
|
|
},
|
|
{
|
|
name: "ownership mismatch",
|
|
code: LarkErrOwnershipMismatch,
|
|
wantExitCode: ExitAPI,
|
|
wantType: "ownership_mismatch",
|
|
wantHint: "messages-resources-download",
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
gotExitCode, gotType, gotHint := ClassifyLarkError(tt.code, "raw msg")
|
|
if gotExitCode != tt.wantExitCode {
|
|
t.Fatalf("exitCode=%d, want %d", gotExitCode, tt.wantExitCode)
|
|
}
|
|
if gotType != tt.wantType {
|
|
t.Fatalf("type=%q, want %q", gotType, tt.wantType)
|
|
}
|
|
if gotHint == "" {
|
|
t.Fatal("expected non-empty hint")
|
|
}
|
|
if !strings.Contains(gotHint, tt.wantHint) {
|
|
t.Fatalf("hint=%q, want substring %q", gotHint, tt.wantHint)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// TestClassifyLarkError_WikiLockContention verifies the wiki write-lock
|
|
// contention error (131009) maps to an actionable retry hint instead of
|
|
// a generic "api_error". Surfaces during concurrent wiki +node-create
|
|
// against the same parent (see larksuite/cli#1012).
|
|
func TestClassifyLarkError_WikiLockContention(t *testing.T) {
|
|
t.Parallel()
|
|
gotExitCode, gotType, gotHint := ClassifyLarkError(LarkErrWikiLockContention, "raw msg")
|
|
if gotExitCode != ExitAPI {
|
|
t.Fatalf("exitCode=%d, want %d", gotExitCode, ExitAPI)
|
|
}
|
|
if gotType != "conflict" {
|
|
t.Fatalf("type=%q, want %q", gotType, "conflict")
|
|
}
|
|
if !strings.Contains(gotHint, "wiki write lock") {
|
|
t.Fatalf("hint=%q, want substring %q", gotHint, "wiki write lock")
|
|
}
|
|
if !strings.Contains(gotHint, "backoff") {
|
|
t.Fatalf("hint=%q, want substring %q", gotHint, "backoff")
|
|
}
|
|
}
|