Deprecate OBSERVE_REQUEST_CALLBACK setting #1895
Merged
Conversation
This file contains 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
The previous implementation of observe_request(), the default callback for OBSERVE_REQUEST_CALLBACK, was checking for DebugToolbar.is_toolbar_request() and returning True only if that method returned False. However, this is actually unneeded, because DebugToolbarMiddleware never instruments its own requests. If DebugToolbar.is_toolbar_request() returns True for a given request, DebugToolbarMiddleware will return early without performing any instrumentation or processing on the request [1]. In this case, the OBSERVE_REQUEST_CALLBACK callback never gets called, because it only gets called via the HistoryPanel.get_headers() method [2]. The .get_headers() method is only called by DebugToolbarMiddleware after the early return mentioned above [3]. Thus if OBSERVE_REQUEST_CALLBACK is called, it must be the case that DebugToolbar.is_toolbar_request() is False for the current request. Therefore observe_request() can be simplified to always return True without changing its behavior. [1] https://github.com/jazzband/django-debug-toolbar/blob/c688ce4ad7d18c5ecb800869298ca8cf6c08be1d/debug_toolbar/middleware.py#L48-L49 [2] https://github.com/jazzband/django-debug-toolbar/blob/c688ce4ad7d18c5ecb800869298ca8cf6c08be1d/debug_toolbar/panels/history/panel.py#L23-L29 [3] https://github.com/jazzband/django-debug-toolbar/blob/c688ce4ad7d18c5ecb800869298ca8cf6c08be1d/debug_toolbar/middleware.py#L76-L77
With the addition of the UPDATE_ON_FETCH setting, the OBSERVE_REQUEST_CALLBACK setting is redundant. Thus add a check debug_toolbar.W008 to warn if it is present in DEBUG_TOOLBAR_CONFIG, but do not remove it yet. See jazzband#1886
tim-schilling
approved these changes
Mar 12, 2024
There was a problem hiding this comment.
This looks good to me. Thank you for cleaning this up @living180! I'll leave it open for a day or two to give Matthias time to review, but will otherwise merge it.
|
Thanks! |
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
Based on this comment, change the default implementation of
OBSERVE_REQUEST_CALLBACK,observe_request(), to always returnTrue.Based on Deprecate and remove
OBSERVE_REQUEST_CALLBACK#1886, deprecateOBSERVE_REQUEST_CALLBACK, but do not remove it yet.Checklist:
docs/changes.rst.