kozorizki/haproxy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MEDIUM: cache: Change caching conditions

Browse Source 
Do not cache responses that do not have an explicit expiration time
(s-maxage or max-age Cache-Control directives or Expires header) or a
validator (ETag or Last-Modified headers) anymore, as suggested in
RFC 7234#3.
The TX_FLAG_IGNORE flag is used instead of the TX_FLAG_CACHEABLE so as
not to change the behavior of the checkcache option.
This commit is contained in:
Remi Tricot-Le Breton 2020-11-12 11:14:41 +01:00 committed by William Lallemand
parent 91dc0c0d8f
commit cc9bf2e5fe
7 changed files with 196 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/haproxy/http_ana-t.h
View File

@ -59,7 +59,7 @@
/* cacheability management, bits values 0x1000 to 0x3000 (0-3 shift 12) */
#define TX_CACHEABLE 0x00001000 /* at least part of the response is cacheable */
#define TX_CACHE_COOK 0x00002000 /* a cookie in the response is cacheable */
#define TX_CACHE_IGNORE 0x00004000 /* do not retrieve object from cache */
#define TX_CACHE_IGNORE 0x00004000 /* do not retrieve object from cache, or avoid caching response */
#define TX_CACHE_SHIFT 12 /* bit shift */
#define TX_CON_WANT_TUN 0x00008000 /* Will be a tunnel (CONNECT or 101-Switching-Protocol) */

3
reg-tests/cache/basic.vtc vendored
View File

