WIP - Dimension Content Versioning

.github/workflows/test-application.yaml

@@ -52,12 +52,6 @@ jobs:
                       env:
                           SYMFONY_DEPRECATIONS_HELPER: weak
 
-                    - php-version: '8.3'
-                      coverage: false
-                      dependency-versions: 'highest'
-                      env:
-                          SYMFONY_DEPRECATIONS_HELPER: weak
-
         services:
             mysql:
                 image: mysql:5.7
@@ -119,7 +113,7 @@ jobs:
             - name: Install and configure PHP
               uses: shivammathur/setup-php@v2
               with:
-                  php-version: 8.3
+                  php-version: 8.0
                   extensions: ctype, iconv, mysql
 
             - name: Install composer dependencies

Content/Application/ContentMerger/ContentMerger.php

@@ -17,7 +17,6 @@
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentCollectionInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentInterface;
 use Symfony\Component\PropertyAccess\PropertyAccessor;
-use Webmozart\Assert\Assert;
 
 class ContentMerger implements ContentMergerInterface
 {
@@ -42,13 +41,6 @@ public function __construct(
         $this->propertyAccessor = $propertyAccessor;
     }
 
-    /**
-     * @template T of DimensionContentInterface
-     *
-     * @param DimensionContentCollectionInterface<T> $dimensionContentCollection
-     *
-     * @return T
-     */
     public function merge(DimensionContentCollectionInterface $dimensionContentCollection): DimensionContentInterface
     {
         if (!$dimensionContentCollection->count()) {
@@ -60,7 +52,6 @@ public function merge(DimensionContentCollectionInterface $dimensionContentColle
         foreach ($dimensionContentCollection as $dimensionContent) {
             if (!$mergedDimensionContent) {
                 $contentRichEntity = $dimensionContent->getResource();
-                /** @var T $mergedDimensionContent */
                 $mergedDimensionContent = $contentRichEntity->createDimensionContent();
                 $mergedDimensionContent->markAsMerged();
             }
@@ -78,8 +69,6 @@ public function merge(DimensionContentCollectionInterface $dimensionContentColle
             }
         }
 
-        Assert::notNull($mergedDimensionContent);
-
         return $mergedDimensionContent;
     }
 }

Content/Application/ContentNormalizer/Normalizer/DimensionContentNormalizer.php

@@ -28,6 +28,7 @@ public function getIgnoredAttributes(object $object): array
             'merged',
             'dimension',
             'resource',
+            'version',
         ];
     }
 
@@ -40,6 +41,7 @@ public function enhance(object $object, array $normalizedData): array
         $normalizedData['id'] = $object->getResource()->getId();
         $normalizedData['locale'] = $object->getLocale();
         $normalizedData['stage'] = $object->getStage();
+        $normalizedData['version'] = $object->getVersion();
 
         return $normalizedData;
     }

Content/Application/ContentWorkflow/Subscriber/PublishTransitionSubscriber.php

@@ -21,6 +21,7 @@
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\ShadowInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\TemplateInterface;
 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;
 
@@ -36,9 +37,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
@@ -77,6 +86,17 @@ public function onPublish(TransitionEvent $transitionEvent): void
         $targetDimensionAttributes = $dimensionAttributes;
         $targetDimensionAttributes['stage'] = DimensionContentInterface::STAGE_LIVE;
 
+        $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' => time()])
+            );
+        }
+
         $shadowLocale = $dimensionContent instanceof ShadowInterface
             ? $dimensionContent->getShadowLocale()
             : null;

Content/Domain/Model/DimensionContentInterface.php

@@ -21,6 +21,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;
@@ -59,6 +61,10 @@ public function getStage(): string;
      */
     public function setStage(string $stage): void;
 
+    public function setVersion(int $version): void;
+
+    public function getVersion(): int;
+
     /**
      * @return T
      */

Content/Domain/Model/DimensionContentTrait.php

@@ -35,6 +35,11 @@ trait DimensionContentTrait
      */
     protected $stage = DimensionContentInterface::STAGE_DRAFT;
 
+    /**
+     * @var int
+     */
+    protected $version = DimensionContentInterface::DEFAULT_VERSION;
+
     /**
      * @var bool
      */
@@ -114,6 +119,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;
@@ -132,6 +147,7 @@ public static function getDefaultDimensionAttributes(): array
         return [
             'locale' => null,
             'stage' => DimensionContentInterface::STAGE_DRAFT,
+            'version' => DimensionContentInterface::DEFAULT_VERSION,
         ];
     }
 

