Merge branch 'main' into javascript-load-panel-event

Author: matthiask

.github/workflows/test.yml

@@ -15,8 +15,7 @@ jobs:
       mariadb:
         image: mariadb:10.3
         env:
-          MYSQL_ROOT_PASSWORD: mysql
-          MYSQL_DATABASE: mysql
+          MYSQL_ROOT_PASSWORD: debug_toolbar
         options: >-
           --health-cmd "mysqladmin ping"
           --health-interval 10s
@@ -61,11 +60,10 @@ jobs:
       run: tox
       env:
         DB_BACKEND: mysql
-        DB_NAME: mysql
         DB_USER: root
-        DB_PASSWORD: mysql
-        DB_HOST: "127.0.0.1"
-        DB_PORT: "3306"
+        DB_PASSWORD: debug_toolbar
+        DB_HOST: 127.0.0.1
+        DB_PORT: 3306
 
     - name: Upload coverage
       uses: codecov/codecov-action@v1
@@ -84,7 +82,9 @@ jobs:
       postgres:
         image: 'postgres:9.5'
         env:
-          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: debug_toolbar
+          POSTGRES_USER: debug_toolbar
+          POSTGRES_PASSWORD: debug_toolbar
         ports:
         - 5432:5432
         options: >-
@@ -129,9 +129,6 @@ jobs:
       run: tox
       env:
         DB_BACKEND: postgresql
-        DB_NAME: postgres
-        DB_USER: postgres
-        DB_PASSWORD: postgres
         DB_HOST: localhost
         DB_PORT: 5432
 

.tx/config

@@ -2,7 +2,7 @@
 host = https://www.transifex.com
 lang_map = sr@latin:sr_Latn
 
-[django-debug-toolbar.master]
+[django-debug-toolbar.main]
 file_filter = debug_toolbar/locale/<lang>/LC_MESSAGES/django.po
 source_file = debug_toolbar/locale/en/LC_MESSAGES/django.po
 source_lang = en

Makefile

@@ -8,13 +8,15 @@ style: package-lock.json
 	flake8
 	npx eslint --ignore-path .gitignore --fix .
 	npx prettier --ignore-path .gitignore --write $(PRETTIER_TARGETS)
+	! grep -r '\(style=\|onclick=\|<script>\|<style\)' debug_toolbar/templates/
 
 style_check: package-lock.json
 	isort -c .
 	black --target-version=py36 --check .
 	flake8
 	npx eslint --ignore-path .gitignore .
 	npx prettier --ignore-path .gitignore --check $(PRETTIER_TARGETS)
+	! grep -r '\(style=\|onclick=\|<script>\|<style\)' debug_toolbar/templates/
 
 example:
 	python example/manage.py migrate --noinput

README.rst

@@ -10,7 +10,7 @@ Django Debug Toolbar
    :target: https://github.com/jazzband/django-debug-toolbar/actions
    :alt: Build Status
 
-.. image:: https://codecov.io/gh/jazzband/django-debug-toolbar/branch/master/graph/badge.svg
+.. image:: https://codecov.io/gh/jazzband/django-debug-toolbar/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/jazzband/django-debug-toolbar
    :alt: Test coverage status
 
@@ -28,7 +28,7 @@ more details about the panel's content.
 
 Here's a screenshot of the toolbar in action:
 
-.. image:: https://raw.github.com/jazzband/django-debug-toolbar/master/example/django-debug-toolbar.png
+.. image:: https://raw.github.com/jazzband/django-debug-toolbar/main/example/django-debug-toolbar.png
    :alt: Django Debug Toolbar screenshot
 
 In addition to the built-in panels, a number of third-party panels are

debug_toolbar/__init__.py

@@ -1,13 +1,9 @@
 __all__ = ["VERSION"]
 
 
-try:
-    import pkg_resources
-
-    VERSION = pkg_resources.get_distribution("django-debug-toolbar").version
-except Exception:
-    VERSION = "unknown"
-
+# Do not use pkg_resources to find the version but set it here directly!
+# see issue #1446
+VERSION = "3.2"
 
 # Code that discovers files or modules in INSTALLED_APPS imports this module.
 

debug_toolbar/middleware.py

@@ -44,7 +44,7 @@ def __init__(self, get_response):
     def __call__(self, request):
         # Decide whether the toolbar is active for this request.
         show_toolbar = get_show_toolbar()
