/
hud.go
376 lines (324 loc) · 9.54 KB
/
hud.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
package hud
import (
"context"
"fmt"
"os"
"runtime"
"runtime/pprof"
"sync"
"time"
"github.com/windmilleng/tilt/internal/output"
"github.com/windmilleng/tilt/pkg/logger"
"github.com/gdamore/tcell"
"github.com/pkg/browser"
"github.com/pkg/errors"
"github.com/windmilleng/tilt/internal/analytics"
"github.com/windmilleng/tilt/internal/hud/view"
"github.com/windmilleng/tilt/internal/store"
"github.com/windmilleng/tilt/pkg/model"
)
// The main loop ensures the HUD updates at least this often
const DefaultRefreshInterval = 100 * time.Millisecond
// number of arrows a pgup/dn is equivalent to
// (we don't currently worry about trying to know how big a page is, and instead just support pgup/dn as "faster arrows"
const pgUpDownCount = 20
type HudEnabled bool
type HeadsUpDisplay interface {
store.Subscriber
Run(ctx context.Context, dispatch func(action store.Action), refreshRate time.Duration) error
}
type Hud struct {
r *Renderer
webURL model.WebURL
currentView view.View
currentViewState view.ViewState
mu sync.RWMutex
isRunning bool
a *analytics.TiltAnalytics
}
var _ HeadsUpDisplay = (*Hud)(nil)
func ProvideHud(hudEnabled HudEnabled, renderer *Renderer, webURL model.WebURL, analytics *analytics.TiltAnalytics, printer *IncrementalPrinter, store store.RStore) (HeadsUpDisplay, error) {
if !hudEnabled {
return NewDisabledHud(printer, store), nil
}
return NewDefaultHeadsUpDisplay(renderer, webURL, analytics)
}
func NewDefaultHeadsUpDisplay(renderer *Renderer, webURL model.WebURL, analytics *analytics.TiltAnalytics) (HeadsUpDisplay, error) {
return &Hud{
r: renderer,
webURL: webURL,
a: analytics,
}, nil
}
func (h *Hud) SetNarrationMessage(ctx context.Context, msg string) {
h.mu.Lock()
defer h.mu.Unlock()
currentViewState := h.currentViewState
currentViewState.ShowNarration = true
currentViewState.NarrationMessage = msg
h.setViewState(ctx, currentViewState)
}
func (h *Hud) Run(ctx context.Context, dispatch func(action store.Action), refreshRate time.Duration) error {
// Redirect stdout and stderr into our logger
err := output.CaptureAllOutput(logger.Get(ctx).Writer(logger.InfoLvl))
if err != nil {
logger.Get(ctx).Infof("Error capturing stdout and stderr: %v", err)
}
h.mu.Lock()
h.isRunning = true
h.mu.Unlock()
defer func() {
h.mu.Lock()
h.isRunning = false
h.mu.Unlock()
}()
screenEvents, err := h.r.SetUp()
if err != nil {
return errors.Wrap(err, "setting up screen")
}
defer h.Close()
if refreshRate == 0 {
refreshRate = DefaultRefreshInterval
}
ticker := time.NewTicker(refreshRate)
for {
select {
case <-ctx.Done():
err := ctx.Err()
if err != context.Canceled {
return err
}
return nil
case e := <-screenEvents:
done := h.handleScreenEvent(ctx, dispatch, e)
if done {
return nil
}
case <-ticker.C:
h.Refresh(ctx)
}
}
}
func (h *Hud) Close() {
h.r.Reset()
}
func (h *Hud) recordInteraction(name string) {
h.a.Incr(fmt.Sprintf("ui.interactions.%s", name), map[string]string{})
}
func (h *Hud) handleScreenEvent(ctx context.Context, dispatch func(action store.Action), ev tcell.Event) (done bool) {
h.mu.Lock()
defer h.mu.Unlock()
escape := func() {
am := h.activeModal()
if am != nil {
am.Close(&h.currentViewState)
}
}
switch ev := ev.(type) {
case *tcell.EventKey:
switch ev.Key() {
case tcell.KeyEscape:
escape()
case tcell.KeyRune:
switch r := ev.Rune(); {
case r == 'b': // [B]rowser
// If we have an endpoint(s), open the first one
// TODO(nick): We might need some hints on what load balancer to
// open if we have multiple, or what path to default to on the opened manifest.
_, selected := h.selectedResource()
if len(selected.Endpoints) > 0 {
h.recordInteraction("open_preview")
err := browser.OpenURL(selected.Endpoints[0])
if err != nil {
h.currentViewState.AlertMessage = fmt.Sprintf("error opening url '%s' for resource '%s': %v",
selected.Endpoints[0], selected.Name, err)
}
} else {
h.currentViewState.AlertMessage = fmt.Sprintf("no urls for resource '%s' ¯\\_(ツ)_/¯", selected.Name)
}
case r == 'l': // Tilt [L]og
if h.webURL.Empty() {
break
}
url := h.webURL
url.Path = "/"
_ = browser.OpenURL(url.String())
case r == 'k':
h.activeScroller().Up()
h.refreshSelectedIndex()
case r == 'j':
h.activeScroller().Down()
h.refreshSelectedIndex()
case r == 'q': // [Q]uit
escape()
case r == 'R': // hidden key for recovering from printf junk during demos
h.r.screen.Sync()
case r == 'x':
h.recordInteraction("cycle_view_log_state")
h.currentViewState.CycleViewLogState()
case r == '1':
h.recordInteraction("tab_all_log")
h.currentViewState.TabState = view.TabAllLog
case r == '2':
h.recordInteraction("tab_build_log")
h.currentViewState.TabState = view.TabBuildLog
case r == '3':
h.recordInteraction("tab_pod_log")
h.currentViewState.TabState = view.TabRuntimeLog
}
case tcell.KeyUp:
h.activeScroller().Up()
h.refreshSelectedIndex()
case tcell.KeyDown:
h.activeScroller().Down()
h.refreshSelectedIndex()
case tcell.KeyPgUp:
for i := 0; i < pgUpDownCount; i++ {
h.activeScroller().Up()
}
h.refreshSelectedIndex()
case tcell.KeyPgDn:
for i := 0; i < pgUpDownCount; i++ {
h.activeScroller().Down()
}
h.refreshSelectedIndex()
case tcell.KeyEnter:
if len(h.currentView.Resources) == 0 {
break
}
_, r := h.selectedResource()
if h.webURL.Empty() {
break
}
url := h.webURL
// If the cursor is in the default position (Tiltfile), open the All log.
if r.Name != store.TiltfileManifestName {
url.Path = fmt.Sprintf("/r/%s/", r.Name)
}
h.a.Incr("ui.interactions.open_log", nil)
_ = browser.OpenURL(url.String())
case tcell.KeyRight:
i, _ := h.selectedResource()
h.currentViewState.Resources[i].CollapseState = view.CollapseNo
case tcell.KeyLeft:
i, _ := h.selectedResource()
h.currentViewState.Resources[i].CollapseState = view.CollapseYes
case tcell.KeyHome:
h.activeScroller().Top()
case tcell.KeyEnd:
h.activeScroller().Bottom()
case tcell.KeyCtrlC:
h.Close()
dispatch(NewExitAction(nil))
return true
case tcell.KeyCtrlD:
dispatch(DumpEngineStateAction{})
case tcell.KeyCtrlP:
if h.currentView.IsProfiling {
dispatch(StopProfilingAction{})
} else {
dispatch(StartProfilingAction{})
}
case tcell.KeyCtrlO:
go writeHeapProfile(ctx)
}
case *tcell.EventResize:
// since we already refresh after the switch, don't need to do anything here
// just marking this as where sigwinch gets handled
}
h.refresh(ctx)
return false
}
func (h *Hud) OnChange(ctx context.Context, st store.RStore) {
h.mu.Lock()
defer h.mu.Unlock()
toPrint := ""
state := st.RLockState()
view := store.StateToView(state, st.StateMutex())
// if the hud isn't running, make sure new logs are visible on stdout
if !h.isRunning {
toPrint = state.LogStore.ContinuingString(h.currentViewState.ProcessedLogs)
}
h.currentViewState.ProcessedLogs = state.LogStore.Checkpoint()
st.RUnlockState()
fmt.Print(toPrint)
// if we're going from 1 resource (i.e., the Tiltfile) to more than 1, reset
// the resource selection, so that we're not scrolled to the bottom with the Tiltfile selected
if len(h.currentView.Resources) == 1 && len(view.Resources) > 1 {
h.resetResourceSelection()
}
h.currentView = view
h.refreshSelectedIndex()
}
func (h *Hud) Refresh(ctx context.Context) {
h.mu.Lock()
defer h.mu.Unlock()
h.refresh(ctx)
}
// Must hold the lock
func (h *Hud) setViewState(ctx context.Context, currentViewState view.ViewState) {
h.currentViewState = currentViewState
h.refresh(ctx)
}
// Must hold the lock
func (h *Hud) refresh(ctx context.Context) {
// TODO: We don't handle the order of resources changing
for len(h.currentViewState.Resources) < len(h.currentView.Resources) {
h.currentViewState.Resources = append(h.currentViewState.Resources, view.ResourceViewState{})
}
vs := h.currentViewState
vs.Resources = append(vs.Resources, h.currentViewState.Resources...)
h.r.Render(h.currentView, h.currentViewState)
}
func (h *Hud) resetResourceSelection() {
rty := h.r.RTY()
if rty == nil {
return
}
// wipe out any scroll/selection state for resources
// it will get re-set in the next call to render
rty.RegisterElementScroll("resources", []string{})
}
func (h *Hud) refreshSelectedIndex() {
rty := h.r.RTY()
if rty == nil {
return
}
scroller := rty.ElementScroller("resources")
if scroller == nil {
return
}
i := scroller.GetSelectedIndex()
h.currentViewState.SelectedIndex = i
}
func (h *Hud) selectedResource() (i int, resource view.Resource) {
return selectedResource(h.currentView, h.currentViewState)
}
func selectedResource(view view.View, state view.ViewState) (i int, resource view.Resource) {
i = state.SelectedIndex
if i >= 0 && i < len(view.Resources) {
resource = view.Resources[i]
}
return i, resource
}
var _ store.Subscriber = &Hud{}
func writeHeapProfile(ctx context.Context) {
f, err := os.Create("tilt.heap_profile")
if err != nil {
logger.Get(ctx).Infof("error creating file for heap profile: %v", err)
return
}
runtime.GC()
logger.Get(ctx).Infof("writing heap profile to %s", f.Name())
err = pprof.WriteHeapProfile(f)
if err != nil {
logger.Get(ctx).Infof("error writing heap profile: %v", err)
return
}
err = f.Close()
if err != nil {
logger.Get(ctx).Infof("error closing file for heap profile: %v", err)
return
}
logger.Get(ctx).Infof("wrote heap profile to %s", f.Name())
}