Weird interaction between bubbletea/glamour/bubble

[pme-openai]

Describe the bug

When using the auto style, with the textinput bubble, it'll get wedged and start spewing OSC on the screen.

Setup

Please complete the following information along with version numbers, if applicable.

• macOS 15.3.2
• zsh
• iTerm2

To Reproduce

Use the source below and run

$ go run main.go
bug
> ]11;rgb:0000/0000/0000\]11;rgb:0000/0000/0000\rgb:0000/0000/0000

Source Code

package main

import (
	"fmt"
	"os"
	"strings"

	"github.com/charmbracelet/bubbles/textinput"
	tea "github.com/charmbracelet/bubbletea"
	"github.com/charmbracelet/glamour"
	"github.com/charmbracelet/lipgloss"
)

type model struct{ input textinput.Model }

func (m model) Init() tea.Cmd { return nil }

func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
	var cmd tea.Cmd

	switch t := msg.(type) {
	case tea.KeyMsg:
		switch t.Type {
		case tea.KeyEsc:
			return m, tea.Quit
		}
	}
	m.input, cmd = m.input.Update(msg)

	return m, cmd
}

func (m model) View() string {
	if _, err := glamour.Render("", "auto"); err != nil {
		panic(err)
	}

	var sb strings.Builder
	sb.WriteString(lipgloss.NewStyle().Foreground(lipgloss.Color("1")).Render("bug"))
	sb.WriteString("\n")
	sb.WriteString(m.input.View())

	return sb.String()
}

func main() {
	input := textinput.New()
	input.Focus()

	p := tea.NewProgram(model{input})
	if _, err := p.Run(); err != nil {
		fmt.Printf("error: %v", err)
		os.Exit(1)
	}
}

Expected behavior

You should not see OSC output

Screenshots

Additional context

If you switch from auto to e.g. dark, it works as expected.

[meowgorithm]

Hey! This is somewhat of a known issue (which will be solved in the forthcoming v2 versions of Bubble Tea, Lip Gloss, and Bubbles). Essentially, Lip Gloss and Glamour are fighting over stdout to perform dark background detection, causing lock-ups and leakage.

The fix, in this case, is to have Lip Gloss manually perform the background color detection for Glamour prior to starting your program, storing the result on your model, then passing the detected style to Glamour.

Here's the diff:

diff --git a/main.go b/main.go
index 5494d79..4966ca8 100644
--- a/main.go
+++ b/main.go
@@ -11,7 +11,10 @@ import (
 	"github.com/charmbracelet/lipgloss"
 )
 
-type model struct{ input textinput.Model }
+type model struct {
+	glamourStyle string
+	input        textinput.Model
+}
 
 func (m model) Init() tea.Cmd { return nil }
 
@@ -31,7 +34,7 @@ func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 }
 
 func (m model) View() string {
-	if _, err := glamour.Render("", "auto"); err != nil {
+	if _, err := glamour.Render("", m.glamourStyle); err != nil {
 		panic(err)
 	}
 
@@ -44,10 +47,15 @@ func (m model) View() string {
 }
 
 func main() {
+	s := "light"
+	if lipgloss.HasDarkBackground() {
+		s = "dark"
+	}
+
 	input := textinput.New()
 	input.Focus()
 
-	p := tea.NewProgram(model{input})
+	p := tea.NewProgram(model{glamourStyle: s, input: input})
 	if _, err := p.Run(); err != nil {
 		fmt.Printf("error: %v", err)
 		os.Exit(1)

Let us know if you have any questions, and thanks for the nice report and concise, reproducible code.

[pme-openai]

Thanks for the workaround, and thanks for great tools 🌟

I searched the intertubes for quite some time, but couldn't find any documented instance of this issue, so at least the next person won't have to trample into the same minefield...

[Jorres]

Just spent a couple hours figuring something very similar to this issue. In my case, I have narrowed down the difference between my app getting a bunch of strange keycodes via tea.KeyMsg (such as 11;rgb:1818/1818/1818) and everything working fine to the following line:

glamour.NewTermRenderer(
	// glamour.WithAutoStyle(), // this line causes random keycodes to arrive to my app in `Update` and app becomes unresponsive
        glamour.WithStandardStyle("dark"), // when I use this line, no strange keycodes arrive to my app via 
	glamour.WithWordWrap(wordWrap),
)

I did NOT yet manage to reproduce it on a short example, that's why I'm not attaching any more code yet. When I pull the relevant code and isolate only one model to be rendered at a time which uses this code, the issue seems to disappear... I'm currently out of ideas.

glamour.WithAutoStyle() works just fine for me on default glamour example in bubbletea repo.

I do use lipgloss and bubbletea in the same application, and upgrading to bubbletea v2, lipgloss v2 (glamour still v0.10.0) did NOT make this issue go away.

One other peculiar detail is that my program, breaking on Gnome terminal, kitty and alacritty, works fine with tmux (probably because termenv, glamour dependency, does not even try to get a background color of tmux terminal)

It does feel like a race because it triggers not in 100% of cases: I would estimate about 50%.

Would you happen to have any quick clues as to what might be happening or what direction should I debug into? I might just leave "dark" or hardcode terminal detection elsewhere, but not knowing what happens feels wrong to me :(