Skip to content

armgit / meet

Public Imported from GitHub
0

Open source video conferencing app powered by LiveKit. Built with Django and React.

🔥(backend) vendor analytics code

lebaudantoine15e922f9df4b
diff --git a/src/backend/core/analytics.py b/src/backend/core/analytics.py
deleted file mode 100644
index 24fb1c4c..00000000
--- a/src/backend/core/analytics.py
+++ /dev/null
@@ -1,58 +0,0 @@
-"""
-Meet analytics class.
-"""
-
-import uuid
-
-from django.conf import settings
-
-from june import analytics as jAnalytics
-
-
-class Analytics:
- """Analytics integration
-
- This class wraps the June analytics code to avoid coupling our code directly
- with this third-party library. By doing so, we create a generic interface
- for analytics that can be easily modified or replaced in the future.
- """
-
- def __init__(self):
- key = getattr(settings, "ANALYTICS_KEY", None)
-
- if key is not None:
- jAnalytics.write_key = key
-
- self._enabled = key is not None
-
- def _is_anonymous_user(self, user):
- """Check if the user is anonymous."""
- return user is None or user.is_anonymous
-
- def identify(self, user, **kwargs):
- """Identify a user"""
-
- if self._is_anonymous_user(user) or not self._enabled:
- return
-
- traits = kwargs.pop("traits", {})
- traits.update({"email": user.email_anonymized})
-
- jAnalytics.identify(user_id=user.sub, traits=traits, **kwargs)
-
- def track(self, user, **kwargs):
- """Track an event"""
-
- if not self._enabled:
- return
-
- event_data = {}
- if self._is_anonymous_user(user):
- event_data["anonymous_id"] = str(uuid.uuid4())
- else:
- event_data["user_id"] = user.sub
-
- jAnalytics.track(**event_data, **kwargs)
-
-
-analytics = Analytics()
diff --git a/src/backend/core/api/viewsets.py b/src/backend/core/api/viewsets.py
index 0d7d22c6..af1cd818 100644
--- a/src/backend/core/api/viewsets.py
+++ b/src/backend/core/api/viewsets.py
@@ -20,7 +20,6 @@ from rest_framework import (
from core import models, utils
-from ..analytics import analytics
from . import permissions, serializers
# pylint: disable=too-many-ancestors
@@ -203,11 +202,6 @@ class RoomViewSet(
}
else:
data = self.get_serializer(instance).data
- analytics.track(
- user=self.request.user,
- event="Get Room",
- properties={"slug": instance.slug},
- )
return drf_response.Response(data)
@@ -239,14 +233,6 @@ class RoomViewSet(
role=models.RoleChoices.OWNER,
)
- analytics.track(
- user=self.request.user,
- event="Create Room",
- properties={
- "slug": room.slug,
- },
- )
-
class ResourceAccessListModelMixin:
"""List mixin for resource access API."""
diff --git a/src/backend/core/authentication/backends.py b/src/backend/core/authentication/backends.py
index 3bb6fb04..a4576916 100644
--- a/src/backend/core/authentication/backends.py
+++ b/src/backend/core/authentication/backends.py
@@ -10,8 +10,6 @@ from mozilla_django_oidc.auth import (
from core.models import User
-from ..analytics import analytics
-
class OIDCAuthenticationBackend(MozillaOIDCAuthenticationBackend):
"""Custom OpenID Connect (OIDC) Authentication Backend.
@@ -81,7 +79,6 @@ class OIDCAuthenticationBackend(MozillaOIDCAuthenticationBackend):
else:
user = None
- analytics.identify(user=user)
return user
def create_user(self, claims):
diff --git a/src/backend/core/authentication/views.py b/src/backend/core/authentication/views.py
index f602cfcb..709f2097 100644
--- a/src/backend/core/authentication/views.py
+++ b/src/backend/core/authentication/views.py
@@ -22,8 +22,6 @@ from mozilla_django_oidc.views import (
OIDCLogoutView as MozillaOIDCOIDCLogoutView,
)
-from ..analytics import analytics
-
class OIDCLogoutView(MozillaOIDCOIDCLogoutView):
"""Custom logout view for handling OpenID Connect (OIDC) logout flow.
@@ -100,10 +98,6 @@ class OIDCLogoutView(MozillaOIDCOIDCLogoutView):
logout_url = self.redirect_url
- analytics.track(
- user=request.user,
- event="Signed Out",
- )
if request.user.is_authenticated:
logout_url = self.construct_oidc_logout_url(request)
diff --git a/src/backend/core/tests/test_analytics.py b/src/backend/core/tests/test_analytics.py
deleted file mode 100644
index fd91fa33..00000000
--- a/src/backend/core/tests/test_analytics.py
+++ /dev/null
@@ -1,132 +0,0 @@
-"""
-Test for the Analytics class.
-"""
-
-# pylint: disable=W0212
-
-from unittest.mock import patch
-
-from django.contrib.auth.models import AnonymousUser
-from django.test.utils import override_settings
-
-import pytest
-
-from core.analytics import Analytics
-from core.factories import UserFactory
-
-pytestmark = pytest.mark.django_db
-
-
[email protected](name="mock_june_analytics")
-def _mock_june_analytics():
- with patch("core.analytics.jAnalytics") as mock:
- yield mock
-
-
-@override_settings(ANALYTICS_KEY="test_key")
-def test_analytics_init_enabled(mock_june_analytics):
- """Should enable analytics and set the write key correctly when ANALYTICS_KEY is set."""
- analytics = Analytics()
- assert analytics._enabled is True
- assert mock_june_analytics.write_key == "test_key"
-
-
-@override_settings(ANALYTICS_KEY=None)
-def test_analytics_init_disabled():
- """Should disable analytics when ANALYTICS_KEY is not set."""
- analytics = Analytics()
- assert analytics._enabled is False
-
-
-@override_settings(ANALYTICS_KEY="test_key")
-def test_analytics_identify_user(mock_june_analytics):
- """Should identify a user with the correct traits when analytics is enabled."""
- user = UserFactory(sub="12345", email="[email protected]")
- analytics = Analytics()
- analytics.identify(user)
- mock_june_analytics.identify.assert_called_once_with(
- user_id="12345", traits={"email": "***@example.com"}
- )
-
-
-@override_settings(ANALYTICS_KEY="test_key")
-def test_analytics_identify_user_with_traits(mock_june_analytics):
- """Should identify a user with additional traits when analytics is enabled."""
- user = UserFactory(sub="12345", email="[email protected]")
- analytics = Analytics()
- analytics.identify(user, traits={"email": "[email protected]", "foo": "foo"})
- mock_june_analytics.identify.assert_called_once_with(
- user_id="12345", traits={"email": "***@example.com", "foo": "foo"}
- )
-
-
-@override_settings(ANALYTICS_KEY=None)
-def test_analytics_identify_not_enabled(mock_june_analytics):
- """Should not call identify when analytics is not enabled."""
- user = UserFactory(sub="12345", email="[email protected]")
- analytics = Analytics()
- analytics.identify(user)
- mock_june_analytics.identify.assert_not_called()
-
-
-@override_settings(ANALYTICS_KEY="test_key")
-def test_analytics_identify_no_user(mock_june_analytics):
- """Should not call identify when the user is None."""
- analytics = Analytics()
- analytics.identify(None)
- mock_june_analytics.identify.assert_not_called()
-
-
-@override_settings(ANALYTICS_KEY="test_key")
-def test_analytics_identify_anonymous_user(mock_june_analytics):
- """Should not call identify when the user is anonymous."""
- user = AnonymousUser()
- analytics = Analytics()
- analytics.identify(user)
- mock_june_analytics.identify.assert_not_called()
-
-
-@override_settings(ANALYTICS_KEY="test_key")
-def test_analytics_track_event(mock_june_analytics):
- """Should track an event with the correct user and event details when analytics is enabled."""
- user = UserFactory(sub="12345")
- analytics = Analytics()
- analytics.track(user, event="test_event", foo="foo")
- mock_june_analytics.track.assert_called_once_with(
- user_id="12345", event="test_event", foo="foo"
- )
-
-
-@override_settings(ANALYTICS_KEY=None)
-def test_analytics_track_event_not_enabled(mock_june_analytics):
- """Should not call track when analytics is not enabled."""
- user = UserFactory(sub="12345")
- analytics = Analytics()
- analytics.track(user, event="test_event", foo="foo")
-
- mock_june_analytics.track.assert_not_called()
-
-
-@override_settings(ANALYTICS_KEY="test_key")
-@patch("uuid.uuid4", return_value="test_uuid4")
-def test_analytics_track_event_no_user(mock_uuid4, mock_june_analytics):
- """Should track an event with a random anonymous user ID when the user is None."""
- analytics = Analytics()
- analytics.track(None, event="test_event", foo="foo")
- mock_june_analytics.track.assert_called_once_with(
- anonymous_id="test_uuid4", event="test_event", foo="foo"
- )
- mock_uuid4.assert_called_once()
-
-
-@override_settings(ANALYTICS_KEY="test_key")
-@patch("uuid.uuid4", return_value="test_uuid4")
-def test_analytics_track_event_anonymous_user(mock_uuid4, mock_june_analytics):
- """Should track an event with a random anonymous user ID when the user is anonymous."""
- user = AnonymousUser()
- analytics = Analytics()
- analytics.track(user, event="test_event", foo="foo")
- mock_june_analytics.track.assert_called_once_with(
- anonymous_id="test_uuid4", event="test_event", foo="foo"
- )
- mock_uuid4.assert_called_once()
diff --git a/src/backend/meet/settings.py b/src/backend/meet/settings.py
index bf2deaa5..3f63faa9 100755
--- a/src/backend/meet/settings.py
+++ b/src/backend/meet/settings.py
@@ -505,8 +505,6 @@ class Test(Base):
CELERY_TASK_ALWAYS_EAGER = values.BooleanValue(True)
- ANALYTICS_KEY = None
-
def __init__(self):
# pylint: disable=invalid-name
self.INSTALLED_APPS += ["drf_spectacular_sidecar"]
diff --git a/src/helm/env.d/dev/values.meet.yaml.gotmpl b/src/helm/env.d/dev/values.meet.yaml.gotmpl
index 93e043ae..6ba17f7d 100644
--- a/src/helm/env.d/dev/values.meet.yaml.gotmpl
+++ b/src/helm/env.d/dev/values.meet.yaml.gotmpl
@@ -47,7 +47,6 @@ backend:
{{- end }}
{{- end }}
LIVEKIT_API_URL: https://livekit.127.0.0.1.nip.io/
- ANALYTICS_KEY: xwhoIMCZ8PBRjQ2t
ALLOW_UNREGISTERED_ROOMS: False
FRONTEND_SILENCE_LIVEKIT_DEBUG: False
FRONTEND_SUPPORT: "{'id': '58ea6697-8eba-4492-bc59-ad6562585041'}"
diff --git a/src/helm/env.d/production/values.meet.yaml.gotmpl b/src/helm/env.d/production/values.meet.yaml.gotmpl
index 7e67ea2d..0747ead8 100644
--- a/src/helm/env.d/production/values.meet.yaml.gotmpl
+++ b/src/helm/env.d/production/values.meet.yaml.gotmpl
@@ -94,7 +94,6 @@ backend:
name: backend
key: LIVEKIT_API_KEY
LIVEKIT_API_URL: https://livekit-preprod.beta.numerique.gouv.fr
- ANALYTICS_KEY: mwuxTKi8o2xzWH54
ALLOW_UNREGISTERED_ROOMS: False
FRONTEND_SILENCE_LIVEKIT_DEBUG: False
FRONTEND_ANALYTICS: "{'id': 'phc_RPYko028Oqtj0c9exLIWwrlrjLxSdxT0ntW0Lam4iom', 'host': 'https://product.visio.numerique.gouv.fr'}"
diff --git a/src/helm/env.d/staging/values.meet.yaml.gotmpl b/src/helm/env.d/staging/values.meet.yaml.gotmpl
index 675ac35c..34af9a60 100644
--- a/src/helm/env.d/staging/values.meet.yaml.gotmpl
+++ b/src/helm/env.d/staging/values.meet.yaml.gotmpl
@@ -93,7 +93,6 @@ backend:
name: backend
key: LIVEKIT_API_KEY
LIVEKIT_API_URL: https://livekit-staging.beta.numerique.gouv.fr
- ANALYTICS_KEY: Roi1k6IAc2DEqHB0
ALLOW_UNREGISTERED_ROOMS: False
FRONTEND_ANALYTICS: "{'id': 'phc_RPYko028Oqtj0c9exLIWwrlrjLxSdxT0ntW0Lam4iom', 'host': 'https://product.visio-staging.beta.numerique.gouv.fr'}"
FRONTEND_SUPPORT: "{'id': '58ea6697-8eba-4492-bc59-ad6562585041'}"