servo/components/devtools/actors/device.rs
Olivier Tilloy 6a2e4a61f7
Devtools device description: improve how Servo is advertised in Firefox's about:debugging (fixes #27528) (#32227)
* Devtools device description: fix the case of the 'platformversion' property

* Devtools device description: expose the properties Firefox expects for the display name and version of the server

When connecting to Servo from Firefox (about:debugging), it will display "Servo (71.0)" instead of "{$name} (${version})".

* Devtools device description: update versions to match those in the UA string

* Devtools device description: expose a property (appbuildid) Firefox expects to compare versions for compatibility (_compareVersionCompatibility function)

* Devtools device description: advertise a current platform version to remove the incompatibility warning in Firefox's about:debugging

* Devtools preference actor: fix retrieving the actual preference by its key

* Devtools preference actor: translate Firefox preference names onto the corresponding Servo preference names

* Devtools device description: downgrade the platform version to prevent a confusing warning in about:debugging if the build ID is newer than that of Firefox (likely)

* Devtools device description: add comments

* Devtools device description: use CARGO_PKG_VERSION for the user-visible version number
2024-05-08 04:12:18 +00:00

102 lines
3.1 KiB
Rust

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/. */
use std::net::TcpStream;
use serde::Serialize;
use serde_json::{Map, Value};
use crate::actor::{Actor, ActorMessageStatus, ActorRegistry};
use crate::protocol::{ActorDescription, JsonPacketStream, Method};
use crate::StreamId;
#[derive(Serialize)]
struct GetDescriptionReply {
from: String,
value: SystemInfo,
}
// This is only a minimal subset of the properties exposed/expected by Firefox
// (see https://searchfox.org/mozilla-central/source/devtools/shared/system.js#45)
#[derive(Serialize)]
struct SystemInfo {
apptype: String,
// Display version
version: String,
// Build ID (timestamp with format YYYYMMDDhhmmss), used for compatibility checks
// (see https://searchfox.org/mozilla-central/source/devtools/client/shared/remote-debugging/version-checker.js#82)
appbuildid: String,
// Firefox major.minor version number, use for compatibility checks
platformversion: String,
// Display name
brandName: String,
}
include!(concat!(env!("OUT_DIR"), "/build_id.rs"));
pub struct DeviceActor {
pub name: String,
}
impl Actor for DeviceActor {
fn name(&self) -> String {
self.name.clone()
}
fn handle_message(
&self,
_registry: &ActorRegistry,
msg_type: &str,
_msg: &Map<String, Value>,
stream: &mut TcpStream,
_id: StreamId,
) -> Result<ActorMessageStatus, ()> {
Ok(match msg_type {
"getDescription" => {
let msg = GetDescriptionReply {
from: self.name(),
value: SystemInfo {
apptype: "servo".to_string(),
version: env!("CARGO_PKG_VERSION").to_string(),
appbuildid: BUILD_ID.to_string(),
platformversion: "124.0".to_string(),
brandName: "Servo".to_string(),
},
};
let _ = stream.write_json_packet(&msg);
ActorMessageStatus::Processed
},
_ => ActorMessageStatus::Ignored,
})
}
}
impl DeviceActor {
pub fn new(name: String) -> DeviceActor {
DeviceActor { name }
}
pub fn description() -> ActorDescription {
ActorDescription {
category: "actor",
typeName: "device",
methods: vec![Method {
name: "getDescription",
request: Value::Null,
response: Value::Object(
vec![(
"value".to_owned(),
Value::Object(
vec![("_retval".to_owned(), Value::String("json".to_owned()))]
.into_iter()
.collect(),
),
)]
.into_iter()
.collect(),
),
}],
}
}
}