flowpack/varnish

Varnish integration for Neos CMS

Varnish

Introduction

This package provides an out-of-the-box seamless integration between Varnish and Neos. It basically makes Neos send Cache-Control headers and BAN requests to Varnish for all document nodes.

Installation

You can install the package as usual with composer:

composer require flowpack/varnish

When installed, Neos sends headers for cache lifetime and cache invalidation requests.

Compatible with Neos 7.x+

Documentation

For more information, see the documentation

Thanks

This package was originally developed at MOC A/S, published as MOC.Varnish and eventually moved to the Flowpack namespace. You find previous PRs and issues there.

varnish's Issues

Versioning

Related to #4, could have a 1.0 and 2.0 branch

Require newer version of friendsofsymfony/http-cache

Hi together,

is there a reason, why Version ~1.3 is required for friendsofsymfony/http-cache. ?
That causes us some trouble in one setup, because 1.3 only allows HTTP-Requests for varnish. No https.

In the current version, it seems like the logic has changed. Is there some known incompatibility with a newer version? Or would it be an option to upgrade to a 2.x version?
I'm not so deep into Varnish as to be able to make a judgment.

Thanks for your help!

Introduce a unique instance hash for clearing the Varnish cache of a single Neos instance

• Automatically generate an instance hash in Data/Persistent
• Sent the instance hash as an extended header
• Automatically use the hash in the clear cache commands

Spider crawling

BUG: addFlashMessage can not handle Message object

When purging content cache for a certain content type (ex. text/css) you will get the following exception after the purging is done

Exception #1243258395 in line 175 of /var/www/website/Data/Temporary/Production/Cache/Code/Flow_Object_Classes/MOC_Varnish_Controller_VarnishCacheController.php: The message body must be of type string, "object" given. - See also: 20200513062504a2ac87.txt

This is due to a Object being passed to the flashMessage.

This change cast it to a string (using the __toString) method of the Message object

Support uncached segments with ESI and out-of-bound rendering

To make pages with uncached segments cachable, replace those segments with ESI includes that call a out-of-bound rendering of the specific segments.

CacheTags with Workspace hashes are not supported

In Neos 4.X, cache tags also include a hash of the workspace chain, see https://github.com/neos/neos-development-collection/blob/4.1/Neos.Neos/Classes/Fusion/Cache/ContentCacheFlusher.php#L98

So instead of NodeType_Neos_Neos-Document, the nodes are now tagged with
NodeType_%d0dbe915091d400bd8ee7f27f0791303%_Neos_Neos-Document, so pages cached in varnish are currently never banned.

Document nodes clear all nodes due to Menu object cache tags

• List of ignored tags in bans
• Explain how to improve that with different cache configuration if possible

VCL to remove varnish specific headers

https://github.com/FriendsOfSymfony/FOSHttpCache/blob/master/src/Handler/TagHandler.php
http://www.smashingmagazine.com/2014/04/23/cache-invalidation-strategies-with-varnish-cache/

Flow 3.0 / Neos 2.0 support

• Adjust Policy.yaml
• Remove "Notice that the search is case-sensitive" in backend module
• Remove JSON backend module workaround
• Use notifications when clearing cache for nodes
• Use notifications for alerts
• Remove excludeClasses

Improve backend module

Improve styling

Info button to show details like age and lifetime asynchronously

Clear by tag

Refactor CacheControlService to use TYPO3.TypoScript:Http.Message instead of signal

prototype(TYPO3.TypoScript:Http.Message).httpResponseHead.Cache-Controls = CustomTypoScriptObject

Needs refactoring of the internals to be able to access the necessary information, thus this is targeted at Neos 2.1+

Neos CMS 5.* version

Hi,

Any known blockes not mentioned in the issue list in order to release a version for Neos CMS 5.*? :-)

Asynchronous banning

Support for Neos 8

Hi,

is it possible to add support for Neos 8, it seems it just needs to update composer.json to allow.

Thanks

Calculate maximum life time (TTL) from all cache segments on a page

Cache-miss: Calculate the lowest TTL based on the content of the page
Cache-hit: Use TTL from Redis as header

Problem is that for already cached segments, their expire time cannot be retrieved in any way.

Changing an Asset does not flush pages that reference it

Neos creates the following tags in the content cache when using an asset:

• AssetDynamicTag_<$workspaceHash>_<assetIdentifier>
• AssetDynamicTag_<assetIdentifier>

Neither of those tags are flushed by this package when an Asset changes (AssetService assetUpdated Signal). See the Neos Package.php for comparison.

Since the MOC\Varnish\Service\ContentCacheFlusherService is basically a copy of the Neos Neos\Neos\Fusion\Cache\ContentCacheFlusher without the Asset stuff, fixing this is relatively easy, but IMO having that logic duplicated isn't great (that already broke once, see #41 and my guess is it might break again with the event sourced CR).

Flowpack.FullPageCache gets around this problem with the following aspect that intercepts the shutdownObject() method of the ContentCacheFlusher and grabs the cache tags: https://github.com/Flowpack/Flowpack.FullPageCache/blob/master/Classes/Aspects/ContentCacheAspect.php#L44

Since other packages seem to have the same problem, maybe adding a new Signal to the shutdownObject() method of the Neos ContentCacheFlusher here is the proper way to resolve this problem.
That way this package could simply connect a Slot to that Signal and flush the same tags that Neos flushes internally.

Multi-site & dimension support

Provide example VCL configuration for Varnish 3 and 4

Provide missing XLIFF files

On a fresh install (version ~2 and Neos 2) an Exception

#1334759591: No XLIFF file is available for MOC.Varnish::Main::en in the locale chain.

is thrown.

Documentation

Configuration/Settings option to disabled plugin

Hi,

i would like to have an option to disable the plugin by Settings.yaml configuration, because of our surf deployment script. We use the same composer.json on Development and Production context.

In Development context there is no varnish server available but the plugin causes extreme slow down of all publish actions in neos backend.

At the Production server everything is fine ...

Thanks.

Clear varnish cache for specific tags

Problem is that for already cached segments, their tags cannot be retrieved in any way.

Send all tags as headers to the page.

Implement a ban by tag strategy.

Functional tests