Merge pull request #599 from Open-Source-Legal/JSv4/update-posthog-telemetry

Update Posthog to Use Singleton Approach

Author: JSv4

.github/workflows/claude-code-review.yml

@@ -54,4 +54,3 @@ jobs:
           # See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md
           # or https://docs.claude.com/en/docs/claude-code/cli-reference for available options
           claude_args: '--allowed-tools "Bash(gh issue view:*),Bash(gh search:*),Bash(gh issue list:*),Bash(gh pr comment:*),Bash(gh pr diff:*),Bash(gh pr view:*),Bash(gh pr list:*)"'
-

.github/workflows/claude.yml

@@ -47,4 +47,3 @@ jobs:
           # See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md
           # or https://docs.claude.com/en/docs/claude-code/cli-reference for available options
           # claude_args: '--allowed-tools Bash(gh pr:*)'
-

config/telemetry.py

@@ -3,8 +3,8 @@
 import logging
 from datetime import datetime, timezone
 
+import posthog
 from django.conf import settings
-from posthog import Posthog
 
 logger = logging.getLogger(__name__)
 
@@ -46,11 +46,8 @@ def record_event(event_type: str, properties: dict | None = None) -> bool:
         return False
 
     try:
-        client = Posthog(
-            project_api_key=settings.POSTHOG_API_KEY, host=settings.POSTHOG_HOST
-        )
-
-        client.capture(
+        # Use the globally configured posthog module (initialized in UsersConfig.ready())
+        posthog.capture(
             distinct_id=installation_id,
             event=f"opencontracts.{event_type}",
             properties={

opencontractserver/tests/test_telemetry.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from unittest.mock import MagicMock, patch
+from unittest.mock import patch
 
 from django.test import TestCase, override_settings
 
@@ -13,11 +13,9 @@ def setUp(self):
         self.mock_installation = Installation.get()
         self.installation_id = self.mock_installation.id
 
-        # Set up PostHog mock
-        self.posthog_patcher = patch("config.telemetry.Posthog")
-        self.mock_posthog_class = self.posthog_patcher.start()
-        self.mock_posthog = MagicMock()
-        self.mock_posthog_class.return_value = self.mock_posthog
+        # Set up PostHog mock - now patching the module-level capture function
+        self.posthog_patcher = patch("config.telemetry.posthog.capture")
+        self.mock_posthog_capture = self.posthog_patcher.start()
 
     def tearDown(self):
         self.posthog_patcher.stop()
@@ -34,10 +32,10 @@ def test_record_event_success(self):
             result = record_event("test_event", {"test_prop": "value"})
 
         self.assertTrue(result)
-        self.mock_posthog.capture.assert_called_once()
+        self.mock_posthog_capture.assert_called_once()
 
         # Verify the capture call arguments
-        call_args = self.mock_posthog.capture.call_args[1]
+        call_args = self.mock_posthog_capture.call_args[1]
         self.assertEqual(call_args["distinct_id"], str(self.installation_id))
         self.assertEqual(call_args["event"], "opencontracts.test_event")
         self.assertEqual(call_args["properties"]["package"], "opencontracts")
@@ -58,7 +56,7 @@ def test_record_event_telemetry_disabled(self):
             result = record_event("test_event")
 
         self.assertFalse(result)
-        self.mock_posthog.capture.assert_not_called()
+        self.mock_posthog_capture.assert_not_called()
 
     def test_record_event_installation_inactive(self):
         """Test when installation exists but is inactive"""
@@ -67,11 +65,11 @@ def test_record_event_installation_inactive(self):
             result = record_event("test_event")
 
         self.assertFalse(result)
-        self.mock_posthog.capture.assert_not_called()
+        self.mock_posthog_capture.assert_not_called()
 
     def test_record_event_posthog_error(self):
         """Test when PostHog client raises an error"""
-        self.mock_posthog.capture.side_effect = Exception("PostHog Error")
+        self.mock_posthog_capture.side_effect = Exception("PostHog Error")
 
         with override_settings(MODE="DEV", TELEMETRY_ENABLED=True):
             result = record_event("test_event")
@@ -85,10 +83,10 @@ def test_record_event_without_properties(self):
             result = record_event("test_event")
 
         self.assertTrue(result)
-        self.mock_posthog.capture.assert_called_once()
+        self.mock_posthog_capture.assert_called_once()
 
         # Verify only default properties are present
-        properties = self.mock_posthog.capture.call_args[1]["properties"]
+        properties = self.mock_posthog_capture.call_args[1]["properties"]
         self.assertEqual(
             set(properties.keys()), {"package", "timestamp", "installation_id"}
         )

opencontractserver/users/apps.py

@@ -7,6 +7,14 @@ class UsersConfig(AppConfig):
     verbose_name = _("Users")
 
     def ready(self):
+        import posthog
+        from django.conf import settings
+
+        # Initialize PostHog globally as per official Django integration
+        if settings.TELEMETRY_ENABLED:
+            posthog.api_key = settings.POSTHOG_API_KEY
+            posthog.host = settings.POSTHOG_HOST
+
         try:
             import opencontractserver.users.signals  # noqa F401
         except ImportError: