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

Rework “visible” to “throttled” in constellation + script + compositor (#31816)

Browse source
This commit is contained in:
Delan Azabani 2024-03-22 14:06:28 +08:00 • committed by GitHub
parent 9b26dca141
commit 8882507ad0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 124 additions and 129 deletions
Download patch file Download diff file Expand all files Collapse all files

16
components/constellation/browsingcontext.rs
View file

@ -32,9 +32,9 @@ pub struct NewBrowsingContextInfo {
/// Whether this browsing context inherits a secure context.
pub inherited_secure_context: Option<bool>,
/// Whether this browsing context should be treated as visible for the
/// purposes of scheduling and resource management.
pub is_visible: bool,
/// Whether this browsing context should be throttled, using less resources
/// by stopping animations and running timers at a heavily limited rate.
pub throttled: bool,
}
/// The constellation's view of a browsing context.
@ -62,9 +62,9 @@ pub struct BrowsingContext {
/// Whether this browsing context inherits a secure context.
pub inherited_secure_context: Option<bool>,
/// Whether this browsing context should be treated as visible for the
/// purposes of scheduling and resource management.
pub is_visible: bool,
/// Whether this browsing context should be throttled, using less resources
/// by stopping animations and running timers at a heavily limited rate.
pub throttled: bool,
/// The pipeline for the current session history entry.
pub pipeline_id: PipelineId,
@ -90,7 +90,7 @@ impl BrowsingContext {
size: Size2D<f32, CSSPixel>,
is_private: bool,
inherited_secure_context: Option<bool>,
is_visible: bool,
throttled: bool,
) -> BrowsingContext {
let mut pipelines = HashSet::new();
pipelines.insert(pipeline_id);
@ -101,7 +101,7 @@ impl BrowsingContext {
size,
is_private,
inherited_secure_context,
is_visible,
throttled,
pipeline_id,
parent_pipeline_id,
pipelines,

88
components/constellation/constellation.rs
View file

@ -127,7 +127,7 @@ use msg::constellation_msg::{
BackgroundHangMonitorControlMsg, BackgroundHangMonitorRegister, BroadcastChannelRouterId,
BrowsingContextGroupId, BrowsingContextId, HangMonitorAlert, HistoryStateId, MessagePortId,
MessagePortRouterId, PipelineId, PipelineNamespace, PipelineNamespaceId,
PipelineNamespaceRequest, TopLevelBrowsingContextId, TraversalDirection,
PipelineNamespaceRequest, TopLevelBrowsingContextId, TraversalDirection, WebViewId,
};
use net_traits::pub_domains::reg_host;
use net_traits::request::{Referrer, RequestBuilder};
@ -956,7 +956,7 @@ where
load_data: LoadData,
sandbox: IFrameSandboxState,
is_private: bool,
is_visible: bool,
throttled: bool,
) {
if self.shutting_down {
return;
@ -1051,7 +1051,7 @@ where
},
event_loop,
load_data,
prev_visibility: is_visible,
prev_throttled: throttled,
webrender_api_sender: self.webrender_api_ipc_sender.clone(),
webrender_image_api_sender: self.webrender_image_api_sender.clone(),
webrender_document: self.webrender_document,
@ -1135,7 +1135,7 @@ where
size: Size2D<f32, CSSPixel>,
is_private: bool,
inherited_secure_context: Option<bool>,
is_visible: bool,
throttled: bool,
) {
debug!("{}: Creating new browsing context", browsing_context_id);
let bc_group_id = match self
@ -1168,7 +1168,7 @@ where
size,
is_private,
inherited_secure_context,
is_visible,
throttled,
);
self.browsing_contexts
.insert(browsing_context_id, browsing_context);
@ -1536,7 +1536,7 @@ where
self.handle_media_session_action_msg(action);
},
FromCompositorMsg::SetWebViewThrottled(webview_id, throttled) => {
self.notify_webview_visibility(webview_id, !throttled);
self.set_webview_throttled(webview_id, throttled);
},
FromCompositorMsg::ReadyToPresent(top_level_browsing_context_id) => {
self.embedder_proxy.send((
@ -1712,8 +1712,8 @@ where
FromScriptMsg::Focus => {
self.handle_focus_msg(source_pipeline_id);
},
FromScriptMsg::VisibilityChangeComplete(is_visible) => {
self.handle_visibility_change_complete(source_pipeline_id, is_visible);
FromScriptMsg::SetThrottledComplete(throttled) => {
self.handle_set_throttled_complete(source_pipeline_id, throttled);
},
FromScriptMsg::RemoveIFrame(browsing_context_id, response_sender) => {
let removed_pipeline_ids = self.handle_remove_iframe_msg(browsing_context_id);
@ -2790,7 +2790,7 @@ where
};
let window_size = browsing_context.size;
let pipeline_id = browsing_context.pipeline_id;
let is_visible = browsing_context.is_visible;
let throttled = browsing_context.throttled;
let pipeline = match self.pipelines.get(&pipeline_id) {
Some(p) => p,
@ -2837,7 +2837,7 @@ where
new_load_data,
sandbox,
is_private,
is_visible,
throttled,
);
self.add_pending_change(SessionHistoryChange {
top_level_browsing_context_id,
@ -2953,7 +2953,7 @@ where
);
let sandbox = IFrameSandboxState::IFrameUnsandboxed;
let is_private = false;
let is_visible = true;
let throttled = false;
// Register this new top-level browsing context id as a webview and set
// its focused browsing context to be itself.
@ -2984,7 +2984,7 @@ where
load_data,
sandbox,
is_private,
is_visible,
throttled,
);
self.add_pending_change(SessionHistoryChange {
top_level_browsing_context_id,
@ -2995,7 +2995,7 @@ where
parent_pipeline_id: None,
is_private,
inherited_secure_context: None,
is_visible,
throttled,
}),
window_size,
});
@ -3197,7 +3197,7 @@ where
// https://github.com/rust-lang/rust/issues/59159
let browsing_context_size = browsing_context.size;
let browsing_context_is_visible = browsing_context.is_visible;
let browsing_context_throttled = browsing_context.throttled;
// TODO(servo#30571) revert to debug_assert_eq!() once underlying bug is fixed
#[cfg(debug_assertions)]
if !(browsing_context_size == load_info.window_size.initial_viewport) {
@ -3215,7 +3215,7 @@ where
load_info.load_data,
load_info.sandbox,
is_private,
browsing_context_is_visible,
browsing_context_throttled,
);
self.add_pending_change(SessionHistoryChange {
top_level_browsing_context_id,
@ -3248,9 +3248,9 @@ where
)
},
};
let (is_parent_private, is_parent_visible, is_parent_secure) =
let (is_parent_private, is_parent_throttled, is_parent_secure) =
match self.browsing_contexts.get(&parent_browsing_context_id) {
Some(ctx) => (ctx.is_private, ctx.is_visible, ctx.inherited_secure_context),
Some(ctx) => (ctx.is_private, ctx.throttled, ctx.inherited_secure_context),
None => {
return warn!(
"{}: New iframe {} loaded in closed parent browsing context",
@ -3266,7 +3266,7 @@ where
None,
script_sender,
self.compositor_proxy.clone(),
is_parent_visible,
is_parent_throttled,
load_info.load_data,
);
@ -3282,7 +3282,7 @@ where
parent_pipeline_id: Some(parent_pipeline_id),
is_private,
inherited_secure_context: is_parent_secure,
is_visible: is_parent_visible,
throttled: is_parent_throttled,
}),
window_size: load_info.window_size.initial_viewport,
});
@ -3307,9 +3307,9 @@ where
);
},
};
let (is_opener_private, is_opener_visible, is_opener_secure) =
let (is_opener_private, is_opener_throttled, is_opener_secure) =
match self.browsing_contexts.get(&opener_browsing_context_id) {
Some(ctx) => (ctx.is_private, ctx.is_visible, ctx.inherited_secure_context),
Some(ctx) => (ctx.is_private, ctx.throttled, ctx.inherited_secure_context),
None => {
return warn!(
"{}: New auxiliary {} loaded in closed opener browsing context",
@ -3324,7 +3324,7 @@ where
Some(opener_browsing_context_id),
script_sender,
self.compositor_proxy.clone(),
is_opener_visible,
is_opener_throttled,
load_data,
);
@ -3367,7 +3367,7 @@ where
parent_pipeline_id: None,
is_private: is_opener_private,
inherited_secure_context: is_opener_secure,
is_visible: is_opener_visible,
throttled: is_opener_throttled,
}),
window_size: self.window_size.initial_viewport,
});
@ -3470,14 +3470,14 @@ where
return None;
},
};
let (window_size, pipeline_id, parent_pipeline_id, is_private, is_visible) =
let (window_size, pipeline_id, parent_pipeline_id, is_private, is_throttled) =
match self.browsing_contexts.get(&browsing_context_id) {
Some(ctx) => (
ctx.size,
ctx.pipeline_id,
ctx.parent_pipeline_id,
ctx.is_private,
ctx.is_visible,
ctx.throttled,
),
None => {
// This should technically never happen (since `load_url` is
@ -3553,7 +3553,7 @@ where
load_data,
sandbox,
is_private,
is_visible,
is_throttled,
);
self.add_pending_change(SessionHistoryChange {
top_level_browsing_context_id,
@ -3827,7 +3827,7 @@ where
parent_pipeline_id,
window_size,
is_private,
is_visible,
throttled,
) = match self.browsing_contexts.get(&browsing_context_id) {
Some(ctx) => (
ctx.top_level_id,
@ -3835,7 +3835,7 @@ where
ctx.parent_pipeline_id,
ctx.size,
ctx.is_private,
ctx.is_visible,
ctx.throttled,
),
None => return warn!("No browsing context to traverse!"),
};
@ -3854,7 +3854,7 @@ where
load_data.clone(),
sandbox,
is_private,
is_visible,
throttled,
);
self.add_pending_change(SessionHistoryChange {
top_level_browsing_context_id: top_level_id,
@ -3886,7 +3886,7 @@ where
};
if let Some(old_pipeline) = self.pipelines.get(&old_pipeline_id) {
old_pipeline.notify_visibility(false);
old_pipeline.set_throttled(true);
}
if let Some(new_pipeline) = self.pipelines.get(&new_pipeline_id) {
if let Some(ref chan) = self.devtools_sender {
@ -3904,7 +3904,7 @@ where
));
}
new_pipeline.notify_visibility(true);
new_pipeline.set_throttled(false);
}
self.update_activity(old_pipeline_id);
@ -4267,7 +4267,7 @@ where
result
}
fn handle_visibility_change_complete(&mut self, pipeline_id: PipelineId, visibility: bool) {
fn handle_set_throttled_complete(&mut self, pipeline_id: PipelineId, throttled: bool) {
let browsing_context_id = match self.pipelines.get(&pipeline_id) {
Some(pipeline) => pipeline.browsing_context_id,
None => {
@ -4285,14 +4285,14 @@ where
};
if let Some(parent_pipeline_id) = parent_pipeline_id {
let visibility_msg = ConstellationControlMsg::NotifyVisibilityChange(
let msg = ConstellationControlMsg::SetThrottledInContainingIframe(
parent_pipeline_id,
browsing_context_id,
visibility,
throttled,
);
let result = match self.pipelines.get(&parent_pipeline_id) {
None => return warn!("{}: Parent pipeline closed", parent_pipeline_id),
Some(parent_pipeline) => parent_pipeline.event_loop.send(visibility_msg),
Some(parent_pipeline) => parent_pipeline.event_loop.send(msg),
};
if let Err(e) = result {
@ -4454,21 +4454,17 @@ where
}
}
fn notify_webview_visibility(
&mut self,
top_level_browsing_context_id: TopLevelBrowsingContextId,
visible: bool,
) {
let browsing_context_id = BrowsingContextId::from(top_level_browsing_context_id);
fn set_webview_throttled(&mut self, webview_id: WebViewId, throttled: bool) {
let browsing_context_id = BrowsingContextId::from(webview_id);
let pipeline_id = match self.browsing_contexts.get(&browsing_context_id) {
Some(browsing_context) => browsing_context.pipeline_id,
None => {
return warn!("{browsing_context_id}: Tried to notify visibility after closure");
return warn!("{browsing_context_id}: Tried to SetWebViewThrottled after closure");
},
};
match self.pipelines.get(&pipeline_id) {
None => warn!("{pipeline_id}: Tried to notify visibility after closure"),
Some(pipeline) => pipeline.notify_visibility(visible),
None => warn!("{pipeline_id}: Tried to SetWebViewThrottled after closure"),
Some(pipeline) => pipeline.set_throttled(throttled),
}
}
@ -4664,13 +4660,13 @@ where
change.window_size,
new_context_info.is_private,
new_context_info.inherited_secure_context,
new_context_info.is_visible,
new_context_info.throttled,
);
self.update_activity(change.new_pipeline_id);
},
Some(old_pipeline_id) => {
if let Some(pipeline) = self.pipelines.get(&old_pipeline_id) {
pipeline.notify_visibility(false);
pipeline.set_throttled(true);
}
// https://html.spec.whatwg.org/multipage/#unload-a-document

27
components/constellation/pipeline.rs
View file

@ -178,11 +178,11 @@ pub struct InitialPipelineState {
/// Information about the page to load.
pub load_data: LoadData,
/// Whether the browsing context in which pipeline is embedded is visible
/// for the purposes of scheduling and resource management. This field is
/// only used to notify script and compositor threads after spawning
/// a pipeline.
pub prev_visibility: bool,
/// Whether the browsing context in which pipeline is embedded is throttled,
/// using less resources by stopping animations and running timers at a
/// heavily limited rate. This field is only used to notify script and
/// compositor threads after spawning a pipeline.
pub prev_throttled: bool,
/// Webrender api.
pub webrender_image_api_sender: net_traits::WebrenderIpcSender,
@ -339,7 +339,7 @@ impl Pipeline {
state.opener,
script_chan,
state.compositor_proxy,
state.prev_visibility,
state.prev_throttled,
state.load_data,
);
Ok(NewPipeline {
@ -356,7 +356,7 @@ impl Pipeline {
opener: Option<BrowsingContextId>,
event_loop: Rc<EventLoop>,
compositor_proxy: CompositorProxy,
is_visible: bool,
throttled: bool,
load_data: LoadData,
) -> Pipeline {
let pipeline = Pipeline {
@ -377,7 +377,7 @@ impl Pipeline {
layout_epoch: Epoch(0),
};
pipeline.notify_visibility(is_visible);
pipeline.set_throttled(throttled);
pipeline
}
@ -458,13 +458,14 @@ impl Pipeline {
}
}
/// Notify the script thread that this pipeline is visible.
pub fn notify_visibility(&self, is_visible: bool) {
let script_msg = ConstellationControlMsg::ChangeFrameVisibilityStatus(self.id, is_visible);
let compositor_msg = CompositorMsg::PipelineVisibilityChanged(self.id, is_visible);
/// Set whether to make pipeline use less resources, by stopping animations and
/// running timers at a heavily limited rate.
pub fn set_throttled(&self, throttled: bool) {
let script_msg = ConstellationControlMsg::SetThrottled(self.id, throttled);
let compositor_msg = CompositorMsg::SetThrottled(self.id, throttled);
let err = self.event_loop.send(script_msg);
if let Err(e) = err {
warn!("Sending visibility change failed ({}).", e);
warn!("Sending SetThrottled to script failed ({}).", e);
}
self.compositor_proxy.send(compositor_msg);
}

2
components/constellation/tracing.rs
View file

@ -165,7 +165,7 @@ mod from_script {
Self::ReplaceHistoryState(_, _) => target!("ReplaceHistoryState"),
Self::JointSessionHistoryLength(_) => target!("JointSessionHistoryLength"),
Self::RemoveIFrame(_, _) => target!("RemoveIFrame"),
Self::VisibilityChangeComplete(_) => target!("VisibilityChangeComplete"),
Self::SetThrottledComplete(_) => target!("SetThrottledComplete"),
Self::ScriptLoadedURLInIFrame(_) => target!("ScriptLoadedURLInIFrame"),
Self::ScriptNewIFrame(_) => target!("ScriptNewIFrame"),
Self::ScriptNewAuxiliary(_) => target!("ScriptNewAuxiliary"),