Skip to content

armgit / moli

Public Imported from GitHub
0

Best headless browser for AI agents. Lite, Fast, High-Compatibility. Built in Rust

refactor(renderer): unify document settings application

ldm0674a2fd9dfc8
diff --git a/moli-protocol/src/conn/browser_context/target_session_owner.rs b/moli-protocol/src/conn/browser_context/target_session_owner.rs
index 91d6b3b14..016b07df6 100644
--- a/moli-protocol/src/conn/browser_context/target_session_owner.rs
+++ b/moli-protocol/src/conn/browser_context/target_session_owner.rs
@@ -186,6 +186,22 @@ pub(crate) struct TargetNavigationLoadInputs {
}
impl TargetNavigationLoadInputs {
+ pub(crate) fn document_settings_snapshot(
+ &self,
+ idle_override: Option<moli_page_types::EmulatedIdleOverride>,
+ ) -> moli_page_types::DocumentSettings {
+ moli_page_types::DocumentSettings {
+ script_execution_disabled: self.script_execution_disabled,
+ scrollbars_hidden: self.scrollbars_hidden,
+ bypass_content_security_policy: self.bypass_content_security_policy,
+ emulated_media: self.emulated_media.clone(),
+ idle_override,
+ navigator_overrides: self.navigator_overrides.clone(),
+ viewport_surface: self.viewport_surface,
+ document_activity: self.document_activity,
+ }
+ }
+
pub(crate) fn with_main_document_commit_seed(
mut self,
seed: RendererMainDocumentCommitSeed,
diff --git a/moli-protocol/src/conn/runtime_load.rs b/moli-protocol/src/conn/runtime_load.rs
index 3bd7f7216..ef69ec2f8 100644
--- a/moli-protocol/src/conn/runtime_load.rs
+++ b/moli-protocol/src/conn/runtime_load.rs
@@ -1465,6 +1465,7 @@ impl CdpConnection {
) -> anyhow::Result<PreparedDocumentPageCommitConfiguration> {
let idle_override = self.idle_override_for_navigation(owner, final_url);
let load_inputs = self.navigation_load_inputs_for_owner(owner);
+ let document_settings = load_inputs.document_settings_snapshot(idle_override);
// The renderer runtime is shared by the BrowserContext, but each Page
// target owns its NavigationEngine and may have a different transport
// identity. Resolve through that target's engine at the commit
@@ -1489,16 +1490,7 @@ impl CdpConnection {
runtime_isolated_worlds: Vec::new(),
permission_overrides: load_inputs.permission_overrides,
extra_http_headers: load_inputs.extra_http_headers,
- document_settings: moli_page_types::DocumentSettings {
- script_execution_disabled: load_inputs.script_execution_disabled,
- scrollbars_hidden: load_inputs.scrollbars_hidden,
- bypass_content_security_policy: load_inputs.bypass_content_security_policy,
- emulated_media: load_inputs.emulated_media,
- idle_override,
- navigator_overrides: load_inputs.navigator_overrides,
- viewport_surface: load_inputs.viewport_surface,
- document_activity: load_inputs.document_activity,
- },
+ document_settings,
browser_resource_runtime,
navigator_identity,
network_offline: load_inputs.network_offline,
diff --git a/moli-protocol/src/domains/emulation/tests/scrollbars.rs b/moli-protocol/src/domains/emulation/tests/scrollbars.rs
index 09ab38619..159ce7687 100644
--- a/moli-protocol/src/domains/emulation/tests/scrollbars.rs
+++ b/moli-protocol/src/domains/emulation/tests/scrollbars.rs
@@ -127,6 +127,22 @@ async fn scrollbars_hidden_is_replayed_before_navigation_scripts_and_initial_pag
bc.set_target_url("about:blank".to_owned());
bc.attach_active_session("SID-1");
ctx.conn.install_browser_context_fixture_for_test(bc);
+ expect_session_command_result(
+ &mut ctx,
+ 88502,
+ "SID-1",
+ "Emulation.setEmulatedMedia",
+ json!({"features":[{"name":"prefers-color-scheme","value":"dark"}]}),
+ )
+ .await;
+ expect_session_command_result(
+ &mut ctx,
+ 88503,
+ "SID-1",
+ "Emulation.setDeviceMetricsOverride",
+ json!({"width":900,"height":500,"deviceScaleFactor":1,"mobile":false}),
+ )
+ .await;
set_hidden(&mut ctx, "SID-1", true).await;
// Materialize the staged about:blank Page first, then navigate to a new
// Document. Both direct HTML creation and prepared commit must inherit.
@@ -152,7 +168,7 @@ async fn scrollbars_hidden_is_replayed_before_navigation_scripts_and_initial_pag
for hidden in [true, false, true] {
set_hidden(&mut ctx, "SID-1", hidden).await;
let html = format!(
- "{HTML}<script>globalThis.__initial = [innerWidth,document.documentElement.clientWidth,scroller.clientWidth];</script>"
+ "{HTML}<script>globalThis.__initial = [innerWidth,document.documentElement.clientWidth,scroller.clientWidth,matchMedia('(prefers-color-scheme: dark)').matches];</script>"
);
ctx.install_buffered_navigation_fixture_for_session_owner(
url::Url::parse("https://scrollbars.example/next").unwrap(),
@@ -168,6 +184,8 @@ async fn scrollbars_hidden_is_replayed_before_navigation_scripts_and_initial_pag
evaluate(&mut ctx, "__initial[2]").await,
json!(if hidden { 200 } else { 185 })
);
+ assert_eq!(evaluate(&mut ctx, "__initial[0]").await, json!(900));
+ assert_eq!(evaluate(&mut ctx, "__initial[3]").await, json!(true));
}
}
diff --git a/moli-renderer-v8/src/runtime/mod.rs b/moli-renderer-v8/src/runtime/mod.rs
index a1f8df57e..e2383a5f5 100644
--- a/moli-renderer-v8/src/runtime/mod.rs
+++ b/moli-renderer-v8/src/runtime/mod.rs
@@ -69,6 +69,7 @@ mod page_generated_dom;
mod page_geometry;
mod page_network;
mod page_screenshot;
+mod page_settings;
mod page_state;
mod page_surface;
mod page_turn_scheduler;
diff --git a/moli-renderer-v8/src/runtime/page_commands.rs b/moli-renderer-v8/src/runtime/page_commands.rs
index f26d2caf8..4d750aeae 100644
--- a/moli-renderer-v8/src/runtime/page_commands.rs
+++ b/moli-renderer-v8/src/runtime/page_commands.rs
@@ -1116,7 +1116,7 @@ impl PageVm {
Ok(RendererPageReply::Unit)
}
RendererPageCommand::SetScriptExecutionDisabled(disabled) => {
- self.set_script_execution_disabled(disabled);
+ self.set_script_execution_disabled(disabled)?;
Ok(RendererPageReply::Unit)
}
RendererPageCommand::SetScrollbarsHidden(hidden) => {
@@ -1124,11 +1124,11 @@ impl PageVm {
Ok(RendererPageReply::Unit)
}
RendererPageCommand::SetBypassContentSecurityPolicy(bypass) => {
- self.set_bypass_content_security_policy(bypass);
+ self.set_bypass_content_security_policy(bypass)?;
Ok(RendererPageReply::Unit)
}
RendererPageCommand::SetEmulatedMedia(overrides) => {
- self.set_emulated_media(&overrides);
+ self.set_emulated_media(&overrides)?;
Ok(RendererPageReply::Unit)
}
RendererPageCommand::SetViewportSurface(viewport_surface) => {
diff --git a/moli-renderer-v8/src/runtime/page_network.rs b/moli-renderer-v8/src/runtime/page_network.rs
index dfb7444f7..e338d31b6 100644
--- a/moli-renderer-v8/src/runtime/page_network.rs
+++ b/moli-renderer-v8/src/runtime/page_network.rs
@@ -149,77 +149,6 @@ impl PageVm {
self.vm_mut().set_permission_overrides(overrides);
}
- pub(crate) fn set_script_execution_disabled(&mut self, disabled: bool) {
- self.document_settings.script_execution_disabled = disabled;
- self.vm_mut().set_script_execution_disabled(disabled);
- }
-
- pub(crate) fn set_scrollbars_hidden(&mut self, hidden: bool) -> anyhow::Result<()> {
- let previous = self
- .layout_configuration
- .scrollbars_hidden_for(self.document_settings.scrollbars_hidden);
- self.document_settings.scrollbars_hidden = hidden;
- let hidden = self.layout_configuration.scrollbars_hidden_for(hidden);
- if previous == hidden {
- return Ok(());
- }
- self.vm_mut().set_scrollbars_hidden(hidden);
- // Emulation changes the published geometry of this live Page. Finish
- // that update before acknowledging the command to subsequent reads.
- self.vm_mut().publish_layout()
- }
-
- pub(crate) fn set_bypass_content_security_policy(&mut self, bypass: bool) {
- self.document_settings.bypass_content_security_policy = bypass;
- self.vm_mut().set_bypass_content_security_policy(bypass);
- }
-
- pub(crate) fn set_emulated_media(
- &mut self,
- overrides: &crate::protocol_types::EmulatedMediaOverrides,
- ) {
- self.document_settings.emulated_media = overrides.clone();
- self.vm_mut().set_emulated_media(overrides);
- }
-
- pub(crate) fn set_idle_override(
- &mut self,
- idle_override: Option<crate::protocol_types::EmulatedIdleOverride>,
- ) -> anyhow::Result<()> {
- self.vm_mut()
- .set_idle_override_and_sync_surface(idle_override)?;
- self.document_settings.idle_override = idle_override;
- Ok(())
- }
-
- pub(crate) fn set_viewport_surface(
- &mut self,
- viewport_surface: Option<crate::protocol_types::ViewportSurface>,
- ) -> anyhow::Result<()> {
- self.vm_mut().set_viewport_surface(viewport_surface)?;
- self.document_settings.viewport_surface = viewport_surface;
- Ok(())
- }
-
- pub(crate) fn set_navigator_overrides(
- &mut self,
- overrides: &moli_page_types::NavigatorOverrides,
- ) -> anyhow::Result<()> {
- self.vm_mut()
- .set_navigator_overrides_and_sync_surface(overrides)?;
- self.document_settings.navigator_overrides = overrides.clone();
- Ok(())
- }
-
- pub(crate) fn set_document_activity(
- &mut self,
- activity: moli_page_types::DocumentActivity,
- ) -> anyhow::Result<()> {
- self.vm_mut().set_document_activity(activity)?;
- self.document_settings.document_activity = activity;
- Ok(())
- }
-
pub(crate) fn set_network_offline(&mut self, offline: bool) {
self.network_offline = offline;
self.vm_mut().set_network_offline(offline);
diff --git a/moli-renderer-v8/src/runtime/page_screenshot.rs b/moli-renderer-v8/src/runtime/page_screenshot.rs
index 38ce36c75..580776f4b 100644
--- a/moli-renderer-v8/src/runtime/page_screenshot.rs
+++ b/moli-renderer-v8/src/runtime/page_screenshot.rs
@@ -207,7 +207,7 @@ impl PageVm {
let previous = self.document_settings.emulated_media.clone();
let mut print = previous.clone();
print.media = Some("print".to_owned());
- self.set_emulated_media(&print);
+ self.set_emulated_media(&print)?;
Some(previous)
} else {
None
@@ -223,7 +223,7 @@ impl PageVm {
},
);
if let Some(previous) = restore_media {
- self.set_emulated_media(&previous);
+ self.set_emulated_media(&previous)?;
}
result.map(RendererImageCaptureOutcome::into_screenshot_reply)
}
diff --git a/moli-renderer-v8/src/runtime/page_settings.rs b/moli-renderer-v8/src/runtime/page_settings.rs
new file mode 100644
index 000000000..5927bc72e
--- /dev/null
+++ b/moli-renderer-v8/src/runtime/page_settings.rs
@@ -0,0 +1,70 @@
+use super::*;
+use crate::script_vm::{DocumentSetting, DocumentSettingEffect, DocumentSettingsApplication};
+
+impl PageVm {
+ fn apply_document_setting(&mut self, setting: DocumentSetting<'_>) -> anyhow::Result<()> {
+ let layout = self.layout_configuration;
+ let effect = self.vm_mut().apply_document_setting(
+ setting,
+ layout,
+ DocumentSettingsApplication::Live,
+ )?;
+ // Retain the target value before publication. Even if publication
+ // fails, a followed navigation must inherit the accepted native input.
+ setting.retain_in(&mut self.document_settings);
+ if effect == DocumentSettingEffect::PublishLayout {
+ self.vm_mut().publish_layout()?;
+ }
+ Ok(())
+ }
+
+ pub(crate) fn set_script_execution_disabled(&mut self, disabled: bool) -> anyhow::Result<()> {
+ self.apply_document_setting(DocumentSetting::ScriptExecutionDisabled(disabled))
+ }
+
+ pub(crate) fn set_scrollbars_hidden(&mut self, hidden: bool) -> anyhow::Result<()> {
+ self.apply_document_setting(DocumentSetting::ScrollbarsHidden(hidden))
+ }
+
+ pub(crate) fn set_bypass_content_security_policy(
+ &mut self,
+ bypass: bool,
+ ) -> anyhow::Result<()> {
+ self.apply_document_setting(DocumentSetting::BypassContentSecurityPolicy(bypass))
+ }
+
+ pub(crate) fn set_emulated_media(
+ &mut self,
+ overrides: &crate::protocol_types::EmulatedMediaOverrides,
+ ) -> anyhow::Result<()> {
+ self.apply_document_setting(DocumentSetting::EmulatedMedia(overrides))
+ }
+
+ pub(crate) fn set_idle_override(
+ &mut self,
+ idle_override: Option<crate::protocol_types::EmulatedIdleOverride>,
+ ) -> anyhow::Result<()> {
+ self.apply_document_setting(DocumentSetting::IdleOverride(idle_override))
+ }
+
+ pub(crate) fn set_viewport_surface(
+ &mut self,
+ viewport_surface: Option<crate::protocol_types::ViewportSurface>,
+ ) -> anyhow::Result<()> {
+ self.apply_document_setting(DocumentSetting::ViewportSurface(viewport_surface))
+ }
+
+ pub(crate) fn set_navigator_overrides(
+ &mut self,
+ overrides: &moli_page_types::NavigatorOverrides,
+ ) -> anyhow::Result<()> {
+ self.apply_document_setting(DocumentSetting::NavigatorOverrides(overrides))
+ }
+
+ pub(crate) fn set_document_activity(
+ &mut self,
+ activity: moli_page_types::DocumentActivity,
+ ) -> anyhow::Result<()> {
+ self.apply_document_setting(DocumentSetting::DocumentActivity(activity))
+ }
+}
diff --git a/moli-renderer-v8/src/runtime/page_vm/mod.rs b/moli-renderer-v8/src/runtime/page_vm/mod.rs
index ca179b23d..c80f4109c 100644
--- a/moli-renderer-v8/src/runtime/page_vm/mod.rs
+++ b/moli-renderer-v8/src/runtime/page_vm/mod.rs
@@ -4369,7 +4369,8 @@ impl PageVm {
page_vm.vm_mut().set_web_storage_handles(&env.web_storage);
page_vm
.vm_mut()
- .set_script_execution_disabled(env.document_settings.script_execution_disabled);
+ .initialize_document_settings(&env.document_settings, env.layout_configuration)
+ .map_err(|error| Box::new((error, page_vm.vm().document_runtime.dom_host().clone())))?;
page_vm
.vm_mut()
.set_permission_overrides(&env.permission_overrides);
@@ -4393,21 +4394,6 @@ impl PageVm {
page_vm
.vm_mut()
.set_stored_runtime_bindings(&env.runtime_bindings);
- page_vm
- .vm_mut()
- .set_emulated_media_for_bootstrap(&env.document_settings.emulated_media);
- page_vm
- .vm_mut()
- .set_idle_override(env.document_settings.idle_override);
- page_vm
- .vm_mut()
- .set_navigator_overrides(&env.document_settings.navigator_overrides);
- page_vm
- .vm_mut()
- .set_viewport_surface_for_bootstrap(env.document_settings.viewport_surface);
- page_vm
- .vm_mut()
- .set_document_activity_for_bootstrap(env.document_settings.document_activity);
page_vm.vm_mut().set_network_offline(env.network_offline);
page_vm
.vm_mut()
diff --git a/moli-renderer-v8/src/runtime/page_vm/tests/document_script_completion.rs b/moli-renderer-v8/src/runtime/page_vm/tests/document_script_completion.rs
index 8dfcbf2b7..596364ee5 100644
--- a/moli-renderer-v8/src/runtime/page_vm/tests/document_script_completion.rs
+++ b/moli-renderer-v8/src/runtime/page_vm/tests/document_script_completion.rs
@@ -362,7 +362,9 @@ async fn selected_disabled_document_script_does_not_flush_unrelated_runtime_work
Url::parse("https://example.com/disabled-document-script.html")
.expect("document URL"),
);
- page_vm.set_script_execution_disabled(true);
+ page_vm
+ .set_script_execution_disabled(true)
+ .expect("disable script execution");
page_vm
.vm_mut()
.enqueue_test_pending_runtime_source_load();
diff --git a/moli-renderer-v8/src/script_vm.rs b/moli-renderer-v8/src/script_vm.rs
index d317b4436..ecb340cf1 100644
--- a/moli-renderer-v8/src/script_vm.rs
+++ b/moli-renderer-v8/src/script_vm.rs
@@ -753,6 +753,10 @@ pub(crate) use post_parse_lifecycle::RuntimeOwnedModuleFailureBodySettlement;
mod browsing_contexts;
mod child_frame_runtime;
mod document_environment;
+mod document_settings;
+pub(crate) use document_settings::{
+ DocumentSetting, DocumentSettingEffect, DocumentSettingsApplication,
+};
mod execution_contexts;
mod layout;
mod prepared_scripts;
diff --git a/moli-renderer-v8/src/script_vm/document_settings.rs b/moli-renderer-v8/src/script_vm/document_settings.rs
new file mode 100644
index 000000000..6bdd52f9c
--- /dev/null
+++ b/moli-renderer-v8/src/script_vm/document_settings.rs
@@ -0,0 +1,146 @@
+use super::ScriptVm;
+use moli_page_types::{
+ DocumentActivity, DocumentSettings, EmulatedIdleOverride, EmulatedMediaOverrides,
+ LayoutConfiguration, NavigatorOverrides, ViewportSurface,
+};
+
+#[derive(Clone, Copy, PartialEq, Eq)]
+pub(crate) enum DocumentSettingsApplication {
+ Bootstrap,
+ Live,
+}
+
+#[derive(Clone, Copy, PartialEq, Eq)]
+pub(crate) enum DocumentSettingEffect {
+ Deferred,
+ PublishLayout,
+}
+
+/// A single target setting. Borrowed values avoid cloning a whole snapshot
+/// when a live command changes one property.
+#[derive(Clone, Copy)]
+pub(crate) enum DocumentSetting<'a> {
+ ScriptExecutionDisabled(bool),
+ ScrollbarsHidden(bool),
+ BypassContentSecurityPolicy(bool),
+ EmulatedMedia(&'a EmulatedMediaOverrides),
+ IdleOverride(Option<EmulatedIdleOverride>),
+ NavigatorOverrides(&'a NavigatorOverrides),
+ ViewportSurface(Option<ViewportSurface>),
+ DocumentActivity(DocumentActivity),
+}
+
+impl DocumentSetting<'_> {
+ pub(crate) fn retain_in(self, settings: &mut DocumentSettings) {
+ match self {
+ Self::ScriptExecutionDisabled(value) => settings.script_execution_disabled = value,
+ Self::ScrollbarsHidden(value) => settings.scrollbars_hidden = value,
+ Self::BypassContentSecurityPolicy(value) => {
+ settings.bypass_content_security_policy = value
+ }
+ Self::EmulatedMedia(value) => settings.emulated_media = value.clone(),
+ Self::IdleOverride(value) => settings.idle_override = value,
+ Self::NavigatorOverrides(value) => settings.navigator_overrides = value.clone(),
+ Self::ViewportSurface(value) => settings.viewport_surface = value,
+ Self::DocumentActivity(value) => settings.document_activity = value,
+ }
+ }
+}
+
+impl ScriptVm {
+ /// Installs every setting before document-start scripts. Keep this
+ /// destructure exhaustive so a new snapshot field must gain native setup.
+ pub(crate) fn initialize_document_settings(
+ &mut self,
+ settings: &DocumentSettings,
+ layout: LayoutConfiguration,
+ ) -> anyhow::Result<()> {
+ let DocumentSettings {
+ script_execution_disabled,
+ scrollbars_hidden,
+ bypass_content_security_policy,
+ emulated_media,
+ idle_override,
+ navigator_overrides,
+ viewport_surface,
+ document_activity,
+ } = settings;
+ for setting in [
+ DocumentSetting::ScriptExecutionDisabled(*script_execution_disabled),
+ DocumentSetting::BypassContentSecurityPolicy(*bypass_content_security_policy),
+ DocumentSetting::EmulatedMedia(emulated_media),
+ DocumentSetting::IdleOverride(*idle_override),
+ DocumentSetting::NavigatorOverrides(navigator_overrides),
+ DocumentSetting::ViewportSurface(*viewport_surface),
+ DocumentSetting::DocumentActivity(*document_activity),
+ DocumentSetting::ScrollbarsHidden(*scrollbars_hidden),
+ ] {
+ self.apply_document_setting(setting, layout, DocumentSettingsApplication::Bootstrap)?;
+ }
+ Ok(())
+ }
+
+ /// Bootstrap installs native inputs without environment events. Live
+ /// updates keep each setting's event and geometry-publication boundary.
+ pub(crate) fn apply_document_setting(
+ &mut self,
+ setting: DocumentSetting<'_>,
+ layout: LayoutConfiguration,
+ application: DocumentSettingsApplication,
+ ) -> anyhow::Result<DocumentSettingEffect> {
+ let live = application == DocumentSettingsApplication::Live;
+ let mut effect = DocumentSettingEffect::Deferred;
+ match setting {
+ DocumentSetting::ScriptExecutionDisabled(value) => {
+ self.set_script_execution_disabled(value)
+ }
+ DocumentSetting::BypassContentSecurityPolicy(value) => {
+ self.set_bypass_content_security_policy(value)
+ }
+ DocumentSetting::EmulatedMedia(value) => {
+ if live {
+ self.set_emulated_media(value);
+ } else {
+ self.set_emulated_media_for_bootstrap(value);
+ }
+ }
+ DocumentSetting::IdleOverride(value) => {
+ if live {
+ self.set_idle_override_and_sync_surface(value)?;
+ } else {
+ self.set_idle_override(value);
+ }
+ }
+ DocumentSetting::NavigatorOverrides(value) => {
+ if live {
+ self.set_navigator_overrides_and_sync_surface(value)?;
+ } else {
+ self.set_navigator_overrides(value);
+ }
+ }
+ DocumentSetting::ViewportSurface(value) => {
+ if live {
+ self.set_viewport_surface(value)?;
+ } else {
+ self.set_viewport_surface_for_bootstrap(value);
+ }
+ }
+ DocumentSetting::DocumentActivity(value) => {
+ if live {
+ self.set_document_activity(value)?;
+ } else {
+ self.set_document_activity_for_bootstrap(value);
+ }
+ }
+ DocumentSetting::ScrollbarsHidden(value) => {
+ let hidden = layout.scrollbars_hidden_for(value);
+ let changed = self._context_host.borrow().scrollbars_hidden() != hidden;
+ self.set_scrollbars_hidden(hidden);
+ if live && changed {
+ effect = DocumentSettingEffect::PublishLayout;
+ }
+ }
+ }
+ Ok(effect)
+ }
+}