Grab stats and libwebrtc logs from WebInspector directly

[youennf]

7533deb

Grab stats and libwebrtc logs from WebInspector directly
rdar://122803271
https://bugs.webkit.org/show_bug.cgi?id=269196

Reviewed by Eric Carlson and Devin Rousso.

To help web developpers, it is convenient to get access to WebRTC stats and logs.
We add a Web Inspector new function that allows to pass a JS callback to get those logs.
This can be extended in the future to rtc event logs as well.
This new function is called gatherRTCLogs and is only available in Web Inspector command line.

* LayoutTests/http/tests/inspector/gatherWebInspectorRTCLogs-expected.txt: Added.
* LayoutTests/http/tests/inspector/gatherWebInspectorRTCLogs.html: Added.
* LayoutTests/platform/glib/TestExpectations:
* LayoutTests/platform/mac-wk1/TestExpectations:
* Source/ThirdParty/libwebrtc/Configurations/libwebrtc.exp:
* Source/WebCore/CMakeLists.txt:
* Source/WebCore/DerivedSources-input.xcfilelist:
* Source/WebCore/DerivedSources-output.xcfilelist:
* Source/WebCore/DerivedSources.make:
* Source/WebCore/Modules/mediastream/PeerConnectionBackend.h:
(WebCore::PeerConnectionBackend::startGatheringStatLogs):
(WebCore::PeerConnectionBackend::stopGatheringStatLogs):
* Source/WebCore/Modules/mediastream/RTCController.cpp:
(WebCore::RTCController::RTCController):
(WebCore::RTCController::~RTCController):
(WebCore::RTCController::add):
(WebCore::RTCController::startGatheringLogs):
(WebCore::RTCController::stopGatheringLogs):
(WebCore::RTCController::startGatheringStatLogs):
(WebCore::RTCController::stopLoggingLibWebRTCLogs):
* Source/WebCore/Modules/mediastream/RTCController.h:
* Source/WebCore/Modules/mediastream/RTCPeerConnection.cpp:
(WebCore::RTCPeerConnection::startGatheringStatLogs):
(WebCore::RTCPeerConnection::stopGatheringStatLogs):
* Source/WebCore/Modules/mediastream/RTCPeerConnection.h:
* Source/WebCore/Modules/mediastream/libwebrtc/LibWebRTCMediaEndpoint.cpp:
(WebCore::RTCStatsLogger::toJSONString const):
(WebCore::LibWebRTCMediaEndpoint::OnStatsDelivered):
(WebCore::LibWebRTCMediaEndpoint::statsLogInterval const):
(WebCore::LibWebRTCMediaEndpoint::startRTCLogs):
(WebCore::LibWebRTCMediaEndpoint::stopRTCLogs):
* Source/WebCore/Modules/mediastream/libwebrtc/LibWebRTCMediaEndpoint.h:
* Source/WebCore/Modules/mediastream/libwebrtc/LibWebRTCPeerConnectionBackend.cpp:
(WebCore::LibWebRTCPeerConnectionBackend::startGatheringStatLogs):
(WebCore::LibWebRTCPeerConnectionBackend::stopGatheringStatLogs):
(WebCore::LibWebRTCPeerConnectionBackend::provideStatLogs):
* Source/WebCore/Modules/mediastream/libwebrtc/LibWebRTCPeerConnectionBackend.h:
* Source/WebCore/Sources.txt:
* Source/WebCore/WebCore.xcodeproj/project.pbxproj:
* Source/WebCore/dom/Document.cpp:
(WebCore::Document::startGatheringRTCLogs):
(WebCore::Document::stopGatheringRTCLogs):
* Source/WebCore/dom/Document.h:
* Source/WebCore/inspector/CommandLineAPIHost.cpp:
(WebCore::CommandLineAPIHost::gatherRTCLogs):
* Source/WebCore/inspector/CommandLineAPIHost.h:
* Source/WebCore/inspector/CommandLineAPIHost.idl:
* Source/WebCore/inspector/CommandLineAPIModuleSource.js:
(injectModule):
* Source/WebCore/inspector/RTCLogsCallback.h: Added.
* Source/WebCore/inspector/RTCLogsCallback.idl: Added.
* Source/WebCore/platform/SourcesLibWebRTC.txt:
* Source/WebCore/platform/mediastream/libwebrtc/LibWebRTCLogSink.cpp: Added.
(WebCore::LibWebRTCLogSink::LibWebRTCLogSink):
(WebCore::LibWebRTCLogSink::~LibWebRTCLogSink):
(WebCore::toWebRTCLogLevel):
(WebCore::LibWebRTCLogSink::logMessage):
(WebCore::LibWebRTCLogSink::start):
(WebCore::LibWebRTCLogSink::stop):
* Source/WebCore/platform/mediastream/libwebrtc/LibWebRTCLogSink.h: Added.
* Source/WebInspectorUI/UserInterface/Controllers/JavaScriptRuntimeCompletionProvider.js:
(WI.JavaScriptRuntimeCompletionProvider.get _commandLineAPIKeys):

