Added event subscriber to clear entity cache on doctrine clear (martin-georgiev#8)

Author: robwasripped

src/SimpleThings/EntityAudit/AuditManager.php

@@ -17,13 +17,16 @@ class AuditManager
 
     private $metadataFactory;
 
+    private $entityCache;
+
     /**
      * @param AuditConfiguration $config
      */
-    public function __construct(AuditConfiguration $config)
+    public function __construct(AuditConfiguration $config, EntityCache $entityCache)
     {
         $this->config = $config;
         $this->metadataFactory = $config->createMetadataFactory();
+        $this->entityCache = $entityCache;
     }
 
     public function getMetadataFactory()
@@ -38,7 +41,7 @@ public function getConfiguration()
 
     public function createAuditReader(EntityManager $em)
     {
-        return new AuditReader($em, $this->config, $this->metadataFactory);
+        return new AuditReader($em, $this->config, $this->metadataFactory, $this->entityCache);
     }
 
     public function registerEvents(EventManager $evm)

src/SimpleThings/EntityAudit/AuditReader.php

@@ -69,7 +69,7 @@ class AuditReader
 
     /**
      * Entity cache to prevent circular references
-     * @var array
+     * @var EntityCache
      */
     private $entityCache;
 
@@ -166,11 +166,12 @@ public function setLoadNativeEntities($loadNativeEntities)
      * @param AuditConfiguration $config
      * @param MetadataFactory $factory
      */
-    public function __construct(EntityManagerInterface $em, AuditConfiguration $config, MetadataFactory $factory)
+    public function __construct(EntityManagerInterface $em, AuditConfiguration $config, MetadataFactory $factory, EntityCache $entityCache)
     {
         $this->em = $em;
         $this->config = $config;
         $this->metadataFactory = $factory;
+        $this->entityCache = $entityCache;
         $this->platform = $this->em->getConnection()->getDatabasePlatform();
         $this->quoteStrategy = $this->em->getConfiguration()->getQuoteStrategy();
     }
@@ -196,7 +197,7 @@ public function getConfiguration()
      */
     public function clearEntityCache()
     {
-        $this->entityCache = array();
+        $this->entityCache->clear();
     }
 
     /**
@@ -363,11 +364,8 @@ private function createEntity($className, array $columnMap, array $data, $revisi
 
         $key = implode(':', $keyParts);
 
-        if (isset($this->entityCache[$className]) &&
-            isset($this->entityCache[$className][$key]) &&
-            isset($this->entityCache[$className][$key][$revision])
-        ) {
-            return $this->entityCache[$className][$key][$revision];
+        if ($this->entityCache->hasEntity($className, $key, $revision)) {
+            return $this->entityCache->getEntity($className, $key, $revision);
         }
 
         if (!$class->isInheritanceTypeNone()) {
@@ -396,7 +394,7 @@ private function createEntity($className, array $columnMap, array $data, $revisi
         }
 
         //cache the entity to prevent circular references
-        $this->entityCache[$className][$key][$revision] = $entity;
+        $this->entityCache->addEntity($className, $key, $revision, $entity);
 
         foreach ($data as $field => $value) {
             if (isset($class->fieldMappings[$field])) {

src/SimpleThings/EntityAudit/EntityCache.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleThings\EntityAudit;
+
+class EntityCache
+{
+    private $entities = [];
+
+    public function clear(): void
+    {
+        $this->entities = [];
+    }
+
+    public function hasEntity(string $className, string $key, string $revision): bool
+    {
+        return isset($this->entities[$className])
+            && isset($this->entities[$className][$key])
+            && isset($this->entities[$className][$key][$revision]);
+    }
+
+    public function addEntity(string $className, string $key, string $revision, $entity): void
+    {
+        $this->entities[$className][$key][$revision] = $entity;
+    }
+
+    public function getEntity(string $className, string $key, string $revision)
+    {
+        if($this->hasEntity($className, $key, $revision)) {
+            return $this->entities[$className][$key][$revision];
+        }
+    }
+}

src/SimpleThings/EntityAudit/EventListener/CacheListener.php

@@ -0,0 +1,31 @@
+<?php
+
+declare (strict_types=1);
+
+namespace SimpleThings\EntityAudit\EventListener;
+
+use Doctrine\Common\EventSubscriber;
+use Doctrine\ORM\Events;
+use SimpleThings\EntityAudit\EntityCache;
+
+class CacheListener implements EventSubscriber
+{
+    private $entityCache;
+
+    public function __construct(EntityCache $entityCache)
+    {
+        $this->entityCache = $entityCache;
+    }
+
+    public function getSubscribedEvents(): array
+    {
+        return [
+            Events::onClear,
+        ];
+    }
+
+    public function onClear(): void
+    {
+        $this->entityCache->clear();
+    }
+}

src/SimpleThings/EntityAudit/Resources/config/auditable.xml

@@ -18,6 +18,7 @@
     <services>
         <service id="simplethings_entityaudit.manager" class="SimpleThings\EntityAudit\AuditManager" public="true">
             <argument id="simplethings_entityaudit.config" type="service" />
+            <argument id="SimpleThings\EntityAudit\EntityCache" type="service" />
         </service>
 
         <service id="SimpleThings\EntityAudit\AuditManager" alias="simplethings_entityaudit.manager" public="true" />
@@ -29,6 +30,8 @@
 
         <service id="SimpleThings\EntityAudit\AuditReader" alias="simplethings_entityaudit.reader" />
 
+        <service id="SimpleThings\EntityAudit\EntityCache" class="SimpleThings\EntityAudit\EntityCache" public="true" />
+
         <service id="simplethings_entityaudit.log_revisions_listener" class="SimpleThings\EntityAudit\EventListener\LogRevisionsListener">
             <argument id="simplethings_entityaudit.manager" type="service" />
             <tag name="doctrine.event_subscriber" connection="default" />
@@ -39,6 +42,11 @@
             <tag name="doctrine.event_subscriber" connection="default" />
         </service>
 
+        <service id="simplethings_entityaudit.cache_listener" class="SimpleThings\EntityAudit\EventListener\CacheListener">
+            <argument id="SimpleThings\EntityAudit\EntityCache" type="service" />
+            <tag name="doctrine.event_subscriber" connection="default" />
+        </service>
+
         <service id="simplethings_entityaudit.username_callable.token_storage" class="SimpleThings\EntityAudit\User\TokenStorageUsernameCallable">
             <argument id="service_container" type="service" />
         </service>

tests/SimpleThings/Tests/EntityAudit/BaseTest.php

@@ -34,6 +34,7 @@
 use Gedmo;
 use SimpleThings\EntityAudit\AuditConfiguration;
 use SimpleThings\EntityAudit\AuditManager;
+use SimpleThings\EntityAudit\EntityCache;
 
 abstract class BaseTest extends \PHPUnit_Framework_TestCase
 {
@@ -205,7 +206,7 @@ protected function getAuditManager()
             return 'beberlei';
         });
 
-        $auditManager = new AuditManager($auditConfig);
+        $auditManager = new AuditManager($auditConfig, new EntityCache());
         $auditManager->registerEvents($this->_getConnection()->getEventManager());
 
         return $this->auditManager = $auditManager;