INTPYTHON-423 MQL panel for Django Debug Toolbar (#29)

* Implement MQL panel for Django Debug Toolbar

* Address review feedback

- Just use validation error
- Remove type hints
- Document Exception
- Use debug_toolbar's get_signed_data
- Fix docstrings in tests
- s/sql/mql/g
- Narrow exception

* Delete .coverage

* Address review feedback (🤖 assisted)

* Add tests based on sql panel tests (🤖 assisted)

* Jib review fixes

* readme edits

* Update gitignore

* Address review feedback

* Remove find

* Fix convert_documents_to_table and add test

* Address review feedback

* Address review feedback

Co-Authored-By: Claude Code <noreply@anthropic.com>

* Add template_info support to MQL panel

Co-Authored-By: Claude Code <noreply@anthropic.com>

* Address review feedback

* Move template_info above stacktrace

* More verbose test run output

* Add test coverage harness

* Rename select -> aggregate

* Fix package version resolution for coverage

* Move utils tests from test_panel -> test_utils

* Move forms tests from test_utils -> tests_forms

* Add QueryPartsTests

* Rename mql select -> mql query

* Address review feedback

* Move MQL panel tests to tests/debug_toolbar/

* Rename debug_toolbar.panels.mql/* -> mql_panel/*

* Update readme

* Refactor mql form clean() method

* Address review feedback

* Format mql_query and fix dhtml pre-commit hook

* Alpha-sort class methods

* Address review feedback

* Refactor tests

* Bump zizmorcore/zizmor-action from 0.5.0 to 0.5.2 in the actions group (#33)

Bumps the actions group with 1 update: [zizmorcore/zizmor-action](https://github.com/zizmorcore/zizmor-action).


Updates `zizmorcore/zizmor-action` from 0.5.0 to 0.5.2
- [Release notes](https://github.com/zizmorcore/zizmor-action/releases)
- [Commits](zizmorcore/zizmor-action@0dce257...71321a2)

---
updated-dependencies:
- dependency-name: zizmorcore/zizmor-action
  dependency-version: 0.5.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: actions
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Address review feedback

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Tim Graham <timograham@gmail.com>
Co-authored-by: Claude Code <noreply@anthropic.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Author: 4 people

.github/workflows/test-python.yml

@@ -86,7 +86,7 @@ jobs:
       with:
         mongodb-version: ${{ env.MIN_MONGODB }}
         mongodb-replica-set: test-rs
-    - name: Run unit tests with minimum dependency versions
+    - name: Run unit tests with minimum Python/MongoDB versions
       run: |
-        uv sync --python=${MIN_PYTHON} --resolution=lowest-direct
+        uv sync --python=${MIN_PYTHON} --resolution=highest
         just test

.gitignore

@@ -1 +1,3 @@
 __pycache__
+uv.lock
+.coverage

.pre-commit-config.yaml

@@ -20,4 +20,3 @@ repos:
   hooks:
     - id: djhtml
       entry: djhtml --tabwidth 2
-      files: django_mongodb_extensions/templates/debug_toolbar/panels/mql.html

README.md

@@ -1,3 +1,79 @@
 # django-mongodb-extensions
 
 Extensions for Django MongoDB Backend
+
+## Installation
+
+```bash
+pip install django-mongodb-extensions
+```
+
+## Extensions
+
+### MQL Panel
+
+This panel for
+[Django Debug Toolbar](https://github.com/jazzband/django-debug-toolbar)
+provides insights into MongoDB queries executed during a request
+similar to how the SQL panel works for relational databases.
+
+**Features:**
+
+- View all MongoDB queries (MQL) executed during a request
+- See query execution time and identify slow queries
+- Re-execute read operations (aggregate) directly from the toolbar
+- Explain query execution plans
+- Color-coded query grouping for easy identification
+- Detailed query statistics and performance metrics
+
+#### Configure the MQL Panel
+
+First, install and configure Django Debug Toolbar by following their
+[installation instructions](https://django-debug-toolbar.readthedocs.io/en/latest/installation.html).
+
+1. **Add to `INSTALLED_APPS`** in your Django settings:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "django_mongodb_extensions",
+    # ...
+]
+```
+
+2. **Add the MQL Panel** to your debug toolbar configuration:
+
+```python
+DEBUG_TOOLBAR_PANELS = [
+    "debug_toolbar.panels.history.HistoryPanel",
+    "debug_toolbar.panels.versions.VersionsPanel",
+    "debug_toolbar.panels.timer.TimerPanel",
+    "debug_toolbar.panels.settings.SettingsPanel",
+    "debug_toolbar.panels.headers.HeadersPanel",
+    "debug_toolbar.panels.request.RequestPanel",
+    # Add this:
+    "django_mongodb_extensions.mql_panel.MQLPanel",
+    "debug_toolbar.panels.templates.TemplatesPanel",
+    "debug_toolbar.panels.staticfiles.StaticFilesPanel",
+    "debug_toolbar.panels.cache.CachePanel",
+    "debug_toolbar.panels.signals.SignalsPanel",
+    "debug_toolbar.panels.redirects.RedirectsPanel",
+    "debug_toolbar.panels.profiling.ProfilingPanel",
+]
+```
+
+3. **Optional:** Configure settings.
+
+```python
+# Maximum number of documents to return when re-executing select
+# queries (default is 100).
+DJDT_MQL_MAX_QUERY_RESULTS = 25
+
+# Queries slower than this threshold (in milliseconds) are highlighted
+# in the debug toolbar (default is 500 ms).
+DJDT_MQL_WARNING_THRESHOLD = 1000
+```
+
+## License
+
+See [LICENSE](LICENSE) file for details.

django_mongodb_extensions/debug_toolbar/panels/__init__.py

@@ -0,0 +1,3 @@
+from django_mongodb_extensions.mql_panel.panel import MQLPanel
+
+__all__ = [MQLPanel.panel_id]