Add versioning to dimension content

sulu · Oct 5, 2021 · 695b797 · 695b797
1 parent 9fa38cb
commit 695b797
Show file tree

Hide file tree

Showing 20 changed files with 282 additions and 26 deletions.
diff --git a/Content/Application/ContentNormalizer/Normalizer/DimensionContentNormalizer.php b/Content/Application/ContentNormalizer/Normalizer/DimensionContentNormalizer.php
@@ -28,6 +28,7 @@ public function getIgnoredAttributes(object $object): array
             'merged',
             'dimension',
             'resource',
+            'version',
         ];
     }
 

diff --git a/Content/Application/ContentWorkflow/ContentWorkflow.php b/Content/Application/ContentWorkflow/ContentWorkflow.php
@@ -135,9 +135,11 @@ private function getWorkflow(): SymfonyWorkflowInterface
         // | New |--------->| Unpublished |                      | Review |---------->| Published  |                | draft |                             | Review draft  |
         // |     |          |             |<---------------------|        |           |            |--------------->|       |<----------------------------|               |
         // +-----+          +-------------+       reject         +--------+           +------------+  create draft  +-------+        reject draft         +---------------+
-        //                                                                              A   |    A                                                                |
-        //                                                                              +---+    |                          publish                               |
-        //                                                                             publish   +----------------------------------------------------------------+
+        //                   A   |                                                     A   |  A  |                      A                                          |
+        //                   +---+                                                     +---+  |  |       restore        |                                          |
+        //                  restore                                                   publish |  +----------------------+                                          |
+        //                                                                                    |                              publish                               |
+        //                                                                                    +--------------------------------------------------------------------+
 
         // Configures places
         $definition = $definitionBuilder

diff --git a/Content/Application/ContentWorkflow/Subscriber/PublishTransitionSubscriber.php b/Content/Application/ContentWorkflow/Subscriber/PublishTransitionSubscriber.php
@@ -19,6 +19,7 @@
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentCollectionInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\WorkflowInterface;
+use Sulu\Bundle\ContentBundle\Content\Domain\Repository\DimensionContentRepositoryInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\Workflow\Event\TransitionEvent;
 
@@ -29,9 +30,17 @@ class PublishTransitionSubscriber implements EventSubscriberInterface
      */
     private $contentCopier;
 