Canonical link: https://commits.webkit.org/274946@main

6fdacdd

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 wincairo
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	✅ 🧪 ios-wk2-wpt	✅ 🧪 mac-wk1	✅ 🛠 gtk
	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 tv	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 api-gtk
	✅ 🛠 tv-sim	✅ 🧪 mac-wk2-stress
✅ 🛠 🧪 merge	✅ 🛠 watch
	✅ 🛠 watch-sim

[webkit-early-warning-system]

EWS run on previous version of this PR (hash 246987f)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	❌ 🛠 ios	❌ 🛠 mac	❌ 🛠 wpe	🛠 wincairo
✅ 🧪 bindings	❌ 🛠 ios-sim	❌ 🛠 mac-AS-debug	❌ 🧪 wpe-wk2
✅ 🧪 webkitperl	❌ 🧪 ios-wk2	❌ 🧪 api-mac	❌ 🧪 api-wpe
	❌ 🧪 ios-wk2-wpt	❌ 🧪 mac-wk1	❌ 🛠 gtk
🛠 🧪 jsc	❌ 🧪 api-ios	❌ 🧪 mac-wk2	❌ 🧪 gtk-wk2
✅ 🛠 🧪 jsc-arm64	🛠 tv	❌ 🧪 mac-AS-debug-wk2	❌ 🧪 api-gtk
	❌ 🛠 tv-sim	❌ 🧪 mac-wk2-stress	✅ 🛠 jsc-armv7
	🛠 watch		🧪 jsc-armv7-tests
	🛠 watch-sim

[webkit-early-warning-system]

EWS run on previous version of this PR (hash 1151853)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	❌ 🛠 wpe	❌ 🛠 wincairo
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	❌ 🧪 wpe-wk2
✅ 🧪 webkitperl	🧪 ios-wk2	🧪 api-mac	❌ 🧪 api-wpe
	⏳ 🧪 ios-wk2-wpt	🧪 mac-wk1	❌ 🛠 gtk
🛠 🧪 jsc	✅ 🧪 api-ios	🧪 mac-wk2	❌ 🧪 gtk-wk2
✅ 🛠 🧪 jsc-arm64	❌ 🛠 tv	🧪 mac-AS-debug-wk2	❌ 🧪 api-gtk
	❌ 🛠 tv-sim	🧪 mac-wk2-stress	✅ 🛠 jsc-armv7
	🛠 watch		🧪 jsc-armv7-tests
	🛠 watch-sim

[webkit-early-warning-system]

EWS run on previous version of this PR (hash ea27326)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	❌ 🛠 wpe	❌ 🛠 wincairo
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	❌ 🧪 wpe-wk2
✅ 🧪 webkitperl	🧪 ios-wk2	🧪 api-mac	❌ 🧪 api-wpe
	⏳ 🧪 ios-wk2-wpt	🧪 mac-wk1	❌ 🛠 gtk
✅ 🛠 🧪 jsc	✅ 🧪 api-ios	🧪 mac-wk2	❌ 🧪 gtk-wk2
✅ 🛠 🧪 jsc-arm64	❌ 🛠 tv	🧪 mac-AS-debug-wk2	❌ 🧪 api-gtk
	❌ 🛠 tv-sim	🧪 mac-wk2-stress	✅ 🛠 jsc-armv7
	🛠 watch		✅ 🧪 jsc-armv7-tests
	🛠 watch-sim

