plain.admin 0.33.2__tar.gz → 0.35.0__tar.gz

{plain_admin-0.33.2 → plain_admin-0.35.0}/.gitignore

@@ -4,7 +4,6 @@
 *.py[co]
 __pycache__
 *.DS_Store
-.coverage
 
 # Test apps
 plain*/tests/.plain
@@ -17,4 +16,4 @@ plain*/tests/.plain
 # Plain temp dirs
 .plain
 
-coverage.xml
+.vscode

{plain_admin-0.33.2 → plain_admin-0.35.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.admin
-Version: 0.33.2
+Version: 0.35.0
 Summary: Admin dashboard and tools for Plain.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause
@@ -10,7 +10,6 @@ Requires-Dist: plain-auth<1.0.0
 Requires-Dist: plain-htmx<1.0.0
 Requires-Dist: plain-tailwind<1.0.0
 Requires-Dist: plain<1.0.0
-Requires-Dist: sqlparse>=0.2.2
 Description-Content-Type: text/markdown
 
 # plain.admin
@@ -203,7 +202,3 @@ TODO
 ## Impersonate
 
 TODO
-
-## Querystats
-
-TODO

{plain_admin-0.33.2 → plain_admin-0.35.0}/plain/admin/CHANGELOG.md

@@ -1,5 +1,27 @@
 # plain-admin changelog
 
+## [0.35.0](https://github.com/dropseed/plain/releases/plain-admin@0.35.0) (2025-07-18)
+
+### What's changed
+
+- The built-in QueryStats functionality has been completely removed from plain-admin in favor of the new OpenTelemetry-based observability tools in the `plain-observer` package ([b0224d0](https://github.com/dropseed/plain/commit/b0224d0))
+- QueryStats documentation has been removed from the admin README ([97fb69d](https://github.com/dropseed/plain/commit/97fb69d))
+
+### Upgrade instructions
+
+- Remove any querystats-related settings like `ADMIN_QUERYSTATS_IGNORE_URLS` from your configuration
+
+## [0.34.0](https://github.com/dropseed/plain/releases/plain-admin@0.34.0) (2025-07-18)
+
+### What's changed
+
+- The admin toolbar now automatically expands when an exception occurs, making it easier to immediately see exception details ([55a6eaf](https://github.com/dropseed/plain/commit/55a6eaf))
+- The admin toolbar now remembers your custom height preference when resized, persisting across page reloads and browser sessions ([b8db44b](https://github.com/dropseed/plain/commit/b8db44b))
+
+### Upgrade instructions
+
+- No changes required
+
 ## [0.33.2](https://github.com/dropseed/plain/releases/plain-admin@0.33.2) (2025-07-07)
 
 ### What's changed

{plain_admin-0.33.2 → plain_admin-0.35.0}/plain/admin/README.md

@@ -188,7 +188,3 @@ TODO
 ## Impersonate
 
 TODO
-
-## Querystats
-
-TODO

{plain_admin-0.33.2 → plain_admin-0.35.0}/plain/admin/assets/toolbar/toolbar.js

@@ -43,6 +43,10 @@ const plainToolbar = {
     document.querySelector("#plaintoolbar-details").classList.add("hidden");
     localStorage.setItem("plaintoolbar.expanded", "0");
   },
+  expandTemporary: function () {
+    this.expanded = true;
+    document.querySelector("#plaintoolbar-details").classList.remove("hidden");
+  },
   showTab: function (tabName) {
     this.expand();
 
@@ -74,6 +78,15 @@ const plainToolbar = {
     }
     localStorage.setItem("plaintoolbar.tab", tabName);
   },
+  resetHeight: () => {
+    const content = document.querySelector(
+      "#plaintoolbar-details [data-resizer]",
+    )?.nextElementSibling;
+    if (content) {
+      content.style.height = "";
+      localStorage.removeItem("plaintoolbar.height");
+    }
+  },
 };
 
 // Render it hidden immediately if the user has hidden it before
@@ -91,10 +104,28 @@ window.addEventListener("load", () => {
     if (lastTab) {
       plainToolbar.showTab(lastTab);
     }
+    // Restore custom height if it was set
+    const savedHeight = localStorage.getItem("plaintoolbar.height");
+    if (savedHeight) {
+      const content = document.querySelector(
+        "#plaintoolbar-details [data-resizer]",
+      )?.nextElementSibling;
+      if (content) {
+        content.style.height = savedHeight;
+      }
+    }
   } else if (state === "0") {
     plainToolbar.collapse();
   }
   const toolbar = document.querySelector("#plaintoolbar");
+  const hasException = toolbar.querySelector('[data-toolbar-tab="Exception"]');
+
+  if (hasException) {
+    plainToolbar.show();
+    if (!plainToolbar.expanded) {
+      plainToolbar.expandTemporary();
+    }
+  }
 
   for (const tab of toolbar.querySelectorAll("button[data-toolbar-tab]")) {
     tab.addEventListener("click", () => {
@@ -160,6 +191,8 @@ window.addEventListener("load", () => {
           isDragging = false;
           handle.style.cursor = "grab";
           document.body.style.userSelect = "";
+          // Save the new height to localStorage
+          localStorage.setItem("plaintoolbar.height", content.style.height);
         }
       });
     }

plain_admin-0.35.0/plain/admin/default_settings.py

@@ -0,0 +1,2 @@
+ADMIN_TOOLBAR_CLASS = "plain.admin.toolbar.Toolbar"
+ADMIN_TOOLBAR_VERSION: str = "dev"

{plain_admin-0.33.2 → plain_admin-0.35.0}/plain/admin/middleware.py

@@ -1,5 +1,4 @@
 from .impersonate.middleware import ImpersonateMiddleware
-from .querystats.middleware import QueryStatsMiddleware
 
 
 class AdminMiddleware:
@@ -9,4 +8,4 @@ class AdminMiddleware:
         self.get_response = get_response
 
     def __call__(self, request):
-        return QueryStatsMiddleware(ImpersonateMiddleware(self.get_response))(request)
+        return ImpersonateMiddleware(self.get_response)(request)

plain_admin-0.35.0/plain/admin/templates/toolbar/exception_button.html

@@ -0,0 +1,5 @@
+<button class="cursor-pointer text-amber-500 hover:text-amber-400" type="button" data-toolbar-tab="{{ panel.name }}">
+    <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="w-4 h-4 bi bi-exclamation-triangle-fill" viewBox="0 0 16 16">
+        <path d="M8.982 1.566a1.13 1.13 0 0 0-1.96 0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889 0 1.438-.99.98-1.767zM8 5c.535 0 .954.462.9.995l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 5.995A.905.905 0 0 1 8 5m.002 6a1 1 0 1 1 0 2 1 1 0 0 1 0-2"/>
+    </svg>
+</button>

{plain_admin-0.33.2 → plain_admin-0.35.0}/plain/admin/templates/toolbar/toolbar.html

@@ -58,17 +58,13 @@
         </div>
         <button type="button" data-plaintoolbar-expand class="flex-grow cursor-pointer"></button>
         <div class="flex items-center space-x-4">
-            {% include "querystats/toolbar.html" %}
-
             <div class="flex items-center space-x-3 transition-all">
 
-                {% if toolbar.request_exception() %}
-                <button class="cursor-pointer text-amber-500 hover:text-amber-400" type="button" data-toolbar-tab="Exception">
-                    <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="w-4 h-4 bi bi-exclamation-triangle-fill" viewBox="0 0 16 16">
-                        <path d="M8.982 1.566a1.13 1.13 0 0 0-1.96 0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889 0 1.438-.99.98-1.767zM8 5c.535 0 .954.462.9.995l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 5.995A.905.905 0 0 1 8 5m.002 6a1 1 0 1 1 0 2 1 1 0 0 1 0-2"/>
-                    </svg>
-                </button>
+                {% for panel in panels %}
+                {% if panel.button_template_name %}
+                {{ panel.render_button() }}
                 {% endif %}
+                {% endfor %}
 
                 <a href="{{ url('admin:index') }}" class="hover:underline">Admin</a>
 

{plain_admin-0.33.2 → plain_admin-0.35.0}/plain/admin/toolbar.py

@@ -49,6 +49,7 @@ class Toolbar:
 class ToolbarPanel:
     name: str
     template_name: str
+    button_template_name: str = ""
 
     def __init__(self, request):
         self.request = request
@@ -63,6 +64,14 @@ class ToolbarPanel:
         context = self.get_template_context()
         return mark_safe(template.render(context))
 
+    def render_button(self):
+        """Render the toolbar button for the minimized state."""
+        if not self.button_template_name:
+            return ""
+        template = Template(self.button_template_name)
+        context = self.get_template_context()
+        return mark_safe(template.render(context))
+
 
 class _ToolbarPanelRegistry:
     def __init__(self):
@@ -86,6 +95,7 @@ def register_toolbar_panel(panel_class):
 class _ExceptionToolbarPanel(ToolbarPanel):
     name = "Exception"
     template_name = "toolbar/exception.html"
+    button_template_name = "toolbar/exception_button.html"
 
     def __init__(self, request, exception):
         super().__init__(request)
@@ -101,9 +111,3 @@ class _ExceptionToolbarPanel(ToolbarPanel):
 class _RequestToolbarPanel(ToolbarPanel):
     name = "Request"
     template_name = "toolbar/request.html"
-
-
-@register_toolbar_panel
-class _QuerystatsToolbarPanel(ToolbarPanel):
-    name = "Queries"
-    template_name = "toolbar/querystats.html"

{plain_admin-0.33.2 → plain_admin-0.35.0}/plain/admin/urls.py

@@ -2,7 +2,6 @@ from plain.http import ResponseRedirect
 from plain.urls import Router, include, path
 
 from .impersonate.urls import ImpersonateRouter
-from .querystats.urls import QuerystatsRouter
 from .views.base import AdminView
 from .views.registry import registry
 
@@ -36,7 +35,6 @@ class AdminRouter(Router):
     urls = [
         path("search/", AdminSearchView, name="search"),
         include("impersonate/", ImpersonateRouter),
-        include("querystats/", QuerystatsRouter),
         include("", registry.get_urls()),
         path("", AdminIndexView, name="index"),
     ]

{plain_admin-0.33.2 → plain_admin-0.35.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain.admin"
-version = "0.33.2"
+version = "0.35.0"
 description = "Admin dashboard and tools for Plain."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 license = "BSD-3-Clause"
@@ -11,7 +11,6 @@ dependencies = [
     "plain.auth<1.0.0",
     "plain.htmx<1.0.0",
     "plain.tailwind<1.0.0",
-    "sqlparse>=0.2.2",
 ]
 
 [tool.uv]

plain_admin-0.33.2/plain/admin/default_settings.py

@@ -1,8 +0,0 @@
-ADMIN_TOOLBAR_CLASS = "plain.admin.toolbar.Toolbar"
-ADMIN_TOOLBAR_VERSION: str = "dev"
-
-ADMIN_QUERYSTATS_IGNORE_URLS: list[str] = [
-    "/assets/.*",
-    "/admin/querystats/.*",
-    "/favicon.ico",
-]

plain_admin-0.33.2/plain/admin/querystats/README.md

@@ -1,146 +0,0 @@
-# plain.querystats
-
-On-page database query stats in development and production.
-
-On each page, the query stats will display how many database queries were performed and how long they took.
-
-[Watch on YouTube](https://www.youtube.com/watch?v=NX8VXxVJm08)
-
-Clicking the stats in the toolbar will show the full SQL query log with tracebacks and timings.
-This is even designed to work in production,
-making it much easier to discover and debug performance issues on production data!
-
-![Django query stats](https://user-images.githubusercontent.com/649496/213781593-54197bb6-36a8-4c9d-8294-5b43bd86a4c9.png)
-
-It will also point out duplicate queries,
-which can typically be removed by using `select_related`,
-`prefetch_related`, or otherwise refactoring your code.
-
-## Installation
-
-```python
-# settings.py
-INSTALLED_PACKAGES = [
-    # ...
-    "plain.admin.querystats",
-]
-
-MIDDLEWARE = [
-    "plain.sessions.middleware.SessionMiddleware",
-    "plain.auth.middleware.AuthenticationMiddleware",
-
-    "plain.admin.querystats.QueryStatsMiddleware",
-    # Put additional middleware below querystats
-    # ...
-]
-```
-
-We strongly recommend using the plain-toolbar along with this,
-but if you aren't,
-you can add the querystats to your frontend templates with this include:
-
-```html
-{% include "querystats/button.html" %}
-```
-
-_Note that you will likely want to surround this with an if `DEBUG` or `is_admin` check._
-
-To view querystats you need to send a POST request to `?querystats=store` (i.e. via a `<form>`),
-and the template include is the easiest way to do that.
-
-## Tailwind CSS
-
-This package is styled with [Tailwind CSS](https://tailwindcss.com/),
-and pairs well with [`plain-tailwind`](https://github.com/plainpackages/plain-tailwind).
-
-If you are using your own Tailwind implementation,
-you can modify the "content" in your Tailwind config to include any Plain packages:
-
-```js
-// tailwind.config.js
-module.exports = {
-  content: [
-    // ...
-    ".venv/lib/python*/site-packages/plain*/**/*.{html,js}",
-  ],
-  // ...
-}
-```
-
-If you aren't using Tailwind, and don't intend to, open an issue to discuss other options.
-
-# plain.toolbar
-
-The admin toolbar is enabled for every user who `is_admin`.
-
-![Plain admin toolbar](https://user-images.githubusercontent.com/649496/213781915-a2094f54-99b8-4a05-a36e-dee107405229.png)
-
-## Installation
-
-Add `plaintoolbar` to your `INSTALLED_PACKAGES`,
-and the `{% toolbar %}` to your base template:
-
-```python
-# settings.py
-INSTALLED_PACKAGES += [
-    "plaintoolbar",
-]
-```
-
-```html
-<!-- base.template.html -->
-{% load toolbar %}
-<!doctype html>
-<html lang="en">
-  <head>
-    ...
-  </head>
-  <body>
-    {% toolbar %}
-    ...
-  </body>
-```
-
-More specific settings can be found below.
-
-## Tailwind CSS
-
-This package is styled with [Tailwind CSS](https://tailwindcss.com/),
-and pairs well with [`plain-tailwind`](https://github.com/plainpackages/plain-tailwind).
-
-If you are using your own Tailwind implementation,
-you can modify the "content" in your Tailwind config to include any Plain packages:
-
-```js
-// tailwind.config.js
-module.exports = {
-  content: [
-    // ...
-    ".venv/lib/python*/site-packages/plain*/**/*.{html,js}",
-  ],
-  // ...
-}
-```
-
-If you aren't using Tailwind, and don't intend to, open an issue to discuss other options.
-
-## Tailwind CSS
-
-This package is styled with [Tailwind CSS](https://tailwindcss.com/),
-and pairs well with [`plain-tailwind`](https://github.com/plainpackages/plain-tailwind).
-
-If you are using your own Tailwind implementation,
-you can modify the "content" in your Tailwind config to include any Plain packages:
-
-```js
-// tailwind.config.js
-module.exports = {
-  content: [
-    // ...
-    ".venv/lib/python*/site-packages/plain*/**/*.{html,js}",
-  ],
-  // ...
-}
-```
-
-If you aren't using Tailwind, and don't intend to, open an issue to discuss other options.

plain_admin-0.33.2/plain/admin/querystats/__init__.py

@@ -1,3 +0,0 @@
-from .middleware import QueryStatsMiddleware
-
-__all__ = ["QueryStatsMiddleware"]

plain_admin-0.33.2/plain/admin/querystats/core.py

@@ -1,155 +0,0 @@
-import datetime
-import time
-import traceback
-from collections import Counter
-from functools import cached_property
-
-import sqlparse
-
-IGNORE_STACK_FILES = [
-    "threading",
-    "concurrent/futures",
-    "functools.py",
-    "socketserver",
-    "wsgiref",
-    "gunicorn",
-    "whitenoise",
-    "sentry_sdk",
-    "querystats/core",
-    "plain/template/base",
-    "plain/models",
-    "plain/internal",
-]
-
-
-def pretty_print_sql(sql):
-    return sqlparse.format(sql, reindent=True, keyword_case="upper")
-
-
-def get_stack():
-    return "".join(tidy_stack(traceback.format_stack()))
-
-
-def tidy_stack(stack):
-    lines = []
-
-    skip_next = False
-
-    for line in stack:
-        if skip_next:
-            skip_next = False
-            continue
-
-        if line.startswith('  File "') and any(
-            ignore in line for ignore in IGNORE_STACK_FILES
-        ):
-            skip_next = True
-            continue
-
-        lines.append(line)
-
-    return lines
-
-
-class QueryStats:
-    def __init__(self, include_tracebacks):
-        self.queries = []
-        self.include_tracebacks = include_tracebacks
-
-    def __str__(self):
-        s = f"{self.num_queries} queries in {self.total_time_display}"
-        if self.duplicate_queries:
-            s += f" ({self.num_duplicate_queries} duplicates)"
-        return s
-
-    def __call__(self, execute, sql, params, many, context):
-        current_query = {"sql": sql, "params": params, "many": many}
-        start = time.monotonic()
-
-        result = execute(sql, params, many, context)
-
-        if self.include_tracebacks:
-            current_query["tb"] = get_stack()
-
-        # if many, then X times is len(params)
-
-        # current_query["result"] = result
-
-        current_query["duration"] = time.monotonic() - start
-
-        self.queries.append(current_query)
-        return result
-
-    @cached_property
-    def total_time(self):
-        return sum(q["duration"] for q in self.queries)
-
-    @staticmethod
-    def get_time_display(seconds):
-        if seconds < 0.01:
-            return f"{seconds * 1000:.0f} ms"
-        return f"{seconds:.2f} seconds"
-
-    @cached_property
-    def total_time_display(self):
-        return self.get_time_display(self.total_time)
-
-    @cached_property
-    def num_queries(self):
-        return len(self.queries)
-
-    # @cached_property
-    # def models(self):
-    #     # parse table names from self.queries sql
-    #     table_names = [x for x in [q['sql'].split(' ')[2] for q in self.queries] if x]
-    #     models = connection.introspection.installed_models(table_names)
-    #     return models
-
-    @cached_property
-    def duplicate_queries(self):
-        sqls = [q["sql"] for q in self.queries]
-        duplicates = {k: v for k, v in Counter(sqls).items() if v > 1}
-        return duplicates
-
-    @cached_property
-    def num_duplicate_queries(self):
-        # Count the number of "excess" queries by getting how many there
-        # are minus the initial one (and potentially only one required)
-        return sum(self.duplicate_queries.values()) - len(self.duplicate_queries)
-
-    def as_summary_dict(self):
-        return {
-            "summary": str(self),
-            "total_time": self.total_time,
-            "num_queries": self.num_queries,
-            "num_duplicate_queries": self.num_duplicate_queries,
-        }
-
-    def as_context_dict(self, request):
-        # If we don't create a dict, the instance of this class
-        # is lost before we can use it in the template
-        for query in self.queries:
-            # Add some useful display info
-            query["duration_display"] = self.get_time_display(query["duration"])
-            query["sql_display"] = pretty_print_sql(query["sql"])
-            duplicates = self.duplicate_queries.get(query["sql"], 0)
-            if duplicates:
-                query["duplicate_count"] = duplicates
-
-        return {
-            **self.as_summary_dict(),
-            "request": {
-                "path": request.path,
-                "method": request.method,
-                "unique_id": request.unique_id,
-            },
-            "timestamp": datetime.datetime.now().isoformat(),
-            "total_time_display": self.total_time_display,
-            "queries": self.queries,
-        }
-
-    def as_server_timing(self):
-        duration = self.total_time * 1000  # put in ms
-        duration = round(duration, 2)
-        description = str(self)
-        return f'querystats;dur={duration};desc="{description}"'

plain_admin-0.33.2/plain/admin/querystats/middleware.py

@@ -1,102 +0,0 @@
-import json
-import logging
-import re
-
-from plain.json import PlainJSONEncoder
-from plain.models import db_connection
-from plain.runtime import settings
-
-from .core import QueryStats
-
-try:
-    import psycopg
-except ImportError:
-    psycopg = None
-
-logger = logging.getLogger(__name__)
-
-
-class QueryStatsJSONEncoder(PlainJSONEncoder):
-    def default(self, obj):
-        try:
-            return super().default(obj)
-        except TypeError:
-            if psycopg and isinstance(obj, psycopg.types.json.Json):
-                return obj.obj
-            elif psycopg and isinstance(obj, psycopg.types.json.Jsonb):
-                return obj.obj
-            else:
-                raise
-
-
-class QueryStatsMiddleware:
-    def __init__(self, get_response):
-        self.get_response = get_response
-        self.ignore_url_patterns = [
-            re.compile(url) for url in settings.ADMIN_QUERYSTATS_IGNORE_URLS
-        ]
-
-    def should_ignore_request(self, request):
-        for url in self.ignore_url_patterns:
-            if url.match(request.path):
-                return True
-
-        return False
-
-    def __call__(self, request):
-        """
-        Enables querystats for the current request.
-
-        If DEBUG or an admin, then Server-Timing headers are always added to the response.
-        Full querystats are only stored in the session if they are manually enabled.
-        """
-
-        if self.should_ignore_request(request):
-            return self.get_response(request)
-
-        def is_tracking():
-            return "querystats" in request.session
-
-        querystats = QueryStats(include_tracebacks=is_tracking())
-
-        with db_connection.execute_wrapper(querystats):
-            is_admin = self.is_admin_request(request)
-
-        if settings.DEBUG or is_admin:
-            with db_connection.execute_wrapper(querystats):
-                response = self.get_response(request)
-
-            if settings.DEBUG:
-                # TODO logging settings
-                logger.debug("Querystats: %s", querystats)
-
-            # Make current querystats available on the current page
-            # by using the server timing API which can be parsed client-side
-            response.headers["Server-Timing"] = querystats.as_server_timing()
-
-            if is_tracking() and querystats.num_queries > 0:
-                request.session["querystats"][request.unique_id] = json.dumps(
-                    querystats.as_context_dict(request), cls=QueryStatsJSONEncoder
-                )
-
-                # Keep 30 requests max, in case it is left on by accident
-                if len(request.session["querystats"]) > 30:
-                    del request.session["querystats"][
-                        list(request.session["querystats"])[0]
-                    ]
-
-                # Did a deeper modification to the session dict...
-                request.session.modified = True
-
-            return response
-
-        else:
-            return self.get_response(request)
-
-    @staticmethod
-    def is_admin_request(request):
-        if getattr(request, "impersonator", None):
-            # Support for impersonation (still want the real admin user to see the querystats)
-            return request.impersonator and request.impersonator.is_admin
-
-        return hasattr(request, "user") and request.user and request.user.is_admin