Skip to content

WDT following AJAX requests #9692

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

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions profiler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ install the profiler before using it:
profiler/profiling_data
profiler/matchers
profiler/storage
profiler/wdt_follow_ajax
40 changes: 40 additions & 0 deletions profiler/wdt_follow_ajax.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
.. index::
single: Profiling: WDT Auto-update after AJAX Request

How to make the Web Debug Toolbar Auto-upate after AJAX Requests
Copy link
Contributor

Choose a reason for hiding this comment

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

typo update

================================================================

For single page applications it is often inconvenient to find the profiler
information for the most recent request. It would be much more convient if it
Copy link
Contributor

Choose a reason for hiding this comment

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

typo convenient

Copy link
Contributor

Choose a reason for hiding this comment

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

Consider rephrase to:

It would be more convenient if the toolbar showed the information for the most recent AJAX request instead of the initial page load.

the toolbar would show the information from the most recent AJAX request
instead of your initial page load.

By setting the `Symfony-Debug-Toolbar-Replace` to a value of `1` in the
Copy link
Contributor

Choose a reason for hiding this comment

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

By setting the Symfony-Debug-Toolbar-Replace header to a value of 1

AJAX request, the toolbar will be automatically reloaded for the request. The
header can be set on the response object::

$response->headers->set('Symfony-Debug-Toolbar-Replace', 1);

Only setting the header durring development
Copy link
Contributor

Choose a reason for hiding this comment

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

typo during

-------------------------------------------

Ideally this header should only be set durring development and not for
Copy link
Contributor

Choose a reason for hiding this comment

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

typo during

Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps:

As the Web Debug Toolbar should not be used in production, this header should only be set in the development environment. This can be accomplished by creating a kernel.response event listener that is only registered in the development environment.

production. This can be accomplished by setting the header in a
:ref:`kernel.response <component-http-kernel-kernel-response>` event listener::

public function onKernelResponse(FilterResponseEvent $event)
{
$response = $event->getResponse();

$response->headers->set('Symfony-Debug-Toolbar-Replace', 1);
}

.. seealso::

Read more Symfony events :ref:`/reference/events`.

If you are using Symfony Flex, you should define your event listener service in the ``config/services_dev.yml`` file so that it only exists in the ``dev`` environment.

.. seealso::

Read more on creating dev only services :ref:`/configuration/configuration_organization`.