1842895 - The SessionStoreInternal _closedTabs and _closedWindowTabs are confusingly named

Status: RESOLVED FIXED

(Firefox :: Session Restore, task)

Description

[Sam Foster [:sfoster] (he/him)]

We have these two weakmaps SessionStoreInternal._closedTabs and SessionStoreInternal._closedWindowTabs that are used to capture finalizing state that happens async as a window or tab is closed (AIUI.) They both use a browser.permanentKey as the key to lookup a tab or closedTabs collection respectively, and this entry is ephemeral - existing only to bridge the moment when the tab or window is closing, and the unload events are received and state is finalized.

Given the other work we have in-flight around closed tabs and closed windows, what used to be conveniently short property names are now a real source of potential confusion. I'd like to rename them to better reflect their purpose. This would be refactoring internal to SessionStore and have no impact on any of the callers.

Comment 1

[Sam Foster [:sfoster] (he/him)]

Maybe something like?

• _closedTabs => _browserToClosingTabMap
• _closedWindowTabs => _browserToClosingWindowClosedTabsMap

Comment 2

[Sam Foster [:sfoster] (he/him)]

hg blame suggests you might have an informed opinion here :mconley?

Comment 3

[Mike Conley (:mconley) (:⚙️)]

Hoooo boy this is a blast from the past.

So to me, some of the subtlety here is the difference between a tab closed on its own or a tab closed because it was in a window that also closed. If we can capture that in the naming, that might be best. I do like using closing here though to properly represent how they're ephemeral.

Maybe:

• _closedTabs => _browserToClosingTabMap
• _closedWindowTabs => _browserToTabClosingByWindowMap?

Naming is hard. :/

Comment 4

[Sam Foster [:sfoster] (he/him)]

Attachment: Bug 1842895 - Rename SessionStoreInternal._closedTabs and _closedWindowTabs to differentiate from other closedTabs collections. r?sclements!

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/62e9b36475c9
Rename SessionStoreInternal._closedTabs and _closedWindowTabs to differentiate from other closedTabs collections. r=sessionstore-reviewers,sclements

Comment 6

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/mozilla-central/rev/62e9b36475c9