Skip to content

Commit

Permalink
feat(tui): improve logging and error handling in setup
Browse files Browse the repository at this point in the history 
- Set up stderr logger by default, allowing subcommands to override.
- Change TuiCommand to TUICommand for consistency.
- Enhance error messages in flag parsing and TUI setup.
- Refactor NewController to return error instead of using fatal logs.
- Implement detailed logging and error handling in TUI Execute method.
- Add unpublished log entries catch-up mechanism if TUI setup fails.
- Update comments and method documentation for clarity.

This fixes some weirdness around stderr messages popping into the
TUI (fixes in the sense that we follow a different strategy for
getting the messages to the user now).
  • Loading branch information
@ja-he
ja-he committed Jul 2, 2024
1 parent ea62bf9 commit ee07e28
Show file tree
Hide file tree
Showing 4 changed files with 118 additions and 64 deletions.
8 changes: 7 additions & 1 deletion cmd/dayplan.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,18 @@ import (
"os"

"github.com/jessevdk/go-flags"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"

"github.com/ja-he/dayplan/internal/control/cli"
)

// MAIN
func main() {
// set up stderr logger by default, subcommands (such as tui) may choose to
// change this
log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr})

// parse the flags
parser := flags.NewParser(&cli.Opts, flags.Default)
parser.SubcommandsOptional = false
Expand All @@ -19,7 +25,7 @@ func main() {
if flags.WroteHelp(err) {
os.Exit(0)
} else if err != nil {
fmt.Fprintf(os.Stderr, "flag parsing error:\n > %s\n", err.Error())
fmt.Fprintf(os.Stderr, "fatal error (e.g. flag parsing):\n > %s\n", err.Error())
os.Exit(1)
}

Expand Down
2 changes: 1 addition & 1 deletion internal/control/cli/cli.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package cli
type CommandLineOpts struct {
Version bool `short:"v" long:"version" description:"Show the program version"`

TuiCommand TuiCommand `command:"tui" subcommands-optional:"true"`
TuiCommand TUICommand `command:"tui" subcommands-optional:"true"`
SummarizeCommand SummarizeCommand `command:"summarize" subcommands-optional:"true"`
TimesheetCommand TimesheetCommand `command:"timesheet" subcommands-optional:"true"`
AddCommand AddCommand `command:"add" subcommands-optional:"true"`
Expand Down
92 changes: 46 additions & 46 deletions internal/control/cli/controller.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import (
"sync"
"time"

"github.com/rs/zerolog"
"github.com/rs/zerolog/log"

"github.com/ja-he/dayplan/internal/control"
Expand All @@ -31,7 +30,7 @@ import (
)

// TODO: this absolutely does not belong here
func (t *Controller) GetDayFromFileHandler(date model.Date) *model.Day {
func (t *Controller) getDayFromFileHandler(date model.Date) *model.Day {
t.fhMutex.RLock()
fh, ok := t.FileHandlers[date]
t.fhMutex.RUnlock()
Expand All @@ -48,7 +47,7 @@ func (t *Controller) GetDayFromFileHandler(date model.Date) *model.Day {
}
}

// Controller
// Controller is the struct for the TUI controller.
type Controller struct {
data *control.ControlData
rootPane *panes.RootPane
Expand All @@ -73,15 +72,13 @@ type Controller struct {
syncer tui.ScreenSynchronizer
}

// NewController
// NewController creates a new Controller.
func NewController(
date model.Date,
envData control.EnvData,
categoryStyling styling.CategoryStyling,
stylesheet styling.Stylesheet,
stderrLogger zerolog.Logger,
tuiLogger zerolog.Logger,
) *Controller {
) (*Controller, error) {
controller := Controller{}

inputConfig := input.InputConfig{
Expand Down Expand Up @@ -132,31 +129,33 @@ func NewController(
},
}

categoryGetter := func(name string) model.Category {
cat, ok := categoryStyling.GetKnownCategoriesByName()[name]
if ok {
return *cat
}
return model.Category{
Name: name,
}
}
// categoryGetter := func(name string) model.Category {
// cat, ok := categoryStyling.GetKnownCategoriesByName()[name]
// if ok {
// return *cat
// }
// return model.Category{
// Name: name,
// }
// }

controller.data = control.NewControlData(categoryStyling)
backlogFilePath := path.Join(envData.BaseDirPath, "days", "backlog.yml") // TODO(ja_he): Migrate 'days' -> 'data', perhaps subdir 'days'
backlog, err := func() (*model.Backlog, error) {
backlogReader, err := os.Open(backlogFilePath)
if err != nil {
return &model.Backlog{}, err
}
defer backlogReader.Close()
return model.BacklogFromReader(backlogReader, categoryGetter)
}()
if err != nil {
tuiLogger.Error().Err(err).Str("file", backlogFilePath).Msg("could not read backlog")
} else {
tuiLogger.Info().Str("file", backlogFilePath).Msg("successfully read backlog")
}
// backlog, err := func() (*model.Backlog, error) {
// backlogReader, err := os.Open(backlogFilePath)
// if err != nil {
// return &model.Backlog{}, err
// }
// defer backlogReader.Close()
// return model.BacklogFromReader(backlogReader, categoryGetter)
// }()
// if err != nil {
// tuiLogger.Error().Err(err).Str("file", backlogFilePath).Msg("could not read backlog")
// } else {
// tuiLogger.Info().Str("file", backlogFilePath).Msg("successfully read backlog")
// }
backlog := &model.Backlog{}
log.Info().Msg("just testing because this should be just dandy")

tasksWidth := 40
toolsWidth := func() int {
Expand Down Expand Up @@ -270,7 +269,7 @@ func NewController(
}
weekdayPaneInputTree, err := input.ConstructInputTree(eventsViewBaseInputMap)
if err != nil {
stderrLogger.Fatal().Err(err).Msg("could not construct weekday pane input tree")
return nil, fmt.Errorf("could not construct weekday pane input tree (%w)", err)
}
weekdayPane := func(dayIndex int) *panes.EventsPane {
return panes.NewEventsPane(
Expand Down Expand Up @@ -303,7 +302,7 @@ func NewController(
}
monthdayPaneInputTree, err := input.ConstructInputTree(eventsViewBaseInputMap)
if err != nil {
stderrLogger.Fatal().Err(err).Msg("could not construct monthday pane input tree")
return nil, fmt.Errorf("could not construct monthday pane input tree (%w)", err)
}
monthdayPane := func(dayIndex int) ui.Pane {
return panes.NewMaybePane(
Expand Down Expand Up @@ -671,7 +670,7 @@ func NewController(
},
)
if err != nil {
stderrLogger.Fatal().Err(err).Msg("failed to construct input tree for tasks pane")
return nil, fmt.Errorf("failed to construct input tree for tasks pane (%w)", err)
}
toolsInputTree, err := input.ConstructInputTree(
map[input.Keyspec]action.Action{
Expand Down Expand Up @@ -702,7 +701,7 @@ func NewController(
},
)
if err != nil {
stderrLogger.Fatal().Err(err).Msg("failed to construct input tree for tools pane")
return nil, fmt.Errorf("failed to construct input tree for tools pane (%w)", err)
}

// TODO(ja-he): move elsewhere
Expand Down Expand Up @@ -871,7 +870,7 @@ func NewController(
}
dayViewEventsPaneInputTree, err := input.ConstructInputTree(eventsPaneDayInputMap)
if err != nil {
stderrLogger.Fatal().Err(err).Msg("failed to construct input tree for day view pane's events subpane")
return nil, fmt.Errorf("failed to construct input tree for day view pane's events subpane (%w)", err)
}

tasksVisible := false
Expand Down Expand Up @@ -1132,7 +1131,8 @@ func NewController(
},
)
if err != nil {
stderrLogger.Fatal().Err(err).Msg("failed to construct input tree for event pane's resize mode")
log.Error().Err(err).Msg("failed to construct input tree for event pane's resize mode (this should really never happen)")
return
}
dayEventsPane.ApplyModalOverlay(input.CapturingOverlayWrap(eventResizeOverlay))
controller.data.EventEditMode = edit.EventEditModeResize
Expand All @@ -1152,7 +1152,7 @@ func NewController(
},
)
if err != nil {
stderrLogger.Fatal().Err(err).Msg("failed to construct input tree for root pane")
return nil, fmt.Errorf("failed to construct input tree for root pane (%w)", err)
}
var ensureDayViewMainPaneFocusIsOnVisible func()
updateMainPaneRightFlexWidth := func() {
Expand Down Expand Up @@ -1190,12 +1190,12 @@ func NewController(
},
)
if err != nil {
stderrLogger.Fatal().Err(err).Msg("failed to construct input tree for day view pane")
return nil, fmt.Errorf("failed to construct input tree for day view pane (%w)", err)
}

dayViewScrollablePaneInputTree, err := input.ConstructInputTree(scrollableZoomableInputMap)
if err != nil {
stderrLogger.Fatal().Err(err).Msg("failed to construct input tree for day view scrollable pane")
return nil, fmt.Errorf("failed to construct input tree for day view scrollable pane (%w)", err)
}
dayViewScrollablePane := panes.NewWrapperPane(
[]ui.Pane{
Expand Down Expand Up @@ -1233,7 +1233,7 @@ func NewController(
multidayViewEventsWrapperInputMap["l"] = action.NewSimple(func() string { return "go to next day" }, controller.goToNextDay)
weekViewEventsWrapperInputTree, err := input.ConstructInputTree(multidayViewEventsWrapperInputMap)
if err != nil {
stderrLogger.Fatal().Err(err).Msg("failed to construct input tree for multi-day wrapper pane")
return nil, fmt.Errorf("failed to construct input tree for multi-day wrapper pane (%w)", err)
}
weekViewEventsWrapper := panes.NewWrapperPane(
weekViewEventsPanes,
Expand All @@ -1242,7 +1242,7 @@ func NewController(
)
monthViewEventsWrapperInputTree, err := input.ConstructInputTree(multidayViewEventsWrapperInputMap)
if err != nil {
stderrLogger.Fatal().Err(err).Msg("failed to construct input tree for month view wrapper pane")
return nil, fmt.Errorf("failed to construct input tree for month view wrapper pane (%w)", err)
}
monthViewEventsWrapper := panes.NewWrapperPane(
monthViewEventsPanes,
Expand All @@ -1267,7 +1267,7 @@ func NewController(
ensureDayViewMainPaneFocusIsOnVisible = dayViewMainPane.EnsureFocusIsOnVisible
weekViewMainPaneInputTree, err := input.ConstructInputTree(map[input.Keyspec]action.Action{})
if err != nil {
stderrLogger.Fatal().Err(err).Msg("failed to construct input tree for week view main pane")
return nil, fmt.Errorf("failed to construct input tree for week view main pane (%w)", err)
}
weekViewMainPane := panes.NewWrapperPane(
[]ui.Pane{
Expand All @@ -1289,7 +1289,7 @@ func NewController(
)
monthViewMainPaneInputTree, err := input.ConstructInputTree(scrollableZoomableInputMap)
if err != nil {
stderrLogger.Fatal().Err(err).Msg("failed to construct input tree for month view main pane")
return nil, fmt.Errorf("failed to construct input tree for month view main pane (%w)", err)
}
monthViewMainPane := panes.NewWrapperPane(
[]ui.Pane{
Expand Down Expand Up @@ -1340,7 +1340,7 @@ func NewController(
}),
})
if err != nil {
stderrLogger.Fatal().Err(err).Msg("failed to construct input tree for summary pane")
return nil, fmt.Errorf("failed to construct input tree for summary pane (%w)", err)
}

helpPaneInputTree, err := input.ConstructInputTree(
Expand All @@ -1351,7 +1351,7 @@ func NewController(
},
)
if err != nil {
stderrLogger.Fatal().Err(err).Msg("failed to construct input tree for help pane")
return nil, fmt.Errorf("failed to construct input tree for help pane (%w)", err)
}
helpPane := panes.NewHelpPane(
ui.NewConstrainedRenderer(renderer, helpDimensions),
Expand Down Expand Up @@ -1521,7 +1521,7 @@ func NewController(

controller.data.MouseEditState = edit.MouseEditStateNone

return &controller
return &controller, nil
}

func (t *Controller) ScrollUp(by int) {
Expand Down Expand Up @@ -1628,7 +1628,7 @@ func (t *Controller) goToNextDay() {
func (t *Controller) loadDay(date model.Date) {
if !t.data.Days.HasDay(date) {
// load file
newDay := t.GetDayFromFileHandler(date)
newDay := t.getDayFromFileHandler(date)
if newDay == nil {
panic("newDay nil?!")
}
Expand Down
Loading

0 comments on commit ee07e28

Please sign in to comment.