Changeset 285739 in webkit

Timestamp:

Nov 12, 2021, 1:23:59 PM (5 years ago)

Author:

Chris Dumez

Message:

Demote WKWebpagePreferences.captivePortalModeEnabled API to SPI
​https://bugs.webkit.org/show_bug.cgi?id=233059

Reviewed by Geoffrey Garen.

Source/WebKit:

Demote WKWebpagePreferences.captivePortalModeEnabled API to SPI until we reach
agreement on a suitable API name.

• UIProcess/API/Cocoa/WKWebpagePreferences.h:
• UIProcess/API/Cocoa/WKWebpagePreferences.mm:

(-[WKWebpagePreferences _setCaptivePortalModeEnabled:]):
(-[WKWebpagePreferences _captivePortalModeEnabled]):
(-[WKWebpagePreferences setCaptivePortalModeEnabled:]): Deleted.
(-[WKWebpagePreferences captivePortalModeEnabled]): Deleted.

• UIProcess/API/Cocoa/WKWebpagePreferencesPrivate.h:

Tools:

Update API test accordingly.

• TestWebKitAPI/Tests/WebKitCocoa/ProcessSwapOnNavigation.mm:

Location:

trunk

Files:

• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/WKWebpagePreferences.h (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/WKWebpagePreferences.mm (modified) (2 diffs)
• Source/WebKit/UIProcess/API/Cocoa/WKWebpagePreferencesPrivate.h (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKitCocoa/ProcessSwapOnNavigation.mm (modified) (6 diffs)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2021-11-12  Chris Dumez  <cdumez@apple.com>
+
+        Demote WKWebpagePreferences.captivePortalModeEnabled API to SPI
+        https://bugs.webkit.org/show_bug.cgi?id=233059
+
+        Reviewed by Geoffrey Garen.
+
+        Demote WKWebpagePreferences.captivePortalModeEnabled API to SPI until we reach
+        agreement on a suitable API name.
+
+        * UIProcess/API/Cocoa/WKWebpagePreferences.h:
+        * UIProcess/API/Cocoa/WKWebpagePreferences.mm:
+        (-[WKWebpagePreferences _setCaptivePortalModeEnabled:]):
+        (-[WKWebpagePreferences _captivePortalModeEnabled]):
+        (-[WKWebpagePreferences setCaptivePortalModeEnabled:]): Deleted.
+        (-[WKWebpagePreferences captivePortalModeEnabled]): Deleted.
+        * UIProcess/API/Cocoa/WKWebpagePreferencesPrivate.h:
+
 2021-11-12  Chris Dumez  <cdumez@apple.com>
 

trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebpagePreferences.h

@@ -72 +72 @@
 @property (nonatomic) BOOL allowsContentJavaScript WK_API_AVAILABLE(macos(11.0), ios(14.0));
 
-/*! @abstract A boolean indicating whether Captive Portal mode is enabled.
- @discussion The default value is NO on macOS. On iOS, the default value depends on the system setting.
- */
-@property (nonatomic) BOOL captivePortalModeEnabled WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
-
 @end

trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebpagePreferences.mm

@@ -392 +392 @@
 }
 
-- (void)setCaptivePortalModeEnabled:(BOOL)captivePortalModeEnabled
+- (void)_setCaptivePortalModeEnabled:(BOOL)captivePortalModeEnabled
 {
 #if PLATFORM(IOS_FAMILY)
@@ -401 +401 @@
 }
 
-- (BOOL)captivePortalModeEnabled
+- (BOOL)_captivePortalModeEnabled
 {
     return _websitePolicies->captivePortalModeEnabled();

trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebpagePreferencesPrivate.h

@@ -86 +86 @@
 @property (nonatomic, setter=_setMouseEventPolicy:) _WKWebsiteMouseEventPolicy _mouseEventPolicy WK_API_AVAILABLE(macos(11.0), ios(14.0));
 
+@property (nonatomic, setter=_setCaptivePortalModeEnabled:) BOOL _captivePortalModeEnabled WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
+
 @end

trunk/Tools/ChangeLog

@@ +1 @@
+2021-11-12  Chris Dumez  <cdumez@apple.com>
+
+        Demote WKWebpagePreferences.captivePortalModeEnabled API to SPI
+        https://bugs.webkit.org/show_bug.cgi?id=233059
+
+        Reviewed by Geoffrey Garen.
+
+        Update API test accordingly.
+
+        * TestWebKitAPI/Tests/WebKitCocoa/ProcessSwapOnNavigation.mm:
+
 2021-11-05  Jonathan Bedard  <jbedard@apple.com>
 

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

@@ -46 +46 @@
 #import <WebKit/WKWebViewPrivateForTesting.h>
 #import <WebKit/WKWebpagePreferences.h>
+#import <WebKit/WKWebpagePreferencesPrivate.h>
 #import <WebKit/WKWebsiteDataStorePrivate.h>
 #import <WebKit/WKWebsiteDataStoreRef.h>
@@ -7680 +7681 @@
 {
     auto webViewConfiguration = adoptNS([WKWebViewConfiguration new]);
-    EXPECT_FALSE(webViewConfiguration.get().defaultWebpagePreferences.captivePortalModeEnabled);
+    EXPECT_FALSE(webViewConfiguration.get().defaultWebpagePreferences._captivePortalModeEnabled);
     [webViewConfiguration.get().preferences _setMediaDevicesEnabled:YES];
     webViewConfiguration.get().preferences._mediaCaptureRequiresSecureConnection = NO;
@@ -7707 +7708 @@
 
     delegate.get().decidePolicyForNavigationActionWithPreferences = ^(WKNavigationAction *action, WKWebpagePreferences *preferences, void (^completionHandler)(WKNavigationActionPolicy, WKWebpagePreferences *)) {
-        EXPECT_FALSE(preferences.captivePortalModeEnabled);
-        preferences.captivePortalModeEnabled = YES;
+        EXPECT_FALSE(preferences._captivePortalModeEnabled);
+        [preferences _setCaptivePortalModeEnabled:YES];
         completionHandler(WKNavigationActionPolicyAllow, preferences);
     };
@@ -7726 +7727 @@
 {
     auto webViewConfiguration = adoptNS([WKWebViewConfiguration new]);
-    EXPECT_FALSE(webViewConfiguration.get().defaultWebpagePreferences.captivePortalModeEnabled);
-    webViewConfiguration.get().defaultWebpagePreferences.captivePortalModeEnabled = YES;
+    EXPECT_FALSE(webViewConfiguration.get().defaultWebpagePreferences._captivePortalModeEnabled);
+    [webViewConfiguration.get().defaultWebpagePreferences _setCaptivePortalModeEnabled:YES];
     [webViewConfiguration.get().preferences _setMediaDevicesEnabled:YES];
     webViewConfiguration.get().preferences._mediaCaptureRequiresSecureConnection = NO;
@@ -7745 +7746 @@
 
     delegate.get().decidePolicyForNavigationActionWithPreferences = ^(WKNavigationAction *action, WKWebpagePreferences *preferences, void (^completionHandler)(WKNavigationActionPolicy, WKWebpagePreferences *)) {
-        EXPECT_TRUE(preferences.captivePortalModeEnabled);
+        EXPECT_TRUE(preferences._captivePortalModeEnabled);
         completionHandler(WKNavigationActionPolicyAllow, preferences);
     };
@@ -7767 +7768 @@
 
     delegate.get().decidePolicyForNavigationActionWithPreferences = ^(WKNavigationAction *action, WKWebpagePreferences *preferences, void (^completionHandler)(WKNavigationActionPolicy, WKWebpagePreferences *)) {
-        EXPECT_TRUE(preferences.captivePortalModeEnabled);
-        preferences.captivePortalModeEnabled = NO; // Opt out of captive portal mode for this load.
+        EXPECT_TRUE(preferences._captivePortalModeEnabled);
+        [preferences _setCaptivePortalModeEnabled:NO]; // Opt out of captive portal mode for this load.
         completionHandler(WKNavigationActionPolicyAllow, preferences);
     };