874381 - [meta][SessionStore] Clean up and document session restore

Status: NEW

(Firefox :: Session Restore, defect)

Description

[David Teller [:Yoric] - still alive but not very active]

The state of Session Restore contains a number of fragile and undocumented fields. Opening this bug to track cleanups.

Comment 1

[YUKI "Piro" Hiroshi]

Some "__SS_*" properties still there.

 * window.__SSi
 * window.__SS_restoreID
 * window.__SS_tabsToRestore
 * window.__SS_lastSessionWindowID
 * tab.linkedBrowser.__SS_restore_data
 * tab.linkedBrowser.__SS_restore_pageStyle
 * tab.linkedBrowser.__SS_restore_tab
 * tab.linkedBrowser.__SS_formDataSaved
 * tab.linkedBrowser.__SS_hostSchemeData
 * tab.linkedBrowser.__SS_broken_history
 * tab.linkedBrowser.__SS_extdata
 * tab.linkedBrowser.__SS_shistoryListener

Are there existing bugs for them?

Comment 2

[Michael Kraft [:morac]]

My addon uses windows.__SSi to match session data to it's associated window.  If that is removed, there should be some way to still get that value.

Comment 3

[David Teller [:Yoric] - still alive but not very active]

(In reply to YUKI "Piro" Hiroshi from comment #1)
> Some "__SS_*" properties still there.

We'll open bugs progressively.

(In reply to Michael Kraft [:morac] from comment #2)
> My addon uses windows.__SSi to match session data to it's associated window.
> If that is removed, there should be some way to still get that value.

I don't understand your sentence. What are you matching, exactly?
Note that __SSi will not disappear immediately – actually, it might be the last one to disappear.

Comment 4

[Michael Kraft [:morac]]

(In reply to David Rajchenbach Teller [:Yoric] from comment #3)
> I don't understand your sentence. What are you matching, exactly?
> Note that __SSi will not disappear immediately – actually, it might be the
> last one to disappear.

I use it as a window identifier since it's always set and unique, in addition to matching Windows to window session data. I suppose I can create my own unique window identifier though.

Comment 5

[David Teller [:Yoric] - still alive but not very active]

In our various patches, we are using WeakMap for this kind of use. Would this work for you, morac?

Comment 6

[Michael Kraft [:morac]]

(In reply to David Rajchenbach Teller [:Yoric] from comment #5)
> In our various patches, we are using WeakMap for this kind of use. Would
> this work for you, morac?

As long as it's readable and set and cleared properly, that will work.

Comment 7

[Tim Taubert [:ttaubert] (inactive)]

(In reply to Michael Kraft [:morac] from comment #6)
> (In reply to David Rajchenbach Teller [:Yoric] from comment #5)
> > In our various patches, we are using WeakMap for this kind of use. Would
> > this work for you, morac?
> 
> As long as it's readable and set and cleared properly, that will work.

I think David was saying that you might want to look into using this inside your add-on to map data to windows. We might end up using this in SessionStore too but we would not want to expose it unless really necessary.

Comment 8

[Tim Taubert [:ttaubert] (inactive)]

Anyway, please let's not turn this into a discussion forum. This is a meta bug for tracking progress. Once we attack __SSi we can deal with details in the specific bug and can handle bigger discussions on the mailing lists.