Changeset 208606 in webkit

Timestamp:

Nov 11, 2016 1:45:21 PM (7 years ago)

Author:

eric.carlson@apple.com

Message:

[MediaStream] defer resolution of getUserMedia promise made in a background tab
​https://bugs.webkit.org/show_bug.cgi?id=164643
<rdar://problem/29048317>

Reviewed by Brady Eidson.

Source/WebCore:

Test: fast/mediastream/get-user-media-background-tab.html

Do not start producing data when the document does not allow media
to start playing. Instead, register with the document for a callback
when playback is allowed and start then.

• Modules/mediastream/MediaStream.cpp:

(WebCore::MediaStream::~MediaStream):
(WebCore::MediaStream::mediaCanStart):
(WebCore::MediaStream::startProducingData):
(WebCore::MediaStream::stopProducingData):
(WebCore::MediaStream::pageMutedStateDidChange):

• Modules/mediastream/MediaStream.h:

• Modules/webaudio/AudioContext.cpp:

(WebCore::AudioContext::mediaCanStart): Deal with API change.

• Modules/webaudio/AudioContext.h:

• html/HTMLMediaElement.cpp:

(WebCore::HTMLMediaElement::mediaCanStart): Ditto.

• html/HTMLMediaElement.h:
• page/MediaCanStartListener.h:

• page/Page.cpp:

(WebCore::Page::takeAnyMediaCanStartListener): Return the listener and document.
(WebCore::Page::setCanStartMedia): Pass the document to the listener.

• page/Page.h:

Source/WebKit2:

Do not ask for user for access to capture devices when the document does not
allow media to play, wait until playback is allowed.

• WebProcess/MediaStream/UserMediaPermissionRequestManager.cpp:

(WebKit::UserMediaPermissionRequestManager::startUserMediaRequest):
(WebKit::UserMediaPermissionRequestManager::sendUserMediaRequest):
(WebKit::UserMediaPermissionRequestManager::mediaCanStart):
(WebKit::UserMediaPermissionRequestManager::grantUserMediaDevicesSandboxExtension):

• WebProcess/MediaStream/UserMediaPermissionRequestManager.h:
• WebProcess/Plugins/PluginView.cpp:

(WebKit::PluginView::mediaCanStart):

• WebProcess/Plugins/PluginView.h:

LayoutTests:

