Missing varnish configuration for API-Platform workflow

[vasilvestre]

https://api-platform.com/docs/core/performance/#enabling-the-built-in-http-cache-invalidation-system does not contains any information about how APIP works with varnish.

This part in particular :

    if (req.http.ApiPlatform-Ban-Regex) {
      ban("obj.http.Cache-Tags ~ " + req.http.ApiPlatform-Ban-Regex);

      return (synth(200, "Ban added"));
    }

[dunglas]

Indeed, this docs entry needs to be updated.

The VCL to use is here: https://github.com/api-platform/api-platform/blob/v2.1.6/docker/varnish/conf/default.vcl (cc @dbu).

Also, we're in the process of integrating the Caddy Cache handler (which uses Souin) to replace Varnish: api-platform/api-platform#2383

[vasilvestre]

The VCL to use is here: https://github.com/api-platform/api-platform/blob/v2.1.6/docker/varnish/conf/default.vcl (cc @dbu).

Do you want me to create the PR or do you notify dbu so he change the entry?

Also, we're in the process of integrating the Caddy Cache handler (which uses Souin) to replace Varnish: api-platform/api-platform#2383

I totally prefer this but changing existing nginx isn't a light task

[dbu]

i do not plan to do a pull request for it, glad if you want to do it @vasilvestre

and i just notice in the example that you invalidate tags with ban. this works, but if you have a lot of traffic and frequent bans, this can put a high overhead on varnish. the best way to handle tags is with the varnish xkey module.

(the banlist needs to be checked against every request, and is a regex on the tags header. with xkey, varnish creates an optimized tree to look up keys so it can immediately invalidate the caches with those tags and avoid overhead)

[vasilvestre]

@dbu the part about xkey is documented in the documentation right ? Your point is that the vcl from dunglas don't handle this one case ?

[dbu]

ah i did not look at the documentation. yeah that mentions xkey but the vcl needs to handle it as well. (and the doc could explain why xkey are preferred over ban)

[soyuka]

It's on my todolist to improve this but I'm stuck with website issues, feel free to propose a documentation for xkey.