Skip to content

feat(cli): colorize sync timeline lanes per unit #27164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
SasSwart wants to merge 1 commit into
base: sas/sync-graph
Choose a base branch
from
+29 −8
Draft

feat(cli): colorize sync timeline lanes per unit #27164

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 29 additions & 8 deletions cli/sync_timeline_render.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,16 @@ import (
"time"

"github.com/coder/coder/v2/agent/unit"
"github.com/coder/coder/v2/cli/cliui"
"github.com/coder/pretty"
)

// laneColors is the palette used to give each timeline lane (unit) its own
// color, cycled by lane index. cliui.Color yields a colorless profile in
// tests and on non-TTY output, so colored lanes do not affect golden
// files.
var laneColors = []string{"1", "2", "3", "4", "5", "6", "9", "10", "11", "12", "13", "14"}

// syncEventDescription renders a unit event as a short human-readable
// phrase, shared by the sync status history and sync timeline views.
func syncEventDescription(ev unit.Event) string {
Expand Down Expand Up @@ -152,16 +160,28 @@ func (r *timelineRenderer) isReady(u unit.ID) bool {
return true
}

// laneStyle returns the color style for the lane at the given index.
func laneStyle(lane int) pretty.Style {
return pretty.Style{pretty.FgColor(cliui.Color(laneColors[lane%len(laneColors)]))}
}

// colorizeLane colors s with the lane's color. In tests and on non-TTY
// output this returns s unchanged.
func colorizeLane(lane int, s string) string {
return pretty.Sprint(laneStyle(lane), s)
}

// glyphRow renders one graph row: mark in the target unit's lane, "|" in
// other active lanes, and spaces elsewhere.
// other active lanes, and spaces elsewhere. Each lane's glyph is drawn in
// that lane's color.
func (r *timelineRenderer) glyphRow(target unit.ID, mark string) string {
glyphs := make([]string, len(r.lanes))
for i, u := range r.lanes {
switch {
case u == target:
glyphs[i] = mark
glyphs[i] = colorizeLane(i, mark)
case r.active[u]:
glyphs[i] = "|"
glyphs[i] = colorizeLane(i, "|")
default:
glyphs[i] = " "
}
Expand All @@ -170,17 +190,17 @@ func (r *timelineRenderer) glyphRow(target unit.ID, mark string) string {
}

// connectorRow draws the dependency-satisfaction edge from lane "from"
// toward lane "to".
// toward lane "to". Each lane's glyph is drawn in that lane's color.
func (r *timelineRenderer) connectorRow(from, to unit.ID) string {
glyphs := make([]string, len(r.lanes))
for i, u := range r.lanes {
switch {
case u == from && r.laneOf[from] < r.laneOf[to]:
glyphs[i] = `\`
glyphs[i] = colorizeLane(i, `\`)
case u == from:
glyphs[i] = "/"
glyphs[i] = colorizeLane(i, "/")
case r.active[u]:
glyphs[i] = "|"
glyphs[i] = colorizeLane(i, "|")
default:
glyphs[i] = " "
}
Expand All @@ -189,5 +209,6 @@ func (r *timelineRenderer) connectorRow(from, to unit.ID) string {
}

func (r *timelineRenderer) writeRow(sb *strings.Builder, graph string, at time.Time, u unit.ID, description string) {
_, _ = sb.WriteString(fmt.Sprintf("%s [%s] %s %s\n", graph, syncElapsed(r.base, at), u, description))
name := colorizeLane(r.laneOf[u], string(u))
_, _ = sb.WriteString(fmt.Sprintf("%s [%s] %s %s\n", graph, syncElapsed(r.base, at), name, description))
}
Loading