Merge pull request #449 from jackalope/1-to-2

1 to 2

Author: dbu

CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+2.0.1
+-----
+
+* Fixed cache key sanitize for PSR-16 cache.
+* Fixed not found detection for PSR-16 cache.
+
 2.0.0
 -----
 
@@ -24,6 +30,12 @@ Changelog
 1.x
 ===
 
+1.13.0
+------
+
+* Fixed cache key sanitize for PSR-16 cache.
+* Fixed not found detection for PSR-16 cache.
+
 1.12.0
 ------
 

composer.json

@@ -43,8 +43,10 @@
         "psr-0": { "Jackalope\\": "src/" }
     },
     "autoload-dev": {
+        "psr-4": {
+            "Jackalope\\Tests\\": "tests/"
+        },
         "psr-0": {
-            "Jackalope\\Test\\": "tests/",
             "Jackalope\\": "vendor/jackalope/jackalope/tests",
             "PHPCR": "vendor/phpcr/phpcr/tests"
         }

phpunit.xml.dist

@@ -27,8 +27,8 @@
 
     <testsuites>
         <testsuite name="Jackalope Doctrine DBAL Tests">
-            <directory>tests/Jackalope/Transport</directory>
-            <directory>tests/Jackalope/Tools</directory>
+            <directory>tests/Transport</directory>
+            <directory>tests/Tools</directory>
             <directory>vendor/jackalope/jackalope/tests</directory>
             <directory>vendor/phpcr/phpcr/tests</directory>
             <directory>vendor/phpcr/phpcr-utils/tests</directory>

src/Jackalope/Transport/DoctrineDBAL/CachedClient.php

@@ -50,8 +50,12 @@ public function __construct(FactoryInterface $factory, Connection $conn, array $
             }
         }
         $this->caches = $caches;
-        $this->keySanitizer = static function (string $cacheKey): string {
-            return str_replace(' ', '_', $cacheKey);
+        $this->keySanitizer = static function ($cacheKey) {
+            return str_replace(
+                ['%', '.'],
+                ['_', '|'],
+                \urlencode($cacheKey)
+            );
         };
     }
 
@@ -219,7 +223,7 @@ public function getNode(string $path): \stdClass
         $cacheKey = "nodes: $path, ".$this->workspaceName;
         $cacheKey = $this->sanitizeKey($cacheKey);
 
