Merge branch 'add-telemetry' into 'enterprise'

feat(telemetry): Sending event when user logs in

See merge request dkinternal/testgen/dataops-testgen!180

Author: aarthy-dk

testgen/common/mixpanel_service.py

@@ -0,0 +1,77 @@
+import json
+import logging
+import ssl
+import uuid
+from base64 import b64encode
+from functools import cached_property, wraps
+from hashlib import blake2b
+from urllib.parse import urlencode
+from urllib.request import Request, urlopen
+
+from testgen import settings
+from testgen.ui.session import session
+from testgen.utils.singleton import Singleton
+
+LOG = logging.getLogger("testgen")
+
+
+def safe_method(method):
+    @wraps(method)
+    def wrapped(*args, **kwargs):
+        if settings.ANALYTICS_ENABLED:
+            try:
+                method(*args, **kwargs)
+            except Exception:
+                LOG.exception("Error processing analytics data")
+
+    return wrapped
+
+
+class MixpanelService(Singleton):
+
+    @cached_property
+    def instance_id(self):
+        return settings.INSTANCE_ID or blake2b(uuid.getnode().to_bytes(8), digest_size=8).hexdigest()
+
+    @cached_property
+    def distinct_id(self):
+        return self._hash_value(session.username)
+
+    def _hash_value(self, value: bytes | str, digest_size: int = 8) -> str:
+        if isinstance(value, str):
+            value = value.encode()
+        return blake2b(value, salt=self.instance_id.encode(), digest_size=digest_size).hexdigest()
+
+    @safe_method
+    def send_event(self, event_name, **properties):
+        properties.setdefault("instance_id", self.instance_id)
+        properties.setdefault("version", settings.VERSION)
+        properties.setdefault("distinct_id", self.distinct_id)
+
+        track_payload = {
+            "event": event_name,
+            "properties": {
+                "token": settings.MIXPANEL_TOKEN,
+                **properties,
+            }
+        }
+        self.send_mp_request("track?ip=1", track_payload)
+
+    def get_ssl_context(self):
+        ssl_context = ssl.create_default_context()
+        ssl_context.check_hostname = False
+        ssl_context.verify_mode = ssl.CERT_NONE
+        return ssl_context
+
+    def send_mp_request(self, endpoint, payload):
+        try:
+            post_data = urlencode(
+                {"data": b64encode(json.dumps(payload).encode()).decode()}
+            ).encode()
+
+            req = Request(f"{settings.MIXPANEL_URL}/{endpoint}", data=post_data, method="POST")  # noqa: S310
+            req.add_header("Content-Type", "application/x-www-form-urlencoded")
+
+            urlopen(req, context=self.get_ssl_context(), timeout=settings.MIXPANEL_TIMEOUT)  # noqa: S310
+        except Exception:
+            LOG.exception("Failed to send analytics data")

testgen/settings.py

@@ -466,3 +466,21 @@
 File paths for SSL certificate and private key to support HTTPS.
 Both files must be provided.
 """
+
+
+MIXPANEL_URL: str = "https://api.mixpanel.com"
+MIXPANEL_TIMEOUT: int = 3
+MIXPANEL_TOKEN: str = "973680ddf8c2b512e6f6d1f2959149eb"
+"""
+Mixpanel configuration
+"""
+
+INSTANCE_ID: str | None = os.getenv("TG_INSTANCE_ID", None)
+"""
+Random ID that uniquely identifies the instance.
+"""
+
+ANALYTICS_ENABLED: bool = os.getenv("TG_ANALYTICS", "yes").lower() in ("true", "yes")
+"""
+Disables sending usage data when set to any value except "true" and "yes". Defaults to "yes"
+"""

testgen/ui/views/login.py

@@ -4,6 +4,7 @@
 import streamlit as st
 import streamlit_authenticator as stauth
 
+from testgen.common.mixpanel_service import MixpanelService
 from testgen.ui.components import widgets as testgen
 from testgen.ui.navigation.page import Page
 from testgen.ui.services import javascript_service, user_session_service
@@ -60,3 +61,4 @@ def render(self, **_kwargs) -> None:
                     self.router.navigate(next_route)
                 else:
                     session.logging_in = True
+                    MixpanelService().send_event("login")