Deprecate RedirectsPanel and update tests for deprecation warning #2223
Conversation
tests/panels/test_redirects.py
Outdated
|
|
||
| def test_deprecation_warning(self): | ||
| """Test that a deprecation warning is shown when RedirectsPanel is instantiated.""" | ||
| from debug_toolbar.toolbar import DebugToolbar |
There was a problem hiding this comment.
Does this need to be a local import?
There was a problem hiding this comment.
No will change it
|
Originally I was thinking it would be a message on the template that gets rendered for the |
|
Should I include it in the template too? |
|
@JohananOppongAmoateng I'm good with this as is. I wanted to raise it to see what you thought. |
…-toolbar into deprecate-redirects-panel
|
Hello, I think a message in the template it's not a lot of work and another warning for people who don't read the warning in console. |
|
Mm that's true I will add a warning in the template. Should it be something like a toast? |
Yep only if the user is on the template ofc. |
There was a problem hiding this comment.
The new styles look pretty fixed with pixel units and static colors. This needs to be more flexible for both themes and people who adjust the zoom on the page. The classes also need to be prefixed with the toolbar id (see other styles). This prevents our styles from impacting application styles.
There was a problem hiding this comment.
The latest changes have caused the toolbar's side panel to disappear. I suspect it's due to trying to use the id="djDebug" attribute. My suggestion of using that as a prefix was wrong. This redirect HTML isn't actually within the toolbar's container, though we don't want custom styles floating around. We would need to identify a new container, like djdt-redirect. Though that said, I'm guessing that path is going to be more effort than we want to spend since this is deprecated. I think putting the styles in the <head> may be best. Though I wonder how that's going to go over with a CSP 😬
| <link{% if toolbar.csp_nonce %} nonce="{{ toolbar.csp_nonce }}"{% endif %} rel="stylesheet" href="{% static 'debug_toolbar/css/toolbar.css' %}"> | ||
| </head> | ||
| <body> | ||
| <body id="djDebug" {% if toolbar.store_id %}data-store-id="{{ toolbar.store_id }}"{% endif %}> |
There was a problem hiding this comment.
The id="djDebug" seems to be causing downstream effects. I wonder if it'd be better to have the styles defined in the <head> here directly?
| <body> | ||
| <body id="djDebug" {% if toolbar.store_id %}data-store-id="{{ toolbar.store_id }}"{% endif %}> | ||
| <div class="djdt-deprecation-warning"> | ||
| <strong>{% translate "WARNING:" %}</strong> {% translate "The RedirectsPanel is deprecated and will be removed in a future version. The HistoryPanel now provides the ability to view toolbar data for redirected requests. If you still have a use case for this panel, please comment on this <a href='https://github.com/django-commons/django-debug-toolbar/issues/2216'>issue</a>" %} |
There was a problem hiding this comment.
| <strong>{% translate "WARNING:" %}</strong> {% translate "The RedirectsPanel is deprecated and will be removed in a future version. The HistoryPanel now provides the ability to view toolbar data for redirected requests. If you still have a use case for this panel, please comment on this <a href='https://github.com/django-commons/django-debug-toolbar/issues/2216'>issue</a>" %} | |
| <strong>{% translate "WARNING:" %}</strong> {% translate "The RedirectsPanel is deprecated and will be removed in a future version. The HistoryPanel now provides the ability to view toolbar data for redirected requests. If you still have a use case for this panel, please comment on this <a target='_blank' href='https://github.com/django-commons/django-debug-toolbar/issues/2216'>issue</a>" %} |
I also think a {% blocktranslate %} may make this a bit more readable since you could add more linebreaks to the code.
3 participants
Description
Please include a summary of the change and which issue is fixed. Please also
include relevant motivation and context. Your commit message should include
this information as well.
Fixes #2216
Checklist:
docs/changes.rst.