• fast/mediastream/get-user-media-background-tab-expected.txt: Added.
• fast/mediastream/get-user-media-background-tab.html: Added.

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/fast/mediastream/get-user-media-background-tab-expected.txt (added)
• LayoutTests/fast/mediastream/get-user-media-background-tab.html (added)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/Modules/mediastream/MediaStream.cpp (modified) (5 diffs)
• Source/WebCore/Modules/mediastream/MediaStream.h (modified) (5 diffs)
• Source/WebCore/Modules/webaudio/AudioContext.cpp (modified) (1 diff)
• Source/WebCore/Modules/webaudio/AudioContext.h (modified) (1 diff)
• Source/WebCore/html/HTMLMediaElement.cpp (modified) (1 diff)
• Source/WebCore/html/HTMLMediaElement.h (modified) (1 diff)
• Source/WebCore/page/MediaCanStartListener.h (modified) (1 diff)
• Source/WebCore/page/Page.cpp (modified) (3 diffs)
• Source/WebCore/page/Page.h (modified) (1 diff)
• Source/WebKit2/ChangeLog (modified) (1 diff)
• Source/WebKit2/WebProcess/MediaStream/UserMediaPermissionRequestManager.cpp (modified) (5 diffs)
• Source/WebKit2/WebProcess/MediaStream/UserMediaPermissionRequestManager.h (modified) (4 diffs)
• Source/WebKit2/WebProcess/Plugins/PluginView.cpp (modified) (1 diff)
• Source/WebKit2/WebProcess/Plugins/PluginView.h (modified) (1 diff)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2016-11-11  Eric Carlson  <eric.carlson@apple.com>
+
+        [MediaStream] defer resolution of getUserMedia promise made in a background tab
+        https://bugs.webkit.org/show_bug.cgi?id=164643
+        <rdar://problem/29048317>
+
+        Reviewed by Brady Eidson.
+
+        * fast/mediastream/get-user-media-background-tab-expected.txt: Added.
+        * fast/mediastream/get-user-media-background-tab.html: Added.
+
 2016-11-10  Jiewen Tan  <jiewen_tan@apple.com>
 

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2016-11-11  Eric Carlson  <eric.carlson@apple.com>
+
+        [MediaStream] defer resolution of getUserMedia promise made in a background tab
+        https://bugs.webkit.org/show_bug.cgi?id=164643
+        <rdar://problem/29048317>
+
+        Reviewed by Brady Eidson.
+
+        Test: fast/mediastream/get-user-media-background-tab.html
+
+        Do not start producing data when the document does not allow media
+        to start playing. Instead, register with the document for a callback 
+        when playback is allowed and start then.
+        * Modules/mediastream/MediaStream.cpp:
+        (WebCore::MediaStream::~MediaStream):
+        (WebCore::MediaStream::mediaCanStart):
+        (WebCore::MediaStream::startProducingData):
+        (WebCore::MediaStream::stopProducingData):
+        (WebCore::MediaStream::pageMutedStateDidChange):
+        * Modules/mediastream/MediaStream.h:
+
+        * Modules/webaudio/AudioContext.cpp:
+        (WebCore::AudioContext::mediaCanStart): Deal with API change.
+        * Modules/webaudio/AudioContext.h:
+
+        * html/HTMLMediaElement.cpp:
+        (WebCore::HTMLMediaElement::mediaCanStart): Ditto.
+        * html/HTMLMediaElement.h:
+        * page/MediaCanStartListener.h:
+
+        * page/Page.cpp:
+        (WebCore::Page::takeAnyMediaCanStartListener): Return the listener and document.
+        (WebCore::Page::setCanStartMedia): Pass the document to the listener.
+        * page/Page.h:
+
 2016-11-11  Zalan Bujtas  <zalan@apple.com>
 

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

@@ -2 +2 @@
  * Copyright (C) 2011 Google Inc. All rights reserved.
  * Copyright (C) 2011, 2012, 2015 Ericsson AB. All rights reserved.
- * Copyright (C) 2013-2015 Apple Inc. All rights reserved.
+ * Copyright (C) 2013-2016 Apple Inc. All rights reserved.
  * Copyright (C) 2013 Nokia Corporation and/or its subsidiary(-ies).
  *
@@ -35 +35 @@
 #include "EventNames.h"
 #include "ExceptionCode.h"
+#include "Logging.h"
 #include "MediaStreamRegistry.h"
 #include "MediaStreamTrackEvent.h"
@@ -112 +113 @@
     for (auto& track : m_trackSet.values())
         track->removeObserver(this);
-    if (Document* document = this->document())
+    if (Document* document = this->document()) {
         document->removeAudioProducer(this);
+        if (m_isWaitingUntilMediaCanStart)
+            document->removeMediaCanStartListener(this);
+    }
 }
 
@@ -248 +252 @@
 }
 
+void MediaStream::mediaCanStart(Document& document)
+{
+    ASSERT_UNUSED(document, &document == this->document());
+    ASSERT(m_isWaitingUntilMediaCanStart);
+    if (m_isWaitingUntilMediaCanStart) {
+        m_isWaitingUntilMediaCanStart = false;
+        startProducingData();
+    }
+}
+
+void MediaStream::startProducingData()
+{
+    Document* document = this->document();
+    if (!document || !document->page())
+        return;
+
+    // If we can't start a load right away, start it later.
+    if (!document->page()->canStartMedia()) {
+        LOG(Media, "MediaStream::startProducingData(%p) - not allowed to start in background, waiting", this);
+        if (m_isWaitingUntilMediaCanStart)
+            return;
+
+        m_isWaitingUntilMediaCanStart = true;
+        document->addMediaCanStartListener(this);
+        return;
+    }
+
+    m_private->startProducingData();
+}
+
+void MediaStream::stopProducingData()
+{
+    m_private->stopProducingData();
+}
+
 void MediaStream::pageMutedStateDidChange()
 {
@@ -263 +302 @@
     m_externallyMuted = pageMuted;
     if (pageMuted)
-        m_private->stopProducingData();
+        stopProducingData();
     else
-        m_private->startProducingData();
+        startProducingData();
 }
 

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

