Moved InvalidKey error into the backpressure module.

Author: horned-sphere

runtime/swimos_runtime/src/agent/task/mod.rs

@@ -22,7 +22,7 @@ use crate::agent::store::StoreInitError;
 use crate::agent::task::links::TriggerUnlink;
 use crate::agent::task::sender::LaneSendError;
 use crate::agent::task::write_fut::SpecialAction;
-use crate::error::InvalidKey;
+use crate::backpressure::InvalidKey;
 use crate::timeout_coord::{self, VoteResult};
 
 use self::external_links::{LinksTaskState, NoReport};

runtime/swimos_runtime/src/agent/task/remotes/mod.rs

@@ -20,7 +20,7 @@ use swimos_utilities::{byte_channel::ByteWriter, trigger::promise};
 use tracing::debug;
 use uuid::Uuid;
 
-use crate::{agent::DisconnectionReason, error::InvalidKey};
+use crate::{agent::DisconnectionReason, backpressure::InvalidKey};
 pub use sender::RemoteSender;
 pub use uplink::UplinkResponse;
 

runtime/swimos_runtime/src/agent/task/remotes/uplink/mod.rs

@@ -29,9 +29,8 @@ use crate::{
     },
     backpressure::{
         recon::MapOperationReconEncoder, BackpressureStrategy, MapBackpressure, SupplyBackpressure,
-        ValueBackpressure,
+        ValueBackpressure, InvalidKey
     },
-    error::InvalidKey,
 };
 
 #[cfg(test)]

runtime/swimos_runtime/src/backpressure/map_queue/mod.rs

@@ -20,9 +20,7 @@ use std::{
 use bytes::{BufMut, BytesMut};
 use swimos_agent_protocol::MapOperation;
 
-use crate::error::InvalidKey;
-
-use super::{key::ReconKey, RawMapOperation, RawMapOperationMut};
+use super::{key::ReconKey, RawMapOperation, RawMapOperationMut, InvalidKey};
 
 #[cfg(test)]
 mod tests;

runtime/swimos_runtime/src/backpressure/mod.rs

@@ -12,11 +12,13 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use std::{convert::Infallible, fmt::Display};
+use std::{convert::Infallible, fmt::{Display, Formatter}};
 
 use bytes::{Buf, BufMut, Bytes, BytesMut};
 use swimos_agent_protocol::{DownlinkOperation, MapOperation};
 use tokio_util::codec::Encoder;
+use std::str::Utf8Error;
+use thiserror::Error;
 
 use map_queue::MapOperationQueue;
 mod key;
@@ -25,7 +27,6 @@ pub mod recon;
 
 use recon::MapOperationReconEncoder;
 
-use crate::error::InvalidKey;
 
 type RawMapOperation = MapOperation<Bytes, BytesMut>;
 type RawMapOperationMut = MapOperation<BytesMut, BytesMut>;
@@ -211,3 +212,26 @@ impl BackpressureStrategy for MapBackpressure {
         }
     }
 }
+
+/// Error indicating that the key for a map message contained invalid UTF8.
+#[derive(Debug, Error)]
+pub struct InvalidKey {
+    key_bytes: Bytes,
+    source: Utf8Error,
+}
+
+impl Display for InvalidKey {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        write!(
+            f,
+            "The key {:?}, contains invalid UTF8: {}.",
+            self.key_bytes, self.source
+        )
+    }
+}
+
+impl InvalidKey {
+    pub fn new(key_bytes: Bytes, source: Utf8Error) -> Self {
+        InvalidKey { key_bytes, source }
+    }
+}

runtime/swimos_runtime/src/error/mod.rs

@@ -15,5 +15,4 @@
 pub mod agent;
 mod backpressure;
 pub mod downlink;
-pub mod error;
 mod timeout_coord;