weakbit/lucene-cache

Provides a cache backend for TYPO3 that stores all cache information in Lucene

1.0.1 2024-05-28 15:22 UTC

Requires

• php: ^8.1
• typo3/cms-core: ^11.5
• zf1s/zend-search-lucene: ^1.15.5

Requires (Dev)

• nimut/testing-framework: ^6.0.1
• phpstan/extension-installer: ^1.1
• pluswerk/grumphp-config: ^6.8.0
• rybakit/msgpack: *
• saschaegerer/phpstan-typo3: ^1.1
• ssch/typo3-rector: ^1.1.3
• typo3/cms-adminpanel: ^11.0 || ^12.0

Suggests

• rybakit/msgpack: To get a smaller and faster serialization of data

GPL-2.0-or-later

• Stefan Lamm

README

This extension adds a new Cache Backend for the TYPO3 Caching framework, using a PHP implementation of the lucene index to hold the data. The goal is have a ram-independent cache.

You have to decide if it makes sense to use this Backend, in general, the bigger the Cache gets the more sense lays in using lucene.

Example Configuration for the Cache

$GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations']['pages'] = [
    'frontend' => \TYPO3\CMS\Core\Cache\Frontend\VariableFrontend::class,
    'backend' => \Weakbit\LuceneCache\Cache\Backend\LuceneCacheBackend::class,
    'options' => [
        'defaultLifetime' => 604800,
        'indexName' => 'pages',
        'maxBufferedDocs' => 1000,
    ],
    'groups' => ['all']
];

The Option "indexName" must not contain other than the following chars: a-zA-Z0-9-_

Performance

The performance heavily depends on your setup und needs. In my case i checked it with a modern system using SATA SSD.

Also the Setup created quite very many "Cache-Tags".

maxBufferedDocs is set to 1000 here, that means that up to 1000 documents are buffered before the writeout, that is good for large imports if you have some spare ram. But keep in mind that a lookup (has,get,remove,flush) will always commit the buffer first to have a full index to search in.

Keep in mind

Cache is indented to be nearly valid, but concurrency or programatically issues between the cache layer and your data might lead into inconsistency, that is why you should think about queues and transactions as soon as the cache must be precise.

This extenion relies on using the SingleSpackTokenizer with the lucene package, so if you already use lucene in your project, your tokenizer is overwritten which could lead into problems. This is a todo we work on

Considerdations

You should consider to set a proper serializer to your PHP Installation e.g. msgpack or igbinary

To be done:

• implement metrics (hits/misses/inserts/deletions)
• Code quality coverage