HTTP cache multi-tagging purge client by bdunogier · Pull Request #1894 · ezsystems/ezpublish-kernel

bdunogier · 2017-01-24T21:45:58Z

Part of EZP-22401

Adds support for new multi-tagging capabilities to cache purge clients:

FOSPurgeClient will iterate over the given cache tags, and send one purge request for each
LocalPurgeClient will send a unique request, with the tags separated by |, since the symfony Proxy knows how to handle that.

Changes since the previous feature branch

Updated fos_http_cache.md
Tried to prevent the BC break on PurgeClientInterface

TODO

Describe better
Change commit ownership
Improve the BC break prevention on PurgeClientInterface (see Limit BC changes on PurgeClientInterface #1896)

bdunogier · 2017-01-24T21:47:48Z

@andrerom can you have a look, mostly at the fos_http_cache.md file ? The PurgeClientInterface changes aren't final yet.

andrerom · 2017-01-25T08:50:32Z

 Varnish proxy client from FOSHttpCache lib is now used for clearing eZ Http cache, even when using Symfony HttpCache.
-A single `BAN` request is sent to registered purge servers, containing a `X-Location-Id` header.
-This header contains all Location IDs for which objects in cache need to be cleared.
+A single `BAN` request is sent to registered purge servers, containing a `xkey` header.


It's not BAN, its typically a PURGE when we deal with xkey

andrerom · 2017-01-25T08:51:20Z

-A single `BAN` request is sent to registered purge servers, containing a `X-Location-Id` header.
-This header contains all Location IDs for which objects in cache need to be cleared.
+A single `BAN` request is sent to registered purge servers, containing a `xkey` header.
+This header contains cache items tags that need to be cleared.


item, xkey (side: and fastly) currently only supports clearing one tag per request, so several requests are made.

andrerom · 2017-01-25T08:54:01Z

+     *
+     * @param array $locationIds Cache resource(s) to purge (e.g. array of URI to purge in a reverse proxy)
+     */
+    public function purge($locationIds);


Don't think we need to add purge and purgeAll here, its still on the old interface also being implemented.

Clearly a mistake, it wasn't supposed to end up here.

bdunogier · 2017-01-25T17:55:46Z


-        $purgeRequest = Request::create('http://localhost/', 'BAN');
-        $purgeRequest->headers->set('X-Location-Id', '(' . implode('|', $locationIds) . ')');
+        $purgeRequest = Request::create('http://localhost/', 'PURGE');


As far as I can tell, this won't work if the server is configured to use HTTPS.

andrerom · 2017-01-30T16:19:42Z


-        if (!is_array($locationIds)) {
-            $locationIds = array($locationIds);
+        // As xkey only support one tag (key) being invalidated at a time, we loop.


To align with xkey offical example as is also done in FOS and our VCL PR, lets change this to use key (only for Purges, for response headers for tags we use xkey as automatically used by the VMOD).

andrerom · 2017-01-30T16:19:52Z

+
+            $this->cacheManager->invalidatePath(
+                '/',
+                ['xkey' => $tag, 'Host' => empty($_SERVER['SERVER_NAME']) ? 'localhost' : $_SERVER['SERVER_NAME']]


andrerom · 2017-01-30T16:20:05Z

    public function purgeAll()
    {
-        $this->cacheManager->invalidate(array('X-Location-Id' => '.*'));
+        $this->cacheManager->invalidate(['xkey' => '.*']);


andrerom · 2017-01-30T16:20:15Z

-        $purgeRequest = Request::create('http://localhost/', 'BAN');
-        $purgeRequest->headers->set('X-Location-Id', '(' . implode('|', $locationIds) . ')');
+        $purgeRequest = Request::create('http://localhost/', 'PURGE');
+        $purgeRequest->headers->set('xkey', implode(' ', $tags));


andrerom · 2017-01-30T16:20:45Z

 Varnish proxy client from FOSHttpCache lib is now used for clearing eZ Http cache, even when using Symfony HttpCache.
-A single `BAN` request is sent to registered purge servers, containing a `X-Location-Id` header.
-This header contains all Location IDs for which objects in cache need to be cleared.
+It sends, for each cache tag that needs to be expired, a `PURGE` request with a `xkey` header to the registered purge servers.


bdunogier · 2017-01-30T23:53:32Z

This should be good to merge. Could you update your review if it's good to go for you as well @andrerom ?

andrerom

Looks good, but what is the failure about?

bdunogier · 2017-01-31T14:58:16Z

1) eZ\Publish\Core\FieldType\Tests\DateAndTimeTest::testFromHash with data set #3 (array('now'), eZ\Publish\Core\FieldType\DateAndTime\Value Object (...))
fromHash() method did not create expected result.
Failed asserting that 1485860774 is less than 1485860774.

Hum...

andrerom · 2017-01-31T15:02:13Z

ok that would most likely be buggy test.

bdunogier · 2017-01-31T15:05:47Z

Yeah, it seems so. It passes locally on all branches. Restarted it.

bdunogier · 2017-02-08T18:13:06Z

Replaced by http://github.com/ezsystems/ezplatform-http-cache. Please do not delete the branch yet.

bdunogier changed the base branch from master to feature-http_cache_multi_tagging January 24, 2017 21:46

bdunogier force-pushed the http_cache_purge_client branch from c879770 to 20ea6e7 Compare January 24, 2017 21:47

bdunogier changed the title ~~HTTP cache multi-tagging purge client~~ WIP: HTTP cache multi-tagging purge client Jan 24, 2017

andrerom reviewed Jan 25, 2017

View reviewed changes

bdunogier commented Jan 25, 2017

View reviewed changes

andrerom suggested changes Jan 30, 2017

View reviewed changes

bdunogier force-pushed the http_cache_purge_client branch from 9f45ec0 to 8388e6b Compare January 30, 2017 16:30

André R and others added 3 commits January 30, 2017 17:43

Multi-tagging purge client

ed81c3a

Updated fos_http_cache.md for multi-tagging

718c5d7

Limit BC changes on PurgeClientInterface

acaee40

bdunogier force-pushed the http_cache_purge_client branch from dc22773 to f00af38 Compare January 30, 2017 23:52

bdunogier changed the title ~~WIP: HTTP cache multi-tagging purge client~~ HTTP cache multi-tagging purge client Jan 30, 2017

Changed 'xkey' to 'key' for PURGE calls

bfc5b64

bdunogier force-pushed the http_cache_purge_client branch from f00af38 to bfc5b64 Compare January 31, 2017 11:02

bdunogier mentioned this pull request Jan 31, 2017

WIP: Http cache multi-tagging: MVC #1898

Closed

6 tasks

andrerom approved these changes Jan 31, 2017

View reviewed changes

bdunogier closed this Feb 8, 2017

alongosz deleted the http_cache_purge_client branch July 2, 2019 13:12

Conversation

bdunogier commented Jan 24, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes since the previous feature branch

TODO

Uh oh!

bdunogier commented Jan 24, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrerom Jan 25, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bdunogier commented Jan 30, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andrerom left a comment

Choose a reason for hiding this comment

Uh oh!

bdunogier commented Jan 31, 2017

Uh oh!

andrerom commented Jan 31, 2017

Uh oh!

bdunogier commented Jan 31, 2017

Uh oh!

bdunogier commented Feb 8, 2017

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

bdunogier commented Jan 24, 2017 •

edited

Loading

bdunogier commented Jan 24, 2017 •

edited

Loading

andrerom Jan 25, 2017 •

edited

Loading

bdunogier commented Jan 30, 2017 •

edited

Loading