Add HistoryPanel to capture ajax requests. #1250

tim-schilling · 2020-03-20T23:24:23Z

This creates a new panel, HistoryPanel which makes use of the
Toolbar.store to support a history of the toolbar as requests are
made.

The interface changes as follows:
Panel.is_historical - Indicates that the panel's button and content
should be updated when switching between snapshots of the history.

Toolbar.store - Will no longer generate a new store_id when the
instance already has a value.

DEBUG_TOOLBAR_CONFIG.HISTORY_POST_TRUNC_LENGTH - Allows the request's
POST content to be truncated in the history panel's content.

LoggingPanel and StaticFilesPanel now utilize the get_stats method
to fetch panel data for nav_subtitle.

Credit to @djsutho for creating the original third party panel:
https://github.com/djsutho/django-debug-toolbar-request-history
The core concepts were derived from that package.

Closes #1066, #1032, #998.

codecov · 2020-03-21T00:18:17Z

Codecov Report

Merging #1250 into master will increase coverage by 0.02%.
The diff coverage is 91.48%.

@@            Coverage Diff             @@
##           master    #1250      +/-   ##
==========================================
+ Coverage   86.68%   86.71%   +0.02%     
==========================================
  Files          25       29       +4     
  Lines        1442     1528      +86     
  Branches      207      215       +8     
==========================================
+ Hits         1250     1325      +75     
- Misses        140      148       +8     
- Partials       52       55       +3

Impacted Files	Coverage Δ
debug_toolbar/toolbar.py	`85.71% <0.00%> (-5.75%)`	⬇️
debug_toolbar/panels/history/views.py	`76.19% <76.19%> (ø)`
debug_toolbar/panels/history/panel.py	`97.29% <97.29%> (ø)`
debug_toolbar/middleware.py	`93.65% <100.00%> (+3.17%)`	⬆️
debug_toolbar/panels/history/__init__.py	`100.00% <100.00%> (ø)`
debug_toolbar/panels/history/forms.py	`100.00% <100.00%> (ø)`
debug_toolbar/panels/logging.py	`95.91% <100.00%> (ø)`
debug_toolbar/panels/staticfiles.py	`94.89% <100.00%> (+0.05%)`	⬆️
debug_toolbar/panels/profiling.py	`89.28% <0.00%> (-1.79%)`	⬇️
... and 5 more

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 bad48b2...fa6984b. Read the comment docs.

matthiask

I didn't try it out but went through the diff. Looks good!

debug_toolbar/panels/history/panel.py

debug_toolbar/settings.py

tim-schilling · 2020-04-18T16:48:02Z

If we think this is going to be merged, we'll need to do a major version bump. But before we do that, I'll want to go through the third party panels identified in the docs to at least identify if any will break.

matthiask · 2020-05-10T19:04:11Z

@tim-schilling Compatibility problems only really surface after a release, unfortunately. I think it would be alright to merge this and go ahead with it, maybe with an alpha/beta release (similar to 2.0a1) so that it is installable using pip --pre.

But I certainly wouldn't want to push this without your approval or if there is anything you'd still like to check before.

tim-schilling · 2020-05-21T02:03:13Z

I have not forgotten about this, I've been busy with paid work and haven't had time for FOSS development. I will get back around to this though.

@djsutho

This creates a new panel, HistoryPanel which makes use of the Toolbar.store to support a history of the toolbar as requests are made. The interface changes as follows: Panel.is_historical - Indicates that the panel's button and content should be updated when switching between snapshots of the history. Toolbar.store - Will no longer generate a new store_id when the instance already has a value. DEBUG_TOOLBAR_CONFIG.HISTORY_POST_TRUNC_LENGTH - Allows the request's POST content to be truncated in the history panel's content. LoggingPanel and StaticFilesPanel now utilize the ``get_stats`` method to fetch panel data for nav_subtitle. Credit to @djsutho for creating the original third party panel: https://github.com/djsutho/django-debug-toolbar-request-history The core concepts were derived from that package.

tim-schilling · 2020-08-08T21:46:15Z

@matthiask This requires another review due to me making a few changes:

Rebasing on the new main branch.
Displaying the request variables as a table similar to the cache panel rather than a JSON strong.
Supporting a refresh button within the history panel. This allows the user to load up the debug toolbar info for requests that have been performed since the original request
Increased RESULTS_CACHE_SIZE to 25 (from 10). The reason for this is because the original request's data was being dropped before I opened the toolbar during my testing. With ajax-y applications, I feel like this new setting better reflects the number of ajax requests between full requests.

matthiask

This looks very good already, thank you!

matthiask · 2020-08-12T14:41:22Z

docs/panels.rst

+History
+~~~~~~~
+
+Path: ``debug_toolbar.panels.history.VersionsPanel``


Typo? (VersionsPanel)

Yeah, copy paste error. Thanks for catching it.

matthiask · 2020-08-12T14:46:54Z

debug_toolbar/panels/history/panel.py

+    sending to less secure functions.
+    Not comprehensive
+
+    Taken from django.contrib.auth.__init__.credentials


I was hoping there would be a way to use https://docs.djangoproject.com/en/3.1/ref/settings/#default-exception-reporter-filter for this. I didn't even know there was a setting for this, I assumed it was internal-only. I'd have referenced the setting earlier if I was aware that it existed at all.

(Also, maybe Django should use the SafeExceptionReporterFilter instead of reimplementing parts of it in django.contrib.auth.)

Ah, good call. I'll rework this to make use of that.

I'm thinking I need to remove this. The django implementation only uses it for debug cases which defeats the purpose of this.

tim-schilling · 2020-08-24T19:44:09Z

