Skip to content

Commit

Permalink
Bug 1172897 - Rename Tab Actor to BrowsingContextActor
Browse files Browse the repository at this point in the history 
As part of [Bug 1172987](https://bugzilla.mozilla.org/show_bug.cgi?id=1172897) we renamed TabActor, as the actor does not represent tabs (as in a browser tab), it instead represents a browsing context as defined by the the [HTML standard](https://html.spec.whatwg.org/multipage/browsers.html#windows). In a later PR I will mirror the structure we have on devtools to have a targets folder, which contains all target types. At the moment it looks like servo only represents workers and browsing contexts.
  • Loading branch information
@codehag
codehag committed Sep 23, 2018
1 parent 196bec2 commit 86b7862
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 34 deletions.
34 changes: 17 additions & 17 deletions components/devtools/actors/tab.rs → ...nents/devtools/actors/browsing_context.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

//! Liberally derived from the [Firefox JS implementation]
//! (http://mxr.mozilla.org/mozilla-central/source/toolkit/devtools/server/actors/webbrowser.js).
//! Connection point for remote devtools that wish to investigate a particular tab's contents.
//! Connection point for remote devtools that wish to investigate a particular Browsing Context's contents.
//! Supports dynamic attaching and detaching which control notifications of navigation, etc.

use actor::{Actor, ActorMessageStatus, ActorRegistry};
Expand All @@ -15,21 +15,21 @@ use serde_json::{Map, Value};
use std::net::TcpStream;

#[derive(Serialize)]
struct TabTraits;
struct BrowsingContextTraits;

#[derive(Serialize)]
struct TabAttachedReply {
struct BrowsingContextAttachedReply {
from: String,
#[serde(rename = "type")]
type_: String,
threadActor: String,
cacheDisabled: bool,
javascriptEnabled: bool,
traits: TabTraits,
traits: BrowsingContextTraits,
}

#[derive(Serialize)]
struct TabDetachedReply {
struct BrowsingContextDetachedReply {
from: String,
#[serde(rename = "type")]
type_: String,
Expand All @@ -55,7 +55,7 @@ struct FrameMsg {
}

#[derive(Serialize)]
pub struct TabActorMsg {
pub struct BrowsingContextActorMsg {
actor: String,
title: String,
url: String,
Expand All @@ -67,7 +67,7 @@ pub struct TabActorMsg {
performanceActor: String,
}

pub struct TabActor {
pub struct BrowsingContextActor {
pub name: String,
pub title: String,
pub url: String,
Expand All @@ -79,7 +79,7 @@ pub struct TabActor {
pub thread: String,
}

impl Actor for TabActor {
impl Actor for BrowsingContextActor {
fn name(&self) -> String {
self.name.clone()
}
Expand Down Expand Up @@ -107,16 +107,16 @@ impl Actor for TabActor {
ActorMessageStatus::Processed
},

// https://wiki.mozilla.org/Remote_Debugging_Protocol#Listing_Browser_Tabs
// (see "To attach to a _tabActor_")
// https://docs.firefox-dev.tools/backend/protocol.html#listing-browser-tabs
// (see "To attach to a _targetActor_")
"attach" => {
let msg = TabAttachedReply {
let msg = BrowsingContextAttachedReply {
from: self.name(),
type_: "tabAttached".to_owned(),
type_: "targetAttached".to_owned(),
threadActor: self.thread.clone(),
cacheDisabled: false,
javascriptEnabled: true,
traits: TabTraits,
traits: BrowsingContextTraits,
};
let console_actor = registry.find::<ConsoleActor>(&self.console);
console_actor
Expand All @@ -134,7 +134,7 @@ impl Actor for TabActor {
//FIXME: The current implementation won't work for multiple connections. Need to ensure 105
// that the correct stream is removed.
"detach" => {
let msg = TabDetachedReply {
let msg = BrowsingContextDetachedReply {
from: self.name(),
type_: "detached".to_owned(),
};
Expand Down Expand Up @@ -162,9 +162,9 @@ impl Actor for TabActor {
}
}

impl TabActor {
pub fn encodable(&self) -> TabActorMsg {
TabActorMsg {
impl BrowsingContextActor {
pub fn encodable(&self) -> BrowsingContextActorMsg {
BrowsingContextActorMsg {
actor: self.name(),
title: self.title.clone(),
url: self.url.clone(),
Expand Down
10 changes: 5 additions & 5 deletions components/devtools/actors/root.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
/// Liberally derived from the [Firefox JS implementation]
/// (http://mxr.mozilla.org/mozilla-central/source/toolkit/devtools/server/actors/root.js).
/// Connection point for all new remote devtools interactions, providing lists of know actors
/// that perform more specific actions (tabs, addons, browser chrome, etc.)
/// that perform more specific actions (targets, addons, browser chrome, etc.)
use actor::{Actor, ActorMessageStatus, ActorRegistry};
use actors::browsing_context::{BrowsingContextActor, BrowsingContextActorMsg};
use actors::performance::PerformanceActor;
use actors::tab::{TabActor, TabActorMsg};
use protocol::{ActorDescription, JsonPacketStream};
use serde_json::{Map, Value};
use std::net::TcpStream;
Expand All @@ -34,7 +34,7 @@ enum AddonMsg {}
struct ListTabsReply {
from: String,
selected: u32,
tabs: Vec<TabActorMsg>,
tabs: Vec<BrowsingContextActorMsg>,
}

#[derive(Serialize)]
Expand Down Expand Up @@ -81,15 +81,15 @@ impl Actor for RootActor {
ActorMessageStatus::Processed
},

//https://wiki.mozilla.org/Remote_Debugging_Protocol#Listing_Browser_Tabs
// https://docs.firefox-dev.tools/backend/protocol.html#listing-browser-tabs
"listTabs" => {
let actor = ListTabsReply {
from: "root".to_owned(),
selected: 0,
tabs: self
.tabs
.iter()
.map(|tab| registry.find::<TabActor>(tab).encodable())
.map(|target| registry.find::<BrowsingContextActor>(target).encodable())
.collect(),
};
stream.write_json_packet(&actor);
Expand Down
24 changes: 12 additions & 12 deletions components/devtools/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ extern crate servo_channel;
extern crate time;

use actor::{Actor, ActorRegistry};
use actors::browsing_context::BrowsingContextActor;
use actors::console::ConsoleActor;
use actors::framerate::FramerateActor;
use actors::inspector::InspectorActor;
use actors::network_event::{EventActor, NetworkEventActor, ResponseStartMsg};
use actors::performance::PerformanceActor;
use actors::profiler::ProfilerActor;
use actors::root::RootActor;
use actors::tab::TabActor;
use actors::thread::ThreadActor;
use actors::timeline::TimelineActor;
use actors::worker::WorkerActor;
Expand All @@ -55,6 +55,7 @@ use time::precise_time_ns;
mod actor;
/// Corresponds to http://mxr.mozilla.org/mozilla-central/source/toolkit/devtools/server/actors/
mod actors {
pub mod browsing_context;
pub mod console;
pub mod framerate;
pub mod inspector;
Expand All @@ -64,7 +65,6 @@ mod actors {
pub mod performance;
pub mod profiler;
pub mod root;
pub mod tab;
pub mod thread;
pub mod timeline;
pub mod worker;
Expand Down Expand Up @@ -202,7 +202,7 @@ fn run_server(

// We need separate actor representations for each script global that exists;
// clients can theoretically connect to multiple globals simultaneously.
// TODO: move this into the root or tab modules?
// TODO: move this into the root or target modules?
fn handle_new_global(
actors: Arc<Mutex<ActorRegistry>>,
ids: (PipelineId, Option<WorkerId>),
Expand All @@ -215,8 +215,8 @@ fn run_server(

let (pipeline, worker_id) = ids;

//TODO: move all this actor creation into a constructor method on TabActor
let (tab, console, inspector, timeline, profiler, performance, thread) = {
//TODO: move all this actor creation into a constructor method on BrowsingContextActor
let (target, console, inspector, timeline, profiler, performance, thread) = {
let console = ConsoleActor {
name: actors.new_name("console"),
script_chan: script_sender.clone(),
Expand All @@ -240,8 +240,8 @@ fn run_server(
let thread = ThreadActor::new(actors.new_name("context"));

let DevtoolsPageInfo { title, url } = page_info;
let tab = TabActor {
name: actors.new_name("tab"),
let target = BrowsingContextActor {
name: actors.new_name("target"),
title: String::from(title),
url: url.into_string(),
console: console.name(),
Expand All @@ -253,10 +253,10 @@ fn run_server(
};

let root = actors.find_mut::<RootActor>("root");
root.tabs.push(tab.name.clone());
root.tabs.push(target.name.clone());

(
tab,
target,
console,
inspector,
timeline,
Expand All @@ -276,8 +276,8 @@ fn run_server(
actors.register(Box::new(worker));
}

actor_pipelines.insert(pipeline, tab.name.clone());
actors.register(Box::new(tab));
actor_pipelines.insert(pipeline, target.name.clone());
actors.register(Box::new(target));
actors.register(Box::new(console));
actors.register(Box::new(inspector));
actors.register(Box::new(timeline));
Expand Down Expand Up @@ -342,7 +342,7 @@ fn run_server(
Some(actors.find::<WorkerActor>(actor_name).console.clone())
} else {
let actor_name = (*actor_pipelines).get(&id)?;
Some(actors.find::<TabActor>(actor_name).console.clone())
Some(actors.find::<BrowsingContextActor>(actor_name).console.clone())
}
}

Expand Down

0 comments on commit 86b7862

Please sign in to comment.