Fix availableLocales after unpublish

Content/Application/ContentWorkflow/Subscriber/UnpublishTransitionSubscriber.php

@@ -68,14 +68,23 @@ public function onUnpublish(TransitionEvent $transitionEvent): void
         }
 
         $liveDimensionAttributes = \array_merge($dimensionAttributes, ['stage' => DimensionContentInterface::STAGE_LIVE]);
-
         $dimensionContentCollection = $this->dimensionContentRepository->load($contentRichEntity, $liveDimensionAttributes);
         $localizedLiveDimensionContent = $dimensionContentCollection->getDimensionContent($liveDimensionAttributes);
 
         if (!$localizedLiveDimensionContent) {
             throw new ContentNotFoundException($contentRichEntity, $liveDimensionAttributes);
         }
 
+        $locale = $localizedLiveDimensionContent->getLocale();
+
+        if ($locale) {
+            $unlocalizedLiveDimensionAttributes = \array_merge($liveDimensionAttributes, ['locale' => null]);
+
+            /** @var DimensionContentInterface $unlocalizedLiveDimensionContent */
+            $unlocalizedLiveDimensionContent = $dimensionContentCollection->getDimensionContent($unlocalizedLiveDimensionAttributes);
+            $unlocalizedLiveDimensionContent->removeAvailableLocale($locale);
+        }
+
         $this->entityManager->remove($localizedLiveDimensionContent);
     }
 

Content/Domain/Model/DimensionContentInterface.php

@@ -39,6 +39,11 @@ public function getGhostLocale(): ?string;
      */
     public function addAvailableLocale(string $availableLocale): void;
 
+    /**
+     * @internal should only be set by content bundle services not from outside
+     */
+    public function removeAvailableLocale(string $availableLocale): void;
+
     /**
      * @return string[]|null
      */

Content/Domain/Model/DimensionContentTrait.php

@@ -80,6 +80,22 @@ public function addAvailableLocale(string $availableLocale): void
         }
     }
 
+    /**
+     * @internal should only be set by content bundle services not from outside
+     */
+    public function removeAvailableLocale(string $availableLocale): void
+    {
+        if (null === $this->availableLocales) {
+            return;
+        }
+
+        $removeIndex = \array_search($availableLocale, $this->availableLocales, true);
+        if (false !== $removeIndex) {
+            unset($this->availableLocales[$removeIndex]);
+            $this->availableLocales = \array_values($this->availableLocales);
+        }
+    }
+
     public function getAvailableLocales(): ?array
     {
         return $this->availableLocales;

Tests/Functional/Integration/responses/example_get.json

@@ -17,6 +17,7 @@
     "ghostLocale": "en",
     "id": "@integer@",
     "images": null,
+    "mainWebspace": "sulu-io",
     "locale": "en",
     "published": null,
     "publishedState": false,
@@ -31,6 +32,5 @@
     "template": "example-2",
     "title": "Test Example",
     "url": "/my-example",
-    "workflowPlace": "unpublished",
-    "mainWebspace": "sulu-io"
+    "workflowPlace": "unpublished"
 }

Tests/Functional/Integration/responses/example_get_ghost_locale.json

@@ -12,6 +12,7 @@
     "ghostLocale": "en",
     "id": "@integer@",
     "locale": null,
+    "mainWebspace": null,
     "published": null,
     "publishedState": false,
     "seoCanonicalUrl": null,

Tests/Functional/Integration/responses/example_post_trigger_copy_locale.json

@@ -19,6 +19,7 @@
     "id": "@integer@",
     "images": null,
     "locale": "de",
+    "mainWebspace": "sulu-io",
     "published": null,
     "publishedState": false,
     "seoCanonicalUrl": "https://sulu.io/",

Tests/Unit/Content/Application/ContentWorkflow/Subscriber/UnpublishTransitionSubscriberTest.php

@@ -24,6 +24,8 @@
 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 Sulu\Bundle\ContentBundle\Tests\Application\ExampleTestBundle\Entity\Example;
+use Sulu\Bundle\ContentBundle\Tests\Application\ExampleTestBundle\Entity\ExampleDimensionContent;
 use Symfony\Component\Workflow\Event\TransitionEvent;
 use Symfony\Component\Workflow\Marking;
 
@@ -197,12 +199,23 @@ public function testOnUnpublish(): void
             $entityManager->reveal()
         );
 
-        $localizedLiveDimensionContent = $this->prophesize(DimensionContentInterface::class);
+        $example = new Example();
+        $localizedLiveDimensionContent = new ExampleDimensionContent($example);
+        $localizedLiveDimensionContent->setStage('live');
+        $localizedLiveDimensionContent->setLocale('en');
         $dimensionContentCollection = $this->prophesize(DimensionContentCollectionInterface::class);
         $dimensionContentCollection->getDimensionContent(['locale' => 'en', 'stage' => 'live'])
             ->willReturn($localizedLiveDimensionContent)
             ->shouldBeCalled();
 
