[Cache] Add support for URL encoded characters in Couchbase DSN

Author: alexandre-daubois

.github/workflows/integration-tests.yml

@@ -132,10 +132,10 @@ jobs:
 
       - name: Configure Couchbase
         run: |
-          curl -s -u 'username=Administrator&password=111111' -X POST http://localhost:8091/node/controller/setupServices -d 'services=kv%2Cn1ql%2Cindex%2Cfts'
-          curl -s -X POST http://localhost:8091/settings/web -d 'username=Administrator&password=111111&port=SAME'
-          curl -s -u Administrator:111111 -X POST http://localhost:8091/pools/default/buckets -d 'ramQuotaMB=100&bucketType=ephemeral&name=cache'
-          curl -s -u Administrator:111111 -X POST  http://localhost:8091/pools/default -d 'memoryQuota=256'
+          curl -s -u 'username=Administrator&password=111111@' -X POST http://localhost:8091/node/controller/setupServices -d 'services=kv%2Cn1ql%2Cindex%2Cfts'
+          curl -s -X POST http://localhost:8091/settings/web -d 'username=Administrator&password=111111%40&port=SAME'
+          curl -s -u Administrator:111111@ -X POST http://localhost:8091/pools/default/buckets -d 'ramQuotaMB=100&bucketType=ephemeral&name=cache'
+          curl -s -u Administrator:111111@ -X POST http://localhost:8091/pools/default -d 'memoryQuota=256'
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2

phpunit.xml.dist

@@ -25,7 +25,7 @@
         <env name="ZOOKEEPER_HOST" value="localhost" />
         <env name="COUCHBASE_HOST" value="localhost" />
         <env name="COUCHBASE_USER" value="Administrator" />
-        <env name="COUCHBASE_PASS" value="111111" />
+        <env name="COUCHBASE_PASS" value="111111%40" />
     </php>
 
     <testsuites>

src/Symfony/Component/Cache/Adapter/CouchbaseCollectionAdapter.php

@@ -59,10 +59,7 @@ public static function createConnection(#[\SensitiveParameter] array|string $dsn
 
         set_error_handler(static fn ($type, $msg, $file, $line) => throw new \ErrorException($msg, 0, $type, $file, $line));
 
-        $dsnPattern = '/^(?<protocol>couchbase(?:s)?)\:\/\/(?:(?<username>[^\:]+)\:(?<password>[^\@]{6,})@)?'
-            .'(?<host>[^\:]+(?:\:\d+)?)(?:\/(?<bucketName>[^\/\?]+))(?:(?:\/(?<scopeName>[^\/]+))'
-            .'(?:\/(?<collectionName>[^\/\?]+)))?(?:\/)?(?:\?(?<options>.*))?$/i';
-
+        $pathPattern = '/^(?:\/(?<bucketName>[^\/\?]+))(?:(?:\/(?<scopeName>[^\/]+))(?:\/(?<collectionName>[^\/\?]+)))?(?:\/)?$/';
         $newServers = [];
         $protocol = 'couchbase';
         try {
@@ -74,31 +71,32 @@ public static function createConnection(#[\SensitiveParameter] array|string $dsn
                     throw new InvalidArgumentException('Invalid Couchbase DSN: it does not start with "couchbase:".');
                 }
 
-                preg_match($dsnPattern, $server, $matches);
+                $params = parse_url($server);
 
-                $username = $matches['username'] ?: $username;
-                $password = $matches['password'] ?: $password;
-                $protocol = $matches['protocol'] ?: $protocol;
+                $username = isset($params['user']) ? rawurldecode($params['user']) : $username;
+                $password = isset($params['pass']) ? rawurldecode($params['pass']) : $password;
+                $protocol = $params['scheme'] ?? $protocol;
 
-                if (isset($matches['options'])) {
-                    $optionsInDsn = self::getOptions($matches['options']);
+                if (isset($params['query'])) {
+                    $optionsInDsn = self::getOptions($params['query']);
 
                     foreach ($optionsInDsn as $parameter => $value) {
                         $options[$parameter] = $value;
                     }
                 }
 
-                $newServers[] = $matches['host'];
+                $newServers[] = $params['host'];
             }
 
-            $option = isset($matches['options']) ? '?'.$matches['options'] : '';
+            $option = isset($params['query']) ? '?'.$params['query'] : '';
             $connectionString = $protocol.'://'.implode(',', $newServers).$option;
 
             $clusterOptions = new ClusterOptions();
             $clusterOptions->credentials($username, $password);
 
             $client = new Cluster($connectionString, $clusterOptions);
 
+            preg_match($pathPattern, $params['path'] ?? '', $matches);
             $bucket = $client->bucket($matches['bucketName']);
             $collection = $bucket->defaultCollection();
             if (!empty($matches['scopeName'])) {

src/Symfony/Component/Cache/CHANGELOG.md

@@ -6,6 +6,7 @@ CHANGELOG
 
  * Add option `sentinel_master` as an alias for `redis_sentinel`
  * Deprecate `CouchbaseBucketAdapter`, use `CouchbaseCollectionAdapter`
+ * Add support for URL encoded characters in Couchbase DSN
 
 7.0
 ---

src/Symfony/Component/Cache/Tests/Adapter/CouchbaseCollectionAdapterTest.php

@@ -42,4 +42,24 @@ public function createCachePool($defaultLifetime = 0): CacheItemPoolInterface
 
         return new CouchbaseCollectionAdapter($client, str_replace('\\', '.', __CLASS__), $defaultLifetime);
     }
+
+    /**
+     * Couchbase consider expiration time greater than 30 days as an absolute timestamp.
+     * This test case overrides parent to avoid this behavior for the "k2" item.
+     */
+    public function testExpiration()
+    {
+        $cache = $this->createCachePool();
+        $cache->save($cache->getItem('k1')->set('v1')->expiresAfter(2));
+        $cache->save($cache->getItem('k2')->set('v2')->expiresAfter(86400));
+
+        sleep(3);
+        $item = $cache->getItem('k1');
+        $this->assertFalse($item->isHit());
+        $this->assertNull($item->get(), "Item's value must be null when isHit() is false.");
+
+        $item = $cache->getItem('k2');
+        $this->assertTrue($item->isHit());
+        $this->assertSame('v2', $item->get());
+    }
 }

src/Symfony/Component/Cache/phpunit.xml.dist

@@ -15,7 +15,7 @@
         <env name="MEMCACHED_HOST" value="localhost" />
         <env name="COUCHBASE_HOST" value="localhost" />
         <env name="COUCHBASE_USER" value="Administrator" />
-        <env name="COUCHBASE_PASS" value="111111" />
+        <env name="COUCHBASE_PASS" value="111111%40" />
     </php>
 
     <testsuites>