Closed Bug 1597509 Opened 1 year ago Closed 3 months ago

Audit nsIDocShellTreeItem usage in mozilla::widget::WidgetUtils::DOMWindowToWidget in widget/SharedWidgetUtils.cpp

Categories

(Core :: Widget, defect)

defect
Not set
normal

Tracking

()

RESOLVED WORKSFORME
Fission Milestone M6c

People

(Reporter: djvj, Unassigned)

References

(Blocks 1 open bug)

Details

(Whiteboard: [rm-docshell-tree-item:simple])

In file widget/SharedWidgetUtils.cpp

Walks up the docshell tree, looking for a window with an associated widget.

https://searchfox.org/mozilla-central/rev/6566d92dd46417a2f57e75c515135ebe84c9cef5/widget/SharedWidgetUtils.cpp#38

A cursory audit of the users seems to indicate that this should only be invoked in either chrome code, or situations where the top-level window is in-process.

Should be fine to change this to using BrowsingContext to walk up the tree, asserting that all items along the way are in-process, and otherwise leaving the logic the same.

Kannan says replacing nsIDocShellTreeItem calls should block enabling Fission in Nightly (M6).

Fission Milestone: --- → M6
Priority: -- → P3

Moving to Widget.

Please audit this use of the nsIDocShellTreeItem interface. With Fission enabled, Documents and nsDocShells for related frames, such as subframes and parent documents, may not be available within the current process and the corresponding nsIDocShellTreeItem methods will return null

If this code works as-is with Fission, we don't need to remove this usage of nsIDocShellTreeItem until when we remove nsIDocShellTreeItem entirely (bug 1607591) after we ship Fission MVP.

Fission documentation about replacing nsIDocShellTree Item:
https://wiki.mozilla.org/Project_Fission/DocShell_Tree_Replace

:farre's presentation with examples of replacing nsIDocShellTreeItem with BrowsingContext, WindowContext, SyncedContexts, and BrowsingContextGroup:
https://docs.google.com/presentation/d/1K4j6ngty64TZjJNS5qH-MBoOm3TI2dJedVsbH8jUhKE/edit#slide=id.g6e35225e5d_1_264

Component: DOM: Navigation → Widget
Priority: P3 → --
Summary: Fix uses of mozilla::widget::WidgetUtils::DOMWindowToWidget in widget/SharedWidgetUtils.cpp → Audit nsIDocShellTreeItem usage in mozilla::widget::WidgetUtils::DOMWindowToWidget in widget/SharedWidgetUtils.cpp

Jim, someone with Widget experience will need to triage this bug and audit this code.

Flags: needinfo?(jmathies)

Auditing whether this use of nsIDocShellTreeItem breaks when Fission is enabled blocks Fission Nightly.

Fission Milestone: M6 → M6c
Flags: needinfo?(jmathies)

Each BrowserChild has it's own PuppetWidget, meaning this probably works OK as-is so needs no changes for Fission. Jim, can you confirm?

Flags: needinfo?(jmathies)

This should work OK as-is for Fission, so we shouldn't need to change anything.

Status: NEW → RESOLVED
Closed: 3 months ago
Flags: needinfo?(jmathies)
Resolution: --- → WORKSFORME
You need to log in before you can comment on or make changes to this bug.