Changeset 287364 in webkit

Timestamp:

Dec 22, 2021, 10:48:55 AM (4 years ago)

Author:

Simon Fraser

Message:

Preferences that read from NSUserDefaults need to be initialied from platformInitializeStore()
​https://bugs.webkit.org/show_bug.cgi?id=234488

Reviewed by Sam Weinig.

Having the default value for a preference read from NSUserDefaults can cause issues
if the UIProcess and WebProcess values don't match. Instead, have platformInitializeStore()
explicitly add values for these keys; this is done for scrollAnimatorEnabledKey.

Source/WebKit:

• UIProcess/Cocoa/WebPreferencesCocoa.mm:

(WebKit::WebPreferences::initializePlatformDependentPreferences):
(WebKit::WebPreferences::platformInitializeStore):

• UIProcess/WebPreferences.cpp:

(WebKit::WebPreferences::initializePlatformDependentPreferences):

• UIProcess/WebPreferences.h:

Source/WTF:

• Scripts/Preferences/WebPreferences.yaml:

Location:

trunk/Source

Files:

• WTF/ChangeLog (modified) (1 diff)
• WTF/Scripts/Preferences/WebPreferences.yaml (modified) (1 diff)
• WebKit/ChangeLog (modified) (1 diff)
• WebKit/UIProcess/Cocoa/WebPreferencesCocoa.mm (modified) (1 diff)
• WebKit/UIProcess/WebPreferences.cpp (modified) (1 diff)
• WebKit/UIProcess/WebPreferences.h (modified) (1 diff)

trunk/Source/WTF/ChangeLog

@@ +1 @@
+2021-12-22  Simon Fraser  <simon.fraser@apple.com>
+
+        Preferences that read from NSUserDefaults need to be initialied from platformInitializeStore()
+        https://bugs.webkit.org/show_bug.cgi?id=234488
+
+        Reviewed by Sam Weinig.
+
+        Having the default value for a preference read from NSUserDefaults can cause issues
+        if the UIProcess and WebProcess values don't match. Instead, have platformInitializeStore()
+        explicitly add values for these keys; this is done for scrollAnimatorEnabledKey.
+
+        * Scripts/Preferences/WebPreferences.yaml:
+
 2021-12-22  J Pascoe  <j_pascoe@apple.com>
 

trunk/Source/WTF/Scripts/Preferences/WebPreferences.yaml

@@ -1894 +1894 @@
       default: false
     WebKit:
-      "PLATFORM(MAC)": WebKit::defaultScrollAnimatorEnabled()
+      # PLATFORM(MAC) initializes the value in initializeProcessStateDependentPreferences
       "PLATFORM(GTK) || PLATFORM(WPE)": true
       default: false

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2021-12-22  Simon Fraser  <simon.fraser@apple.com>
+
+        Preferences that read from NSUserDefaults need to be initialied from platformInitializeStore()
+        https://bugs.webkit.org/show_bug.cgi?id=234488
+
+        Reviewed by Sam Weinig.
+
+        Having the default value for a preference read from NSUserDefaults can cause issues
+        if the UIProcess and WebProcess values don't match. Instead, have platformInitializeStore()
+        explicitly add values for these keys; this is done for scrollAnimatorEnabledKey.
+
+        * UIProcess/Cocoa/WebPreferencesCocoa.mm:
+        (WebKit::WebPreferences::initializePlatformDependentPreferences):
+        (WebKit::WebPreferences::platformInitializeStore):
+        * UIProcess/WebPreferences.cpp:
+        (WebKit::WebPreferences::initializePlatformDependentPreferences):
+        * UIProcess/WebPreferences.h:
+
 2021-12-22  Commit Queue  <commit-queue@webkit.org>
 

trunk/Source/WebKit/UIProcess/Cocoa/WebPreferencesCocoa.mm

@@ -141 +141 @@
 }
 
+void WebPreferences::initializeProcessStateDependentPreferences()
+{
+#if ENABLE(MEDIA_STREAM)
+    // NOTE: This is set here, and does not set the default using the 'defaultValue' mechanism, because the
+    // 'defaultValue' must be the same in both the UIProcess and WebProcess, which may not be true for audio
+    // and video capture state as the WebProcess is not entitled to use the camera or microphone by default.
+    // If other preferences need to dynamically set the initial value based on host app state, we should extended
+    // the declarative format rather than adding more special cases here.
+    m_store.setBoolValueForKey(WebPreferencesKey::mediaDevicesEnabledKey(), UserMediaPermissionRequestManagerProxy::permittedToCaptureAudio() || UserMediaPermissionRequestManagerProxy::permittedToCaptureVideo());
+#endif
+
+#if PLATFORM(MAC)
+    m_store.setBoolValueForKey(WebPreferencesKey::scrollAnimatorEnabledKey(), [[NSUserDefaults standardUserDefaults] boolForKey:@"NSScrollAnimationEnabled"]);
+#endif
+}
+
 void WebPreferences::platformInitializeStore()
 {
     @autoreleasepool {
-#if ENABLE(MEDIA_STREAM)
-        // NOTE: This is set here, and does not setting the default using the 'defaultValue' mechanism, because the
-        // 'defaultValue' must be the same in both the UIProcess and WebProcess, which may not be true for audio
-        // and video capture state as the WebProcess is not entitled to use the camera or microphone by default.
-        // If other preferences need to dynamically set the initial value based on host app state, we should extended
-        // the declarative format rather than adding more special cases here.
-        m_store.setBoolValueForKey(WebPreferencesKey::mediaDevicesEnabledKey(), UserMediaPermissionRequestManagerProxy::permittedToCaptureAudio() || UserMediaPermissionRequestManagerProxy::permittedToCaptureVideo());
-#endif
+        initializeProcessStateDependentPreferences();
 
 #define INITIALIZE_DEBUG_PREFERENCE_FROM_NSUSERDEFAULTS(KeyUpper, KeyLower, TypeName, Type, DefaultValue, HumanReadableName, HumanReadableDescription) \

trunk/Source/WebKit/UIProcess/WebPreferences.cpp

@@ -229 +229 @@
 
 #if !PLATFORM(COCOA)
+void WebPreferences::initializeProcessStateDependentPreferences()
+{
+}
+
 void WebPreferences::platformUpdateStringValueForKey(const String&, const String&)
 {

trunk/Source/WebKit/UIProcess/WebPreferences.h

@@ -90 +90 @@
 private:
     void platformInitializeStore();
+    void initializeProcessStateDependentPreferences();
 
     void update();