[Cache] Deprecate CouchbaseBucketAdapter, use CouchbaseCollectionAdapter

alexandre-daubois · alexandre-daubois · commit 3ccc6348da7b · 2023-12-09T15:28:05.000+01:00
diff --git a/UPGRADE-7.1.md b/UPGRADE-7.1.md
@@ -1,6 +1,11 @@
 UPGRADE FROM 7.0 to 7.1
 =======================
 
+Cache
+-----
+
+ * Deprecate `CouchbaseBucketAdapter`, use `CouchbaseCollectionAdapter`
+
 Workflow
 --------
 
diff --git a/src/Symfony/Component/Cache/Adapter/CouchbaseBucketAdapter.php b/src/Symfony/Component/Cache/Adapter/CouchbaseBucketAdapter.php
@@ -16,8 +16,12 @@
 use Symfony\Component\Cache\Marshaller\DefaultMarshaller;
 use Symfony\Component\Cache\Marshaller\MarshallerInterface;
 
+trigger_deprecation('symfony/cache', '7.1', 'The "%s" class is deprecated, use "%s" instead.', CouchbaseBucketAdapter::class, CouchbaseCollectionAdapter::class);
+
 /**
  * @author Antonio Jose Cerezo Aranda <aj.cerezo@gmail.com>
+ *
+ * @deprecated since Symfony 7.1, use {@see CouchbaseCollectionAdapter} instead
  */
 class CouchbaseBucketAdapter extends AbstractAdapter
 {
diff --git a/src/Symfony/Component/Cache/CHANGELOG.md b/src/Symfony/Component/Cache/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add option `sentinel_master` as an alias for `redis_sentinel`
+ * Deprecate `CouchbaseBucketAdapter`, use `CouchbaseCollectionAdapter`
 
 7.0
 ---
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/CouchbaseBucketAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/CouchbaseBucketAdapterTest.php
@@ -12,8 +12,8 @@
 namespace Symfony\Component\Cache\Tests\Adapter;
 
 use Psr\Cache\CacheItemPoolInterface;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Component\Cache\Adapter\AbstractAdapter;
-use Symfony\Component\Cache\Adapter\CouchbaseBucketAdapter;
 
 /**
  * @requires extension couchbase <3.0.0
@@ -25,19 +25,19 @@
  */
 class CouchbaseBucketAdapterTest extends AdapterTestCase
 {
+    use ExpectDeprecationTrait;
+
     protected $skippedTests = [
         'testClearPrefix' => 'Couchbase cannot clear by prefix',
     ];
 
-    protected static \CouchbaseBucket $client;
+    protected \CouchbaseBucket $client;
 
-    public static function setupBeforeClass(): void
+    protected function setUp(): void
     {
-        if (!CouchbaseBucketAdapter::isSupported()) {
-            self::markTestSkipped('Couchbase >= 2.6.0 < 3.0.0 is required.');
-        }
+        $this->expectDeprecation('Since symfony/cache 7.1: The "Symfony\Component\Cache\Adapter\CouchbaseBucketAdapter" class is deprecated, use "Symfony\Component\Cache\Adapter\CouchbaseCollectionAdapter" instead.');
 
-        self::$client = AbstractAdapter::createConnection('couchbase://'.getenv('COUCHBASE_HOST').'/cache',
+        $this->client = AbstractAdapter::createConnection('couchbase://'.getenv('COUCHBASE_HOST').'/cache',
             ['username' => getenv('COUCHBASE_USER'), 'password' => getenv('COUCHBASE_PASS')]
         );
     }
@@ -50,8 +50,8 @@ public function createCachePool($defaultLifetime = 0): CacheItemPoolInterface
                 .':'.getenv('COUCHBASE_PASS')
                 .'@'.getenv('COUCHBASE_HOST')
                 .'/cache')
-            : self::$client;
+            : $this->client;
 
-        return new CouchbaseBucketAdapter($client, str_replace('\\', '.', __CLASS__), $defaultLifetime);
+        return new \Symfony\Component\Cache\Adapter\CouchbaseBucketAdapter($client, str_replace('\\', '.', __CLASS__), $defaultLifetime);
     }
 }
