django-devbar 0.4.0__tar.gz → 0.5.0__tar.gz

{django_devbar-0.4.0 → django_devbar-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-devbar
-Version: 0.4.0
+Version: 0.5.0
 Summary: Lightweight performance devbar for Django
 Keywords: django,debug,performance,monitoring,development
 Author: amureki
@@ -31,16 +31,24 @@ Description-Content-Type: text/markdown
 
 # django-devbar
 
+> [!WARNING]
+> This package is experimental and may introduce breaking changes in minor versions.
+
 Lightweight performance devbar for Django. Shows DB query count, query duration, application time, and detects duplicate queries with visual severity indicators.
 
-Normal operation – showing query count, duration, and application time: ![devbar example](https://github.com/amureki/django-devbar/raw/3c6118d4283c211a5d84510de52e1d5c3e5e46e4/docs/devbar-example.svg)
+## Showcase
 
-Duplicate queries detected – severity indicator and details shown: ![devbar warning example](https://github.com/amureki/django-devbar/raw/3c6118d4283c211a5d84510de52e1d5c3e5e46e4/docs/devbar-example-warning.svg)
+Normal operation – showing query count, duration, and application time:
 
-[![Chrome DevTools extension](https://github.com/user-attachments/assets/bc06af44-a0b3-4561-a13f-8007da53cb9e)](#chrome-extension)
+![devbar example](https://github.com/amureki/django-devbar/raw/3c6118d4283c211a5d84510de52e1d5c3e5e46e4/docs/devbar-example.svg)
 
-> [!WARNING]
-> This package is experimental and may introduce breaking changes in minor versions.
+Duplicate queries detected – severity indicator and details shown:
+
+![devbar warning example](https://github.com/amureki/django-devbar/raw/3c6118d4283c211a5d84510de52e1d5c3e5e46e4/docs/devbar-example-warning.svg)
+
+[optional] Chrome extension - showing detailed metrics in DevTools panel:
+
+[![Chrome DevTools extension](https://github.com/user-attachments/assets/9bbc41b7-3d93-46e7-aef4-9330a862b8f0)](#chrome-extension)
 
 ## Motivation
 

{django_devbar-0.4.0 → django_devbar-0.5.0}/README.md

@@ -1,15 +1,23 @@
 # django-devbar
 
+> [!WARNING]
+> This package is experimental and may introduce breaking changes in minor versions.
+
 Lightweight performance devbar for Django. Shows DB query count, query duration, application time, and detects duplicate queries with visual severity indicators.
 
-Normal operation – showing query count, duration, and application time: ![devbar example](https://github.com/amureki/django-devbar/raw/3c6118d4283c211a5d84510de52e1d5c3e5e46e4/docs/devbar-example.svg)
+## Showcase
 
-Duplicate queries detected – severity indicator and details shown: ![devbar warning example](https://github.com/amureki/django-devbar/raw/3c6118d4283c211a5d84510de52e1d5c3e5e46e4/docs/devbar-example-warning.svg)
+Normal operation – showing query count, duration, and application time:
 
-[![Chrome DevTools extension](https://github.com/user-attachments/assets/bc06af44-a0b3-4561-a13f-8007da53cb9e)](#chrome-extension)
+![devbar example](https://github.com/amureki/django-devbar/raw/3c6118d4283c211a5d84510de52e1d5c3e5e46e4/docs/devbar-example.svg)
 
-> [!WARNING]
-> This package is experimental and may introduce breaking changes in minor versions.
+Duplicate queries detected – severity indicator and details shown:
+
+![devbar warning example](https://github.com/amureki/django-devbar/raw/3c6118d4283c211a5d84510de52e1d5c3e5e46e4/docs/devbar-example-warning.svg)
+
+[optional] Chrome extension - showing detailed metrics in DevTools panel:
+
+[![Chrome DevTools extension](https://github.com/user-attachments/assets/9bbc41b7-3d93-46e7-aef4-9330a862b8f0)](#chrome-extension)
 
 ## Motivation
 

{django_devbar-0.4.0 → django_devbar-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-devbar"
-version = "0.4.0"
+version = "0.5.0"
 description = "Lightweight performance devbar for Django"
 readme = "README.md"
 license = "MIT"

{django_devbar-0.4.0 → django_devbar-0.5.0}/src/django_devbar/middleware.py

@@ -13,6 +13,7 @@ from .conf import (
     get_position,
     get_show_bar,
 )
+from .tracker import format_sql, truncate_sql
 
 BODY_CLOSE_RE = re.compile(rb"</body\s*>", re.IGNORECASE)
 
@@ -41,10 +42,10 @@ class DevBarMiddleware:
         stats = tracker.get_stats()
 
         db_time = stats["duration"]
-        python_time = max(0, total_time - db_time)
+        python_time = round(max(0, total_time - db_time), 2)
 
         stats["python_time"] = python_time
-        stats["total_time"] = total_time
+        stats["total_time"] = round(total_time, 2)
 
         if get_enable_devtools_data():
             self._add_devtools_data_header(response, stats)
@@ -57,14 +58,31 @@ class DevBarMiddleware:
         return response
 
     def _add_devtools_data_header(self, response, stats):
+        # Abbreviated keys used to minimize DevBar-Data header size
         extension_data = {
-            "count": stats["count"],
-            "db_time": stats["duration"],
-            "app_time": stats["python_time"],
-            "total_time": stats["total_time"],
+            "c": stats["count"],
+            "db": round(stats["duration"], 2),
+            "app": stats["python_time"],
+            "full": stats["total_time"],
         }
-        if stats.get("duplicate_queries"):
-            extension_data["duplicates"] = stats["duplicate_queries"]
+
+        all_queries = stats.get("queries", [])
+        duplicates = stats.get("duplicate_queries", [])
+
+        if all_queries:
+            processed_queries = [
+                {
+                    "s": truncate_sql(q["sql"]),
+                    "dur": q["duration"],
+                    "dup": 1 if q["is_duplicate"] else 0,
+                }
+                for q in all_queries
+            ]
+            extension_data["q"] = processed_queries
+
+        if duplicates:
+            marked_duplicates = [{**d, "dup": 1} for d in duplicates]
+            extension_data["dup"] = marked_duplicates
 
         response["DevBar-Data"] = json.dumps(extension_data)
 
@@ -118,5 +136,8 @@ class DevBarMiddleware:
     def _build_duplicates_html(self, duplicates):
         if not duplicates:
             return ""
+        formatted_duplicates = [
+            {**dup, "sql": format_sql(dup["sql"])} for dup in duplicates
+        ]
         template = _template_engine.get_template("django_devbar/duplicates.html")
-        return template.render(Context({"duplicates": duplicates}))
+        return template.render(Context({"duplicates": formatted_duplicates}))

django_devbar-0.5.0/src/django_devbar/tracker.py

@@ -0,0 +1,287 @@
+import re
+from contextvars import ContextVar
+from time import perf_counter
+
+SQL_KEYWORDS_RE = re.compile(
+    r"\b(SELECT|FROM|WHERE|JOIN|LEFT JOIN|RIGHT JOIN|INNER JOIN|OUTER JOIN|ON|AND|OR|ORDER BY|GROUP BY|HAVING|LIMIT|OFFSET|INSERT INTO|VALUES|UPDATE|SET|DELETE|CREATE TABLE|ALTER TABLE|DROP TABLE|DISTINCT|COUNT|SUM|AVG|MAX|MIN|UNION|EXISTS|IN|IS NULL|IS NOT NULL|LIKE|BETWEEN|CASE|WHEN|THEN|ELSE|END|ASC|DESC|AS|WITH|RECURSIVE)\b",
+    re.IGNORECASE,
+)
+
+SQL_CLAUSES_RE = re.compile(
+    r"\b(FROM|WHERE|JOIN|LEFT JOIN|RIGHT JOIN|INNER JOIN|OUTER JOIN|GROUP BY|ORDER BY|HAVING|LIMIT|OFFSET|ON|AND|OR|UNION|WITH|CASE|WHEN|THEN|ELSE)\b",
+    re.IGNORECASE,
+)
+
+_query_count: ContextVar[int] = ContextVar("query_count", default=0)
+_query_duration: ContextVar[float] = ContextVar("query_duration", default=0.0)
+_seen_queries: ContextVar[dict] = ContextVar("seen_queries", default={})
+_duplicate_log: ContextVar[list] = ContextVar("duplicate_log", default=[])
+_query_log: ContextVar[list] = ContextVar("query_log", default=[])
+
+
+def reset():
+    _query_count.set(0)
+    _query_duration.set(0.0)
+    _seen_queries.set({})
+    _duplicate_log.set([])
+    _query_log.set([])
+
+
+def get_stats():
+    duplicate_queries = _duplicate_log.get()
+    duplicate_sqls = {d["sql"] for d in duplicate_queries}
+
+    queries = _query_log.get()
+    for q in queries:
+        q["is_duplicate"] = q["sql"] in duplicate_sqls
+
+    return {
+        "count": _query_count.get(),
+        "duration": _query_duration.get(),
+        "duplicate_queries": duplicate_queries,
+        "queries": queries,
+    }
+
+
+def _hash_params(params):
+    try:
+        return hash(tuple(params)) if params else 0
+    except TypeError:
+        return hash(str(params))
+
+
+def _record(sql, params, duration):
+    _query_count.set(_query_count.get() + 1)
+    _query_duration.set(_query_duration.get() + duration)
+
+    seen = _seen_queries.get()
+    params_hash = _hash_params(params)
+
+    query_log = _query_log.get()
+    query_log.append(
+        {
+            "sql": sql,
+            "duration": round(duration, 2),
+        }
+    )
+    _query_log.set(query_log)
+
+    if sql in seen:
+        if params_hash in seen[sql]:
+            duplicates = _duplicate_log.get()
+            duplicates.append({"sql": sql, "duration": round(duration, 2)})
+        else:
+            seen[sql].add(params_hash)
+    else:
+        seen[sql] = {params_hash}
+
+
+def format_sql(sql):
+    """Highlight SQL keywords with HTML spans for visual formatting.
+
+    Escapes HTML first for security, then wraps SQL keywords in span tags.
+    Used for rendering duplicates in the injected devbar HTML.
+
+    Args:
+        sql: SQL query string
+
+    Returns:
+        Safe HTML string with keywords wrapped in spans
+    """
+    from django.utils.html import escape
+    from django.utils.safestring import mark_safe
+
+    escaped_sql = escape(sql)
+
+    def replace_keyword(match):
+        return f'<span class="sql-keyword">{match.group(0)}</span>'
+
+    highlighted = SQL_KEYWORDS_RE.sub(replace_keyword, escaped_sql)
+    return mark_safe(highlighted)
+
+
+class SQLTruncator:
+    """Handles intelligent SQL query truncation while preserving the structure."""
+
+    def __init__(self, max_length=150):
+        self.max_length = max_length
+
+    def truncate(self, sql):
+        """Intelligently truncate long SQL queries while preserving the structure.
+
+        Args:
+            sql: SQL query string
+
+        Returns:
+            Truncated SQL string with "..." at the end if shortened
+        """
+        if len(sql) <= self.max_length:
+            return sql
+
+        sql_upper = sql.upper()
+
+        if sql_upper.startswith("SELECT"):
+            result = self._truncate_select(sql, sql_upper)
+            if result:
+                return result
+
+        return self._fallback_truncate(sql)
+
+    def _truncate_select(self, sql, sql_upper):
+        """Truncate SELECT queries while preserving columns and joins."""
+        distinct_match = re.search(r"\bDISTINCT\b", sql_upper[:20])
+        has_distinct = distinct_match is not None
+        from_match = re.search(r"\bFROM\b", sql_upper)
+
+        if not from_match:
+            return None
+
+        from_pos = from_match.start()
+
+        if has_distinct:
+            distinct_end = distinct_match.end()
+            select_part = sql[distinct_end:from_pos].strip()
+        else:
+            select_part = sql[6:from_pos].strip()
+
+        first_column = self._extract_first_column(select_part)
+        select_clause = "SELECT DISTINCT" if has_distinct else "SELECT"
+
+        from_part = sql[from_pos:]
+        table_match = re.search(r'FROM\s+(["\[]?)(\w+)', from_part, re.IGNORECASE)
+
+        if not table_match:
+            return None
+
+        table_name = table_match.group(2)
+        result = f"{select_clause} {first_column} FROM {table_name}"
+
+        # Add joins if they fit
+        join_result = self._add_joins_if_fit(result, from_part)
+        if join_result:
+            return join_result
+
+        return result if len(result) <= self.max_length else None
+
+    def _extract_first_column(self, select_part):
+        """Extract the first column from SELECT clause, handling quotes and parentheses."""
+        if not select_part.strip():
+            return "..."
+        columns = self._parse_columns(select_part)
+        return columns[0] + ", ..." if columns else "..."
+
+    def _parse_columns(self, select_part):
+        """Parse columns from SELECT clause, handling complex expressions."""
+        columns = []
+        in_quotes = False
+        quote_char = None
+        in_parens = False
+        paren_depth = 0
+        current_col = ""
+
+        for i, char in enumerate(select_part):
+            if char in ('"', "'") and (i == 0 or select_part[i - 1] != "\\"):
+                if not in_quotes:
+                    in_quotes = True
+                    quote_char = char
+                elif char == quote_char:
+                    in_quotes = False
+                    quote_char = None
+                current_col += char
+            elif in_quotes:
+                current_col += char
+            elif char == "(":
+                in_parens = True
+                paren_depth += 1
+                current_col += char
+            elif char == ")":
+                paren_depth -= 1
+                if paren_depth == 0:
+                    in_parens = False
+                current_col += char
+            elif char == "," and not in_parens and not in_quotes:
+                if current_col.strip():
+                    columns.append(current_col.strip())
+                    break
+                current_col = ""
+            elif char in " \t\n" and not in_parens and not in_quotes:
+                if current_col.strip():
+                    columns.append(current_col.strip())
+                current_col = ""
+            else:
+                current_col += char
+
+        if not columns and current_col.strip():
+            columns.append(current_col.strip())
+
+        return columns
+
+    def _add_joins_if_fit(self, base_result, from_part):
+        """Add JOIN clauses to result if they fit within max_length."""
+        join_matches = re.finditer(
+            r'\b(LEFT\s+|RIGHT\s+|INNER\s+|OUTER\s+)?JOIN\s+(["\[]?)(\w+)',
+            from_part,
+            re.IGNORECASE,
+        )
+
+        result = base_result
+
+        for join_match in join_matches:
+            join_type = (join_match.group(1) or "").strip()
+            join_table = join_match.group(3)
+            new_result = (
+                f"{result} {join_type} JOIN {join_table}"
+                if join_type
+                else f"{result} JOIN {join_table}"
+            )
+            if len(new_result) <= self.max_length:
+                result = new_result
+            else:
+                break
+
+        return result if len(result) <= self.max_length else None
+
+    def _fallback_truncate(self, sql):
+        """Fallback truncation at clause boundaries or simple length limit."""
+        # First try simple length truncation
+        if len(sql) <= self.max_length:
+            return sql
+
+        # Try clause boundary truncation
+        clause_positions = [
+            (match.start(), match.group())
+            for match in SQL_CLAUSES_RE.finditer(sql[: self.max_length + 50])
+        ]
+
+        if clause_positions:
+            best_pos = self._find_best_truncate_position(clause_positions)
+            if best_pos > 0:
+                return sql[:best_pos].rstrip() + "..."
+
+        # Final fallback: simple truncation
+        return sql[: self.max_length].rstrip() + "..."
+
+    def _find_best_truncate_position(self, clause_positions):
+        """Find the best position to truncate based on clause boundaries."""
+        best_pos = 0
+        for pos, _ in clause_positions:
+            if self.max_length > pos > best_pos:
+                best_pos = pos
+
+        if best_pos > self.max_length - 30:
+            best_pos = 0
+
+        return best_pos
+
+
+def truncate_sql(sql, max_length=150):
+    truncator = SQLTruncator(max_length)
+    return truncator.truncate(sql)
+
+
+def tracking_wrapper(execute, sql, params, many, context):
+    start = perf_counter()
+    try:
+        return execute(sql, params, many, context)
+    finally:
+        _record(sql, params, (perf_counter() - start) * 1000)

django_devbar-0.4.0/src/django_devbar/tracker.py

@@ -1,60 +0,0 @@
-from contextvars import ContextVar
-from time import perf_counter
-
-_query_count: ContextVar[int] = ContextVar("query_count", default=0)
-_query_duration: ContextVar[float] = ContextVar("query_duration", default=0.0)
-_seen_queries: ContextVar[dict] = ContextVar("seen_queries", default={})
-_duplicate_log: ContextVar[list] = ContextVar("duplicate_log", default=[])
-
-
-def reset():
-    _query_count.set(0)
-    _query_duration.set(0.0)
-    _seen_queries.set({})
-    _duplicate_log.set([])
-
-
-def get_stats():
-    return {
-        "count": _query_count.get(),
-        "duration": _query_duration.get(),
-        "duplicate_queries": _duplicate_log.get(),
-    }
-
-
-def _hash_params(params):
-    try:
-        return hash(tuple(params)) if params else 0
-    except TypeError:
-        return hash(str(params))
-
-
-def _record(sql, params, duration):
-    _query_count.set(_query_count.get() + 1)
-    _query_duration.set(_query_duration.get() + duration)
-
-    seen = _seen_queries.get()
-    params_hash = _hash_params(params)
-
-    if sql in seen:
-        if params_hash in seen[sql]:
-            param_str = str(params)
-            if len(param_str) > 200:
-                param_str = param_str[:200] + "..."
-
-            duplicates = _duplicate_log.get()
-            duplicates.append(
-                {"sql": sql, "params": param_str, "duration": round(duration, 2)}
-            )
-        else:
-            seen[sql].add(params_hash)
-    else:
-        seen[sql] = {params_hash}
-
-
-def tracking_wrapper(execute, sql, params, many, context):
-    start = perf_counter()
-    try:
-        return execute(sql, params, many, context)
-    finally:
-        _record(sql, params, (perf_counter() - start) * 1000)