fix: added utm source & medium on playground url (#1994)

Cargo.toml

@@ -50,6 +50,7 @@ opentelemetry-otlp = { version = "0.15.0", features = [
 ], optional = true }
 opentelemetry-system-metrics = { version = "0.1.8", optional = true }
 tailcall-http-cache = {path = "tailcall-http-cache", optional = true }
+tailcall-version = { path = "./tailcall-version", optional = true }
 
 
 # dependencies safe for wasm:
@@ -197,6 +198,7 @@ cli = [
     "dep:opentelemetry-system-metrics",
     "dep:tailcall-tracker",
     "dep:tailcall-http-cache",
+    "dep:tailcall-version"
 ]
 
 # Feature flag to enable all default features.
@@ -219,6 +221,7 @@ members = [
     "tailcall-tracker",
     "tailcall-hasher",
     "tailcall-http-cache",
+    "tailcall-version",
 ]
 
 # Boost execution_spec snapshot diffing performance

src/cli/command.rs

@@ -1,12 +1,9 @@
 use clap::{Parser, Subcommand};
 use strum_macros::Display;
+use tailcall_version::VERSION;
 
 use crate::core::{config, generator};
 
-pub const VERSION: &str = match option_env!("APP_VERSION") {
-    Some(version) => version,
-    _ => "0.1.0-dev",
-};
 const ABOUT: &str = r"
    __        _ __           ____
   / /_____ _(_) /________ _/ / /
@@ -15,7 +12,7 @@ const ABOUT: &str = r"
 \__/\__,_/_/_/\___/\__,_/_/_/";
 
 #[derive(Parser)]
-#[command(name = "tailcall", author, version = VERSION, about, long_about = Some(ABOUT))]
+#[command(name = "tailcall", author, version = VERSION.as_str(), about, long_about = Some(ABOUT))]
 pub struct Cli {
     #[command(subcommand)]
     pub command: Command,

src/cli/server/mod.rs

@@ -1,12 +1,15 @@
 pub mod http_1;
 pub mod http_2;
 pub mod http_server;
+pub mod playground;
 pub mod server_config;
 
 pub use http_server::Server;
 
 use self::server_config::ServerConfig;
 
+const GRAPHQL_SLUG: &str = "/graphql";
+
 fn log_launch(sc: &ServerConfig) {
     let addr = sc.addr().to_string();
     tracing::info!(
@@ -15,7 +18,7 @@ fn log_launch(sc: &ServerConfig) {
         sc.http_version()
     );
 
-    let url = sc.graphiql_url();
-    let url = format!("https://tailcall.run/playground/?u={}/graphql", url);
+    let graphiql_url = sc.graphiql_url() + GRAPHQL_SLUG;
+    let url = playground::build_url(&graphiql_url);
     tracing::info!("🌍 Playground: {}", url);
 }

src/cli/server/playground.rs

@@ -0,0 +1,19 @@
+use tailcall_version::VERSION;
+
+const UTM_MEDIUM: &str = "server";
+const DEBUG_UTM_SOURCE: &str = "tailcall-debug";
+const RELEASE_UTM_SOURCE: &str = "tailcall-release";
+const BASE_PLAYGROUND_URL: &str = "https://tailcall.run/playground/";
+
+pub fn build_url(graphiql_url: &str) -> String {
+    let utm_source = if VERSION.is_dev() {
+        DEBUG_UTM_SOURCE
+    } else {
+        RELEASE_UTM_SOURCE
+    };
+
+    format!(
+        "{}?u={}&utm_source={}&utm_medium={}",
+        BASE_PLAYGROUND_URL, graphiql_url, utm_source, UTM_MEDIUM
+    )
+}

src/cli/update_checker.rs

@@ -1,9 +1,8 @@
 use colored::Colorize;
+use tailcall_version::VERSION;
 use update_informer::{registry, Check};
 use which::which;
 
-use crate::cli::command::VERSION;
-
 enum InstallationMethod {
     Npm,
     Npx,
@@ -37,14 +36,14 @@ fn get_installation_method() -> InstallationMethod {
 
 pub async fn check_for_update() {
     tokio::task::spawn_blocking(|| {
-        if VERSION.eq("0.1.0-dev") {
+        if VERSION.is_dev() {
             // skip validation if it's not a release
             return;
         }
 
         let name: &str = "tailcallhq/tailcall";
 
-        let informer = update_informer::new(registry::GitHub, name, VERSION);
+        let informer = update_informer::new(registry::GitHub, name, VERSION.as_str());
 
         if let Some(latest_version) = informer.check_version().ok().flatten() {
             let github_release_url =
@@ -54,7 +53,7 @@ pub async fn check_for_update() {
                 "{}",
                 format!(
                     "A new release of tailcall is available: {} {} {}",
-                    VERSION.cyan(),
+                    VERSION.as_str().cyan(),
                     "➜".white(),
                     latest_version.to_string().cyan()
                 )

tailcall-tracker/Cargo.toml

@@ -15,3 +15,4 @@ machineid-rs = "1.2.4"
 tokio = { workspace = true }
 tracing = { workspace = true }
 sysinfo = "0.30.12"
+tailcall-version = { path = "../tailcall-version" }

tailcall-tracker/src/check_tracking.rs

@@ -1,15 +1,13 @@
 use std::env;
 
+use tailcall_version::VERSION;
+
 const LONG_ENV_FILTER_VAR_NAME: &str = "TAILCALL_TRACKER";
 const SHORT_ENV_FILTER_VAR_NAME: &str = "TC_TRACKER";
-const VERSION: &str = match option_env!("APP_VERSION") {
-    Some(version) => version,
-    _ => "0.1.0-dev",
-};
 
 /// Checks if tracking is enabled
 pub fn check_tracking() -> bool {
-    let is_prod = !VERSION.contains("dev");
+    let is_prod = !VERSION.is_dev();
     let usage_enabled = env::var(LONG_ENV_FILTER_VAR_NAME)
         .or(env::var(SHORT_ENV_FILTER_VAR_NAME))
         .map(|v| !v.eq_ignore_ascii_case("false"))

tailcall-version/Cargo.toml

@@ -0,0 +1,6 @@
+[package]
+name = "tailcall-version"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]

tailcall-version/src/lib.rs

@@ -0,0 +1,42 @@
+const DEFAULT_VERSION: &str = "0.1.0-dev";
+
+pub struct Version {
+    version: &'static str,
+}
+
+impl Version {
+    pub const fn new(version: &'static str) -> Self {
+        Version { version }
+    }
+
+    pub const fn as_str(&self) -> &'static str {
+        self.version
+    }
+
+    pub fn is_dev(&self) -> bool {
+        self.version.contains("dev")
+    }
+}
+
+pub const VERSION: Version = match option_env!("APP_VERSION") {
+    Some(version) => Version::new(version),
+    None => Version::new(DEFAULT_VERSION),
+};
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_default_version() {
+        assert_eq!(VERSION.as_str(), DEFAULT_VERSION);
+        assert!(VERSION.is_dev());
+    }
+
+    #[test]
+    fn test_custom_version() {
+        const CUSTOM_VERSION: Version = Version::new("1.0.0-release");
+        assert_eq!(CUSTOM_VERSION.as_str(), "1.0.0-release");
+        assert!(!CUSTOM_VERSION.is_dev());
+    }
+}