-        if not show_toolbar(request) or request.path.startswith("/__debug__/"):
+        if not show_toolbar(request) or DebugToolbar.is_toolbar_request(request):
             return self.get_response(request)
 
         toolbar = DebugToolbar(request, self.get_response)

debug_toolbar/panels/cache.py

@@ -3,9 +3,19 @@
 import time
 from collections import OrderedDict
 
+try:
+    from django.utils.connection import ConnectionProxy
+except ImportError:
+    ConnectionProxy = None
+
 from django.conf import settings
 from django.core import cache
-from django.core.cache import CacheHandler, caches as original_caches
+from django.core.cache import (
+    DEFAULT_CACHE_ALIAS,
+    CacheHandler,
+    cache as original_cache,
+    caches as original_caches,
+)
 from django.core.cache.backends.base import BaseCache
 from django.dispatch import Signal
 from django.middleware import cache as middleware_cache
@@ -246,8 +256,13 @@ def enable_instrumentation(self):
         else:
             cache.caches = CacheHandlerPatch()
 
+        # Wrap the patched cache inside Django's ConnectionProxy
+        if ConnectionProxy:
+            cache.cache = ConnectionProxy(cache.caches, DEFAULT_CACHE_ALIAS)
+
     def disable_instrumentation(self):
         cache.caches = original_caches
+        cache.cache = original_cache
         # While it can be restored to the original, any views that were
         # wrapped with the cache_page decorator will continue to use a
         # monkey patched cache.

debug_toolbar/panels/request.py

@@ -44,7 +44,16 @@ def generate_stats(self, request, response):
             view_info["view_func"] = get_name_from_obj(func)
             view_info["view_args"] = args
             view_info["view_kwargs"] = kwargs
-            view_info["view_urlname"] = getattr(match, "url_name", _("<unavailable>"))
+
+            if getattr(match, "url_name", False):
+                url_name = match.url_name
+                if match.namespaces:
+                    url_name = ":".join([*match.namespaces, url_name])
+            else:
+                url_name = _("<unavailable>")
+
+            view_info["view_urlname"] = url_name
+
         except Http404:
             pass
         self.record_stats(view_info)

debug_toolbar/static/debug_toolbar/css/toolbar.css

@@ -601,6 +601,9 @@
 #djDebug .djdt-width-60 {
     width: 60%;
 }
+#djDebug .djdt-max-height-100 {
+    max-height: 100%;
+}
 #djDebug .djdt-highlighted {
     background-color: lightgrey;
 }

debug_toolbar/static/debug_toolbar/js/toolbar.js

