django-devbar 0.6.0__tar.gz → 0.7.0__tar.gz

{django_devbar-0.6.0 → django_devbar-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-devbar
-Version: 0.6.0
+Version: 0.7.0
 Summary: Lightweight performance devbar for Django
 Keywords: django,debug,performance,monitoring,development
 Author: amureki
@@ -22,11 +22,12 @@ Classifier: Framework :: Django :: 5.2
 Classifier: Framework :: Django :: 6.0
 Classifier: Topic :: Software Development
 Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
 Requires-Dist: django>=4.2
 Requires-Python: >=3.10
 Project-URL: Homepage, https://github.com/amureki/django-devbar
-Project-URL: Issues, https://github.com/amureki/django-devbar/issues
 Project-URL: Repository, https://github.com/amureki/django-devbar
+Project-URL: Issues, https://github.com/amureki/django-devbar/issues
 Description-Content-Type: text/markdown
 
 # django-devbar
@@ -71,16 +72,21 @@ uv add --dev django-devbar
 pip install django-devbar
 ```
 
-Add to your middleware as early as possible, but after any middleware that encodes the response (e.g., `GZipMiddleware`):
+Add to your middleware early. For example:
 
 ```python
 MIDDLEWARE = [
     "django.middleware.security.SecurityMiddleware",
-    "django_devbar.DevBarMiddleware",
     # ...
 ]
+
+if DEBUG:
+    idx = MIDDLEWARE.index("django.middleware.security.SecurityMiddleware")
+    MIDDLEWARE.insert(idx + 1, "django_devbar.DevBarMiddleware")
 ```
 
+This keeps the middleware active only in development and avoids import errors if the package isn't installed in production.
+
 ## Configuration
 
 All settings are optional. Configure via a `DEVBAR` dict in your Django settings:
@@ -90,6 +96,8 @@ DEVBAR = {
     "POSITION": "bottom-right",  # bottom-right (default), bottom-left, top-right, top-left
     "SHOW_BAR": None,  # follows DEBUG; set True/False to override
     "ENABLE_DEVTOOLS_DATA": None,  # follows DEBUG; set True/False to override
+    "DEVTOOLS_HEADER_MAX_BYTES": 6144,  # max bytes for DevBar-Data header payload
+    "DEVTOOLS_MAX_QUERIES": None,  # optional hard cap for q/dup entries sent to DevTools
 }
 ```
 
@@ -102,6 +110,9 @@ Django DevBar adds HTTP response headers with performance metrics:
 An additional header is included by default in DEBUG mode:
 
 - **DevBar-Data** - JSON header with comprehensive metrics including similar and duplicate query details
+  - Query-level flags are embedded in `q` entries (`dup` and `sim`)
+  - Payload is automatically truncated to fit `DEVTOOLS_HEADER_MAX_BYTES`
+  - When truncated, response includes metadata keys: `tr`, `q_total`, `q_sent`
 
 This is useful for:
 

{django_devbar-0.6.0 → django_devbar-0.7.0}/README.md

@@ -40,16 +40,21 @@ uv add --dev django-devbar
 pip install django-devbar
 ```
 
-Add to your middleware as early as possible, but after any middleware that encodes the response (e.g., `GZipMiddleware`):
+Add to your middleware early. For example:
 
 ```python
 MIDDLEWARE = [
     "django.middleware.security.SecurityMiddleware",
-    "django_devbar.DevBarMiddleware",
     # ...
 ]
+
+if DEBUG:
+    idx = MIDDLEWARE.index("django.middleware.security.SecurityMiddleware")
+    MIDDLEWARE.insert(idx + 1, "django_devbar.DevBarMiddleware")
 ```
 
+This keeps the middleware active only in development and avoids import errors if the package isn't installed in production.
+
 ## Configuration
 
 All settings are optional. Configure via a `DEVBAR` dict in your Django settings:
@@ -59,6 +64,8 @@ DEVBAR = {
     "POSITION": "bottom-right",  # bottom-right (default), bottom-left, top-right, top-left
     "SHOW_BAR": None,  # follows DEBUG; set True/False to override
     "ENABLE_DEVTOOLS_DATA": None,  # follows DEBUG; set True/False to override
+    "DEVTOOLS_HEADER_MAX_BYTES": 6144,  # max bytes for DevBar-Data header payload
+    "DEVTOOLS_MAX_QUERIES": None,  # optional hard cap for q/dup entries sent to DevTools
 }
 ```
 
@@ -71,6 +78,9 @@ Django DevBar adds HTTP response headers with performance metrics:
 An additional header is included by default in DEBUG mode:
 
 - **DevBar-Data** - JSON header with comprehensive metrics including similar and duplicate query details
+  - Query-level flags are embedded in `q` entries (`dup` and `sim`)
+  - Payload is automatically truncated to fit `DEVTOOLS_HEADER_MAX_BYTES`
+  - When truncated, response includes metadata keys: `tr`, `q_total`, `q_sent`
 
 This is useful for:
 

{django_devbar-0.6.0 → django_devbar-0.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-devbar"
-version = "0.6.0"
+version = "0.7.0"
 description = "Lightweight performance devbar for Django"
 readme = "README.md"
 license = "MIT"
@@ -27,6 +27,7 @@ classifiers = [
   "Framework :: Django :: 6.0",
   "Topic :: Software Development",
   "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
 ]
 
 [project.urls]

{django_devbar-0.6.0 → django_devbar-0.7.0}/src/django_devbar/conf.py

@@ -13,6 +13,8 @@ def get_config():
         "POSITION": "bottom-right",
         "SHOW_BAR": None,  # None = use settings.DEBUG
         "ENABLE_DEVTOOLS_DATA": None,  # None = use settings.DEBUG
+        "DEVTOOLS_HEADER_MAX_BYTES": 6144,
+        "DEVTOOLS_MAX_QUERIES": None,
         **getattr(settings, "DEVBAR", {}),
     }
 
@@ -33,3 +35,13 @@ def get_enable_devtools_data():
     config = get_config()
     enable = config["ENABLE_DEVTOOLS_DATA"]
     return settings.DEBUG if enable is None else enable
+
+
+def get_devtools_header_max_bytes():
+    config = get_config()
+    return config["DEVTOOLS_HEADER_MAX_BYTES"]
+
+
+def get_devtools_max_queries():
+    config = get_config()
+    return config["DEVTOOLS_MAX_QUERIES"]

{django_devbar-0.6.0 → django_devbar-0.7.0}/src/django_devbar/middleware.py

@@ -9,6 +9,8 @@ from django.template import Context, Engine
 
 from . import tracker
 from .conf import (
+    get_devtools_header_max_bytes,
+    get_devtools_max_queries,
     get_enable_devtools_data,
     get_position,
     get_show_bar,
@@ -58,34 +60,104 @@ class DevBarMiddleware:
         return response
 
     def _add_devtools_data_header(self, response, stats):
-        # Abbreviated keys used to minimize DevBar-Data header size
-        extension_data = {
+        max_bytes = get_devtools_header_max_bytes()
+        if max_bytes <= 0:
+            return
+
+        summary_data = {
             "c": stats["count"],
             "db": round(stats["duration"], 2),
             "app": stats["python_time"],
             "full": stats["total_time"],
         }
+        if self._json_size(summary_data) > max_bytes:
+            return
 
-        all_queries = stats.get("queries", [])
-        duplicates = stats.get("duplicate_queries", [])
+        raw_queries = stats.get("queries", [])
+        total_query_count = len(raw_queries)
+        max_queries = get_devtools_max_queries()
+        all_queries = (
+            raw_queries[:max_queries] if max_queries is not None else raw_queries
+        )
+        processed_queries = [
+            {
+                "s": truncate_sql(q["sql"]),
+                "dur": q["duration"],
+                "dup": 1 if q["is_duplicate"] else 0,
+                "sim": 1 if q.get("is_similar") else 0,
+            }
+            for q in all_queries
+        ]
+        is_truncated = len(processed_queries) < total_query_count
 
-        if all_queries:
-            processed_queries = [
-                {
-                    "s": truncate_sql(q["sql"]),
-                    "dur": q["duration"],
-                    "dup": 1 if q["is_duplicate"] else 0,
-                    "sim": 1 if q.get("is_similar") else 0,
-                }
-                for q in all_queries
-            ]
-            extension_data["q"] = processed_queries
+        full_payload = summary_data.copy()
+        if processed_queries:
+            full_payload["q"] = processed_queries
+        if self._json_size(full_payload) <= max_bytes and not is_truncated:
+            response["DevBar-Data"] = self._serialize_payload(full_payload)
+            return
 
-        if duplicates:
-            marked_duplicates = [{**d, "dup": 1} for d in duplicates]
-            extension_data["dup"] = marked_duplicates
+        best_count = self._max_queries_that_fit(
+            summary_data,
+            processed_queries,
+            max_bytes,
+            total_query_count,
+        )
+        payload = self._build_truncated_payload(
+            summary_data,
+            processed_queries,
+            best_count,
+            total_query_count,
+        )
 
-        response["DevBar-Data"] = json.dumps(extension_data)
+        if self._json_size(payload) <= max_bytes:
+            response["DevBar-Data"] = self._serialize_payload(payload)
+        else:
+            response["DevBar-Data"] = self._serialize_payload(summary_data)
+
+    def _json_size(self, data):
+        return len(self._serialize_payload(data).encode("utf-8"))
+
+    def _serialize_payload(self, payload):
+        return json.dumps(payload, separators=(",", ":"))
+
+    def _build_truncated_payload(
+        self,
+        summary_data,
+        processed_queries,
+        query_count,
+        queries_total,
+    ):
+        payload = summary_data.copy()
+        if query_count:
+            payload["q"] = processed_queries[:query_count]
+        payload["tr"] = 1
+        payload["q_total"] = queries_total
+        payload["q_sent"] = query_count
+        return payload
+
+    def _max_queries_that_fit(
+        self,
+        summary_data,
+        processed_queries,
+        max_bytes,
+        queries_total,
+    ):
+        low = 0
+        high = len(processed_queries)
+        while low < high:
+            mid = (low + high + 1) // 2
+            payload = self._build_truncated_payload(
+                summary_data,
+                processed_queries,
+                mid,
+                queries_total,
+            )
+            if self._json_size(payload) <= max_bytes:
+                low = mid
+            else:
+                high = mid - 1
+        return low
 
     def _add_server_timing_header(self, response, stats):
         parts = [

{django_devbar-0.6.0 → django_devbar-0.7.0}/src/django_devbar/tracker.py

@@ -85,7 +85,7 @@ def _record(sql, params, duration):
     query_log = _query_log.get()
     query_log.append(
         {
-            "sql": sql,
+            "sql": str(sql),
             "duration": round(duration, 2),
             "params_hash": params_hash,
         }