From 4db826dc72800f5b679c4b51cc8c0ae195a440d0 Mon Sep 17 00:00:00 2001
From: Nikhil Sinha <nikhil.sinha@cloudsurfex.com>
Date: Mon, 5 Aug 2024 14:25:07 +0530
Subject: [PATCH] feat: allow user actions' tracking in MS Clarity

add env var P_MS_CLARITY_TAG with MS Clarity Tag
The value will be available in the about API response if added

About API Response json structure -

`
{
    "version": "v1.3.0",
    "uiVersion": "development",
    "commit": "e581c10",
    "deploymentId": "01J4722F68X8XQVYT55TRG6R29",
    "updateAvailable": false,
    "latestVersion": "v1.3.0",
    "llmActive": false,
    "llmProvider": null,
    "oidcActive": false,
    "license": "AGPL-3.0-only",
    "mode": "Standalone",
    "staging": "/Users/nikhilsinha/Parseable/parseable/staging",
    "cache": "Disabled",
    "grpcPort": 8001,
    "store": {
        "type": "Local drive",
        "path": "/Users/nikhilsinha/Parseable/parseable/data"
    },
    "analytics": {
        "clarityTag": "testtag"
    }
}
`
---
 server/src/cli.rs                 | 13 +++++++++++++
 server/src/handlers/http/about.rs |  7 +++++--
 2 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/server/src/cli.rs b/server/src/cli.rs
index 857c165d3..6f4160738 100644
--- a/server/src/cli.rs
+++ b/server/src/cli.rs
@@ -107,6 +107,8 @@ pub struct Cli {
 
     ///maximum disk usage allowed
     pub max_disk_usage: f64,
+
+    pub ms_clarity_tag: Option<String>,
 }
 
 impl Cli {
@@ -142,6 +144,7 @@ impl Cli {
     pub const CORS: &'static str = "cors";
     pub const HOT_TIER_PATH: &'static str = "hot-tier-path";
     pub const MAX_DISK_USAGE: &'static str = "max-disk-usage";
+    pub const MS_CLARITY_TAG: &'static str = "ms-clarity-tag";
 
     pub fn local_stream_data_path(&self, stream_name: &str) -> PathBuf {
         self.local_staging_path.join(stream_name)
@@ -423,6 +426,14 @@ impl Cli {
                     .help("Maximum allowed disk usage in percentage e.g 90.0 for 90%")
                     .next_line_help(true),
             )
+            .arg(
+                Arg::new(Self::MS_CLARITY_TAG)
+                    .long(Self::MS_CLARITY_TAG)
+                    .env("P_MS_CLARITY_TAG")
+                    .value_name("STRING")
+                    .required(false)
+                    .help("Tag for MS Clarity"),
+            )
             .group(
                 ArgGroup::new("oidc")
                     .args([Self::OPENID_CLIENT_ID, Self::OPENID_CLIENT_SECRET, Self::OPENID_ISSUER])
@@ -566,6 +577,8 @@ impl FromArgMatches for Cli {
             .cloned()
             .expect("default for max disk usage");
 
+        self.ms_clarity_tag = m.get_one::<String>(Self::MS_CLARITY_TAG).cloned();
+
         Ok(())
     }
 }
diff --git a/server/src/handlers/http/about.rs b/server/src/handlers/http/about.rs
index 0cacbb7e4..4acd01ad2 100644
--- a/server/src/handlers/http/about.rs
+++ b/server/src/handlers/http/about.rs
@@ -94,7 +94,7 @@ pub async fn about() -> Json<serde_json::Value> {
         )
     };
 
-    let send_analytics = CONFIG.parseable.send_analytics;
+    let ms_clarity_tag = &CONFIG.parseable.ms_clarity_tag;
 
     Json(json!({
         "version": current_version,
@@ -115,6 +115,9 @@ pub async fn about() -> Json<serde_json::Value> {
             "type": CONFIG.get_storage_mode_string(),
             "path": store_endpoint
         },
-        "sendAnalytics": send_analytics
+        "analytics": {
+            "clarityTag": ms_clarity_tag
+        }
+
     }))
 }