From a8185359ae1014db558321ffbf82b1c961a39cbd Mon Sep 17 00:00:00 2001 From: Sean Feng Date: Wed, 11 Oct 2023 19:39:37 +0000 Subject: [PATCH] Bug 1856514 - Make sure nsRefreshDriver will tick enough times for user input handling r=smaug Differential Revision: https://phabricator.services.mozilla.com/D190108 --- dom/base/test/browser.toml | 2 + ..._user_input_handling_delay_reload_ticks.js | 54 +++++++++++++++++++ layout/base/nsPresContext.cpp | 7 +++ layout/base/nsPresContext.h | 2 + layout/base/nsRefreshDriver.cpp | 7 +++ layout/base/nsRefreshDriver.h | 1 + 6 files changed, 73 insertions(+) create mode 100644 dom/base/test/browser_user_input_handling_delay_reload_ticks.js diff --git a/dom/base/test/browser.toml b/dom/base/test/browser.toml index 3b812b87d535..e6613fa2aa2c 100644 --- a/dom/base/test/browser.toml +++ b/dom/base/test/browser.toml @@ -142,4 +142,6 @@ skip-if = ["verify"] ["browser_user_input_handling_delay_bfcache.js"] +["browser_user_input_handling_delay_reload_ticks.js"] + ["browser_xml_toggle.js"] diff --git a/dom/base/test/browser_user_input_handling_delay_reload_ticks.js b/dom/base/test/browser_user_input_handling_delay_reload_ticks.js new file mode 100644 index 000000000000..8afc7f16bb54 --- /dev/null +++ b/dom/base/test/browser_user_input_handling_delay_reload_ticks.js @@ -0,0 +1,54 @@ +/* -*- Mode: JavaScript; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim: set ts=8 sts=2 et sw=2 tw=80: */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +async function test_user_input_handling_delay_helper(prefs) { + await SpecialPowers.pushPrefEnv({ + set: prefs, + }); + + const tab = await BrowserTestUtils.openNewForegroundTab( + gBrowser, + `data:text/html,` + ); + + await BrowserTestUtils.reloadTab(tab); + + // eslint-disable-next-line mozilla/no-arbitrary-setTimeout + await new Promise(r => setTimeout(r, 5000)); + + const userInputHappend = SpecialPowers.spawn( + tab.linkedBrowser, + [], + async function () { + await ContentTaskUtils.waitForEvent(content, "keydown"); + } + ).then(function () { + Assert.ok( + true, + "User input event should be able to work after 5 seconds of an reload" + ); + }); + + // In the buggy build, the following tab key doesn't work + await BrowserTestUtils.synthesizeKey("KEY_Tab", {}, tab.linkedBrowser); + await BrowserTestUtils.synthesizeKey("KEY_Tab", {}, tab.linkedBrowser); + await BrowserTestUtils.synthesizeKey("KEY_Tab", {}, tab.linkedBrowser); + await BrowserTestUtils.synthesizeKey("KEY_Tab", {}, tab.linkedBrowser); + + await userInputHappend; + + BrowserTestUtils.removeTab(tab); +} + +add_task(async function test_MinTick() { + const prefs = [ + ["dom.input_events.security.minNumTicks", 10], + ["dom.input_events.security.minTimeElapsedInMS", 0], + ["dom.input_events.security.isUserInputHandlingDelayTest", true], + ]; + + await test_user_input_handling_delay_helper(prefs); +}); diff --git a/layout/base/nsPresContext.cpp b/layout/base/nsPresContext.cpp index 35c018216876..f1cebe9455e3 100644 --- a/layout/base/nsPresContext.cpp +++ b/layout/base/nsPresContext.cpp @@ -1288,6 +1288,13 @@ void nsPresContext::MaybeIncreaseMeasuredTicksSinceLoading() { } } } + +bool nsPresContext::NeedsMoreTicksForUserInput() const { + MOZ_ASSERT(IsRoot()); + return mMeasuredTicksSinceLoading < + StaticPrefs::dom_input_events_security_minNumTicks(); +} + // Helper function for setting Anim Mode on image static void SetImgAnimModeOnImgReq(imgIRequest* aImgReq, uint16_t aMode) { if (aImgReq) { diff --git a/layout/base/nsPresContext.h b/layout/base/nsPresContext.h index dda4c8ccc92a..3d723066a99c 100644 --- a/layout/base/nsPresContext.h +++ b/layout/base/nsPresContext.h @@ -516,6 +516,8 @@ class nsPresContext : public nsISupports, public mozilla::SupportsWeakPtr { void MaybeIncreaseMeasuredTicksSinceLoading(); + bool NeedsMoreTicksForUserInput() const; + void ResetUserInputEventsAllowed() { MOZ_ASSERT(IsRoot()); mMeasuredTicksSinceLoading = 0; diff --git a/layout/base/nsRefreshDriver.cpp b/layout/base/nsRefreshDriver.cpp index 6fe7c9f428b4..cecfd83d6966 100644 --- a/layout/base/nsRefreshDriver.cpp +++ b/layout/base/nsRefreshDriver.cpp @@ -1976,6 +1976,10 @@ auto nsRefreshDriver::GetReasonsToTick() const -> TickReasons { if (!mVisualViewportScrollEvents.IsEmpty()) { reasons |= TickReasons::eHasVisualViewportScrollEvents; } + if (mPresContext && mPresContext->IsRoot() && + mPresContext->NeedsMoreTicksForUserInput()) { + reasons |= TickReasons::eRootNeedsMoreTicksForUserInput; + } return reasons; } @@ -2015,6 +2019,9 @@ void nsRefreshDriver::AppendTickReasonsToString(TickReasons aReasons, if (aReasons & TickReasons::eHasVisualViewportScrollEvents) { aStr.AppendLiteral(" HasVisualViewportScrollEvents"); } + if (aReasons & TickReasons::eRootNeedsMoreTicksForUserInput) { + aStr.AppendLiteral(" RootNeedsMoreTicksForUserInput"); + } } bool nsRefreshDriver:: diff --git a/layout/base/nsRefreshDriver.h b/layout/base/nsRefreshDriver.h index e366154a4e50..107aae115183 100644 --- a/layout/base/nsRefreshDriver.h +++ b/layout/base/nsRefreshDriver.h @@ -452,6 +452,7 @@ class nsRefreshDriver final : public mozilla::layers::TransactionIdAllocator, eHasVisualViewportScrollEvents = 1 << 6, eHasPendingMediaQueryListeners = 1 << 7, eNeedsToNotifyResizeObservers = 1 << 8, + eRootNeedsMoreTicksForUserInput = 1 << 9, }; void AddForceNotifyContentfulPaintPresContext(nsPresContext* aPresContext);