-    public function __construct(ContentCopierInterface $contentCopier)
-    {
+    /**
+     * @var DimensionContentRepositoryInterface
+     */
+    private $dimensionContentRepository;
+
+    public function __construct(
+        ContentCopierInterface $contentCopier,
+        DimensionContentRepositoryInterface $dimensionContentRepository
+    ) {
         $this->contentCopier = $contentCopier;
+        $this->dimensionContentRepository = $dimensionContentRepository;
     }
 
     public function onPublish(TransitionEvent $transitionEvent): void
@@ -68,6 +77,21 @@ public function onPublish(TransitionEvent $transitionEvent): void
 
         $dimensionAttributes['stage'] = DimensionContentInterface::STAGE_LIVE;
 
+        // create new version
+        // TODO optimize latest version and publish locales on write process to avoid loading them here?
+        $version = 1 + $this->dimensionContentRepository->getLatestVersion($contentRichEntity);
+        $publishLocales = $this->dimensionContentRepository->getLocales($contentRichEntity, $dimensionAttributes);
+
+        foreach ($publishLocales as $publishLocale) {
+            $this->contentCopier->copy(
+                $contentRichEntity,
+                \array_merge($dimensionAttributes, ['locale' => $publishLocale]),
+                $contentRichEntity,
+                \array_merge($dimensionAttributes, ['locale' => $publishLocale, 'version' => $version])
+            );
+        }
+
+        // publish content into live workspace
         $this->contentCopier->copyFromDimensionContentCollection(
             $dimensionContentCollection,
             $contentRichEntity,

diff --git a/Content/Domain/Model/DimensionContentInterface.php b/Content/Domain/Model/DimensionContentInterface.php
@@ -18,6 +18,8 @@ interface DimensionContentInterface
     public const STAGE_DRAFT = 'draft';
     public const STAGE_LIVE = 'live';
 
+    public const DEFAULT_VERSION = 0;
+
     public static function getResourceKey(): string;
 
     public function getLocale(): ?string;
@@ -28,6 +30,10 @@ public function getStage(): string;
 
     public function setStage(string $stage): void;
 
+    public function getVersion(): int;
+
+    public function setVersion(int $version): void;
+
     public function getResource(): ContentRichEntityInterface;
 
     public function isMerged(): bool;

diff --git a/Content/Domain/Model/DimensionContentTrait.php b/Content/Domain/Model/DimensionContentTrait.php
@@ -25,6 +25,11 @@ trait DimensionContentTrait
      */
     protected $stage = DimensionContentInterface::STAGE_DRAFT;
 
+    /**
+     * @var int
+     */
+    protected $version = DimensionContentInterface::DEFAULT_VERSION;
+
     /**
      * @var bool
      */
@@ -50,6 +55,16 @@ public function getStage(): string
         return $this->stage;
     }
 
+    public function setVersion(int $version): void
+    {
+        $this->version = $version;
+    }
+
+    public function getVersion(): int
+    {
+        return $this->version;
+    }
+
     public function isMerged(): bool
     {
         return $this->isMerged;
@@ -65,6 +80,7 @@ public static function getDefaultDimensionAttributes(): array
         return [
             'locale' => null,
             'stage' => DimensionContentInterface::STAGE_DRAFT,
+            'version' => DimensionContentInterface::DEFAULT_VERSION,
         ];
     }
 

diff --git a/Content/Domain/Repository/DimensionContentRepositoryInterface.php b/Content/Domain/Repository/DimensionContentRepositoryInterface.php
@@ -25,4 +25,16 @@ public function load(
         ContentRichEntityInterface $contentRichEntity,
         array $dimensionAttributes
     ): DimensionContentCollectionInterface;
+
+    public function getLatestVersion(ContentRichEntityInterface $contentRichEntity): int;
+
+    /**
+     * @param mixed[] $dimensionAttributes
+     *
+     * @return string[]
+     */
+    public function getLocales(
+        ContentRichEntityInterface $contentRichEntity,
+        array $dimensionAttributes
+    ): array;
 }
diff --git a/Content/Infrastructure/Doctrine/DimensionContentRepository.php b/Content/Infrastructure/Doctrine/DimensionContentRepository.php
@@ -57,8 +57,7 @@ public function load(
 
         $queryBuilder = $this->entityManager->createQueryBuilder()
             ->from($dimensionContentClass, 'dimensionContent')
-            ->innerJoin('dimensionContent.' . $mappingProperty, 'content')
-            ->where('content.id = :id')
+            ->where('IDENTITY(dimensionContent.' . $mappingProperty . ') = :id')
             ->setParameter('id', $contentRichEntity->getId());
 
         $this->dimensionContentQueryEnhancer->addSelects(
@@ -77,4 +76,45 @@ public function load(
             $dimensionContentClass
         );
     }
+
+    public function getLatestVersion(ContentRichEntityInterface $contentRichEntity): int
+    {
+        $dimensionContentClass = $this->contentMetadataInspector->getDimensionContentClass(\get_class($contentRichEntity));
+        $mappingProperty = $this->contentMetadataInspector->getDimensionContentPropertyName(\get_class($contentRichEntity));
+
+        $queryBuilder = $this->entityManager->createQueryBuilder()
+            ->from($dimensionContentClass, 'dimensionContent')
+            ->select('dimensionContent.version')
+            ->orderBy('dimensionContent.version', 'DESC')
+            ->setMaxResults(1)
+            ->where('IDENTITY(dimensionContent.' . $mappingProperty . ') = :id')
+            ->setParameter('id', $contentRichEntity->getId());
+
+        return (int) $queryBuilder->getQuery()->getSingleScalarResult();
+    }
+
+    public function getLocales(
+        ContentRichEntityInterface $contentRichEntity,
+        array $dimensionAttributes
+    ): array {
+        $dimensionContentClass = $this->contentMetadataInspector->getDimensionContentClass(\get_class($contentRichEntity));
+        $mappingProperty = $this->contentMetadataInspector->getDimensionContentPropertyName(\get_class($contentRichEntity));
+
+        $queryBuilder = $this->entityManager->createQueryBuilder()
+            ->from($dimensionContentClass, 'dimensionContent')
+            ->select('dimensionContent.locale')
+            ->where('IDENTITY(dimensionContent.' . $mappingProperty . ') = :id')
+            ->andWhere('dimensionContent.locale IS NOT NULL')
+            ->setParameter('id', $contentRichEntity->getId());
+
+        unset($dimensionAttributes['locale']);
+        foreach ($dimensionAttributes as $key => $value) {
+            $queryBuilder->andWhere('dimensionContent.' . $key . ' = :' . $key)
+                ->setParameter(':' . $key, $value);
+        }
+
+        return \array_map(function($row) {
+            return $row['locale'];
+        }, $queryBuilder->getQuery()->getArrayResult());
+    }
 }
