Skip to content

Commit

Permalink
appdev: handle user cancellation, log pager styling updates (digitalo…
Browse files Browse the repository at this point in the history 
…cean#1229)

* correctly handle user cancellation

* log pager: update header/footer styling, scroll indicator

* log pager: add title spinner
  • Loading branch information
@kamaln7 @nicktate
kamaln7 authored and nicktate committed Sep 20, 2022
1 parent 7d8c14d commit d7b01cb
Show file tree
Hide file tree
Showing 3 changed files with 106 additions and 56 deletions.
27 changes: 16 additions & 11 deletions commands/apps_dev.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (

"github.com/MakeNowJust/heredoc"
"github.com/digitalocean/doctl"
"github.com/digitalocean/doctl/commands/charm"
"github.com/digitalocean/doctl/commands/charm/confirm"
"github.com/digitalocean/doctl/commands/charm/list"
"github.com/digitalocean/doctl/commands/charm/pager"
Expand Down Expand Up @@ -156,7 +157,7 @@ func RunAppsDevBuild(c *CmdConfig) error {
if err != nil {
return err
} else if selected == nil {
return fmt.Errorf("cancelled")
return fmt.Errorf("canceled")
}
selectedComponent, ok := selected.(componentListItem)
if !ok {
Expand Down Expand Up @@ -255,24 +256,34 @@ func RunAppsDevBuild(c *CmdConfig) error {
)
template.Print(`{{success checkmark}} {{.}}{{nl 2}}`, buildingComponentLine)

// TODO intercept ctrl-c and allow for graceful shutdown & container cleanup

var (
wg sync.WaitGroup
logWriter io.Writer

// userCanceled indicates whether the context was canceled by user request
userCanceled bool
)
if Interactive {
logPager, err := pager.New(
pager.WithTitle(buildingComponentLine),
pager.WithTitleSpinner(true),
)
if err != nil {
return fmt.Errorf("starting log pager: %w", err)
return fmt.Errorf("creating log pager: %w", err)
}
wg.Add(1)
go func() {
defer cancel()
defer wg.Done()
err := logPager.Start(ctx)
if err != nil {
fmt.Fprintf(os.Stderr, "pager error: %v\n", err)
if errors.Is(err, charm.ErrCanceled) {
userCanceled = true
} else {
fmt.Fprintf(os.Stderr, "pager error: %v\n", err)
}
}
}()
logWriter = logPager
Expand Down Expand Up @@ -315,16 +326,10 @@ func RunAppsDevBuild(c *CmdConfig) error {
// allow the pager to exit cleanly
wg.Wait()

// TODO: differentiate between user-initiated cancel and cancel due to build failure
// if err == nil {
// err = ctx.Err()
// if errors.Is(err, context.Canceled) {
// err = fmt.Errorf("cancelled")
// }
// }

if err != nil {
return err
} else if userCanceled {
return fmt.Errorf("canceled")
} else if res.ExitCode == 0 {
template.Buffered(
textbox.New().Success(),
Expand Down
4 changes: 2 additions & 2 deletions commands/charm/charm.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ import (
)

var (
// ErrCancelled represents a user-initiated cancellation.
ErrCancelled = fmt.Errorf("cancelled")
// ErrCanceled represents a user-initiated cancellation.
ErrCanceled = fmt.Errorf("canceled")
)

// Style is a styled component.
Expand Down
131 changes: 88 additions & 43 deletions commands/charm/pager/pager.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,18 @@ import (
"context"
"fmt"
"io"
"os"
"strings"
"time"

"github.com/armon/circbuf"
"github.com/charmbracelet/bubbles/spinner"
"github.com/charmbracelet/bubbles/viewport"
tea "github.com/charmbracelet/bubbletea"
"github.com/charmbracelet/lipgloss"
"github.com/digitalocean/doctl/commands/charm"
"github.com/digitalocean/doctl/commands/charm/template"
"github.com/digitalocean/doctl/commands/charm/text"
)

type WriterStringer interface {
Expand All @@ -21,11 +24,13 @@ type WriterStringer interface {
}

type Pager struct {
title string
bufSize int64
buffer WriterStringer
prog *tea.Program
model *pagerModel
title string
titleSpinner bool
bufSize int64
buffer WriterStringer
prog *tea.Program
model *pagerModel
exited bool
}

type Option func(*Pager)
Expand Down Expand Up @@ -58,7 +63,16 @@ func WithTitle(title string) Option {
}
}

func WithTitleSpinner(spinner bool) Option {
return func(p *Pager) {
p.titleSpinner = spinner
}
}

func (p *Pager) Write(b []byte) (int, error) {
if p.exited {
return os.Stdout.Write(b)
}
n, err := p.buffer.Write(b)
if p.prog != nil {
p.prog.Send(msgUpdate{})
Expand All @@ -67,7 +81,7 @@ func (p *Pager) Write(b []byte) (int, error) {
}

func (p *Pager) Start(ctx context.Context) error {
p.model = newPagerModel(ctx, p.buffer, p.title)
p.model = newPagerModel(ctx, p.buffer, p.title, p.titleSpinner)
prog := tea.NewProgram(
p.model,
tea.WithAltScreen(), // use the full size of the terminal in its "alternate screen buffer"
Expand All @@ -76,29 +90,48 @@ func (p *Pager) Start(ctx context.Context) error {
p.prog = prog

err := prog.Start()
content := p.buffer.String()
fmt.Fprintln(charm.Indent(4), content)
return err
p.exited = true
p.prog = nil

fmt.Fprint(charm.Indent(4), p.buffer.String())
if err != nil {
return err
} else if p.model.userCanceled {
return charm.ErrCanceled
}

return nil
}

type pagerModel struct {
ctx context.Context
cancel context.CancelFunc

start time.Time
title string
buffer WriterStringer
ready bool
viewport viewport.Model
start time.Time
title string
buffer WriterStringer
ready bool
viewport viewport.Model
userCanceled bool
spinner *spinner.Model
}

func newPagerModel(ctx context.Context, buffer WriterStringer, title string) *pagerModel {
func newPagerModel(ctx context.Context, buffer WriterStringer, title string, titleSpinner bool) *pagerModel {
m := &pagerModel{
buffer: buffer,
title: title,
start: time.Now(),
}
m.ctx, m.cancel = context.WithCancel(ctx)

if titleSpinner {
s := spinner.New(
spinner.WithStyle(text.Muted.Lipgloss()),
spinner.WithSpinner(spinner.Dot),
)
m.spinner = &s
}

return m
}

Expand All @@ -107,13 +140,19 @@ type msgUpdate struct{}
type msgTick struct{}

func (m *pagerModel) Init() tea.Cmd {
return tea.Batch(
cmds := []tea.Cmd{
m.timerTick(),
func() tea.Msg {
<-m.ctx.Done()
return msgQuit{}
},
)
}

if m.spinner != nil {
cmds = append(cmds, m.spinner.Tick)
}

return tea.Batch(cmds...)
}

func (m *pagerModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
Expand All @@ -130,9 +169,10 @@ func (m *pagerModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
if k := msg.String(); k == "ctrl+c" {
template.Buffered(
m.buffer,
`{{nl}}{{error (print crossmark " got ctrl-c, cancelling build")}}{{nl}}`,
`{{nl}}{{error (print crossmark " got ctrl-c, cancelling")}}{{nl}}`,
nil,
)
m.userCanceled = true
m.cancel()
return m, nil
}
Expand Down Expand Up @@ -163,6 +203,10 @@ func (m *pagerModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
if m.ctx.Err() == nil {
cmds = append(cmds, m.timerTick())
}
case spinner.TickMsg:
sp, cmd := m.spinner.Update(msg)
m.spinner = &sp
cmds = append(cmds, cmd)
}

// Handle keyboard and mouse events in the viewport
Expand All @@ -174,39 +218,40 @@ func (m *pagerModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {

func (m *pagerModel) View() string {
if !m.ready {
return "\n Loading..."
return "\n loading..."
}
return fmt.Sprintf("%s\n%s\n%s", m.headerView(), m.viewport.View(), m.footerView())
return fmt.Sprintf("%s\n%s%s", m.headerView(), m.viewport.View(), m.footerView())
}

func (m *pagerModel) headerView() string {
title := m.titleStyle().Render(m.title)
line := strings.Repeat("─", max(0, m.viewport.Width-lipgloss.Width(title)))
line = lipgloss.NewStyle().Foreground(lipgloss.Color("#9B9B9B")).Render(line)
return lipgloss.JoinHorizontal(lipgloss.Center, title, line)
}
// title line
title := m.title
if m.spinner != nil {
title = m.spinner.View() + title
}
title = lipgloss.NewStyle().Padding(1).PaddingBottom(0).Render(title)

func (m *pagerModel) footerView() string {
info := m.infoStyle().Render(time.Since(m.start).Truncate(time.Second).String())
line := strings.Repeat("─", max(0, m.viewport.Width-lipgloss.Width(info)))
line = lipgloss.NewStyle().Foreground(lipgloss.Color("#9B9B9B")).Render(line)
return lipgloss.JoinHorizontal(lipgloss.Center, line, info)
}
// elapsed time + horizontal divider line
elapsed := fmt.Sprintf(
"%s%s%s",
text.Muted.S("["),
time.Since(m.start).Truncate(time.Second),
text.Muted.S("]─"),
)
line := strings.Repeat("─", max(0, m.viewport.Width-lipgloss.Width(elapsed)))
line = text.Muted.S(line)

func (m *pagerModel) titleStyle() lipgloss.Style {
b := lipgloss.RoundedBorder()
b.Right = "├"
return lipgloss.NewStyle().
Foreground(lipgloss.Color("#dddddd")).
BorderStyle(b).
BorderForeground(lipgloss.Color("#9B9B9B")).
Padding(0, 1)
return fmt.Sprintf("%s\n%s%s\n", title, line, elapsed)
}

func (m *pagerModel) infoStyle() lipgloss.Style {
b := lipgloss.RoundedBorder()
b.Left = "┤"
return m.titleStyle().Copy().BorderStyle(b).Foreground(lipgloss.Color("#dddddd"))
func (m *pagerModel) footerView() string {
if m.viewport.AtBottom() {
return ""
}

info := "┤ scroll down for new logs "
line := strings.Repeat("─", max(0, m.viewport.Width-lipgloss.Width(info)))
return "\n" + text.Highlight.S(line+info)
}

func max(a, b int) int {
Expand Down

0 comments on commit d7b01cb

Please sign in to comment.