-        if (false !== ($result = $this->caches['nodes']->get($cacheKey))) {
+        if (null !== ($result = $this->caches['nodes']->get($cacheKey))) {
             if ('ItemNotFoundException' === $result) {
                 throw new ItemNotFoundException("Item '$path' not found in workspace '$this->workspaceName'");
             }
@@ -354,7 +358,7 @@ public function getNodePathForIdentifier($uuid, $workspace = null): string
         $cacheKey = "nodes by uuid: $uuid, $this->workspaceName";
         $cacheKey = $this->sanitizeKey($cacheKey);
 
-        if (false !== ($result = $this->caches['nodes']->get($cacheKey))) {
+        if (null !== ($result = $this->caches['nodes']->get($cacheKey))) {
             if ('ItemNotFoundException' === $result) {
                 throw new ItemNotFoundException("no item found with uuid $uuid");
             }
@@ -407,7 +411,7 @@ public function getReferences($path, $name = null): array
         $cacheKey = "nodes references: $path, $name, ".$this->workspaceName;
         $cacheKey = $this->sanitizeKey($cacheKey);
 
-        if (false !== ($result = $this->caches['nodes']->get($cacheKey))) {
+        if (null !== ($result = $this->caches['nodes']->get($cacheKey))) {
             return $result;
         }
 
@@ -449,7 +453,7 @@ public function query(Query $query): array
         $cacheKey = "query: {$query->getStatement()}, {$query->getLimit()}, {$query->getOffset()}, {$query->getLanguage()}, ".$this->workspaceName;
         $cacheKey = $this->sanitizeKey($cacheKey);
 
-        if (false !== ($result = $this->caches['query']->get($cacheKey))) {
+        if (null !== ($result = $this->caches['query']->get($cacheKey))) {
             return $result;
         }
 

tests/Jackalope/Test/FunctionalTestCase.php tests/FunctionalTestCase.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Jackalope\Test;
+namespace Jackalope\Tests;
 
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Platforms\SqlitePlatform;
@@ -10,6 +10,7 @@
 use Jackalope\Transport\DoctrineDBAL\Client;
 use Jackalope\Transport\DoctrineDBAL\RepositorySchema;
 use Jackalope\Transport\TransportInterface;
+use Jackalope\Transport\WorkspaceManagementInterface;
 use PHPCR\RepositoryException;
 use PHPCR\SimpleCredentials;
 
@@ -29,6 +30,7 @@ public function setUp(): void
         $conn = $this->getConnection();
         $this->loadFixtures($conn);
         $this->transport = $this->getClient($conn);
+        $this->assertInstanceOf(WorkspaceManagementInterface::class, $this->transport);
 
         $this->transport->createWorkspace('default');
         $this->repository = new Repository(null, $this->transport);

tests/ImplementationLoader.php

@@ -8,9 +8,9 @@
 use Jackalope\Repository;
 use Jackalope\RepositoryFactoryDoctrineDBAL;
 use Jackalope\Session;
-use Jackalope\Test\Tester\Generic;
-use Jackalope\Test\Tester\Mysql;
-use Jackalope\Test\Tester\Pgsql;
+use Jackalope\Tests\Test\Tester\Generic;
+use Jackalope\Tests\Test\Tester\Mysql;
+use Jackalope\Tests\Test\Tester\Pgsql;
 use Jackalope\Transport\DoctrineDBAL\Client;
 use Jackalope\Transport\Logging\Psr3Logger;
 use PHPCR\RepositoryException;
@@ -141,8 +141,8 @@ public function getRepositoryFactoryParameters()
 
     public function getSessionWithLastModified()
     {
-        /** @var $session Session */
         $session = $this->getSession();
+        \assert($session instanceof Session);
         $session->setSessionOption(Session::OPTION_AUTO_LASTMODIFIED, true);
 
         return $session;

tests/Jackalope/RepositoryFactoryDoctrineDBALTest.php tests/RepositoryFactoryDoctrineDBALTest.php

@@ -1,8 +1,9 @@
 <?php
 
-namespace Jackalope;
+namespace Jackalope\Tests;
 
 use Doctrine\DBAL\Connection;
+use Jackalope\RepositoryFactoryDoctrineDBAL;
 use PHPCR\ConfigurationException;
 use PHPUnit\Framework\TestCase;
 

tests/Jackalope/Test/Fixture/DBUnitFixtureXML.php tests/Test/Fixture/DBUnitFixtureXML.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Jackalope\Test\Fixture;
+namespace Jackalope\Tests\Test\Fixture;
 
 use PHPCR\Util\PathHelper;
 use PHPCR\Util\UUIDHelper;

tests/Jackalope/Test/Fixture/JCRSystemXML.php tests/Test/Fixture/JCRSystemXML.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Jackalope\Test\Fixture;
+namespace Jackalope\Tests\Test\Fixture;
 
 /**
  * Jackalope Document or System Views.

tests/Jackalope/Test/Fixture/XMLDocument.php tests/Test/Fixture/XMLDocument.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Jackalope\Test\Fixture;
+namespace Jackalope\Tests\Test\Fixture;
 
 /**
  * Base for Jackalope Document or System Views and PHPUnit DBUnit Fixture XML classes.

tests/Jackalope/Test/Tester/Generic.php tests/Test/Tester/Generic.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Jackalope\Test\Tester;
+namespace Jackalope\Tests\Test\Tester;
 
 use Doctrine\DBAL\Connection;
 use PHPCR\Test\FixtureLoaderInterface;

tests/Jackalope/Test/Tester/Mysql.php tests/Test/Tester/Mysql.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Jackalope\Test\Tester;
+namespace Jackalope\Tests\Test\Tester;
 
 /**
  * MySQL specific tester class.

tests/Jackalope/Test/Tester/Pgsql.php tests/Test/Tester/Pgsql.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Jackalope\Test\Tester;
+namespace Jackalope\Tests\Test\Tester;
 
 /**
  * PostgreSQL specific tester class.

tests/Jackalope/Test/Tester/XmlDataSet.php tests/Test/Tester/XmlDataSet.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Jackalope\Test\Tester;
+namespace Jackalope\Tests\Test\Tester;
 
 use Doctrine\DBAL\Schema\Column;
 use Doctrine\DBAL\Schema\Index;

tests/Jackalope/Test/TestCase.php tests/TestCase.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Jackalope\Test;
+namespace Jackalope\Tests;
 
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\DriverManager;

tests/Jackalope/Tools/Console/InitDoctrineDbalCommandTest.php tests/Tools/Console/InitDoctrineDbalCommandTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Jackalope\Tools\Console;
+namespace Jackalope\Tests\Tools\Console;
 
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
@@ -9,6 +9,7 @@
 use Doctrine\DBAL\Schema\SchemaConfig;
 use Jackalope\Tools\Console\Command\InitDoctrineDbalCommand;
 use Jackalope\Tools\Console\Helper\DoctrineDbalHelper;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Helper\HelperSet;
@@ -22,7 +23,7 @@ class InitDoctrineDbalCommandTest extends TestCase
     protected $helperSet;
 
     /**
-     * @var Connection
+     * @var Connection&MockObject
      */
     protected $connection;
 
@@ -32,7 +33,7 @@ class InitDoctrineDbalCommandTest extends TestCase
     protected $platform;
 
     /**
-     * @var AbstractSchemaManager
+     * @var AbstractSchemaManager&MockObject
      */
     protected $schemaManager;
 

tests/Transport/DoctrineDBAL/CachedClientFunctionalTest.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Jackalope\Tests\Transport\DoctrineDBAL;
+
+use Doctrine\DBAL\Connection;
+use Jackalope\Factory;
+use Jackalope\Transport\DoctrineDBAL\CachedClient;
+use Jackalope\Transport\TransportInterface;
+use Symfony\Component\Cache\Adapter\ArrayAdapter;
+use Symfony\Component\Cache\Psr16Cache;
+
+class CachedClientFunctionalTest extends ClientTest
+{
+    protected function getClient(Connection $conn): TransportInterface
+    {
+        $nodeCacheAdapter = new ArrayAdapter();
+        $nodeCache = new Psr16Cache($nodeCacheAdapter);
+
+        $metaCacheAdapter = new ArrayAdapter();
+        $metaCache = new Psr16Cache($metaCacheAdapter);
+
+        return new CachedClient(new Factory(), $conn, [
+            'nodes' => $nodeCache,
+            'meta' => $metaCache,
+        ]);
+    }
+}

tests/Jackalope/Transport/DoctrineDBAL/CachedClientTest.php tests/Transport/DoctrineDBAL/CachedClientTest.php

@@ -1,10 +1,11 @@
 <?php
 
-namespace Jackalope\Transport\DoctrineDBAL;
+namespace Jackalope\Tests\Transport\DoctrineDBAL;
 
 use Doctrine\DBAL\Connection;
 use Jackalope\Factory;
-use Jackalope\Test\FunctionalTestCase;
+use Jackalope\Tests\FunctionalTestCase;
+use Jackalope\Transport\DoctrineDBAL\CachedClient;
 use Jackalope\Transport\TransportInterface;
 use Psr\SimpleCache\CacheInterface;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
@@ -30,25 +31,28 @@ public function testArrayObjectIsConvertedToArray(): void
         self::assertIsArray($namespaces);
     }
 
-    public function testCacheHit()
+    public function testCacheHit(): void
     {
         $cache = new \stdClass();
         $cache->foo = 'bar';
-        $this->cache->set('nodes:_/test,_tests', $cache);
+        $this->cache->set('nodes_3A+_2Ftest_2C+tests', $cache);
         $this->assertEquals($cache, $this->transport->getNode('/test'));
     }
 
     /**
-     * The default key sanitizer replaces spaces with underscores.
+     * The default key sanitizer keeps the cache key compatible with PSR16.
      */
     public function testDefaultKeySanitizer(): void
     {
-        /** @var CachedClient $cachedClient */
-        $cachedClient = $this->transport;
-        $cachedClient->getNodeTypes();
+        $client = $this->getClient($this->getConnection());
+        $reflection = new \ReflectionClass($client);
+        $keySanitizerProperty = $reflection->getProperty('keySanitizer');
+        $keySanitizerProperty->setAccessible(true);
+        $defaultKeySanitizer = $keySanitizerProperty->getValue($client);
+
+        $result = $defaultKeySanitizer(' :{}().@/"\\'); // not allowed PSR16 keys
 
-        $this->assertTrue($this->cache->has('node_types'));
-        $this->assertTrue($this->cache->has('nodetypes:_a:0:{}'));
+        $this->assertEquals('+_3A_7B_7D_28_29|_40_2F_22_5C', $result);
     }
 
     public function testCustomKeySanitizer(): void

tests/Jackalope/Transport/DoctrineDBAL/ClientTest.php tests/Transport/DoctrineDBAL/ClientTest.php

@@ -1,9 +1,11 @@
 <?php
 
-namespace Jackalope\Transport\DoctrineDBAL;
+namespace Jackalope\Tests\Transport\DoctrineDBAL;
 
 use Doctrine\DBAL\Platforms\MySQLPlatform;
-use Jackalope\Test\FunctionalTestCase;
+use Jackalope\Tests\FunctionalTestCase;
+use Jackalope\Transport\DoctrineDBAL\Client;
+use Jackalope\Transport\WritingInterface;
 use PHPCR\PropertyType;
 use PHPCR\Query\QOM\QueryObjectModelConstantsInterface;
 use PHPCR\Query\QueryInterface;
@@ -157,6 +159,7 @@ public function testDepthOnMove(): void
         $topic3->addNode('page3');
         $this->session->save();
 
+        $this->assertInstanceOf(WritingInterface::class, $this->transport);
         $this->transport->moveNodeImmediately('/topic2/page2', '/topic1/page1/page2');
 
         $this->transport->moveNodeImmediately('/topic3', '/topic1/page1/page2/topic3');
@@ -323,7 +326,7 @@ public function testPropertyLengthAttribute(): void
 
             $values = $xpath->query('sv:value', $propertyElement->item(0));
 
-            /** @var $value \DOMElement */
+            /** @var \DOMElement $value */
             foreach ($values as $index => $value) {
                 $lengthAttribute = $value->attributes->getNamedItem('length');
                 if (null === $lengthAttribute) {

tests/Jackalope/Transport/DoctrineDBAL/DeleteCascadeTest.php tests/Transport/DoctrineDBAL/DeleteCascadeTest.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace Jackalope\Transport\DoctrineDBAL;
+namespace Jackalope\Tests\Transport\DoctrineDBAL;
 
 use Doctrine\DBAL\Platforms\SqlitePlatform;
-use Jackalope\Test\FunctionalTestCase;
+use Jackalope\Tests\FunctionalTestCase;
 use PHPCR\PropertyType;
 
 class DeleteCascadeTest extends FunctionalTestCase

tests/Jackalope/Transport/DoctrineDBAL/PrefetchTest.php tests/Transport/DoctrineDBAL/PrefetchTest.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace Jackalope\Transport\DoctrineDBAL;
+namespace Jackalope\Tests\Transport\DoctrineDBAL;
 
-use Jackalope\Test\FunctionalTestCase;
+use Jackalope\Tests\FunctionalTestCase;
 
 class PrefetchTest extends FunctionalTestCase
 {