mirror of
https://github.com/larksuite/cli.git
synced 2026-07-03 14:02:43 +08:00
c09b03f854
The previous default (atomic.Bool zero-value = enabled) meant any *cobra.Command built without first calling configureFlagCompletions leaked into cobra's package-global flagCompletionFunctions map. Bench runs (scripts/bench_build) showed hundreds of KB and thousands of objects retained per Build call. Flip the semantics so the zero-value matches the safe default: - Rename internal var to flagCompletionsEnabled (zero = disabled). - Rename public API to SetFlagCompletionsEnabled / FlagCompletionsEnabled. - Update call sites in cmd/root.go and scripts/bench_build/main.go. - Add cmd.TestBuild_DefaultNoCompletionLeak: asserts that, with no setter call at all, repeated cmd.Build invocations stay under 50 KB and 500 objects per build (observed: ~0.7 KB, 3 objs/build). This closes the gap that let the wrong default ship — every previous test explicitly Set the switch before exercising it. Change-Id: Ifefb04af5fd45eea9676a344a64ad071b6a4cd1a
80 lines
2.4 KiB
Go
80 lines
2.4 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package cmdutil
|
|
|
|
import (
|
|
"runtime"
|
|
"sync/atomic"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
func TestSetFlagCompletionsEnabled_RoundTrip(t *testing.T) {
|
|
t.Cleanup(func() { SetFlagCompletionsEnabled(false) })
|
|
|
|
if FlagCompletionsEnabled() {
|
|
t.Fatal("expected default false (completions disabled by default)")
|
|
}
|
|
SetFlagCompletionsEnabled(true)
|
|
if !FlagCompletionsEnabled() {
|
|
t.Fatal("expected true after Set(true)")
|
|
}
|
|
SetFlagCompletionsEnabled(false)
|
|
if FlagCompletionsEnabled() {
|
|
t.Fatal("expected false after Set(false)")
|
|
}
|
|
}
|
|
|
|
// When disabled, a *cobra.Command must be collectable after the caller drops
|
|
// its reference — i.e. the wrapper did not touch cobra's global map.
|
|
func TestRegisterFlagCompletion_Disabled_DoesNotRetainCommand(t *testing.T) {
|
|
SetFlagCompletionsEnabled(false)
|
|
t.Cleanup(func() { SetFlagCompletionsEnabled(false) })
|
|
|
|
const N = 5
|
|
var collected atomic.Int32
|
|
func() {
|
|
for range N {
|
|
cmd := &cobra.Command{Use: "x"}
|
|
cmd.Flags().String("foo", "", "")
|
|
RegisterFlagCompletion(cmd, "foo", func(_ *cobra.Command, _ []string, _ string) ([]cobra.Completion, cobra.ShellCompDirective) {
|
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
|
})
|
|
runtime.SetFinalizer(cmd, func(_ *cobra.Command) { collected.Add(1) })
|
|
}
|
|
}()
|
|
// Finalizers run on a dedicated goroutine after GC; loop to give it time.
|
|
for range 30 {
|
|
runtime.GC()
|
|
time.Sleep(20 * time.Millisecond)
|
|
}
|
|
if got := collected.Load(); int(got) != N {
|
|
t.Fatalf("expected %d *cobra.Command finalizers to fire when completions disabled, got %d", N, got)
|
|
}
|
|
}
|
|
|
|
// When enabled, the registered completion must be reachable via cobra.
|
|
func TestRegisterFlagCompletion_Enabled_DoesRegister(t *testing.T) {
|
|
SetFlagCompletionsEnabled(true)
|
|
t.Cleanup(func() { SetFlagCompletionsEnabled(false) })
|
|
|
|
cmd := &cobra.Command{Use: "x"}
|
|
cmd.Flags().String("foo", "", "")
|
|
want := []cobra.Completion{"a", "b"}
|
|
RegisterFlagCompletion(cmd, "foo", func(_ *cobra.Command, _ []string, _ string) ([]cobra.Completion, cobra.ShellCompDirective) {
|
|
return want, cobra.ShellCompDirectiveNoFileComp
|
|
})
|
|
|
|
fn, ok := cmd.GetFlagCompletionFunc("foo")
|
|
if !ok {
|
|
t.Fatal("expected completion func to be registered")
|
|
}
|
|
got, _ := fn(cmd, nil, "")
|
|
if len(got) != 2 || got[0] != "a" || got[1] != "b" {
|
|
t.Fatalf("unexpected completion result: %v", got)
|
|
}
|
|
}
|