Changeset 245185 in webkit

Timestamp:

May 10, 2019 12:01:12 PM (5 years ago)

Author:

Chris Dumez

Message:

Do not wait until requestPermission() is called to fire deviceorientation events if permission was already granted
​https://bugs.webkit.org/show_bug.cgi?id=197750

Reviewed by Geoffrey Garen.

Source/WebKit:

The UIProcess remembers previous device orientation permission decisions per origin for the duration of the browsing
session. However, the WebContent process was not aware of previous decisions and would therefore not fire any
deviceorientation / devicemotion events until the JS has called requestPermission(). This patches addresses this
problem by having the UIProcess communicate any previous permission decision for the origin via WebSitePolicies.

• UIProcess/WebPageProxy.cpp:

(WebKit::WebPageProxy::receivedNavigationPolicyDecision):

• UIProcess/WebsiteData/WebDeviceOrientationAndMotionAccessController.cpp:

(WebKit::WebDeviceOrientationAndMotionAccessController::shouldAllowAccess):
(WebKit::WebDeviceOrientationAndMotionAccessController::cachedDeviceOrientationPermission const):
(WebKit::WebDeviceOrientationAndMotionAccessController::deviceOrientationPermission const): Deleted.

• UIProcess/WebsiteData/WebDeviceOrientationAndMotionAccessController.h:

Tools:

Add API test coverage.

• TestWebKitAPI/Tests/WebKitCocoa/DeviceOrientation.mm:

(TEST):

Location:

trunk

Files:

• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/UIProcess/WebPageProxy.cpp (modified) (1 diff)
• Source/WebKit/UIProcess/WebsiteData/WebDeviceOrientationAndMotionAccessController.cpp (modified) (2 diffs)
• Source/WebKit/UIProcess/WebsiteData/WebDeviceOrientationAndMotionAccessController.h (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKitCocoa/DeviceOrientation.mm (modified) (1 diff)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2019-05-10  Chris Dumez  <cdumez@apple.com>
+
+        Do not wait until requestPermission() is called to fire deviceorientation events if permission was already granted
+        https://bugs.webkit.org/show_bug.cgi?id=197750
+
+        Reviewed by Geoffrey Garen.
+
+        The UIProcess remembers previous device orientation permission decisions per origin for the duration of the browsing
+        session. However, the WebContent process was not aware of previous decisions and would therefore not fire any
+        deviceorientation / devicemotion events until the JS has called requestPermission(). This patches addresses this
+        problem by having the UIProcess communicate any previous permission decision for the origin via WebSitePolicies.
+
+        * UIProcess/WebPageProxy.cpp:
+        (WebKit::WebPageProxy::receivedNavigationPolicyDecision):
+        * UIProcess/WebsiteData/WebDeviceOrientationAndMotionAccessController.cpp:
+        (WebKit::WebDeviceOrientationAndMotionAccessController::shouldAllowAccess):
+        (WebKit::WebDeviceOrientationAndMotionAccessController::cachedDeviceOrientationPermission const):
+        (WebKit::WebDeviceOrientationAndMotionAccessController::deviceOrientationPermission const): Deleted.
+        * UIProcess/WebsiteData/WebDeviceOrientationAndMotionAccessController.h:
+
 2019-05-10  Chris Dumez  <cdumez@apple.com>
 

trunk/Source/WebKit/UIProcess/WebPageProxy.cpp

@@ -2781 +2781 @@
     }
 
+#if ENABLE(DEVICE_ORIENTATION)
+    if (navigation && (!data || data->deviceOrientationAndMotionAccessState == WebCore::DeviceOrientationOrMotionPermissionState::Prompt)) {
+        auto deviceOrientationPermission = websiteDataStore->deviceOrientationAndMotionAccessController().cachedDeviceOrientationPermission(SecurityOriginData::fromURL(navigation->currentRequest().url()));
+        if (deviceOrientationPermission != WebCore::DeviceOrientationOrMotionPermissionState::Prompt) {
+            if (!data)
+                data = WebsitePoliciesData { };
+            data->deviceOrientationAndMotionAccessState = deviceOrientationPermission;
+        }
+    }
+#endif
+
 #if PLATFORM(COCOA)
     static const bool forceDownloadFromDownloadAttribute = false;

trunk/Source/WebKit/UIProcess/WebsiteData/WebDeviceOrientationAndMotionAccessController.cpp

@@ -38 +38 @@
 void WebDeviceOrientationAndMotionAccessController::shouldAllowAccess(WebPageProxy& page, WebFrameProxy& frame, WebCore::SecurityOriginData&& originData, bool mayPrompt, CompletionHandler<void(DeviceOrientationOrMotionPermissionState)>&& completionHandler)
 {
-    auto currentPermission = deviceOrientationPermission(originData);
+    auto currentPermission = cachedDeviceOrientationPermission(originData);
     if (currentPermission != DeviceOrientationOrMotionPermissionState::Prompt || !mayPrompt)
         return completionHandler(currentPermission);
@@ -59 +59 @@
 }
 
