Fix KeyError in DatabaseStore when dynamically adding panels and ensure from_store flag is set correctly #2184
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…re from_store flag is set correctly
abdibaker
changed the title
The DatabaseStore fix caused all panels to be loaded, including disabled ones like ProfilingPanel. The history sidebar was including all panels in its JSON response rather than filtering by enabled status. This change adds a check for panel.enabled in the history sidebar view to ensure only enabled panels are included in the response, matching the behavior expected by tests and consistent with the main toolbar display logic. Fixes failing tests: - test_history_sidebar - test_history_sidebar_expired_request_id - test_history_sidebar_includes_history
matthiask
reviewed
Aug 18, 2025
| @@ -223,7 +223,9 @@ def from_store(cls, request_id, panel_id=None): | |||
| data = toolbar.store.panel(toolbar.request_id, panel.panel_id) | |||
| if data: | |||
| panel.load_stats_from_store(data) | |||
| toolbar._panels[panel.panel_id] = panel | |||
| else: | |||
| panel.from_store = True | |||
There was a problem hiding this comment.
We are only setting from_store in debug_toolbar/panels/__init__.py right now.
I think it would be better to call load_stats_from_store unconditionally if we actually depend on this attribute.
| delattr(settings, "DEBUG_TOOLBAR_PANELS") | ||
| DebugToolbar._panel_classes = None | ||
| StoredDebugToolbar._panel_classes = None | ||
| get_panels.cache_clear() |
There was a problem hiding this comment.
I wonder a bit if all that is really necessary?
If you're using the @override_settings decorator, a signal is emitted which also calls cache_clear.
I'd prefer this to use @override_settings(DEBUG_TOOLBAR_PANELS=...) or something similar instead.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This commit addresses the KeyError issue that occurs when using DatabaseStore with dynamically added panels to DEBUG_TOOLBAR_PANELS. The problem occurred in
StoredDebugToolbar.from_store()where the method would only load panels that had stored data, causing a KeyError when accessing panels that were added after the initial request.The fix modifies the panel loading logic to:
from_storeflag for panels that have stored dataThis ensures that the toolbar works correctly when panels are dynamically added to the configuration, particularly when using DatabaseStore for persistent storage.
Fixes #2166
Checklist:
docs/changes.rst.