Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct RENDER_PANELS functionality and when enabled disable HistoryPanel #1440

Merged
merged 4 commits into from
Jul 20, 2021

Conversation

tim-schilling
Copy link
Member

The render panels setting used to control whether the toolbar would keep
the contents of the panels in the background or render the toolbar on
every page. The history panel relies on loading panels in the background.
If panels should be rendered on the request, then the history panel is
can't/shouldn't work.

References #1413

@codecov
Copy link

codecov bot commented Jan 22, 2021

Codecov Report

Merging #1440 (8d39876) into main (085f8dd) will increase coverage by 0.07%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1440      +/-   ##
==========================================
+ Coverage   86.51%   86.58%   +0.07%     
==========================================
  Files          35       35              
  Lines        1861     1864       +3     
  Branches      262      262              
==========================================
+ Hits         1610     1614       +4     
+ Misses        180      178       -2     
- Partials       71       72       +1     
Impacted Files Coverage Δ
debug_toolbar/toolbar.py 92.04% <ø> (ø)
debug_toolbar/panels/history/panel.py 90.38% <100.00%> (+0.58%) ⬆️
debug_toolbar/panels/profiling.py 89.28% <0.00%> (+0.89%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 085f8dd...8d39876. Read the comment docs.

docs/changes.rst Outdated
Comment on lines 12 to 16
* ``HistoryPanel`` will be disabled when ``RENDER_PANELS`` is ``True``
or if it's not set, but the server is running with multiple processes.
* Fixes ``RENDER_PANELS`` functionality so that when ``True`` panels are
rendered during the request and not loaded asynchronously.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a hard time understanding the first bullet point. The second bullet point should probably use past tense too for consistency.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that's written poorly. I'll fix it.

Base automatically changed from master to main February 11, 2021 15:01
…anel.

The render panels setting used to control whether the toolbar would keep
the contents of the panels in the background or render the toolbar on
every page. The history panel relies on loading panels in the background.
If panels should be rendered on the request, then the history panel is
can't/shouldn't work.
@matthiask matthiask merged commit 9b6aae4 into django-commons:main Jul 20, 2021
@matthiask
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants