IBX-12029: Introduced ContentPublicationResult

Author: bnowak

src/contracts/Repository/Strategy/ContentPublication/ContentPublicationResult.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\Repository\Strategy\ContentPublication;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\Content;
+
+final readonly class ContentPublicationResult
+{
+    public function __construct(
+        public ?Content $publishedContent,
+    ) {
+    }
+}

src/contracts/Repository/Strategy/ContentPublication/ContentPublicationStrategyInterface.php

@@ -29,5 +29,5 @@ public function supports(): bool;
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\BadStateException
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException
      */
-    public function publishVersion(VersionInfo $versionInfo, array $translations = Language::ALL): void;
+    public function publishVersion(VersionInfo $versionInfo, array $translations = Language::ALL): ContentPublicationResult;
 }

src/lib/Repository/Strategy/ContentPublication/ChainContentPublicationStrategy.php

@@ -8,6 +8,7 @@
 
 namespace Ibexa\Core\Repository\Strategy\ContentPublication;
 
+use Ibexa\Contracts\Core\Repository\Strategy\ContentPublication\ContentPublicationResult;
 use Ibexa\Contracts\Core\Repository\Strategy\ContentPublication\ContentPublicationStrategyInterface;
 use Ibexa\Contracts\Core\Repository\Values\Content\Language;
 use Ibexa\Contracts\Core\Repository\Values\Content\VersionInfo;
@@ -40,13 +41,11 @@ public function supports(): bool
         return false;
     }
 
-    public function publishVersion(VersionInfo $versionInfo, array $translations = Language::ALL): void
+    public function publishVersion(VersionInfo $versionInfo, array $translations = Language::ALL): ContentPublicationResult
     {
         foreach ($this->strategies as $strategy) {
             if ($strategy->supports()) {
-                $strategy->publishVersion($versionInfo, $translations);
-
-                return;
+                return $strategy->publishVersion($versionInfo, $translations);
             }
         }
 

src/lib/Repository/Strategy/ContentPublication/SynchronousContentPublicationStrategy.php

@@ -9,6 +9,7 @@
 namespace Ibexa\Core\Repository\Strategy\ContentPublication;
 
 use Ibexa\Contracts\Core\Repository\ContentService;
+use Ibexa\Contracts\Core\Repository\Strategy\ContentPublication\ContentPublicationResult;
 use Ibexa\Contracts\Core\Repository\Strategy\ContentPublication\ContentPublicationStrategyInterface;
 use Ibexa\Contracts\Core\Repository\Values\Content\Language;
 use Ibexa\Contracts\Core\Repository\Values\Content\VersionInfo;
@@ -31,8 +32,10 @@ public function supports(): bool
         return true;
     }
 
-    public function publishVersion(VersionInfo $versionInfo, array $translations = Language::ALL): void
+    public function publishVersion(VersionInfo $versionInfo, array $translations = Language::ALL): ContentPublicationResult
     {
-        $this->contentService->publishVersion($versionInfo, $translations);
+        return new ContentPublicationResult(
+            $this->contentService->publishVersion($versionInfo, $translations)
+        );
     }
 }

tests/lib/Repository/Strategy/Publication/ChainContentPublicationStrategyTest.php

@@ -8,6 +8,7 @@
 
 namespace Ibexa\Tests\Core\Repository\Strategy\Publication;
 
+use Ibexa\Contracts\Core\Repository\Strategy\ContentPublication\ContentPublicationResult;
 use Ibexa\Contracts\Core\Repository\Strategy\ContentPublication\ContentPublicationStrategyInterface;
 use Ibexa\Contracts\Core\Repository\Values\Content\VersionInfo;
 use Ibexa\Core\Repository\Strategy\ContentPublication\ChainContentPublicationStrategy;
@@ -19,6 +20,7 @@ final class ChainContentPublicationStrategyTest extends TestCase
     public function testPublishVersionExecutesFirstSupportingStrategy(): void
     {
         $versionInfo = $this->createStub(VersionInfo::class);
+        $result = new ContentPublicationResult(null);
 
         $notSupportingStrategy = $this->createMock(ContentPublicationStrategyInterface::class);
         $notSupportingStrategy
@@ -37,7 +39,8 @@ public function testPublishVersionExecutesFirstSupportingStrategy(): void
         $supportingStrategy
             ->expects(self::once())
             ->method('publishVersion')
-            ->with(self::identicalTo($versionInfo), ['eng-GB']);
+            ->with(self::identicalTo($versionInfo), ['eng-GB'])
+            ->willReturn($result);
 
         $neverConsultedStrategy = $this->createMock(ContentPublicationStrategyInterface::class);
         $neverConsultedStrategy
@@ -53,7 +56,7 @@ public function testPublishVersionExecutesFirstSupportingStrategy(): void
             $neverConsultedStrategy,
         ]);
 
-        $chain->publishVersion($versionInfo, ['eng-GB']);
+        self::assertSame($result, $chain->publishVersion($versionInfo, ['eng-GB']));
     }
 
     public function testSupportsReturnsTrueWhenAnyStrategySupports(): void

tests/lib/Repository/Strategy/Publication/SynchronousContentPublicationStrategyTest.php

@@ -9,6 +9,7 @@
 namespace Ibexa\Tests\Core\Repository\Strategy\Publication;
 
 use Ibexa\Contracts\Core\Repository\ContentService;
+use Ibexa\Contracts\Core\Repository\Values\Content\Content;
 use Ibexa\Contracts\Core\Repository\Values\Content\Language;
 use Ibexa\Contracts\Core\Repository\Values\Content\VersionInfo;
 use Ibexa\Core\Repository\Strategy\ContentPublication\SynchronousContentPublicationStrategy;
@@ -36,20 +37,24 @@ public function testPublishVersionDelegatesToContentService(
         array $expectedTranslations
     ): void {
         $versionInfo = $this->createStub(VersionInfo::class);
+        $content = $this->createStub(Content::class);
 
         $contentService = $this->createMock(ContentService::class);
         $contentService
             ->expects(self::once())
             ->method('publishVersion')
-            ->with(self::identicalTo($versionInfo), $expectedTranslations);
+            ->with(self::identicalTo($versionInfo), $expectedTranslations)
+            ->willReturn($content);
 
         $publishArguments = ['versionInfo' => $versionInfo];
         if (null !== $translations) {
             $publishArguments['translations'] = $translations;
         }
 
-        (new SynchronousContentPublicationStrategy($contentService))
+        $result = (new SynchronousContentPublicationStrategy($contentService))
             ->publishVersion(...$publishArguments);
+
+        self::assertSame($content, $result->publishedContent);
     }
 
     /**