Changeset 244749 in webkit

Timestamp:

Apr 29, 2019, 1:04:33 PM (7 years ago)

Author:

youenn@apple.com

Message:

getDisplayMedia should be called on user gesture
​https://bugs.webkit.org/show_bug.cgi?id=197356
Source/WebCore:

Reviewed by Eric Carlson.

Allow getDisplayMedia on user gesture only.
Otherwise reject the promise.
Minor refactoring to align getDisplayMedia, getUserMedia and
enumerateDevices when called with no document.

Test: fast/mediastream/screencapture-user-gesture.html

• Modules/mediastream/MediaDevices.cpp:

(WebCore::MediaDevices::getUserMedia const):

• Modules/mediastream/MediaDevices.h:
• Modules/mediastream/NavigatorMediaDevices.h:
• page/DOMWindow.h:
• testing/Internals.cpp:

(WebCore::Internals::setDisableGetDisplayMediaUserGestureConstraint):

• testing/Internals.h:
• testing/Internals.idl:

Tools:

<rdar://problem/50296074>

Reviewed by Eric Carlson.

Update test configuration to inject internals
so that we can use it to simulate a user click to call getDisplayMedia.

• TestWebKitAPI/Tests/WebKit/getDisplayMedia.html:
• TestWebKitAPI/Tests/WebKitCocoa/GetDisplayMedia.mm:

(TestWebKitAPI::GetDisplayMediaTest::SetUp):

LayoutTests:

Reviewed by Eric Carlson.

• fast/mediastream/media-stream-page-muted.html:
• fast/mediastream/screencapture-user-gesture-expected.txt: Added.
• fast/mediastream/screencapture-user-gesture.html: Added.
• http/tests/media/media-stream/get-display-media-iframe-allow-attribute-expected.txt:
• http/tests/media/media-stream/get-display-media-iframe-allow-attribute.html:
• http/tests/media/media-stream/get-display-media-prompt.html:
• http/tests/media/media-stream/resources/get-display-media-devices-iframe.html:

