plain.admin 0.27.0__tar.gz → 0.28.0__tar.gz

{plain_admin-0.27.0 → plain_admin-0.28.0}/PKG-INFO

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

plain_admin-0.28.0/plain/admin/assets/toolbar/toolbar.js

@@ -0,0 +1,162 @@
+// Make this available to the JS console for the user
+var plainToolbar = {
+  hide: function () {
+    // Hide by inserting a style so it doesn't flash on page load
+    var style = document.createElement("style");
+    style.innerHTML = "#plaintoolbar { display: none; }";
+    document.getElementsByTagName("head")[0].appendChild(style);
+    this.stylesheet = style;
+  },
+  show: function () {
+    localStorage.removeItem("plaintoolbar.hidden_until");
+    if (this.stylesheet) {
+      this.stylesheet.remove();
+    }
+  },
+  shouldHide: function () {
+    var hiddenUntil = localStorage.getItem("plaintoolbar.hidden_until");
+    if (hiddenUntil) {
+      if (Date.now() < hiddenUntil) {
+        return true;
+      } else {
+        localStorage.removeItem("plaintoolbar.hidden_until");
+        return false;
+      }
+    }
+    return false;
+  },
+  hideUntil: function (until) {
+    localStorage.setItem("plaintoolbar.hidden_until", until);
+    this.hide();
+  },
+  toggleExpand: function () {
+    this.expanded = !this.expanded;
+    document.querySelector("#plaintoolbar-details").classList.toggle("hidden");
+    localStorage.setItem('plaintoolbar.expanded', this.expanded ? '1' : '0');
+  },
+  expand: function () {
+    this.expanded = true;
+    document.querySelector("#plaintoolbar-details").classList.remove("hidden");
+    localStorage.setItem('plaintoolbar.expanded', '1');
+  },
+  collapse: function () {
+    this.expanded = false;
+    document.querySelector("#plaintoolbar-details").classList.add("hidden");
+    localStorage.setItem('plaintoolbar.expanded', '0');
+  },
+  showTab: function (tabName) {
+    this.expand();
+
+    var toolbar = document.querySelector("#plaintoolbar");
+    var tab = toolbar.querySelector("div[data-toolbar-tab=" + tabName + "]");
+
+    // Hide all children in the tab parent
+    for (var i = 0; i < tab.parentNode.children.length; i++) {
+      var child = tab.parentNode.children[i];
+      if (child !== tab) {
+        child.style.display = "none";
+      }
+    }
+
+    tab.style.display = "block";
+
+    toolbar.querySelectorAll("button[data-toolbar-tab]").forEach(function (tab) {
+      if (tab.dataset.toolbarTab === tabName) {
+        tab.setAttribute("data-active", true);
+      } else {
+        tab.removeAttribute("data-active");
+      }
+    });
+    localStorage.setItem('plaintoolbar.tab', tabName);
+  },
+};
+
+// Render it hidden immediately if the user has hidden it before
+if (plainToolbar.shouldHide()) {
+  plainToolbar.hide();
+}
+
+window.addEventListener("load", function() {
+  // Restore expanded/collapsed state
+  var state = localStorage.getItem('plaintoolbar.expanded');
+  if (state === '1') {
+    plainToolbar.expand();
+    // Restore last active tab
+    var lastTab = localStorage.getItem('plaintoolbar.tab');
+    if (lastTab) {
+      plainToolbar.showTab(lastTab);
+    }
+  } else if (state === '0') {
+    plainToolbar.collapse();
+  }
+  var toolbar = document.querySelector("#plaintoolbar");
+
+  toolbar.querySelectorAll("button[data-toolbar-tab]").forEach(function (tab) {
+    tab.addEventListener("click", function () {
+      plainToolbar.showTab(tab.dataset.toolbarTab);
+    });
+  });
+
+  toolbar.querySelectorAll('[data-plaintoolbar-hide]').forEach(function(btn) {
+    btn.addEventListener('click', function() {
+      plainToolbar.hide();
+    });
+  });
+
+  toolbar.querySelectorAll('[data-plaintoolbar-hideuntil]').forEach(function(btn) {
+    btn.addEventListener('click', function() {
+      console.log("Hiding admin toolbar for 1 hour");
+      plainToolbar.hideUntil(Date.now() + 3600000);
+    });
+  });
+
+  toolbar.querySelectorAll('[data-plaintoolbar-expand]').forEach(function(btn) {
+    btn.addEventListener('click', function() {
+      plainToolbar.toggleExpand();
+    });
+  });
+
+  // Enable manual resize of the expanded toolbar via drag handle
+  var details = document.getElementById('plaintoolbar-details');
+  if (details) {
+    var handle = details.querySelector('[data-resizer]');
+    var content = handle.nextElementSibling;
+    var isDragging = false;
+    var startY = 0;
+    var startHeight = 0;
+    if (handle && content) {
+      // Initial cursor
+      handle.style.cursor = 'grab';
+      // Start dragging
+      handle.addEventListener('mousedown', function(e) {
+        isDragging = true;
+        startY = e.clientY;
+        startHeight = content.offsetHeight;
+        handle.style.cursor = 'grabbing';
+        // Prevent text selection while dragging
+        document.body.style.userSelect = 'none';
+        e.preventDefault();
+      });
+      // Handle dragging
+      document.addEventListener('mousemove', function(e) {
+        if (!isDragging) return;
+        var delta = e.clientY - startY;
+        // Calculate new height: dragging up increases height
+        var newHeight = startHeight - delta;
+        // Clamp between reasonable bounds
+        var minHeight = 50;
+        var maxHeight = window.innerHeight - 100;
+        newHeight = Math.max(minHeight, Math.min(maxHeight, newHeight));
+        content.style.height = newHeight + 'px';
+      });
+      // End dragging
+      document.addEventListener('mouseup', function() {
+        if (isDragging) {
+          isDragging = false;
+          handle.style.cursor = 'grab';
+          document.body.style.userSelect = '';
+        }
+      });
+    }
+  }
+});

