fix: don't panic in ProgressBarState.String() for out-of-range values (#1748)

Co-authored-by: drew <me@andrinoff.com>
Signed-off-by: drew <me@andrinoff.com>
This commit is contained in:
Ankit 2026-08-19 13:51:01 +05:30 committed by GitHub
parent faf4dcf54a
commit 930e18c966
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 36 additions and 8 deletions

24
tea.go
View file

@ -317,15 +317,23 @@ const (
ProgressBarWarning
)
// String return a human-readable value for the given [ProgressBarState].
// String returns a human-readable name for the given [ProgressBarState].
// Values outside the known range return "Unknown".
func (s ProgressBarState) String() string {
return [...]string{
"None",
"Default",
"Error",
"Indeterminate",
"Warning",
}[s]
switch s {
case ProgressBarNone:
return "None"
case ProgressBarDefault:
return "Default"
case ProgressBarError:
return "Error"
case ProgressBarIndeterminate:
return "Indeterminate"
case ProgressBarWarning:
return "Warning"
default:
return "Unknown"
}
}
// ProgressBar represents the terminal progress bar.

View file

@ -669,3 +669,23 @@ func BenchmarkTeaRun(b *testing.B) {
_ = r.CloseWithError(io.EOF)
}
}
// TestProgressBarStateStringOutOfRange is a regression test for
// https://github.com/charmbracelet/bubbletea/issues/1711: String panicked
// with an index-out-of-range error for any ProgressBarState outside the
// [ProgressBarNone, ProgressBarWarning] range. Since State is an exported
// field on ProgressBar, callers can assign such a value without going
// through NewProgressBar.
func TestProgressBarStateStringOutOfRange(t *testing.T) {
for _, s := range []ProgressBarState{-1, 5, 100} {
if got, want := s.String(), "Unknown"; got != want {
t.Errorf("ProgressBarState(%d).String() = %q, want %q", int(s), got, want)
}
}
for s := ProgressBarNone; s <= ProgressBarWarning; s++ {
if got := s.String(); got == "Unknown" {
t.Errorf("ProgressBarState(%d).String() = %q, want a known name", int(s), got)
}
}
}