From 9b51a0beb71275a1259e14dee021beb0078799da Mon Sep 17 00:00:00 2001
From: Shiroki <me@shirok1.dev>
Date: Thu, 1 Feb 2024 06:16:58 +0800
Subject: [PATCH] feat: parsing stdout of steamcmd require a i386 stdbuf (from
 coreutils) to change buffer strategy of steamcmd

---
 frontend/interfaces/gateway.interface.ts | 16 +++++
 frontend/pages/info.vue                  | 28 +++++++-
 gateway/Cargo.lock                       |  1 +
 gateway/Cargo.toml                       |  1 +
 gateway/Dockerfile                       | 11 +++
 gateway/src/steamcmd.rs                  | 88 ++++++++++++++++++++----
 6 files changed, 132 insertions(+), 13 deletions(-)

diff --git a/frontend/interfaces/gateway.interface.ts b/frontend/interfaces/gateway.interface.ts
index 5f5af64..5f9d44f 100644
--- a/frontend/interfaces/gateway.interface.ts
+++ b/frontend/interfaces/gateway.interface.ts
@@ -3,3 +3,19 @@ type Player = {
   playeruid: string;
   steamid: string; // this should be considered unique
 };
+
+type UpdateSteamMessage = {
+  type: "steam_self_update";
+  status: string;
+} | {
+  type: "update_state";
+  state_id: number;
+  state_name: string;
+  progress: string;
+  current: number;
+  total: number;
+} | {
+  type: "success"
+} | {
+  type: "error"; reason: string
+};
diff --git a/frontend/pages/info.vue b/frontend/pages/info.vue
index ed9647f..feb63ca 100644
--- a/frontend/pages/info.vue
+++ b/frontend/pages/info.vue
@@ -37,6 +37,7 @@ const updateDropdownItems = [
     }
   }]
 ]
