navigator.mediaCapabilities wrapper should not become GC-collectable before its navigator object

https://bugs.webkit.org/show_bug.cgi?id=315684

Reviewed by Ryosuke Niwa.

navigator.mediaCapabilities wrapper should not become GC-collectable before its navigator object.
The MediaCapabilities interface is annotated [SameObject] in the spec:
https://www.w3.org/TR/media-capabilities/#idl-index
It means that navigator.mediaCapabilities must return the same object on every access.

See: WebPlatformForEmbedded/WPEWebKit#1678

Original author: Andrzej Surdej (https://github.com/asurdej-comcast)

Updated existing LayoutTest with mediaCapabilities case.

* LayoutTests/fast/dom/navigator-property-gc-after-frame-detach-expected.txt:
* LayoutTests/fast/dom/navigator-property-gc-after-frame-detach.html:
* Source/WebCore/Modules/mediacapabilities/MediaCapabilities.cpp:
(WebCore::MediaCapabilities::MediaCapabilities):
(WebCore::MediaCapabilities::navigator):
* Source/WebCore/Modules/mediacapabilities/MediaCapabilities.h:
(WebCore::MediaCapabilities::create):
* Source/WebCore/Modules/mediacapabilities/MediaCapabilities.idl:
* Source/WebCore/Modules/mediacapabilities/NavigatorMediaCapabilities.cpp:
(WebCore::NavigatorMediaCapabilities::NavigatorMediaCapabilities):
(WebCore::NavigatorMediaCapabilities::from):
* Source/WebCore/Modules/mediacapabilities/NavigatorMediaCapabilities.h:
* Source/WebCore/Modules/mediacapabilities/WorkerNavigatorMediaCapabilities.cpp:
(WebCore::WorkerNavigatorMediaCapabilities::WorkerNavigatorMediaCapabilities):
(WebCore::WorkerNavigatorMediaCapabilities::from):
* Source/WebCore/Modules/mediacapabilities/WorkerNavigatorMediaCapabilities.h:

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

Author: pgorszkowski-igalia

LayoutTests/fast/dom/navigator-property-gc-after-frame-detach-expected.txt

@@ -3,16 +3,19 @@ Tests that Navigator properties do not get GC'd before their Navigator object.
 On success, you will see a series of "PASS" messages, followed by "TEST COMPLETE".
 
 
+PASS frameNavigator.mediaCapabilities.foo is 1
 PASS frameNavigator.geolocation.foo is 1
 PASS frameNavigator.mimeTypes.foo is 1
 PASS frameNavigator.plugins.foo is 1
 PASS frameNavigator.serviceWorker.foo is 1
 
+PASS frameNavigator.mediaCapabilities.foo is 1
 PASS frameNavigator.geolocation.foo is 1
 PASS frameNavigator.mimeTypes.foo is 1
 PASS frameNavigator.plugins.foo is 1
 PASS frameNavigator.serviceWorker.foo is 1
 
+PASS frameNavigator.mediaCapabilities.foo is 1
 PASS frameNavigator.geolocation.foo is 1
 PASS frameNavigator.mimeTypes.foo is 1
 PASS frameNavigator.plugins.foo is 1

LayoutTests/fast/dom/navigator-property-gc-after-frame-detach.html

@@ -7,7 +7,7 @@
 description("Tests that Navigator properties do not get GC'd before their Navigator object.");
 jsTestIsAsync = true;
 
-var navigatorProperties = [ "geolocation", "mimeTypes", "plugins" ];
+var navigatorProperties = [ "mediaCapabilities", "geolocation", "mimeTypes", "plugins" ];
 if (navigator.serviceWorker)
     navigatorProperties.push("serviceWorker");
 

Source/WebCore/Modules/mediacapabilities/MediaCapabilities.cpp

@@ -48,6 +48,16 @@
 
 namespace WebCore {
 
+MediaCapabilities::MediaCapabilities(NavigatorBase& navigator)
+    : m_navigator(navigator)
+{
+}
+
+NavigatorBase* MediaCapabilities::navigator()
+{
+    return m_navigator.get();
+}
+
 static bool isValidMediaMIMEType(const ContentType& contentType)
 {
     // A "bucket" MIME types is one whose container type does not uniquely specify a codec.

Source/WebCore/Modules/mediacapabilities/MediaCapabilities.h

@@ -33,20 +33,24 @@
 namespace WebCore {
 
 class DeferredPromise;
+class NavigatorBase;
 class ScriptExecutionContext;
 struct MediaDecodingConfiguration;
 struct MediaEncodingConfiguration;
 
 class MediaCapabilities : public RefCountedAndCanMakeWeakPtr<MediaCapabilities> {
 public:
-    static Ref<MediaCapabilities> create() { return adoptRef(*new MediaCapabilities); }
+    static Ref<MediaCapabilities> create(NavigatorBase& navigator) { return adoptRef(*new MediaCapabilities(navigator)); }
+
+    NavigatorBase* navigator();
 
     void decodingInfo(ScriptExecutionContext&, MediaDecodingConfiguration&&, Ref<DeferredPromise>&&);
     void encodingInfo(ScriptExecutionContext&, MediaEncodingConfiguration&&, Ref<DeferredPromise>&&);
 
 private:
-    MediaCapabilities() = default;
+    explicit MediaCapabilities(NavigatorBase&);
 
+    WeakPtr<NavigatorBase> m_navigator;
     uint64_t m_nextTaskIdentifier { 0 };
     HashMap<uint64_t, PlatformMediaEngineConfigurationFactory::DecodingConfigurationCallback> m_decodingTasks;
     HashMap<uint64_t, PlatformMediaEngineConfigurationFactory::EncodingConfigurationCallback> m_encodingTasks;

Source/WebCore/Modules/mediacapabilities/MediaCapabilities.idl

@@ -26,7 +26,8 @@
 // https://w3c.github.io/media-capabilities/#media-capabilities-interface
 [
     EnabledBySetting=MediaCapabilitiesEnabled,
-    Exposed=(Window,DedicatedWorker)
+    Exposed=(Window,DedicatedWorker),
+    GenerateIsReachable=ReachableFromNavigator
 ] interface MediaCapabilities {
     [CallWith=CurrentScriptExecutionContext] Promise<MediaCapabilitiesDecodingInfo> decodingInfo(MediaDecodingConfiguration configuration);
     [CallWith=CurrentScriptExecutionContext] Promise<MediaCapabilitiesEncodingInfo> encodingInfo(MediaEncodingConfiguration configuration);

Source/WebCore/Modules/mediacapabilities/NavigatorMediaCapabilities.cpp

@@ -34,8 +34,8 @@ namespace WebCore {
 
 WTF_MAKE_TZONE_ALLOCATED_IMPL(NavigatorMediaCapabilities);
 
-NavigatorMediaCapabilities::NavigatorMediaCapabilities()
-    : m_mediaCapabilities(MediaCapabilities::create())
+NavigatorMediaCapabilities::NavigatorMediaCapabilities(Navigator& navigator)
+    : m_mediaCapabilities(MediaCapabilities::create(navigator))
 {
 }
 
@@ -45,7 +45,7 @@ NavigatorMediaCapabilities& NavigatorMediaCapabilities::from(Navigator& navigato
 {
     auto* supplement = downcast<NavigatorMediaCapabilities>(Supplement<Navigator>::from(&navigator, supplementName()));
     if (!supplement) {
-        auto newSupplement = makeUnique<NavigatorMediaCapabilities>();
+        auto newSupplement = makeUnique<NavigatorMediaCapabilities>(navigator);
         supplement = newSupplement.get();
         provideTo(&navigator, supplementName(), WTF::move(newSupplement));
     }

Source/WebCore/Modules/mediacapabilities/NavigatorMediaCapabilities.h

@@ -36,7 +36,7 @@ class Navigator;
 class NavigatorMediaCapabilities final : public Supplement<Navigator> {
     WTF_MAKE_TZONE_ALLOCATED(NavigatorMediaCapabilities);
 public:
-    NavigatorMediaCapabilities();
+    explicit NavigatorMediaCapabilities(Navigator&);
     ~NavigatorMediaCapabilities();
 
     static MediaCapabilities& mediaCapabilities(Navigator&);

Source/WebCore/Modules/mediacapabilities/WorkerNavigatorMediaCapabilities.cpp

@@ -34,8 +34,8 @@ namespace WebCore {
 
 WTF_MAKE_TZONE_ALLOCATED_IMPL(WorkerNavigatorMediaCapabilities);
 
-WorkerNavigatorMediaCapabilities::WorkerNavigatorMediaCapabilities()
-    : m_mediaCapabilities(MediaCapabilities::create())
+WorkerNavigatorMediaCapabilities::WorkerNavigatorMediaCapabilities(WorkerNavigator& navigator)
+    : m_mediaCapabilities(MediaCapabilities::create(navigator))
 {
 }
 
@@ -45,7 +45,7 @@ WorkerNavigatorMediaCapabilities& WorkerNavigatorMediaCapabilities::from(WorkerN
 {
     auto* supplement = downcast<WorkerNavigatorMediaCapabilities>(Supplement<WorkerNavigator>::from(&navigator, supplementName()));
     if (!supplement) {
-        auto newSupplement = makeUnique<WorkerNavigatorMediaCapabilities>();
+        auto newSupplement = makeUnique<WorkerNavigatorMediaCapabilities>(navigator);
         supplement = newSupplement.get();
         provideTo(&navigator, supplementName(), WTF::move(newSupplement));
     }

Source/WebCore/Modules/mediacapabilities/WorkerNavigatorMediaCapabilities.h

@@ -36,7 +36,7 @@ class WorkerNavigator;
 class WorkerNavigatorMediaCapabilities final : public Supplement<WorkerNavigator> {
     WTF_MAKE_TZONE_ALLOCATED(WorkerNavigatorMediaCapabilities);
 public:
-    WorkerNavigatorMediaCapabilities();
+    explicit WorkerNavigatorMediaCapabilities(WorkerNavigator&);
     ~WorkerNavigatorMediaCapabilities();
 
     static MediaCapabilities& mediaCapabilities(WorkerNavigator&);