mirror of
https://github.com/larksuite/cli.git
synced 2026-07-07 00:55:53 +08:00
11191df703
* fix: skip flag-completion registration outside completion path Cobra keeps completion callbacks in a package-global map keyed by *pflag.Flag with no removal path, so registrations made during Build() outlive the command itself. Route all seven call sites through cmdutil.RegisterFlagCompletion and enable registration only when the invocation actually serves a __complete request. Measured over 30 dropped Builds: ~202 KB / 2180 retained objects per Build before, ~0 after. Change-Id: I734d598a4c91a92c33b02e0f292f640cc0e224c6
79 lines
2.3 KiB
Go
79 lines
2.3 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 TestSetFlagCompletionsDisabled_RoundTrip(t *testing.T) {
|
|
t.Cleanup(func() { SetFlagCompletionsDisabled(false) })
|
|
|
|
if FlagCompletionsDisabled() {
|
|
t.Fatal("expected default false")
|
|
}
|
|
SetFlagCompletionsDisabled(true)
|
|
if !FlagCompletionsDisabled() {
|
|
t.Fatal("expected true after Set(true)")
|
|
}
|
|
SetFlagCompletionsDisabled(false)
|
|
if FlagCompletionsDisabled() {
|
|
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) {
|
|
SetFlagCompletionsDisabled(true)
|
|
t.Cleanup(func() { SetFlagCompletionsDisabled(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) {
|
|
SetFlagCompletionsDisabled(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)
|
|
}
|
|
}
|