@@ -45,6 +45,7 @@ const djdt = {
                             inner.previousElementSibling.remove(); // Remove AJAX loader
                             inner.innerHTML = data.content;
                             $$.executeScripts(data.scripts);
+                            $$.applyStyles(inner);
                             djDebug.dispatchEvent(
                                 new CustomEvent("djdt.panel.render", {
                                     detail: { panelId: panelId },

debug_toolbar/static/debug_toolbar/js/utils.js

@@ -47,6 +47,26 @@ const $$ = {
             document.head.appendChild(el);
         });
     },
+    applyStyles(container) {
+        /*
+         * Given a container element, apply styles set via data-djdt-styles attribute.
+         * The format is data-djdt-styles="styleName1:value;styleName2:value2"
+         * The style names should use the CSSStyleDeclaration camel cased names.
+         */
+        container
+            .querySelectorAll("[data-djdt-styles]")
+            .forEach(function (element) {
+                const styles = element.dataset.djdtStyles || "";
+                styles.split(";").forEach(function (styleText) {
+                    const styleKeyPair = styleText.split(":");
+                    if (styleKeyPair.length === 2) {
+                        const name = styleKeyPair[0].trim();
+                        const value = styleKeyPair[1].trim();
+                        element.style[name] = value;
+                    }
+                });
+            });
+    },
 };
 
 function ajax(url, init) {

debug_toolbar/templates/debug_toolbar/panels/history.html

@@ -3,7 +3,7 @@
     {{ refresh_form }}
     <button class="refreshHistory">Refresh</button>
 </form>
-<table style="max-height:100%;">
+<table class="djdt-max-height-100">
     <thead>
         <tr>
             <th>{% trans "Time" %}</th>

debug_toolbar/templates/debug_toolbar/panels/profiling.html

@@ -14,7 +14,7 @@
     {% for call in func_list %}
       <tr class="{% for parent_id in call.parent_ids %} djToggleDetails_{{ parent_id }}{% endfor %}" id="profilingMain_{{ call.id }}">
         <td>
-          <div style="padding-left:{{ call.indent }}px">
+          <div data-djdt-styles="paddingLeft:{{ call.indent }}px">
             {% if call.has_subfuncs %}
               <button type="button" class="djProfileToggleDetails djToggleSwitch" data-toggle-name="profilingMain" data-toggle-id="{{ call.id }}">-</button>
             {% else %}

debug_toolbar/templates/debug_toolbar/panels/sql.html

@@ -2,7 +2,7 @@
 <ul>
   {% for alias, info in databases %}
     <li>
-      <strong><span class="djdt-color" style="background-color:rgb({{ info.rgb_color|join:', ' }})"></span> {{ alias }}</strong>
+      <strong><span class="djdt-color" data-djdt-styles="backgroundColor:rgb({{ info.rgb_color|join:', ' }})"></span> {{ alias }}</strong>
       {{ info.time_spent|floatformat:"2" }} ms ({% blocktrans count info.num_queries as num %}{{ num }} query{% plural %}{{ num }} queries{% endblocktrans %}
       {% if info.similar_count %}
         {% blocktrans with count=info.similar_count trimmed %}
@@ -40,21 +40,21 @@
     <tbody>
       {% for query in queries %}
         <tr class="{% if query.is_slow %} djDebugRowWarning{% endif %}" id="sqlMain_{{ forloop.counter }}">
-          <td><span class="djdt-color" style="background-color:rgb({{ query.rgb_color|join:', '}})"></span></td>
+          <td><span class="djdt-color" data-djdt-styles="backgroundColor:rgb({{ query.rgb_color|join:', '}})"></span></td>
           <td class="djdt-toggle">
             <button type="button" class="djToggleSwitch" data-toggle-name="sqlMain" data-toggle-id="{{ forloop.counter }}">+</button>
           </td>
           <td>
             <div class="djDebugSql">{{ query.sql|safe }}</div>
             {% if query.similar_count %}
               <strong>
-                <span class="djdt-color" style="background-color:{{ query.similar_color }}"></span>
+                <span class="djdt-color" data-djdt-styles="backgroundColor:{{ query.similar_color }}"></span>
                 {% blocktrans with count=query.similar_count %}{{ count }} similar queries.{% endblocktrans %}
               </strong>
             {% endif %}
             {% if query.duplicate_count %}
               <strong>
-                <span class="djdt-color" style="background-color:{{ query.duplicate_color }}"></span>
+                <span class="djdt-color" data-djdt-styles="backgroundColor:{{ query.duplicate_color }}"></span>
                 {% blocktrans with dupes=query.duplicate_count %}Duplicated {{ dupes }} times.{% endblocktrans %}
               </strong>
             {% endif %}

debug_toolbar/toolbar.py

@@ -9,7 +9,8 @@
 from django.core.exceptions import ImproperlyConfigured
 from django.template import TemplateSyntaxError
 from django.template.loader import render_to_string
-from django.urls import path
+from django.urls import path, resolve
+from django.urls.exceptions import Resolver404
 from django.utils.module_loading import import_string
 
 from debug_toolbar import settings as dt_settings
@@ -133,6 +134,19 @@ def get_urls(cls):
             cls._urlpatterns = urlpatterns
         return cls._urlpatterns
 
+    @classmethod
+    def is_toolbar_request(cls, request):
+        """
+        Determine if the request is for a DebugToolbar view.
+        """
+        # The primary caller of this function is in the middleware which may
+        # not have resolver_match set.
+        try:
+            resolver_match = request.resolver_match or resolve(request.path)
+        except Resolver404:
+            return False
+        return resolver_match.namespaces and resolver_match.namespaces[-1] == app_name
+
 
 app_name = "djdt"
 urlpatterns = DebugToolbar.get_urls()

docs/changes.rst

@@ -9,12 +9,13 @@ Next version
 * Added ``PRETTIFY_SQL`` configuration option to support controlling
   SQL token grouping. By default it's set to True. When set to False,
   a performance improvement can be seen by the SQL panel.
-* Support JavaScript event when a panel loads of the format
-  ``djdt.panel.[PanelId]`` where PanelId is the panel's python class'
-  ``panel_id`` property. Listening for this event corrects the bug
-  in the Timer Panel in which it doesn't insert the browser timings
-  after being switching requests in the History Panel.
-
+* Added a JavaScript event when a panel loads of the format
+  ``djdt.panel.[PanelId]`` where PanelId is the ``panel_id`` property
+  of the panel's Python class. Listening for this event corrects the bug
+  in the Timer Panel in which it didn't insert the browser timings
+  after switching requests in the History Panel.
+* Fixed issue with the toolbar expecting URL paths to start with
+  ``/__debug__/`` while the documentation indicates it's not required.
 
 3.2 (2020-12-03)
 ----------------

docs/contributing.rst

@@ -53,7 +53,7 @@ Tests
 
 Once you've set up a development environment as explained above, you can run
 the test suite for the versions of Django and Python installed in that
-environment::
+environment using the SQLite database::
 
     $ make test
 
@@ -79,8 +79,23 @@ or by setting the ``DJANGO_SELENIUM_TESTS`` environment variable::
     $ DJANGO_SELENIUM_TESTS=true make coverage
     $ DJANGO_SELENIUM_TESTS=true tox
 
-At this time, there isn't an easy way to test against databases other than
-SQLite.
+To test via `tox` against other databases, you'll need to create the user,
+database and assign the proper permissions. For PostgreSQL in a `psql`
+shell (note this allows the debug_toolbar user the permission to create
+databases)::
+
+    psql> CREATE USER debug_toolbar WITH PASSWORD 'debug_toolbar';
+    psql> ALTER USER debug_toolbar CREATEDB;
+    psql> CREATE DATABASE debug_toolbar;
+    psql> GRANT ALL PRIVILEGES ON DATABASE debug_toolbar to debug_toolbar;
+
+For MySQL/MariaDB in a `mysql` shell::
+
+    mysql> CREATE DATABASE debug_toolbar;
+    mysql> CREATE USER 'debug_toolbar'@'localhost' IDENTIFIED BY 'debug_toolbar';
+    mysql> GRANT ALL PRIVILEGES ON debug_toolbar.* TO 'debug_toolbar'@'localhost';
+    mysql> GRANT ALL PRIVILEGES ON test_debug_toolbar.* TO 'debug_toolbar'@'localhost';
+
 
 Style
 -----
@@ -141,8 +156,8 @@ The release itself requires the following steps:
    Commit.
 
 #. Bump version numbers in ``docs/changes.rst``, ``docs/conf.py``,
-   ``README.rst`` and ``setup.py``. Add the release date to
-   ``docs/changes.rst``. Commit.
+   ``README.rst``, ``debug_toolbar/__init__.py`` and ``setup.py``.
+   Add the release date to ``docs/changes.rst``. Commit.
 
 #. Tag the new version.
 

example/settings.py

@@ -73,26 +73,23 @@
 
 # To use another database, set the DB_BACKEND environment variable.
 if os.environ.get("DB_BACKEND", "").lower() == "postgresql":
-    # % su postgres
-    # % createuser debug_toolbar
-    # % createdb debug_toolbar -O debug_toolbar
+    # See docs/contributing for instructions on configuring PostgreSQL.
     DATABASES = {
         "default": {
             "ENGINE": "django.db.backends.postgresql",
             "NAME": "debug_toolbar",
             "USER": "debug_toolbar",
+            "PASSWORD": "debug_toolbar",
         }
     }
 if os.environ.get("DB_BACKEND", "").lower() == "mysql":
-    # % mysql
-    # mysql> CREATE DATABASE debug_toolbar;
-    # mysql> CREATE USER 'debug_toolbar'@'localhost';
-    # mysql> GRANT ALL PRIVILEGES ON debug_toolbar.* TO 'debug_toolbar'@'localhost';
+    # See docs/contributing for instructions on configuring MySQL/MariaDB.
     DATABASES = {
         "default": {
             "ENGINE": "django.db.backends.mysql",
             "NAME": "debug_toolbar",
             "USER": "debug_toolbar",
+            "PASSWORD": "debug_toolbar",
         }
     }