-DeviceOrientationOrMotionPermissionState WebDeviceOrientationAndMotionAccessController::deviceOrientationPermission(const SecurityOriginData& origin) const
+DeviceOrientationOrMotionPermissionState WebDeviceOrientationAndMotionAccessController::cachedDeviceOrientationPermission(const SecurityOriginData& origin) const
 {
     auto it = m_deviceOrientationPermissionDecisions.find(origin);

trunk/Source/WebKit/UIProcess/WebsiteData/WebDeviceOrientationAndMotionAccessController.h

@@ -45 +45 @@
     void clearPermissions();
 
+    WebCore::DeviceOrientationOrMotionPermissionState cachedDeviceOrientationPermission(const WebCore::SecurityOriginData&) const;
+
 private:
-    WebCore::DeviceOrientationOrMotionPermissionState deviceOrientationPermission(const WebCore::SecurityOriginData&) const;
-
     HashMap<WebCore::SecurityOriginData, bool> m_deviceOrientationPermissionDecisions;
     HashMap<WebCore::SecurityOriginData, Vector<CompletionHandler<void(WebCore::DeviceOrientationOrMotionPermissionState)>>> m_pendingRequests;

trunk/Tools/ChangeLog

@@ +1 @@
+2019-05-10  Chris Dumez  <cdumez@apple.com>
+
+        Do not wait until requestPermission() is called to fire deviceorientation events if permission was already granted
+        https://bugs.webkit.org/show_bug.cgi?id=197750
+
+        Reviewed by Geoffrey Garen.
+
+        Add API test coverage.
+
+        * TestWebKitAPI/Tests/WebKitCocoa/DeviceOrientation.mm:
+        (TEST):
+
 2019-05-10  Keith Miller  <keith_miller@apple.com>
 

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

@@ -251 +251 @@
 }
 
+TEST(DeviceOrientation, FireOrientationEventsRightAwayIfPermissionAlreadyGranted)
+{
+    auto configuration = adoptNS([[WKWebViewConfiguration alloc] init]);
+    configuration.get().websiteDataStore = [WKWebsiteDataStore defaultDataStore];
+
+    auto messageHandler = adoptNS([[DeviceOrientationMessageHandler alloc] init]);
+    [[configuration userContentController] addScriptMessageHandler:messageHandler.get() name:@"testHandler"];
+
+    auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]);
+    RetainPtr<DeviceOrientationPermissionUIDelegate> uiDelegate = adoptNS([[DeviceOrientationPermissionUIDelegate alloc] initWithHandler:[] { return true; }]);
+    [webView setUIDelegate:uiDelegate.get()];
+
+    NSURLRequest *request = [NSURLRequest requestWithURL:[[NSBundle mainBundle] URLForResource:@"simple" withExtension:@"html" subdirectory:@"TestWebKitAPI.resources"]];
+    [webView loadRequest:request];
+    [webView _test_waitForDidFinishNavigation];
+
+    // Request permission.
+    [webView evaluateJavaScript:@"DeviceOrientationEvent.requestPermission().then((granted) => { webkit.messageHandlers.testHandler.postMessage(granted) });" completionHandler: [&] (id result, NSError *error) { }];
+
+    TestWebKitAPI::Util::run(&didReceiveMessage);
+    didReceiveMessage = false;
+
+    EXPECT_TRUE(askedClientForPermission);
+    askedClientForPermission = false;
+    EXPECT_WK_STREQ(@"granted", receivedMessages.get()[0]);
+
+    // Go to the same origin again in a new view.
+    webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]);
+    [webView setUIDelegate:uiDelegate.get()];
+
+    [webView loadRequest:request];
+    [webView _test_waitForDidFinishNavigation];
+
+    // This time, we do not request permission but set our event listener.
+    bool addedEventListener = false;
+    [webView evaluateJavaScript:@"addEventListener('deviceorientation', (e) => { webkit.messageHandlers.testHandler.postMessage('received-event') });" completionHandler: [&] (id result, NSError *error) {
+        addedEventListener = true;
+    }];
+
+    TestWebKitAPI::Util::run(&addedEventListener);
+    addedEventListener = false;
+
+    // Simulate a device orientation event. The page's event listener should get called even though it did not request permission,
+    // because it was previously granted permission during this browsing session.
+    [webView _simulateDeviceOrientationChangeWithAlpha:1.0 beta:2.0 gamma:3.0];
+
+    TestWebKitAPI::Util::run(&didReceiveMessage);
+    EXPECT_WK_STREQ(@"received-event", receivedMessages.get()[1]);
+}
+
 #endif // PLATFORM(IOS_FAMILY)