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 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
use super::service_endpoints;
use crate::data_source::{DataSource, NullDataSource, PollingDataSource, StreamingDataSource};
use crate::feature_requester_builders::{FeatureRequesterFactory, HyperFeatureRequesterBuilder};
use eventsource_client::HttpsConnector;
use std::sync::{Arc, Mutex};
use std::time::Duration;
use thiserror::Error;
#[cfg(test)]
use super::data_source;
/// Error type used to represent failures when building a DataSource instance.
#[non_exhaustive]
#[derive(Debug, Error)]
pub enum BuildError {
/// Error used when a configuration setting is invalid. This typically invalids an invalid URL.
#[error("data source factory failed to build: {0}")]
InvalidConfig(String),
}
const DEFAULT_INITIAL_RECONNECT_DELAY: Duration = Duration::from_secs(1);
const MINIMUM_POLL_INTERVAL: Duration = Duration::from_secs(30);
/// Trait which allows creation of data sources. Should be implemented by data source builder types.
pub trait DataSourceFactory {
fn build(
&self,
endpoints: &service_endpoints::ServiceEndpoints,
sdk_key: &str,
tags: Option<String>,
) -> Result<Arc<dyn DataSource>, BuildError>;
fn to_owned(&self) -> Box<dyn DataSourceFactory>;
}
/// Contains methods for configuring the streaming data source.
///
/// By default, the SDK uses a streaming connection to receive feature flag data from LaunchDarkly. If you want
/// to customize the behavior of the connection, create a builder [StreamingDataSourceBuilder::new],
/// change its properties with the methods of this class, and pass it to
/// [crate::ConfigBuilder::data_source].
///
/// # Examples
///
/// Adjust the initial reconnect delay.
/// ```
/// # use launchdarkly_server_sdk::{StreamingDataSourceBuilder, ConfigBuilder};
/// # use std::time::Duration;
/// # fn main() {
/// ConfigBuilder::new("sdk-key").data_source(StreamingDataSourceBuilder::new()
/// .initial_reconnect_delay(Duration::from_secs(10)));
/// # }
/// ```
#[derive(Clone)]
pub struct StreamingDataSourceBuilder {
initial_reconnect_delay: Duration,
connector: Option<HttpsConnector>,
}
impl StreamingDataSourceBuilder {
/// Create a new instance of the [StreamingDataSourceBuilder] with default values.
pub fn new() -> Self {
Self {
initial_reconnect_delay: DEFAULT_INITIAL_RECONNECT_DELAY,
connector: None,
}
}
/// Sets the initial reconnect delay for the streaming connection.
pub fn initial_reconnect_delay(&mut self, duration: Duration) -> &mut Self {
self.initial_reconnect_delay = duration;
self
}
/// Sets the [eventsource_client::HttpsConnector] for the event
/// source client to use. This allows for re-use of a connector between
/// multiple client instances. This is especially useful for the `sdk-test-harness`
/// where many client instances are created throughout the test and reading
/// the native certificates is a substantial portion of the runtime.
pub fn https_connector(&mut self, connector: HttpsConnector) -> &mut Self {
self.connector = Some(connector);
self
}
}
impl DataSourceFactory for StreamingDataSourceBuilder {
fn build(
&self,
endpoints: &service_endpoints::ServiceEndpoints,
sdk_key: &str,
tags: Option<String>,
) -> Result<Arc<dyn DataSource>, BuildError> {
let data_source = match &self.connector {
None => StreamingDataSource::new(
endpoints.streaming_base_url(),
sdk_key,
self.initial_reconnect_delay,
&tags,
),
Some(connector) => StreamingDataSource::new_with_connector(
endpoints.streaming_base_url(),
sdk_key,
self.initial_reconnect_delay,
&tags,
connector.clone(),
),
}
.map_err(|e| BuildError::InvalidConfig(format!("invalid stream_base_url: {:?}", e)))?;
Ok(Arc::new(data_source))
}
fn to_owned(&self) -> Box<dyn DataSourceFactory> {
Box::new(self.clone())
}
}
impl Default for StreamingDataSourceBuilder {
fn default() -> Self {
StreamingDataSourceBuilder::new()
}
}
#[derive(Clone)]
pub struct NullDataSourceBuilder {}
impl NullDataSourceBuilder {
pub fn new() -> Self {
Self {}
}
}
impl DataSourceFactory for NullDataSourceBuilder {
fn build(
&self,
_: &service_endpoints::ServiceEndpoints,
_: &str,
_: Option<String>,
) -> Result<Arc<dyn DataSource>, BuildError> {
Ok(Arc::new(NullDataSource::new()))
}
fn to_owned(&self) -> Box<dyn DataSourceFactory> {
Box::new(self.clone())
}
}
impl Default for NullDataSourceBuilder {
fn default() -> Self {
NullDataSourceBuilder::new()
}
}
/// Contains methods for configuring the polling data source.
///
/// Polling is not the default behavior; by default, the SDK uses a streaming connection to receive feature flag
/// data from LaunchDarkly. In polling mode, the SDK instead makes a new HTTP request to LaunchDarkly at regular
/// intervals. HTTP caching allows it to avoid redundantly downloading data if there have been no changes, but
/// polling is still less efficient than streaming and should only be used on the advice of LaunchDarkly support.
///
/// To use polling mode, create a builder [PollingDataSourceBuilder::new], change its properties
/// with the methods of this class, and pass it to the [crate::ConfigBuilder::data_source].
///
/// # Examples
///
/// Adjust the initial reconnect delay.
/// ```
/// # use launchdarkly_server_sdk::{PollingDataSourceBuilder, ConfigBuilder};
/// # use std::time::Duration;
/// # fn main() {
/// ConfigBuilder::new("sdk-key").data_source(PollingDataSourceBuilder::new()
/// .poll_interval(Duration::from_secs(60)));
/// # }
/// ```
#[derive(Clone)]
pub struct PollingDataSourceBuilder {
poll_interval: Duration,
feature_requester_factory: Option<Arc<Mutex<Box<dyn FeatureRequesterFactory>>>>,
}
/// Contains methods for configuring the polling data source.
///
/// Polling is not the default behavior; by default, the SDK uses a streaming connection to receive
/// feature flag data from LaunchDarkly. In polling mode, the SDK instead makes a new HTTP request
/// to LaunchDarkly at regular intervals. HTTP caching allows it to avoid redundantly downloading
/// data if there have been no changes, but polling is still less efficient than streaming and
/// should only be used on the advice of LaunchDarkly support.
///
/// To use polling mode, create a builder with [PollingDataSourceBuilder::new], set its properties
/// with the methods of this class, and pass it to [crate::ConfigBuilder::data_source].
///
/// # Examples
///
/// Adjust the poll interval.
/// ```
/// # use launchdarkly_server_sdk::{PollingDataSourceBuilder, ConfigBuilder};
/// # use std::time::Duration;
/// # fn main() {
/// ConfigBuilder::new("sdk-key").data_source(PollingDataSourceBuilder::new()
/// .poll_interval(Duration::from_secs(60)));
/// # }
/// ```
impl PollingDataSourceBuilder {
/// Create a new instance of the [PollingDataSourceBuilder] with default values.
pub fn new() -> Self {
Self {
poll_interval: MINIMUM_POLL_INTERVAL,
feature_requester_factory: None,
}
}
/// Sets the poll interval for the polling connection.
///
/// The default and minimum value is 30 seconds. Values less than this will be set to the
/// default.
pub fn poll_interval(&mut self, poll_interval: Duration) -> &mut Self {
self.poll_interval = std::cmp::max(poll_interval, MINIMUM_POLL_INTERVAL);
self
}
/// Sets the feature requester factory for use by this polling data source.
///
/// The default implementation relies on reqwest and handles basic caching.
pub fn feature_requester_factory(
&mut self,
feature_requester_factory: Box<dyn FeatureRequesterFactory>,
) -> &mut Self {
self.feature_requester_factory = Some(Arc::new(Mutex::new(feature_requester_factory)));
self
}
}
impl DataSourceFactory for PollingDataSourceBuilder {
fn build(
&self,
endpoints: &service_endpoints::ServiceEndpoints,
sdk_key: &str,
tags: Option<String>,
) -> Result<Arc<dyn DataSource>, BuildError> {
let feature_requester_factory: Arc<Mutex<Box<dyn FeatureRequesterFactory>>> =
match &self.feature_requester_factory {
Some(factory) => factory.clone(),
_ => Arc::new(Mutex::new(Box::new(HyperFeatureRequesterBuilder::new(
endpoints.polling_base_url(),
sdk_key,
)))),
};
let data_source =
PollingDataSource::new(feature_requester_factory, self.poll_interval, tags);
Ok(Arc::new(data_source))
}
fn to_owned(&self) -> Box<dyn DataSourceFactory> {
Box::new(self.clone())
}
}
impl Default for PollingDataSourceBuilder {
fn default() -> Self {
PollingDataSourceBuilder::new()
}
}
/// For testing you can use this builder to inject the MockDataSource.
#[cfg(test)]
#[derive(Clone)]
pub(crate) struct MockDataSourceBuilder {
data_source: Option<Arc<data_source::MockDataSource>>,
}
#[cfg(test)]
impl MockDataSourceBuilder {
pub fn new() -> MockDataSourceBuilder {
MockDataSourceBuilder { data_source: None }
}
pub fn data_source(
&mut self,
data_source: Arc<data_source::MockDataSource>,
) -> &mut MockDataSourceBuilder {
self.data_source = Some(data_source);
self
}
}
#[cfg(test)]
impl DataSourceFactory for MockDataSourceBuilder {
fn build(
&self,
_endpoints: &service_endpoints::ServiceEndpoints,
_sdk_key: &str,
_tags: Option<String>,
) -> Result<Arc<dyn DataSource>, BuildError> {
return Ok(self.data_source.as_ref().unwrap().clone());
}
fn to_owned(&self) -> Box<dyn DataSourceFactory> {
Box::new(self.clone())
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn default_stream_builder_has_correct_defaults() {
let builder = StreamingDataSourceBuilder::new();
assert_eq!(
builder.initial_reconnect_delay,
DEFAULT_INITIAL_RECONNECT_DELAY
);
}
#[test]
fn default_polling_builder_has_correct_defaults() {
let builder = PollingDataSourceBuilder::new();
assert_eq!(builder.poll_interval, MINIMUM_POLL_INTERVAL,);
}
#[test]
fn initial_reconnect_delay_for_streaming_can_be_adjusted() {
let mut builder = StreamingDataSourceBuilder::new();
builder.initial_reconnect_delay(Duration::from_secs(1234));
assert_eq!(builder.initial_reconnect_delay, Duration::from_secs(1234));
}
}