[Messenger] Fix BC layer for stamps moved into separate packages

ogizanagi · ogizanagi · commit 118579ced776 · 2020-08-13T16:04:02.000+02:00
diff --git a/src/Symfony/Component/Messenger/Envelope.php b/src/Symfony/Component/Messenger/Envelope.php
@@ -73,7 +73,7 @@ public function withoutAll(string $stampFqcn): self
     {
         $cloned = clone $this;
 
-        unset($cloned->stamps[$stampFqcn]);
+        unset($cloned->stamps[$this->resolveAlias($stampFqcn)]);
 
         return $cloned;
     }
@@ -84,6 +84,7 @@ public function withoutAll(string $stampFqcn): self
     public function withoutStampsOfType(string $type): self
     {
         $cloned = clone $this;
+        $type = $this->resolveAlias($type);
 
         foreach ($cloned->stamps as $class => $stamps) {
             if ($class === $type || is_subclass_of($class, $type)) {
@@ -96,7 +97,7 @@ public function withoutStampsOfType(string $type): self
 
     public function last(string $stampFqcn): ?StampInterface
     {
-        return isset($this->stamps[$stampFqcn]) ? end($this->stamps[$stampFqcn]) : null;
+        return isset($this->stamps[$stampFqcn = $this->resolveAlias($stampFqcn)]) ? end($this->stamps[$stampFqcn]) : null;
     }
 
     /**
@@ -105,7 +106,7 @@ public function last(string $stampFqcn): ?StampInterface
     public function all(string $stampFqcn = null): array
     {
         if (null !== $stampFqcn) {
-            return $this->stamps[$stampFqcn] ?? [];
+            return $this->stamps[$this->resolveAlias($stampFqcn)] ?? [];
         }
 
         return $this->stamps;
@@ -118,4 +119,14 @@ public function getMessage(): object
     {
         return $this->message;
     }
+
+    /**
+     * BC to be removed in 6.0.
+     */
+    private function resolveAlias(string $fqcn): string
+    {
+        static $resolved;
+
+        return $resolved[$fqcn] ?? ($resolved[$fqcn] = (new \ReflectionClass($fqcn))->getName());
+    }
 }
diff --git a/src/Symfony/Component/Messenger/Tests/EnvelopeTest.php b/src/Symfony/Component/Messenger/Tests/EnvelopeTest.php
@@ -12,12 +12,16 @@
 namespace Symfony\Component\Messenger\Tests;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Messenger\Bridge\Doctrine\Transport\DoctrineReceivedStamp;
+use Symfony\Component\Messenger\Bridge\Redis\Transport\RedisReceivedStamp;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Stamp\DelayStamp;
 use Symfony\Component\Messenger\Stamp\ReceivedStamp;
 use Symfony\Component\Messenger\Stamp\StampInterface;
 use Symfony\Component\Messenger\Stamp\ValidationStamp;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
+use Symfony\Component\Messenger\Transport\Doctrine\DoctrineReceivedStamp as LegacyDoctrineReceivedStamp;
+use Symfony\Component\Messenger\Transport\RedisExt\RedisReceivedStamp as LegacyRedisReceivedStamp;
 
 /**
  * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
@@ -114,6 +118,40 @@ public function testWrapWithEnvelope()
         $this->assertCount(1, $envelope->all(DelayStamp::class));
         $this->assertCount(1, $envelope->all(ReceivedStamp::class));
     }
+
+    /**
+     * To be removed in 6.0.
+     *
+     * @group legacy
+     */
+    public function testWithAliases()
+    {
+        $envelope = new Envelope(new \stdClass(), [
+            $s1 = new DoctrineReceivedStamp(1),
+            $s2 = new RedisReceivedStamp(2),
+            $s3 = new DoctrineReceivedStamp(3),
+        ]);
+
+        self::assertSame([
+            DoctrineReceivedStamp::class => [$s1, $s3],
+            RedisReceivedStamp::class => [$s2],
+        ], $envelope->all());
+
+        self::assertSame([$s1, $s3], $envelope->all(DoctrineReceivedStamp::class));
+        self::assertSame([$s2], $envelope->all(RedisReceivedStamp::class));
+
+        self::assertSame([$s1, $s3], $envelope->all(LegacyDoctrineReceivedStamp::class));
+        self::assertSame([$s2], $envelope->all(LegacyRedisReceivedStamp::class));
+
+        self::assertSame($s3, $envelope->last(LegacyDoctrineReceivedStamp::class));
+        self::assertSame($s2, $envelope->last(LegacyRedisReceivedStamp::class));
+
+        self::assertSame([RedisReceivedStamp::class => [$s2]], $envelope->withoutAll(LegacyDoctrineReceivedStamp::class)->all());
+        self::assertSame([DoctrineReceivedStamp::class => [$s1, $s3]], $envelope->withoutAll(LegacyRedisReceivedStamp::class)->all());
+
+        self::assertSame([RedisReceivedStamp::class => [$s2]], $envelope->withoutStampsOfType(LegacyDoctrineReceivedStamp::class)->all());
+        self::assertSame([DoctrineReceivedStamp::class => [$s1, $s3]], $envelope->withoutStampsOfType(LegacyRedisReceivedStamp::class)->all());
+    }
 }
 
 interface DummyFooBarStampInterface extends StampInterface

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ public function withoutAll(string $stampFqcn): self`
`73`	`73`	`{`
`74`	`74`	`$cloned = clone $this;`
`75`	`75`
`76`		`- unset($cloned->stamps[$stampFqcn]);`
	`76`	`+ unset($cloned->stamps[$this->resolveAlias($stampFqcn)]);`
`77`	`77`
`78`	`78`	`return $cloned;`
`79`	`79`	`}`
`@@ -84,6 +84,7 @@ public function withoutAll(string $stampFqcn): self`
`84`	`84`	`public function withoutStampsOfType(string $type): self`
`85`	`85`	`{`
`86`	`86`	`$cloned = clone $this;`
	`87`	`+ $type = $this->resolveAlias($type);`
`87`	`88`
`88`	`89`	`foreach ($cloned->stamps as $class => $stamps) {`
`89`	`90`	`if ($class === $type \|\| is_subclass_of($class, $type)) {`
`@@ -96,7 +97,7 @@ public function withoutStampsOfType(string $type): self`
`96`	`97`
`97`	`98`	`public function last(string $stampFqcn): ?StampInterface`
`98`	`99`	`{`
`99`		`- return isset($this->stamps[$stampFqcn]) ? end($this->stamps[$stampFqcn]) : null;`
	`100`	`+ return isset($this->stamps[$stampFqcn = $this->resolveAlias($stampFqcn)]) ? end($this->stamps[$stampFqcn]) : null;`
`100`	`101`	`}`
`101`	`102`
`102`	`103`	`/**`
`@@ -105,7 +106,7 @@ public function last(string $stampFqcn): ?StampInterface`
`105`	`106`	`public function all(string $stampFqcn = null): array`
`106`	`107`	`{`
`107`	`108`	`if (null !== $stampFqcn) {`
`108`		`- return $this->stamps[$stampFqcn] ?? [];`
	`109`	`+ return $this->stamps[$this->resolveAlias($stampFqcn)] ?? [];`
`109`	`110`	`}`
`110`	`111`
`111`	`112`	`return $this->stamps;`
`@@ -118,4 +119,14 @@ public function getMessage(): object`
`118`	`119`	`{`
`119`	`120`	`return $this->message;`
`120`	`121`	`}`
	`122`	`+`
	`123`	`+ /**`
	`124`	`+ * BC to be removed in 6.0.`
	`125`	`+ */`
	`126`	`+ private function resolveAlias(string $fqcn): string`
	`127`	`+ {`
	`128`	`+ static $resolved;`
	`129`	`+`
	`130`	`+ return $resolved[$fqcn] ?? ($resolved[$fqcn] = (new \ReflectionClass($fqcn))->getName());`
	`131`	`+ }`
`121`	`132`	`}`