• resources/testharnessreport.js:

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/fast/mediastream/media-stream-page-muted.html (modified) (1 diff)
• LayoutTests/fast/mediastream/screencapture-user-gesture-expected.txt (added)
• LayoutTests/fast/mediastream/screencapture-user-gesture.html (added)
• LayoutTests/http/tests/media/media-stream/get-display-media-iframe-allow-attribute-expected.txt (modified) (1 diff)
• LayoutTests/http/tests/media/media-stream/get-display-media-prompt.html (modified) (1 diff)
• LayoutTests/http/tests/media/media-stream/resources/get-display-media-devices-iframe.html (modified) (1 diff)
• LayoutTests/resources/testharnessreport.js (modified) (1 diff)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/Modules/mediastream/MediaDevices.cpp (modified) (2 diffs)
• Source/WebCore/Modules/mediastream/MediaDevices.h (modified) (3 diffs)
• Source/WebCore/Modules/mediastream/NavigatorMediaDevices.h (modified) (1 diff)
• Source/WebCore/page/DOMWindow.h (modified) (1 diff)
• Source/WebCore/testing/Internals.cpp (modified) (3 diffs)
• Source/WebCore/testing/Internals.h (modified) (1 diff)
• Source/WebCore/testing/Internals.idl (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKit/getDisplayMedia.html (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKitCocoa/GetDisplayMedia.mm (modified) (1 diff)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2019-04-29  Youenn Fablet  <youenn@apple.com>
+
+        getDisplayMedia should be called on user gesture
+        https://bugs.webkit.org/show_bug.cgi?id=197356
+
+        Reviewed by Eric Carlson.
+
+        * fast/mediastream/media-stream-page-muted.html:
+        * fast/mediastream/screencapture-user-gesture-expected.txt: Added.
+        * fast/mediastream/screencapture-user-gesture.html: Added.
+        * http/tests/media/media-stream/get-display-media-iframe-allow-attribute-expected.txt:
+        * http/tests/media/media-stream/get-display-media-iframe-allow-attribute.html:
+        * http/tests/media/media-stream/get-display-media-prompt.html:
+        * http/tests/media/media-stream/resources/get-display-media-devices-iframe.html:
+
+        * resources/testharnessreport.js:
+
 2019-04-29  Javier Fernandez  <jfernandez@igalia.com>
 

trunk/LayoutTests/fast/mediastream/media-stream-page-muted.html

@@ -5 +5 @@
     <script src="../../resources/js-test-pre.js"></script>
     <script>
+        if (window.internals)
+            internals.setDisableGetDisplayMediaUserGestureConstraint(true);
+
         async function checkPageState(activeState, inactiveState) {
             await new Promise((resolve, reject) => {

trunk/LayoutTests/http/tests/media/media-stream/get-display-media-iframe-allow-attribute-expected.txt

@@ -1 @@
-CONSOLE MESSAGE: line 5: Trying to call getDisplayMedia from a frame without correct 'allow' attribute.
-CONSOLE MESSAGE: line 5: Trying to call getDisplayMedia from a frame without correct 'allow' attribute.
-CONSOLE MESSAGE: line 5: Trying to call getDisplayMedia from a frame without correct 'allow' attribute.
+CONSOLE MESSAGE: line 8: Trying to call getDisplayMedia from a frame without correct 'allow' attribute.
+CONSOLE MESSAGE: line 8: Trying to call getDisplayMedia from a frame without correct 'allow' attribute.
+CONSOLE MESSAGE: line 8: Trying to call getDisplayMedia from a frame without correct 'allow' attribute.
      
 

trunk/LayoutTests/http/tests/media/media-stream/get-display-media-prompt.html

@@ -10 +10 @@
 
 <script>
+    if (window.internals)
+        internals.setDisableGetDisplayMediaUserGestureConstraint(true);
 
     let stream;

trunk/LayoutTests/http/tests/media/media-stream/resources/get-display-media-devices-iframe.html

@@ -1 +1 @@
 <script>
+    if (window.internals)
+        internals.setDisableGetDisplayMediaUserGestureConstraint(true);
+
     async function enumerate(event)
     {

trunk/LayoutTests/resources/testharnessreport.js

@@ -29 +29 @@
     }
 }
+
+if (self.internals && internals.setDisableGetDisplayMediaUserGestureConstraint)
+    internals.setDisableGetDisplayMediaUserGestureConstraint(true);
 
 if (self.internals && internals.setICECandidateFiltering)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2019-04-29  Youenn Fablet  <youenn@apple.com>
+
+        getDisplayMedia should be called on user gesture
+        https://bugs.webkit.org/show_bug.cgi?id=197356
+
+        Reviewed by Eric Carlson.
+
+        Allow getDisplayMedia on user gesture only.
+        Otherwise reject the promise.
+        Minor refactoring to align getDisplayMedia, getUserMedia and
+        enumerateDevices when called with no document.
+
+        Test: fast/mediastream/screencapture-user-gesture.html
+
+        * Modules/mediastream/MediaDevices.cpp:
+        (WebCore::MediaDevices::getUserMedia const):
+        * Modules/mediastream/MediaDevices.h:
+        * Modules/mediastream/NavigatorMediaDevices.h:
+        * page/DOMWindow.h:
+        * testing/Internals.cpp:
+        (WebCore::Internals::setDisableGetDisplayMediaUserGestureConstraint):
+        * testing/Internals.h:
+        * testing/Internals.idl:
+
 2019-04-29  Javier Fernandez  <jfernandez@igalia.com>
 

trunk/Source/WebCore/Modules/mediastream/MediaDevices.cpp

@@ -103 +103 @@
 {
     auto* document = this->document();
-    if (!document) {
-        promise.reject(Exception { InvalidStateError });
-        return;
-    }
+    if (!document)
+        return;
 
     auto audioConstraints = createMediaConstraints(constraints.audio);
@@ -115 +113 @@
     auto request = UserMediaRequest::create(*document, { MediaStreamRequest::Type::UserMedia, WTFMove(audioConstraints), WTFMove(videoConstraints) }, WTFMove(promise));
     request->start();
-
-    return;
-}
-
-ExceptionOr<void> MediaDevices::getDisplayMedia(const StreamConstraints& constraints, Promise&& promise) const
+}
+
+void MediaDevices::getDisplayMedia(const StreamConstraints& constraints, Promise&& promise) const
 {
     auto* document = this->document();
     if (!document)
-        return Exception { InvalidStateError };
+        return;
+
+    if (!m_disableGetDisplayMediaUserGestureConstraint && !UserGestureIndicator::processingUserGesture()) {
+        promise.reject(Exception { InvalidAccessError, "getDisplayMedia must be called from a user gesture handler."_s });
+        return;
+    }
 
     auto request = UserMediaRequest::create(*document, { MediaStreamRequest::Type::DisplayMedia, { }, createMediaConstraints(constraints.video) }, WTFMove(promise));
     request->start();
-
-    return { };
 }
 

trunk/Source/WebCore/Modules/mediastream/MediaDevices.h

@@ -77 +77 @@
     };
     void getUserMedia(const StreamConstraints&, Promise&&) const;
-    ExceptionOr<void> getDisplayMedia(const StreamConstraints&, Promise&&) const;
+    void getDisplayMedia(const StreamConstraints&, Promise&&) const;
     void enumerateDevices(EnumerateDevicesPromise&&) const;
     MediaTrackSupportedConstraints getSupportedConstraints();
@@ -83 +83 @@
     using RefCounted<MediaDevices>::ref;
     using RefCounted<MediaDevices>::deref;
+
+    void setDisableGetDisplayMediaUserGestureConstraint(bool value) { m_disableGetDisplayMediaUserGestureConstraint = value; }
 
 private:
@@ -108 +110 @@
     const EventNames& m_eventNames; // Need to cache this so we can use it from GC threads.
     bool m_listeningForDeviceChanges { false };
+    bool m_disableGetDisplayMediaUserGestureConstraint { false };
 };
 

trunk/Source/WebCore/Modules/mediastream/NavigatorMediaDevices.h

@@ -48 +48 @@
     static NavigatorMediaDevices* from(Navigator*);
 
-    static MediaDevices* mediaDevices(Navigator&);
+    WEBCORE_TESTSUPPORT_EXPORT static MediaDevices* mediaDevices(Navigator&);
     MediaDevices* mediaDevices() const;
 

trunk/Source/WebCore/page/DOMWindow.h

@@ -159 +159 @@
     BarProp& statusbar();
     BarProp& toolbar();
-    Navigator& navigator();
+    WEBCORE_EXPORT Navigator& navigator();
     Navigator* optionalNavigator() const { return m_navigator.get(); }
     Navigator& clientInformation() { return navigator(); }

trunk/Source/WebCore/testing/Internals.cpp

@@ -109 +109 @@
 #include "LoaderStrategy.h"
 #include "MallocStatistics.h"
+#include "MediaDevices.h"
 #include "MediaEngineConfigurationFactory.h"
 #include "MediaPlayer.h"
@@ -119 +120 @@
 #include "MockPageOverlay.h"
 #include "MockPageOverlayClient.h"
+#include "NavigatorMediaDevices.h"
 #include "NetworkLoadInformation.h"
 #include "Page.h"
@@ -4706 +4708 @@
 }
 
