feat: 🎸 posthog (#1978)

user settings to premium

# Description

Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.

## Checklist before requesting a review

Please delete options that are not relevant.

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged

## Screenshots (if appropriate):

backend/models/settings.py

@@ -1,7 +1,10 @@
+from uuid import UUID
+
 from langchain.embeddings.ollama import OllamaEmbeddings
 from langchain.embeddings.openai import OpenAIEmbeddings
 from logger import get_logger
 from models.databases.supabase.supabase import SupabaseDB
+from posthog import Posthog
 from pydantic import BaseSettings
 from supabase.client import Client, create_client
 from vectorstore.supabase import SupabaseVectorStore
@@ -13,6 +16,91 @@ class BrainRateLimiting(BaseSettings):
     max_brain_per_user: int = 5
 
 
+# The `PostHogSettings` class is used to initialize and interact with the PostHog analytics service.
+class PostHogSettings(BaseSettings):
+    posthog_api_key: str = None
+    posthog_api_url: str = None
+    posthog: Posthog = None
+
+    def __init__(self, *args, **kwargs):
+        """
+        The function initializes the "posthog" attribute and calls the "initialize_posthog" method.
+        """
+        super().__init__(*args, **kwargs)
+        self.posthog = None
+        self.initialize_posthog()
+
+    def initialize_posthog(self):
+        """
+        The function initializes a PostHog client with an API key and URL.
+        """
+        if self.posthog_api_key and self.posthog_api_url:
+            self.posthog = Posthog(
+                api_key=self.posthog_api_key, host=self.posthog_api_url
+            )
+
+    def log_event(self, user_id: UUID, event_name: str, event_properties: dict):
+        """
+        The function logs an event with a user ID, event name, and event properties using the PostHog
+        analytics tool.
+
+        :param user_id: The user_id parameter is a UUID (Universally Unique Identifier) that uniquely
+        identifies a user. It is typically used to track and identify individual users in an application
+        or system
+        :type user_id: UUID
+        :param event_name: The event_name parameter is a string that represents the name or type of the
+        event that you want to log. It could be something like "user_signed_up", "item_purchased", or
+        "page_viewed"
+        :type event_name: str
+        :param event_properties: The event_properties parameter is a dictionary that contains additional
+        information or properties related to the event being logged. These properties provide more
+        context or details about the event and can be used for analysis or filtering purposes
+        :type event_properties: dict
+        """
+        if self.posthog:
+            self.posthog.capture(user_id, event_name, event_properties)
+
+    def set_user_properties(self, user_id: UUID, event_name, properties: dict):
+        """
+        The function sets user properties for a given user ID and event name using the PostHog analytics
+        tool.
+
+        :param user_id: The user_id parameter is a UUID (Universally Unique Identifier) that uniquely
+        identifies a user. It is used to associate the user with the event and properties being captured
+        :type user_id: UUID
+        :param event_name: The `event_name` parameter is a string that represents the name of the event
+        that you want to capture. It could be something like "user_signed_up" or "item_purchased"
+        :param properties: The `properties` parameter is a dictionary that contains the user properties
+        that you want to set. Each key-value pair in the dictionary represents a user property, where
+        the key is the name of the property and the value is the value you want to set for that property
+        :type properties: dict
+        """
+        if self.posthog:
+            self.posthog.capture(
+                user_id, event=event_name, properties={"$set": properties}
+            )
+
+    def set_once_user_properties(self, user_id: UUID, event_name, properties: dict):
+        """
+        The function sets user properties for a specific event, ensuring that the properties are only
+        set once.
+
+        :param user_id: The user_id parameter is a UUID (Universally Unique Identifier) that uniquely
+        identifies a user
+        :type user_id: UUID
+        :param event_name: The `event_name` parameter is a string that represents the name of the event
+        that you want to capture. It could be something like "user_signed_up" or "item_purchased"
+        :param properties: The `properties` parameter is a dictionary that contains the user properties
+        that you want to set. Each key-value pair in the dictionary represents a user property, where
+        the key is the property name and the value is the property value
+        :type properties: dict
+        """
+        if self.posthog:
+            self.posthog.capture(
+                user_id, event=event_name, properties={"$set_once": properties}
+            )
+
+
 class BrainSettings(BaseSettings):
     openai_api_key: str
     supabase_url: str

backend/models/user_usage.py

@@ -1,6 +1,6 @@
 from logger import get_logger
 from models.databases.supabase.supabase import SupabaseDB
-from models.settings import get_supabase_db
+from models.settings import PostHogSettings, get_supabase_db
 from modules.user.entity.user_identity import UserIdentity
 
 logger = get_logger(__name__)
@@ -36,7 +36,19 @@ class UserUsage(UserIdentity):
         """
         Fetch the user settings from the database
         """
+        posthog = PostHogSettings()
         request = self.supabase_db.get_user_settings(self.id)
+        if request is not None and request.get("is_premium", False):
+            posthog.set_once_user_properties(
+                self.id, "HAS_OR_HAD_PREMIUM", {"bought_premium": "true"}
+            )
+            posthog.set_user_properties(
+                self.id, "CURRENT_PREMIUM", {"is_premium": "true"}
+            )
+        else:
+            posthog.set_user_properties(
+                self.id, "CURRENT_PREMIUM", {"is_premium": "false"}
+            )
 
         return request
 
@@ -44,7 +56,11 @@ class UserUsage(UserIdentity):
         """
         Fetch the user daily usage from the database
         """
+        posthog = PostHogSettings()
         request = self.supabase_db.get_user_requests_count_for_day(self.id, date)
+        posthog.set_user_properties(
+            self.id, "DAILY_USAGE", {"daily_chat_usage": request}
+        )
 
         return request
 

backend/modules/chat/controller/chat/utils.py

@@ -36,10 +36,6 @@ def check_user_requests_limit(user: UserIdentity, model: str):
     for model_setting in models_price:
         if model_setting["name"] == model:
             user_choosen_model_price = model_setting["price"]
-    print(f"User {user.id} has {daily_user_count} requests for today")
-    print(f"User {user.id} has {daily_chat_credit} daily chat credit")
-    print(f"User {user.id} has {user_choosen_model_price} price for the model")
-    print(f"User {user.id} has {models_price} models price")
 
     if int(daily_user_count + user_choosen_model_price) > int(daily_chat_credit):
         raise HTTPException(

backend/renovate.json

@@ -1,40 +0,0 @@
-{
-    "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-    "extends": [
-        "config:base",
-        "group:allNonMajor"
-    ],
-    "prHourlyLimit": 0,
-    "prConcurrentLimit": 15,
-    "baseBranches": [
-        "main"
-    ],
-    "packageRules": [
-        {
-            "updateTypes": [
-                "major"
-            ],
-            "addLabels": [
-                "SemVer Major"
-            ]
-        },
-        {
-            "updateTypes": [
-                "minor"
-            ],
-            "addLabels": [
-                "SemVer Minor"
-            ]
-        },
-        {
-            "updateTypes": [
-                "patch",
-                "digest",
-                "bump"
-            ],
-            "addLabels": [
-                "SemVer Patch"
-            ]
-        }
-    ]
-}

backend/requirements.txt

@@ -38,3 +38,4 @@ pytest-mock
 pytest-celery
 pytesseract==0.3.10
 async_generator
+posthog==3.1.0

supabase/migrations/20240103185550_upgrade.sql

@@ -1,3 +0,0 @@
-alter extension "wrappers" update to '0.2.0';
-
-