feat: Add ContributoorSettingsPage with form and descriptions

cmd/cli/commands/config/config_contributoor.go

@@ -0,0 +1,221 @@
+package config
+
+import (
+	"github.com/ethpandaops/contributoor-installer/internal/sidecar"
+	"github.com/ethpandaops/contributoor-installer/internal/tui"
+	"github.com/gdamore/tcell/v2"
+	"github.com/rivo/tview"
+	"github.com/sirupsen/logrus"
+)
+
+// ContributoorSettingsPage is a page that allows the user to configure core contributoor settings.
+type ContributoorSettingsPage struct {
+	display     *ConfigDisplay
+	page        *tui.Page
+	content     tview.Primitive
+	form        *tview.Form
+	description *tview.TextView
+}
+
+// NewContributoorSettingsPage creates a new ContributoorSettingsPage.
+func NewContributoorSettingsPage(cd *ConfigDisplay) *ContributoorSettingsPage {
+	settingsPage := &ContributoorSettingsPage{
+		display: cd,
+	}
+
+	settingsPage.initPage()
+	settingsPage.page = tui.NewPage(
+		cd.homePage,
+		"config-contributoor",
+		"Contributoor Settings",
+		"Configure core contributoor settings like logging and run mode",
+		settingsPage.content,
+	)
+
+	return settingsPage
+}
+
+// GetPage returns the page.
+func (p *ContributoorSettingsPage) GetPage() *tui.Page {
+	return p.page
+}
+
+// initPage initializes the page.
+func (p *ContributoorSettingsPage) initPage() {
+	// Create a form to collect user input.
+	form := tview.NewForm()
+	p.form = form
+	form.SetBackgroundColor(tui.ColorFormBackground)
+
+	// Create a description box to display help text.
+	p.description = tview.NewTextView()
+	p.description.
+		SetDynamicColors(true).
+		SetWordWrap(true).
+		SetTextAlign(tview.AlignLeft).
+		SetBackgroundColor(tui.ColorFormBackground)
+	p.description.SetBorder(true)
+	p.description.SetTitle(tui.TitleDescription)
+	p.description.SetBorderPadding(0, 0, 1, 1)
+	p.description.SetBorderColor(tui.ColorBorder)
+
+	// Available log levels
+	logLevels := []string{
+		logrus.TraceLevel.String(),
+		logrus.DebugLevel.String(),
+		logrus.InfoLevel.String(),
+		logrus.WarnLevel.String(),
+		logrus.ErrorLevel.String(),
+	}
+
+	// Available run modes
+	runModes := []string{
+		sidecar.RunMethodDocker,
+		sidecar.RunMethodBinary,
+	}
+
+	// Find current log level index
+	currentLogLevel := p.display.sidecarCfg.Get().LogLevel
+	currentLogLevelIndex := 2 // Default to info
+
+	for i, level := range logLevels {
+		if level == currentLogLevel {
+			currentLogLevelIndex = i
+
+			break
+		}
+	}
+
+	// Find current run mode index
+	currentRunMode := p.display.sidecarCfg.Get().RunMethod
+	currentRunModeIndex := 0 // Default to docker
+
+	for i, mode := range runModes {
+		if mode == currentRunMode {
+			currentRunModeIndex = i
+
+			break
+		}
+	}
+
+	// Add our form fields.
+	form.AddDropDown("Log Level", logLevels, currentLogLevelIndex, func(option string, index int) {
+		p.description.SetText("Set the logging verbosity level. Debug and Trace provide more detailed output.")
+	})
+
+	form.AddDropDown("Run Mode", runModes, currentRunModeIndex, func(option string, index int) {
+		if option == sidecar.RunMethodDocker {
+			p.description.SetText("Run using Docker containers (recommended)")
+		} else {
+			p.description.SetText("Run directly as a binary on your system")
+		}
+	})
+
+	// Add a save button and ensure we validate the input.
+	saveButton := tview.NewButton(tui.ButtonSaveSettings)
+	saveButton.SetSelectedFunc(func() {
+		validateAndUpdateContributoor(p)
+	})
+	saveButton.SetBackgroundColorActivated(tui.ColorButtonActivated)
+	saveButton.SetLabelColorActivated(tui.ColorButtonText)
+
+	// Define key bindings for the save button.
+	saveButton.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey {
+		switch event.Key() {
+		case tcell.KeyTab, tcell.KeyBacktab:
+			p.display.app.SetFocus(form)
+
+			return nil
+		}
+
+		return event
+	})
+
+	// Define key bindings for the form.
+	form.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey {
+		formIndex, _ := form.GetFocusedItemIndex()
+
+		switch event.Key() {
+		case tcell.KeyTab:
+			if formIndex == form.GetFormItemCount()-1 {
+				p.display.app.SetFocus(saveButton)
+
+				return nil
+			}
+
+			return event
+		case tcell.KeyBacktab:
+			if formIndex == 0 {
+				p.display.app.SetFocus(saveButton)
+
+				return nil
+			}
+
+			return event
+		default:
+			return event
+		}
+	})
+
+	// We wrap the form in a frame to add a border and title.
+	formFrame := tview.NewFrame(form)
+	formFrame.SetBorder(true)
+	formFrame.SetTitle("Contributoor Settings")
+	formFrame.SetBorderPadding(0, 0, 1, 1)
+	formFrame.SetBorderColor(tui.ColorBorder)
+	formFrame.SetBackgroundColor(tui.ColorFormBackground)
+
+	// Create a button container to hold the save button.
+	buttonFlex := tview.NewFlex().
+		SetDirection(tview.FlexColumn).
+		AddItem(nil, 0, 1, false).
+		AddItem(saveButton, len(tui.ButtonSaveSettings)+4, 0, true).
+		AddItem(nil, 0, 1, false)
+
+	// Create a horizontal flex to hold the form and description.
+	formDescriptionFlex := tview.NewFlex().
+		SetDirection(tview.FlexColumn).
+		AddItem(formFrame, 0, 2, true).
+		AddItem(p.description, 0, 1, false)
+
+	// Create a main layout both the flexes.
+	mainFlex := tview.NewFlex().
+		SetDirection(tview.FlexRow).
+		AddItem(formDescriptionFlex, 0, 1, true).
+		AddItem(nil, 1, 0, false).
+		AddItem(buttonFlex, 1, 0, false).
+		AddItem(nil, 1, 0, false)
+	mainFlex.SetBackgroundColor(tui.ColorBackground)
+
+	p.content = mainFlex
+}
+
+func validateAndUpdateContributoor(p *ContributoorSettingsPage) {
+	logLevel, _ := p.form.GetFormItem(0).(*tview.DropDown)
+	runMode, _ := p.form.GetFormItem(1).(*tview.DropDown)
+
+	_, logLevelText := logLevel.GetCurrentOption()
+	_, runModeText := runMode.GetCurrentOption()
+
+	if err := p.display.sidecarCfg.Update(func(cfg *sidecar.Config) {
+		cfg.LogLevel = logLevelText
+		cfg.RunMethod = runModeText
+	}); err != nil {
+		p.openErrorModal(err)
+
+		return
+	}
+
+	p.display.setPage(p.display.homePage)
+}
+
+func (p *ContributoorSettingsPage) openErrorModal(err error) {
+	p.display.app.SetRoot(tui.CreateErrorModal(
+		p.display.app,
+		err.Error(),
+		func() {
+			p.display.app.SetRoot(p.display.frame, true)
+			p.display.app.SetFocus(p.form)
+		},
+	), true)
+}

