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 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
//! Apollo configuration apis. //! //! Refs: <https://www.apolloconfig.com/#/zh/usage/other-language-client-user-guide>. //! //! # Example //! //! Simple fetch configuration: //! //! ``` //! use apollo_client::{ //! conf::{meta::IpValue, requests::CachedFetchRequest, ApolloConfClientBuilder}, //! errors::ApolloClientResult, //! }; //! use ini::Properties; //! use std::error::Error; //! use url::Url; //! //! #[tokio::main] //! async fn main() -> Result<(), Box<dyn Error>> { //! env_logger::init(); //! //! // Create configuration client. //! let client = //! ApolloConfClientBuilder::new_via_config_service(Url::parse("http://localhost:8080")?)? //! .build()?; //! //! // Request apollo cached configuration api. //! let configuration: Properties = client //! .execute( //! CachedFetchRequest::builder() //! .app_id("SampleApp") //! .namespace_name("application.json") //! .ip(IpValue::HostName) //! .build(), //! ) //! .await?; //! //! // Get the content of configuration. //! let content = configuration.get("content"); //! dbg!(content); //! //! Ok(()) //! } //! ``` //! //! Watch configuration and fetch when changed: //! //! ```no_run //! use apollo_client::conf::{meta::IpValue, requests::WatchRequest, ApolloConfClientBuilder}; //! use cidr_utils::cidr::IpCidr; //! use futures_util::{pin_mut, stream::StreamExt}; //! use std::error::Error; //! use url::Url; //! //! #[tokio::main] //! async fn main() -> Result<(), Box<dyn Error>> { //! env_logger::init(); //! //! // Create configuration client. //! let client = //! ApolloConfClientBuilder::new_via_config_service(Url::parse("http://localhost:8080")?)? //! .build()?; //! //! // Request apollo notification api, and fetch configuration when notified. //! let stream = client.watch( //! WatchRequest::builder() //! .app_id("SampleApp") //! .namespace_names([ //! "application.properties".into(), //! "application.json".into(), //! "application.yml".into(), //! ]) //! .ip(IpValue::HostCidr(IpCidr::from_str("172.16.0.0/16")?)) //! .build(), //! ); //! //! pin_mut!(stream); //! //! // There is a dead loop, `next()` is returned when configuration has changed. //! while let Some(response) = stream.next().await { //! let responses = response?; //! for response in responses { //! let _ = dbg!(response); //! } //! } //! //! Ok(()) //! } //! ``` //! pub mod meta; pub mod requests; pub mod responses; use crate::{ conf::{ meta::Notification, requests::{FetchRequest, NotifyRequest, PerformConfRequest, WatchRequest}, responses::FetchResponse, }, errors::{ApolloClientError::ApolloResponse, ApolloClientResult}, meta::{ handle_url, validate_response, PerformResponse, DEFAULT_NOTIFY_TIMEOUT, DEFAULT_TIMEOUT, }, }; use async_stream::stream; use futures_core::Stream; use futures_util::{stream, StreamExt}; use http::status::StatusCode; use reqwest::{Client, ClientBuilder}; use std::collections::HashMap; use url::Url; enum ServerUrl { ConfigServer(Url), /// Todo implement fetch config via meta server. #[allow(dead_code)] MetaServer(Url), } /// Builder for [ApolloConfClient]. pub struct ApolloConfClientBuilder { server_url: ServerUrl, client_builder: ClientBuilder, } impl ApolloConfClientBuilder { /// Create a client request api via config service. /// /// # Example /// /// ``` /// use apollo_client::conf::ApolloConfClientBuilder; /// use url::Url; /// /// let _builder = ApolloConfClientBuilder::new_via_config_service( /// Url::parse("http://localhost:8080").unwrap() /// ).unwrap(); /// ``` pub fn new_via_config_service(config_server_url: Url) -> ApolloClientResult<Self> { let mut builder = Self { server_url: ServerUrl::ConfigServer(config_server_url), client_builder: Default::default(), }; builder.client_builder = builder.client_builder.timeout(DEFAULT_TIMEOUT); Ok(builder) } /// Customize inner http client. /// /// # Example /// /// ```no_run /// use apollo_client::conf::ApolloConfClientBuilder; /// use std::time::Duration; /// /// let mut client_builder: ApolloConfClientBuilder = todo!(); /// client_builder = client_builder.with_client_builder(|builder| { /// builder.timeout(Duration::from_secs(6)) /// }); /// ``` pub fn with_client_builder(mut self, f: impl FnOnce(ClientBuilder) -> ClientBuilder) -> Self { self.client_builder = f(self.client_builder); self } /// Build the [ApolloConfClient]. pub fn build(self) -> ApolloClientResult<ApolloConfClient> { Ok(ApolloConfClient { server_url: self.server_url, client: self.client_builder.build()?, }) } } /// Apollo configuration apis client. pub struct ApolloConfClient { server_url: ServerUrl, client: Client, } impl ApolloConfClient { /// Execute configuration Api request. /// /// # Example /// /// ```no_run /// use apollo_client::{ /// conf::{ApolloConfClient, meta::IpValue, requests::CachedFetchRequest}, /// errors::ApolloClientResult, /// }; /// use ini::Properties; /// use std::error::Error; /// use url::Url; /// /// #[tokio::main] /// async fn main() -> Result<(), Box<dyn Error>> { /// let client: ApolloConfClient = todo!(); /// /// // Request apollo cached configuration api. /// let _configuration: Properties = client /// .execute( /// CachedFetchRequest::builder() /// .app_id("SampleApp") /// .namespace_name("application.json") /// .ip(IpValue::HostName) /// .build(), /// ) /// .await?; /// /// Ok(()) /// } /// ``` /// pub async fn execute<R: PerformResponse>( &self, request: impl PerformConfRequest<Response = R>, ) -> ApolloClientResult<R> { let url = match &self.server_url { ServerUrl::ConfigServer(url) => handle_url(&request, url.clone())?, ServerUrl::MetaServer(_) => todo!("unreachable here now"), }; let mut request_builder = self.client.request(request.method(), url); request_builder = request.request_builder(request_builder); let response = request_builder.send().await?; let response = validate_response(response).await?; <R>::from_response(response).await } /// Watch the multi namespaces change, and fetch namespaces configuration when changed. /// /// Return the Stream implemented [futures_core::Stream], and the return value of `poll_next` /// will never be None (Dead Loop). /// /// The first `poll_next` will fetch all namespaces, the remained will only fetch changed /// namespaces. /// /// # Panic /// /// panic if request field `namespace_names` is empty. /// /// # Example /// /// ```no_run /// use apollo_client::conf::{ApolloConfClient, meta::IpValue, requests::WatchRequest}; /// use cidr_utils::cidr::IpCidr; /// use futures_util::{pin_mut, stream::StreamExt}; /// use std::error::Error; /// /// #[tokio::main] /// async fn main() -> Result<(), Box<dyn Error>> { /// let client: ApolloConfClient = todo!(); /// /// let stream = client.watch( /// WatchRequest::builder() /// .app_id("SampleApp") /// .namespace_names([ /// "application.properties".into(), /// "application.json".into(), /// "application.yml".into(), /// ]) /// .ip(IpValue::HostCidr(IpCidr::from_str("172.16.0.0/16")?)) /// .build(), /// ); /// /// pin_mut!(stream); /// /// // This is a dead loop, `next()` is returned when configuration has changed. /// while let Some(response) = stream.next().await { /// let _ = response?; /// } /// /// Ok(()) /// } /// ``` /// pub fn watch( self, request: WatchRequest, ) -> impl Stream<Item = ApolloClientResult<HashMap<String, ApolloClientResult<FetchResponse>>>> { let mut watch_notifications = request.create_notifications(); let mut fetch_notifications = watch_notifications.clone(); assert_ne!( watch_notifications.len(), 0, "watch namespaces should not be null" ); stream! { loop { let requests = Notification::create_fetch_requests(fetch_notifications, &request); yield Ok(self.fetch_multi(requests).await); loop { match self .execute(NotifyRequest::from_watch( &request, watch_notifications.clone(), DEFAULT_NOTIFY_TIMEOUT, )) .await { Ok(notifications) => { let is_uninitialized = watch_notifications[0].is_uninitialized(); Notification::update_notifications( &mut watch_notifications, ¬ifications, ); fetch_notifications = notifications; if !is_uninitialized { break; } }, Err(ApolloResponse(e)) if e.status == StatusCode::NOT_MODIFIED => {}, Err(e) => yield Err(e), } } } } } async fn fetch_multi( &self, requests: Vec<FetchRequest>, ) -> HashMap<String, ApolloClientResult<FetchResponse>> { let executors = requests.into_iter().map(|fetch_request| async move { ( fetch_request.namespace_name(), self.execute(fetch_request).await, ) }); let executors_len = executors.len(); let executors_stream = stream::iter(executors); let mut buffered = executors_stream.buffer_unordered(executors_len); let mut map = HashMap::with_capacity(executors_len); while let Some(item) = buffered.next().await { map.insert(item.0, item.1); } map } }