{plain_admin-0.27.0 → plain_admin-0.28.0}/plain/admin/querystats/core.py

@@ -141,7 +141,6 @@ class QueryStats:
             "request": {
                 "path": request.path,
                 "method": request.method,
-                "headers": dict(request.headers),
                 "unique_id": request.unique_id,
             },
             "timestamp": time.time(),

{plain_admin-0.27.0 → plain_admin-0.28.0}/plain/admin/querystats/middleware.py

@@ -55,15 +55,14 @@ class QueryStatsMiddleware:
         if self.should_ignore_request(request):
             return self.get_response(request)
 
-        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)
+        # Previously we wrapped this in execute_wrapper too,
+        # but now there's a chicken and the egg issue with "querystats" being by the view,
+        # which hasn't been processed yet (on the initial request)
+        is_admin = self.is_admin_request(request)
 
         if settings.DEBUG or is_admin:
+            tracking = "querystats" in request.session
+            querystats = QueryStats(include_tracebacks=tracking)
             with connection.execute_wrapper(querystats):
                 response = self.get_response(request)
 
@@ -75,7 +74,7 @@ class QueryStatsMiddleware:
             # by using the server timing API which can be parsed client-side
             response.headers["Server-Timing"] = querystats.as_server_timing()
 
-            if session_querystats_enabled and querystats.num_queries > 0:
+            if tracking and querystats.num_queries > 0:
                 request.session["querystats"][request.unique_id] = json.dumps(
                     querystats.as_context_dict(request), cls=QueryStatsJSONEncoder
                 )

{plain_admin-0.27.0 → plain_admin-0.28.0}/plain/admin/querystats/views.py

@@ -1,7 +1,9 @@
+import datetime
 import json
 
 from plain.auth.views import AuthViewMixin
 from plain.http import ResponseRedirect
+from plain.runtime import settings
 from plain.views import TemplateView
 
 
@@ -9,15 +11,39 @@ class QuerystatsView(AuthViewMixin, TemplateView):
     template_name = "querystats/querystats.html"
     admin_required = True
 
+    def check_auth(self):
+        # Allow the view if we're in DEBUG
+        if settings.DEBUG:
+            return
+
+        super().check_auth()
+
+    def get_response(self):
+        response = super().get_response()
+        # So we can load it in the toolbar
+        response.headers["X-Frame-Options"] = "SAMEORIGIN"
+        return response
+
+    def get(self):
+        # Give an easy out if things get messed up
+        if (
+            "clear" in self.request.query_params
+            and "querystats" in self.request.session
+        ):
+            del self.request.session["querystats"]
+            self.request.session.modified = True
+
+        return super().get()
+
     def get_template_context(self):
         context = super().get_template_context()
 
         querystats = self.request.session.get("querystats", {})
 
-        for request_id, json_data in querystats.items():
+        for request_id in list(querystats.keys()):
             try:
-                querystats[request_id] = json.loads(json_data)
-            except json.JSONDecodeError:
+                querystats[request_id] = json.loads(querystats[request_id])
+            except (json.JSONDecodeError, TypeError):
                 # If decoding fails, remove the entry from the dictionary
                 del querystats[request_id]
 
@@ -30,7 +56,12 @@ class QuerystatsView(AuthViewMixin, TemplateView):
             )
         )
 
+        # Convert the timestamps back to a python datetime object
+        for data in querystats.values():
+            data["timestamp"] = datetime.datetime.fromtimestamp(data["timestamp"])
+
         context["querystats"] = querystats
+        context["querystats_enabled"] = "querystats" in self.request.session
 
         return context
 

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

