wip

- less clutter with unusable `span` info (on my personal preference)
- less errors logged when being scanned (ex.: after status response
    don't log errors with ping packets, scanners usually close
    the connection)
- implemented more detailed OpaqueError fields
    - `tracing::Level`
    - error `kind`

README.md

@@ -1,3 +1,8 @@
+# Development
+TODO: fill this out
+### Nix shell with tmux
+In the nix flake there is a devshell setup with cargo and tmux.
+When using tmux it uses a set tmux server path, so only this project uses it.
 # Env variables:
 ```bash
 # Address the server should bind to

flake.nix

@@ -142,6 +142,11 @@
           # Extra inputs can be added here; cargo and rustc are provided by default.
           packages = [
             pkgs.rust-analyzer
+
+            (pkgs.writers.writeBashBin "tmux" ''
+              exec ${lib.getExe pkgs.tmux} -S /tmp/tmux-kube_ingress "$@"
+            ''
+            )
           ];
         };
       });

kube/roles.yaml

@@ -0,0 +1,9 @@
+apiVersion: rbac.authorization.k8s.io/v1
+kind: Role
+metadata:
+  namespace: default
+  name: minecraft-ingress
+rules:
+- apiGroups: [""] # "" indicates the core API group
+  resources: ["pods","deployments","services"]
+  verbs: ["get", "list"]

src/kube_cache.rs

@@ -12,11 +12,7 @@ use tracing::Instrument;
 
 use crate::{
     mc_server::{sanitize_addr, MinecraftAPI, MinecraftServerHandle, ServerDeploymentStatus},
-    packets::{
-        clientbound::status::StatusTrait,
-        serverbound::handshake::{self},
-        SendPacket,
-    },
+    packets::{clientbound::status::StatusTrait, SendPacket},
     OpaqueError,
 };
 
@@ -99,17 +95,19 @@ impl MinecraftAPI<Server> for McApi {
         let dep_name = match self.cache.query_dep_addr(&addr, &port).await {
             Some(x) => x,
             None => {
-                return Err(OpaqueError::create(&format!(
-                    "Failed to find deployment name by addr"
-                )))
+                return Err(OpaqueError::create_with_kind(
+                    "Failed to find deployment name by addr",
+                    "DepNameLookupFailed",
+                ))
             }
         };
         let srv_name = match self.cache.query_srv_addr(&addr, &port).await {
             Some(x) => x,
             None => {
-                return Err(OpaqueError::create(&format!(
-                    "Failed to find service name by addr"
-                )))
+                return Err(OpaqueError::create_with_kind(
+                    "Failed to find service name by addr",
+                    "SrvNameLookupFailed",
+                ))
             }
         };
 
@@ -191,7 +189,7 @@ impl MinecraftAPI<Server> for McApi {
                         drop(guard);
                         if let Err(err) = server.stop().await {
                             tracing::error!(
-                                trace = err.get_span_trace(),
+                                trace = %err.print_span_trace(),
                                 err = err.context,
                                 msg = "failed to stop server"
                             );
@@ -436,6 +434,7 @@ impl fmt::Debug for ServerDeploymentStatus {
             Self::Starting => write!(f, "Starting"),
             Self::PodOk => write!(f, "PodOk"),
             Self::Offline => write!(f, "Offline"),
+            Self::Unavailable(s) => write!(f, "Unavailable ({s})"),
         }
     }
 }

src/main.rs

@@ -58,12 +58,35 @@ async fn main() {
                 "Client connected"
             );
             if let Err(e) = process_connection(socket, addr, api, config).await {
-                tracing::error!(
+                match e.level {
+                    tracing::Level::ERROR => tracing::error!(
                         // addr = format!("{}:{}", addr.ip().to_string(), addr.port().to_string()),
-                    trace = format!("{}", e.get_span_trace()),
+                        trace = %e.print_span_trace(),
                         err = format!("{}", e.context),
                         "Client disconnected"
-                );
+                    ),
+                    tracing::Level::WARN => tracing::warn!(
+                        // addr = format!("{}:{}", addr.ip().to_string(), addr.port().to_string()),
+                        trace = %e.print_span_trace(),
+                        err = format!("{}", e.context),
+                        "Client disconnected"
+                    ),
+                    tracing::Level::INFO => tracing::info!(
+                        // addr = format!("{}:{}", addr.ip().to_string(), addr.port().to_string()),
+                        trace = %e.print_span_trace(),
+                        err = format!("{}", e.context),
+                        "Client disconnected"
+                    ),
+                    _ => {
+                        tracing::error!(
+                            // addr = format!("{}:{}", addr.ip().to_string(), addr.port().to_string()),
+                            trace = %e.print_span_trace(),
+                            err = format!("{}", e.context),
+                            actual_level = ?e.level,
+                            "Client disconnected (bad level)"
+                        )
+                    }
+                }
             } else {
                 tracing::debug!(
                     addr = format!("{}:{}", addr.ip().to_string(), addr.port().to_string()),
@@ -74,18 +97,23 @@ async fn main() {
     }
 }
 
-#[tracing::instrument(level = "info", skip(api, client_stream, config))]
 async fn process_connection<T: MinecraftServerHandle>(
     mut client_stream: TcpStream,
     addr: SocketAddr,
     api: impl MinecraftAPI<T>,
     config: Config,
 ) -> Result<(), OpaqueError> {
-    let client_packet = Packet::parse(&mut client_stream).await?;
+    // this is wrapper so that async doesnt mess up the span, and
+    // to make sure this doesn't propagate to later `handle_*`
+    #[tracing::instrument(level = "info", skip(client_stream, config))]
+    async fn first_packet(
+        client_stream: &mut TcpStream,
+        config: Config,
+    ) -> Result<Option<packets::serverbound::handshake::Handshake>, OpaqueError> {
+        let client_packet = Packet::parse(client_stream).await?;
 
         // --- Handshake ---
         let handshake;
-    let next_server_state;
         let packet_id = client_packet.id.get_int();
         if packet_id != 0 {
             return Err(OpaqueError::create(&format!(
@@ -105,11 +133,19 @@ async fn process_connection<T: MinecraftServerHandle>(
         if filter {
             // TODO: if the server just returns here, the client does not know it
             // and sends a packet with the 122 WeirdID
-        return Ok(());
+            tracing::trace!("filtered out the connection");
+            return Ok(None);
         }
 
-    next_server_state = handshake.get_next_state();
+        Ok(Some(handshake))
+    }
+    let handshake = match first_packet(&mut client_stream, config).await? {
+        Some(x) => x,
+        // this is needed because of the filter
+        None => return Ok(()),
+    };
 
+    let next_server_state = handshake.get_next_state();
     match next_server_state {
         packets::ProtocolState::Status => {
             handle_status(&mut client_stream, &handshake, api).await?;
@@ -159,7 +195,6 @@ async fn handle_status<T: MinecraftServerHandle>(
     };
 
     let server_addr = handshake.get_server_address();
-    let commit_hash: &'static str = env!("COMMIT_HASH");
     let mut status_struct = StatusStructNew::create();
     status_struct.version.protocol = handshake.protocol_version.get_int();
 
@@ -172,7 +207,7 @@ async fn handle_status<T: MinecraftServerHandle>(
     {
         Ok(x) => x,
         Err(e) => {
-            let span = tracing::span!(tracing::Level::WARN, "not_found", err = e.context);
+            let span = tracing::span!(tracing::Level::INFO, "unavailable", err = e.get_kind());
             status_struct.players.max = 0;
             status_struct.players.online = 0;
             status_struct.description.text = format!(
@@ -184,22 +219,25 @@ async fn handle_status<T: MinecraftServerHandle>(
                 .await?;
 
             // Recieve the ping packet, so the client does not send it again
-            let _ping = Packet::parse(client_stream).instrument(span.clone()).await;
+            let _ping = Packet::parse(client_stream)
+                .instrument(span.clone())
+                .await
+                .map_err(|err| {
+                    tracing::debug!(
+                        err = OpaqueError::from(err).context,
+                        "failed to parse ping packet"
+                    )
+                });
             // Send a bad ping packet back, so the client shows *searching* icon
             let _pong = Packet::new(9, vec![0; 8])
                 .ok_or("failed to create empty pong packet?")?
                 .send_packet(client_stream)
                 .instrument(span.clone())
                 .await
-                .map_err(|_| "failed to send pong packet")?;
-            let _guard = span.enter();
+                .map_err(|_| tracing::debug!("failed to send pong packet"));
 
-            match _ping {
-                Ok(_) => tracing::info!("sent status with error"),
-                Err(err) => {
-                    tracing::error!(err = OpaqueError::from(err).context)
-                }
-            };
+            let status = ServerDeploymentStatus::Unavailable(e.get_kind().to_string());
+            tracing::info!(status = ?status, "status request");
             return Ok(());
         }
     };
@@ -209,7 +247,6 @@ async fn handle_status<T: MinecraftServerHandle>(
         .get_motd()
         .unwrap_or("A minecraft server (proxy motd)".to_string());
 
-    tracing::trace!(motd);
     match status {
         ServerDeploymentStatus::Connectable(mut server_stream) => {
             return server
@@ -227,6 +264,7 @@ async fn handle_status<T: MinecraftServerHandle>(
             status_struct.description.text =
                 format!("{motd}\n§4Offline§r §oJoin to start!§r - {BYE_MESSAGE}");
         }
+        ServerDeploymentStatus::Unavailable(_) => unreachable!(),
     };
 
     mc_server::complete_status_request(client_stream, status_struct).await?;
@@ -245,7 +283,8 @@ async fn handle_login<T: MinecraftServerHandle>(
             &handshake.get_server_address(),
             &handshake.server_port.get_value().to_string(),
         )
-        .await?;
+        .await
+        .map_err(|e| e.set_level(tracing::Level::WARN))?;
 
     let status = server.query_status().await?;
     tracing::debug!(msg = "server status", status = ?status);
@@ -281,12 +320,20 @@ async fn handle_login<T: MinecraftServerHandle>(
                 .execute(client_stream, &mut server_stream)
                 .await;
 
-            tracing::debug!("data exchanged: tx: {} rx: {}", traffic.tx, traffic.rx);
-            if let Some(e) = traffic.error {
-                return Err(OpaqueError::create(&format!(
-                    "failed to splice; err = {}",
-                    e
-                )));
+            match traffic.error {
+                Some(e) => {
+                    tracing::warn!(
+                        tx = traffic.tx,
+                        rx = traffic.rx,
+                        err = ?e,
+                        "connection splicing ended with error",
+                    )
+                }
+                None => tracing::info!(
+                    tx = traffic.tx,
+                    rx = traffic.rx,
+                    "connection splicing ended",
+                ),
             }
         }
         ServerDeploymentStatus::PodOk | ServerDeploymentStatus::Starting => {
@@ -298,6 +345,7 @@ async fn handle_login<T: MinecraftServerHandle>(
                 .await?;
             mc_server::send_disconnect(client_stream, format!("[\"\",{{\"text\":\"Okayy, §2starting§r the server!\n\n\"}},{{\"text\":\"{BYE_MESSAGE}\"}}]").as_str()).await?;
         }
+        ServerDeploymentStatus::Unavailable(_) => unreachable!(),
     }
     Ok(())
 }

src/mc_server.rs

@@ -139,6 +139,7 @@ pub enum ServerDeploymentStatus {
     Starting,
     PodOk,
     Offline,
+    Unavailable(String),
 }
 
 pub fn sanitize_addr(addr: &str) -> &str {

src/opaque_error.rs

@@ -1,10 +1,16 @@
-use std::{error::Error, fmt};
+use std::{
+    error::Error,
+    fmt::{self, Debug},
+};
+use tracing::Level;
 use tracing_error::SpanTrace;
 
 #[derive(Debug)]
 pub struct OpaqueError {
     span_trace: SpanTrace,
     pub context: String,
+    pub level: Level,
+    kind: Option<String>,
 }
 
 impl fmt::Display for OpaqueError {
@@ -31,13 +37,23 @@ impl fmt::Display for OpaqueError {
 }
 impl Error for OpaqueError {}
 impl OpaqueError {
-    pub fn create(str: &str) -> OpaqueError {
+    pub fn create(context: &str) -> OpaqueError {
         Self {
             span_trace: SpanTrace::capture(),
-            context: str.to_string(),
+            context: context.to_string(),
+            level: Level::ERROR,
+            kind: None,
         }
     }
-    pub fn get_span_trace(&self) -> String {
+    pub fn create_with_kind(context: &str, kind: &str) -> OpaqueError {
+        Self {
+            span_trace: SpanTrace::capture(),
+            context: context.to_string(),
+            level: Level::ERROR,
+            kind: Some(kind.to_string()),
+        }
+    }
+    pub fn print_span_trace(&self) -> FancyTrace {
         let mut vec: Vec<(&str, String)> = Vec::new();
 
         self.span_trace.with_spans(|metadata, _fields| {
@@ -45,22 +61,40 @@ impl OpaqueError {
             true
         });
         let str = vec.iter().rfold(String::new(), |mut acc, x| {
-            let first = acc.len() != 0;
-            if first {
-                acc.push_str(":");
+            let first = acc.len() == 0;
+            if !first {
+                // TODO: should this code be hardcoded?
+                acc.push_str("\x1b[2m:\x1b[0m");
             }
 
             acc.push_str(x.0);
+            if !x.1.is_empty() {
                 acc.push_str("{");
                 acc.push_str(&x.1);
                 acc.push_str("}");
-
+            }
             acc
         });
-        match String::from_utf8(strip_ansi_escapes::strip(str.clone())) {
-            Ok(x) => x,
-            Err(_) => str,
+
+        FancyTrace { str }
     }
+    pub fn set_level(mut self, lvl: Level) -> Self {
+        self.level = lvl;
+        self
+    }
+    pub fn get_kind(&self) -> &str {
+        match self.kind.as_ref() {
+            Some(x) => &x,
+            None => &self.context,
+        }
+    }
+}
+pub struct FancyTrace {
+    str: String,
+}
+impl fmt::Display for FancyTrace {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(f, "\x1b[2m{{{{\x1b[0m {} \x1b[2m}}}}\x1b[0m", self.str)
     }
 }
 
@@ -69,6 +103,8 @@ impl From<String> for OpaqueError {
         Self {
             span_trace: SpanTrace::capture(),
             context: value,
+            level: Level::ERROR,
+            kind: None,
         }
     }
 }
@@ -78,6 +114,8 @@ impl From<&str> for OpaqueError {
         Self {
             span_trace: SpanTrace::capture(),
             context: value.to_string(),
+            level: Level::ERROR,
+            kind: None,
         }
     }
 }
@@ -87,6 +125,8 @@ impl From<crate::packets::ParseErrorTrace> for OpaqueError {
         Self {
             span_trace: value.context,
             context: format!("{:?}", value.inner),
+            level: Level::ERROR,
+            kind: None,
         }
     }
 }

src/packets/mod.rs

@@ -61,7 +61,7 @@ impl Packet {
     pub async fn parse(stream: &mut TcpStream) -> Result<Packet, ParseErrorTrace> {
         let length = VarInt::parse(stream)
             .await
-            .ok_or(ParseError::IDParseError)?;
+            .ok_or(ParseError::LengthParseError)?;
 
         tracing::trace!(length = length.get_int());
         let id = match VarInt::parse(stream).await {
@@ -150,6 +150,7 @@ impl From<ParseError> for ParseErrorTrace {
 }
 
 pub enum ParseError {
+    LengthParseError,
     IDParseError,
     WeirdID,
     LengthIsTooBig(i32),
@@ -162,7 +163,10 @@ pub enum ParseError {
 impl fmt::Debug for ParseError {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         match self {
-            Self::IDParseError => write!(f, "IDParseError: could not parse packet id"),
+            Self::LengthParseError => {
+                write!(f, "LengthParseError: could not parse packet length VarInt")
+            }
+            Self::IDParseError => write!(f, "IDParseError: could not parse packet id VarInt"),
             Self::WeirdID => write!(f, "WeirdID: weird packet id encountered: 122"),
             Self::LengthIsTooBig(x) => {
                 write!(f, "LengthIsTooBig: packet length is too big; len={x}")