[webkit-early-warning-system]

EWS run on previous version of this PR (hash 19de337)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 wincairo
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	🧪 wpe-wk2
✅ 🧪 webkitperl	🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	⏳ 🧪 ios-wk2-wpt	🧪 mac-wk1	✅ 🛠 gtk
🛠 🧪 jsc	✅ 🧪 api-ios	🧪 mac-wk2	🧪 gtk-wk2
✅ 🛠 🧪 jsc-arm64	✅ 🛠 tv	🧪 mac-AS-debug-wk2	✅ 🧪 api-gtk
	✅ 🛠 tv-sim	✅ 🧪 mac-wk2-stress	✅ 🛠 jsc-armv7
	🛠 watch		🧪 jsc-armv7-tests
	🛠 watch-sim

[webkit-early-warning-system]

EWS run on previous version of this PR (hash a7fc526)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 wincairo
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	❌ 🧪 wpe-wk2
✅ 🧪 webkitperl	❌ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	🧪 ios-wk2-wpt	❌ 🧪 mac-wk1	✅ 🛠 gtk
✅ 🛠 🧪 jsc	✅ 🧪 api-ios	🧪 mac-wk2	❌ 🧪 gtk-wk2
✅ 🛠 🧪 jsc-arm64	✅ 🛠 tv	❌ 🧪 mac-AS-debug-wk2	✅ 🧪 api-gtk
	✅ 🛠 tv-sim	✅ 🧪 mac-wk2-stress	✅ 🛠 jsc-armv7
	🛠 watch		✅ 🧪 jsc-armv7-tests
	🛠 watch-sim

[webkit-early-warning-system]

EWS run on previous version of this PR (hash a388c40)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	❌ 🛠 wpe	✅ 🛠 wincairo
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	❌ 🧪 wpe-wk2
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	❌ 🧪 api-wpe
	✅ 🧪 ios-wk2-wpt	✅ 🧪 mac-wk1	❌ 🛠 gtk
✅ 🛠 🧪 jsc	✅ 🧪 api-ios	❌ 🧪 mac-wk2	❌ 🧪 gtk-wk2
✅ 🛠 🧪 jsc-arm64	✅ 🛠 tv	❌ 🧪 mac-AS-debug-wk2	❌ 🧪 api-gtk
	✅ 🛠 tv-sim	❌ 🧪 mac-wk2-stress	✅ 🛠 jsc-armv7
	✅ 🛠 watch		✅ 🧪 jsc-armv7-tests
	✅ 🛠 watch-sim

[dcrousso]

i realize this is still in draft, but just wanted to give you a heads up on a few things :)

the Console API is (somewhat) standardized, so if you want to add something to console i'd recommend creating a proposal (e.g. console.screenshot) and soliciting some feedback before proceeding too far with the implementation

also, generally speaking it's strongly preferred (and potentially actually required) that all console APIs do not reveal any information about whether Web Inspector is open or not as that could be used as a sort of denial-of-service attack against developers (e.g. removing content from the DOM if Web Inspector is opened). having a callback (even if it's not guaranteed how long it'll take to be invoked) would violate that concept, and therefore not be desirable

for what it's worth, this is why Web Inspector (as well as developer tooling in most other browsers) has special functions that are exposed when evaluating in the Console (e.g. the Console Command Line API), as that's a way of ensuring that the new functionality is only exposed within Web Inspector and initiated by the developer (since the page cannot access any of the specially exposed functions). i would strongly suggest considering this approach as it does require any sort of standardization and will not undesirably expose anything about Web Inspector

[youennf]

@dcrousso, thanks for looking into this.
The patch is using a private identifier so I would not expect JavaScript to be able to call console.gatherRTCLogs directly.
It should be similar to queryInstances for instance.
I used the page console client infrastructure for convenience, but I'll change this to directly use a JSDOMGlobalObject function.

[webkit-early-warning-system]