diff --git a/Content/Infrastructure/Doctrine/MetadataLoader.php b/Content/Infrastructure/Doctrine/MetadataLoader.php
@@ -47,6 +47,7 @@ public function loadClassMetadata(LoadClassMetadataEventArgs $event): void
         if ($reflection->implementsInterface(DimensionContentInterface::class)) {
             $this->addField($metadata, 'stage', 'string', ['length' => 16, 'nullable' => false]);
             $this->addField($metadata, 'locale', 'string', ['length' => 7, 'nullable' => true]);
+            $this->addField($metadata, 'version', 'integer', ['nullable' => false, 'default' => 0]);
         }
 
         if ($reflection->implementsInterface(SeoInterface::class)) {

diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -158,6 +158,7 @@
 
         <service id="sulu_content.publish_transition_subscriber" class="Sulu\Bundle\ContentBundle\Content\Application\ContentWorkflow\Subscriber\PublishTransitionSubscriber">
             <argument type="service" id="sulu_content.content_copier"/>
+            <argument type="service" id="sulu_content.dimension_content_repository"/>
 
             <tag name="kernel.event_subscriber"/>
         </service>

diff --git a/Tests/Functional/Content/Infrastructure/Doctrine/DimensionContentRepositoryTest.php b/Tests/Functional/Content/Infrastructure/Doctrine/DimensionContentRepositoryTest.php
@@ -107,6 +107,46 @@ public function testLoadExistOrderedDifferent(): void
         }, \iterator_to_array($dimensionContentCollection)));
     }
 