@ -6,7 +6,8 @@ feature ignore_unknown_macro
server s1 {
rxreq
txresp -nolen -hdr "Transfer-Encoding: chunked"
txresp -nolen -hdr "Transfer-Encoding: chunked" \
-hdr "Cache-Control: max-age=5"
chunkedlen 1
chunkedlen 1
chunkedlen 2

150
reg-tests/cache/caching_rules.vtc vendored Normal file
View File

@ -0,0 +1,150 @@
varnishtest "Caching rules test"
# A respnse will not be cached unless it has an explicit age (Cache-Control max-age of s-maxage, Expires, Last-Modified headers, or ETag)
#REQUIRE_VERSION=1.9
feature ignore_unknown_macro
server s1 {
rxreq
expect req.url == "/max-age"
txresp -hdr "Cache-Control: max-age=5" \
-bodylen 150
rxreq
expect req.url == "/s-maxage"
txresp -hdr "Cache-Control: s-maxage=5" \
-bodylen 160
rxreq
expect req.url == "/last-modified"
txresp -hdr "Last-Modified: Thu, 22 Oct 2020 16:51:12 GMT" \
-bodylen 180
rxreq
expect req.url == "/etag"
txresp -hdr "ETag: \"etag\"" \
-bodylen 190
rxreq
expect req.url == "/uncacheable"
txresp \
-bodylen 200
rxreq
expect req.url == "/uncacheable"
txresp \
-bodylen 210
} -start
server s2 {
rxreq
expect req.url == "/expires"
# Expires header is filled directly by the expires_be backend"
txresp \
-bodylen 170
} -start
haproxy h1 -conf {
defaults
mode http
${no-htx} option http-use-htx
timeout connect 1s
timeout client 1s
timeout server 1s
frontend fe
bind "fd@${fe}"
use_backend expires_be if { path_beg /expires }
default_backend test
backend expires_be
http-request cache-use my_cache
server www ${s2_addr}:${s2_port}
http-response set-header X-Cache-Hit %[res.cache_hit]
# Expires value set in the future (current_time+5s)
http-response set-header Expires %[date(5),http_date]
http-response cache-store my_cache
backend test
http-request cache-use my_cache
server www ${s1_addr}:${s1_port}
http-response cache-store my_cache
http-response set-header X-Cache-Hit %[res.cache_hit]
cache my_cache
total-max-size 3
max-age 20
max-object-size 3072
} -start
client c1 -connect ${h1_fe_sock} {
txreq -url "/max-age"
rxresp
expect resp.status == 200
expect resp.bodylen == 150
txreq -url "/max-age"
rxresp
expect resp.status == 200
expect resp.bodylen == 150
expect resp.http.X-Cache-Hit == 1
txreq -url "/s-maxage"
rxresp
expect resp.status == 200
expect resp.bodylen == 160
txreq -url "/s-maxage"
rxresp
expect resp.status == 200
expect resp.bodylen == 160
expect resp.http.X-Cache-Hit == 1
txreq -url "/expires"
rxresp
expect resp.status == 200
expect resp.bodylen == 170
txreq -url "/expires"
rxresp
expect resp.status == 200
expect resp.bodylen == 170
expect resp.http.X-Cache-Hit == 1
txreq -url "/last-modified"
rxresp
expect resp.status == 200
expect resp.bodylen == 180
txreq -url "/last-modified"
rxresp
expect resp.status == 200
expect resp.bodylen == 180
expect resp.http.X-Cache-Hit == 1
txreq -url "/etag"
rxresp
expect resp.status == 200
expect resp.bodylen == 190
txreq -url "/etag"
rxresp
expect resp.status == 200
expect resp.bodylen == 190
expect resp.http.X-Cache-Hit == 1
# The next response should not be cached
txreq -url "/uncacheable"
rxresp
expect resp.status == 200
expect resp.bodylen == 200
txreq -url "/uncacheable"
rxresp
expect resp.status == 200
expect resp.bodylen == 210
expect resp.http.X-Cache-Hit == 0
} -run

3
reg-tests/cache/if-modified-since.vtc vendored
View File

@ -19,7 +19,8 @@ server s1 {
rxreq
expect req.url == "/date"
txresp -nolen -hdr "Transfer-Encoding: chunked" \
-hdr "Date: Thu, 22 Oct 2020 16:51:12 GMT"
-hdr "Date: Thu, 22 Oct 2020 16:51:12 GMT" \
-hdr "Cache-Control: max-age=5"
chunkedlen 16
chunkedlen 16
chunkedlen 16

12
reg-tests/cache/sample_fetches.vtc vendored
View File

@ -7,7 +7,8 @@ feature ignore_unknown_macro
server s1 {
rxreq
txresp -nolen -hdr "Transfer-Encoding: chunked"
txresp -nolen -hdr "Transfer-Encoding: chunked" \
-hdr "Cache-Control: max-age=5"
chunkedlen 15
chunkedlen 15
chunkedlen 15
@ -16,7 +17,8 @@ server s1 {
server s2 {
rxreq
txresp -nolen -hdr "Transfer-Encoding: chunked"
txresp -nolen -hdr "Transfer-Encoding: chunked" \
-hdr "Cache-Control: max-age=5"
chunkedlen 16
chunkedlen 16
chunkedlen 16
@ -25,14 +27,16 @@ server s2 {
server s3 {
rxreq
txresp -nolen -hdr "Transfer-Encoding: chunked"
txresp -nolen -hdr "Transfer-Encoding: chunked" \
-hdr "Cache-Control: max-age=5"
chunkedlen 17
chunkedlen 17
chunkedlen 17
chunkedlen 0
rxreq
txresp -nolen -hdr "Transfer-Encoding: chunked"
txresp -nolen -hdr "Transfer-Encoding: chunked" \
-hdr "Cache-Control: max-age=5"
chunkedlen 17
chunkedlen 17
chunkedlen 17

2
src/cache.c
View File

@ -664,7 +664,7 @@ enum act_return http_action_store_cache(struct act_rule *rule, struct proxy *px,
http_check_response_for_cacheability(s, &s->res);
if (!(txn->flags & TX_CACHEABLE) || !(txn->flags & TX_CACHE_COOK))
if (!(txn->flags & TX_CACHEABLE) || !(txn->flags & TX_CACHE_COOK) || (txn->flags & TX_CACHE_IGNORE))
goto out;
age = 0;

32
src/http_ana.c
View File

@ -3912,6 +3912,8 @@ void http_check_response_for_cacheability(struct stream *s, struct channel *res)
struct http_txn *txn = s->txn;
struct http_hdr_ctx ctx = { .blk = NULL };
struct htx *htx;
int has_freshness_info = 0;
int has_validator = 0;
if (txn->status < 200) {
/* do not try to cache interim responses! */
@ -3949,7 +3951,37 @@ void http_check_response_for_cacheability(struct stream *s, struct channel *res)
txn->flags &= ~TX_CACHE_COOK;
continue;
}
if (istmatchi(ctx.value, ist("s-maxage")) ||
istmatchi(ctx.value, ist("max-age"))) {
has_freshness_info = 1;
continue;
}
}
/* If no freshness information could be found in Cache-Control values,
* look for an Expires header. */
if (!has_freshness_info) {
ctx.blk = NULL;
has_freshness_info = http_find_header(htx, ist("expires"), &ctx, 0);
}
/* If no freshness information could be found in Cache-Control or Expires
* values, look for an explicit validator. */
if (!has_freshness_info) {
ctx.blk = NULL;
has_validator = 1;
if (!http_find_header(htx, ist("etag"), &ctx, 0)) {
ctx.blk = NULL;
if (!http_find_header(htx, ist("last-modified"), &ctx, 0))
has_validator = 0;
}
}
/* We won't store an entry that has neither a cache validator nor an
* explicit expiration time, as suggested in RFC 7234#3. */
if (!has_freshness_info && !has_validator)
txn->flags |= TX_CACHE_IGNORE;
}
/*