1542170 - Map HTTP upgrade request to WS connection/frames

Status: RESOLVED FIXED

(Core :: Networking: WebSockets, enhancement, P2)

Description

[Hengyeow (:tanhengyeow)]

User Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.86 Safari/537.36

Steps to reproduce:

When a new HTTP request is created, it is assigned a channel with a channelId as seen here.

Description of the spec can be seen here.

As an initiative to support Bug 885508, the plan is to show WS frames for upgraded HTTP requests in Netmonitor. As such, we might want to have platform support available to map upgraded HTTP requests with the WS frames under the same channel.

One possible approach is to accept another parameter (possibly the channelId of the upgraded HTTP request) in functions of the interface nsIWebSocketEventListener e.g. webSocketCreated.

Through this way, DevTools would be able to correlate the upgraded HTTP request with its associated WS frames and show them accordingly.

Comment 1

[Jan Honza Odvarko [:Honza] (always need-info? me)]

:baku, this bug report is related to my question I sent on Slack.

Honza

Comment 2

[Jan Honza Odvarko [:Honza] (always need-info? me)]

From comment #0

One possible approach is to accept another parameter (possibly the channelId of the upgraded HTTP request) in functions of the interface nsIWebSocketEventListener e.g. webSocketCreated.

This looks promising.

I was quickly looking at the code base and found this place:
https://searchfox.org/mozilla-central/rev/dd7e27f4a805e4115d0dbee70e1220b23b23c567/dom/websocket/WebSocket.cpp#1395

// Let's inform devtools about this new active WebSocket.
webSocket->mImpl->mService->WebSocketCreated(
    webSocket->mImpl->mChannel->Serial(), webSocket->mImpl->mInnerWindowID,
    webSocket->mURI, webSocket->mImpl->mRequestedProtocolList);

It looks like we could use mHttpChannel from webSocket->mImpl.

mHttpChannel is defined here:
https://searchfox.org/mozilla-central/rev/dd7e27f4a805e4115d0dbee70e1220b23b23c567/netwerk/protocol/websocket/WebSocketChannel.h#199

So, something like as follows:

// Let's inform devtools about this new active WebSocket.
webSocket->mImpl->mService->WebSocketCreated(
    webSocket->mImpl->mChannel->Serial(), webSocket->mImpl->mInnerWindowID,
    webSocket->mURI, webSocket->mImpl->mRequestedProtocolList,
    webSocket->mImpl->mHttpChannel->channelId);

Does that make sense?

Honza

Comment 3

[Andrea Marchesini [:baku]]

Yes, this is correct. Honza, do you know who can work on this? I don't have time to work on this at the moment.
How urgent is it?

Comment 4

[Jan Honza Odvarko [:Honza] (always need-info? me)]

This is needed for GSoC 2019 project, so it should ideally land in 69 Nightly around May 6
(the merge date is May 13, so could be one week later for 69)

Would that be enough time for you?

Honza

Comment 5

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Changing the target component.

Honza

Comment 6

[Andrea Marchesini [:baku]]

Attachment: Bug 1542170 - Introduce nsIWebSocketChannel.httpChannelId, r?valentin

Comment 7

[Andrea Marchesini [:baku]]

Attachment: Bug 1542170 - Expose http channel Id to WebSocketEvent listeners, r?valentin

Depends on D28864

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/24a453261a2e
Introduce nsIWebSocketChannel.httpChannelId, r=valentin
https://hg.mozilla.org/integration/autoland/rev/87fbdfa81895
Expose http channel Id to WebSocketEvent listeners, r=valentin

Comment 10

[Alexandru Michis [:malexandru]]

https://hg.mozilla.org/mozilla-central/rev/24a453261a2e
https://hg.mozilla.org/mozilla-central/rev/87fbdfa81895