Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 33 additions & 3 deletions internal/ui/mainwindow.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ type MainWindow struct {
showOffline bool
peerQuery string
ipn *tsutil.IPNStatus
sidebarHold int

profiles []ipn.LoginProfile
profileModel *gtk.StringList
Expand Down Expand Up @@ -195,6 +196,25 @@ func (win *MainWindow) OpenPeerSearch() {
win.PeerSearchEntry.GrabFocus()
}

// holdSidebar detaches the sidebar from the stack until the returned
// function is called. AdwViewSwitcherSidebar rebuilds all of its rows
// whenever the stack's pages change, so adding or removing pages one at
// a time with it attached takes time quadratic in the number of pages.
// Holds nest. The sidebar is reattached, and rebuilt once, when the
// last one is released.
func (win *MainWindow) holdSidebar() (release func()) {
if win.sidebarHold == 0 {
win.PeersSidebar.SetStack(nil)
}
win.sidebarHold++
return func() {
win.sidebarHold--
if win.sidebarHold == 0 {
win.PeersSidebar.SetStack(win.PeersStack)
}
}
}

func (win *MainWindow) addPage(name string, page Page) {
win.pages[name] = page
if old := win.stackPages[name]; old != nil {
Expand Down Expand Up @@ -321,6 +341,7 @@ func (win *MainWindow) applyLayout(status *tsutil.IPNStatus) {
layout := sidebarLayout(maps.Keys(win.pages), status, win.showOffline, win.peerQuery)
names := sidebarNames(layout)
if !slices.Equal(win.stackPageNames(), names) {
defer win.holdSidebar()()
win.restack(names)
win.updateStackPages(status)
}
Expand All @@ -347,14 +368,20 @@ func (win *MainWindow) updatePeers(status *tsutil.IPNStatus) {

win.ensureSectionPages(status)

var newPeers []tailcfg.StableNodeID
for id, peer := range status.Peers {
if tsutil.IsMullvad(peer) || tsutil.IsShareeNode(peer) {
continue
}
if _, ok := win.pages[string(id)]; ok {
continue
if _, ok := win.pages[string(id)]; !ok {
newPeers = append(newPeers, id)
}
win.addPage(string(id), NewPeerPage(win.app, status, peer))
}
if len(newPeers) > 0 {
defer win.holdSidebar()()
}
for _, id := range newPeers {
win.addPage(string(id), NewPeerPage(win.app, status, status.Peers[id]))
}

win.updatePages(status)
Expand All @@ -378,6 +405,9 @@ func (win *MainWindow) updatePages(status *tsutil.IPNStatus) {
remove = append(remove, name)
}
}
if len(remove) > 0 {
defer win.holdSidebar()()
}
for _, name := range remove {
win.removePage(name, win.pages[name])
}
Expand Down
83 changes: 83 additions & 0 deletions internal/ui/sidebar_test.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
package ui

import (
"fmt"
"maps"
"net/netip"
"slices"
"testing"

"codeberg.org/puregotk/puregotk/v4/adw"
"codeberg.org/puregotk/puregotk/v4/glib"
"codeberg.org/puregotk/puregotk/v4/gobject"
"codeberg.org/puregotk/puregotk/v4/gtk"
"deedles.dev/trayscale/internal/gutil"
"deedles.dev/trayscale/internal/tsutil"
"tailscale.com/ipn"
"tailscale.com/net/tsaddr"
Expand Down Expand Up @@ -149,3 +156,79 @@ func layoutPeer(t *testing.T, id, hostname string, online, exit, sharee bool) ta
n.InitDisplayNames("example.ts.net")
return n.View()
}

// TestPeerUpdatesDontRebuildSidebar checks that the stack's pages don't
// change while the sidebar is attached during peer updates. The sidebar
// rebuilds all of its rows for each change, which made the window take
// seconds to open on a tailnet with a couple hundred peers.
func TestPeerUpdatesDontRebuildSidebar(t *testing.T) {
requireGTK(t)

win := &MainWindow{
app: &App{},
pages: make(map[string]Page),
stackPages: make(map[string]*adw.ViewStackPage),
showOffline: true,
PeersStack: adw.NewViewStack(),
PeersSidebar: adw.NewViewSwitcherSidebar(),
}
win.profileModel = gtk.NewStringList(nil)
win.profileModel.Ref()
win.profileSortModel = gtk.NewSortListModel(win.profileModel, &newStringSorter().Sorter)
win.PeersSidebar.SetStack(win.PeersStack)
defer win.Dispose()

attached := func() bool {
stack := win.PeersSidebar.GetStack()
if stack == nil {
return false
}
defer stack.Unref()
return stack.GoPointer() == win.PeersStack.GoPointer()
}

var rebuilds int
itemsChanged := func(_, _, _, _, _ uintptr) {
if attached() {
rebuilds++
}
}
sectionsChanged := func(_, _, _, _ uintptr) {
if attached() {
rebuilds++
}
}
pages := win.PeersStack.GetPages()
defer gutil.Obj(pages).Unref()
gobject.SignalConnect(pages.GoPointer(), "items-changed", glib.NewCallback(&itemsChanged))
gobject.SignalConnect(pages.GoPointer(), "sections-changed", glib.NewCallback(&sectionsChanged))

update := func(name string, peers []tailcfg.NodeView) {
t.Helper()
status := layoutStatus(peers)
status.Prefs = ipn.NewPrefs().View()
rebuilds = 0
win.updatePeers(status)
if rebuilds != 0 {
t.Errorf("%s: sidebar rebuilt %d times during the update", name, rebuilds)
}
if !attached() {
t.Fatalf("%s: sidebar left detached from the stack", name)
}
want := sidebarNames(sidebarLayout(maps.Keys(win.pages), status, win.showOffline, win.peerQuery))
if got := win.stackPageNames(); !slices.Equal(got, want) {
t.Errorf("%s: stack pages = %v, want %v", name, got, want)
}
}

peers := make([]tailcfg.NodeView, 200)
for i := range peers {
peers[i] = layoutPeer(t, fmt.Sprintf("peer-%03d", i), fmt.Sprintf("peer-%03d", i), true, false, false)
}
update("initial", peers)

peers[0] = layoutPeer(t, "peer-000", "peer-000", false, false, false)
update("peer offline", peers)

update("peers removed", peers[100:])
}
Loading