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 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
pub mod broker; pub mod events; mod generated; mod inv; mod sub_stream; use crate::events::PublishedEvent; pub use crate::generated::ctliface::*; use crossbeam_channel::{unbounded, Receiver}; use futures::executor::block_on; use futures::stream::StreamExt; use inv::Entity; pub use inv::{Invocation, InvocationResponse}; use log::error; use nats::asynk::Connection; use serde::{Deserialize, Serialize}; use std::{collections::HashMap, time::Duration}; use sub_stream::SubscriptionStream; use wascap::prelude::KeyPair; type Result<T> = ::std::result::Result<T, Box<dyn ::std::error::Error + Send + Sync>>; /// Lattice control interface client pub struct Client { nc: Connection, nsprefix: Option<String>, timeout: Duration, key: KeyPair, } impl Client { /// Creates a new lattice control interface client pub fn new(nc: Connection, nsprefix: Option<String>, timeout: Duration) -> Self { Client { nc, nsprefix, timeout, key: KeyPair::new_server(), } } /// Queries the lattice for all responsive hosts, waiting for the full period specified by _timeout_. pub async fn get_hosts(&self, timeout: Duration) -> Result<Vec<Host>> { let subject = broker::queries::hosts(&self.nsprefix); let sub = self.nc.request_multi(&subject, vec![]).await?; let hosts = SubscriptionStream::new(sub) .collect(timeout, "get hosts") .await; Ok(hosts) } /// Performs an actor auction within the lattice, publishing a set of constraints and the metadata for the actor /// in question. This will always wait for the full period specified by _duration_, and then return the set of /// gathered results. It is then up to the client to choose from among the "auction winners" to issue the appropriate /// command to start an actor. Clients cannot assume that auctions will always return at least one result. pub async fn perform_actor_auction( &self, actor_ref: &str, constraints: HashMap<String, String>, timeout: Duration, ) -> Result<Vec<ActorAuctionAck>> { let subject = broker::actor_auction_subject(&self.nsprefix); let bytes = serialize(ActorAuctionRequest { actor_ref: actor_ref.to_string(), constraints, })?; let sub = self.nc.request_multi(&subject, bytes).await?; let actors = SubscriptionStream::new(sub) .collect(timeout, "actor auction") .await; Ok(actors) } /// Performs a provider auction within the lattice, publishing a set of constraints and the metadata for the provider /// in question. This will always wait for the full period specified by _duration_, and then return the set of gathered /// results. It is then up to the client to choose from among the "auction winners" and issue the appropriate command /// to start a provider. Clients cannot assume that auctions will always return at least one result. pub async fn perform_provider_auction( &self, provider_ref: &str, link_name: &str, constraints: HashMap<String, String>, timeout: Duration, ) -> Result<Vec<ProviderAuctionAck>> { let subject = broker::provider_auction_subject(&self.nsprefix); let bytes = serialize(ProviderAuctionRequest { provider_ref: provider_ref.to_string(), link_name: link_name.to_string(), constraints, })?; let sub = self.nc.request_multi(&subject, bytes).await?; let providers = SubscriptionStream::new(sub) .collect(timeout, "provider auction") .await; Ok(providers) } /// Retrieves the contents of a running host pub async fn get_host_inventory(&self, host_id: &str) -> Result<HostInventory> { let subject = broker::queries::host_inventory(&self.nsprefix, host_id); match actix_rt::time::timeout(self.timeout, self.nc.request(&subject, vec![])).await? { Ok(msg) => { let hi: HostInventory = deserialize(&msg.data)?; Ok(hi) } Err(e) => Err(format!("Did not receive host inventory from target host: {}", e).into()), } } /// Sends a request to the given host to start a given actor by its OCI reference. This returns an acknowledgement /// of _receipt_ of the command, not a confirmation that the actor started. An acknowledgement will either indicate /// some form of validation failure, or, if no failure occurs, the receipt of the command. To avoid blocking consumers, /// wasmCloud hosts will acknowledge the start actor command prior to fetching the actor's OCI bytes. If a client needs /// deterministic results as to whether the actor completed its startup process, the client will have to monitor /// the appropriate event in the control event stream pub async fn start_actor(&self, host_id: &str, actor_ref: &str) -> Result<StartActorAck> { let subject = broker::commands::start_actor(&self.nsprefix, host_id); let bytes = serialize(StartActorCommand { actor_ref: actor_ref.to_string(), host_id: host_id.to_string(), })?; match actix_rt::time::timeout(self.timeout, self.nc.request(&subject, &bytes)).await? { Ok(msg) => { let ack: StartActorAck = deserialize(&msg.data)?; Ok(ack) } Err(e) => Err(format!("Did not receive start actor acknowledgement: {}", e).into()), } } /// Performs a remote procedure call over the lattice, targeting the given actor. This call will appear /// to originate from the "system" actor and from a unique host ID that was generated by the control /// interface client when it was instantiated. If there are multiple actors with the same public key /// actively running in the lattice, then the message broker is responsible for choosing the appropriate /// target. Under current NATS implementations, that means an actor is chosen psuedo-randomly among the /// known queue subscribers, and will **not** be invoked in round-robin fashion pub async fn call_actor( &self, target_id: &str, operation: &str, data: &[u8], ) -> Result<InvocationResponse> { let subject = broker::rpc::call_actor(&self.nsprefix, target_id); let bytes = crate::generated::ctliface::serialize(Invocation::new( &self.key, Entity::Actor("system".to_string()), Entity::Actor(target_id.to_string()), operation, data.to_vec(), ))?; match actix_rt::time::timeout(self.timeout, self.nc.request(&subject, &bytes)).await? { Ok(msg) => { let resp: InvocationResponse = crate::generated::ctliface::deserialize(&msg.data)?; Ok(resp) } Err(e) => Err(format!("Actor RPC call did not succeed: {}", e).into()), } } /// Publishes the link advertisement message to the lattice that is published when code invokes the `set_link` /// function on a `Host` struct instance. No confirmation or acknowledgement is available for this operation /// because it is publish-only. pub async fn advertise_link( &self, actor_id: &str, provider_id: &str, contract_id: &str, link_name: &str, values: HashMap<String, String>, ) -> Result<()> { let subject = broker::rpc::advertise_links(&self.nsprefix); let ld = LinkDefinition { actor_id: actor_id.to_string(), provider_id: provider_id.to_string(), contract_id: contract_id.to_string(), link_name: link_name.to_string(), values, }; let bytes = crate::generated::ctliface::serialize(&ld)?; self.nc.publish(&subject, &bytes).await?; Ok(()) } /// Publishes a request to remove a link definition to the lattice. All hosts in the lattice will /// receive this message and, if the appropriate capability provider is in that host, it will have /// the "remove actor" operation sent to it. The link definition will also be removed from the lattice /// cache. No confirmation or acknowledgement is available for this operation, you will need to monitor events /// and/or query the lattice to confirm that the link has been removed. pub async fn remove_link( &self, actor_id: &str, contract_id: &str, link_name: &str, ) -> Result<()> { let subject = broker::rpc::remove_links(&self.nsprefix); let ld = LinkDefinition { actor_id: actor_id.to_string(), contract_id: contract_id.to_string(), link_name: link_name.to_string(), ..Default::default() }; let bytes = crate::generated::ctliface::serialize(&ld)?; self.nc.publish(&subject, &bytes).await?; Ok(()) } /// Issue a command to a host instructing that it replace an existing actor (indicated by its /// public key) with a new actor indicated by an OCI image reference. The host will acknowledge /// this request as soon as it verifies that the target actor is running. This acknowledgement /// occurs **before** the new bytes are downloaded. Live-updating an actor can take a long /// time and control clients cannot block waiting for a reply that could come several seconds /// later. If you need to verify that the actor has been updated, you will want to set up a /// listener for the appropriate **PublishedEvent** which will be published on the control events /// channel in JSON pub async fn update_actor( &self, host_id: &str, existing_actor_id: &str, new_actor_ref: &str, ) -> Result<UpdateActorAck> { let subject = broker::commands::update_actor(&self.nsprefix, host_id); let bytes = serialize(UpdateActorCommand { host_id: host_id.to_string(), actor_id: existing_actor_id.to_string(), new_actor_ref: new_actor_ref.to_string(), })?; match actix_rt::time::timeout(self.timeout, self.nc.request(&subject, &bytes)).await? { Ok(msg) => { let ack: UpdateActorAck = deserialize(&msg.data)?; Ok(ack) } Err(e) => Err(format!("Did not receive update actor acknowledgement: {}", e).into()), } } /// Issues a command to a host to start a provider with a given OCI reference using the specified link /// name (or "default" if none is specified). The target wasmCloud host will acknowledge the receipt /// of this command _before_ downloading the provider's bytes from the OCI registry, indicating either /// a validation failure or success. If a client needs deterministic guarantees that the provider has /// completed its startup process, such a client needs to monitor the control event stream for the /// appropriate event pub async fn start_provider( &self, host_id: &str, provider_ref: &str, link_name: Option<String>, ) -> Result<StartProviderAck> { let subject = broker::commands::start_provider(&self.nsprefix, host_id); let bytes = serialize(StartProviderCommand { host_id: host_id.to_string(), provider_ref: provider_ref.to_string(), link_name: link_name.unwrap_or_else(|| "default".to_string()), })?; match actix_rt::time::timeout(self.timeout, self.nc.request(&subject, &bytes)).await? { Ok(msg) => { let ack: StartProviderAck = deserialize(&msg.data)?; Ok(ack) } Err(e) => Err(format!("Did not receive start provider acknowledgement: {}", e).into()), } } /// Issues a command to a host to stop a provider for the given OCI reference, link name, and contract ID. The /// target wasmCloud host will acknowledge the receipt of this command, and _will not_ supply a discrete /// confirmation that a provider has terminated. For that kind of information, the client must also monitor /// the control event stream pub async fn stop_provider( &self, host_id: &str, provider_ref: &str, link_name: &str, contract_id: &str, ) -> Result<StopProviderAck> { let subject = broker::commands::stop_provider(&self.nsprefix, host_id); let bytes = serialize(StopProviderCommand { host_id: host_id.to_string(), provider_ref: provider_ref.to_string(), link_name: link_name.to_string(), contract_id: contract_id.to_string(), })?; match actix_rt::time::timeout(self.timeout, self.nc.request(&subject, &bytes)).await? { Ok(msg) => { let ack: StopProviderAck = deserialize(&msg.data)?; Ok(ack) } Err(e) => Err(format!("Did not receive stop provider acknowledgement: {}", e).into()), } } /// Issues a command to a host to stop an actor for the given OCI reference. The /// target wasmCloud host will acknowledge the receipt of this command, and _will not_ supply a discrete /// confirmation that the actor has terminated. For that kind of information, the client must also monitor /// the control event stream pub async fn stop_actor(&self, host_id: &str, actor_ref: &str) -> Result<StopActorAck> { let subject = broker::commands::stop_actor(&self.nsprefix, host_id); let bytes = serialize(StopActorCommand { host_id: host_id.to_string(), actor_ref: actor_ref.to_string(), })?; match actix_rt::time::timeout(self.timeout, self.nc.request(&subject, &bytes)).await? { Ok(msg) => { let ack: StopActorAck = deserialize(&msg.data)?; Ok(ack) } Err(e) => Err(format!("Did not receive stop actor acknowledgement: {}", e).into()), } } /// Retrieves the full set of all cached claims in the lattice by getting a response from the first /// host that answers this query pub async fn get_claims(&self) -> Result<ClaimsList> { let subject = broker::queries::claims(&self.nsprefix); match actix_rt::time::timeout(self.timeout, self.nc.request(&subject, vec![])).await? { Ok(msg) => { let list: ClaimsList = deserialize(&msg.data)?; Ok(list) } Err(e) => Err(format!("Did not receive claims from lattice: {}", e).into()), } } /// Returns the receiver end of a channel that subscribes to the lattice control event stream. /// Any [`PublishedEvent`](struct@PublishedEvent)s that are published after this channel is created /// will be added to the receiver channel's buffer, which can be observed or handled if needed. /// See the example for how you could use this receiver to handle events. /// /// # Example /// ```rust /// use wasmcloud_control_interface::Client; /// async { /// let nc = nats::asynk::connect("0.0.0.0:4222").await.unwrap(); /// let client = Client::new(nc, None, std::time::Duration::from_millis(1000)); /// let receiver = client.events_receiver().await.unwrap(); /// std::thread::spawn(move || loop { /// if let Ok(evt) = receiver.recv() { /// println!("Event received: {:?}", evt); /// } else { /// // channel is closed /// break; /// } /// }); /// // perform other operations on client /// client.get_host_inventory("NAEXHW...").await.unwrap(); /// }; /// ``` /// /// Once you're finished with the event receiver, be sure to call `drop` with the receiver /// as an argument. This closes the channel and will prevent the sender from endlessly /// sending messages into the channel buffer. /// /// # Example /// ```rust /// use wasmcloud_control_interface::Client; /// async { /// let nc = nats::asynk::connect("0.0.0.0:4222").await.unwrap(); /// let client = Client::new(nc, None, std::time::Duration::from_millis(1000)); /// let receiver = client.events_receiver().await.unwrap(); /// std::thread::spawn(move || { /// if let Ok(evt) = receiver.recv() { /// println!("Event received: {:?}", evt); /// // We received our one event, now close the channel /// drop(receiver); /// } else { /// // channel is closed /// return; /// } /// }); /// }; /// ``` pub async fn events_receiver(&self) -> Result<Receiver<PublishedEvent>> { let (sender, receiver) = unbounded(); let mut sub = self .nc .subscribe(&broker::control_event(&self.nsprefix)) .await?; std::thread::spawn(move || loop { if let Some(msg) = block_on(&mut sub.next()) { match deserialize::<PublishedEvent>(&msg.data) { Ok(evt) => { // If the channel is disconnected, stop sending events if sender.send(evt).is_err() { let _ = block_on(sub.unsubscribe()); return; } } _ => error!("Object received on event stream was not a PublishedEvent"), } } }); Ok(receiver) } } /// The standard function for serializing codec structs into a format that can be /// used for message exchange between actor and host. Use of any other function to /// serialize could result in breaking incompatibilities. pub fn serialize<T>( item: T, ) -> ::std::result::Result<Vec<u8>, Box<dyn std::error::Error + Send + Sync>> where T: Serialize, { serde_json::to_vec(&item).map_err(|e| format!("JSON serialization failure: {}", e).into()) } /// The standard function for de-serializing codec structs from a format suitable /// for message exchange between actor and host. Use of any other function to /// deserialize could result in breaking incompatibilities. pub fn deserialize<'de, T: Deserialize<'de>>( buf: &'de [u8], ) -> ::std::result::Result<T, Box<dyn std::error::Error + Send + Sync>> { serde_json::from_slice(buf).map_err(|e| format!("JSON deserialization failure: {}", e).into()) }