@@ -0,0 +1,142 @@
+<!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="text-stone-300">
+
+    {% if querystats_enabled %}
+    <div class="flex items-center justify-between border-b border-white/5 px-6 h-14 fixed top-0 left-0 right-0 bg-stone-950 z-10">
+        <!-- <h1 class="text-lg font-semibold">Querystats</h1> -->
+        <div></div>
+        <div class="flex items-center space-x-2">
+            <form method="get" action=".">
+                {{ csrf_input }}
+                <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">Reload</button>
+            </form>
+            <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>
+    {% endif %}
+
+    {% if querystats %}
+    <div class="flex mt-2 h-full">
+        <aside id="sidebar" class="fixed left-0 top-14 bottom-0 w-82 overflow-auto p-4">
+            <ul class="space-y-2">
+                {% for request_id, qs in querystats.items() %}
+                <li>
+                    <button data-request-id="{{ request_id }}" class="w-full text-left px-2 py-1 rounded hover:bg-stone-700 cursor-pointer">
+                        <span class="text-sm">{{ qs.request.path }}</span>
+                        <span class="font-semibold bg-white/5 rounded-sm px-1 py-0.5 text-xs">{{ qs.request.method }}</span>
+                        <div class="text-xs text-stone-400">{{ qs.summary }}</div>
+                        <div class="text-xs text-stone-500">{{ qs.timestamp|timesince }} ago</div>
+                    </button>
+                </li>
+                {% endfor %}
+            </ul>
+        </aside>
+
+        <main id="content" class="flex-1 p-6 overflow-auto ml-82 mt-14">
+            {% for request_id, qs in querystats.items() %}
+            <div class="request-detail" data-request-id="{{ request_id }}" style="display: none;">
+                <div class="flex justify-between">
+                    <div>
+                        <h2 class="font-medium text-sm"><span class="font-semibold">{{ qs.request.method }}</span> {{ qs.request.path }}</h2>
+                        <p class="text-sm text-white/70">{{ qs.summary }}</p>
+                    </div>
+                    <div class="text-right">
+                        <div class="text-xs text-white/60">Request ID <code>{{ qs.request.unique_id }}</code></div>
+                        <div class="text-xs text-white/60"><code>{{ qs.timestamp }}</code></div>
+                    </div>
+                </div>
+
+                <div class="flex w-full mt-3 overflow-auto rounded-sm">
+                    {% for query in qs.queries %}
+                    <a href="#query-{{ loop.index }}"
+                        {{ loop.cycle('class=\"h-2 bg-amber-400\"', 'class=\"h-2 bg-orange-400\"', 'class=\"h-2 bg-yellow-400\"', 'class=\"h-2 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-white/5">
+                        <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>
+                            <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>
+            {% endfor %}
+        </main>
+    </div>
+    {% elif querystats_enabled %}
+    <div class="text-center text-white/30 py-8">Querystats are enabled but nothing has been recorded yet.</div>
+    {% else %}
+    <div class="text-center py-8">
+        <div class="text-white/30">Querystats are disabled.</div>
+        <form method="post" action=".">
+            {{ csrf_input }}
+            <input type="hidden" name="querystats_action" value="enable">
+            <button type="submit" class="mt-2 px-2 py-px text-sm rounded-sm bg-stone-700 text-stone-300 hover:bg-stone-600 cursor-pointer whitespace-nowrap">Enable</button>
+        </form>
+    </div>
+    {% endif %}
+
+    <script>
+        document.addEventListener('DOMContentLoaded', function() {
+            const buttons = document.querySelectorAll('#sidebar [data-request-id]');
+            const details = document.querySelectorAll('#content .request-detail');
+            buttons.forEach(function(btn) {
+                btn.addEventListener('click', function(e) {
+                    e.preventDefault();
+                    const id = this.getAttribute('data-request-id');
+                    details.forEach(div => div.style.display = 'none');
+                    const sel = document.querySelector('#content .request-detail[data-request-id="' + id + '"]');
+                    if (sel) sel.style.display = 'block';
+                    buttons.forEach(b => b.classList.remove('bg-stone-700', 'text-white'));
+                    this.classList.add('bg-stone-700', 'text-white');
+                });
+            });
+            if (buttons.length > 0) buttons[0].click();
+        });
+    </script>
+
+    </body>
+</html>

{plain_admin-0.27.0 → plain_admin-0.28.0}/plain/admin/templates/querystats/toolbar.html

@@ -1,25 +1,25 @@
 <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">
+    <button data-toolbar-tab="querystats" class="inline-flex items-center cursor-pointer text-xs rounded-full px-2 py-px bg-white/20 text-white/80 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>
+    </button>
     {% 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">
+        <button type="submit" class="cursor-pointer text-xs rounded-full px-2 py-px bg-white/20 text-white/80 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 data-querystats-list style="display: none;" class="absolute z-50 hidden -translate-y-full right-0 -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>