From ca734e43342fdad2374f1fadd0e416a1641bbf25 Mon Sep 17 00:00:00 2001
From: Huong Nguyen <32060364+Huongg@users.noreply.github.com>
Date: Tue, 19 Nov 2024 14:10:49 +0000
Subject: [PATCH] telemetry/add kedro_Viz_version to heaps (#2194)

* add kedro_Viz_version to heaps

Signed-off-by: Huong Nguyen <huongg1409@gmail>

* update release note

Signed-off-by: Huong Nguyen <huongg1409@gmail>

* shortern the syntax

Signed-off-by: Huong Nguyen <huongg1409@gmail>

* update release note and lint error

Signed-off-by: Huong Nguyen <huongg1409@gmail>

* Fix lint error

Signed-off-by: Huong Nguyen <huongg1409@gmail>

* set version in base.py

Signed-off-by: Huong Nguyen <huongg1409@gmail>

* revert back to the old syntax

Signed-off-by: Huong Nguyen <huongg1409@gmail>

---------

Signed-off-by: Huong Nguyen <huongg1409@gmail>
Co-authored-by: Huong Nguyen <huongg1409@gmail>
---
 RELEASE.md                                                 | 1 +
 package/kedro_viz/api/apps.py                              | 4 +++-
 package/kedro_viz/integrations/deployment/base_deployer.py | 4 +++-
 public/telemetry.html                                      | 3 +++
 4 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/RELEASE.md b/RELEASE.md
index 61cb49bf9b..8d913321f7 100644
--- a/RELEASE.md
+++ b/RELEASE.md
@@ -24,6 +24,7 @@ Please follow the established format:
 - Refactor `DatasetStatsHook` to avoid showing error when dataset doesn't have file size info (#2174)
 - Fix 404 error when accessing the experiment tracking page on the demo site (#2179)
 - Add check for port availability before starting Kedro Viz to prevent unintended browser redirects when the port is already in use (#2176)
+- Include Kedro Viz version in telemetry.. (#2194)
 
 
 # Release 10.0.0
diff --git a/package/kedro_viz/api/apps.py b/package/kedro_viz/api/apps.py
index e188ab1911..8c2b6b298c 100644
--- a/package/kedro_viz/api/apps.py
+++ b/package/kedro_viz/api/apps.py
@@ -92,7 +92,9 @@ async def index():
         env = Environment(loader=FileSystemLoader(_HTML_DIR))
         if should_add_telemetry:
             telemetry_content = env.get_template("telemetry.html").render(
-                heap_app_id=heap_app_id, heap_user_identity=heap_user_identity
+                heap_app_id=heap_app_id,
+                heap_user_identity=heap_user_identity,
+                kedro_viz_version=__version__,
             )
             injected_head_content.append(telemetry_content)
 
diff --git a/package/kedro_viz/integrations/deployment/base_deployer.py b/package/kedro_viz/integrations/deployment/base_deployer.py
index d0f0b2a7bf..31c0adea54 100644
--- a/package/kedro_viz/integrations/deployment/base_deployer.py
+++ b/package/kedro_viz/integrations/deployment/base_deployer.py
@@ -51,7 +51,9 @@ def _ingest_heap_analytics(self):
         if should_add_telemetry:
             logger.debug("Ingesting heap analytics.")
             telemetry_content = env.get_template("telemetry.html").render(
-                heap_app_id=heap_app_id, heap_user_identity=heap_user_identity
+                heap_app_id=heap_app_id,
+                heap_user_identity=heap_user_identity,
+                kedro_viz_version=__version__,
             )
             injected_head_content.append(telemetry_content)
 
diff --git a/public/telemetry.html b/public/telemetry.html
index 9e392a72dc..a684a20dde 100644
--- a/public/telemetry.html
+++ b/public/telemetry.html
@@ -2,5 +2,8 @@
   window.heap=window.heap||[],heap.load=function(e,t){window.heap.appid=e,window.heap.config=t=t||{};var r=document.createElement("script");r.type="text/javascript",r.async=!0,r.src="https://cdn.heapanalytics.com/js/heap-"+e+".js";var a=document.getElementsByTagName("script")[0];a.parentNode.insertBefore(r,a);for(var n=function(e){return function(){heap.push([e].concat(Array.prototype.slice.call(arguments,0)))}},p=["addEventProperties","addUserProperties","clearEventProperties","identify","resetIdentity","removeEventProperty","setEventProperties","track","unsetEventProperty"],o=0;o<p.length;o++)heap[p[o]]=n(p[o])};
   heap.load("{{ heap_app_id }}"); 
   heap.identify("{{ heap_user_identity }}");
+  heap.addEventProperties({
+    kedro_viz_version: "{{ kedro_viz_version }}",
+  });
 </script>
 </head>