Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The 'watch' command allows watching a table for changes, similar to the "cilium-dbg statedb <table> --watch" flag. The "strike out" support is ported from cilium-dbg/cmd/statedb.go. The plan is to eventually replace the "cilium-dbg statedb" with the script commands. Signed-off-by: Jussi Maki <[email protected]>
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,11 +16,12 @@ import ( | |
| "regexp" | ||
| "slices" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/cilium/hive" | ||
|
Check failure on line 21 in script.go
|
||
| "github.com/cilium/hive/script" | ||
|
Check failure on line 22 in script.go
|
||
| "github.com/liggitt/tabwriter" | ||
| "golang.org/x/time/rate" | ||
| "gopkg.in/yaml.v3" | ||
| ) | ||
|
|
||
|
|
@@ -35,6 +36,7 @@ func ScriptCommands(db *DB) hive.ScriptCmdOut { | |
| "prefix": PrefixCmd(db), | ||
| "list": ListCmd(db), | ||
| "lowerbound": LowerBoundCmd(db), | ||
| "watch": WatchCmd(db), | ||
| "initialized": InitializedCmd(db), | ||
| } | ||
| subCmdsList := strings.Join(slices.Collect(maps.Keys(subCmds)), ", ") | ||
|
|
@@ -77,7 +79,7 @@ func TablesCmd(db *DB) script.Cmd { | |
| func(s *script.State, args ...string) (script.WaitFunc, error) { | ||
| txn := db.ReadTxn() | ||
| tbls := db.GetTables(txn) | ||
| w := newTabWriter(s.LogWriter()) | ||
| fmt.Fprintf(w, "Name\tObject count\tDeleted objects\tIndexes\tInitializers\tGo type\tLast WriteTxn\n") | ||
| for _, tbl := range tbls { | ||
| idxs := strings.Join(tbl.Indexes(), ", ") | ||
|
|
@@ -207,7 +209,7 @@ func CompareCmd(db *DB) script.Cmd { | |
| return script.Command( | ||
| script.CmdUsage{ | ||
| Summary: "Compare table", | ||
| Args: "(-timeout=<dur>) (-grep=<pattern>) table file", | ||
| }, | ||
| func(s *script.State, args ...string) (script.WaitFunc, error) { | ||
| flags := newCmdFlagSet() | ||
|
|
@@ -264,7 +266,7 @@ func CompareCmd(db *DB) script.Cmd { | |
| // Create the diff between 'lines' and the rows in the table. | ||
| equal := true | ||
| var diff bytes.Buffer | ||
| w := newTabWriter(&diff) | ||
| fmt.Fprintf(w, " %s\n", joinByPositions(columnNames, columnPositions)) | ||
|
|
||
| objs, watch := tbl.AllWatch(db.ReadTxn()) | ||
|
|
@@ -509,6 +511,65 @@ func runQueryCmd(query int, db *DB, s *script.State, args []string) (script.Wait | |
| }, nil | ||
| } | ||
|
|
||
| func WatchCmd(db *DB) script.Cmd { | ||
| return script.Command( | ||
| script.CmdUsage{ | ||
| Summary: "Watch a table for changes", | ||
| Args: "table", | ||
| }, | ||
| func(s *script.State, args ...string) (script.WaitFunc, error) { | ||
| if len(args) < 1 { | ||
| return nil, fmt.Errorf("expected table name") | ||
| } | ||
|
|
||
| tbl, _, err := getTable(db, args[0]) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| wtxn := db.WriteTxn(tbl.Meta) | ||
| iter, err := tbl.Changes(wtxn) | ||
| wtxn.Commit() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| header := tbl.TableHeader() | ||
| if header == nil { | ||
| return nil, fmt.Errorf("objects in table %q not TableWritable", tbl.Meta.Name()) | ||
| } | ||
| tw := newTabWriter(&strikethroughWriter{w: s.LogWriter()}) | ||
| fmt.Fprintf(tw, "%s\n", strings.Join(header, "\t")) | ||
|
|
||
| limiter := rate.NewLimiter(10.0, 1) | ||
| for { | ||
| if err := limiter.Wait(s.Context()); err != nil { | ||
| break | ||
| } | ||
| changes, watch := iter.nextAny(db.ReadTxn()) | ||
| for change := range changes { | ||
| row := change.Object.(TableWritable).TableRow() | ||
| if change.Deleted { | ||
| fmt.Fprintf(tw, "%s (deleted)%s", strings.Join(row, "\t"), magicStrikethroughNewline) | ||
| } else { | ||
| fmt.Fprintf(tw, "%s\n", strings.Join(row, "\t")) | ||
| } | ||
| } | ||
| tw.Flush() | ||
| if err := s.FlushLog(); err != nil { | ||
| return nil, err | ||
| } | ||
| select { | ||
| case <-watch: | ||
| case <-s.Context().Done(): | ||
| return nil, nil | ||
| } | ||
| } | ||
| return nil, nil | ||
|
|
||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func firstOfSeq2[A, B any](it iter.Seq2[A, B]) iter.Seq2[A, B] { | ||
| return func(yield func(a A, b B) bool) { | ||
| for a, b := range it { | ||
|
|
@@ -576,7 +637,7 @@ func writeObjects(tbl *AnyTable, it iter.Seq2[any, Revision], w io.Writer, colum | |
| if err != nil { | ||
| return err | ||
| } | ||
| tw := newTabWriter(w) | ||
| fmt.Fprintf(tw, "%s\n", strings.Join(header, "\t")) | ||
|
|
||
| for obj := range it { | ||
|
|
@@ -682,3 +743,95 @@ func joinByPositions(row []string, positions []int) string { | |
| } | ||
| return w.String() | ||
| } | ||
|
|
||
| // strikethroughWriter writes a line of text that is striken through | ||
| // if the line contains the magic character at the end before \n. | ||
| // This is used to strike through a tab-formatted line without messing | ||
| // up with the widths of the cells. | ||
| type strikethroughWriter struct { | ||
| buf []byte | ||
| strikethrough bool | ||
| w io.Writer | ||
| } | ||
|
|
||
| var ( | ||
| // Magic character to use at the end of the line to denote that this should be | ||
| // striken through. | ||
| // This is to avoid messing up the width calculations in the tab writer, which | ||
| // would happen if ANSI codes were used directly. | ||
| magicStrikethrough = byte('\xfe') | ||
| magicStrikethroughNewline = "\xfe\n" | ||
| ) | ||
|
|
||
| func stripTrailingWhitespace(buf []byte) []byte { | ||
| idx := bytes.LastIndexFunc( | ||
| buf, | ||
| func(r rune) bool { | ||
| return r != ' ' && r != '\t' | ||
| }, | ||
| ) | ||
| if idx > 0 { | ||
| return buf[:idx+1] | ||
| } | ||
| return buf | ||
| } | ||
|
|
||
| func (s *strikethroughWriter) Write(p []byte) (n int, err error) { | ||
| write := func(bs []byte) { | ||
| if err == nil { | ||
| _, e := s.w.Write(bs) | ||
| if e != nil { | ||
| err = e | ||
| } | ||
| } | ||
| } | ||
| for _, c := range p { | ||
| switch c { | ||
| case '\n': | ||
| s.buf = stripTrailingWhitespace(s.buf) | ||
|
|
||
| if s.strikethrough { | ||
| write(beginStrikethrough) | ||
| write(s.buf) | ||
| write(endStrikethrough) | ||
| } else { | ||
| write(s.buf) | ||
| } | ||
| write(newline) | ||
|
|
||
| s.buf = s.buf[:0] // reset len for reuse. | ||
| s.strikethrough = false | ||
|
|
||
| if err != nil { | ||
| return 0, err | ||
| } | ||
|
|
||
| case magicStrikethrough: | ||
| s.strikethrough = true | ||
|
|
||
| default: | ||
| s.buf = append(s.buf, c) | ||
| } | ||
| } | ||
| return len(p), nil | ||
| } | ||
|
|
||
| var ( | ||
| // Use color red and the strikethrough escape | ||
| beginStrikethrough = []byte("\033[9m\033[31m") | ||
| endStrikethrough = []byte("\033[0m") | ||
| newline = []byte("\n") | ||
| ) | ||
|
|
||
| var _ io.Writer = &strikethroughWriter{} | ||
|
|
||
| func newTabWriter(out io.Writer) *tabwriter.Writer { | ||
| const ( | ||
| minWidth = 6 | ||
| width = 4 | ||
| padding = 3 | ||
| padChar = ' ' | ||
| flags = tabwriter.RememberWidths | ||
| ) | ||
| return tabwriter.NewWriter(out, minWidth, width, padding, padChar, flags) | ||
| } | ||
