mirror of
https://github.com/servo/servo.git
synced 2025-07-23 07:13:52 +01:00
Devtools: send error replies instead of ignoring messages (#37686)
Client messages, which are always requests, are dispatched to Actor instances one at a time via Actor::handle_message. Each request must be paired with exactly one reply from the same actor the request was sent to, where a reply is a message with no type (if a message from the server has a type, it’s a notification, not a reply). Failing to reply to a request will almost always permanently break that actor, because either the client gets stuck waiting for a reply, or the client receives the reply for a subsequent request as if it was the reply for the current request. If an actor fails to reply to a request, we want the dispatcher (ActorRegistry::handle_message) to send an error of type `unrecognizedPacketType`, to keep the conversation for that actor in sync. Since replies come in all shapes and sizes, we want to allow Actor types to send replies without having to return them to the dispatcher. This patch adds a wrapper type around a client stream that guarantees request/reply invariants. It allows the dispatcher to check if a valid reply was sent, and guarantees that if the actor tries to send a reply, it’s actually a valid reply (see ClientRequest::is_valid_reply). It does not currently guarantee anything about messages sent via the TcpStream released via ClientRequest::try_clone_stream or the return value of ClientRequest::reply. We also send `unrecognizedPacketType`, `missingParameter`, `badParameterType`, and `noSuchActor` messages per the [protocol](https://firefox-source-docs.mozilla.org/devtools/backend/protocol.html#error-packets) [docs](https://firefox-source-docs.mozilla.org/devtools/backend/protocol.html#packets). Testing: automated tests all pass, and manual testing looks ok Fixes: #37683 and at least six bugs, plus one with a different root cause, plus three with zero impact --------- Signed-off-by: atbrakhi <atbrakhi@igalia.com> Signed-off-by: Delan Azabani <dazabani@igalia.com> Co-authored-by: delan azabani <dazabani@igalia.com> Co-authored-by: Simon Wülker <simon.wuelker@arcor.de> Co-authored-by: the6p4c <me@doggirl.gay>
This commit is contained in:
atbrakhi
GitHub
parent
fcb2a4cd95
commit
71d97bd935
36 changed files with 661 additions and 637 deletions
|
|
@ -5,7 +5,6 @@
|
|||
//! Liberally derived from the [Firefox JS implementation](http://mxr.mozilla.org/mozilla-central/source/toolkit/devtools/server/actors/webconsole.js).
|
||||
//! Handles interaction with the remote web console on network events (HTTP requests, responses) in Servo.
|
||||
|
||||
use std::net::TcpStream;
|
||||
use std::time::{Duration, SystemTime, UNIX_EPOCH};
|
||||
|
||||
use chrono::{Local, LocalResult, TimeZone};
|
||||
|
|
@ -16,9 +15,9 @@ use serde::Serialize;
|
|||
use serde_json::{Map, Value};
|
||||
|
||||
use crate::StreamId;
|
||||
use crate::actor::{Actor, ActorMessageStatus, ActorRegistry};
|
||||
use crate::actor::{Actor, ActorError, ActorRegistry};
|
||||
use crate::network_handler::Cause;
|
||||
use crate::protocol::JsonPacketStream;
|
||||
use crate::protocol::ClientRequest;
|
||||
|
||||
pub struct NetworkEventActor {
|
||||
pub name: String,
|
||||
|
|
@ -202,13 +201,13 @@ impl Actor for NetworkEventActor {
|
|||
|
||||
fn handle_message(
|
||||
&self,
|
||||
request: ClientRequest,
|
||||
_registry: &ActorRegistry,
|
||||
msg_type: &str,
|
||||
_msg: &Map<String, Value>,
|
||||
stream: &mut TcpStream,
|
||||
_id: StreamId,
|
||||
) -> Result<ActorMessageStatus, ()> {
|
||||
Ok(match msg_type {
|
||||
) -> Result<(), ActorError> {
|
||||
match msg_type {
|
||||
"getRequestHeaders" => {
|
||||
let mut headers = Vec::new();
|
||||
let mut raw_headers_string = "".to_owned();
|
||||
|
|
@ -232,8 +231,7 @@ impl Actor for NetworkEventActor {
|
|||
header_size: headers_size,
|
||||
raw_headers: raw_headers_string,
|
||||
};
|
||||
let _ = stream.write_json_packet(&msg);
|
||||
ActorMessageStatus::Processed
|
||||
request.reply_final(&msg)?
|
||||
},
|
||||
"getRequestCookies" => {
|
||||
let mut cookies = Vec::new();
|
||||
|
|
@ -248,8 +246,7 @@ impl Actor for NetworkEventActor {
|
|||
from: self.name(),
|
||||
cookies,
|
||||
};
|
||||
let _ = stream.write_json_packet(&msg);
|
||||
ActorMessageStatus::Processed
|
||||
request.reply_final(&msg)?
|
||||
},
|
||||
"getRequestPostData" => {
|
||||
let msg = GetRequestPostDataReply {
|
||||
|
|
@ -257,8 +254,7 @@ impl Actor for NetworkEventActor {
|
|||
post_data: self.request_body.clone(),
|
||||
post_data_discarded: self.request_body.is_none(),
|
||||
};
|
||||
let _ = stream.write_json_packet(&msg);
|
||||
ActorMessageStatus::Processed
|
||||
request.reply_final(&msg)?
|
||||
},
|
||||
"getResponseHeaders" => {
|
||||
if let Some(ref response_headers) = self.response_headers_raw {
|
||||
|
|
@ -282,9 +278,11 @@ impl Actor for NetworkEventActor {
|
|||
header_size: headers_size,
|
||||
raw_headers: raw_headers_string,
|
||||
};
|
||||
let _ = stream.write_json_packet(&msg);
|
||||
request.reply_final(&msg)?;
|
||||
} else {
|
||||
// FIXME: what happens when there are no response headers?
|
||||
return Err(ActorError::Internal);
|
||||
}
|
||||
ActorMessageStatus::Processed
|
||||
},
|
||||
"getResponseCookies" => {
|
||||
let mut cookies = Vec::new();
|
||||
|
|
@ -300,8 +298,7 @@ impl Actor for NetworkEventActor {
|
|||
from: self.name(),
|
||||
cookies,
|
||||
};
|
||||
let _ = stream.write_json_packet(&msg);
|
||||
ActorMessageStatus::Processed
|
||||
request.reply_final(&msg)?
|
||||
},
|
||||
"getResponseContent" => {
|
||||
let msg = GetResponseContentReply {
|
||||
|
|
@ -309,8 +306,7 @@ impl Actor for NetworkEventActor {
|
|||
content: self.response_body.clone(),
|
||||
content_discarded: self.response_body.is_none(),
|
||||
};
|
||||
let _ = stream.write_json_packet(&msg);
|
||||
ActorMessageStatus::Processed
|
||||
request.reply_final(&msg)?
|
||||
},
|
||||
"getEventTimings" => {
|
||||
// TODO: This is a fake timings msg
|
||||
|
|
@ -323,8 +319,7 @@ impl Actor for NetworkEventActor {
|
|||
timings: timings_obj,
|
||||
total_time: total,
|
||||
};
|
||||
let _ = stream.write_json_packet(&msg);
|
||||
ActorMessageStatus::Processed
|
||||
request.reply_final(&msg)?
|
||||
},
|
||||
"getSecurityInfo" => {
|
||||
// TODO: Send the correct values for securityInfo.
|
||||
|
|
@ -334,11 +329,11 @@ impl Actor for NetworkEventActor {
|
|||
state: "insecure".to_owned(),
|
||||
},
|
||||
};
|
||||
let _ = stream.write_json_packet(&msg);
|
||||
ActorMessageStatus::Processed
|
||||
request.reply_final(&msg)?
|
||||
},
|
||||
_ => ActorMessageStatus::Ignored,
|
||||
})
|
||||
_ => return Err(ActorError::UnrecognizedPacketType),
|
||||
};
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue