dashboard.go

package termui

import (
	"fmt"

	"github.com/gdamore/tcell/v2"
	"github.com/rivo/tview"

	"github.com/buildpacks/pack/pkg/dist"
)

type Dashboard struct {
	app           app
	buildpackInfo []dist.ModuleInfo
	appTree       *tview.TreeView
	builderTree   *tview.TreeView
	planList      *tview.List
	logsView      *tview.TextView
	screen        *tview.Flex
	leftPane      *tview.Flex
	nodes         map[string]*tview.TreeNode

	logs string
}

func NewDashboard(app app, appName string, bldr buildr, runImageName string, buildpackInfo []dist.ModuleInfo, logs []string) *Dashboard {
	d := &Dashboard{}

	appTree, builderTree := initTrees(appName, bldr, runImageName)

	planList, logsView := d.initDashboard(buildpackInfo)

	imagesView := tview.NewFlex().
		SetDirection(tview.FlexRow).
		AddItem(appTree, 0, 1, false).
		AddItem(builderTree, 0, 1, true)

	imagesView.
		SetBorder(true).
		SetTitleAlign(tview.AlignLeft).
		SetTitle("| [::b]images[::-] |").
		SetBackgroundColor(backgroundColor)

	leftPane := tview.NewFlex().
		SetDirection(tview.FlexRow).
		AddItem(imagesView, 11, 0, false).
		AddItem(planList, 0, 1, true)

	screen := tview.NewFlex().
		SetDirection(tview.FlexColumn).
		AddItem(leftPane, 0, 1, true).
		AddItem(logsView, 0, 1, false)

	d.app = app
	d.buildpackInfo = buildpackInfo
	d.appTree = appTree
	d.builderTree = builderTree
	d.planList = planList
	d.leftPane = leftPane
	d.logsView = logsView
	d.screen = screen

	for _, txt := range logs {
		d.logs = d.logs + txt + "\n"
	}

	d.handleToggle()
	d.setScreen()
	return d
}

func (d *Dashboard) Handle(txt string) {
	d.app.QueueUpdateDraw(func() {
		d.logs = d.logs + txt + "\n"
		d.logsView.SetText(tview.TranslateANSI(d.logs))
	})
}

func (d *Dashboard) Stop() {
	// no-op
	// This method is a side effect of the ill-fitting 'page interface'
	// Trying to create a cleaner interface between the main termui controller
	// and child pages like this one is currently a work-in-progress
}

func (d *Dashboard) SetNodes(nodes map[string]*tview.TreeNode) {
	d.nodes = nodes

	// activate plan list buttons
	d.planList.SetMainTextColor(tcell.ColorMediumTurquoise).
		SetSelectedTextColor(tcell.ColorMediumTurquoise)

	idx := d.planList.GetCurrentItem()
	d.planList.Clear()
	for _, buildpackInfo := range d.buildpackInfo {
		bp := buildpackInfo

		d.planList.AddItem(
			bp.FullName(),
			info(bp),
			'✔',
			func() {
				NewDive(d.app, d.buildpackInfo, bp, d.nodes, func() {
					d.setScreen()
				})
			},
		)
	}
	d.planList.SetCurrentItem(idx)
	d.app.Draw()
}

func (d *Dashboard) handleToggle() {
	d.planList.SetDoneFunc(func() {
		screen := tview.NewFlex().
			SetDirection(tview.FlexColumn).
			AddItem(d.leftPane, 0, 1, false).
			AddItem(d.logsView, 0, 1, true)
		d.app.SetRoot(screen, true)
	})

	d.logsView.SetDoneFunc(func(key tcell.Key) {
		screen := tview.NewFlex().
			SetDirection(tview.FlexColumn).
			AddItem(d.leftPane, 0, 1, true).
			AddItem(d.logsView, 0, 1, false)
		d.app.SetRoot(screen, true)
	})
}

func (d *Dashboard) setScreen() {
	d.app.SetRoot(d.screen, true)
}

func (d *Dashboard) initDashboard(buildpackInfos []dist.ModuleInfo) (*tview.List, *tview.TextView) {
	planList := tview.NewList()
	planList.SetMainTextColor(tcell.ColorDarkGrey).
		SetSelectedTextColor(tcell.ColorDarkGrey).
		SetSelectedBackgroundColor(tcell.ColorDarkSlateGray).
		SetSecondaryTextColor(tcell.ColorDimGray).
		SetBorder(true).
		SetBorderPadding(1, 1, 1, 1).
		SetTitle("| [::b]plan[::-] |").
		SetTitleAlign(tview.AlignLeft).
		SetBackgroundColor(backgroundColor)

	for _, buildpackInfo := range buildpackInfos {
		bp := buildpackInfo

		planList.AddItem(
			bp.FullName(),
			info(bp),
			' ',
			func() {},
		)
	}

	logsView := tview.NewTextView()
	logsView.SetDynamicColors(true).
		SetTextAlign(tview.AlignLeft).
		SetBorderPadding(1, 1, 3, 1).
		SetTitleAlign(tview.AlignLeft).
		SetBackgroundColor(backgroundColor)

	return planList, logsView
}

func initTrees(appName string, bldr buildr, runImageName string) (*tview.TreeView, *tview.TreeView) {
	var (
		appImage     = tview.NewTreeNode(fmt.Sprintf("app: [white::b]%s", appName)).SetColor(tcell.ColorDimGray)
		appRunImage  = tview.NewTreeNode(fmt.Sprintf(" run: [white::b]%s", runImageName)).SetColor(tcell.ColorDimGray)
		builderImage = tview.NewTreeNode(fmt.Sprintf("builder: [white::b]%s", bldr.BaseImageName())).SetColor(tcell.ColorDimGray)
		lifecycle    = tview.NewTreeNode(fmt.Sprintf(" lifecycle: [white::b]%s", bldr.LifecycleDescriptor().Info.Version.String())).SetColor(tcell.ColorDimGray)
		runImage     = tview.NewTreeNode(fmt.Sprintf(" run: [white::b]%s", bldr.Stack().RunImage.Image)).SetColor(tcell.ColorDimGray)
		buildpacks   = tview.NewTreeNode(" [mediumturquoise::b]buildpacks")
	)

	appImage.AddChild(appRunImage)
	builderImage.AddChild(lifecycle)
	builderImage.AddChild(runImage)
	builderImage.AddChild(buildpacks)

	appTree := tview.NewTreeView()
	appTree.
		SetRoot(appImage).
		SetGraphics(true).
		SetGraphicsColor(tcell.ColorMediumTurquoise).
		SetBorderPadding(1, 0, 4, 0).
		SetBackgroundColor(backgroundColor)

	builderTree := tview.NewTreeView()
	builderTree.
		SetRoot(builderImage).
		SetGraphics(true).
		SetGraphicsColor(tcell.ColorMediumTurquoise).
		SetBorderPadding(0, 0, 4, 0).
		SetBackgroundColor(backgroundColor)

	return appTree, builderTree
}

func info(buildpackInfo dist.ModuleInfo) string {
	if buildpackInfo.Description != "" {
		return buildpackInfo.Description
	}

	if buildpackInfo.Homepage != "" {
		return buildpackInfo.Homepage
	}

	return "-"
}