Content/Domain/Model/TemplateInterface.php

@@ -22,12 +22,12 @@ public function getTemplateKey(): ?string;
     public function setTemplateKey(string $templateKey): void;
 
     /**
-     * @return array<string, mixed>
+     * @return mixed[]
      */
     public function getTemplateData(): array;
 
     /**
-     * @param array<string, mixed> $templateData
+     * @param mixed[] $templateData
      */
     public function setTemplateData(array $templateData): void;
 }

Content/Domain/Model/TemplateTrait.php

@@ -24,7 +24,7 @@ trait TemplateTrait
     private $templateKey;
 
     /**
-     * @var array<string, mixed>
+     * @var mixed[]
      */
     private $templateData = [];
 
@@ -43,9 +43,6 @@ public function getTemplateData(): array
         return $this->templateData;
     }
 
-    /**
-     * @param array<string, mixed> $templateData
-     */
     public function setTemplateData(array $templateData): void
     {
         $this->templateData = $templateData;

Content/Domain/Repository/DimensionContentRepositoryInterface.php

@@ -31,4 +31,14 @@ public function load(
         ContentRichEntityInterface $contentRichEntity,
         array $dimensionAttributes
     ): DimensionContentCollectionInterface;
+
+    /**
+     * @param mixed[] $dimensionAttributes
+     *
+     * @return string[]
+     */
+    public function getLocales(
+        ContentRichEntityInterface $contentRichEntity,
+        array $dimensionAttributes
+    ): array;
 }

Content/Infrastructure/Doctrine/DimensionContentRepository.php

@@ -66,6 +66,7 @@ public function load(
         $queryBuilder = $this->entityManager->createQueryBuilder()
             ->from($dimensionContentClass, 'dimensionContent')
             ->where('dimensionContent.' . $mappingProperty . ' = :id')
+            ->andWhere('dimensionContent.version = 0')
             ->setParameter('id', $contentRichEntity->getId());
 
         $this->dimensionContentQueryEnhancer->addSelects(
@@ -84,4 +85,29 @@ public function load(
             $dimensionContentClass
         );
     }
+
+    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());
+    }
 }

Content/Infrastructure/Doctrine/MetadataLoader.php

@@ -53,10 +53,12 @@ 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', ['default' => 0, 'nullable' => true]);
             $this->addField($metadata, 'ghostLocale', 'string', ['length' => 7, 'nullable' => true]);
             $this->addField($metadata, 'availableLocales', 'json', ['nullable' => true, 'options' => ['jsonb' => true]]);
             $this->addIndex($metadata, 'idx_dimension', ['stage', 'locale']);
             $this->addIndex($metadata, 'idx_locale', ['locale']);
+            $this->addIndex($metadata, 'idx_version', ['version']);
             $this->addIndex($metadata, 'idx_stage', ['stage']);
         }
 

Content/Infrastructure/Sulu/Link/ContentLinkProvider.php

@@ -108,9 +108,7 @@ public function preload(array $hrefs, $locale, $published = true): array
      */
     protected function getTitle(DimensionContentInterface $dimensionContent, array $data): ?string
     {
-        $title = $data['title'] ?? $data['name'] ?? null;
-
-        return \is_string($title) ? $title : null;
+        return $data['title'] ?? $data['name'] ?? null;
     }
 
     protected function getEntityIdField(): string

Content/Infrastructure/Sulu/Sitemap/ContentSitemapProvider.php

