1622857 - Internal preference for logging RDP request/response packets

Status: RESOLVED FIXED

(DevTools :: Framework, enhancement, P4)

Comment 1

[Alexandre Poirot [:ochameau]]

We might reuse the existing preferences:
devtools.debugger.log devtools.debugger.log.verbose
https://searchfox.org/mozilla-central/search?q=devtools.debugger.log&path=
Which are mapped to flags.wantLogging:
https://searchfox.org/mozilla-central/search?q=wantLogging&case=true&regexp=false&path=devtools
And flags.wantVerbose:
https://searchfox.org/mozilla-central/search?q=wantLogging&case=true&regexp=false&path=devtools

Comment 2

[Alexandre Poirot [:ochameau]]

The RDP packets can still be logged via devtools.debugger.log preference
which turns the flags.wantLogging flag to true and enables the following logs:
https://searchfox.org/firefox-main/search?q=wantLogging&path=transport&case=true&regexp=false
While devtools.debugger.log.verbose pref, enabled these other logs:
https://searchfox.org/firefox-main/search?q=wantLogging&path=transport&case=true&regexp=false

These logs are imperfect, as I think they aren't necessarily logging both inbound and outbound packets.
The verbose helps see more information, but it is only interesting when you care about packet headers, which are super low level and not interesting when you care only about JSON objects.

These stdout logs only works if you also have browser.dom.window.dump.enabled preference set to true, which is a common puzzling issue on release builds where this pref is false (it is true on local builds).

It might be nice to move these logs to MOZ_LOG, the generic logging mechanism used in C++, but now also available in JS.
These is some documentation over here.
The overall idea would be to replace dump methods with:

const logger = console.createInstance({ prefix: "devtools_rdp" });
logger.log(rdpPacket); // Or stringify rdpPacket nicely if stdout logging of the JSON packet isn't nice with stdout logging

so that you can see more easily see the logs in stdout by running firefox like this:

$ MOZ_LOG=devtools_rdp:5 ./firefox  (or ./mach run)

The benefits are that:

• you no longer need any preference to see the logs on stdout,
• you can easily control which logs you want to see from the command line,
• the logs can also be seen in the browser console/toolbox.

Working on this would be a nice step forward re-introducing a RDP inspector UI (UI to see all incoming/outcoming packets).

Comment 3

[Alexandre Poirot [:ochameau]]

Lorenz, some improvement recently landed around MOZ_LOG which makes comment 2 suggestion much more actionable.
Are you still interested in contributing something to help seeing RDP packets?

Comment 4

[Alexandre Poirot [:ochameau]]

Attachment: WIP: Bug 1622857 - [devtools] Log RDP packets via MOZ_LOG.

RDP can be easily traced via stdout by running:
$ MOZ_LOG="devtools_rdp:5" ./mach run

Comment 5

[Alexandre Poirot [:ochameau]]

Attachment: Bug 1622857 - [devtools] Log RDP packets via MOZ_LOG. r=#devtools

RDP can be easily traced via stdout by running:
$ MOZ_LOG="devtools_rdp:5" ./mach run

Comment 6

[Alexandre Poirot [:ochameau]]

Attachment: Bug 1622857 - [devtools] Highlights pairs of outgoing/incoming RDP packets in MOZ_LOG output. r=#devtools

Comment 7

[Alexandre Poirot [:ochameau]]

Attachment: Bug 1622857 - [devtools] Use MOZ_LOG to trace RDP packets in tests. r=#devtools

Also remove disabled/commented logging.
You may use "--env MOZ_LOG=devtools_rdp:5" to trace RDP packets on try runs.
Some tests are still toggling the old preference as they may want to
trace other usages of dumpn/dumpv.

Comment 8

[Alexandre Poirot [:ochameau]]

Attachment: Bug 1622857 - [devtools] Migrate transport layer to MOZ_LOG. r=#devtools

Comment 9

[Alexandre Poirot [:ochameau]]

Attachment: Bug 1622857 - [devtools] Use a console instance for logging DevToolsWorker messages. r=#devtools

This the last usage of "wantVerbose" flag.

Comment 10

[Alexandre Poirot [:ochameau]]

Attachment: Bug 1622857 - [devtools] Remove now unused dumpv/verbose logging logic. r=#devtools

The transport layer was the only one using this.

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/9c63514236db
https://hg.mozilla.org/integration/autoland/rev/8eac666269fa
[devtools] Log RDP packets via MOZ_LOG. r=devtools-reviewers,jdescottes,nchevobbe
https://github.com/mozilla-firefox/firefox/commit/5e8593b7bc21
https://hg.mozilla.org/integration/autoland/rev/c5b50edc9155
[devtools] Highlights pairs of outgoing/incoming RDP packets in MOZ_LOG output. r=devtools-reviewers,nchevobbe
https://github.com/mozilla-firefox/firefox/commit/3af4a6d2ad5a
https://hg.mozilla.org/integration/autoland/rev/33dd4f7f8e4c
[devtools] Use MOZ_LOG to trace RDP packets in tests. r=devtools-reviewers,nchevobbe
https://github.com/mozilla-firefox/firefox/commit/0b0b73d5a978
https://hg.mozilla.org/integration/autoland/rev/4d8e40b8c487
[devtools] Migrate transport layer to MOZ_LOG. r=devtools-reviewers,nchevobbe
https://github.com/mozilla-firefox/firefox/commit/ff764d01fd1d
https://hg.mozilla.org/integration/autoland/rev/a640941015ab
[devtools] Use a console instance for logging DevToolsWorker messages. r=devtools-reviewers,nchevobbe
https://github.com/mozilla-firefox/firefox/commit/81fd28204b0e
https://hg.mozilla.org/integration/autoland/rev/d3f55800bbc2
[devtools] Remove now unused dumpv/verbose logging logic. r=devtools-reviewers,nchevobbe

Comment 12

[Serban Stanca [:SerbanS]]

https://hg.mozilla.org/mozilla-central/rev/8eac666269fa
https://hg.mozilla.org/mozilla-central/rev/c5b50edc9155
https://hg.mozilla.org/mozilla-central/rev/33dd4f7f8e4c
https://hg.mozilla.org/mozilla-central/rev/4d8e40b8c487
https://hg.mozilla.org/mozilla-central/rev/a640941015ab
https://hg.mozilla.org/mozilla-central/rev/d3f55800bbc2