cmd/cli/commands/config/display.go

@@ -23,6 +23,7 @@ type ConfigDisplay struct {
 	closeButton            *tview.Button
 	networkConfigPage      *NetworkConfigPage
 	outputServerConfigPage *OutputServerConfigPage
+	settingsPage           *ContributoorSettingsPage
 }
 
 // NewConfigDisplay creates a new Configtui.
@@ -39,9 +40,11 @@ func NewConfigDisplay(log *logrus.Logger, app *tview.Application, sidecarCfg sid
 	// Create all the config sub-pages.
 	display.networkConfigPage = NewNetworkConfigPage(display)
 	display.outputServerConfigPage = NewOutputServerConfigPage(display)
+	display.settingsPage = NewContributoorSettingsPage(display)
 	display.settingsPages = []tui.PageInterface{
 		display.networkConfigPage,
 		display.outputServerConfigPage,
+		display.settingsPage,
 	}
 
 	// Add all the sub-pages to the tui.

internal/sidecar/config.go

@@ -37,7 +37,7 @@ type ConfigManager interface {
 
 // Config is the configuration for the contributoor sidecar.
 type Config struct {
-	Logging               string              `yaml:"logging"`
+	LogLevel              string              `yaml:"logLevel"`
 	Version               string              `yaml:"version"`
 	ContributoorDirectory string              `yaml:"contributoorDirectory"`
 	RunMethod             string              `yaml:"runMethod"`
@@ -126,11 +126,11 @@ func NewConfigService(logger *logrus.Logger, configPath string) (ConfigManager,
 
 func newDefaultConfig() *Config {
 	return &Config{
-		Logging:           logrus.InfoLevel.String(),
+		LogLevel:          logrus.InfoLevel.String(),
 		Version:           "latest",
 		RunMethod:         RunMethodDocker,
 		NetworkName:       "mainnet",
-		BeaconNodeAddress: "http://localhost:5052",
+		BeaconNodeAddress: "",
 	}
 }