Wagtail-cache

=====

This release massively improves caching for sites which employ trackers such as
Google Analytics, Facebook Pixel, HubSpot, etc.

* Add setting to strip cookies from requests and remove ``Vary: Cookie`` headers
(except for Django session and CSRF token) to maximize caching opportunities.
This is ON by default! See :ref:`WAGTAIL_CACHE_IGNORE_COOKIES`.

=====

* Includes everything from 1.1.0 released in tandem.

* Includes new SVG icon in settings panel. Previously this icon was either the
cog, or the lighthing bolt if ``wagtailfontawesome`` was installed.

* Supports Wagtail 3 and only Wagtail 3. Wagtail 2 support will be maintained in
the 1.x series as needed.

=====

* Previously, the feature to strip cookies was not triggered if the Vary header
contained something other than "Cookie", e.g. ``Vary: Language, Cookie``. This
change properly inspects and rebuilds the Vary header in such cases.

=====

This release massively improves caching for sites which employ trackers such as
Google Analytics, Facebook Pixel, HubSpot, etc.

* Add setting to strip cookies from requests and remove ``Vary: Cookie`` headers
(except for Django session and CSRF token) to maximize caching opportunities.
This is ON by default! See :ref:`WAGTAIL_CACHE_IGNORE_COOKIES`.

=====

New features

* Show list of all URLs cached in the Wagtail Admin.

* Support purging individual URLs (via regular expressions) from the cache. See
:ref:`purge_specific_urls`.

* Ignore tracking querystring parameters by default. This means that pages with
unique tracking parameters will still be cached and/or served from the cache
regardless of those parameters. This should massively improve performance on
sites with heavy marketing activity, but can potentially introduce breakage if
you have server-side logic that uses tracking codes via the querystring.

The list of querystrings to ignore can be customized, or the feature can be
completely disabled. See Django setting :ref:`WAGTAIL_CACHE_IGNORE_QS`.

Bug fixes

* Previously, request with methods except GET and HEAD were never cached, even
if you override the caching decision with ``is_request_cacheable`` hooks.
These requests are still not cached by default, but *can be cached* if you
override the caching decision. Please use caution when overriding caching
decisions using :doc:`these hooks </getting_started/hooks>`.

Maintenance


* Add support for Django 4.

* Supports Wagtail 2 only.

* New shiny documentation based on the Wagtail Sphinx theme.

=====

* Fix typo in Wagtail Cache settings page.

* Updated unit tests for Wagtail 2.12.

* Apply ``black`` formatting to codebase.

.. note::

Wagtail Cache may not work correctly with
``wagtail.core.middleware.SiteMiddleware`` or
``wagtail.contrib.legacy.sitemiddleware.SiteMiddleware`` on Wagtail 2.9 and
newer. `Follow these instructions to replace SiteMiddleware
<https://docs.wagtail.io/en/stable/releases/2.9.html#sitemiddleware-and-request-site-deprecated>`_.