@matthiask I'm curious about your v3.0 release plan. Would this be included or would it be smarter to do a 3.0 and then a 3.1.0a immediately after? I can make a post on forum.djangoproject.com asking for alpha testers.

matthiask · 2020-08-27T15:44:41Z

@tim-schilling I think it might be worth it to do another alpha. Generally I don't worry too much about stability since mostly people aren't supposed to use django-debug-toolbar in production :-)

It's enough work to create a release already, and I'd rather speed the release process up a bit.

tim-schilling · 2020-08-28T13:40:44Z

Sounds good. Let me know where I can help out.

matthiask · 2020-09-05T12:00:22Z

@tim-schilling I have just pushed 3.0a3 now, if you want to add a post in the forum that would be awesome. Thanks!

tim-schilling · 2020-09-08T12:56:23Z

@matthiask Thanks for the update! I'll do that this morning.

matthiask · 2020-09-08T12:57:50Z

@tim-schilling It may be worth it uploading another release; I fixed a crash which happened when using request as a file-like object (see 3.0a3...master). What do you think? Maybe it's an edge case....

tim-schilling · 2020-09-08T13:11:37Z

No, I doubt it's an edge-case if it was found that quickly. I agree it's worth to bump the version since it was caught and fixed.

matthiask · 2020-09-08T13:21:11Z

Alright, https://pypi.org/project/django-debug-toolbar/3.0a4/ is available on PyPI.

tim-schilling · 2020-09-08T13:31:23Z

Thanks, here's the forum post https://forum.djangoproject.com/t/django-debug-toolbar-alpha-release-v3/4250

tim-schilling force-pushed the history branch from 7a4ea58 to af9fc3f Compare March 20, 2020 23:24

tim-schilling changed the title ~~Support HistoryPanel to capture ajax requests.~~ Add HistoryPanel to capture ajax requests. Mar 20, 2020

tim-schilling force-pushed the history branch from 00b439e to fa6984b Compare March 21, 2020 00:24

matthiask reviewed Apr 18, 2020

View reviewed changes

debug_toolbar/panels/history/panel.py Outdated Show resolved Hide resolved

debug_toolbar/settings.py Outdated Show resolved Hide resolved

djsutho mentioned this pull request May 17, 2020

Selecting link from history does not show any data in panels djsutho/django-debug-toolbar-request-history#35

Open

matthiask mentioned this pull request May 19, 2020

Make AJAX views return JSON instead of HTML #1282

Merged

tim-schilling self-assigned this May 21, 2020

matthiask force-pushed the master branch from 4d0d718 to 080ce84 Compare July 15, 2020 18:14

tim-schilling force-pushed the history branch from fa6984b to 3028a71 Compare August 8, 2020 21:39

Show history request data in table and include refresh history button.

5dee6e3

tim-schilling force-pushed the history branch from 3141a8d to 5dee6e3 Compare August 8, 2020 21:54

Handle python 3.5's json.loads expecting a string.

44072b2

matthiask reviewed Aug 12, 2020

View reviewed changes

Fix documentation error, remove request variable cleansing.

4aa4dfe

matthiask merged commit ab08d14 into django-commons:master Aug 22, 2020

tim-schilling mentioned this pull request Sep 4, 2020

debug-toolbar for frontend development #1313

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add HistoryPanel to capture ajax requests. #1250

Add HistoryPanel to capture ajax requests. #1250

tim-schilling commented Mar 20, 2020 •

edited

Loading

codecov bot commented Mar 21, 2020 •

edited

Loading

matthiask left a comment

tim-schilling commented Apr 18, 2020

matthiask commented May 10, 2020

tim-schilling commented May 21, 2020

tim-schilling commented Aug 8, 2020

matthiask left a comment

matthiask Aug 12, 2020

tim-schilling Aug 12, 2020

matthiask Aug 12, 2020

tim-schilling Aug 12, 2020

tim-schilling Aug 12, 2020

tim-schilling commented Aug 24, 2020

matthiask commented Aug 27, 2020

tim-schilling commented Aug 28, 2020

matthiask commented Sep 5, 2020

tim-schilling commented Sep 8, 2020

matthiask commented Sep 8, 2020 •

edited

Loading

tim-schilling commented Sep 8, 2020

matthiask commented Sep 8, 2020

tim-schilling commented Sep 8, 2020

Add HistoryPanel to capture ajax requests. #1250

Add HistoryPanel to capture ajax requests. #1250

Conversation

tim-schilling commented Mar 20, 2020 • edited Loading

codecov bot commented Mar 21, 2020 • edited Loading

Codecov Report

matthiask left a comment

Choose a reason for hiding this comment

tim-schilling commented Apr 18, 2020

matthiask commented May 10, 2020

tim-schilling commented May 21, 2020

tim-schilling commented Aug 8, 2020

matthiask left a comment

Choose a reason for hiding this comment

matthiask Aug 12, 2020

Choose a reason for hiding this comment

tim-schilling Aug 12, 2020

Choose a reason for hiding this comment

matthiask Aug 12, 2020

Choose a reason for hiding this comment

tim-schilling Aug 12, 2020

Choose a reason for hiding this comment

tim-schilling Aug 12, 2020

Choose a reason for hiding this comment

tim-schilling commented Aug 24, 2020

matthiask commented Aug 27, 2020

tim-schilling commented Aug 28, 2020

matthiask commented Sep 5, 2020

tim-schilling commented Sep 8, 2020

matthiask commented Sep 8, 2020 • edited Loading

tim-schilling commented Sep 8, 2020

matthiask commented Sep 8, 2020

tim-schilling commented Sep 8, 2020

tim-schilling commented Mar 20, 2020 •

edited

Loading

codecov bot commented Mar 21, 2020 •

edited

Loading

matthiask commented Sep 8, 2020 •

edited

Loading