plain.admin 0.25.1__tar.gz → 0.26.0__tar.gz

{plain_admin-0.25.1 → plain_admin-0.26.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.admin
-Version: 0.25.1
+Version: 0.26.0
 Summary: Admin dashboard and tools for Plain.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause

plain_admin-0.26.0/plain/admin/default_settings.py

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

{plain_admin-0.25.1 → plain_admin-0.26.0}/plain/admin/querystats/core.py

@@ -8,6 +8,8 @@ from plain.utils.functional import cached_property
 
 IGNORE_STACK_FILES = [
     "threading",
+    "concurrent/futures",
+    "functools.py",
     "socketserver",
     "wsgiref",
     "gunicorn",
@@ -15,11 +17,8 @@ IGNORE_STACK_FILES = [
     "sentry_sdk",
     "querystats/core",
     "plain/template/base",
-    "plain/utils/decorators",
-    "plain/db",
-    "plain/utils/functional",
-    "plain/core/servers",
-    "plain/core/handlers",
+    "plain/models",
+    "plain/internal",
 ]
 
 
@@ -74,7 +73,7 @@ class QueryStats:
 
         # if many, then X times is len(params)
 
-        current_query["result"] = result
+        # current_query["result"] = result
 
         current_query["duration"] = time.monotonic() - start
 
@@ -126,7 +125,7 @@ class QueryStats:
             "num_duplicate_queries": self.num_duplicate_queries,
         }
 
-    def as_context_dict(self):
+    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:
@@ -137,10 +136,15 @@ class QueryStats:
             if duplicates:
                 query["duplicate_count"] = duplicates
 
-        summary = self.as_summary_dict()
-
         return {
-            **summary,
+            **self.as_summary_dict(),
+            "request": {
+                "path": request.path,
+                "method": request.method,
+                "headers": dict(request.headers),
+                "unique_id": request.unique_id,
+            },
+            "timestamp": time.time(),
             "total_time_display": self.total_time_display,
             "queries": self.queries,
         }

{plain_admin-0.25.1 → plain_admin-0.26.0}/plain/admin/querystats/middleware.py

@@ -1,26 +1,19 @@
 import json
 import logging
 import re
-import threading
 
-from plain.http import ResponseRedirect
 from plain.json import PlainJSONEncoder
 from plain.models import connection
 from plain.runtime import settings
-from plain.urls import reverse
 
 from .core import QueryStats
 
 try:
-    try:
-        import psycopg
-    except ImportError:
-        import psycopg2 as psycopg
+    import psycopg
 except ImportError:
     psycopg = None
 
 logger = logging.getLogger(__name__)
-_local = threading.local()
 
 
 class QueryStatsJSONEncoder(PlainJSONEncoder):
@@ -28,8 +21,11 @@ class QueryStatsJSONEncoder(PlainJSONEncoder):
         try:
             return super().default(obj)
         except TypeError:
-            if psycopg and isinstance(obj, psycopg._json.Json):
-                return obj.adapted
+            print(type(obj))
+            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
 
@@ -38,7 +34,7 @@ class QueryStatsMiddleware:
     def __init__(self, get_response):
         self.get_response = get_response
         self.ignore_url_patterns = [
-            re.compile(url) for url in settings.QUERYSTATS_IGNORE_URLS
+            re.compile(url) for url in settings.ADMIN_QUERYSTATS_IGNORE_URLS
         ]
 
     def should_ignore_request(self, request):
@@ -49,41 +45,49 @@ class QueryStatsMiddleware:
         return False
 
     def __call__(self, request):
-        if request.GET.get("querystats") == "disable":
+        """
+        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)
 
-        querystats = QueryStats(
-            # Only want these if we're getting ready to show it
-            include_tracebacks=request.GET.get("querystats") == "store"
-        )
+        session_querystats_enabled = "querystats" in request.session
 
+        querystats = QueryStats(include_tracebacks=session_querystats_enabled)
         with connection.execute_wrapper(querystats):
             # Have to wrap this first call so it is included in the querystats,
             # but we don't have to wrap everything else unless we are admin or debug
             is_admin = self.is_admin_request(request)
 
-        if (settings.DEBUG or is_admin) and not self.should_ignore_request(request):
-            # Persist it on the thread
-            _local.querystats = querystats
-
-            with connection.execute_wrapper(_local.querystats):
+        if settings.DEBUG or is_admin:
+            with connection.execute_wrapper(querystats):
                 response = self.get_response(request)
 
             if settings.DEBUG:
                 # TODO logging settings
-                logger.debug("Querystats: %s", _local.querystats)
+                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"] = _local.querystats.as_server_timing()
+            response.headers["Server-Timing"] = querystats.as_server_timing()
 
-            if request.GET.get("querystats") == "store":
-                request.session["querystats"] = json.dumps(
-                    _local.querystats.as_context_dict(), cls=QueryStatsJSONEncoder
+            if session_querystats_enabled and querystats.num_queries > 0:
+                request.session["querystats"][request.unique_id] = json.dumps(
+                    querystats.as_context_dict(request), cls=QueryStatsJSONEncoder
                 )
-                return ResponseRedirect(reverse("querystats:querystats"))
 
-            del _local.querystats
+                # 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
 

plain_admin-0.26.0/plain/admin/querystats/views.py

@@ -0,0 +1,48 @@
+import json
+
+from plain.auth.views import AuthViewMixin
+from plain.http import ResponseRedirect
+from plain.views import TemplateView
+
+
+class QuerystatsView(AuthViewMixin, TemplateView):
+    template_name = "querystats/querystats.html"
+    admin_required = True
+
+    def get_template_context(self):
+        context = super().get_template_context()
+
+        querystats = self.request.session.get("querystats", {})
+
+        for request_id, json_data in querystats.items():
+            try:
+                querystats[request_id] = json.loads(json_data)
+            except json.JSONDecodeError:
+                # If decoding fails, remove the entry from the dictionary
+                del querystats[request_id]
+
+        # Order them by timestamp
+        querystats = dict(
+            sorted(
+                querystats.items(),
+                key=lambda item: item[1].get("timestamp", ""),
+                reverse=True,
+            )
+        )
+
+        context["querystats"] = querystats
+
+        return context
+
+    def post(self):
+        querystats_action = self.request.POST["querystats_action"]
+
+        if querystats_action == "enable":
+            self.request.session.setdefault("querystats", {})
+        elif querystats_action == "clear":
+            self.request.session["querystats"] = {}
+        elif querystats_action == "disable" and "querystats" in self.request.session:
+            del self.request.session["querystats"]
+
+        # Redirect back to the page that submitted the form
+        return ResponseRedirect(self.request.POST.get("redirect_url", "."))

plain_admin-0.26.0/plain/admin/templates/querystats/querystats.html

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Querystats</title>
+    {% tailwind_css %}
+</head>
+<body class="bg-stone-950 text-stone-300">
+
+    <div class="flex items-center justify-between px-6 py-4">
+        <h1 class="text-lg font-semibold">Querystats</h1>
+        <div class="flex items-center space-x-2">
+            <form method="post" action=".">
+                {{ csrf_input }}
+                <input type="hidden" name="querystats_action" value="clear">
+                <button type="submit" class="px-2 py-px text-sm rounded-sm bg-stone-700 text-stone-300 hover:bg-stone-600 cursor-pointer whitespace-nowrap">Clear</button>
+            </form>
+            <form method="post" action=".">
+                {{ csrf_input }}
+                <input type="hidden" name="querystats_action" value="disable">
+                <button type="submit" class="px-2 py-px text-sm rounded-sm bg-stone-700 text-stone-300 hover:bg-stone-600 cursor-pointer whitespace-nowrap">Disable</button>
+            </form>
+        </div>
+    </div>
+
+    <div class="space-y-6 px-6 py-4">
+        {% for request_id, qs in querystats.items() %}
+        <div class="p-3 bg-white/5 rounded">
+            <div class="flex justify-between items-center">
+                <div>
+                    <h2 class="font-medium"><span class="font-semibold">{{ qs.request.method }}</span> {{ qs.request.path }}</h2>
+                    <p class="text-sm text-stone-400">{{ qs.summary }}</p>
+                </div>
+                <div class=text-xs>
+                    <p>Request ID <code>{{ qs.request.unique_id }}</code></p>
+                    <p>Timestamp {{ qs.timestamp }}</p>
+                    <details>
+                        <summary>Headers</summary>
+                        <pre><code>{{ qs.request.get("headers", {})|pprint }}</code></pre>
+                    </details>
+                </div>
+            </div>
+
+            <div class="flex w-full mt-5 overflow-auto rounded-sm">
+                {% for query in qs.queries %}
+                <a href="#query-{{ loop.index }}"
+                    {{ loop.cycle('class=\"h-4 bg-amber-300\"', 'class=\"h-4 bg-amber-400\"', 'class="h-4 bg-amber-500"', 'class="h-4 bg-amber-600"')|safe }}
+                    title="[{{ query.duration_display }}] {{ query.sql_display }}"
+                    style="width: {{ query.duration / qs.total_time * 100 }}%">
+                </a>
+                {% endfor %}
+            </div>
+
+            <div class="mt-4 space-y-3 text-xs">
+                {% for query in qs.queries %}
+                <details id="query-{{ loop.index }}" class="p-2 rounded bg-zinc-800">
+                    <summary class="truncate">
+                        <div class="float-right px-2 py-px mb-px ml-2 text-xs rounded-full bg-zinc-700">
+                            <span>{{ query.duration_display }}</span>
+                            {% if query.duplicate_count is defined %}
+                            <span class="text-red-500">&nbsp; duplicated {{ query.duplicate_count }} times</span>
+                            {% endif %}
+
+                            {#
+                            <div>many {{ query.many }}</div>
+                            <div>result {{ query.result }}</div>
+                            #}
+                        </div>
+                        <code class="font-mono">{{ query.sql }}</code>
+                    </summary>
+                    <div class="space-y-3 mt-3">
+                        <div>
+                            <pre><code class="font-mono whitespace-pre-wrap text-zinc-100">{{ query.sql_display }}</code></pre>
+                        </div>
+                        <div class="text-zinc-400">
+                            <span class="font-medium">Parameters</span>
+                            <pre><code class="font-mono">{{ query.params|pprint }}</code></pre>
+                        </div>
+                        <details>
+                            <summary>Traceback</summary>
+                            <pre><code class="block overflow-x-auto font-mono text-xs">{{ query.tb }}</code></pre>
+                        </details>
+                    </div>
+                </details>
+                {% else %}
+                <div>No queries...</div>
+                {% endfor %}
+            </div>
+        </div>
+
+        {% else %}
+
+        <div class="text-center">
+            {% if "querystats" in request.session %}
+            <div class="text-stone-500">Querystats are enabled but nothing has been tracked yet.</div>
+            {% else %}
+            <form method="post" action=".">
+                {{ csrf_input }}
+                <input type="hidden" name="querystats_action" value="enable">
+                <button type="submit" class="px-2 rounded-sm bg-stone-700 text-stone-300 hover:bg-stone-600 cursor-pointer whitespace-nowrap">Enable querystats</button>
+            </form>
+            {% endif %}
+        </div>
+
+        {% endfor %}
+    </div>
+
+</body>
+</html>

{plain_admin-0.25.1 → plain_admin-0.26.0}/plain/admin/templates/querystats/toolbar.html

@@ -1,13 +1,25 @@
-<form
-    data-querystats
-    action="."
-    method="get"
-    target="querystats"
-    class="relative group/querystats"
-    style="display: none;">
-    <input type="hidden" name="querystats" value="store">
-    <button type="submit" class="px-2 py-px text-xs rounded-full bg-stone-700 text-stone-300 whitespace-nowrap" data-querystats-summary></button>
-    <div data-querystats-list style="display: none;" class="absolute right-0 z-50 hidden translate-y-full -bottom-1 group/querystats-hover:block">
+<div data-querystats class="relative group/querystats" style="display: none;">
+    {% if "querystats" in request.session %}
+    <a href="{{ url('admin:querystats:querystats') }}" target="querystats" class="inline-flex items-center cursor-pointer text-xs rounded-full px-2 py-px bg-stone-700 text-stone-300 whitespace-nowrap">
+        <span class="relative inline-flex size-2 mr-2">
+            <span class="absolute inline-flex h-full w-full animate-ping rounded-full bg-green-400 opacity-75"></span>
+            <span class="relative inline-flex size-2 rounded-full bg-green-500"></span>
+        </span>
+        <span data-querystats-summary></span>
+    </a>
+    {% else %}
+    <form action="{{ url('admin:querystats:querystats') }}" method="post">
+        {{ csrf_input }}
+        <input type="hidden" name="redirect_url" value="{{ request.get_full_path() }}">
+        <input type="hidden" name="querystats_action" value="enable">
+        <button type="submit" class="cursor-pointer text-xs rounded-full px-2 py-px bg-stone-700 text-stone-300 whitespace-nowrap">
+            <span class="rounded-full bg-zinc-500 w-2 h-2 inline-block mr-1"></span>
+            <span data-querystats-summary></span>
+        </button>
+    </form>
+    {% endif %}
+
+    <div data-querystats-list style="display: none;" class="absolute z-50 -translate-x-1/2 hidden -translate-y-full left-1/2 -top-1 group-hover/querystats:block">
         <div class="p-2 text-xs border rounded shadow-md bg-zinc-900 border-zinc-700"><table><tbody></tbody></table></div>
     </div>
     <script async defer>
@@ -15,9 +27,8 @@
     // https://bugs.webkit.org/show_bug.cgi?id=209216
     var querystatsTimings = [];
     function renderQuerystats() {
-        // Render the most recent timing call
-        const latestTiming = querystatsTimings[querystatsTimings.length - 1];
-        let summary = latestTiming.description;
+        // Render the original timing call
+        let summary = querystatsTimings[0].description;
         if (querystatsTimings.length > 1) {
             summary += ` *`;
         }
@@ -47,7 +58,6 @@
         }
     }
     try {
-        // Create the performance observer.
         const po = new PerformanceObserver((list) => {
             for (const entry of list.getEntries()) {
                 if (!entry.serverTiming) {
@@ -55,15 +65,15 @@
                     return;
                 }
                 for (const timing of entry.serverTiming) {
-                    if (querystatsTimings.length > 0) {
-                        if (querystatsTimings[querystatsTimings.length - 1] === timing) {
-                            // Skip duplicate timings (happens on initial load...)
-                            continue;
-                        }
-                    }
                     if (timing.name === "querystats") {
                         console.log("Querystats timing", entry)
                         timing.url = entry.name;  // Store this for reference later
+                        for (const existingTiming of querystatsTimings) {
+                            if (existingTiming == timing) {
+                                // Skip duplicate timings (happens on initial load...)
+                                return;
+                            }
+                        }
                         querystatsTimings.push(timing);
                         renderQuerystats();
                     }
@@ -76,4 +86,4 @@
         // Do nothing if the browser doesn't support this API.
     }
     </script>
-</form>
+</div>

{plain_admin-0.25.1 → plain_admin-0.26.0}/plain/admin/templates.py

@@ -12,10 +12,10 @@ class ToolbarExtension(InclusionTagExtension):
     template_name = "toolbar/toolbar.html"
 
     def get_context(self, context, *args, **kwargs):
-        if isinstance(settings.TOOLBAR_CLASS, str):
-            cls = import_string(settings.TOOLBAR_CLASS)
+        if isinstance(settings.ADMIN_TOOLBAR_CLASS, str):
+            cls = import_string(settings.ADMIN_TOOLBAR_CLASS)
         else:
-            cls = settings.TOOLBAR_CLASS
+            cls = settings.ADMIN_TOOLBAR_CLASS
         context.vars["toolbar"] = cls(request=context["request"])
         return context
 

{plain_admin-0.25.1 → plain_admin-0.26.0}/plain/admin/toolbar.py

@@ -8,7 +8,7 @@ from plain.urls.exceptions import Resolver404
 class Toolbar:
     def __init__(self, request):
         self.request = request
-        self.version = settings.TOOLBAR_VERSION
+        self.version = settings.ADMIN_TOOLBAR_VERSION
         self.metadata = {
             "Request ID": request.unique_id,
         }

{plain_admin-0.25.1 → plain_admin-0.26.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain.admin"
-version = "0.25.1"
+version = "0.26.0"
 description = "Admin dashboard and tools for Plain."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 license = "BSD-3-Clause"

plain_admin-0.25.1/plain/admin/default_settings.py

@@ -1,4 +0,0 @@
-TOOLBAR_CLASS = "plain.admin.toolbar.Toolbar"
-TOOLBAR_VERSION: str = "dev"
-
-QUERYSTATS_IGNORE_URLS: list[str] = ["/assets/.*"]

plain_admin-0.25.1/plain/admin/querystats/views.py

@@ -1,27 +0,0 @@
-import json
-
-from plain.auth.views import AuthViewMixin
-from plain.views import TemplateView
-
-
-class QuerystatsView(AuthViewMixin, TemplateView):
-    template_name = "querystats/querystats.html"
-    admin_required = True  # allow impersonator?
-
-    def get_template_context(self):
-        context = super().get_template_context()
-
-        stored_querystats = self.request.session.get(
-            "querystats"
-        )  # Not popping so page can be reloaded
-        if stored_querystats:
-            # dates won't come back as Python dates...
-            stored_querystats = json.loads(stored_querystats)
-            context["querystats"] = stored_querystats
-
-        return context
-
-    def get_querystats(self):
-        from .middleware import _local
-
-        return _local.querystats

plain_admin-0.25.1/plain/admin/templates/querystats/querystats.html

@@ -1,78 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Document</title>
-    {% tailwind_css %}
-</head>
-<body>
-
-    <div class="px-6 py-4">
-        <div class="flex items-center justify-between">
-            <h2 class="text-xl font-medium">Query stats for {{ request.path }}</h2>
-            <div class="flex items-center">
-                <div class="pt-1">
-                    {{ querystats.summary }}
-                </div>
-
-                <form action="." method="get">
-                    <input type="hidden" name="querystats" value="store">
-                    <button type="submit" class="flex items-center px-3 py-2 ml-4 text-sm rounded-full bg-zinc-600 hover:bg-zinc-500">
-                        <svg xmlns="http://www.w3.org/2000/svg" class="w-4 h-4 mr-2" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-refresh-cw"><polyline points="23 4 23 10 17 10"></polyline><polyline points="1 20 1 14 7 14"></polyline><path d="M3.51 9a9 9 0 0 1 14.85-3.36L23 10M1 14l4.64 4.36A9 9 0 0 0 20.49 15"></path></svg>
-                        reload
-                    </button>
-                </form>
-            </div>
-        </div>
-        {#
-        <div class="mt-2 font-mono text-xs">
-            {{ querystats_resolver_match }}
-            and template {{ querystats_template_name }}
-        </div>
-        #}
-
-        <div class="flex w-full mt-5 overflow-auto rounded-sm">
-            {% for query in querystats.queries %}
-            <a href="#query-{{ loop.index }}"
-                {{ loop.cycle('class=\"h-4 bg-amber-400\"', 'class="h-4 bg-amber-500"', 'class="h-4 bg-amber-600"')|safe }}
-                title="[{{ query.duration_display }}] {{ query.sql_display }}"
-                style="width: {{ query.duration / querystats.total_time * 100 }}%">
-            </a>
-            {% endfor %}
-        </div>
-
-        <div class="mt-4 space-y-4 text-sm">
-            {% for query in querystats.queries %}
-            <div id="query-{{ loop.index }}" class="p-2 rounded bg-zinc-800">
-                <div class="float-right px-2 py-px mb-px ml-2 text-xs rounded-full bg-zinc-700">
-                    <span>{{ query.duration_display }}</span>
-                    {% if query.duplicate_count is defined %}
-                    <span class="text-red-500">&nbsp; duplicated {{ query.duplicate_count }} times</span>
-                    {% endif %}
-
-                    {#
-                    <div>many {{ query.many }}</div>
-                    <div>result {{ query.result }}</div>
-                    #}
-                </div>
-                <div>
-                    <pre><code class="font-mono whitespace-pre-wrap text-zinc-100">{{ query.sql_display }}</code></pre>
-                </div>
-                <div class="mt-3 text-zinc-400">
-                    <span class="font-medium">Parameters</span>
-                    <pre><code class="font-mono">{{ query.params|pprint }}</code></pre>
-                </div>
-                <details class="mt-3">
-                    <summary>Traceback</summary>
-                    <pre><code class="block overflow-x-auto font-mono text-xs">{{ query.tb }}</code></pre>
-                </details>
-            </div>
-            {% else %}
-            <div>No queries...</div>
-            {% endfor %}
-        </div>
-    </div>
-
-</body>
-</html>