+void Internals::setDisableGetDisplayMediaUserGestureConstraint(bool value)
+{
+    Document* document = contextDocument();
+    if (!document || !document->domWindow())
+        return;
+
+    if (auto* mediaDevices = NavigatorMediaDevices::mediaDevices(document->domWindow()->navigator()))
+        mediaDevices->setDisableGetDisplayMediaUserGestureConstraint(value);
+}
 #endif
 

trunk/Source/WebCore/testing/Internals.h

@@ -707 +707 @@
     void setMediaStreamTrackIdentifier(MediaStreamTrack&, String&& id);
     void setMediaStreamSourceInterrupted(MediaStreamTrack&, bool);
+    void setDisableGetDisplayMediaUserGestureConstraint(bool);
 #endif
 

trunk/Source/WebCore/testing/Internals.idl

@@ -680 +680 @@
     [Conditional=MEDIA_STREAM] void setMediaStreamTrackIdentifier(MediaStreamTrack track, DOMString identifier);
     [Conditional=MEDIA_STREAM] void setMediaStreamSourceInterrupted(MediaStreamTrack track, boolean interrupted);
+    [Conditional=MEDIA_STREAM] void setDisableGetDisplayMediaUserGestureConstraint(boolean value);
 
     unsigned long long documentIdentifier(Document document);

trunk/Tools/ChangeLog

@@ +1 @@
+2019-04-29  Youenn Fablet  <youenn@apple.com>
+
+        getDisplayMedia should be called on user gesture
+        https://bugs.webkit.org/show_bug.cgi?id=197356
+        <rdar://problem/50296074>
+
+        Reviewed by Eric Carlson.
+
+        Update test configuration to inject internals
+        so that we can use it to simulate a user click to call getDisplayMedia.
+
+        * TestWebKitAPI/Tests/WebKit/getDisplayMedia.html:
+        * TestWebKitAPI/Tests/WebKitCocoa/GetDisplayMedia.mm:
+        (TestWebKitAPI::GetDisplayMediaTest::SetUp):
+
 2019-04-26  Stephanie Lewis  <slewis@apple.com>
 

trunk/Tools/TestWebKitAPI/Tests/WebKit/getDisplayMedia.html

@@ -8 +8 @@
             function promptForCapture(constraints)
             {
-                navigator.mediaDevices.getDisplayMedia(constraints)
-                .then((s) => {
-                    stream = s;
-                    video.srcObject = stream;
-                    if (window.webkit)
-                      window.webkit.messageHandlers.testHandler.postMessage('allowed');
-                })
-                .catch((error) => {
-                    if (window.webkit)
-                       window.webkit.messageHandlers.testHandler.postMessage('denied');
+                window.internals.withUserGesture(async () => {
+                    navigator.mediaDevices.getDisplayMedia(constraints)
+                    .then((s) => {
+                        stream = s;
+                        video.srcObject = stream;
+                        if (window.webkit)
+                          window.webkit.messageHandlers.testHandler.postMessage('allowed');
+                    })
+                    .catch((error) => {
+                        if (window.webkit)
+                           window.webkit.messageHandlers.testHandler.postMessage('denied');
+                    });
                 });
             }

trunk/Tools/TestWebKitAPI/Tests/WebKitCocoa/GetDisplayMedia.mm

@@ -94 +94 @@
     {
         m_configuration = adoptNS([[WKWebViewConfiguration alloc] init]);
+        auto context = adoptWK(TestWebKitAPI::Util::createContextForInjectedBundleTest("InternalsInjectedBundleTest"));
+        m_configuration.get().processPool = (WKProcessPool *)context.get();
 
         auto handler = adoptNS([[GetDisplayMediaMessageHandler alloc] init]);