extern/hishtory
1
0
Fork 0
mirror of https://github.com/ddworken/hishtory.git synced 2024-11-26 18:23:27 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add better handling for invalid searches in the TUI + better error messages in a couple other places to improve #40

Browse Source
This commit is contained in:
David Dworken 2022-11-27 08:54:34 -08:00
parent 3985010a17
commit 5249ee6709
No known key found for this signature in database
5 changed files with 88 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
client/client_test.go
View File

@ -1840,6 +1840,22 @@ func TestTui(t *testing.T) {
t.Fatalf("hishtory export mismatch (-expected +got):\n%s", diff) t.Fatalf("hishtory export mismatch (-expected +got):\n%s", diff)
} }
// Check the output when the initial search is invalid
out = captureTerminalOutput(t, tester, []string{
"hishtory SPACE tquery SPACE foo: ENTER",
"ls",
})
out = strings.TrimSpace(strings.Split(out, "hishtory tquery")[1])
compareGoldens(t, out, "TestTui-InitialInvalidSearch")
// Check the output when the initial search is invalid
out = captureTerminalOutput(t, tester, []string{
"hishtory SPACE tquery ENTER",
"ls:",
})
out = strings.TrimSpace(strings.Split(out, "hishtory tquery")[1])
compareGoldens(t, out, "TestTui-InvalidSearch")
// Check the output when the size is adjusted // Check the output when the size is adjusted
out = captureTerminalOutputWithShellNameAndDimensions(t, tester, tester.ShellName(), 100, 20, []string{ out = captureTerminalOutputWithShellNameAndDimensions(t, tester, tester.ShellName(), 100, 20, []string{
"hishtory SPACE tquery ENTER", "hishtory SPACE tquery ENTER",

30
client/lib/goldens/TestTui-InitialInvalidSearch Normal file
View File

@ -0,0 +1,30 @@
foo:
Search Query: > ls
┌────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Hostname CWD Timestamp Runtime Exit Code Command │
│────────────────────────────────────────────────────────────────────────────────────────────────────────│
│ localhost /tmp/ Oct 17 2022 21:43:16 PDT 3s 2 ls ~/ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└────────────────────────────────────────────────────────────────────────────────────────────────────────┘

29
client/lib/goldens/TestTui-InvalidSearch Normal file
View File

@ -0,0 +1,29 @@
Warning: failed to search: search query contains unknown search atom 'ls' that doesn't match any column names
Search Query: > ls:
┌────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Hostname CWD Timestamp Runtime Exit Code Command │
│────────────────────────────────────────────────────────────────────────────────────────────────────────│
│ localhost /tmp/ Oct 17 2022 21:43:16 PDT 3s 2 ls ~/ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└────────────────────────────────────────────────────────────────────────────────────────────────────────┘

4
client/lib/lib.go
View File

@ -495,7 +495,7 @@ func IsEnabled(ctx *context.Context) (bool, error) {
func CheckFatalError(err error) { func CheckFatalError(err error) {
if err != nil { if err != nil {
_, filename, line, _ := runtime.Caller(1) _, filename, line, _ := runtime.Caller(1)
log.Fatalf("hishtory fatal error at %s:%d: %v", filename, line, err) log.Fatalf("hishtory v0.%s fatal error at %s:%d: %v", Version, filename, line, err)
} }
} }
@ -1199,7 +1199,7 @@ func parseAtomizedToken(ctx *context.Context, token string) (string, interface{}
} }
} }
if !isCustomColumn { if !isCustomColumn {
return "", nil, nil, fmt.Errorf("search query contains unknown search atom %s", field) return "", nil, nil, fmt.Errorf("search query contains unknown search atom '%s' that doesn't match any column names", field)
} }
// Build the where clause for the custom column // Build the where clause for the custom column
return "EXISTS (SELECT 1 FROM json_each(custom_columns) WHERE json_extract(value, '$.name') = ? and instr(json_extract(value, '$.value'), ?) > 0)", field, val, nil return "EXISTS (SELECT 1 FROM json_each(custom_columns) WHERE json_extract(value, '$.name') = ? and instr(json_extract(value, '$.value'), ?) > 0)", field, val, nil

19
client/lib/tui.go
View File

@ -57,7 +57,7 @@ type model struct {
lastQuery string lastQuery string
// Unrecoverable error. // Unrecoverable error.
err error fatalErr error
// An error while searching. Recoverable and displayed as a warning message. // An error while searching. Recoverable and displayed as a warning message.
searchErr error searchErr error
// Whether the device is offline. If so, a warning will be displayed. // Whether the device is offline. If so, a warning will be displayed.
@ -98,17 +98,15 @@ func runQueryAndUpdateTable(m model, updateTable bool) model {
m.runQuery = &m.lastQuery m.runQuery = &m.lastQuery
} }
rows, numEntries, err := getRows(m.ctx, hctx.GetConf(m.ctx).DisplayedColumns, *m.runQuery, PADDED_NUM_ENTRIES) rows, numEntries, err := getRows(m.ctx, hctx.GetConf(m.ctx).DisplayedColumns, *m.runQuery, PADDED_NUM_ENTRIES)
m.searchErr = err
if err != nil { if err != nil {
m.searchErr = err
return m return m
} else {
m.searchErr = nil
} }
m.numEntries = numEntries m.numEntries = numEntries
if updateTable { if updateTable {
t, err := makeTable(m.ctx, rows) t, err := makeTable(m.ctx, rows)
if err != nil { if err != nil {
m.err = err m.fatalErr = err
return m return m
} }
m.table = t m.table = t
@ -154,7 +152,7 @@ func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
m = runQueryAndUpdateTable(m, true) m = runQueryAndUpdateTable(m, true)
return m, nil return m, nil
case errMsg: case errMsg:
m.err = msg m.fatalErr = msg
return m, nil return m, nil
case offlineMsg: case offlineMsg:
m.isOffline = true m.isOffline = true
@ -178,8 +176,8 @@ func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
} }
func (m model) View() string { func (m model) View() string {
if m.err != nil { if m.fatalErr != nil {
return fmt.Sprintf("An unrecoverable error occured: %v\n", m.err) return fmt.Sprintf("An unrecoverable error occured: %v\n", m.fatalErr)
} }
if m.selected { if m.selected {
indexOfCommand := -1 indexOfCommand := -1
@ -412,6 +410,11 @@ func TuiQuery(ctx *context.Context, initialQuery string) error {
lipgloss.SetColorProfile(termenv.ANSI) lipgloss.SetColorProfile(termenv.ANSI)
rows, numEntries, err := getRows(ctx, hctx.GetConf(ctx).DisplayedColumns, initialQuery, PADDED_NUM_ENTRIES) rows, numEntries, err := getRows(ctx, hctx.GetConf(ctx).DisplayedColumns, initialQuery, PADDED_NUM_ENTRIES)
if err != nil { if err != nil {
if initialQuery != "" {
// initialQuery is likely invalid in some way, let's just drop it
return TuiQuery(ctx, "")
}
// Something else has gone wrong, crash
return err return err
} }
t, err := makeTable(ctx, rows) t, err := makeTable(ctx, rows)