chore: workspace events (#8439)

* chore: adding invite and joined events

* chore: adding workspace create and update events

apps/api/plane/bgtasks/event_tracking_task.py

@@ -1,5 +1,7 @@
+import logging
 import os
 import uuid
+from typing import Dict, Any
 
 # third party imports
 from celery import shared_task
@@ -8,6 +10,11 @@ from posthog import Posthog
 # module imports
 from plane.license.utils.instance_value import get_configuration_value
 from plane.utils.exception_logger import log_exception
+from plane.db.models import Workspace
+from plane.utils.analytics_events import USER_INVITED_TO_WORKSPACE, WORKSPACE_DELETED
+
+
+logger = logging.getLogger("plane.worker")
 
 
 def posthogConfiguration():
@@ -17,7 +24,10 @@ def posthogConfiguration():
                 "key": "POSTHOG_API_KEY",
                 "default": os.environ.get("POSTHOG_API_KEY", None),
             },
-            {"key": "POSTHOG_HOST", "default": os.environ.get("POSTHOG_HOST", None)},
+            {
+                "key": "POSTHOG_HOST",
+                "default": os.environ.get("POSTHOG_HOST", None),
+            },
         ]
     )
     if POSTHOG_API_KEY and POSTHOG_HOST:
@@ -26,46 +36,42 @@ def posthogConfiguration():
         return None, None
 
 
-@shared_task
-def auth_events(user, email, user_agent, ip, event_name, medium, first_time):
-    try:
-        POSTHOG_API_KEY, POSTHOG_HOST = posthogConfiguration()
+def preprocess_data_properties(
+    user_id: uuid.UUID, event_name: str, slug: str, data_properties: Dict[str, Any]
+) -> Dict[str, Any]:
+    if event_name == USER_INVITED_TO_WORKSPACE or event_name == WORKSPACE_DELETED:
+        try:
+            # Check if the current user is the workspace owner
+            workspace = Workspace.objects.get(slug=slug)
+            if str(workspace.owner_id) == str(user_id):
+                data_properties["role"] = "owner"
+            else:
+                data_properties["role"] = "admin"
+        except Workspace.DoesNotExist:
+            logger.warning(f"Workspace {slug} does not exist while sending event {event_name} for user {user_id}")
+            data_properties["role"] = "unknown"
 
-        if POSTHOG_API_KEY and POSTHOG_HOST:
-            posthog = Posthog(POSTHOG_API_KEY, host=POSTHOG_HOST)
-            posthog.capture(
-                email,
-                event=event_name,
-                properties={
-                    "event_id": uuid.uuid4().hex,
-                    "user": {"email": email, "id": str(user)},
-                    "device_ctx": {"ip": ip, "user_agent": user_agent},
-                    "medium": medium,
-                    "first_time": first_time,
-                },
-            )
-    except Exception as e:
-        log_exception(e)
-        return
+    return data_properties
 
 
 @shared_task
-def workspace_invite_event(user, email, user_agent, ip, event_name, accepted_from):
-    try:
-        POSTHOG_API_KEY, POSTHOG_HOST = posthogConfiguration()
+def track_event(user_id: uuid.UUID, event_name: str, slug: str, event_properties: Dict[str, Any]):
+    POSTHOG_API_KEY, POSTHOG_HOST = posthogConfiguration()
 
-        if POSTHOG_API_KEY and POSTHOG_HOST:
-            posthog = Posthog(POSTHOG_API_KEY, host=POSTHOG_HOST)
-            posthog.capture(
-                email,
-                event=event_name,
-                properties={
-                    "event_id": uuid.uuid4().hex,
-                    "user": {"email": email, "id": str(user)},
-                    "device_ctx": {"ip": ip, "user_agent": user_agent},
-                    "accepted_from": accepted_from,
-                },
-            )
+    if not (POSTHOG_API_KEY and POSTHOG_HOST):
+        logger.warning("Event tracking is not configured")
+        return
+
+    try:
+        # preprocess the data properties for massaging the payload
+        # in the correct format for posthog
+        data_properties = preprocess_data_properties(user_id, event_name, slug, event_properties)
+        groups = {
+            "workspace": slug,
+        }
+        # track the event using posthog
+        posthog = Posthog(POSTHOG_API_KEY, host=POSTHOG_HOST)
+        posthog.capture(distinct_id=str(user_id), event=event_name, properties=data_properties, groups=groups)
     except Exception as e:
         log_exception(e)
-        return
+        return False