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>

components/devtools/actors/root.rs

@@ -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,
+    custom_highlighters: bool,
-    networkMonitor: 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,
+    performance_actor: String,
-    deviceActor: String,
+    device_actor: String,
-    preferenceActor: 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)]
+#[derive(Default, Serialize)]
-struct ProcessForm {
+#[serde(rename_all = "camelCase")]
-    actor: String,
+pub struct DescriptorTraits {
-    id: u32,
+    pub(crate) watcher: bool,
-    isParent: 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(),
+                    performance_actor: self.performance.clone(),
-                    deviceActor: self.device.clone(),
+                    device_actor: self.device.clone(),
-                    preferenceActor: self.preference.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,
+                custom_highlighters: true,
-                networkMonitor: false,
+                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)
+    }
 }

components/devtools/actors/tab.rs

@@ -9,25 +9,29 @@ use serde_json::{Map, Value};
 
 use crate::actor::{Actor, ActorMessageStatus, ActorRegistry};
 use crate::actors::browsing_context::{BrowsingContextActor, BrowsingContextActorMsg};
-use crate::actors::root::RootActor;
+use crate::actors::root::{DescriptorTraits, RootActor};
 use crate::protocol::JsonPacketStream;
 use crate::StreamId;
 
+// https://searchfox.org/mozilla-central/source/devtools/server/actors/descriptors/tab.js
 #[derive(Serialize)]
-pub struct TabDescriptorTraits {
+#[serde(rename_all = "camelCase")]
-    getFavicon: bool,
-    hasTabInfo: bool,
-    watcher: bool,
-}
-
-#[derive(Serialize)]
 pub struct TabDescriptorActorMsg {
     actor: String,
+    browser_id: u32,
+    browsing_context_id: u32,
+    is_zombie_tab: bool,
+    outer_window_id: u32,
+    selected: bool,
     title: String,
+    traits: DescriptorTraits,
     url: String,
-    outerWindowID: u32,
+}
-    browsingContextId: u32,
+
-    traits: TabDescriptorTraits,
+impl TabDescriptorActorMsg {
+    pub fn id(&self) -> u32 {
+        self.browser_id
+    }
 }
 
 #[derive(Serialize)]
@@ -36,6 +40,12 @@ struct GetTargetReply {
     frame: BrowsingContextActorMsg,
 }
 
+#[derive(Serialize)]
+struct GetFaviconReply {
+    from: String,
+    favicon: String,
+}
+
 pub struct TabDescriptorActor {
     name: String,
     browsing_context_actor: String,
@@ -65,6 +75,15 @@ impl Actor for TabDescriptorActor {
                 });
                 ActorMessageStatus::Processed
             },
+            "getFavicon" => {
+                // TODO: Return a favicon when available
+                let _ = stream.write_json_packet(&GetFaviconReply {
+                    from: self.name(),
+                    favicon: String::new(),
+                });
+                ActorMessageStatus::Processed
+            },
+            // TODO: Unexpected message getWatcher when inspecting tab (create watcher actor)
             _ => ActorMessageStatus::Ignored,
         })
     }
@@ -84,23 +103,25 @@ impl TabDescriptorActor {
         }
     }
 
-    pub fn encodable(&self, registry: &ActorRegistry) -> TabDescriptorActorMsg {
+    pub fn encodable(&self, registry: &ActorRegistry, selected: bool) -> TabDescriptorActorMsg {
         let ctx_actor = registry.find::<BrowsingContextActor>(&self.browsing_context_actor);
 
         let title = ctx_actor.title.borrow().clone();
         let url = ctx_actor.url.borrow().clone();
 
         TabDescriptorActorMsg {
-            title,
-            url,
             actor: self.name(),
-            browsingContextId: ctx_actor.browsing_context_id.index.0.get(),
+            browsing_context_id: ctx_actor.browsing_context_id.index.0.get(),
-            outerWindowID: ctx_actor.active_pipeline.get().index.0.get(),
+            browser_id: ctx_actor.active_pipeline.get().index.0.get(),
-            traits: TabDescriptorTraits {
+            is_zombie_tab: false,
-                getFavicon: false,
+            outer_window_id: ctx_actor.active_pipeline.get().index.0.get(),
-                hasTabInfo: true,
+            selected,
-                watcher: false,
+            title,
+            traits: DescriptorTraits {
+                watcher: true,
+                supports_reload_descriptor: false,
             },
+            url,
         }
     }
 }