@@ -34 +34 @@
 #include "EventTarget.h"
 #include "ExceptionBase.h"
+#include "MediaCanStartListener.h"
 #include "MediaProducer.h"
 #include "MediaStreamPrivate.h"
@@ -48 +49 @@
 class Document;
 
-class MediaStream final : public URLRegistrable, public EventTargetWithInlineData, public ContextDestructionObserver, public MediaStreamTrack::Observer, public MediaStreamPrivate::Observer, private MediaProducer, public RefCounted<MediaStream> {
+class MediaStream final
+    : public URLRegistrable
+    , public EventTargetWithInlineData
+    , public ContextDestructionObserver
+    , public MediaStreamTrack::Observer
+    , public MediaStreamPrivate::Observer
+    , private MediaProducer
+    , private MediaCanStartListener
+    , public RefCounted<MediaStream> {
 public:
     class Observer {
@@ -78 +87 @@
 
     MediaStreamPrivate* privateStream() const { return m_private.get(); }
+
+    void startProducingData();
+    void stopProducingData();
 
     // EventTarget
@@ -119 +131 @@
     MediaProducer::MediaStateFlags mediaState() const final;
 
+    // MediaCanStartListener
+    void mediaCanStart(Document&) final;
+
     bool internalAddTrack(Ref<MediaStreamTrack>&&, StreamModifier);
     bool internalRemoveTrack(const String&, StreamModifier);
@@ -143 +158 @@
     bool m_isMuted { true };
     bool m_externallyMuted { false };
+    bool m_isWaitingUntilMediaCanStart { false };
 };
 

trunk/Source/WebCore/Modules/webaudio/AudioContext.cpp

@@ -958 +958 @@
 }
 
-void AudioContext::mediaCanStart()
-{
+void AudioContext::mediaCanStart(Document& document)
+{
+    ASSERT_UNUSED(document, &document == this->document());
     removeBehaviorRestriction(AudioContext::RequirePageConsentForAudioStartRestriction);
     mayResumePlayback(true);

trunk/Source/WebCore/Modules/webaudio/AudioContext.h

@@ -285 +285 @@
     void scheduleNodeDeletion();
 
-    void mediaCanStart() override;
+    void mediaCanStart(Document&) override;
 
     // MediaProducer

trunk/Source/WebCore/html/HTMLMediaElement.cpp

@@ -5665 +5665 @@
 #endif
 
-void HTMLMediaElement::mediaCanStart()
-{
+void HTMLMediaElement::mediaCanStart(Document& document)
+{
+    ASSERT_UNUSED(document, &document == &this->document());
     LOG(Media, "HTMLMediaElement::mediaCanStart(%p) - m_isWaitingUntilMediaCanStart = %s, m_pausedInternal = %s",
         this, boolString(m_isWaitingUntilMediaCanStart), boolString(m_pausedInternal) );

trunk/Source/WebCore/html/HTMLMediaElement.h

@@ -728 +728 @@
     void setPlaybackRateInternal(double);
 
-    void mediaCanStart() override;
+    void mediaCanStart(Document&) final;
 
     void invalidateCachedTime() const;

trunk/Source/WebCore/page/MediaCanStartListener.h

@@ -28 +28 @@
 namespace WebCore {
 
+class Document;
+
 class MediaCanStartListener {
 public:
-    virtual void mediaCanStart() = 0;
+    virtual void mediaCanStart(Document&) = 0;
 protected:
     virtual ~MediaCanStartListener() { }

trunk/Source/WebCore/page/Page.cpp

@@ -556 +556 @@
 }
 
-inline MediaCanStartListener* Page::takeAnyMediaCanStartListener()
+inline Optional<std::pair<MediaCanStartListener&, Document&>>  Page::takeAnyMediaCanStartListener()
 {
     for (Frame* frame = &mainFrame(); frame; frame = frame->tree().traverseNext()) {
@@ -562 +562 @@
             continue;
         if (MediaCanStartListener* listener = frame->document()->takeAnyMediaCanStartListener())
-            return listener;
-    }
-    return 0;
+            return { { *listener, *frame->document() } };
+    }
+    return Nullopt;
 }
 
@@ -575 +575 @@
 
     while (m_canStartMedia) {
-        MediaCanStartListener* listener = takeAnyMediaCanStartListener();
+        auto listener = takeAnyMediaCanStartListener();
         if (!listener)
             break;
-        listener->mediaCanStart();
+        listener->first.mediaCanStart(listener->second);
     }
 }

trunk/Source/WebCore/page/Page.h

@@ -550 +550 @@
     unsigned findMatchesForText(const String&, FindOptions, unsigned maxMatchCount, ShouldHighlightMatches, ShouldMarkMatches);
 
-    MediaCanStartListener* takeAnyMediaCanStartListener();
+    Optional<std::pair<MediaCanStartListener&, Document&>> takeAnyMediaCanStartListener();
 
     Vector<Ref<PluginViewBase>> pluginViews();

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2016-11-11  Eric Carlson  <eric.carlson@apple.com>
+
+        [MediaStream] defer resolution of getUserMedia promise made in a background tab
+        https://bugs.webkit.org/show_bug.cgi?id=164643
+        <rdar://problem/29048317>
+
+        Reviewed by Brady Eidson.
+
+        Do not ask for user for access to capture devices when the document does not
+        allow media to play, wait until playback is allowed.
+
+        * WebProcess/MediaStream/UserMediaPermissionRequestManager.cpp:
+        (WebKit::UserMediaPermissionRequestManager::startUserMediaRequest):
+        (WebKit::UserMediaPermissionRequestManager::sendUserMediaRequest):
+        (WebKit::UserMediaPermissionRequestManager::mediaCanStart):
+        (WebKit::UserMediaPermissionRequestManager::grantUserMediaDevicesSandboxExtension):
+        * WebProcess/MediaStream/UserMediaPermissionRequestManager.h:
+        * WebProcess/Plugins/PluginView.cpp:
+        (WebKit::PluginView::mediaCanStart):
+        * WebProcess/Plugins/PluginView.h:
+
 2016-11-11  Darin Adler  <darin@apple.com>
 

trunk/Source/WebKit2/WebProcess/MediaStream/UserMediaPermissionRequestManager.cpp

@@ -61 +61 @@
     Frame* frame = document ? document->frame() : nullptr;
 
+    if (!frame || !document->page()) {
+        request.deny(UserMediaRequest::OtherFailure, emptyString());
+        return;
+    }
+
+    if (document->page()->canStartMedia()) {
+        sendUserMediaRequest(request);
+        return;
+    }
+
+    auto& pendingRequests = m_blockedRequests.add(document, Vector<RefPtr<UserMediaRequest>>()).iterator->value;
+    if (pendingRequests.isEmpty())
+        document->addMediaCanStartListener(this);
+    pendingRequests.append(&request);
+}
+
+void UserMediaPermissionRequestManager::sendUserMediaRequest(UserMediaRequest& request)
+{
+    Document* document = request.document();
+    Frame* frame = document ? document->frame() : nullptr;
+
     if (!frame) {
         request.deny(UserMediaRequest::OtherFailure, emptyString());
@@ -84 +105 @@
         return;
     m_idToUserMediaRequestMap.remove(requestID);
+    removeMediaRequestFromMaps(request);
+}
+
+void UserMediaPermissionRequestManager::mediaCanStart(Document& document)
+{
+    auto pendingRequests = m_blockedRequests.take(&document);
+    while (!pendingRequests.isEmpty()) {
+        if (!document.page()->canStartMedia()) {
+            m_blockedRequests.add(&document, pendingRequests);
+            document.addMediaCanStartListener(this);
+            break;
+        }
+
+        sendUserMediaRequest(*pendingRequests.takeLast());
+    }
+}
+
+void UserMediaPermissionRequestManager::removeMediaRequestFromMaps(UserMediaRequest& request)
+{
+    auto pendingRequests = m_blockedRequests.take(request.document());
+    for (auto& pendingRequest : pendingRequests) {
+        if (&request != pendingRequest.get())
+            continue;
+
+        if (pendingRequests.isEmpty())
+            request.document()->removeMediaCanStartListener(this);
+        else
+            m_blockedRequests.add(request.document(), pendingRequests);
+        break;
+    }
+
+    m_userMediaRequestToIDMap.remove(&request);
 }
 
@@ -91 +144 @@
     if (!request)
         return;
-    m_userMediaRequestToIDMap.remove(request);
+    removeMediaRequestFromMaps(*request);
 
     request->allow(audioDeviceUID, videoDeviceUID);
@@ -101 +154 @@
     if (!request)
         return;
-    m_userMediaRequestToIDMap.remove(request);
+    removeMediaRequestFromMaps(*request);
 
     request->deny(reason, invalidConstraint);
@@ -151 +204 @@
 
     for (size_t i = 0; i < sandboxExtensionHandles.size(); i++) {
-        if (RefPtr<SandboxExtension> extension = SandboxExtension::create(sandboxExtensionHandles[i])) {
+        if (auto extension = SandboxExtension::create(sandboxExtensionHandles[i])) {
             extension->consume();
             m_userMediaDeviceSandboxExtensions.append(extension.release());

trunk/Source/WebKit2/WebProcess/MediaStream/UserMediaPermissionRequestManager.h

@@ -24 +24 @@
 
 #include "SandboxExtension.h"
+#include <WebCore/MediaCanStartListener.h>
 #include <WebCore/MediaConstraints.h>
 #include <WebCore/MediaDevicesEnumerationRequest.h>
@@ -36 +37 @@
 class WebPage;
 
-class UserMediaPermissionRequestManager {
+class UserMediaPermissionRequestManager
+    : private WebCore::MediaCanStartListener {
 public:
     explicit UserMediaPermissionRequestManager(WebPage&);
@@ -53 +55 @@
 
 private:
+    void sendUserMediaRequest(WebCore::UserMediaRequest&);
+
+    // WebCore::MediaCanStartListener
+    void mediaCanStart(WebCore::Document&) override;
+
+    void removeMediaRequestFromMaps(WebCore::UserMediaRequest&);
+
     WebPage& m_page;
 
@@ -62 +71 @@
 
     Vector<RefPtr<SandboxExtension>> m_userMediaDeviceSandboxExtensions;
+
+    HashMap<RefPtr<WebCore::Document>, Vector<RefPtr<WebCore::UserMediaRequest>>> m_blockedRequests;
 };
 

trunk/Source/WebKit2/WebProcess/Plugins/PluginView.cpp

@@ -1372 +1372 @@
 }
 
-void PluginView::mediaCanStart()
+void PluginView::mediaCanStart(WebCore::Document&)
 {
     ASSERT(m_isWaitingUntilMediaCanStart);

trunk/Source/WebKit2/WebProcess/Plugins/PluginView.h

@@ -185 +185 @@
 
     // WebCore::MediaCanStartListener
-    void mediaCanStart() override;
+    void mediaCanStart(WebCore::Document&) override;
 
     // WebCore::MediaProducer