EWS run on previous version of this PR (hash 2f5589f)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 wincairo
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	⏳ 🧪 wpe-wk2
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	🧪 ios-wk2-wpt	✅ 🧪 mac-wk1	✅ 🛠 gtk
🛠 🧪 jsc	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🧪 gtk-wk2
✅ 🛠 🧪 jsc-arm64	✅ 🛠 tv	✅ 🧪 mac-AS-debug-wk2	⏳ 🧪 api-gtk
	✅ 🛠 tv-sim	✅ 🧪 mac-wk2-stress	✅ 🛠 jsc-armv7
	✅ 🛠 watch		❌ 🧪 jsc-armv7-tests
	🛠 watch-sim

[webkit-early-warning-system]

EWS run on previous version of this PR (hash 4dcb75e)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 wincairo
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	🧪 ios-wk2-wpt	✅ 🧪 mac-wk1	✅ 🛠 gtk
🛠 🧪 jsc	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🧪 gtk-wk2
✅ 🛠 🧪 jsc-arm64	✅ 🛠 tv	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 api-gtk
	✅ 🛠 tv-sim	✅ 🧪 mac-wk2-stress	✅ 🛠 jsc-armv7
	✅ 🛠 watch		❌ 🧪 jsc-armv7-tests
	✅ 🛠 watch-sim

[webkit-early-warning-system]

EWS run on previous version of this PR (hash 4bf0d09)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 wincairo
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	🧪 wpe-wk2
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	✅ 🧪 ios-wk2-wpt	✅ 🧪 mac-wk1	✅ 🛠 gtk
	✅ 🧪 api-ios	🧪 mac-wk2	❌ 🧪 gtk-wk2
	✅ 🛠 tv	❌ 🧪 mac-AS-debug-wk2	✅ 🧪 api-gtk
	✅ 🛠 tv-sim	❌ 🧪 mac-wk2-stress
	✅ 🛠 watch
	✅ 🛠 watch-sim

[webkit-early-warning-system]

EWS run on previous version of this PR (hash be4ef99)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 wincairo
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	❌ 🧪 wpe-wk2
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	✅ 🧪 ios-wk2-wpt	✅ 🧪 mac-wk1	✅ 🛠 gtk
	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 tv	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 api-gtk
	✅ 🛠 tv-sim	✅ 🧪 mac-wk2-stress
	✅ 🛠 watch
	✅ 🛠 watch-sim

[webkit-early-warning-system]

EWS run on previous version of this PR (hash 48ba0a8)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 wincairo
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	✅ 🧪 ios-wk2-wpt	✅ 🧪 mac-wk1	✅ 🛠 gtk
	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 tv	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 api-gtk
	✅ 🛠 tv-sim	✅ 🧪 mac-wk2-stress
	✅ 🛠 watch
	✅ 🛠 watch-sim

[eric-carlson]

r+ given Devin's previous reviews

[dcrousso]

r=me for the Web Inspector bits. thanks for iterating on this with me :)

[dcrousso]

we may want to conditionalize this just in case ENABLE_WEB_RTC is false

so either this

if (CommandLineAPIHost.gatherRTCLogs) {
    CommandLineAPI.methods["gatherRTCLogs"] = function(callback) {
        return CommandLineAPIHost.gatherRTCLogs(callback);
    };
}

or this

CommandLineAPI.methods["gatherRTCLogs"] = function(callback) {
    return CommandLineAPIHost.gatherRTCLogs?.(callback);
};

[youennf]

Done

[webkit-early-warning-system]

EWS run on current version of this PR (hash 6fdacdd)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 wincairo
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	✅ 🧪 ios-wk2-wpt	✅ 🧪 mac-wk1	✅ 🛠 gtk
	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 tv	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 api-gtk
	✅ 🛠 tv-sim	✅ 🧪 mac-wk2-stress
✅ 🛠 🧪 merge	✅ 🛠 watch
	✅ 🛠 watch-sim

[webkit-commit-queue]

Committed 274946@main (7533deb): https://commits.webkit.org/274946@main

Reviewed commits have been landed. Closing PR #24330 and removing active labels.