+const updateLastMessage = ref<UpdateSteamMessage>()
 const update_steam = async (query: { game: false } | { game: true, validate: boolean }) => {
   logs.value = ""
   updateModal.value = true
@@ -54,6 +55,20 @@ const update_steam = async (query: { game: false } | { game: true, validate: boo
     if (data instanceof Blob) {
       const text = await data.text();
       logs.value += text;
+    } else if (typeof data === "string") {
+      const msg: UpdateSteamMessage = JSON.parse(data);
+      if (msg.type === "steam_self_update") {
+        console.log(`Steam self update: ${msg.status}`);
+      } else if (msg.type === "update_state") {
+        console.log(`Update state: ${msg.state_name} (${msg.progress}%)`);
+      } else if (msg.type === "success") {
+        console.log("Update success");
+      } else if (msg.type === "error") {
+        console.log("Update error");
+      } else {
+        console.log("Received unknown message:", msg);
+      }
+      updateLastMessage.value = msg
     } else {
       // Handle other data types
       console.log("Received non blob data:", data);
@@ -113,10 +128,21 @@ const shutdownModal = ref(false)
         <UModal v-model="updateModal" :ui="{ width: 'w-full sm:max-w-2xl' }" prevent-close>
           <UCard :ui="{ ring: '', divide: 'divide-y divide-gray-100 dark:divide-gray-800' }">
             <template #header>
-              Updating...
+              {{
+                updateLastMessage?.type === 'update_state' ? `Stage: ${updateLastMessage.state_name} (${updateLastMessage.progress}%)`
+                : updateLastMessage?.type === 'steam_self_update' ? 'Updating Steam...'
+                  : updateLastMessage?.type === 'success' ? 'Update success'
+                    : updateLastMessage?.type === 'error' ? 'Update error'
+                      : 'Updating...'
+              }}
             </template>
             <div class="flex flex-col gap-2">
               <UTextarea v-model="logs" disabled autoresize placeholder="Waiting..." />
+              <UProgress
+                :color="updateLastMessage?.type === 'error' ? 'red' : updateLastMessage?.type === 'success' ? 'green' : 'primary'"
+                :value="updateLastMessage?.type === 'update_state' ? (+updateLastMessage.progress)
+                  : updateLastMessage?.type === 'success' ? 100
+                    : updateLastMessage?.type === 'error' ? 100 : undefined" />
             </div>
             <template #footer>
               <div class="flex gap-2 justify-end">
diff --git a/gateway/Cargo.lock b/gateway/Cargo.lock
index 8bab37c..6e0ec1c 100644
--- a/gateway/Cargo.lock
+++ b/gateway/Cargo.lock
@@ -963,6 +963,7 @@ dependencies = [
  "futures-util",
  "pest",
  "pest_derive",
+ "regex",
  "rust-ini",
  "serde",
  "serde_json",
diff --git a/gateway/Cargo.toml b/gateway/Cargo.toml
index 640242e..30ee9f2 100644
--- a/gateway/Cargo.toml
+++ b/gateway/Cargo.toml
@@ -14,6 +14,7 @@ csv = "1.3.0"
 futures-util = { version = "0.3.30", features = ["sink"] }
 pest = "2.7.6"
 pest_derive = "2.7.6"
+regex = "1.10.3"
 rust-ini = "0.20.0"
 serde = { version = "1.0.195", features = ["derive"] }
 serde_json = "1.0.112"
diff --git a/gateway/Dockerfile b/gateway/Dockerfile
index 0fad18e..e17780e 100644
--- a/gateway/Dockerfile
+++ b/gateway/Dockerfile
@@ -21,6 +21,16 @@ cargo build --locked --release
 cp ./target/release/$APP_NAME /bin/gateway
 EOF
 
+# extract stdbuf
+
+# use same base image for convenience
+FROM cm2network/steamcmd:latest AS stdbuf
+
+USER root
+RUN dpkg --add-architecture i386 && \
+    apt update && \
+    apt install -y --allow-remove-essential coreutils:i386
+
 # runtime stage
 
 FROM cm2network/steamcmd:latest AS final
@@ -28,6 +38,7 @@ LABEL org.opencontainers.image.source=https://github.com/shirok1/palboard
 LABEL org.opencontainers.image.description="PalBoard gateway"
 LABEL org.opencontainers.image.licenses=SSPL-1.0
 
+COPY --from=stdbuf /usr/bin/stdbuf /usr/libexec/coreutils/libstdbuf.so /bin/
 COPY --from=build /bin/gateway /bin/
 
 EXPOSE 8080
diff --git a/gateway/src/steamcmd.rs b/gateway/src/steamcmd.rs
index 4e011cd..1bd31b5 100644
--- a/gateway/src/steamcmd.rs
+++ b/gateway/src/steamcmd.rs
@@ -1,4 +1,5 @@
 use axum::extract::ws::WebSocket;
+use serde::Serialize;
 use thiserror::Error;
 use tokio::{
     io::AsyncBufReadExt,
@@ -20,11 +21,7 @@ pub enum UpdateType {
     Steam,
     Game { validate: bool },
 }
-const STEAMCMD_UPDATE_ARGS: &[&str] = &[
-    "+login",
-    "anonymous",
-    "+quit",
-];
+const STEAMCMD_UPDATE_ARGS: &[&str] = &["+login", "anonymous", "+quit"];
 const STEAMCMD_UPDATE_GAME_ARGS: &[&str] = &[
     "+force_install_dir",
     "/home/steam/palserver",
@@ -57,7 +54,9 @@ type SteamCMDResult<T> = Result<T, SteamCMDError>;
 pub async fn run_steamcmd(
     args: impl IntoIterator<Item = impl AsRef<OsStr>>,
 ) -> SteamCMDResult<(Child, ReaderStream<ChildStdout>)> {
-    let mut child = Command::new(STEAMCMD_EXE)
+    let mut child = Command::new("/bin/stdbuf")
+        .arg("--output=0")
+        .arg(STEAMCMD_EXE)
         .args(args)
         .stdout(Stdio::piped())
         .spawn()
@@ -70,6 +69,66 @@ pub async fn run_steamcmd(
     Ok((child, stdout))
 }
 
+#[derive(Debug, Serialize)]
+#[serde(tag = "type", rename_all = "snake_case")]
+enum UpdateSteamMessage {
+    SteamSelfUpdate {
+        status: String,
+    },
+    UpdateState {
+        state_id: u32,
+        state_name: String,
+        progress: String,
+        current: u64,
+        total: u64,
+    },
+    Success,
+    Error {
+        reason: String,
+    },
+}
+
+fn parse_line(line: &str) -> Option<UpdateSteamMessage> {
+    // TODO: reusing regexes
+    let update_state_pattern = regex::Regex::new(r"^ Update state \(0x(?<state_id>[\da-f]+)\) (?<state_name>[\w ]+), progress: (?<progress>\d*\.\d*) \((?<current>\d+) \/ (?<total>\d+)\)$").unwrap();
+    let steam_self_update_pattern = regex::Regex::new(r"^\[....\] (.+)$").unwrap();
+    let error_pattern = regex::Regex::new(r"^ERROR!.+\((.+)\)$").unwrap();
+
+    if line.starts_with("Success!") {
+        return Some(UpdateSteamMessage::Success);
+    }
+
+    if let Some(cap) = steam_self_update_pattern.captures(&line) {
+        let (_, [status]) = cap.extract();
+        let status = status.to_string();
+        return Some(UpdateSteamMessage::SteamSelfUpdate { status });
+    }
+
+    if let Some(cap) = error_pattern.captures(&line) {
+        let (_, [reason]) = cap.extract();
+        let reason = reason.to_string();
+        return Some(UpdateSteamMessage::Error { reason });
+    }
+
+    if let Some(cap) = update_state_pattern.captures(&line) {
+        let (_, [state_id, state_name, progress, current, total]) = cap.extract();
+        let state_id = u32::from_str_radix(state_id, 16).unwrap();
+        let current = u64::from_str_radix(current, 10).unwrap();
+        let total = u64::from_str_radix(total, 10).unwrap();
+        let state_name = state_name.to_string();
+        let progress = progress.to_string();
+        return Some(UpdateSteamMessage::UpdateState {
+            state_id,
+            state_name,
+            progress,
+            current,
+            total,
+        });
+    }
+
+    None
+}
+
 #[instrument(skip_all)]
 pub async fn update_steam(ws: WebSocket, update_type: UpdateType) {
     let (mut child, mut stdout) = run_steamcmd(match update_type {
@@ -92,12 +151,17 @@ pub async fn update_steam(ws: WebSocket, update_type: UpdateType) {
         async move {
             while let Some(line) = lines.next_line().await.unwrap() {
                 debug!("parsing line: {}", line);
-                ws_lr
-                    .lock()
-                    .await
-                    .send(axum::extract::ws::Message::Text(line))
-                    .await
-                    .unwrap();
+
+                if let Some(msg) = parse_line(&line) {
+                    ws_lr
+                        .lock()
+                        .await
+                        .send(axum::extract::ws::Message::Text(
+                            serde_json::to_string(&msg).unwrap(),
+                        ))
+                        .await
+                        .unwrap();
+                }
             }
             debug!("exit");
         }