pixelfederation/doctrine-resettable-em-bundle

Symfony bundle for decorating default entity managers using a resettable decorator.

8.1.0 2024-01-03 11:45 UTC

Requires

• php: >= 8.1
• doctrine/doctrine-bundle: ^2.10
• doctrine/orm: ^2.15
• symfony/config: ^5.4|^6.3|^7.0
• symfony/dependency-injection: ^5.4|^6.3|^7.0
• symfony/proxy-manager-bridge: ^5.4|^6.3|^7.0
• symfony/yaml: ^5.4|^6.3|^7.0

Requires (Dev)

• doctrine/annotations: ^2.0
• friendsofphp/php-cs-fixer: ^3.13.2
• nikic/php-parser: ^4.2
• php-parallel-lint/php-parallel-lint: ^1.3
• phpcompatibility/php-compatibility: ^9.1
• phpmd/phpmd: ^2.8
• phpro/grumphp: ^2.4
• phpstan/phpstan: ^1.0
• phpstan/phpstan-webmozart-assert: ^1.0
• phpunit/phpunit: ^10.2
• pixelfederation/coding-standards: ^2.1
• roave/security-advisories: dev-master
• squizlabs/php_codesniffer: ^3.4
• symfony/browser-kit: ^5.4|^6.3
• symfony/flex: ^2.3
• symfony/framework-bundle: ^5.4|^6.3
• symfony/http-kernel: ^5.4|^6.3
• symfony/phpunit-bridge: ^6.3
• symplify/config-transformer: ^12.0
• vimeo/psalm: 6.x-dev

MIT

• Martin Fris

README

This bundle should be used with workloads where Symfony doesn't get initialized on each request, but stays in memory and the same instance handles multiple requests, one after another (e.g. when using Swoole Bundle). Another use case would be message queue consuming (e.g. Symfony messenger), where it is needed to clear (and possibly reset) the entity manager after processing a message.

The best feature of this bundle is, that it wraps all configured entity managers into a ResettableEntityManager instance, which is able to reset the entity manager when it gets stuck on an exception. After each request the entity manager gets cleared or reset, if an exception occurred during request handling.

Also another feature is, that on each request start the entity manager connection gets pinged, so the connection won't get closed after some period of time.

Instalation

composer require pixelfederation/doctrine-resettable-em-bundle

SETUP

// config/bundles.php
return [
    //...
    \PixelFederation\DoctrineResettableEmBundle\PixelFederationDoctrineResettableEmBundle::class => ['all' => true]
    //...
];

pixel_federation_doctrine_resettable_em:
  exclude_from_processing:
    # these entity managers won't be wrapped by the resettable entity manager:
    entity_managers:
        - readonly
    # these dbal connections won't be assigned to the keep alive handler
    dbal:
      - readonly
    # these redis cluster connections won't be assigned to the keep alive handler
    redis_cluster:
        - default
  # default 0 - if set, the connection ping operation will be executed each X seconds 
  # (instead of at the beginning of each request) 
  ping_interval: 10 
  # default false - if set to true, the app will check if there is an active transaction
  # in the processed connection, and it will rollback the transaction
  check_active_transactions: true
  # for reader writer connections, each has to be defined as 'reader' or 'writer' to be able for the symfony
  # app to reconnect after db failover. currently only AWS Aurora is supported.
  failover_connections:  
    default: writer
  # redis clusters which need to be failed over should be registered here
  # it's really important to set default timeouts to a low value, e.g. 2 seconds, so the app won't block for too long
  redis_cluster_connections:
    default: 'RedisCluster' # connection name (can be literally anything) => redis cluster service id

Migration from v5 to v6

Change all usages of PixelFederation\DoctrineResettableEmBundle\RequestCycle\InitializerInterface to PixelFederation\DoctrineResettableEmBundle\RequestCycle\Initializer