Cleanup widgets and side effects on context invalidated (reload, update)

[fregante]

Follows:

• #4190: Fix content script readiness race conditions and context invalidation handling #4240

Pixiebrix does a good job at cleaning up the buttons across reloads, but some parts remain. This is probably mostly a DX issue meant to ensure PB developers don't lose their minds while debugging Schrödinger's bugs. 😅

kbar

kbar remains attached and sometimes it conflicts with itself, appearing multiple times on a single keystroke.

Element picker overlay (✅ addressed by #4488)

Elements may remain selected when closing the editor as well, and no way to deselect them.

Sidebar (partially addressed by #4117)

It remains unconnectable until the user manually reloads it. An ErrorBanner component with reload button would be helpful.

Solution

• Use onContextInvalidated in more places, perhaps wrapped in a React hook if preferred
• Detect stuck sidebars in the content script instead of reporting "Sidebar not found" messenger errors while the sidebar is on screen

[fregante]

I think this is another side effect that isn't being cleaned up. I don't know how I got to this point, but you can see that there are 3 main "events" here, each of which produce like 9 logs:

[BLoe]

@grahamlangford Worth some investigation here to re-scope, I think some of this has been fixed already, but there might be other, newer examples of the same sort of issue, like #5441 for example is a vaguely similar sort of problem

[fregante]

Also a UX issue experienced by Brandon and Corinne, presumably on Triggers that don't deactivate and keep showing the "PB restarted" notification over and over:

• https://pixiebrix.slack.com/archives/C042CA15AKS/p1688739007307009

[fregante]

I found another issue for context menus:

Repro seems to be:

1. Visit https://pbx.vercel.app/navigation
2. Create context menu mod
3. Reload extension on chrome://extensions
4. Click #hash-2

[BLoe]

@fregante I've been seeing that error a ton on my gmail inbox page as well

[fregante]

It's due to the URL change / ajax navigations.

This is likely a consequence of:

• #6649: Avoid background messaging to handle AJAX page updates #7030

Before that PR, the URL changes were managed by the background page, which was killed on a reload so the content script no longer received those updates.

After that PR, the content script lives on. I'll open a PR to stop the listener onContextInvalidated

[fregante]

I don't know yet which trigger is causing this, but I'm starting to see this message every time the extension is reloaded. The page doesn't really have anything going on, so the user should not be informed of this.

I'll look into what's triggering it and how to clean up the listener.

[fregante]

I think we're good for now. If you see anything else sticking around, please reopen

[fregante]

TriggerExtensionPoint:eventHandler isn't removed

[fregante]

Also the modal stays open and is unclosable. I pushed it but other stuff took priority:

• https://github.com/pixiebrix/pixiebrix-extension/tree/F/bug/close-modals-after-invalidation

Screen.Recording.6.mov