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 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
use std::sync::Arc;
use std::time::Duration;
use crate::auth::{AuthCallback, Credential};
use crate::error::*;
use crate::{auth, http, rest, Result};
static REST_HOST: &str = "rest.ably.io";
/// [Ably client options] for initialising a REST or Realtime client.
///
/// [Ably client options]: https://ably.com/documentation/rest/types#client-options
#[allow(dead_code)]
#[derive(Debug)]
pub struct ClientOptions {
pub(crate) credential: auth::Credential,
/// The HTTP method to use when requesting a token from auth_url. Defaults
/// to GET.
pub(crate) auth_method: http::Method,
/// The HTTP headers to include when requesting a token from auth_url.
pub(crate) auth_headers: Option<http::HeaderMap>,
/// The HTTP params to use when requesting a token from auth_url, which are
/// included in the query string when auth_method is GET, or in the
/// form-encoded body when auth_method is POST.
pub(crate) auth_params: Option<http::UrlQuery>,
/// Use TLS for all connections. Defaults to true.
pub(crate) tls: bool,
/// A client ID, used for identifying this client when publishing messages
/// or for presence purposes.
pub(crate) client_id: Option<String>,
/// Always use token authentication, even if an Ably API key is set.
pub(crate) use_token_auth: bool,
/// An optional custom environment used to construct API URLs.
pub(crate) environment: Option<String>,
/// Enable idempotent REST publishing. Defaults to false.
///
/// See https://faqs.ably.com/what-is-idempotent-publishing
pub(crate) idempotent_rest_publishing: bool,
/// The list of fallback hosts to use in the case of an error necessitating
/// the use of an alternative host. Defaults to [a-e].ably-realtime.com.
pub(crate) fallback_hosts: Vec<String>,
/// Encode requests using the binary msgpack encoding, or the JSON
/// encoding. Defaults to msgpack.
pub(crate) format: rest::Format,
/// Query the Ably system for the current time when issuing tokens.
/// Defaults to false.
pub(crate) query_time: bool,
/// Override the default parameters used to request Ably tokens.
pub(crate) default_token_params: Option<auth::TokenParams>,
/// Automatically connect when the Realtime library is instantiated.
/// Defaults to true.
pub(crate) auto_connect: bool,
// pub queue_messages: bool,
// pub echo_messages: bool,
// pub recover: Option<String>,
/// The hostname used in the REST API URL. Defaults to rest.ably.io.
pub(crate) rest_host: String,
/// The hostname used in the Realtime API URL. Defaults to
/// realtime.ably.io.
pub(crate) realtime_host: String,
/// The TCP port for non-TLS requests. Defaults to 80.
pub(crate) port: u32,
/// The TCP port for TLS requests. Defaults to 443.
pub(crate) tls_port: u32,
/// How long to wait before attempting to re-establish a connection which
/// is in the DISCONNECTED state. Defaults to 15s.
pub(crate) disconnected_retry_timeout: Duration,
/// How long to wait before attempting to re-establish a connection which
/// is in the SUSPENDED state. Defaults to 30s.
pub(crate) suspended_retry_timeout: Duration,
/// How long to wait before attempting to re-attach a channel which is in
/// the SUSPENDED state following a server initiated detach. Defaults to
/// 15s.
pub(crate) channel_retry_timeout: Duration,
/// How long to wait for a TCP connection to be established. Defaults to
/// 4s.
pub(crate) http_open_timeout: Duration,
/// How long to wait for a HTTP request to be sent and a response to be
/// received. Defaults to 10s.
pub(crate) http_request_timeout: Duration,
/// The maximum number of fallback hosts to try when the primary host is
/// unreachable or it indicates that the request is unserviceable.
pub(crate) http_max_retry_count: usize,
/// How long to wait for fallback requests to succeed before considering
/// the request as failed. Defaults to 15s.
pub(crate) http_max_retry_duration: Duration,
/// The maximum size of messages that can be published in a single request.
/// Defaults to 64KiB.
pub(crate) max_message_size: u64,
/// The maximum size of a single POST body or WebSocket frame. Defaults to
/// 512KiB.
pub(crate) max_frame_size: u64,
/// How long to wait before switching back to the primary host after a
/// successful request to a fallback endpoint. Defaults to 10m.
pub(crate) fallback_retry_timeout: Duration,
/// Include a random request_id in the query string of all API requests.
/// Defaults to false.
pub(crate) add_request_ids: bool,
}
impl ClientOptions {
pub fn new(s: &str) -> Self {
match auth::Key::new(s) {
Ok(k) => Self::with_key(k),
Err(_) => Self::with_token(s.to_string()),
}
}
pub fn with_auth_url(url: reqwest::Url) -> Self {
Self::token_source(Credential::Url(url))
}
pub fn with_auth_callback(callback: Arc<dyn AuthCallback>) -> Self {
Self::token_source(Credential::Callback(callback))
}
/// Sets the API key.
///
/// # Example
///
/// ```
/// # fn main() -> ably::Result<()> {
/// let client = ably::ClientOptions::new("aaaaaa.bbbbbb:cccccc").rest()?;
/// # Ok(())
/// # }
/// ```
pub fn with_key(key: auth::Key) -> Self {
Self::token_source(Credential::Key(key))
}
pub fn with_token(token: String) -> Self {
Self::token_source(Credential::TokenDetails(auth::TokenDetails::token(token)))
}
/// Set the client ID, used for identifying this client when publishing
/// messages or for presence purposes. Can be any utf-8 string except the
/// reserved wildcard string '*'.
pub fn client_id(mut self, client_id: impl Into<String>) -> Result<Self> {
let client_id = client_id.into();
if client_id == "*" {
return Err(Error::new(
ErrorCode::InvalidClientID,
"Can’t use '*' as a clientId as that string is reserved",
));
} else {
self.client_id = Some(client_id);
}
Ok(self)
}
/// Indicates whether token authentication should be used even if an API
/// key is present.
pub fn use_token_auth(mut self, v: bool) -> Self {
self.use_token_auth = v;
self
}
/// Sets the environment. See [TO3k1].
///
/// # Example
///
/// ```
/// # fn main() -> ably::Result<()> {
/// let client = ably::ClientOptions::new("aaaaaa.bbbbbb:cccccc")
/// .environment("sandbox")?
/// .rest()?;
/// # Ok(())
/// # }
/// ```
///
/// # Errors
///
/// Fails if rest_host is already set or if the environment cannot be used
/// in the REST API URL.
///
/// [T03k1]: https://docs.ably.io/client-lib-development-guide/features/#TO3k1
pub fn environment(mut self, environment: impl Into<String>) -> Result<Self> {
// Only allow the environment to be set if rest_host is the default.
if self.rest_host != REST_HOST {
return Err(Error::new(
ErrorCode::BadRequest,
"Cannot set both environment and rest_host",
));
}
let environment = environment.into();
self.rest_host = format!("{}-rest.ably.io", environment);
// Generate the fallback hosts.
self.fallback_hosts = vec![
format!("{}-a-fallback.ably-realtime.com", environment),
format!("{}-b-fallback.ably-realtime.com", environment),
format!("{}-c-fallback.ably-realtime.com", environment),
format!("{}-d-fallback.ably-realtime.com", environment),
format!("{}-e-fallback.ably-realtime.com", environment),
];
// Track that the environment was set.
self.environment = Some(environment);
Ok(self)
}
/// Sets the message format to MessagePack if the argument is true, or JSON
/// if the argument is false.
pub fn use_binary_protocol(mut self, v: bool) -> Self {
self.format = if v {
rest::Format::MessagePack
} else {
rest::Format::JSON
};
self
}
/// Set the default TokenParams.
pub fn default_token_params(mut self, params: auth::TokenParams) -> Self {
self.default_token_params = Some(params);
self
}
/// Sets the rest_host. See [TO3k2].
///
/// # Example
///
/// ```
/// # fn main() -> ably::Result<()> {
/// let client = ably::ClientOptions::new("aaaaaa.bbbbbb:cccccc")
/// .rest_host("sandbox-rest.ably.io")?
/// .rest()?;
/// # Ok(())
/// # }
/// ```
///
/// # Errors
///
/// Fails if environment is already set or if the rest_host cannot be used
/// in the REST API URL.
///
/// [T03k2]: https://docs.ably.io/client-lib-development-guide/features/#TO3k2
pub fn rest_host(mut self, rest_host: impl Into<String>) -> Result<Self> {
// Only allow the rest_host to be set if environment isn't set.
if self.environment.is_some() {
return Err(Error::new(
ErrorCode::BadRequest,
"Cannot set both environment and rest_host",
));
}
// TODO: only unset these if they're the defaults
self.fallback_hosts = Vec::new();
// Track that the rest_host was set.
self.rest_host = rest_host.into();
Ok(self)
}
/// Sets the fallback hosts.
pub fn fallback_hosts(mut self, hosts: Vec<String>) -> Self {
self.fallback_hosts = hosts;
self
}
/// Sets the HTTP request timeout.
pub fn http_request_timeout(mut self, timeout: Duration) -> Self {
self.http_request_timeout = timeout;
self
}
/// Sets the maximum number of HTTP retries.
pub fn http_max_retry_count(mut self, count: usize) -> Self {
self.http_max_retry_count = count;
self
}
fn rest_url(&self) -> Result<reqwest::Url> {
let rest_url = if self.tls {
format!("https://{}", self.rest_host)
} else {
format!("http://{}", self.rest_host)
};
let rest_url = reqwest::Url::parse(&rest_url)?;
Ok(rest_url)
}
/// Returns a Rest client using the ClientOptions.
///
/// # Errors
///
/// This method fails if the ClientOptions are not valid:
///
/// - the REST API URL must be valid
///
/// [RSC1b]: https://docs.ably.io/client-lib-development-guide/features/#RSC1b
pub fn rest(self) -> Result<rest::Rest> {
let rest_url = self.rest_url()?;
let mut default_headers = http::HeaderMap::new();
default_headers.insert("X-Ably-Version", http::HeaderValue::from_static("1.2"));
if let Some(client_id) = &self.client_id {
default_headers.insert("X-Ably-ClientId", base64::encode(client_id).parse()?);
}
let http_client = reqwest::Client::builder()
.default_headers(default_headers)
.timeout(self.http_request_timeout)
.connect_timeout(self.http_open_timeout)
.build()?;
Ok(rest::Rest::create(http_client, self, rest_url))
}
pub fn token_source(token: Credential) -> Self {
Self {
credential: token,
auth_method: http::Method::GET,
auth_headers: None,
auth_params: None,
tls: true,
client_id: None,
use_token_auth: false,
environment: None,
idempotent_rest_publishing: false,
fallback_hosts: vec![
"a.ably-realtime.com".to_string(),
"b.ably-realtime.com".to_string(),
"c.ably-realtime.com".to_string(),
"d.ably-realtime.com".to_string(),
"e.ably-realtime.com".to_string(),
],
format: rest::Format::MessagePack,
query_time: false,
default_token_params: None,
auto_connect: true,
rest_host: REST_HOST.to_string(),
realtime_host: "realtime.ably.io".to_string(),
port: 80,
tls_port: 443,
disconnected_retry_timeout: Duration::from_secs(15),
suspended_retry_timeout: Duration::from_secs(30),
channel_retry_timeout: Duration::from_secs(15),
http_open_timeout: Duration::from_secs(4),
http_request_timeout: Duration::from_secs(10),
http_max_retry_count: 3,
http_max_retry_duration: Duration::from_secs(15),
max_message_size: 64 * 1024,
max_frame_size: 512 * 1024,
fallback_retry_timeout: Duration::from_secs(10 * 60),
add_request_ids: false,
}
}
}