Ensuring initialization of CaptionUserPreferencesTestingModeToken before setting caption mode

https://bugs.webkit.org/show_bug.cgi?id=262680

Reviewed by Eric Carlson.

The `captionDisplayMode` option was introduced in
https://bugs.webkit.org/show_bug.cgi?id=261460 (PR:
WebKit#17689). However,
when I attempted to import WPT for webvtt/parsing with
`captionDisplayMode` setting enabled, I found that the
tests were failing intermittently on ios-wk2 (example:
WebKit#17852 (comment)).

The flakiness of these tests appears to be due to the fact
that the `CaptionUserPreferencesTestingModeToken` instance
may not always be initialized before the caption mode is
set (https://github.com/WebKit/WebKit/blob/659f85098cf4322282a775cbd51eb58a4ed34022/Tools/WebKitTestRunner/InjectedBundle/InjectedBundle.cpp#L583).
This instance is usually initialized on the `Internals`
class's constructor during the WebKitTestRunner setup
(https://github.com/WebKit/WebKit/blob/659f85098cf4322282a775cbd51eb58a4ed34022/Tools/WebKitTestRunner/InjectedBundle/InjectedBundlePage.cpp#L888).
In most cases, the `CaptionUserPreferencesTestingModeToken`
instance is created in the `Internals` class constructor
before `WKBundlePageSetCaptionDisplayMode` is called, but
there are instances where it is not, particularly when tests
are run concurrently. This leads to the tests failing.

To address this issue, the WebKitTestRunner needs to ensure
that the `CaptionUserPreferencesTestingModeToken` instance
is always initialized before `WKBundlePageSetCaptionDisplayMode`
is called, thus eliminating the flakiness of the tests.

* Source/WebKit/Shared/API/APICaptionUserPreferencesTestingModeToken.h: Added.
(API::CaptionUserPreferencesTestingModeToken::create):
(API::CaptionUserPreferencesTestingModeToken::CaptionUserPreferencesTestingModeToken):
* Source/WebKit/Shared/API/APIObject.h:
* Source/WebKit/Shared/API/c/WKBase.h:
* Source/WebKit/UIProcess/API/C/WKAPICast.h:
* Source/WebKit/WebKit.xcodeproj/project.pbxproj:
* Source/WebKit/WebProcess/InjectedBundle/API/c/WKBundlePage.cpp:
(WKBundlePageSetCaptionDisplayMode):
(WKBundlePageCreateCaptionUserPreferencesTestingModeToken):
(WKBundleSetCaptionDisplayMode): Deleted.
* Source/WebKit/WebProcess/InjectedBundle/API/c/WKBundlePagePrivate.h:
* Tools/WebKitTestRunner/InjectedBundle/InjectedBundle.cpp:
(WTR::InjectedBundle::beginTesting):
* Tools/WebKitTestRunner/InjectedBundle/InjectedBundle.h:

Canonical link: https://commits.webkit.org/269455@main

Author: cola119

Source/WebKit/Shared/API/APICaptionUserPreferencesTestingModeToken.h

@@ -0,0 +1,49 @@
+/*
+ * Copyright (C) 2010-2023 Apple Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+ * THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+#include "APIObject.h"
+#include <WebCore/CaptionUserPreferences.h>
+#include <wtf/Ref.h>
+
+namespace API {
+
+class CaptionUserPreferencesTestingModeToken : public API::ObjectImpl<API::Object::Type::CaptionUserPreferencesTestingModeToken> {
+public:
+    static Ref<CaptionUserPreferencesTestingModeToken> create(WebCore::CaptionUserPreferences& preferences)
+    {
+        return adoptRef(*new CaptionUserPreferencesTestingModeToken(*new WebCore::CaptionUserPreferencesTestingModeToken(preferences)));
+    }
+private:
+    CaptionUserPreferencesTestingModeToken(WebCore::CaptionUserPreferencesTestingModeToken& token)
+        : m_token(token)
+    {
+    }
+
+    WebCore::CaptionUserPreferencesTestingModeToken m_token;
+};
+
+}

Source/WebKit/Shared/API/APIObject.h

@@ -54,6 +54,7 @@ class Object
         Array,
         AuthenticationChallenge,
         AuthenticationDecisionListener,
+        CaptionUserPreferencesTestingModeToken,
         CertificateInfo,
         Connection,
         ContextMenuItem,
@@ -318,6 +319,7 @@ template<> struct EnumTraits<API::Object::Type> {
         API::Object::Type::Array,
         API::Object::Type::AuthenticationChallenge,
         API::Object::Type::AuthenticationDecisionListener,
+        API::Object::Type::CaptionUserPreferencesTestingModeToken,
         API::Object::Type::CertificateInfo,
         API::Object::Type::Connection,
         API::Object::Type::ContextMenuItem,

Source/WebKit/Shared/API/c/WKBase.h

@@ -84,6 +84,7 @@ typedef const struct OpaqueWKAuthenticationDecisionListener* WKAuthenticationDec
 typedef const struct OpaqueWKBackForwardList* WKBackForwardListRef;
 typedef const struct OpaqueWKBackForwardListItem* WKBackForwardListItemRef;
 typedef const struct OpaqueWKResourceCacheManager* WKResourceCacheManagerRef;
+typedef const struct OpaqueWKCaptionUserPreferencesTestingModeToken* WKCaptionUserPreferencesTestingModeTokenRef;
 typedef const struct OpaqueWKColorPickerResultListener* WKColorPickerResultListenerRef;
 typedef const struct OpaqueWKContext* WKContextRef;
 typedef const struct OpaqueWKContextConfiguration* WKContextConfigurationRef;

Source/WebKit/UIProcess/API/C/WKAPICast.h

@@ -49,6 +49,7 @@
 #include <WebCore/Settings.h>
 
 namespace API {
+class CaptionUserPreferencesTestingModeToken;
 class ContentRuleList;
 class ContentRuleListStore;
 class Feature;
@@ -115,6 +116,7 @@ WK_ADD_API_MAPPING(WKAuthenticationDecisionListenerRef, AuthenticationDecisionLi
 WK_ADD_API_MAPPING(WKBackForwardListItemRef, WebBackForwardListItem)
 WK_ADD_API_MAPPING(WKBackForwardListRef, WebBackForwardList)
 WK_ADD_API_MAPPING(WKBundleHitTestResultMediaType, BundleHitTestResultMediaType)
+WK_ADD_API_MAPPING(WKCaptionUserPreferencesTestingModeTokenRef, API::CaptionUserPreferencesTestingModeToken)
 WK_ADD_API_MAPPING(WKColorPickerResultListenerRef, WebColorPickerResultListenerProxy)
 WK_ADD_API_MAPPING(WKContextRef, WebProcessPool)
 WK_ADD_API_MAPPING(WKContextConfigurationRef, API::ProcessPoolConfiguration)

Source/WebKit/WebKit.xcodeproj/project.pbxproj

@@ -6974,6 +6974,7 @@
 		C5BCE5DB1C50761D00CDE3FA /* InteractionInformationAtPosition.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; name = InteractionInformationAtPosition.mm; path = ios/InteractionInformationAtPosition.mm; sourceTree = "<group>"; };
 		C5FA1ED118E1062200B3F402 /* WKAirPlayRoutePicker.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = WKAirPlayRoutePicker.h; path = ios/forms/WKAirPlayRoutePicker.h; sourceTree = "<group>"; };
 		C5FA1ED218E1062200B3F402 /* WKAirPlayRoutePicker.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; name = WKAirPlayRoutePicker.mm; path = ios/forms/WKAirPlayRoutePicker.mm; sourceTree = "<group>"; };
+		C68BA2622ADBA6EC00770791 /* APICaptionUserPreferencesTestingModeToken.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = APICaptionUserPreferencesTestingModeToken.h; sourceTree = "<group>"; };
 		C6A4CA092252899800169289 /* WKBundlePageMac.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = WKBundlePageMac.h; sourceTree = "<group>"; };
 		C6A4CA0A2252899800169289 /* WKBundlePageMac.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = WKBundlePageMac.mm; sourceTree = "<group>"; };
 		CA05397823EE324400A553DC /* ContentAsStringIncludesChildFrames.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = ContentAsStringIncludesChildFrames.h; sourceTree = "<group>"; };
@@ -13509,6 +13510,7 @@
 				37DFA6FE1810BB2D001F4A9F /* Cocoa */,
 				BC64696D11DBE603006455B0 /* APIArray.cpp */,
 				BC64696E11DBE603006455B0 /* APIArray.h */,
+				C68BA2622ADBA6EC00770791 /* APICaptionUserPreferencesTestingModeToken.h */,
 				1A3DD205125E5A2F004515E6 /* APIClient.h */,
 				1AAB037B185F99D800EDF501 /* APIData.cpp */,
 				51578B821209ECEF00A37C4A /* APIData.h */,

Source/WebKit/WebProcess/InjectedBundle/API/c/WKBundlePage.cpp

@@ -28,6 +28,7 @@
 #include "WKBundlePagePrivate.h"
 
 #include "APIArray.h"
+#include "APICaptionUserPreferencesTestingModeToken.h"
 #include "APIDictionary.h"
 #include "APIFrameHandle.h"
 #include "APIInjectedBundlePageContextMenuClient.h"
@@ -849,7 +850,7 @@ void WKBundlePageClearApplicationCache(WKBundlePageRef page)
     WebKit::toImpl(page)->corePage()->applicationCacheStorage().deleteAllEntries();
 }
 
-void WKBundleSetCaptionDisplayMode(WKBundlePageRef page, WKStringRef mode)
+void WKBundlePageSetCaptionDisplayMode(WKBundlePageRef page, WKStringRef mode)
 {
 #if ENABLE(VIDEO)
     auto& captionPreferences = WebKit::toImpl(page)->corePage()->group().ensureCaptionPreferences();
@@ -858,7 +859,17 @@ void WKBundleSetCaptionDisplayMode(WKBundlePageRef page, WKStringRef mode)
         captionPreferences.setCaptionDisplayMode(displayMode.value());
 #else
     UNUSED_PARAM(page);
-    UNUSED_PARAM(modeString);
+    UNUSED_PARAM(mode);
+#endif
+}
+
+WKCaptionUserPreferencesTestingModeTokenRef WKBundlePageCreateCaptionUserPreferencesTestingModeToken(WKBundlePageRef page)
+{
+#if ENABLE(VIDEO)
+    auto& captionPreferences = WebKit::toImpl(page)->corePage()->group().ensureCaptionPreferences();
+    return WebKit::toAPI(&API::CaptionUserPreferencesTestingModeToken::create(captionPreferences).leakRef());
+#else
+    UNUSED_PARAM(page);
 #endif
 }
 

Source/WebKit/WebProcess/InjectedBundle/API/c/WKBundlePagePrivate.h

@@ -130,7 +130,8 @@ WK_EXPORT void WKBundlePageSetApplicationCacheOriginQuota(WKBundlePageRef page,
 WK_EXPORT void WKBundlePageResetApplicationCacheOriginQuota(WKBundlePageRef page, WKStringRef origin);
 WK_EXPORT WKArrayRef WKBundlePageCopyOriginsWithApplicationCache(WKBundlePageRef page);
 
-WK_EXPORT void WKBundleSetCaptionDisplayMode(WKBundlePageRef page, WKStringRef mode);
+WK_EXPORT void WKBundlePageSetCaptionDisplayMode(WKBundlePageRef page, WKStringRef mode);
+WK_EXPORT WKCaptionUserPreferencesTestingModeTokenRef WKBundlePageCreateCaptionUserPreferencesTestingModeToken(WKBundlePageRef page);
 
 enum {
     kWKEventThrottlingBehaviorResponsive = 0,

Tools/WebKitTestRunner/InjectedBundle/InjectedBundle.cpp

@@ -552,6 +552,10 @@ void InjectedBundle::beginTesting(WKDictionaryRef settings, BegingTestingMode te
     m_accessibilityController->setIsolatedTreeMode(m_accessibilityIsolatedTreeMode);
 #endif
 #endif
+#if ENABLE(VIDEO)
+    if (!m_captionUserPreferencesTestingModeToken)
+        m_captionUserPreferencesTestingModeToken = WKBundlePageCreateCaptionUserPreferencesTestingModeToken(page()->page());
+#endif
 
 #if PLATFORM(IOS_FAMILY)
     WKBundlePageSetUseTestingViewportConfiguration(page()->page(), !booleanValue(settings, "UseFlexibleViewport"));
@@ -580,7 +584,7 @@ void InjectedBundle::beginTesting(WKDictionaryRef settings, BegingTestingMode te
     clearResourceLoadStatistics();
 
 #if ENABLE(VIDEO)
-    WKBundleSetCaptionDisplayMode(page()->page(), stringValue(settings, "CaptionDisplayMode"));
+    WKBundlePageSetCaptionDisplayMode(page()->page(), stringValue(settings, "CaptionDisplayMode"));
 #endif
     // [WK2] REGRESSION(r128623): It made layout tests extremely slow
     // https://bugs.webkit.org/show_bug.cgi?id=96862

Tools/WebKitTestRunner/InjectedBundle/InjectedBundle.h

@@ -221,6 +221,8 @@ class InjectedBundle {
     Vector<String> m_allowedHosts;
 
     size_t m_userScriptInjectedCount { 0 };
+
+    WKRetainPtr<WKCaptionUserPreferencesTestingModeTokenRef> m_captionUserPreferencesTestingModeToken;
 };
 
 void postMessage(const char* name);