feat: send error logs to server

Author: sakshamg1304

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.5.0] - 2025-03-12
+
+### Added
+
+- Added support for sending error logs to VWO server for better debugging.
+
 ## [1.4.0] - 2024-11-22
 
 ### Added

setup.py

@@ -121,7 +121,7 @@ def run(self):
 
 setup(
     name="vwo-fme-python-sdk",
-    version="1.3.0",
+    version="1.5.0",
     description="VWO Feature Management and Experimentation SDK for Python",
     long_description=long_description,
     long_description_content_type="text/markdown",

vwo/api/set_attribute_api.py

@@ -34,7 +34,6 @@ def create_and_send_impression_for_attribute(
         context: ContextModel
     ):
         properties = get_events_base_properties(
-            settings,
             EventEnum.VWO_SYNC_VISITOR_PROP.value,
             visitor_user_agent=context.get_user_agent(),
             ip_address=context.get_ip_address()

vwo/api/track_api.py

@@ -63,7 +63,6 @@ def create_and_send_impression_for_track(
         :param event_properties: The properties of the event.
         """
         properties = get_events_base_properties(
-            settings,
             event_name,
             visitor_user_agent=context.get_user_agent(),
             ip_address=context.get_ip_address()

vwo/constants/Constants.py

@@ -17,7 +17,7 @@ class Constants:
     # Mock package_file equivalent
     package_file = {
         "name": "vwo-fme-python-sdk",  # Replace with actual package name
-        "version": "1.3.0",  # Replace with actual package version
+        "version": "1.5.0",  # Replace with actual package version
     }
 
     # Constants

vwo/enums/event_enum.py

@@ -17,4 +17,5 @@
 
 class EventEnum(Enum):
     VWO_VARIATION_SHOWN = 'vwo_variationShown'
-    VWO_SYNC_VISITOR_PROP = 'vwo_syncVisitorProp'
+    VWO_SYNC_VISITOR_PROP = 'vwo_syncVisitorProp'
+    VWO_LOG_EVENT = 'vwo_log'

vwo/packages/logger/core/log_manager.py

@@ -21,9 +21,12 @@
 from ..logger import Logger
 import datetime
 from typing import Dict, Any, Union
+from ....enums.event_enum import EventEnum
+from ....constants.Constants import Constants
 
 class LogManager(Logger):
     _instance = None
+    stored_messages = set()  # Set to store already logged messages for duplicate prevention
 
     def __new__(cls, *args, **kwargs):
         if cls._instance is None:
@@ -84,4 +87,7 @@ def warn(self, message: str) -> None:
         self.transport_manager.log(LogLevelEnum.WARN, message)
 
     def error(self, message: str) -> None:
+        from ....utils.log_message_util import send_log_to_vwo
+        # Log the error using the transport manager
         self.transport_manager.log(LogLevelEnum.ERROR, message)
+        send_log_to_vwo(message, LogLevelEnum.ERROR)

vwo/services/settings_manager.py

@@ -75,6 +75,12 @@ def __init__(self, options):
     @classmethod
     def get_instance(cls):
         return cls._instance
+    
+    def get_account_id(self):
+        return self.account_id
+
+    def get_sdk_key(self):
+        return self.sdk_key
 
     def fetch_settings_and_cache_in_storage(self, update=False):
         try:

vwo/utils/impression_util.py

@@ -27,7 +27,6 @@ def create_and_send_impression_for_variation_shown(
 ):
     # Get base properties for the event
     properties = get_events_base_properties(
-        settings,
         EventEnum.VWO_VARIATION_SHOWN.value,
         visitor_user_agent=context.get_user_agent(),
         ip_address=context.get_ip_address()

vwo/utils/log_message_util.py

@@ -17,10 +17,15 @@
 import json
 import os
 from typing import Dict, Any
+from ..enums.event_enum import EventEnum
+from ..constants.Constants import Constants
 
 # Determine the base directory (the directory containing this script)
 base_dir = os.path.dirname(__file__)
 
+# Set to store already logged messages (to avoid duplicates)
+stored_messages = set()
+
 def load_json_file(filename: str) -> Dict[str, str]:
     """
     Loads a JSON file and returns its content as a dictionary.
@@ -37,4 +42,33 @@ def load_json_file(filename: str) -> Dict[str, str]:
 error_messages = load_json_file('error-messages.json')
 info_messages = load_json_file('info-message.json')
 trace_messages = load_json_file('trace-messages.json')
-warn_messages = load_json_file('warn-messages.json')
+warn_messages = load_json_file('warn-messages.json')
+
+def send_log_to_vwo(message: str, message_type: str) -> None:
+    """
+    Sends a log message to VWO.
+    
+    :param message: The message to send.
+    :param message_type: The type of message (e.g., ERROR, INFO).
+    """
+    from ..utils.network_util import get_events_base_properties, get_messaging_event_payload, send_messaging_event
+
+    if os.getenv('TEST_ENV') == 'true':
+        return  # Skip logging in test environment
+
+    # Construct the message to check for duplicates
+    message_to_send = f"{message}-{Constants.SDK_NAME}-{Constants.SDK_VERSION}"
+
+    # Avoid sending duplicate messages
+    if message_to_send not in stored_messages:
+        # Add the message to the stored set to prevent duplicates
+        stored_messages.add(message_to_send)
+
+        # Get event properties for the error event
+        properties = get_events_base_properties(EventEnum.VWO_LOG_EVENT.value)
+
+        # Create the payload for the messaging event
+        payload = get_messaging_event_payload(message_type, message, EventEnum.VWO_LOG_EVENT.value)
+
+        # Send the message via HTTP request
+        send_messaging_event(properties, payload)

vwo/utils/network_util.py

@@ -64,15 +64,21 @@ def get_event_batching_query_params(account_id: str) -> Dict[str, Any]:
 
 # Function to build generic properties for tracking events
 def get_events_base_properties(
-    setting: SettingsModel,
     event_name: str,
     visitor_user_agent: str = '',
     ip_address: str = ''
 ) -> Dict[str, Any]:
-    sdk_key = setting.get_sdk_key()
+    from ..services.settings_manager import SettingsManager
+    # Get the instance of SettingsManager
+    settings = SettingsManager.get_instance()
+
+    # Fetch SDK key and account ID from the SettingsManager instance
+    sdk_key = settings.get_sdk_key()
+    account_id = settings.get_account_id()
+
     return {
         'en': event_name,
-        'a': setting.get_account_id(),
+        'a': account_id,
         'env': sdk_key,
         'eTime': get_current_unix_timestamp_in_millis(),
         'random': get_random_number(),
@@ -90,8 +96,9 @@ def _get_event_base_payload(
     visitor_user_agent: str = '',
     ip_address: str = ''
 ) -> Dict[str, Any]:
-    uuid_value = get_uuid(user_id, settings.get_account_id())
-    sdk_key = settings.get_sdk_key()
+    from ..services.settings_manager import SettingsManager
+    uuid_value = get_uuid(user_id, SettingsManager.get_instance().get_account_id())
+    sdk_key = SettingsManager.get_instance().get_sdk_key()
     properties = {
         'd': {
             'msgId': f"{uuid_value}-{get_current_unix_timestamp_in_millis()}",
@@ -268,6 +275,76 @@ def send_post_api_request(properties: Dict[str, Any], payload: Dict[str, Any]):
             ),
         )
 
+# Function to construct the messaging event payload
+def get_messaging_event_payload(message_type: str, message: str, event_name: str) -> Dict[str, Any]:
+    from ..services.settings_manager import SettingsManager
+    # Get user ID and properties
+    settings = SettingsManager.get_instance()
+    user_id = f"{settings.get_account_id()}_{settings.get_sdk_key()}"
+    properties = _get_event_base_payload(None, user_id, event_name, None, None)
+
+    # Set the environment key and product
+    properties['d']['event']['props']['vwo_envKey'] = settings.get_sdk_key()
+    properties['d']['event']['props']['product'] = "fme"  # Assuming 'product' is a required field
+
+    # Set the message data
+    data = {
+        'type': message_type,
+        'content': {
+            'title': message,
+            'dateTime': get_current_unix_timestamp_in_millis()
+        }
+    }
+
+    # Add data to the properties
+    properties['d']['event']['props']['data'] = data
+
+    return properties
+
+def send_messaging_event(properties: Dict[str, Any], payload: Dict[str, Any]) -> Dict[str, Any]:
+    network_instance = NetworkManager.get_instance()
+
+    try:
+        # Prepare the request model
+        request = RequestModel(
+            Constants.HOST_NAME,
+            'POST',
+            UrlEnum.EVENTS.value,
+            properties,
+            payload,
+            None,
+            Constants.HTTPS_PROTOCOL,
+            443
+        )
+
+        # Flag to check if the event loop is initialized
+        event_loop_initialized = False
+        main_event_loop = None
+
+        # Start a new event loop in a separate thread if it hasn't been initialized yet
+        if not event_loop_initialized:
+            main_event_loop = asyncio.new_event_loop()
+            threading.Thread(target=start_event_loop, args=(main_event_loop,), daemon=True).start()
+            event_loop_initialized = True
+
+        # Submit the asynchronous POST request to the newly started event loop
+        asyncio.run_coroutine_threadsafe(network_instance.post_async(request), main_event_loop)
+
+        # Return a success message
+        return {"success": True, "message": "Event sent successfully"}
+
+    except Exception as err:
+        # Log the error
+        LogManager.get_instance().error(
+            error_messages.get('NETWORK_CALL_FAILED').format(
+                method='POST',
+                err=err,
+            )
+        )
+
+        # Return a failure message
+        return {"success": False, "message": "Failed to send event"}
+
 # Function to start the event loop in a new thread
 def start_event_loop(loop):
     # Set the provided loop as the current event loop for the new thread