tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #8280 from open-sausages/pulls/4/simpler-vary-header

Browse Source 
FIX: Remove X-Requested-With from default Vary header
This commit is contained in:
Daniel Hensby 2018-07-24 01:45:07 +01:00 committed by GitHub
commit ae00147de1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/en/02_Developer_Guides/08_Performance/02_HTTP_Cache_Headers.md
View File

@ -218,7 +218,7 @@ when calculating a cache key, usually in addition to the full URL.
By default, SilverStripe will output a `Vary` header with the following content: By default, SilverStripe will output a `Vary` header with the following content:
``` ```
Vary: X-Requested-With, X-Forwarded-Protocol Vary: X-Forwarded-Protocol
``` ```
To change the value of the `Vary` header, you can change this value by specifying the header in configuration. To change the value of the `Vary` header, you can change this value by specifying the header in configuration.
@ -227,3 +227,6 @@ To change the value of the `Vary` header, you can change this value by specifyin
SilverStripe\Control\HTTP: SilverStripe\Control\HTTP:
vary: "" vary: ""
``` ```
Note that if you use `Director::is_ajax()` on cached pages
then you should add `X-Requested-With` to the vary header.

3
docs/en/04_Changelogs/4.2.0.md
View File

@ -357,6 +357,9 @@ class PageController extends ContentController
Note this is different from `Vary: Accept-Encoding`, Note this is different from `Vary: Accept-Encoding`,
which is important for compression (e.g. gzip), and usually added by which is important for compression (e.g. gzip), and usually added by
other layers such as Apache's mod_gzip. other layers such as Apache's mod_gzip.
* Removed `Vary: X-Requested-With` since it's only applicable when varying
content based on the client context, mostly for returning different XHR responses
as determined through `Director::is_ajax()`.
* No longer sets `Last-Modified` date in HTTP response headers in `DataObject::__construct()`. * No longer sets `Last-Modified` date in HTTP response headers in `DataObject::__construct()`.
Uses `ETag` calculation based on response body which is more accurate, Uses `ETag` calculation based on response body which is more accurate,
and resilient against partial and object caching which can produce stale `Last-Modified` values. and resilient against partial and object caching which can produce stale `Last-Modified` values.

3
src/Control/Director.php
View File

@ -993,6 +993,9 @@ class Director implements TemplateGlobalProvider
* Checks if the current HTTP-Request is an "Ajax-Request" by checking for a custom header set by * Checks if the current HTTP-Request is an "Ajax-Request" by checking for a custom header set by
* jQuery or whether a manually set request-parameter 'ajax' is present. * jQuery or whether a manually set request-parameter 'ajax' is present.
* *
* Note that if you plan to use this to alter your HTTP response on a cached page,
* you should add X-Requested-With to the Vary header.
*
* @param HTTPRequest $request * @param HTTPRequest $request
* @return bool * @return bool
*/ */

1
src/Control/Middleware/HTTPCacheControlMiddleware.php
View File

@ -136,7 +136,6 @@ class HTTPCacheControlMiddleware implements HTTPMiddleware, Resettable
* @var array * @var array
*/ */
private static $defaultVary = [ private static $defaultVary = [
"X-Requested-With" => true,
"X-Forwarded-Protocol" => true, "X-Forwarded-Protocol" => true,
]; ];