Skip to content
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.

Sign up for GitHub

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

Added support for caching REST api calls to POST /api/ezp/v2/views #147

Draft
wants to merge 1 commit into
base: 2.0
Choose a base branch
from
Draft

Added support for caching REST api calls to POST /api/ezp/v2/views #147

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
50 changes: 47 additions & 3 deletions docs/varnish/vcl/varnish5.vcl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@

vcl 4.1;
import std;
import bodyaccess; //@added for POST handling
import xkey;

// For customizing your backend and acl rules see parameters.vcl
include "parameters.vcl";

// Called at the beginning of a request, after the complete request has been received
sub vcl_recv {
call ez_handle_post; //@added for POST handling

// Set the backend
set req.backend_hint = ezplatform;
Expand All @@ -31,8 +33,9 @@ sub vcl_recv {
// Trigger cache purge if needed
call ez_purge;

// Don't cache requests other than GET and HEAD.
if (req.method != "GET" && req.method != "HEAD") {
// @added for POST handling: `&& !req.http.X-Body-Len`
// --> Don't cache requests other than GET and HEAD. + and specific POST Requests
if (req.method != "GET" && !req.http.X-Body-Len && req.method != "HEAD") {
return (pass);
}

Expand Down Expand Up @@ -97,13 +100,20 @@ sub vcl_hit {
return (deliver);
}

std.log("MISS: " + req.url + " obj.ttl:" + obj.ttl + " obj.grace:" + obj.grace);
// fetch & deliver once we get the result
return (miss);
}

// Called when the requested object has been retrieved from the backend
sub vcl_backend_response {

// @added for POST handling
if (bereq.http.X-Body-Len) {
set beresp.http.cache-control = "public, max-age=600";
set beresp.http.xkey = "ez-all ez-post";
}

if (bereq.http.accept ~ "application/vnd.fos.user-context-hash"
&& beresp.status >= 500
) {
Expand Down Expand Up @@ -193,7 +203,8 @@ sub ez_user_context_hash {
return (synth(400));
}

if (req.restarts == 0 && (req.method == "GET" || req.method == "HEAD")) {
// @added for POST: `req.http.X-Body-Len ||`
if (req.restarts == 0 && (req.http.X-Body-Len || req.method == "GET" || req.method == "HEAD")) {
// Backup accept header, if set
if (req.http.accept) {
set req.http.x-fos-original-accept = req.http.accept;
Expand Down Expand Up @@ -327,3 +338,36 @@ sub vcl_deliver {
unset resp.http.x-user-context-hash;
}
}

// added to handle POST requests
sub vcl_hash {
# To cache POST and PUT requests
if (req.http.X-Body-Len) {
bodyaccess.hash_req_body();
} else {
hash_data("");
}
}

sub vcl_backend_fetch {
if (bereq.http.X-Body-Len) {
set bereq.method = "POST";
}
}

sub ez_handle_post {
// Making sure client is not able to preset headers we rely on for internal logic
unset req.http.X-Body-Len;
if (req.restarts == 0) {
unset req.http.x-fos-original-url;
}
// enables caching for API calls to "/api/ezp/v2/views"
if (req.method == "POST" && (req.url == "/api/ezp/v2/views" || req.http.x-fos-original-url == "/api/ezp/v2/views")) {
// std.log("ez_handle_post: Will cache POST for: " + req.http.host + req.url);
std.cache_req_body(500KB);
set req.http.X-Body-Len = bodyaccess.len_req_body();
if (req.http.X-Body-Len == "-1") {
return(synth(400, "The request body size exceeds the limit"));
}
}
}