Mirrors/servo
1
0
Fork 0
mirror of https://github.com/servo/servo.git synced 2025-09-15 09:28:20 +01:00
Code Issues Projects Releases Packages Wiki Activity

webdriver: Focus WebView asynchronously (#39241)

Browse source 
#38160 added a webdriver-specific API to support waiting on focus
operations to complete. Later, #38243 added a unique id to track each
focus operation.

Back then we wait on focusing webview in webdriver hoping to improve
stability, but it does not matter as it turns out later. #39086 also
focuses browsing context asynchronously.

This PR would make webdriver's focusing-webview behaviour same as human
interaction.

Testing: 
[Before 1](https://github.com/yezhizhen/servo/actions/runs/17598288280),
[Before 2](https://github.com/yezhizhen/servo/actions/runs/17598289360),
[Before 3](https://github.com/yezhizhen/servo/actions/runs/17598290532)
[After 1](https://github.com/yezhizhen/servo/actions/runs/17598282988),
[After 2](https://github.com/yezhizhen/servo/actions/runs/17598280603),
[After 3](https://github.com/yezhizhen/servo/actions/runs/17589228530)

---------

Signed-off-by: Euclid Ye <yezhizhenjiakang@gmail.com>
This commit is contained in:
Euclid Ye 2025-09-10 15:36:53 +08:00 • committed by GitHub
parent 433a6bf47b
commit 726b456120
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 42 additions and 124 deletions
Download patch file Download diff file Expand all files Collapse all files

23
components/constellation/constellation.rs
View file

@ -131,10 +131,10 @@ use devtools_traits::{
use embedder_traits::resources::{self, Resource};
use embedder_traits::user_content_manager::UserContentManager;
use embedder_traits::{
AnimationState, CompositorHitTestResult, EmbedderMsg, EmbedderProxy, FocusId,
FocusSequenceNumber, InputEvent, JSValue, JavaScriptEvaluationError, JavaScriptEvaluationId,
KeyboardEvent, MediaSessionActionType, MediaSessionEvent, MediaSessionPlaybackState,
MouseButton, MouseButtonAction, MouseButtonEvent, ScriptToEmbedderChan, Theme, ViewportDetails,
AnimationState, CompositorHitTestResult, EmbedderMsg, EmbedderProxy, FocusSequenceNumber,
InputEvent, JSValue, JavaScriptEvaluationError, JavaScriptEvaluationId, KeyboardEvent,
MediaSessionActionType, MediaSessionEvent, MediaSessionPlaybackState, MouseButton,
MouseButtonAction, MouseButtonEvent, ScriptToEmbedderChan, Theme, ViewportDetails,
WebDriverCommandMsg, WebDriverCommandResponse, WebDriverLoadStatus, WebDriverScriptCommand,
};
use euclid::Size2D;
@ -1432,8 +1432,8 @@ where
}
self.handle_panic(webview_id, error, None);
},
EmbedderToConstellationMessage::FocusWebView(webview_id, focus_id) => {
self.handle_focus_web_view(webview_id, focus_id);
EmbedderToConstellationMessage::FocusWebView(webview_id) => {
self.handle_focus_web_view(webview_id);
},
EmbedderToConstellationMessage::BlurWebView => {
self.webviews.unfocus();
@ -2871,13 +2871,13 @@ where
}
#[servo_tracing::instrument(skip_all)]
fn handle_focus_web_view(&mut self, webview_id: WebViewId, focus_id: FocusId) {
fn handle_focus_web_view(&mut self, webview_id: WebViewId) {
let focused = self.webviews.focus(webview_id).is_ok();
if !focused {
warn!("{webview_id}: FocusWebView on unknown top-level browsing context");
}
self.embedder_proxy
.send(EmbedderMsg::WebViewFocused(webview_id, focus_id, focused));
.send(EmbedderMsg::WebViewFocused(webview_id, focused));
}
#[servo_tracing::instrument(skip_all)]
@ -4235,11 +4235,8 @@ where
// Focus the top-level browsing context.
let focused = self.webviews.focus(webview_id);
self.embedder_proxy.send(EmbedderMsg::WebViewFocused(
webview_id,
FocusId::new(),
focused.is_ok(),
));
self.embedder_proxy
.send(EmbedderMsg::WebViewFocused(webview_id, focused.is_ok()));
// If a container with a non-null nested browsing context is focused,
// the nested browsing context's active document becomes the focused

5
components/servo/lib.rs
View file

@ -738,7 +738,7 @@ impl Servo {
webview.delegate().notify_closed(webview);
}
},
EmbedderMsg::WebViewFocused(webview_id, focus_id, focus_result) => {
EmbedderMsg::WebViewFocused(webview_id, focus_result) => {
if focus_result {
for id in self.webviews.borrow().keys() {
if let Some(webview) = self.get_webview_handle(*id) {
@ -747,9 +747,6 @@ impl Servo {
}
}
}
if let Some(webview) = self.get_webview_handle(webview_id) {
webview.complete_focus(focus_id);
}
},
EmbedderMsg::WebViewBlurred => {
for id in self.webviews.borrow().keys() {

20
components/servo/webview.rs
View file

@ -13,7 +13,7 @@ use compositing_traits::WebViewTrait;
use constellation_traits::{EmbedderToConstellationMessage, TraversalDirection};
use dpi::PhysicalSize;
use embedder_traits::{
Cursor, FocusId, Image, InputEvent, JSValue, JavaScriptEvaluationError, LoadStatus,
Cursor, Image, InputEvent, JSValue, JavaScriptEvaluationError, LoadStatus,
MediaSessionActionType, ScreenGeometry, Theme, TraversalId, ViewportDetails,
};
use euclid::{Point2D, Scale, Size2D};
@ -287,10 +287,6 @@ impl WebView {
self.delegate().notify_focus_changed(self, new_value);
}
pub(crate) fn complete_focus(self, focus_id: FocusId) {
self.delegate().notify_focus_complete(self, focus_id);
}
pub fn cursor(&self) -> Cursor {
self.inner().cursor
}
@ -303,15 +299,10 @@ impl WebView {
self.delegate().notify_cursor_changed(self, new_value);
}
pub fn focus(&self) -> FocusId {
let focus_id = FocusId::new();
pub fn focus(&self) {
self.inner()
.constellation_proxy
.send(EmbedderToConstellationMessage::FocusWebView(
self.id(),
focus_id.clone(),
));
focus_id
.send(EmbedderToConstellationMessage::FocusWebView(self.id()));
}
pub fn blur(&self) {
@ -413,10 +404,9 @@ impl WebView {
.expect("BUG: invalid WebView instance");
}
pub fn focus_and_raise_to_top(&self, hide_others: bool) -> FocusId {
let focus_id = self.focus();
pub fn focus_and_raise_to_top(&self, hide_others: bool) {
self.focus();
self.raise_to_top(hide_others);
focus_id
}
pub fn notify_theme_change(&self, theme: Theme) {

5
components/servo/webview_delegate.rs
View file

@ -8,7 +8,7 @@ use base::generic_channel::{GenericSender, SendResult};
use base::id::PipelineId;
use constellation_traits::EmbedderToConstellationMessage;
use embedder_traits::{
AllowOrDeny, AuthenticationResponse, ContextMenuResult, Cursor, FilterPattern, FocusId,
AllowOrDeny, AuthenticationResponse, ContextMenuResult, Cursor, FilterPattern,
GamepadHapticEffectType, InputMethodType, KeyboardEvent, LoadStatus, MediaSessionEvent,
Notification, PermissionFeature, RgbColor, ScreenGeometry, SelectElementOptionOrOptgroup,
SimpleDialog, TraversalId, WebResourceRequest, WebResourceResponse, WebResourceResponseMsg,
@ -419,9 +419,6 @@ pub trait WebViewDelegate {
/// This [`WebView`] has either become focused or lost focus. Whether or not the
/// [`WebView`] is focused can be accessed via [`WebView::focused`].
fn notify_focus_changed(&self, _webview: WebView, _focused: bool) {}
/// A focus operation that was initiated by this webview has completed.
/// The current focus status of this [`WebView`] can be accessed via [`WebView::focused`].
fn notify_focus_complete(&self, _webview: WebView, _focus_id: FocusId) {}
/// This [`WebView`] has either started to animate or stopped animating. When a
/// [`WebView`] is animating, it is up to the embedding application ensure that
/// `Servo::spin_event_loop` is called at regular intervals in order to update the

6
components/shared/constellation/lib.rs
View file

@ -19,8 +19,8 @@ use base::Epoch;
use base::cross_process_instant::CrossProcessInstant;
use base::id::{MessagePortId, PipelineId, WebViewId};
use embedder_traits::{
CompositorHitTestResult, FocusId, InputEvent, JavaScriptEvaluationId, MediaSessionActionType,
Theme, TraversalId, ViewportDetails, WebDriverCommandMsg, WebDriverCommandResponse,
CompositorHitTestResult, InputEvent, JavaScriptEvaluationId, MediaSessionActionType, Theme,
TraversalId, ViewportDetails, WebDriverCommandMsg, WebDriverCommandResponse,
};
use fnv::FnvHashMap;
pub use from_script_message::*;
@ -76,7 +76,7 @@ pub enum EmbedderToConstellationMessage {
SendError(Option<WebViewId>, String),
/// Make a webview focused. [EmbedderMsg::WebViewFocused] will be sent with
/// the result of this operation.
FocusWebView(WebViewId, FocusId),
FocusWebView(WebViewId),
/// Make none of the webviews focused.
BlurWebView,
/// Forward an input event to an appropriate ScriptTask.

18
components/shared/embedder/lib.rs
View file

@ -338,17 +338,6 @@ pub struct ScreenMetrics {
pub available_size: DeviceIndependentIntSize,
}
/// An opaque identifier for a single webview focus operation.
#[derive(Clone, Deserialize, Eq, Hash, PartialEq, Serialize)]
pub struct FocusId(String);
impl FocusId {
#[allow(clippy::new_without_default)]
pub fn new() -> Self {
Self(Uuid::new_v4().to_string())
}
}
/// An opaque identifier for a single history traversal operation.
#[derive(Clone, Deserialize, Eq, Hash, PartialEq, Serialize)]
pub struct TraversalId(String);
@ -445,10 +434,9 @@ pub enum EmbedderMsg {
),
/// A webview was destroyed.
WebViewClosed(WebViewId),
/// A webview potentially gained focus for keyboard events, as initiated
/// by the provided focus id. If the boolean value is false, the webiew
/// could not be focused.
WebViewFocused(WebViewId, FocusId, bool),
/// A webview potentially gained focus for keyboard events.
/// If the boolean value is false, the webiew could not be focused.
WebViewFocused(WebViewId, bool),
/// All webviews lost focus for keyboard events.
WebViewBlurred,
/// Wether or not to unload a document

6
components/shared/embedder/webdriver.rs
View file

@ -22,7 +22,7 @@ use style_traits::CSSPixel;
use webdriver::error::ErrorStatus;
use webrender_api::units::DevicePixel;
use crate::{FocusId, JSValue, MouseButton, MouseButtonAction, TraversalId};
use crate::{JSValue, MouseButton, MouseButtonAction, TraversalId};
#[derive(Clone, Copy, Debug, Deserialize, PartialEq, Serialize)]
pub struct WebDriverMessageId(pub usize);
@ -155,8 +155,7 @@ pub enum WebDriverCommandMsg {
/// Close the webview associated with the provided id.
CloseWebView(WebViewId, IpcSender<()>),
/// Focus the webview associated with the provided id.
/// Sends back a bool indicating whether the focus was successfully set.
FocusWebView(WebViewId, IpcSender<bool>),
FocusWebView(WebViewId),
/// Get focused webview. For now, this is only used when start new session.
GetFocusedWebView(IpcSender<Option<WebViewId>>),
/// Get webviews state
@ -298,5 +297,4 @@ pub struct WebDriverSenders {
pub load_status_senders: HashMap<WebViewId, GenericSender<WebDriverLoadStatus>>,
pub script_evaluation_interrupt_sender: Option<IpcSender<WebDriverJSResult>>,
pub pending_traversals: HashMap<TraversalId, GenericSender<WebDriverLoadStatus>>,
pub pending_focus: HashMap<FocusId, IpcSender<bool>>,
}

11
components/webdriver_server/lib.rs
View file

@ -2515,15 +2515,8 @@ impl Handler {
}
}
fn focus_webview(&self, webview_id: WebViewId) -> Result<(), WebDriverError> {
let (sender, receiver) = ipc::channel().unwrap();
self.send_message_to_embedder(WebDriverCommandMsg::FocusWebView(webview_id, sender))?;
if wait_for_ipc_response(receiver)? {
debug!("Focus new webview {webview_id} successfully");
} else {
debug!("Focus new webview failed, it may not exist anymore");
}
Ok(())
fn focus_webview(&self, webview_id: WebViewId) -> WebDriverResult<()> {
self.send_message_to_embedder(WebDriverCommandMsg::FocusWebView(webview_id))
}
fn focus_browsing_context(&self, browsing_cotext_id: BrowsingContextId) -> WebDriverResult<()> {

5
ports/servoshell/desktop/app.rs
View file

@ -381,10 +381,9 @@ impl App {
warn!("Failed to send response of CloseWebView: {error}");
}
},
WebDriverCommandMsg::FocusWebView(webview_id, response_sender) => {
WebDriverCommandMsg::FocusWebView(webview_id) => {
if let Some(webview) = running_state.webview_by_id(webview_id) {
let focus_id = webview.focus_and_raise_to_top(true);
running_state.set_pending_focus(focus_id, response_sender);
webview.focus_and_raise_to_top(true);
}
},
WebDriverCommandMsg::FocusBrowsingContext(..) => {

23
ports/servoshell/desktop/app_state.rs
View file

@ -21,10 +21,10 @@ use servo::ipc_channel::ipc::IpcSender;
use servo::webrender_api::ScrollLocation;
use servo::webrender_api::units::{DeviceIntPoint, DeviceIntSize};
use servo::{
AllowOrDenyRequest, AuthenticationRequest, FilterPattern, FocusId, FormControl,
GamepadHapticEffectType, JSValue, KeyboardEvent, LoadStatus, PermissionRequest, Servo,
ServoDelegate, ServoError, SimpleDialog, TraversalId, WebDriverCommandMsg, WebDriverJSResult,
WebDriverLoadStatus, WebDriverUserPrompt, WebView, WebViewBuilder, WebViewDelegate,
AllowOrDenyRequest, AuthenticationRequest, FilterPattern, FormControl, GamepadHapticEffectType,
JSValue, KeyboardEvent, LoadStatus, PermissionRequest, Servo, ServoDelegate, ServoError,
SimpleDialog, TraversalId, WebDriverCommandMsg, WebDriverJSResult, WebDriverLoadStatus,
WebDriverUserPrompt, WebView, WebViewBuilder, WebViewDelegate,
};
use url::Url;
@ -466,13 +466,6 @@ impl RunningAppState {
});
}
pub(crate) fn set_pending_focus(&self, focus_id: FocusId, sender: IpcSender<bool>) {
self.webdriver_senders
.borrow_mut()
.pending_focus
.insert(focus_id, sender);
}
pub(crate) fn set_pending_traversal(
&self,
traversal_id: TraversalId,
@ -668,14 +661,6 @@ impl WebViewDelegate for RunningAppState {
self.close_webview(webview.id());
}
fn notify_focus_complete(&self, webview: servo::WebView, focus_id: FocusId) {
let mut webdriver_state = self.webdriver_senders.borrow_mut();
if let Entry::Occupied(entry) = webdriver_state.pending_focus.entry(focus_id) {
let sender = entry.remove();
let _ = sender.send(webview.focused());
}
}
fn notify_focus_changed(&self, webview: servo::WebView, focused: bool) {
let mut inner_mut = self.inner_mut();
if focused {

42
ports/servoshell/egl/app_state.rs
View file

@ -24,10 +24,10 @@ use servo::servo_geometry::DeviceIndependentPixel;
use servo::webrender_api::ScrollLocation;
use servo::webrender_api::units::{DeviceIntRect, DeviceIntSize, DevicePixel};
use servo::{
AllowOrDenyRequest, FocusId, ImeEvent, InputEvent, LoadStatus, MouseButtonEvent,
MouseMoveEvent, NavigationRequest, PermissionRequest, RenderingContext, Servo, ServoDelegate,
ServoError, SimpleDialog, TraversalId, WebDriverCommandMsg, WebDriverLoadStatus,
WebDriverScriptCommand, WebView, WebViewBuilder, WebViewDelegate, WindowRenderingContext,
AllowOrDenyRequest, ImeEvent, InputEvent, LoadStatus, MouseButtonEvent, MouseMoveEvent,
NavigationRequest, PermissionRequest, RenderingContext, Servo, ServoDelegate, ServoError,
SimpleDialog, TraversalId, WebDriverCommandMsg, WebDriverLoadStatus, WebDriverScriptCommand,
WebView, WebViewBuilder, WebViewDelegate, WindowRenderingContext,
};
use url::Url;
@ -218,16 +218,6 @@ impl WebViewDelegate for RunningAppState {
}
}
fn notify_focus_complete(&self, webview: servo::WebView, focus_id: FocusId) {
let mut webdriver_state = self.webdriver_senders.borrow_mut();
if let std::collections::hash_map::Entry::Occupied(entry) =
webdriver_state.pending_focus.entry(focus_id)
{
let sender = entry.remove();
let _ = sender.send(webview.focused());
}
}
fn notify_traversal_complete(&self, _webview: servo::WebView, traversal_id: TraversalId) {
let mut webdriver_state = self.webdriver_senders.borrow_mut();
if let std::collections::hash_map::Entry::Occupied(entry) =
@ -393,13 +383,6 @@ impl RunningAppState {
.script_evaluation_interrupt_sender = sender;
}
pub(crate) fn set_pending_focus(&self, focus_id: FocusId, sender: IpcSender<bool>) {
self.webdriver_senders
.borrow_mut()
.pending_focus
.insert(focus_id, sender);
}
pub(crate) fn set_pending_traversal(
&self,
traversal_id: TraversalId,
@ -642,19 +625,10 @@ impl RunningAppState {
WebDriverCommandMsg::CloseWebView(webview_id, response_sender) => {
info!("(Not Implemented) Closing webview {}", webview_id);
},
WebDriverCommandMsg::FocusWebView(webview_id, response_sender) => {
if self.inner().webviews.contains_key(&webview_id) {
if let Some(webview) = self.webview_by_id(webview_id) {
let focus_id = webview.focus();
info!("Successfully focused webview {}", webview_id);
self.set_pending_focus(focus_id, response_sender.clone());
} else {
warn!("Webview {} not found after cleanup", webview_id);
let _ = response_sender.send(false);
}
} else {
warn!("Webview {} not found for focusing", webview_id);
let _ = response_sender.send(false);
WebDriverCommandMsg::FocusWebView(webview_id) => {
if let Some(webview) = self.webview_by_id(webview_id) {
let focus_id = webview.focus();
info!("Successfully focused webview {}", webview_id);
}
},
WebDriverCommandMsg::IsWebViewOpen(webview_id, response_sender) => {

2
tests/wpt/meta/webdriver/tests/classic/send_alert_text/send.py.ini vendored
View file

@ -15,4 +15,4 @@
expected: FAIL
[test_chained_alert_element_not_interactable[confirm\]]
expected: FAIL
expected: [PASS, FAIL]