Sidebar search: Preserve original collapse/expand state

Author: jorio

gitfourchette/repowidget.py

@@ -231,7 +231,7 @@ def __init__(self, repoModel: RepoModel, taskRunner: RepoTaskRunner, parent: QWi
         with QSignalBlockerContext(self.sidebar):
             collapseCache = repoModel.prefs.collapseCache
             if collapseCache:
-                self.sidebar.sidebarModel.collapseCache = set(collapseCache)
+                self.sidebar.sidebarModel.collapseCache.update(collapseCache)
             self.sidebar.refresh(repoModel)
 
         # ----------------------------------
@@ -392,7 +392,7 @@ def prepareForDeletion(self):
         # Save sidebar collapse cache
         with NonCriticalOperation("Write repo prefs"):  # May raise OSError
             uiPrefs = self.repoModel.prefs
-            collapseCache = self.sidebar.sidebarModel.collapseCache
+            collapseCache = self.sidebar.sidebarModel.collapseCacheLayers[0]
             if uiPrefs.collapseCache != collapseCache:
                 uiPrefs.collapseCache = collapseCache.copy()
                 uiPrefs.setDirty()

gitfourchette/sidebar/sidebar.py

@@ -101,14 +101,6 @@ def nodeToFilterIndex(self, node: SidebarNode) -> QModelIndex:
         assert index.model() is self.sidebarModel
         return self.filterModel.mapFromSource(index)
 
-    def onIndexExpanded(self, index: QModelIndex):
-        node = self.filterIndexToNode(index)
-        self.sidebarModel.cacheNodeCollapsedState(node, collapsed=False)
-
-    def onIndexCollapsed(self, index: QModelIndex):
-        node = self.filterIndexToNode(index)
-        self.sidebarModel.cacheNodeCollapsedState(node, collapsed=True)
-
     def drawBranches(self, painter, rect, index):
         """
         (overridden function)
@@ -861,6 +853,9 @@ def revealStashParent(self, oid: Oid):
         parent = commit.parent_ids[0]
         Jump.invoke(self, NavLocator.inCommit(parent))
 
+    # -------------------------------------------------------------------------
+    # Sidebar nodes
+
     def walk(self):
         return self.sidebarModel.rootNode.walk()
 
@@ -937,8 +932,16 @@ def selectAnyRef(self, *refs: str) -> QModelIndex | None:
         self.clearSelection()
         return None
 
+    # -------------------------------------------------------------------------
+    # Collapse/expand
+
     @benchmark
     def restoreExpandedItems(self):
+        """
+        Assumes all collapsible rows are collapsed before this is called.
+        (After rebuilding the model, all rows are collapsed by default.)
+        """
+
         model = self.sidebarModel
 
         frontier = model.rootNode.children[:]
@@ -954,23 +957,52 @@ def restoreExpandedItems(self):
 
             frontier.extend(node.children)
 
-    def collapseChildFolders(self, node: SidebarNode):
+    def expandChildFolders(self, node: SidebarNode, collapse: bool = False):
+        operation = self.collapse if collapse else self.expand
         frontier = node.children[:]
         while frontier:
             node = frontier.pop()
             if node.kind == SidebarItem.RefFolder:
                 frontier.extend(node.children)
                 index = self.nodeToFilterIndex(node)
-                self.collapse(index)
+                operation(index)
 
-    def expandChildFolders(self, node: SidebarNode):
-        frontier = node.children[:]
-        while frontier:
-            node = frontier.pop()
-            if node.kind == SidebarItem.RefFolder:
-                frontier.extend(node.children)
-                index = self.nodeToFilterIndex(node)
-                self.expand(index)
+    def collapseChildFolders(self, node: SidebarNode):
+        self.expandChildFolders(node, collapse=True)
+
+    def onIndexExpanded(self, index: QModelIndex):
+        node = self.filterIndexToNode(index)
+        self.sidebarModel.cacheNodeCollapsedState(node, collapsed=False)
+
+    def onIndexCollapsed(self, index: QModelIndex):
+        node = self.filterIndexToNode(index)
+        self.sidebarModel.cacheNodeCollapsedState(node, collapsed=True)
+
+    def setCollapseStateLayer(self, transient: bool):
+        model = self.sidebarModel
+        currentLayer = len(model.collapseCacheLayers) - 1
+        targetLayer = 1 if transient else 0
+
+        # No-op if switching to same layer
+        if targetLayer == currentLayer:
+            return
+
+        if currentLayer == 0:
+            # Create layer 1 (transient)
+            model.collapseCacheLayers.append(set())
+        elif currentLayer == 1:
+            # Collapse everything first so restoreExpandedItems will work,
+            # then drop down to layer 0 (permanent)
+            self.collapseAll()
+            model.collapseCacheLayers.pop()
+        else:
+            raise NotImplementedError(f"unsupported layer {currentLayer}")
+
+        assert targetLayer == len(model.collapseCacheLayers) - 1
+
+        self.restoreExpandedItems()
+
+    # -------------------------------------------------------------------------
 
     def copyToClipboard(self, text: str):
         QApplication.clipboard().setText(text)

gitfourchette/sidebar/sidebarfilter.py

@@ -37,7 +37,7 @@ def __init__(self, parent=None):
 
     def setFilterText(self, text: str):
         with FilterChangeContext(self):
-            self._filterText = text
+            self._filterText = text.lower()
 
     def filterAcceptsRow(self, sourceRow: int, sourceParent: QModelIndex) -> bool:
         if not self._filterText:
@@ -63,7 +63,7 @@ def filterAcceptsRow(self, sourceRow: int, sourceParent: QModelIndex) -> bool:
         # This ensures that branches like "wip/leaf" match when searching for "wip"
         if item in _refItems:
             refName = index.data(SidebarModel.Role.Ref)
-            if refName and self._filterText.lower() in refName.lower():
+            if refName and self._filterText in refName.lower():
                 return True
 
-        return self._filterText.lower() in displayText.lower()
+        return self._filterText in displayText.lower()

gitfourchette/sidebar/sidebarmodel.py

@@ -204,7 +204,16 @@ class SidebarModel(QAbstractItemModel):
     _cachedToolTipIndex: QModelIndex
     _cachedToolTipText: str
 
-    collapseCache: set[str]
+    collapseCacheLayers: list[set[str]]
+    """
+    Keeps a cache of collapsed nodes.
+
+    Layer #0 is the permanent state. It is saved to disk as part of RepoPrefs.
+    It is applied when SidebarFilter is inactive.
+
+    Layer #1 is the transient state. It only exists as long as SidebarFilter is
+    active.
+    """
 
     class Role:
         Ref = Qt.ItemDataRole(Qt.ItemDataRole.UserRole + 0)
@@ -220,10 +229,16 @@ def _parentWidget(self) -> QWidget:
     def repo(self) -> Repo:
         return self.repoModel.repo
 
+    @property
+    def collapseCache(self) -> set[str]:
+        return self.collapseCacheLayers[-1]
+
     def __init__(self, parent=None):
         super().__init__(parent)
 
-        self.collapseCache = set()
+        # Initialize collapse cache with an empty permanent layer
+        # (i.e. all items start expanded)
+        self.collapseCacheLayers = [set()]
 
         self.clear()
 

gitfourchette/sidebar/sidebarsearch.py

@@ -23,12 +23,23 @@ def __init__(self, sidebar: Sidebar):
 
     def invalidate(self):
         super().invalidate()
+
+        # Wipe term from filter, return to permanent collapse state
         self.setTerm("")
 
+        # After returning to the permanent collapse state, force expand the node
+        # that the user selected while the filter was active
+        node = self.sidebar.selectedNode()
+        if node is not None and not self.sidebar.sidebarModel.isAncestryChainExpanded(node):
+            self.sidebar.selectionModel().clear()
+            self.sidebar.selectNode(node)
+
     def _termChanged(self):
         term = self.term()
         self.sidebar.filterModel.setFilterText(term)
+
         if term:
+            self.sidebar.setCollapseStateLayer(transient=True)
             self.sidebar.expandAll()
         else:
-            self.sidebar.restoreExpandedItems()
+            self.sidebar.setCollapseStateLayer(transient=False)

test/test_sidebar.py

@@ -15,11 +15,18 @@
 
 
 def _summonSearchBar(rw):
+    rw.activateWindow()  # macOS offscreen compat (e.g. after a context menu)
+    waitUntilTrue(rw.isActiveWindow)
+
     searchBar = rw.sidebar.searchBar
     assert not searchBar.isVisible()
+
     rw.sidebar.setFocus()
+    assert rw.sidebar.hasFocus()
+
     QTest.keySequence(rw.window(), "Ctrl+F")
     assert searchBar.isVisible()
+
     return searchBar
 
 
@@ -657,31 +664,61 @@ def testSidebarFilterPreservesSelection(tempDir, mainWindow):
     assert len(sb.selectedIndexes()) > 0
 
 
-def testSidebarFilterExpandsAll(tempDir, mainWindow):
+def testSidebarFilterCollapseState(tempDir, mainWindow):
     wd = unpackRepo(tempDir)
 
     with RepoContext(wd) as repo:
-        repo.create_branch_on_head("team/frontend/login")
-        repo.create_branch_on_head("team/backend/api")
+        repo.create_branch_on_head("folder1/leaf")
+        repo.create_branch_on_head("folder2/leaf")
+        repo.create_branch_on_head("folder3/leaf")
 
     rw = mainWindow.openRepo(wd)
     sb = rw.sidebar
-    sm = sb.sidebarModel
-    searchBar = _summonSearchBar(rw)
 
-    # Collapse all folders first so we have something to expand
+    # Bypass isAncestryChainExpanded
+    def isExpanded(ref: str) -> bool:
+        i = sb.indexForRef(ref)
+        assert i.isValid()
+
+        i = i.parent()
+        while i.isValid():
+            if not sb.isExpanded(i):
+                return False
+            i = i.parent()
+        return True
+
+    # Collapse all local branch folders first
     localBranchesNode = sb.findNodeByKind(SidebarItem.LocalBranchesHeader)
     sb.selectNode(localBranchesNode)
     triggerContextMenuAction(sb.viewport(), "collapse all folders")
+    assert not isExpanded("refs/heads/folder1/leaf")
+    assert not isExpanded("refs/heads/folder2/leaf")
+    assert not isExpanded("refs/heads/folder3/leaf")
 
-    # Confirm the nested branch is now unreachable (ancestry chain collapsed)
-    loginNode = sb.findNodeByRef("refs/heads/team/frontend/login")
-    assert not sm.isAncestryChainExpanded(loginNode)
-
-    # Applying a filter should expand all matching items
-    searchBar.lineEdit.setText("login")
-
-    # The branch must now be visible in the proxy model
-    assert sb.indexForRef("refs/heads/team/frontend/login").isValid()
-    # And its entire parent chain must be expanded in the source model
-    assert sm.isAncestryChainExpanded(loginNode)
+    # Summon search bar, search for "leaf"
+    searchBar = _summonSearchBar(rw)
+    searchBar.lineEdit.setText("leaf")
+    assert isExpanded("refs/heads/folder1/leaf")
+    assert isExpanded("refs/heads/folder2/leaf")
+    assert isExpanded("refs/heads/folder3/leaf")
+
+    # Search for a term with no matches, then revert to searching for "leaf"
+    searchBar.lineEdit.setText("bogusbogus")
+    assert not sb.indexForRef("refs/heads/folder1/leaf").isValid()
+    searchBar.lineEdit.setText("leaf")
+    assert isExpanded("refs/heads/folder1/leaf")
+    assert isExpanded("refs/heads/folder2/leaf")
+    assert isExpanded("refs/heads/folder3/leaf")
+
+    # Select folder2/leaf before closing search bar
+    sb.selectAnyRef("refs/heads/folder2/leaf")
+
+    # Close search bar
+    searchBar.bail()
+
+    # folder1 & folder3 must be collapsed, as they were before filtering.
+    assert not isExpanded("refs/heads/folder1/leaf")
+    assert not isExpanded("refs/heads/folder3/leaf")
+    # folder2 was originally collapsed, but it should now be expanded because
+    # we selected it before closing the search bar.
+    assert isExpanded("refs/heads/folder2/leaf")