referrerpolicy=no-referrer-when-downgrade
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

// Copyright 2019-2020 Parity Technologies (UK) Ltd.
// This file is part of Parity Bridges Common.

// Parity Bridges Common is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// Parity Bridges Common is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with Parity Bridges Common.  If not, see <http://www.gnu.org/licenses/>.

use crate::{
	error::{self, Error},
	metrics::{
		metric_name, register, F64SharedRef, Gauge, Metric, PrometheusError, Registry,
		StandaloneMetric, F64,
	},
};

use async_std::sync::{Arc, RwLock};
use async_trait::async_trait;
use std::time::Duration;

/// Value update interval.
const UPDATE_INTERVAL: Duration = Duration::from_secs(300);

/// Metric that represents float value received from HTTP service as float gauge.
///
/// The float value returned by the service is assumed to be normal (`f64::is_normal`
/// should return `true`) and strictly positive.
#[derive(Debug, Clone)]
pub struct FloatJsonValueMetric {
	url: String,
	json_path: String,
	metric: Gauge<F64>,
	shared_value_ref: F64SharedRef,
}

impl FloatJsonValueMetric {
	/// Create new metric instance with given name and help.
	pub fn new(
		url: String,
		json_path: String,
		name: String,
		help: String,
	) -> Result<Self, PrometheusError> {
		let shared_value_ref = Arc::new(RwLock::new(None));
		Ok(FloatJsonValueMetric {
			url,
			json_path,
			metric: Gauge::new(metric_name(None, &name), help)?,
			shared_value_ref,
		})
	}

	/// Get shared reference to metric value.
	pub fn shared_value_ref(&self) -> F64SharedRef {
		self.shared_value_ref.clone()
	}

	/// Request value from HTTP service.
	async fn request_value(&self) -> anyhow::Result<String> {
		use isahc::{AsyncReadResponseExt, HttpClient, Request};

		let request = Request::get(&self.url).header("Accept", "application/json").body(())?;
		let raw_response = HttpClient::new()?.send_async(request).await?.text().await?;
		Ok(raw_response)
	}

	/// Read value from HTTP service.
	async fn read_value(&self) -> error::Result<f64> {
		let raw_response = self.request_value().await.map_err(Error::FetchTokenPrice)?;
		parse_service_response(&self.json_path, &raw_response)
	}
}

impl Metric for FloatJsonValueMetric {
	fn register(&self, registry: &Registry) -> Result<(), PrometheusError> {
		register(self.metric.clone(), registry).map(drop)
	}
}

#[async_trait]
impl StandaloneMetric for FloatJsonValueMetric {
	fn update_interval(&self) -> Duration {
		UPDATE_INTERVAL
	}

	async fn update(&self) {
		let value = self.read_value().await;
		let maybe_ok = value.as_ref().ok().copied();
		crate::metrics::set_gauge_value(&self.metric, value.map(Some));
		*self.shared_value_ref.write().await = maybe_ok;
	}
}

/// Parse HTTP service response.
fn parse_service_response(json_path: &str, response: &str) -> error::Result<f64> {
	let json =
		serde_json::from_str(response).map_err(|err| Error::ParseHttp(err, response.to_owned()))?;

	let mut selector = jsonpath_lib::selector(&json);
	let maybe_selected_value =
		selector(json_path).map_err(|err| Error::SelectResponseValue(err, response.to_owned()))?;
	let selected_value = maybe_selected_value
		.first()
		.and_then(|v| v.as_f64())
		.ok_or_else(|| Error::MissingResponseValue(response.to_owned()))?;
	if !selected_value.is_normal() || selected_value < 0.0 {
		return Err(Error::ParseFloat(selected_value))
	}

	Ok(selected_value)
}

#[cfg(test)]
mod tests {
	use super::*;

	#[test]
	fn parse_service_response_works() {
		assert_eq!(
			parse_service_response("$.kusama.usd", r#"{"kusama":{"usd":433.05}}"#).map_err(drop),
			Ok(433.05),
		);
	}

	#[test]
	fn parse_service_response_rejects_negative_numbers() {
		assert!(parse_service_response("$.kusama.usd", r#"{"kusama":{"usd":-433.05}}"#).is_err());
	}

	#[test]
	fn parse_service_response_rejects_zero_numbers() {
		assert!(parse_service_response("$.kusama.usd", r#"{"kusama":{"usd":0.0}}"#).is_err());
	}

	#[test]
	fn parse_service_response_rejects_nan() {
		assert!(parse_service_response("$.kusama.usd", r#"{"kusama":{"usd":NaN}}"#).is_err());
	}
}