+        $unlocalizedLiveDimensionContent = new ExampleDimensionContent($example);
+        $unlocalizedLiveDimensionContent->setStage('live');
+        $unlocalizedLiveDimensionContent->addAvailableLocale('en');
+        $unlocalizedLiveDimensionContent->addAvailableLocale('de');
+        $dimensionContentCollection->getDimensionContent(['locale' => null, 'stage' => 'live'])
+            ->willReturn($unlocalizedLiveDimensionContent)
+            ->shouldBeCalled();
+
         $liveDimensionAttributes = \array_merge($dimensionAttributes, ['stage' => DimensionContentInterface::STAGE_LIVE]);
 
         $dimensionContentRepository->load($contentRichEntity->reveal(), $liveDimensionAttributes)
@@ -212,5 +225,6 @@ public function testOnUnpublish(): void
         $entityManager->remove($localizedLiveDimensionContent)->shouldBeCalled();
 
         $contentUnpublishSubscriber->onUnpublish($event);
+        $this->assertSame(['de'], $unlocalizedLiveDimensionContent->getAvailableLocales());
     }
 }

Tests/Unit/Content/Domain/Model/DimensionContentTraitTest.php

@@ -70,6 +70,46 @@ public function testAddSameAvailableLocale(): void
         $this->assertSame(['de'], $model->getAvailableLocales());
     }
 
+    public function testRemoveAvailableLocaleFirst(): void
+    {
+        $model = $this->getDimensionContentInstance();
+        $this->assertNull($model->getAvailableLocales());
+        $model->addAvailableLocale('de');
+        $model->addAvailableLocale('en');
+        $this->assertSame(['de', 'en'], $model->getAvailableLocales());
+        $model->removeAvailableLocale('de');
+        $this->assertSame(['en'], $model->getAvailableLocales());
+    }
+
+    public function testRemoveAvailableLocaleLast(): void
+    {
+        $model = $this->getDimensionContentInstance();
+        $this->assertNull($model->getAvailableLocales());
+        $model->addAvailableLocale('de');
+        $model->addAvailableLocale('en');
+        $this->assertSame(['de', 'en'], $model->getAvailableLocales());
+        $model->removeAvailableLocale('en');
+        $this->assertSame(['de'], $model->getAvailableLocales());
+    }
+
+    public function testRemoveAvailableLocaleNotSet(): void
+    {
+        $model = $this->getDimensionContentInstance();
+        $this->assertNull($model->getAvailableLocales());
+        $model->addAvailableLocale('en');
+        $this->assertSame(['en'], $model->getAvailableLocales());
+        $model->removeAvailableLocale('de');
+        $this->assertSame(['en'], $model->getAvailableLocales());
+    }
+
+    public function testRemoveAvailableLocaleEmpty(): void
+    {
+        $model = $this->getDimensionContentInstance();
+        $this->assertNull($model->getAvailableLocales());
+        $model->removeAvailableLocale('de');
+        $this->assertNull($model->getAvailableLocales());
+    }
+
     public function testGetSetStage(): void
     {
         $model = $this->getDimensionContentInstance();

Tests/Unit/Mocks/DimensionContentMockWrapperTrait.php

@@ -52,6 +52,11 @@ public function getAvailableLocales(): ?array
         return $this->instance->getAvailableLocales();
     }
 
+    public function removeAvailableLocale(string $availableLocale): void
+    {
+        $this->instance->removeAvailableLocale();
+    }
+
     public function addAvailableLocale(string $availableLocale): void
     {
         $this->instance->addAvailableLocale($availableLocale);

composer.json

@@ -66,7 +66,10 @@
         "doctrine/persistence": "1.3.2"
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "composer/package-versions-deprecated": true
+        }
     },
     "autoload": {
         "psr-4": {

phpstan-baseline.neon

@@ -0,0 +1,22 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Parameter \\#1 \\$array of function array_values expects array, array\\<string\\>\\|null given\\.$#"
+			count: 1
+			path: Tests/Application/ExampleTestBundle/Entity/ExampleDimensionContent.php
+
+		-
+			message: "#^Parameter \\#1 \\$array of function array_values expects array, array\\<string\\>\\|null given\\.$#"
+			count: 2
+			path: Tests/Unit/Content/Application/ContentNormalizer/ContentNormalizerTest.php
+
+		-
+			message: "#^Parameter \\#1 \\$array of function array_values expects array, array\\<string\\>\\|null given\\.$#"
+			count: 1
+			path: Tests/Unit/Content/Domain/Model/DimensionContentTraitTest.php
+
+		-
+			message: "#^Parameter \\#1 \\$array of function array_values expects array, array\\<string\\>\\|null given\\.$#"
+			count: 3
+			path: Tests/Unit/Content/Infrastructure/Sulu/Admin/ContentViewBuilderFactoryTest.php
+

phpstan.neon

@@ -1,4 +1,5 @@
 includes:
+    - phpstan-baseline.neon
     - vendor/jangregor/phpstan-prophecy/extension.neon
     - vendor/phpstan/phpstan-symfony/extension.neon
     - vendor/phpstan/phpstan-doctrine/extension.neon