feat: add autoRefresh config field (derailed#2256) (derailed#2257)

* feat: add autoRefresh config field Add autoRefresh: true to config test scenarios Update all instances of NewLiveView() to pass autoRefresh config value to LiveView * fix: rename generic autoRefresh config field to liveViewAutoRefresh * docs: document liveViewAutoRefresh config field * fix: use app config for NewLiveView creation --------- Co-authored-by: Artem Gorbatiuk <[email protected]>
placintaalexandru · Nov 8, 2023 · e28efdf · e28efdf
1 parent 8155384
commit e28efdf
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -319,6 +319,8 @@ K9s uses aliases to navigate most K8s resources.
   ```yaml
   # $XDG_CONFIG_HOME/k9s/config.yml
   k9s:
+    # Enable periodic refresh of resource browser windows. Default false
+    liveViewAutoRefresh: false
     # Represents ui poll intervals. Default 2secs
     refreshRate: 2
     # Number of retries once the connection to the api-server is lost. Default 15.

diff --git a/internal/config/config_test.go b/internal/config/config_test.go
@@ -277,6 +277,7 @@ func (m *mockSettings) ClusterNames() (map[string]struct{}, error) { return nil,
 // Test Data...
 
 var expectedConfig = `k9s:
+  liveViewAutoRefresh: true
   refreshRate: 100
   maxConnRetry: 5
   enableMouse: false
@@ -376,6 +377,7 @@ var expectedConfig = `k9s:
 `
 
 var resetConfig = `k9s:
+  liveViewAutoRefresh: true
   refreshRate: 2
   maxConnRetry: 5
   enableMouse: false

diff --git a/internal/config/k9s.go b/internal/config/k9s.go
@@ -11,6 +11,7 @@ const (
 
 // K9s tracks K9s configuration options.
 type K9s struct {
+	LiveViewAutoRefresh bool                `yaml:"liveViewAutoRefresh"`
 	RefreshRate         int                 `yaml:"refreshRate"`
 	MaxConnRetry        int                 `yaml:"maxConnRetry"`
 	EnableMouse         bool                `yaml:"enableMouse"`

diff --git a/internal/config/testdata/k9s.yml b/internal/config/testdata/k9s.yml
@@ -1,4 +1,5 @@
 k9s:
+  liveViewAutoRefresh: true
   refreshRate: 2
   readOnly: false
   logger:

diff --git a/internal/view/live_view.go b/internal/view/live_view.go
@@ -48,6 +48,7 @@ func NewLiveView(app *App, title string, m model.ResourceViewer) *LiveView {
 		maxRegions:    0,
 		cmdBuff:       model.NewFishBuff('/', model.FilterBuffer),
 		model:         m,
+		autoRefresh:   app.Config.K9s.LiveViewAutoRefresh,
 	}
 	v.AddItem(v.text, 0, 1, true)