soil_telemetry/
endpoints.rs

1// This file is part of Soil.
2
3// Copyright (C) Soil contributors.
4// Copyright (C) Parity Technologies (UK) Ltd.
5// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
6
7use libp2p::multiaddr::{self, Multiaddr};
8use serde::{Deserialize, Deserializer, Serialize};
9
10/// List of telemetry servers we want to talk to. Contains the URL of the server, and the
11/// maximum verbosity level.
12///
13/// The URL string can be either a URL or a multiaddress.
14#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Hash)]
15pub struct TelemetryEndpoints(
16	#[serde(deserialize_with = "url_or_multiaddr_deser")] pub(crate) Vec<(Multiaddr, u8)>,
17);
18
19/// Custom deserializer for TelemetryEndpoints, used to convert urls or multiaddr to multiaddr.
20fn url_or_multiaddr_deser<'de, D>(deserializer: D) -> Result<Vec<(Multiaddr, u8)>, D::Error>
21where
22	D: Deserializer<'de>,
23{
24	Vec::<(String, u8)>::deserialize(deserializer)?
25		.iter()
26		.map(|e| url_to_multiaddr(&e.0).map_err(serde::de::Error::custom).map(|m| (m, e.1)))
27		.collect()
28}
29
30impl TelemetryEndpoints {
31	/// Create a `TelemetryEndpoints` based on a list of `(String, u8)`.
32	pub fn new(endpoints: Vec<(String, u8)>) -> Result<Self, multiaddr::Error> {
33		let endpoints: Result<Vec<(Multiaddr, u8)>, multiaddr::Error> =
34			endpoints.iter().map(|e| Ok((url_to_multiaddr(&e.0)?, e.1))).collect();
35		endpoints.map(Self)
36	}
37}
38
39impl TelemetryEndpoints {
40	/// Return `true` if there are no telemetry endpoints, `false` otherwise.
41	pub fn is_empty(&self) -> bool {
42		self.0.is_empty()
43	}
44}
45
46/// Parses a WebSocket URL into a libp2p `Multiaddr`.
47fn url_to_multiaddr(url: &str) -> Result<Multiaddr, multiaddr::Error> {
48	// First, assume that we have a `Multiaddr`.
49	let parse_error = match url.parse() {
50		Ok(ma) => return Ok(ma),
51		Err(err) => err,
52	};
53
54	// If not, try the `ws://path/url` format.
55	if let Ok(ma) = multiaddr::from_url(url) {
56		return Ok(ma);
57	}
58
59	// If we have no clue about the format of that string, assume that we were expecting a
60	// `Multiaddr`.
61	Err(parse_error)
62}
63
64#[cfg(test)]
65mod tests {
66	use super::{url_to_multiaddr, Multiaddr, TelemetryEndpoints};
67
68	#[test]
69	fn valid_endpoints() {
70		let endp = vec![
71			("wss://telemetry.polkadot.io/submit/".into(), 3),
72			("/ip4/80.123.90.4/tcp/5432".into(), 4),
73		];
74		let telem =
75			TelemetryEndpoints::new(endp.clone()).expect("Telemetry endpoint should be valid");
76		let mut res: Vec<(Multiaddr, u8)> = vec![];
77		for (a, b) in endp.iter() {
78			res.push((url_to_multiaddr(a).expect("provided url should be valid"), *b))
79		}
80		assert_eq!(telem.0, res);
81	}
82
83	#[test]
84	fn invalid_endpoints() {
85		let endp = vec![
86			("/ip4/...80.123.90.4/tcp/5432".into(), 3),
87			("/ip4/no:!?;rlkqre;;::::///tcp/5432".into(), 4),
88		];
89		let telem = TelemetryEndpoints::new(endp);
90		assert!(telem.is_err());
91	}
92
93	#[test]
94	fn valid_and_invalid_endpoints() {
95		let endp = vec![
96			("/ip4/80.123.90.4/tcp/5432".into(), 3),
97			("/ip4/no:!?;rlkqre;;::::///tcp/5432".into(), 4),
98		];
99		let telem = TelemetryEndpoints::new(endp);
100		assert!(telem.is_err());
101	}
102}
soil_telemetry/endpoints.rs

soil_telemetry/
endpoints.rs
