Analytics: add event for when we serve the web-viewer .wasm (#1379)

emilk · emilk · commit e55d84c3b479 · 2023-03-02T09:12:43.000+01:00
* Serve a `serve_wasm` analytics event when serving a .wasm file

* silence warning on CI
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/re_sdk/Cargo.toml b/crates/re_sdk/Cargo.toml
@@ -19,6 +19,9 @@ all-features = true
 [features]
 default = ["demo", "glam", "image", "re_viewer"]
 
+## Enable telemetry using our analytics SDK.
+analytics = ["re_web_server?/analytics", "re_viewer?/analytics"]
+
 ## Enable the `demo` module (helpers for Rerun examples).
 demo = []
 
diff --git a/crates/re_web_server/Cargo.toml b/crates/re_web_server/Cargo.toml
@@ -31,6 +31,9 @@ all-features = true
 ## will crash if you rey to run it!
 __ci = []
 
+## Enable telemetry using our analytics SDK.
+analytics = ["dep:re_analytics"]
+
 
 [dependencies]
 re_log.workspace = true
@@ -44,6 +47,10 @@ tokio = { workspace = true, default-features = false, features = [
   "rt-multi-thread",
 ] }
 
+# Optional dependencies:
+re_analytics = { workspace = true, optional = true }
+
+
 [build-dependencies]
 glob = "0.3.0"
 cargo_metadata = "0.15"
diff --git a/crates/re_web_server/src/lib.rs b/crates/re_web_server/src/lib.rs
@@ -11,11 +11,40 @@
 use std::task::{Context, Poll};
 
 use futures_util::future;
-use hyper::{server::conn::AddrIncoming, service::Service};
-use hyper::{Body, Request, Response};
+use hyper::{server::conn::AddrIncoming, service::Service, Body, Request, Response};
 
-#[derive(Debug)]
-struct Svc;
+struct Svc {
+    // NOTE: Optional because it is possible to have the `analytics` feature flag enabled
+    // while at the same time opting-out of analytics at run-time.
+    #[cfg(feature = "analytics")]
+    analytics: Option<re_analytics::Analytics>,
+}
+
+impl Svc {
+    #[cfg(feature = "analytics")]
+    fn new() -> Self {
+        let analytics = match re_analytics::Analytics::new(std::time::Duration::from_secs(2)) {
+            Ok(analytics) => Some(analytics),
+            Err(err) => {
+                re_log::error!(%err, "failed to initialize analytics SDK");
+                None
+            }
+        };
+        Self { analytics }
+    }
+
+    #[cfg(not(feature = "analytics"))]
+    fn new() -> Self {
+        Self {}
+    }
+
+    #[cfg(feature = "analytics")]
+    fn on_serve_wasm(&self) {
+        if let Some(analytics) = &self.analytics {
+            analytics.record(re_analytics::Event::append("serve_wasm".into()));
+        }
+    }
+}
 
 impl Service<Request<Body>> for Svc {
     type Response = Response<Body>;
@@ -28,6 +57,10 @@ impl Service<Request<Body>> for Svc {
 
     #[cfg(feature = "__ci")]
     fn call(&mut self, _req: Request<Body>) -> Self::Future {
+        if false {
+            self.on_serve_wasm(); // to silence warning about the function being unused
+        }
+
         panic!("web_server compiled with '__ci' feature (or `--all-features`). DON'T DO THAT! It's only for the CI!");
     }
 
@@ -39,8 +72,12 @@ impl Service<Request<Body>> for Svc {
             "/" | "/index.html" => &include_bytes!("../web_viewer/index.html")[..],
             "/favicon.ico" => &include_bytes!("../web_viewer/favicon.ico")[..],
             "/sw.js" => &include_bytes!("../web_viewer/sw.js")[..],
-            "/re_viewer_bg.wasm" => &include_bytes!("../web_viewer/re_viewer_bg.wasm")[..],
             "/re_viewer.js" => &include_bytes!("../web_viewer/re_viewer.js")[..],
+            "/re_viewer_bg.wasm" => {
+                #[cfg(feature = "analytics")]
+                self.on_serve_wasm();
+                &include_bytes!("../web_viewer/re_viewer_bg.wasm")[..]
+            }
             _ => {
                 re_log::warn!("404 path: {}", req.uri().path());
                 let body = Body::from(Vec::new());
@@ -67,7 +104,7 @@ impl<T> Service<T> for MakeSvc {
     }
 
     fn call(&mut self, _: T) -> Self::Future {
-        future::ok(Svc)
+        future::ok(Svc::new())
     }
 }
 
diff --git a/crates/rerun/Cargo.toml b/crates/rerun/Cargo.toml
@@ -22,7 +22,7 @@ targets = ["x86_64-unknown-linux-gnu", "wasm32-unknown-unknown"]
 default = ["analytics", "glam", "image", "server", "sdk"]
 
 ## Enable telemetry using our analytics SDK.
-analytics = ["dep:re_analytics", "re_viewer/analytics"]
+analytics = ["dep:re_analytics", "re_viewer/analytics", "re_sdk?/analytics"]
 
 ## Add support for some math operations using [`glam`](https://crates.io/crates/glam/).
 ## Only relevant if feature `sdk` is enabled.