@@ -163,7 +163,7 @@ public function getMaxPage($scheme, $host): int
     {
         $queryBuilder = $this->createRoutesQueryBuilder();
         try {
-            $amount = (int) $queryBuilder
+            $amount = $queryBuilder
                 ->select('COUNT(' . self::ROUTE_ALIAS . ')')
                 ->getQuery()
                 ->getSingleScalarResult();

Content/Infrastructure/Sulu/Teaser/ContentTeaserProvider.php

@@ -162,7 +162,7 @@ protected function createTeaser(DimensionContentInterface $dimensionContent, arr
 
     /**
      * @param B $dimensionContent
-     * @param array<string, mixed> $data
+     * @param mixed[] $data
      */
     protected function getTitle(DimensionContentInterface $dimensionContent, array $data): ?string
     {
@@ -172,9 +172,7 @@ protected function getTitle(DimensionContentInterface $dimensionContent, array $
             }
         }
 
-        $title = $data['title'] ?? $data['name'] ?? null;
-
-        return \is_string($title) ? $title : null;
+        return $data['title'] ?? $data['name'] ?? null;
     }
 
     /**

Resources/config/services.xml

@@ -163,6 +163,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>

Tests/Application/ExampleTestBundle/Controller/ExampleController.php

@@ -99,6 +99,7 @@ public function cgetAction(Request $request): Response
         $listBuilder = $this->listBuilderFactory->create(Example::class);
         $listBuilder->addSelectField($fieldDescriptors['locale']);
         $listBuilder->addSelectField($fieldDescriptors['ghostLocale']);
+        $listBuilder->addSelectField($fieldDescriptors['version']);
         $listBuilder->setParameter('locale', $request->query->get('locale'));
         $this->restHelper->initializeListBuilder($listBuilder, $fieldDescriptors);
 

Tests/Application/ExampleTestBundle/Entity/ExampleDimensionContent.php

@@ -85,13 +85,10 @@ public function getTitle(): ?string
         return $this->title;
     }
 
-    /**
-     * @param array<string, mixed> $templateData
-     */
     public function setTemplateData(array $templateData): void
     {
         if (\array_key_exists('title', $templateData)) {
-            $this->title = \is_string($templateData['title']) ? $templateData['title'] : null;
+            $this->title = $templateData['title'];
         }
 
         $this->parentSetTemplateData($templateData);

Tests/Application/ExampleTestBundle/Repository/ExampleRepository.php

@@ -185,7 +185,7 @@ public function countBy(array $filters = []): int
 
         $queryBuilder->select('COUNT(DISTINCT example.id)');
 
-        return (int) $queryBuilder->getQuery()->getSingleScalarResult();
+        return (int) $queryBuilder->getQuery()->getSingleScalarResult(); // @phpstan-ignore-line
     }
 
     /**

Tests/Application/ExampleTestBundle/Resources/config/lists/examples.xml

@@ -7,7 +7,7 @@
             <entity-name>dimensionContent</entity-name>
             <field-name>Sulu\Bundle\ContentBundle\Tests\Application\ExampleTestBundle\Entity\Example.dimensionContents</field-name>
             <method>LEFT</method>
-            <condition>dimensionContent.locale = :locale AND dimensionContent.stage = 'draft'</condition>
+            <condition>dimensionContent.locale = :locale AND dimensionContent.stage = 'draft' AND dimensionContent.version = '0'</condition>
         </join>
     </joins>
 
@@ -16,7 +16,7 @@
             <entity-name>unlocalizedDimensionContent</entity-name>
             <field-name>Sulu\Bundle\ContentBundle\Tests\Application\ExampleTestBundle\Entity\Example.dimensionContents</field-name>
             <method>LEFT</method>
-            <condition>unlocalizedDimensionContent.locale IS NULL AND unlocalizedDimensionContent.stage = 'draft'</condition>
+            <condition>unlocalizedDimensionContent.locale IS NULL AND unlocalizedDimensionContent.stage = 'draft' AND unlocalizedDimensionContent.version = '0'</condition>
         </join>
     </joins>
 
@@ -25,7 +25,7 @@
             <entity-name>ghostDimensionContent</entity-name>
             <field-name>Sulu\Bundle\ContentBundle\Tests\Application\ExampleTestBundle\Entity\Example.dimensionContents</field-name>
             <method>LEFT</method>
-            <condition>dimensionContent.locale IS NULL AND ghostDimensionContent.locale = unlocalizedDimensionContent.ghostLocale AND ghostDimensionContent.stage = 'draft'</condition>
+            <condition>dimensionContent.locale IS NULL AND ghostDimensionContent.locale = unlocalizedDimensionContent.ghostLocale AND ghostDimensionContent.stage = 'draft' AND ghostDimensionContent.version = '0'</condition>
         </join>
     </joins>
 
@@ -66,5 +66,12 @@
 
             <joins ref="ghostDimensionContent"/>
         </property>
+
+        <property name="version" translation="sulu_admin.version" visibility="never">
+            <field-name>version</field-name>
+            <entity-name>dimensionContent</entity-name>
+
+            <joins ref="dimensionContent"/>
+        </property>
     </properties>
 </list>