Skip to content

Instantly share code, notes, and snippets.

@henkvalk
Last active March 25, 2024 20:59
Show Gist options
  • Save henkvalk/f3b1cee66c1daf65b69630a01b8b096e to your computer and use it in GitHub Desktop.
Save henkvalk/f3b1cee66c1daf65b69630a01b8b096e to your computer and use it in GitHub Desktop.
A solution for softpurges in Magento on Varnish 6.0 many thanks to @IvanChepurnyi
vcl 4.1;
import std;
import xkey;
# The minimal Varnish version is 6.0
# For SSL offloading, pass the following header in your proxy server or load balancer: 'X-Forwarded-Proto: https'
backend default {
.host = "127.0.0.1";
.port = "8080";
}
acl purge {
"127.0.0.1";
}
sub vcl_recv {
if (req.method == "PURGE") {
if (client.ip !~ purge) {
return (synth(405, "Method not allowed"));
}
if (!req.http.X-Magento-Tags-Pattern) {
return (synth(400, "X-Magento-Tags-Pattern header required"));
}
set req.http.X-Key-Purge = regsuball(req.http.X-Magento-Tags-Pattern, "[\(\)\^\$]", "");
set req.http.X-Key-Purge = regsuball(req.http.X-Key-Purge, "[,\|]", " ");
set req.http.X-Key-Purge = regsuball(req.http.X-Key-Purge, "\.\*", "all");
set req.http.n-gone = xkey.softpurge(req.http.X-Key-Purge);
return (synth(200, "Purged " + req.http.n-gone + " records"));
}
if (req.method != "GET" &&
req.method != "HEAD" &&
req.method != "PUT" &&
req.method != "POST" &&
req.method != "TRACE" &&
req.method != "OPTIONS" &&
req.method != "DELETE") {
/* Non-RFC2616 or CONNECT which is weird. */
return (pipe);
}
# We only deal with GET and HEAD by default
if (req.method != "GET" && req.method != "HEAD") {
return (pass);
}
# Bypass Shopping cart, Checkout and Search request
# If your checkout url is firecheckout for example, add: || req.url ~ "/firecheckout"
if (req.url ~ "/checkout" || req.url ~ "/catalogsearch" || req.url ~ "/firecheckout" || req.url ~ "/postcode-eu") {
return (pass);
}
# normalize url in case of leading HTTP scheme and domain
set req.url = regsub(req.url, "^http[s]?://", "");
# collect all cookies
std.collect(req.http.Cookie);
# Compression filter. See https://www.varnish-cache.org/trac/wiki/FAQ/Compression
if (req.http.Accept-Encoding) {
if (req.url ~ "\.(jpg|jpeg|png|gif|gz|tgz|bz2|tbz|mp3|ogg|swf|flv)$") {
# No point in compressing these
unset req.http.Accept-Encoding;
} elsif (req.http.Accept-Encoding ~ "gzip") {
set req.http.Accept-Encoding = "gzip";
} elsif (req.http.Accept-Encoding ~ "deflate" && req.http.user-agent !~ "MSIE") {
set req.http.Accept-Encoding = "deflate";
} else {
# unkown algorithm
unset req.http.Accept-Encoding;
}
}
# Remove Google gclid parameters to minimize the cache objects
set req.url = regsuball(req.url,"\?gclid=[^&]+$",""); # strips when QS = "?gclid=AAA"
set req.url = regsuball(req.url,"\?gclid=[^&]+&","?"); # strips when QS = "?gclid=AAA&foo=bar"
set req.url = regsuball(req.url,"&gclid=[^&]+",""); # strips when QS = "?foo=bar&gclid=AAA" or QS = "?foo=bar&gclid=AAA&bar=baz"
# static files are always cacheable. remove SSL flag and cookie
if (req.url ~ "^/(pub/)?(media|static)/.*\.(ico|css|js|jpg|jpeg|png|gif|tiff|bmp|mp3|ogg|svg|swf|woff|woff2|eot|ttf|otf)$") {
unset req.http.Https;
unset req.http.X-Forwarded-Proto;
unset req.http.Cookie;
}
return (hash);
}
sub vcl_hash {
if (req.http.cookie ~ "X-Magento-Vary=") {
hash_data(regsub(req.http.cookie, "^.*?X-Magento-Vary=([^;]+);*.*$", "\1"));
}
# For multi site configurations to not cache each other's content
if (req.http.host) {
hash_data(req.http.host);
} else {
hash_data(server.ip);
}
# To make sure http users don't see ssl warning
if (req.http.X-Forwarded-Proto) {
hash_data(req.http.X-Forwarded-Proto);
}
/* {{ design_exceptions_code }} */
}
sub vcl_backend_response {
if (beresp.http.content-type ~ "text") {
set beresp.do_esi = true;
}
if (bereq.url ~ "\.js$" || beresp.http.content-type ~ "text") {
set beresp.do_gzip = true;
}
# cache only successfully responses and 404s
if (beresp.status != 200 && beresp.status != 404) {
set beresp.ttl = 120s;
set beresp.uncacheable = true;
return (deliver);
} elsif (beresp.http.Cache-Control ~ "private") {
set beresp.uncacheable = true;
set beresp.ttl = 86400s;
return (deliver);
}
if (beresp.http.X-Magento-Debug) {
set beresp.http.X-Magento-Cache-Control = beresp.http.Cache-Control;
}
if (beresp.http.X-Magento-Tags) {
set beresp.http.XKey = regsuball(beresp.http.X-Magento-Tags, ",", " ") + " all";
}
# validate if we need to cache it and prevent from setting cookie
# images, css and js are cacheable by default so we have to remove cookie also
if (beresp.ttl > 0s && (bereq.method == "GET" || bereq.method == "HEAD")) {
unset beresp.http.set-cookie;
set beresp.grace = 1h;
if (bereq.url !~ "\.(ico|css|js|jpg|jpeg|png|gif|tiff|bmp|gz|tgz|bz2|tbz|mp3|ogg|svg|swf|woff|woff2|eot|ttf|otf)(\?|$)") {
set beresp.http.Pragma = "no-cache";
set beresp.http.Expires = "-1";
set beresp.http.Cache-Control = "no-store, no-cache, must-revalidate, max-age=0";
set beresp.grace = 1m;
}
}
# If page is not cacheable then bypass varnish for 2 minutes as Hit-For-Pass
if (beresp.ttl <= 0s ||
beresp.http.Surrogate-control ~ "no-store" ||
(!beresp.http.Surrogate-Control && beresp.http.Vary == "*")) {
# Mark as Hit-For-Pass for the next 2 minutes
set beresp.ttl = 120s;
set beresp.uncacheable = true;
}
return (deliver);
}
sub vcl_hit {
if (obj.ttl >= 0s) {
set req.http.cached = "hit";
return (deliver);
}
if (obj.ttl + obj.grace > 0s) {
set req.http.cached = "stale";
return (deliver);
}
// fetch & deliver once we get the result
set req.http.cached = "miss";
return (miss);
}
sub vcl_deliver {
if (resp.http.X-Magento-Debug) {
if (resp.http.x-varnish ~ " ") {
set resp.http.X-Magento-Cache-Debug = "HIT";
} else {
set resp.http.X-Magento-Cache-Debug = "MISS";
}
}
if (req.http.cached) {
set resp.http.X-Cache = req.http.cached;
} else {
set resp.http.X-Cache = "miss";
}
unset resp.http.X-Magento-Debug;
unset resp.http.X-Magento-Tags;
unset resp.http.XKey;
unset resp.http.X-Powered-By;
unset resp.http.Server;
unset resp.http.X-Varnish;
unset resp.http.Via;
unset resp.http.Link;
}
@henkvalk
Copy link
Author

henkvalk commented May 11, 2023

It will also set inside the chrome dev tools > Network
Click on Doc, click the 200 document on the left: you will see X-cache

Not cached:

X-Cache: miss

Cached:

X-Cache: hit

Cached but served old version while new is generated

X-Cache: stale

@henkvalk
Copy link
Author

henkvalk commented May 11, 2023

How to install on Hypernode:

Download this varnish.vcl to your server

mkdir -p /data/web/vcl/ && cd $_
wget https://gist.githubusercontent.com/henkvalk/f3b1cee66c1daf65b69630a01b8b096e/raw/e50bdcc74d1647db4ea960138dc2bbdca1700a94/varnish.vcl

Load this varnish.vcl into varnish

varnishadm vcl.load varnish_softpurges /data/web/vcl/varnish.vcl

When successfull it will retrun VCL compiled.

Use this profile:

varnishadm vcl.use varnish_softpurges

When successfull it will retrun VCL 'varnish_softpurges' now active

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment