Avoid throwing from the TraceableCacheAdapterTrait::prune() and TraceableCacheAdapterTrait::reset() methods (getsentry#543)

ste93cry · web-flow · commit f2df979964b0 · 2021-08-22T23:15:43.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## Unreleased
 
 - Fix return type for `TracingDriver::getDatabase()` method (#541)
+- Avoid throwing exception from the `TraceableCacheAdapterTrait::prune()` and `TraceableCacheAdapterTrait::reset()` methods when the decorated adapter does not implement the respective interfaces (#543)
 
 ## 4.2.0 (2021-08-12)
 
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -222,7 +222,7 @@ parameters:
 
 		-
 			message: "#^Call to an undefined method TCacheAdapter of Symfony\\\\Component\\\\Cache\\\\Adapter\\\\AdapterInterface\\:\\:reset\\(\\)\\.$#"
-			count: 2
+			count: 1
 			path: tests/Tracing/Cache/AbstractTraceableCacheAdapterTest.php
 
 		-
diff --git a/src/Tracing/Cache/TraceableCacheAdapterTrait.php b/src/Tracing/Cache/TraceableCacheAdapterTrait.php
@@ -159,7 +159,7 @@ public function prune(): bool
     {
         return $this->traceFunction('cache.prune', function (): bool {
             if (!$this->decoratedAdapter instanceof PruneableInterface) {
-                throw new \BadMethodCallException(sprintf('The %s::prune() method is not supported because the decorated adapter does not implement the "%s" interface.', self::class, PruneableInterface::class));
+                return false;
             }
 
             return $this->decoratedAdapter->prune();
@@ -171,11 +171,9 @@ public function prune(): bool
      */
     public function reset(): void
     {
-        if (!$this->decoratedAdapter instanceof ResettableInterface) {
-            throw new \BadMethodCallException(sprintf('The %s::reset() method is not supported because the decorated adapter does not implement the "%s" interface.', self::class, ResettableInterface::class));
+        if ($this->decoratedAdapter instanceof ResettableInterface) {
+            $this->decoratedAdapter->reset();
         }
-
-        $this->decoratedAdapter->reset();
     }
 
     /**
diff --git a/tests/Tracing/Cache/AbstractTraceableCacheAdapterTest.php b/tests/Tracing/Cache/AbstractTraceableCacheAdapterTest.php
@@ -375,14 +375,24 @@ public function testPrune(): void
         $this->assertNotNull($spans[1]->getEndTimestamp());
     }
 
-    public function testPruneThrowsExceptionIfDecoratedAdapterIsNotPruneable(): void
+    public function testPruneReturnsFalseIfDecoratedAdapterIsNotPruneable(): void
     {
+        $transaction = new Transaction(new TransactionContext(), $this->hub);
+        $transaction->initSpanRecorder();
+
+        $this->hub->expects($this->once())
+            ->method('getSpan')
+            ->willReturn($transaction);
+
         $adapter = $this->createCacheAdapter($this->createMock(static::getAdapterClassFqcn()));
 
-        $this->expectException(\BadMethodCallException::class);
-        $this->expectExceptionMessage(sprintf('The %s::prune() method is not supported because the decorated adapter does not implement the "Symfony\\Component\\Cache\\PruneableInterface" interface.', \get_class($adapter)));
+        $this->assertFalse($adapter->prune());
 
-        $adapter->prune();
+        $spans = $transaction->getSpanRecorder()->getSpans();
+
+        $this->assertCount(2, $spans);
+        $this->assertSame('cache.prune', $spans[1]->getOp());
+        $this->assertNotNull($spans[1]->getEndTimestamp());
     }
 
     public function testReset(): void
@@ -395,16 +405,6 @@ public function testReset(): void
         $adapter->reset();
     }
 
-    public function testResetThrowsExceptionIfDecoratedAdapterIsNotResettable(): void
-    {
-        $adapter = $this->createCacheAdapter($this->createMock(static::getAdapterClassFqcn()));
-
-        $this->expectException(\BadMethodCallException::class);
-        $this->expectExceptionMessage(sprintf('The %s::reset() method is not supported because the decorated adapter does not implement the "Symfony\\Component\\Cache\\ResettableInterface" interface.', \get_class($adapter)));
-
-        $adapter->reset();
-    }
-
     private static function isCachePackageInstalled(): bool
     {
         return interface_exists(BaseCacheInterface::class);

Original file line number	Diff line number	Diff line change
`@@ -222,7 +222,7 @@ parameters:`
`222`	`222`
`223`	`223`	`-`
`224`	`224`	`message: "#^Call to an undefined method TCacheAdapter of Symfony\\\\Component\\\\Cache\\\\Adapter\\\\AdapterInterface\\:\\:reset\\(\\)\\.$#"`
`225`		`- count: 2`
	`225`	`+ count: 1`
`226`	`226`	`path: tests/Tracing/Cache/AbstractTraceableCacheAdapterTest.php`
`227`	`227`
`228`	`228`	`-`
Original file line number	Diff line number	Diff line change
`@@ -159,7 +159,7 @@ public function prune(): bool`
`159`	`159`	`{`
`160`	`160`	`return $this->traceFunction('cache.prune', function (): bool {`
`161`	`161`	`if (!$this->decoratedAdapter instanceof PruneableInterface) {`
`162`		`- throw new \BadMethodCallException(sprintf('The %s::prune() method is not supported because the decorated adapter does not implement the "%s" interface.', self::class, PruneableInterface::class));`
	`162`	`+ return false;`
`163`	`163`	`}`
`164`	`164`
`165`	`165`	`return $this->decoratedAdapter->prune();`
`@@ -171,11 +171,9 @@ public function prune(): bool`
`171`	`171`	`*/`
`172`	`172`	`public function reset(): void`
`173`	`173`	`{`
`174`		`- if (!$this->decoratedAdapter instanceof ResettableInterface) {`
`175`		`- throw new \BadMethodCallException(sprintf('The %s::reset() method is not supported because the decorated adapter does not implement the "%s" interface.', self::class, ResettableInterface::class));`
	`174`	`+ if ($this->decoratedAdapter instanceof ResettableInterface) {`
	`175`	`+ $this->decoratedAdapter->reset();`
`176`	`176`	`}`
`177`		`-`
`178`		`- $this->decoratedAdapter->reset();`
`179`	`177`	`}`
`180`	`178`
`181`	`179`	`/**`