Skip to main content

tuwunel_service/appservice/
ping.rs

1use bytes::BytesMut;
2use reqwest::Request;
3use ruma::api::{
4	OutgoingRequestExt,
5	appservice::{Registration, ping::send_ping},
6	auth_scheme::SendAccessToken,
7	error::{BadStatusErrorData, ErrorKind},
8};
9use tuwunel_core::{
10	Error, Result, err, http::StatusCode, implement, utils::string_from_bytes, warn,
11};
12
13use super::request::add_access_token_query;
14use crate::client::read_response_capped;
15
16/// Pings an appservice per MSC2659, surfacing the spec's failure error codes.
17///
18/// Returns `Ok(())` without pinging when the registration has no URL set.
19#[implement(super::Service)]
20pub async fn ping(
21	&self,
22	registration: Registration,
23	request: send_ping::v1::Request,
24) -> Result<()> {
25	let Some(dest) = registration.url else {
26		return Ok(());
27	};
28
29	if dest == *"null" || dest.is_empty() {
30		return Ok(());
31	}
32
33	let (base, client) = self.transport(&dest)?;
34	let hs_token = registration.hs_token.as_str();
35	let mut http_request = request
36		.try_into_http_request::<BytesMut>(base, SendAccessToken::IfRequired(hs_token), ())
37		.map_err(|e| {
38			err!(Request(ConnectionFailed(warn!(
39				appservice = %registration.id,
40				%dest,
41				?e,
42				"Failed to find appservice destination"
43			))))
44		})?
45		.map(BytesMut::freeze);
46
47	add_access_token_query(&mut http_request, hs_token);
48
49	let reqwest_request = Request::try_from(http_request)?;
50
51	let response = client
52		.execute(reqwest_request)
53		.await
54		.map_err(|e| {
55			// The URL carries the hs_token in its access_token query.
56			let e = e.without_url();
57
58			if e.is_timeout() {
59				err!(Request(ConnectionTimeout(warn!(
60					appservice = %registration.id,
61					%dest,
62					?e,
63					"Connection to appservice timed out"
64				))))
65			} else {
66				err!(Request(ConnectionFailed(warn!(
67					appservice = %registration.id,
68					%dest,
69					?e,
70					"Could not send request to appservice"
71				))))
72			}
73		})?;
74
75	let status = response.status();
76	if status.is_success() {
77		return Ok(());
78	}
79
80	let limit = self
81		.services
82		.config
83		.network
84		.http
85		.max_response_size;
86
87	let body = read_response_capped(response, limit)
88		.await
89		.ok()
90		.and_then(|body| string_from_bytes(&body).ok());
91
92	warn!(
93		appservice = %registration.id,
94		%status,
95		%dest,
96		"Appservice returned unsuccessful HTTP response to ping"
97	);
98
99	Err(Error::Request(
100		ErrorKind::BadStatus(BadStatusErrorData { status: Some(status), body }),
101		format!("Appservice returned status {status}").into(),
102		StatusCode::BAD_REQUEST,
103	))
104}