opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix(cli): prevent false deprecation warnings for renamed options (#23931)

Browse Source 
Co-authored-by: dylanhuff-at-coder <dylan@coder.com>
This commit is contained in:
Stephen Kirby
2026-04-15 12:33:31 -05:00
committed by GitHub
co-authored by dylanhuff-at-coder
parent 91446ac7ca
commit e3f2398343
2 changed files with 185 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cli/root.go
+43 -4
View File
@@ -1624,8 +1624,8 @@ func headerTransport(ctx context.Context, serverURL *url.URL, header []string, h
return transport, nil
}
// printDeprecatedOptions loops through all command options, and prints
// a warning for usage of deprecated options.
// PrintDeprecatedOptions loops through all command options, and
// prints a warning for usage of deprecated options.
func PrintDeprecatedOptions() serpent.MiddlewareFunc {
return func(next serpent.HandlerFunc) serpent.HandlerFunc {
return func(inv *serpent.Invocation) error {
@@ -1640,11 +1640,22 @@ func PrintDeprecatedOptions() serpent.MiddlewareFunc {
continue
}
// Verify that this deprecated option was itself
// the source of the value. Serpent propagates
// ValueSource across all options that share the
// same Value pointer, so a new option being set
// can make a deprecated sibling appear set when
// it was not.
source := deprecatedOptionDirectSource(inv, opt)
if source == serpent.ValueSourceNone {
continue
}
var warnStr strings.Builder
_, _ = warnStr.WriteString(translateSource(opt.ValueSource, opt))
_, _ = warnStr.WriteString(translateSource(source, opt))
_, _ = warnStr.WriteString(" is deprecated, please use ")
for i, use := range opt.UseInstead {
_, _ = warnStr.WriteString(translateSource(opt.ValueSource, use))
_, _ = warnStr.WriteString(translateSource(source, use))
if i != len(opt.UseInstead)-1 {
_, _ = warnStr.WriteString(" and ")
}
@@ -1661,6 +1672,34 @@ func PrintDeprecatedOptions() serpent.MiddlewareFunc {
}
}
// deprecatedOptionDirectSource returns the source by which a deprecated
// option was directly set, ignoring any propagated ValueSource from
// sibling options that share the same Value pointer.
func deprecatedOptionDirectSource(inv *serpent.Invocation, opt serpent.Option) serpent.ValueSource {
if opt.Flag != "" {
fl := inv.ParsedFlags().Lookup(opt.Flag)
if fl != nil && fl.Changed {
return serpent.ValueSourceFlag
}
}
if opt.Env != "" {
_, exists := inv.Environ.Lookup(opt.Env)
if exists {
return serpent.ValueSourceEnv
}
}
if opt.ValueSource == serpent.ValueSourceYAML {
// There is no straightforward way to check whether a
// specific YAML key was present in the config file, so
// we conservatively assume the deprecated key was used.
return serpent.ValueSourceYAML
}
return serpent.ValueSourceNone
}
// translateSource provides the name of the source of the option, depending on the
// supplied target ValueSource.
func translateSource(target serpent.ValueSource, opt serpent.Option) string {