[Translation][Cache][Doctrine] refresh cache when resources file change.

aitboudad · aitboudad · commit 2860af4735bf · 2015-04-07T11:18:38.000+01:00
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Translation/TranslatorDoctrineCacheTest.php b/src/Symfony/Bridge/Doctrine/Tests/Translation/TranslatorDoctrineCacheTest.php
@@ -16,14 +16,45 @@
 use Symfony\Component\Translation\MessageSelector;
 use Symfony\Bridge\Doctrine\Translation\DoctrineMessageCache;
 use Doctrine\Common\Cache\ArrayCache;
+use Symfony\Component\Translation\Loader\PhpFileLoader;
+use Symfony\Component\Translation\Dumper\PhpFileDumper;
 
 class TranslatorDoctrineCacheTest extends \PHPUnit_Framework_TestCase
 {
+    protected $tmpDir;
+
     protected function setUp()
     {
         if (!interface_exists('Doctrine\Common\Cache\Cache')) {
             $this->markTestSkipped('The "Doctrine Cache" is not available');
         }
+
+        $this->tmpDir = sys_get_temp_dir().'/sf2_translation';
+        $this->deleteTmpDir();
+    }
+    protected function tearDown()
+    {
+        $this->deleteTmpDir();
+    }
+
+    protected function deleteTmpDir()
+    {
+        if (!file_exists($dir = $this->tmpDir)) {
+            return;
+        }
+
+        $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($this->tmpDir), \RecursiveIteratorIterator::CHILD_FIRST);
+        foreach ($iterator as $path) {
+            if (preg_match('#[/\\\\]\.\.?$#', $path->__toString())) {
+                continue;
+            }
+            if ($path->isDir()) {
+                rmdir($path->__toString());
+            } else {
+                unlink($path->__toString());
+            }
+        }
+        rmdir($this->tmpDir);
     }
 
     public function testTrans()
@@ -98,6 +129,34 @@ public function testRefreshCacheWhenResourcesChange()
         $this->assertEquals('foo B', $translator->trans('foo'));
     }
 
+    public function testRefreshCacheWhenResourcesFileChange()
+    {
+        $resourceFile = $this->tmpDir.'/messages.fr.php';
+        $loader = new PhpFileLoader();
+        $dumper = new PhpFileDumper();
+
+        // prime the cache
+        $cache =  new DoctrineMessageCache(new ArrayCache(), true);
+        $dumper->dump(new MessageCatalogue('fr', array('messages' => array('foo' => 'foo A'))), array('path' => $this->tmpDir));
+
+        $translator = new Translator('fr', new MessageSelector(), $cache);
+        $translator->addLoader('loader', $loader);
+        $translator->addResource('loader', $resourceFile, 'fr');
+
+        $this->assertEquals('foo A', $translator->trans('foo'));
+
+        // add a new resource to refresh the cache
+        $dumper->dump(new MessageCatalogue('fr', array('messages' => array('foo' => 'foo B'))), array('path' => $this->tmpDir));
+        touch($resourceFile, time() + 3600);
+        clearstatcache(true, $resourceFile);
+
+        $translator = new Translator('fr', new MessageSelector(), $cache);
+        $translator->addLoader('loader', $loader);
+        $translator->addResource('loader', $resourceFile, 'fr');
+
+        $this->assertEquals('foo B', $translator->trans('foo'));
+    }
+
     protected function getLoader()
     {
         $loader = $this->getMock('Symfony\Component\Translation\Loader\LoaderInterface');
diff --git a/src/Symfony/Bridge/Doctrine/Translation/DoctrineMessageCache.php b/src/Symfony/Bridge/Doctrine/Translation/DoctrineMessageCache.php
@@ -21,6 +21,8 @@
 class DoctrineMessageCache implements MessageCacheInterface
 {
     const CACHE_RESOURCE_HASH = 'resources_hash';
+    const CACHE_DUMP_TIME = 'time';
+    const CACHE_META_DATA = 'meta';
     const CATALOGUE_FALLBACK_LOCALE = 'fallback_locale';
 
     /**
@@ -39,21 +41,26 @@ class DoctrineMessageCache implements MessageCacheInterface
      */
     public function __construct(Cache $cache, $debug = false)
     {
-        $this->debug = $debug;
         $this->cache = $cache;
+        $this->debug = $debug;
     }
 
     /**
      * {@inheritdoc}
      */
     public function isFresh($locale, array $options = array())
     {
-        $currentResourcesHash = isset($options['resources_hash']) ? $options['resources_hash'] : '';
         $resourcesHash = $this->cache->fetch($this->getResourceHashKey($locale));
-        if (false === $resourcesHash || ($this->debug && $resourcesHash !== $currentResourcesHash)) {
+        if (false === $resourcesHash) {
             return false;
         }
 
+        if ($this->debug) {
+            $currentResourcesHash = isset($options['resources_hash']) ? $options['resources_hash'] : '';
+
+            return $this->isMetaDataFresh($locale, $currentResourcesHash);
+        }
+
         return true;
     }
 
@@ -83,7 +90,8 @@ public function dump(MessageCatalogueInterface $messages, array $options = array
             $catalogue = new DoctrineMessageCatalogue($messages->getLocale(), $this->cache);
             $catalogue->addCatalogue($messages);
 
-            $this->cache->save($this->getResourceHashKey($messages->getLocale()), $resourcesHash);
+            $this->dumpMetaDataCatalogue($messages->getLocale(), $messages->getResources(), $resourcesHash);
+
             if ($fallback = $messages->getFallbackCatalogue()) {
                 $this->cache->save($this->getFallbackLocaleKey($messages->getLocale()), $fallback->getLocale());
             }
@@ -92,6 +100,41 @@ public function dump(MessageCatalogueInterface $messages, array $options = array
         }
     }
 
+    private function isMetaDataFresh($locale, $currentResourcesHash)
+    {
+        $resourcesHash = $this->cache->fetch($this->getResourceHashKey($locale));
+        if ($resourcesHash !== $currentResourcesHash) {
+            return false;
+        }
+
+        $time = $this->cache->fetch($this->getDumpTimeKey($locale));
+        $meta = unserialize($this->cache->fetch($this->getMetaDataKey($locale)));
+        foreach ($meta as $resource) {
+            if (!$resource->isFresh($time)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    private function dumpMetaDataCatalogue($locale, $metadata, $resourcesHash)
+    {
+        $this->cache->save($this->getMetaDataKey($locale), serialize($metadata));
+        $this->cache->save($this->getResourceHashKey($locale), $resourcesHash);
+        $this->cache->save($this->getDumpTimeKey($locale), time());
+    }
+
+    private function getDumpTimeKey($locale)
+    {
+        return self::CACHE_DUMP_TIME.'_'.$locale;
+    }
+
+    private function getMetaDataKey($locale)
+    {
+        return self::CACHE_META_DATA.'_'.$locale;
+    }
+
     private function getResourceHashKey($locale)
     {
         return self::CACHE_RESOURCE_HASH.'_'.$locale;
diff --git a/src/Symfony/Bridge/Doctrine/composer.json b/src/Symfony/Bridge/Doctrine/composer.json
@@ -30,6 +30,7 @@
         "symfony/expression-language": "~2.2|~3.0.0",
         "symfony/validator": "~2.5,>=2.5.5|~3.0.0",
         "symfony/translation": "~2.7|~3.0.0",
+        "symfony/config": "~2.3,>=2.3.12|~3.0.0",
         "doctrine/data-fixtures": "1.0.*",
         "doctrine/dbal": "~2.2",
         "doctrine/orm": "~2.2,>=2.2.3",
