Add TheRun.gg Integration (#903)

This ports the TheRun.gg integration from the original LiveSplit. All
the same features are supported.

Author: CryZe

Cargo.toml

@@ -90,6 +90,9 @@ livesplit-auto-splitting = { path = "crates/livesplit-auto-splitting", version =
 arc-swap = { version = "1.7.1", optional = true }
 log = { version = "0.4.14", default-features = false, optional = true }
 
+# therun.gg
+reqwest = { version = "0.13.2", default-features = false, features = ["json", "rustls"], optional = true }
+
 [target.'cfg(all(target_family = "wasm", target_os = "unknown"))'.dependencies]
 # WebAssembly in the Web
 js-sys = { version = "0.3.55", optional = true }
@@ -184,6 +187,7 @@ wasm-web = [
     "web-sys",
 ]
 auto-splitting = ["std", "livesplit-auto-splitting", "arc-swap", "log"]
+therun-gg = ["std", "reqwest", "time/formatting"]
 
 [lib]
 bench = false

capi/Cargo.toml

@@ -28,3 +28,4 @@ wasm-web = ["livesplit-core/wasm-web", "wasm-bindgen", "wasm-bindgen-futures", "
 auto-splitting = ["livesplit-core/auto-splitting"]
 assume-str-parameters-are-utf8 = []
 web-rendering = ["wasm-web", "livesplit-core/web-rendering"]
+therun-gg = ["wasm-web", "livesplit-core/therun-gg"]

capi/src/lib.rs

@@ -90,6 +90,8 @@ pub mod total_playtime_component;
 pub mod web_command_sink;
 #[cfg(all(target_family = "wasm", feature = "web-rendering"))]
 pub mod web_rendering;
+#[cfg(all(target_family = "wasm", feature = "therun-gg"))]
+pub mod web_therun_gg;
 
 use crate::{
     run_metadata_custom_variable::RunMetadataCustomVariable,

capi/src/web_therun_gg.rs

@@ -0,0 +1,56 @@
+//! Provides a therun.gg client for the web that communicates with therun.gg to
+//! provide live tracking and stats uploading for speedruns.
+
+use livesplit_core::{Timer, event::Event, networking::therun_gg};
+use wasm_bindgen::prelude::*;
+use wasm_bindgen_futures::spawn_local;
+
+/// A client for communicating with therun.gg. It handles live split tracking
+/// and stats uploading. The upload key is a 36-character key obtained from
+/// therun.gg.
+#[wasm_bindgen]
+pub struct TheRunClient {
+    inner: therun_gg::Client,
+}
+
+#[wasm_bindgen]
+impl TheRunClient {
+    /// Creates a new therun.gg client with the given upload key and settings.
+    #[wasm_bindgen(constructor)]
+    pub fn new(
+        upload_key: &str,
+        is_live_tracking_enabled: bool,
+        is_stats_uploading_enabled: bool,
+    ) -> Self {
+        Self {
+            inner: therun_gg::Client::new(
+                upload_key.to_owned(),
+                is_live_tracking_enabled,
+                is_stats_uploading_enabled,
+            ),
+        }
+    }
+
+    /// Sets whether live tracking is enabled. When enabled, live split data is
+    /// sent to therun.gg after every split action.
+    pub fn setLiveTrackingEnabled(&mut self, enabled: bool) {
+        self.inner.set_live_tracking_enabled(enabled);
+    }
+
+    /// Sets whether stats uploading is enabled. When enabled, the .lss file is
+    /// uploaded to therun.gg after every reset or finished run.
+    pub fn setStatsUploadingEnabled(&mut self, enabled: bool) {
+        self.inner.set_stats_uploading_enabled(enabled);
+    }
+
+    /// Handles a timer event. Pass the event code and a pointer to the timer.
+    /// The event codes correspond to the `Event` enum variants (e.g. 0 =
+    /// Started, 6 = Paused, 7 = Resumed, etc.).
+    pub unsafe fn handleEvent(&mut self, event: u32, timer: *const Timer) {
+        // SAFETY: The caller must ensure that the pointer is valid.
+        let snapshot = unsafe { &*timer }.snapshot();
+        if let Some(future) = self.inner.handle_event(Event::from(event), &snapshot) {
+            spawn_local(future);
+        }
+    }
+}

src/networking/mod.rs

@@ -5,3 +5,5 @@
 
 #[cfg(feature = "std")]
 pub mod server_protocol;
+#[cfg(feature = "therun-gg")]
+pub mod therun_gg;