stfalcon-studio/doctrine-redis-cache-bundle

Add custom namespace for doctrine cache pools.

3.0.0 2024-02-12 18:16 UTC

Requires

• php: >=8.2
• ext-redis: *
• doctrine/doctrine-migrations-bundle: ^3.2
• symfony/cache: ^7.0
• symfony/config: ^7.0
• symfony/dependency-injection: ^7.0
• symfony/framework-bundle: ^7.0
• symfony/http-kernel: ^7.0

Requires (Dev)

• escapestudios/symfony2-coding-standard: ^3.12
• phpstan/phpstan: ^1.8.2
• phpstan/phpstan-doctrine: ^1.3
• phpstan/phpstan-phpunit: ^1.1
• phpstan/phpstan-symfony: ^1.2
• phpunit/phpunit: ^9.5

MIT

• Artem Henvald

• redis
• symfony
• cache
• bundle
• doctrine
• cache pool

README

📦 Add custom namespace for doctrine cache pools.

Problem Solved By This Bundle

When you use Redis as cache provider to store Doctrine query/metadata/result/second level cache, Doctrine generates unique keys for each cache item. When you change your database schema, create a new migration (Doctrine migration) and then deploy it to production, you have to clean your Doctrine cache after deploy. Doctrine has console commands to clean any type of cache and they work well. But if during the cache flushing, you have already running script (long running console/cron task or consumer) it still uses old schema info which can conflict with your new schema. In this case this script can regenerate cache (because it has been already flushed) with old schema metadata, query, result etc.

To prevent this problem, we add a custom namespace for each selected cache pool. This namespace is a name of the last migration version. For example, you deploy the first version of your project to production. Last migration version is 1 so all keys in cache will have prefix [1] (e.g. [1]hash_by_doctrine). Then you modify your schema, generate a new migration (version 2) and deploy it to production. Old running script will still use and generate keys with prefix [1], but new scripts will begin to use fresh prefix [2] and don't conflict with previous prefix.

After that you can stop or rerun old script. And after rerun they will use a new prefix and you can clean cache entries with the previous prefix.

Installation

composer req stfalcon-studio/doctrine-redis-cache-bundle

Check the config/bundles.php file

By default Symfony Flex will add this bundle to the config/bundles.php file. But in case when you ignored contrib-recipe during bundle installation it would not be added. In this case add the bundle manually.

# config/bundles.php

return [
    // Other bundles...
    StfalconStudio\DoctrineRedisCacheBundle\StfalconStudioDoctrineRedisCacheBundle::class => ['all' => true],
    // Other bundles...
];

Example of possible cache pool configuration

framework:
    cache:
        default_redis_provider: snc_redis.default
        pools:
            doctrine.result_cache_pool:
                adapter: cache.adapter.redis
                provider: snc_redis.doctrine_result_cache
            doctrine.metadata_cache_pool:
                adapter: cache.adapter.redis
                provider: snc_redis.doctrine_metadata_cache
            doctrine.query_cache_pool:
                adapter: cache.adapter.redis
                provider: snc_redis.doctrine_query_cache

Bundle configuration

stfalcon_studio_doctrine_redis_cache:
    cache_pools:
        - 'doctrine.query_cache_pool'
        - 'doctrine.metadata_cache_pool'
        - 'doctrine.result_cache_pool'

Contributing

Read the CONTRIBUTING file.