1625955 - Use the ResourceWatcher API to fetch WebSocket data

Status: RESOLVED FIXED

(DevTools :: Netmonitor, task, P2)

Description

[Alexandre Poirot [:ochameau]]

Bug 1576624 introduced the ResourceWatcher API, accessible via toolbox.resourceWatcher. This API will help listen to data that is being created early, when the document just started loading.

We should migrate the whole DevTools codebase to this API for any data that:

• DevTools frontend listen to, or care about,
  and,
• may be created or be notified early, when the document just starts being loaded.
  This data will typically be: console messages, errors, warnings, sources, Root element NodeFront, storage values, network events, stylesheets, ...

We are typically not going to use this API for:

• data being fetched on-demand, from user's input. For ex: webconsole evaluation input, or, DOM element expands from the Markup view.
• events which we only want to record when the user cares about them. For ex: animation events.

For some more high level context, please have a look at Migration to Fission-compatible APIs, which describes all Fission-related refactorings.

The typical task for this bug will be about migrating code that:

• start listening and register a RDP event listener,
• retrieve already existings data,
  from panel's codebase, to the ResourceWatcher module, in the LegacyListener object.
  And then, the panel should use the ResourceWatcher instead.

Bug 1620234 is a good example of such migration, applied to Console Messages.
Bug 1623699 is also useful example as it demonstrates how to write tests for such migration.

This bug is about focusing on only one usecase: the WebSocket data.

We start listening for data, and listen for RDP events from here:
https://searchfox.org/mozilla-central/rev/9c6e7500c0015a2c60be7b1b888261d95095ce27/devtools/client/netmonitor/src/connector/firefox-connector.js#159-172

We may have 2 or 3 kinds of resources here:

• WebSocket
• WebSocketFrame
  • WebSocketReveivedFrame
  • WebSocketSentFrame

The websocket open and close should not be two kinds of resource. open will be when the WebSocket resource is "available", and close when it is "destroyed".
As of today, the ResourceWatcher doesn't support "destroyed", but some other parallel bugs are having this requirement as well.

Comment 1

[Chris Peterson [:cpeterson]]

Tracking Fission DevTools bugs for Fission Nightly (M6) milestone

Comment 2

[Chris Peterson [:cpeterson]]

Tracking dt-fission-m2-mvp bugs for Fission Nightly milestone (M6c)

Comment 3

[Daisuke Akatsuka (:daisuke)]

Attachment: Bug 1625955: Implement ResourceWatcher for WebSocket.

Comment 4

[Daisuke Akatsuka (:daisuke)]

Attachment: Bug 1625955: Apply WebSocket ResourceWatcher to firefox connector.

Depends on D83480

Comment 5

[Daisuke Akatsuka (:daisuke)]

Attachment: Bug 1625955: Add a test for ResourceWatcher for websocket.

Depends on D83481

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e4b2a82aa0e3
Implement ResourceWatcher for WebSocket. r=bomsy,jdescottes
https://hg.mozilla.org/integration/autoland/rev/a39a41b8b0b5
Apply WebSocket ResourceWatcher to firefox connector. r=bomsy,jdescottes
https://hg.mozilla.org/integration/autoland/rev/56082fc4acfa
Add a test for ResourceWatcher for websocket. r=bomsy,jdescottes

Comment 7

[Alexandru Michis [:malexandru]]

https://hg.mozilla.org/mozilla-central/rev/e4b2a82aa0e3
https://hg.mozilla.org/mozilla-central/rev/a39a41b8b0b5
https://hg.mozilla.org/mozilla-central/rev/56082fc4acfa