Outline trying to reveal activeEntry when entry is filtered out

roblourens commented 5 months ago

I saw this once a couple days ago, and again today

Open notebook
Close it
The notebook outline is still there and overlayed with this message

2024-03-27 11:03:48.642 [error] TreeError [OutlinePane] Tree element not found: [object Object]: Error: TreeError [OutlinePane] Tree element not found: [object Object]
    at T.o (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:192:29689)
    at T.getListIndex (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:192:28692)
    at Y.getRelativeTop (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:626:2556)
    at V (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:2334:38288)
    at P.jc (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:2334:38425)
2024-03-27 11:06:20.347 [error] [Extension Host] [extension] Error: Response stream has been closed
    at Object.markdown (/Users/roblou/.vscode-insiders/extensions/github.copilot-chat-0.14.2024032701/dist/extension.js:855:1469)
    at p (/Users/roblou/.vscode-insiders/extensions/github.copilot-chat-0.14.2024032701/dist/extension.js:895:7332)
    at processTicksAndRejections (node:internal/process/task_queues:95:5)
    at hE.processResponse (/Users/roblou/.vscode-insiders/extensions/github.copilot-chat-0.14.2024032701/dist/extension.js:897:27)
    at oE.fetchConversationResponse (/Users/roblou/.vscode-insiders/extensions/github.copilot-chat-0.14.2024032701/dist/extension.js:859:1735)
    at oE._provideResponseWithProgress (/Users/roblou/.vscode-insiders/extensions/github.copilot-chat-0.14.2024032701/dist/extension.js:857:1618)
    at oE.provideResponseWithProgress (/Users/roblou/.vscode-insiders/extensions/github.copilot-chat-0.14.2024032701/dist/extension.js:855:1830)
    at r.x (/Users/roblou/.vscode-insiders/extensions/github.copilot-chat-0.14.2024032701/dist/extension.js:869:859)
2024-03-27 11:06:29.734 [error] [Extension Host] [extension] Error: Response stream has been closed
    at Object.markdown (/Users/roblou/.vscode-insiders/extensions/github.copilot-chat-0.14.2024032701/dist/extension.js:855:1469)
    at p (/Users/roblou/.vscode-insiders/extensions/github.copilot-chat-0.14.2024032701/dist/extension.js:895:7332)
    at processTicksAndRejections (node:internal/process/task_queues:95:5)
    at hE.processResponse (/Users/roblou/.vscode-insiders/extensions/github.copilot-chat-0.14.2024032701/dist/extension.js:897:27)
    at oE.fetchConversationResponse (/Users/roblou/.vscode-insiders/extensions/github.copilot-chat-0.14.2024032701/dist/extension.js:859:1735)
    at oE._provideResponseWithProgress (/Users/roblou/.vscode-insiders/extensions/github.copilot-chat-0.14.2024032701/dist/extension.js:857:1618)
    at oE.provideResponseWithProgress (/Users/roblou/.vscode-insiders/extensions/github.copilot-chat-0.14.2024032701/dist/extension.js:855:1830)
    at r.x (/Users/roblou/.vscode-insiders/extensions/github.copilot-chat-0.14.2024032701/dist/extension.js:869:859)
2024-03-27 11:11:15.667 [error] TreeError [OutlinePane] Tree element not found: [object Object]: Error: TreeError [OutlinePane] Tree element not found: [object Object]
    at T.o (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:192:29689)
    at T.getListIndex (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:192:28692)
    at Y.getRelativeTop (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:626:2556)
    at V (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:2334:38288)
    at P.jc (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:2334:38425)
2024-03-27 11:18:53.876 [error] TreeError [OutlinePane] Tree element not found: [object Object]: Error: TreeError [OutlinePane] Tree element not found: [object Object]
    at T.o (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:192:29689)
    at T.getListIndex (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:192:28692)
    at Y.getRelativeTop (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:626:2556)
    at V (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:2334:38288)
    at P.jc (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:2334:38425)
2024-03-27 11:33:54.451 [error] TreeError [OutlinePane] Tree element not found: [object Object]: Error: TreeError [OutlinePane] Tree element not found: [object Object]
    at T.o (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:192:29689)
    at T.getListIndex (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:192:28692)
    at Y.getRelativeTop (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:626:2556)
    at V (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:2334:38288)
    at P.jc (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:2334:38425)
2024-03-27 11:33:59.429 [error] TreeError [OutlinePane] Tree element not found: [object Object]: Error: TreeError [OutlinePane] Tree element not found: [object Object]
    at T.o (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:192:29689)
    at T.getListIndex (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:192:28692)
    at Y.getRelativeTop (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:626:2556)
    at V (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:2334:38288)
    at P.jc (vscode-file://vscode-app/Applications/Visual%20Studio%20Code%20-%20Insiders.app/Contents/Resources/app/out/vs/workbench/workbench.desktop.main.js:2334:38425)

Yoyokrazy commented 5 months ago

update after trying to repro:

repro is EXTREMELY inconsistent, only been able to get the bug once on insiders, and never in OSS. When bugged:
- outline view entirely locks up, notebook entries overlay the placeholder as shown above in the screenshot. forces user to reload the window to fix
- error logs as shown above ^^
- potential memory leak in the render template? creating the scoped context keys seem to be related here: https://github.com/microsoft/vscode/blob/9e0b3f311a68dce476b6209519d5b1506077bbcb/src/vs/workbench/contrib/notebook/browser/contrib/outline/notebookOutline.ts#L160
- mem leak seems to be tied to the bug, absolutely no issues when the primary bug itself doesn't repro. multiple memory profiles reveal nothing out of the ordinary. need to profile when the bug presents again.

Yoyokrazy commented 5 months ago

tied to configuration change listeners maybe

Yoyokrazy commented 5 months ago

Still no consistent repro or solution after a debug session with peng, will need to put a bigger effort into this in the future, and look out for a consistent repro.

cc @joaomoreno Wondering if there's a way that we can make sure that the treeview can recover from this? Bit painful forcing a full reload. The treeview fails on a setSelection call and from that point the DOM node is fully present regardless of editor switching.

deepak1556 commented 5 months ago

@joaomoreno is OOF till next week, if this requires attention from him I suggest we move the issue to next milestone or the recovery milestone. I don't see any candidate label, please let me know otherwise.

shubhamv199 commented 5 months ago

the issue is still happening. Sometimes the outline is stuck and its view remains the same even if I open a new notebook with different content.

jorenham commented 5 months ago

I can confirm this (latest PopOS; Ubuntu 22.04, Linux 6.8.0 and code 1.88.0).

Once I open a notebook, the outline stops updating, and requires a full vscode restart. On opening a notebook, I see the following Window output:

2024-04-08 16:11:01.120 [error] TreeError [OutlinePane] Tree element not found: [object Object]: Error: TreeError [OutlinePane] Tree element not found: [object Object]
    at T.o (vscode-file://vscode-app/usr/share/code/resources/app/out/vs/workbench/workbench.desktop.main.js:192:29689)
    at T.getListIndex (vscode-file://vscode-app/usr/share/code/resources/app/out/vs/workbench/workbench.desktop.main.js:192:28692)
    at Y.getRelativeTop (vscode-file://vscode-app/usr/share/code/resources/app/out/vs/workbench/workbench.desktop.main.js:626:2556)
    at V (vscode-file://vscode-app/usr/share/code/resources/app/out/vs/workbench/workbench.desktop.main.js:2334:38326)
    at P.jc (vscode-file://vscode-app/usr/share/code/resources/app/out/vs/workbench/workbench.desktop.main.js:2334:38463)

jrieken commented 5 months ago

@Yoyokrazy should we track this as candidate? (assuming fix is in reason)

Yoyokrazy commented 5 months ago

@jrieken Yep, I think that's pretty fair. Given the only way out of the broken state is a full reload, it seems breaking enough (and a regression) to warrant candidate status.

Yoyokrazy commented 5 months ago

Easy repro:

ensure notebook.outline.showCodeCells is set to false (this is the default, but double check you haven't changed this)
create a notebook with only code cells
set outline mode to follow cursor
🐛 click into a code cell, treeview will attempt to reveal/highlight the entry however it is not found (filtered by NotebookCellOutline.getChildren)

Yoyokrazy commented 5 months ago

Description of issue (from PR) When outline view was set to follow cursor, the treeview will try to highlight the active entry in the outline view. After the latest iteration, users are now able to exclude a variety of cell types from the view. This filtering logic was shifted to the treeview's getChildren call in order to preserve the outline model for other computations (namely nb sticky scroll).

Easiest example is if the user excludes code cells (the default behavior), and then clicks a code cell. The treeview will attempt to highlight the entry, but as the cell was filtered out, there would be an error as the entry cannot be found. This breaks the outline view entirely, and the treeview cannot recover. Ideally this wouldn't force a reload, but this PR ensures that a notebook entry exclusion error will not break the view state.

rzhao271 commented 5 months ago

I confirmed that nothing shows up in the outline and no errors are thrown in the devtools console.

microsoft / vscode

Outline trying to reveal activeEntry when entry is filtered out #208923