Closed Bug 1643175 Opened 4 years ago Closed 4 years ago

Fission JSWindowActor observer documentation does not accurately reflect how observers work

Categories

(Core :: DOM: Content Processes, task, P3)

task

Tracking

()

RESOLVED FIXED
mozilla79
Fission Milestone M6b
Tracking Status
firefox79 --- fixed

People

(Reporter: Gijs, Assigned: Gijs)

Details

Attachments

(1 file)

The docs say:

Next, we declare that ``PluginChild`` should observe the ``decoder-doctor-notification`` 
``nsIObserver`` notification. When that observer notification fires, the ``PluginChild`` will be
 instantiated for all ``BrowsingContext``'s, and the ``observe`` method on the ``PluginChild`` 
implementation will be called.

This is not correct, and omits some crucial info. See the implementation in the protocol: https://searchfox.org/mozilla-central/rev/7cadba1d8b8feaec4615f5bb98aac4b8a719793c/dom/ipc/JSWindowActorProtocol.cpp#206-223

bug 1526406 and bug 1563597 implemented observer support in such a way that only observer notifications that have a subject of an inner or outer window can be observed using this mechanism, and we will only instantiate the child actor for the relevant window.

This should be documented accurately.

Yoric, since you're familiar with JSWindowActor, can you please fix the JSWindowActor documentation about observers?

This isn't urgent, but it would help other Firefox developers if our docs were up to date before they need to work on Fission. :)

Type: defect → task
Fission Milestone: --- → M6b
Flags: needinfo?(dteller)
Priority: -- → P3
Assignee: nobody → gijskruitbosch+bugs
Status: NEW → ASSIGNED

(In reply to Chris Peterson [:cpeterson] from comment #1)

Yoric, since you're familiar with JSWindowActor, can you please fix the JSWindowActor documentation about observers?

This isn't urgent, but it would help other Firefox developers if our docs were up to date before they need to work on Fission. :)

Sorry, I missed this comment while I was working on this, and then submitted... Yoric, please feel free to review the doc update that I put up... :-)

No problem. You're more familiar with the use of JSWindowActor than me :)

Flags: needinfo?(dteller)
Pushed by gijskruitbosch@gmail.com:
https://hg.mozilla.org/integration/autoland/rev/f787820067a1
update documentation about JSWindowActor's observers list, r=Yoric
Status: ASSIGNED → RESOLVED
Closed: 4 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla79
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: