DevTools: Display tabs and processes (#32475)

* feat: show tabs and processes on devtools

Co-authored-by: fabricedesre <fabrice@desre.org>

* chore: clean for pr

* fix: use serde renaming to avoid camel case

Co-authored-by: Martin Robinson <mrobinson@igalia.com>

* fix: serde rename all to camel case

* refactor: reduce getTab nesting level

---------

Co-authored-by: fabricedesre <fabrice@desre.org>
Co-authored-by: Martin Robinson <mrobinson@igalia.com>
This commit is contained in:
eri 2024-06-12 11:23:09 +02:00 committed by GitHub
parent 699f6960f5
commit 370fbf0331
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 108 additions and 46 deletions

View file

@ -20,11 +20,12 @@ use crate::protocol::{ActorDescription, JsonPacketStream};
use crate::StreamId;
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct ActorTraits {
sources: bool,
highlightable: bool,
customHighlighters: bool,
networkMonitor: bool,
custom_highlighters: bool,
network_monitor: bool,
}
#[derive(Serialize)]
@ -37,12 +38,13 @@ struct ListAddonsReply {
enum AddonMsg {}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct GetRootReply {
from: String,
selected: u32,
performanceActor: String,
deviceActor: String,
preferenceActor: String,
performance_actor: String,
device_actor: String,
preference_actor: String,
}
#[derive(Serialize)]
@ -59,9 +61,10 @@ struct GetTabReply {
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct RootActorMsg {
from: String,
applicationType: String,
application_type: String,
traits: ActorTraits,
}
@ -95,17 +98,28 @@ struct ListProcessesResponse {
processes: Vec<ProcessForm>,
}
#[derive(Serialize)]
struct ProcessForm {
actor: String,
id: u32,
isParent: bool,
#[derive(Default, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct DescriptorTraits {
pub(crate) watcher: bool,
pub(crate) supports_reload_descriptor: bool,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct ProcessForm {
actor: String,
id: u32,
is_parent: bool,
is_windowless_parent: bool,
traits: DescriptorTraits,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct GetProcessResponse {
from: String,
form: ProcessForm,
process_descriptor: ProcessForm,
}
pub struct RootActor {
@ -126,7 +140,7 @@ impl Actor for RootActor {
&self,
registry: &ActorRegistry,
msg_type: &str,
_msg: &Map<String, Value>,
msg: &Map<String, Value>,
stream: &mut TcpStream,
_id: StreamId,
) -> Result<ActorMessageStatus, ()> {
@ -146,7 +160,9 @@ impl Actor for RootActor {
processes: vec![ProcessForm {
actor: self.process.clone(),
id: 0,
isParent: true,
is_parent: true,
is_windowless_parent: false,
traits: Default::default(),
}],
};
let _ = stream.write_json_packet(&reply);
@ -156,10 +172,12 @@ impl Actor for RootActor {
"getProcess" => {
let reply = GetProcessResponse {
from: self.name(),
form: ProcessForm {
process_descriptor: ProcessForm {
actor: self.process.clone(),
id: 0,
isParent: true,
is_parent: true,
is_windowless_parent: false,
traits: Default::default(),
},
};
let _ = stream.write_json_packet(&reply);
@ -170,15 +188,15 @@ impl Actor for RootActor {
let actor = GetRootReply {
from: "root".to_owned(),
selected: 0,
performanceActor: self.performance.clone(),
deviceActor: self.device.clone(),
preferenceActor: self.preference.clone(),
performance_actor: self.performance.clone(),
device_actor: self.device.clone(),
preference_actor: self.preference.clone(),
};
let _ = stream.write_json_packet(&actor);
ActorMessageStatus::Processed
},
// https://docs.firefox-dev.tools/backend/protocol.html#listing-browser-tabs
// https://firefox-source-docs.mozilla.org/devtools/backend/protocol.html#listing-browser-tabs
"listTabs" => {
let actor = ListTabsReply {
from: "root".to_owned(),
@ -189,7 +207,7 @@ impl Actor for RootActor {
.map(|target| {
registry
.find::<TabDescriptorActor>(target)
.encodable(registry)
.encodable(registry, false)
})
.collect(),
};
@ -220,10 +238,18 @@ impl Actor for RootActor {
},
"getTab" => {
let tab = registry.find::<TabDescriptorActor>(&self.tabs[0]);
let Some(serde_json::Value::Number(browser_id)) = msg.get("browserId") else {
return Ok(ActorMessageStatus::Ignored);
};
let browser_id = browser_id.as_u64().unwrap();
let Some(tab) = self.get_tab_msg_by_browser_id(registry, browser_id as u32) else {
return Ok(ActorMessageStatus::Ignored);
};
let reply = GetTabReply {
from: self.name(),
tab: tab.encodable(registry),
tab,
};
let _ = stream.write_json_packet(&reply);
ActorMessageStatus::Processed
@ -250,13 +276,28 @@ impl RootActor {
pub fn encodable(&self) -> RootActorMsg {
RootActorMsg {
from: "root".to_owned(),
applicationType: "browser".to_owned(),
application_type: "browser".to_owned(),
traits: ActorTraits {
sources: false,
highlightable: true,
customHighlighters: true,
networkMonitor: false,
custom_highlighters: true,
network_monitor: false,
},
}
}
fn get_tab_msg_by_browser_id(
&self,
registry: &ActorRegistry,
browser_id: u32,
) -> Option<TabDescriptorActorMsg> {
self.tabs
.iter()
.map(|target| {
registry
.find::<TabDescriptorActor>(target)
.encodable(registry, true)
})
.find(|tab| tab.id() == browser_id)
}
}