+    public function testGetLatestVersion(): void
+    {
+        // prepare database
+        $contentRichEntity = $this->createContentRichEntity();
+        $this->createContentDimension($contentRichEntity, []);
+        $this->createContentDimension($contentRichEntity, ['locale' => 'de']);
+        $this->createContentDimension($contentRichEntity, ['locale' => 'de', 'version' => 1]);
+
+        $this->getEntityManager()->flush();
+        $this->getEntityManager()->clear();
+
+        // test functionality
+        $dimensionContentRepository = $this->createContentDimensionRepository();
+        $version = $dimensionContentRepository->getLatestVersion($contentRichEntity);
+
+        // assert result
+        $this->assertSame(1, $version);
+    }
+
+    public function testGetLocales(): void
+    {
+        // prepare database
+        $contentRichEntity = $this->createContentRichEntity();
+        $this->createContentDimension($contentRichEntity, []);
+        $this->createContentDimension($contentRichEntity, ['locale' => 'de']);
+        $this->createContentDimension($contentRichEntity, ['locale' => 'en']);
+        $this->createContentDimension($contentRichEntity, ['locale' => 'en', 'stage' => 'live']);
+        $this->createContentDimension($contentRichEntity, ['locale' => 'fr', 'stage' => 'live']);
+
+        $this->getEntityManager()->flush();
+        $this->getEntityManager()->clear();
+
+        // test functionality
+        $dimensionContentRepository = $this->createContentDimensionRepository();
+        $locales = $dimensionContentRepository->getLocales($contentRichEntity, ['stage' => 'live']);
+
+        // assert result
+        $this->assertSame(['en', 'fr'], $locales);
+    }
+
     private function createContentRichEntity(): Example
     {
         $example = new Example();
@@ -123,6 +163,7 @@ private function createContentDimension(Example $example, array $dimensionAttrib
         $exampleDimension = new ExampleDimensionContent($example);
         $exampleDimension->setStage($dimensionAttributes['stage'] ?? DimensionContentInterface::STAGE_DRAFT);
         $exampleDimension->setLocale($dimensionAttributes['locale'] ?? null);
+        $exampleDimension->setVersion($dimensionAttributes['version'] ?? 0);
 
         $this->getEntityManager()->persist($exampleDimension);
 

diff --git a/Tests/Unit/Content/Application/ContentMerger/ContentMergerTest.php b/Tests/Unit/Content/Application/ContentMerger/ContentMergerTest.php
@@ -69,6 +69,8 @@ public function testMerge(): void
             ->shouldBeCalled();
         $mergedDimensionContent->setStage('draft')
             ->shouldBeCalled();
+        $mergedDimensionContent->setVersion(0)
+            ->shouldBeCalled();
         $mergedDimensionContent->markAsMerged()
             ->shouldBeCalled();
 

diff --git a/.../Unit/Content/Application/ContentNormalizer/Normalizer/DimensionContentNormalizerTest.php b/.../Unit/Content/Application/ContentNormalizer/Normalizer/DimensionContentNormalizerTest.php
@@ -42,7 +42,7 @@ public function testIgnoredAttributes(): void
         $object = $this->prophesize(DimensionContentInterface::class);
 
         $this->assertSame(
-            ['id', 'merged', 'dimension', 'resource'],
+            ['id', 'merged', 'dimension', 'resource', 'version'],
             $normalizer->getIgnoredAttributes($object->reveal())
         );
     }

diff --git a/Tests/Unit/Content/Application/ContentWorkflow/ContentWorkflowTest.php b/Tests/Unit/Content/Application/ContentWorkflow/ContentWorkflowTest.php
@@ -83,9 +83,11 @@ public function testTransitionNoWorkflowInterface(): void
         $dimensionContent1 = $this->prophesize(DimensionContentInterface::class);
         $dimensionContent1->getStage()->willReturn('draft');
         $dimensionContent1->getLocale()->willReturn(null);
+        $dimensionContent1->getVersion()->willReturn(0);
         $dimensionContent2 = $this->prophesize(DimensionContentInterface::class);
-        $dimensionContent1->getStage()->willReturn('draft');
-        $dimensionContent1->getLocale()->willReturn('de');
+        $dimensionContent2->getStage()->willReturn('draft');
+        $dimensionContent2->getLocale()->willReturn('de');
+        $dimensionContent2->getVersion()->willReturn(0);
 
         $this->expectExceptionMessage(\sprintf(
             'Expected "%s" but "%s" given.',
@@ -166,11 +168,13 @@ public function testNotExistTransition(): void
         $dimensionContent1->willImplement(WorkflowInterface::class);
         $dimensionContent1->getLocale()->willReturn(null);
         $dimensionContent1->getStage()->willReturn('draft');
+        $dimensionContent1->getVersion()->willReturn(0);
 
         $dimensionContent2 = $this->prophesize(DimensionContentInterface::class);
         $dimensionContent2->willImplement(WorkflowInterface::class);
         $dimensionContent2->getLocale()->willReturn('de');
         $dimensionContent2->getStage()->willReturn('draft');
+        $dimensionContent2->getVersion()->willReturn(0);
 
         $dimensionContent2->getWorkflowPlace()
             ->willReturn('unpublished')
@@ -219,10 +223,12 @@ public function testTransitions(
         $dimensionContent1->willImplement(WorkflowInterface::class);
         $dimensionContent1->getLocale()->willReturn(null);
         $dimensionContent1->getStage()->willReturn('draft');
+        $dimensionContent1->getVersion()->willReturn(0);
         $dimensionContent2 = $this->prophesize(DimensionContentInterface::class);
         $dimensionContent2->willImplement(WorkflowInterface::class);
         $dimensionContent2->getLocale()->willReturn('de');
         $dimensionContent2->getStage()->willReturn('draft');
+        $dimensionContent2->getVersion()->willReturn(0);
 
         $dimensionContent2->getWorkflowPlace()
             ->willReturn($currentPlace)