django-activity-audit 1.3.0.dev14__tar.gz → 1.3.0.dev16__tar.gz

{django_activity_audit-1.3.0.dev14 → django_activity_audit-1.3.0.dev16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-activity-audit
-Version: 1.3.0.dev14
+Version: 1.3.0.dev16
 Summary: A Django package for easy CRUD operation logging and container logs
 Project-URL: Homepage, https://github.com/shree256/django-activity-audit
 Project-URL: Repository, https://github.com/shree256/django-activity-audit

{django_activity_audit-1.3.0.dev14 → django_activity_audit-1.3.0.dev16}/activity_audit/formatters.py

@@ -5,6 +5,7 @@ import logging
 import uuid
 
 from .constants import LogType
+from .middleware import get_request_id
 
 def _json_default(obj):
     """
@@ -49,7 +50,7 @@ class AppFormatter(logging.Formatter):
             "path": record.pathname,
             "module": record.module,
             "function": record.funcName,
-            "request_id": getattr(record, "request_id", "") or "",
+            "request_id": getattr(record, "request_id", None) or get_request_id() or "",
             "message": record.getMessage(),
             "exception": "",
             "log_type": self.log_type,

{django_activity_audit-1.3.0.dev14 → django_activity_audit-1.3.0.dev16}/activity_audit/handlers.py

@@ -170,6 +170,8 @@ class AsyncJsonHandler(QueueHandler):
         self._listener.start()
 
     def prepare(self, record):
+        # Capture request_id in the calling thread before the record is queued,
+        # since thread-locals are not accessible from the QueueListener thread.
         record = super().prepare(record)
         record.request_id = get_request_id() or ""
         return record

{django_activity_audit-1.3.0.dev14 → django_activity_audit-1.3.0.dev16}/activity_audit/middleware.py

@@ -126,18 +126,6 @@ class AuditLoggingMiddleware(MiddlewareMixin):
 
     def __init__(self, get_response):
         self.get_response = get_response
-        self.log_data = {
-            "service_name": SERVICE_NAME,
-            "request_type": REQUEST_TYPES[0],
-            "protocol": None,
-            "request_id": "",
-            "user_id": "",
-            "user_info": {},
-            "request_repr": {},
-            "response_repr": {},
-            "error_message": None,
-            "execution_time": 0,
-        }
 
         if iscoroutinefunction(self.get_response):
             markcoroutinefunction(self)
@@ -152,6 +140,18 @@ class AuditLoggingMiddleware(MiddlewareMixin):
         if not should_log_url(request.path):
             return self.get_response(request)
 
+        log_data = {
+            "service_name": SERVICE_NAME,
+            "request_type": REQUEST_TYPES[0],
+            "protocol": None,
+            "request_id": "",
+            "user_id": "",
+            "user_info": {},
+            "request_repr": {},
+            "response_repr": {},
+            "error_message": None,
+            "execution_time": 0,
+        }
         start_time = time.time()
 
         # Log request
@@ -175,8 +175,8 @@ class AuditLoggingMiddleware(MiddlewareMixin):
 
         # Capture user details AFTER authentication has happened
         user_id, user_info = get_user_details()
-        self.log_data["user_id"] = user_id
-        self.log_data["user_info"] = user_info
+        log_data["user_id"] = user_id
+        log_data["user_info"] = user_info
 
         # TODO: Find way to add status code to response_data
 
@@ -196,13 +196,13 @@ class AuditLoggingMiddleware(MiddlewareMixin):
             except UnicodeDecodeError:
                 response_data["body"] = "Binary content"
 
-        self.log_data["execution_time"] = end_time - start_time
-        self.log_data["protocol"] = "https" if request.is_secure() else "http"
-        self.log_data["request_id"] = request_id
-        self.log_data["request_repr"] = request_data
-        self.log_data["response_repr"] = response_data
+        log_data["execution_time"] = end_time - start_time
+        log_data["protocol"] = "https" if request.is_secure() else "http"
+        log_data["request_id"] = request_id
+        log_data["request_repr"] = request_data
+        log_data["response_repr"] = response_data
 
-        logger.api("Audit Internal Request", extra=self.log_data)
+        logger.api("Audit Internal Request", extra=log_data)
 
         clear_request()
 
@@ -216,6 +216,18 @@ class AuditLoggingMiddleware(MiddlewareMixin):
         if not should_log_url(request.path):
             return await self.get_response(request)
 
+        log_data = {
+            "service_name": SERVICE_NAME,
+            "request_type": REQUEST_TYPES[0],
+            "protocol": None,
+            "request_id": "",
+            "user_id": "",
+            "user_info": {},
+            "request_repr": {},
+            "response_repr": {},
+            "error_message": None,
+            "execution_time": 0,
+        }
         start_time = time.time()
 
         # Log request
@@ -241,8 +253,8 @@ class AuditLoggingMiddleware(MiddlewareMixin):
         user_id, user_info = await sync_to_async(
             get_user_details, thread_sensitive=True
         )()
-        self.log_data["user_id"] = user_id
-        self.log_data["user_info"] = user_info
+        log_data["user_id"] = user_id
+        log_data["user_info"] = user_info
 
         # TODO: Find way to add status code to response_data
 
@@ -262,13 +274,13 @@ class AuditLoggingMiddleware(MiddlewareMixin):
             except UnicodeDecodeError:
                 response_data["body"] = "Binary content"
 
-        self.log_data["execution_time"] = end_time - start_time
-        self.log_data["protocol"] = "https" if request.is_secure() else "http"
-        self.log_data["request_id"] = request_id
-        self.log_data["request_repr"] = request_data
-        self.log_data["response_repr"] = response_data
+        log_data["execution_time"] = end_time - start_time
+        log_data["protocol"] = "https" if request.is_secure() else "http"
+        log_data["request_id"] = request_id
+        log_data["request_repr"] = request_data
+        log_data["response_repr"] = response_data
 
-        logger.api("Audit Internal Request", extra=self.log_data)
+        logger.api("Audit Internal Request", extra=log_data)
 
         clear_request()
 

{django_activity_audit-1.3.0.dev14 → django_activity_audit-1.3.0.dev16}/activity_audit/signals.py

@@ -2,7 +2,7 @@ import inspect
 import logging
 
 from functools import wraps
-from typing import Any, List, Optional
+from typing import Any, List
 
 from django.apps import apps
 from django.db import models, transaction
@@ -54,32 +54,70 @@ def should_audit(instance_or_class):
     return True
 
 
-def get_calling_model() -> Optional[str]:
-    """Get the model name from the calling function's frame."""
-    try:
-        # Get the current frame
-        frame = inspect.currentframe()
-        # Go up 3 frames to get to the actual calling function
-        # (1 for get_calling_model, 1 for the signal handler, 1 for the bulk operation)
-        for _ in range(3):
-            frame = frame.f_back
-            if frame is None:
-                return None
-
-        # Get the calling function's name
-        calling_function = frame.f_code.co_name
-        # Get the module name
-        module_name = frame.f_globals.get("__name__", "")
-
-        # Check if this is a direct bulk operation call
-        if "bulk_create" in calling_function or "bulk_update" in calling_function:
-            return module_name.split(".")[-1]
-    except Exception:
-        pass
-    return None
+_patched_models: set = set()
+_queryset_patched: bool = False
 
 
-_patched_models: set = set()
+def patch_queryset_bulk_methods() -> None:
+    """Patch QuerySet.bulk_create and bulk_update exactly once."""
+    global _queryset_patched
+    if _queryset_patched:
+        return
+    _queryset_patched = True
+
+    original_bulk_create = models.QuerySet.bulk_create
+    original_bulk_update = models.QuerySet.bulk_update
+
+    @wraps(original_bulk_create)
+    def bulk_create_with_signals(
+        self, objs: List[models.Model], *args: Any, **kwargs: Any
+    ) -> List[models.Model]:
+        if not objs:
+            return original_bulk_create(self, objs, *args, **kwargs)
+
+        created_objs = original_bulk_create(self, objs, *args, **kwargs)
+
+        model_class = self.model
+        if not should_audit(model_class):
+            return created_objs
+
+        first_obj = created_objs[0]
+        push_log(
+            f"{EVENT_TYPES[3]} event by {model_class.__name__} (id: {first_obj.pk})",
+            model_class.__name__,
+            EVENT_TYPES[3],
+            str(first_obj.pk),
+            instance_to_dict(first_obj),
+            {"total_count": len(created_objs)},
+        )
+        return created_objs
+
+    @wraps(original_bulk_update)
+    def bulk_update_with_signals(
+        self, objs: List[models.Model], fields: List[str], batch_size=None
+    ) -> None:
+        if not objs:
+            return original_bulk_update(self, objs, fields, batch_size)
+
+        result = original_bulk_update(self, objs, fields, batch_size)
+
+        model_class = self.model
+        if not should_audit(model_class):
+            return result
+
+        first_obj = objs[0]
+        push_log(
+            f"{EVENT_TYPES[4]} event by {model_class.__name__}",
+            model_class.__name__,
+            EVENT_TYPES[4],
+            str(first_obj.pk),
+            instance_to_dict(first_obj),
+            {"total_count": len(objs), "fields": fields},
+        )
+        return result
+
+    models.QuerySet.bulk_create = bulk_create_with_signals
+    models.QuerySet.bulk_update = bulk_update_with_signals
 
 
 def push_log(
@@ -126,8 +164,6 @@ def patch_model_event(model_class: type[models.Model]) -> None:
 
         # Store the original methods
         original_save = model_class.save
-        original_bulk_create = models.QuerySet.bulk_create
-        original_bulk_update = models.QuerySet.bulk_update
 
         # SAVE ---------------------------------------------------------------------------
         @wraps(original_save)
@@ -175,76 +211,8 @@ def patch_model_event(model_class: type[models.Model]) -> None:
                 instance_repr,
             )
 
-        # BULK --------------------------------------------------------------------------
-        @wraps(original_bulk_create)
-        def bulk_create_with_signals(
-            self, objs: List[models.Model], *args: Any, **kwargs: Any
-        ) -> List[models.Model]:
-            if not objs:
-                return original_bulk_create(self, objs, *args, **kwargs)
-
-            # Get the calling model
-            calling_model = get_calling_model()
-            if not calling_model:
-                return original_bulk_create(self, objs, *args, **kwargs)
-
-            # Call the original bulk_create method
-            created_objs = original_bulk_create(self, objs, *args, **kwargs)
-
-            # Log only if this is the calling model
-            if calling_model == model_class.__name__:
-                first_obj = created_objs[0]
-                instance_repr = instance_to_dict(first_obj)
-
-                push_log(
-                    f"{EVENT_TYPES[3]} event by {model_class.__name__} (id: {first_obj.pk})",
-                    model_class.__name__,
-                    EVENT_TYPES[3],
-                    str(first_obj.pk),
-                    instance_repr,
-                    {
-                        "total_count": len(created_objs),
-                    },
-                )
-
-            return created_objs
-
-        @wraps(original_bulk_update)
-        def bulk_update_with_signals(
-            self, objs: List[models.Model], fields: List[str], batch_size=None
-        ) -> None:
-            if not objs:
-                return original_bulk_update(self, objs, fields, batch_size)
-
-            # Call the original bulk_update method
-            bulk_update = original_bulk_update(self, objs, fields, batch_size)
-
-            # Get the calling model
-            calling_model = get_calling_model()
-            if not calling_model:
-                return bulk_update
-
-            # Log only if this is the calling model
-            if calling_model == model_class.__name__:
-                first_obj = objs[0]
-                instance_repr = instance_to_dict(first_obj)
-
-                push_log(
-                    f"{EVENT_TYPES[4]} event by {model_class.__name__}",
-                    model_class.__name__,
-                    EVENT_TYPES[4],
-                    str(first_obj.pk),
-                    instance_repr,
-                    {
-                        "total_count": len(objs),
-                        "fields": fields,
-                    },
-                )
-
         # Replace the methods
         model_class.save = save_with_signals
-        models.QuerySet.bulk_create = bulk_create_with_signals
-        models.QuerySet.bulk_update = bulk_update_with_signals
 
         # DELETE -----------------------------------------------------------------------
         @receiver(pre_delete, sender=model_class)
@@ -311,6 +279,7 @@ def patch_model_event(model_class: type[models.Model]) -> None:
 
 def setup_model_signals() -> None:
     """Set up signals for all models in the project."""
+    patch_queryset_bulk_methods()
     for app_config in apps.get_app_configs():
         for model in app_config.get_models():
             if not should_audit(model):

{django_activity_audit-1.3.0.dev14 → django_activity_audit-1.3.0.dev16}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-activity-audit"
-version = "1.3.0.dev14"
+version = "1.3.0.dev16"
 description = "A Django package for easy CRUD operation logging and container logs"
 authors = [
     { name = "Shreeshan", email = "shreeshan256@gmail.com" }