Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix indexing of unpublished documents #648

Merged
merged 5 commits into from
Sep 14, 2023
Merged

Fix indexing of unpublished documents #648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0f2b1da
Fix indexing of unpublished shadow documents
Prokyonn Sep 13, 2023
cecf10e
Revert deprecation
Prokyonn Sep 13, 2023
b3053ad
Fix shadow publishing
Prokyonn Sep 13, 2023
628248b
Add tests
Prokyonn Sep 13, 2023
eaaa816
Update baseline
Prokyonn Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Document/Index/ArticleGhostIndexer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ public function index(ArticleDocument $document): void
}

$article = $this->createOrUpdateArticle($document, $document->getLocale());
$this->createOrUpdateShadows($document);
$this->updateShadows($document);
$this->createOrUpdateGhosts($document);
$this->dispatchIndexEvent($document, $article);
$this->manager->persist($article);
Expand Down
27 changes: 20 additions & 7 deletions Document/Index/ArticleIndexer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,15 @@ private function getBlockContentFieldsRecursive(array $blocks, ArticleDocument $
return $contentFields;
}

protected function findViewDocument(ArticleDocument $document, string $locale): ?ArticleViewDocumentInterface
{
$articleId = $this->getViewDocumentId($document->getUuid(), $locale);
/** @var ArticleViewDocumentInterface $article */
$article = $this->manager->find($this->documentFactory->getClass('article'), $articleId);

return $article;
}

/**
* Returns view-document from index or create a new one.
*/
Expand All @@ -335,9 +344,7 @@ protected function findOrCreateViewDocument(
string $locale,
string $localizationState
): ?ArticleViewDocumentInterface {
$articleId = $this->getViewDocumentId($document->getUuid(), $locale);
/** @var ArticleViewDocumentInterface $article */
$article = $this->manager->find($this->documentFactory->getClass('article'), $articleId);
$article = $this->findViewDocument($document, $locale);

if ($article) {
// Only index ghosts when the article isn't a ghost himself.
Expand All @@ -351,7 +358,7 @@ protected function findOrCreateViewDocument(
}

$article = $this->documentFactory->create('article');
$article->setId($articleId);
$article->setId($this->getViewDocumentId($document->getUuid(), $locale));
$article->setUuid($document->getUuid());
$article->setLocale($locale);

Expand Down Expand Up @@ -505,11 +512,12 @@ public function index(ArticleDocument $document): void
$this->dispatchIndexEvent($document, $article);
$this->manager->persist($article);

$this->createOrUpdateShadows($document);
$this->updateShadows($document);
}

protected function indexShadow(ArticleDocument $document): void
{
/** @var ArticleDocument $shadowDocument */
$shadowDocument = $this->documentManager->find(
$document->getUuid(),
$document->getOriginalLocale(),
Expand All @@ -519,12 +527,11 @@ protected function indexShadow(ArticleDocument $document): void
);

$article = $this->createOrUpdateArticle($shadowDocument, $document->getOriginalLocale(), LocalizationState::SHADOW);

$this->dispatchIndexEvent($shadowDocument, $article);
$this->manager->persist($article);
}

protected function createOrUpdateShadows(ArticleDocument $document): void
protected function updateShadows(ArticleDocument $document): void
{
if ($document->isShadowLocaleEnabled()) {
return;
Expand All @@ -534,6 +541,12 @@ protected function createOrUpdateShadows(ArticleDocument $document): void
try {
/** @var ArticleDocument $shadowDocument */
$shadowDocument = $this->documentManager->find($document->getUuid(), $shadowLocale);

// update shadow only if original document exists
if (!$this->findViewDocument($shadowDocument, $document->getLocale())) {
continue;
}

$this->indexShadow($shadowDocument);
} catch (DocumentManagerException $documentManagerException) {
// @ignoreException
Expand Down
2 changes: 1 addition & 1 deletion Document/Subscriber/ArticleSubscriber.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,7 @@ public function handleRemoveLocaleLive(RemoveLocaleEvent $event)
return;
}

$this->liveIndexer->replaceWithGhostData($document, $event->getLocale());
$this->liveIndexer->remove($document, $event->getLocale());
$this->liveIndexer->flush();
}

Expand Down
3 changes: 2 additions & 1 deletion Resources/translations/admin.de.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,6 @@
"sulu_activity.description.articles.translation_copied": "{userFullName} hat die Sprachvariante für \"{context_sourceLocale}\" des Artikels \"{resourceTitle}\" nach \"{resourceLocale}\" kopiert",
"sulu_activity.description.articles.translation_removed": "{userFullName} hat die Sprachvariante für \"{resourceLocale}\" des Artikels \"{resourceTitle}\" gelöscht",
"sulu_activity.description.articles.translation_restored": "{userFullName} hat die Sprachvariante für \"{resourceLocale}\" des Artikels \"{resourceTitle}\" wiederhergestellt",
"sulu_activity.description.articles.version_restored": "{userFullName} hat die Version \"{context_version}\" des Artikels \"{resourceTitle}\" wiederhergestellt"
"sulu_activity.description.articles.version_restored": "{userFullName} hat die Version \"{context_version}\" des Artikels \"{resourceTitle}\" wiederhergestellt",
"sulu_activity.description.articles.route_removed": "{userFullName} hat die Route \"{resourceTitle}\" gelöscht."
}
3 changes: 2 additions & 1 deletion Resources/translations/admin.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,6 @@
"sulu_activity.description.articles.translation_copied": "{userFullName} has copied the \"{context_sourceLocale}\" translation of the article \"{resourceTitle}\" into \"{resourceLocale}\"",
"sulu_activity.description.articles.translation_removed": "{userFullName} has removed the \"{resourceLocale}\" translation of the article \"{resourceTitle}\"",
"sulu_activity.description.articles.translation_restored": "{userFullName} has restored the \"{resourceLocale}\" translation of the article \"{resourceTitle}\"",
"sulu_activity.description.articles.version_restored": "{userFullName} has restored the version \"{context_version}\" of the article \"{resourceTitle}\""
"sulu_activity.description.articles.version_restored": "{userFullName} has restored the version \"{context_version}\" of the article \"{resourceTitle}\"",
"sulu_activity.description.articles.route_removed": "{userFullName} has removed the route \"{resourceTitle}\"."
}
1 change: 1 addition & 0 deletions Tests/Application/config/webspaces/sulu.io.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
<localizations>
<localization language="de" default="true"/>
<localization language="en"/>
<localization language="fr"/>
</localizations>

<theme>default</theme>
Expand Down
97 changes: 97 additions & 0 deletions Tests/Functional/Document/Index/ArticleIndexerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,91 @@ public function testIndexShadow()
$this->assertEquals($contentData['article'], 'Test content - CHANGED!');
}

public function testUnpublishedShadows(): void
{
$article = $this->createArticle(
[
'article' => 'Test content',
],
'Test Article',
'default_with_route'
);
$secondLocale = 'de';
$thirdLocale = 'fr';

$this->updateArticle(
$article['id'],
$secondLocale,
[
'id' => $article['id'],
'article' => 'Test Inhalt',
],
'Test Artikel Deutsch',
'default_with_route'
);
$this->updateArticle(
$article['id'],
$secondLocale,
[
'id' => $article['id'],
'shadowOn' => true,
'shadowBaseLanguage' => $this->locale,
],
null,
null
);

$this->updateArticle(
$article['id'],
$thirdLocale,
[
'id' => $article['id'],
'article' => 'Test French Content',
],
'Test Artikel French',
'default_with_route'
);
$this->updateArticle(
$article['id'],
$thirdLocale,
[
'id' => $article['id'],
'shadowOn' => true,
'shadowBaseLanguage' => $this->locale,
],
null,
null
);

self::assertNotNull($this->findViewDocument($article['id'], $this->locale));
self::assertNotNull($this->findViewDocument($article['id'], $secondLocale));
self::assertNotNull($this->findViewDocument($article['id'], $thirdLocale));

$this->unpublishArticle($article['id'], $this->locale);
$this->unpublishArticle($article['id'], $secondLocale);
$this->unpublishArticle($article['id'], $thirdLocale);

self::assertNull($this->findViewDocument($article['id'], $this->locale));
self::assertNull($this->findViewDocument($article['id'], $secondLocale));
self::assertNull($this->findViewDocument($article['id'], $thirdLocale));

// publish the shadow
$this->updateArticle(
$article['id'],
$secondLocale,
[
'id' => $article['id'],
],
null,
null
);

// only the DE shadow should be published
self::assertNull($this->findViewDocument($article['id'], $this->locale));
self::assertNotNull($this->findViewDocument($article['id'], $secondLocale));
self::assertNull($this->findViewDocument($article['id'], $thirdLocale));
}

public function testIndexPageTreeRoute()
{
$page = $this->createPage();
Expand Down Expand Up @@ -542,6 +627,18 @@ private function updateArticle(
return \json_decode($this->client->getResponse()->getContent(), true);
}

private function unpublishArticle($uuid, $locale = null)
{
$this->client->jsonRequest(
'POST',
'/api/articles/' . $uuid . '?locale=' . ($locale ?: $this->locale) . '&action=unpublish'
);

$this->assertEquals(200, $this->client->getResponse()->getStatusCode());

return \json_decode($this->client->getResponse()->getContent(), true);
}

/**
* Create article page.
*
Expand Down
60 changes: 60 additions & 0 deletions Tests/Unit/Document/Subscriber/ArticleSubscriberTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
use Sulu\Component\DocumentManager\Event\PublishEvent;
use Sulu\Component\DocumentManager\Event\RemoveDraftEvent;
use Sulu\Component\DocumentManager\Event\RemoveEvent;
use Sulu\Component\DocumentManager\Event\RemoveLocaleEvent;
use Sulu\Component\DocumentManager\Event\ReorderEvent;

class ArticleSubscriberTest extends TestCase
Expand Down Expand Up @@ -654,4 +655,63 @@ public function testPersistPageDataOnReorder()

$this->articleSubscriber->persistPageDataOnReorder($event->reveal());
}

public function testHandleRemoveLocaleWithInvalidDocument()
{
$event = $this->prophesize(RemoveLocaleEvent::class);
$document = $this->prophesize(\stdClass::class); // Not an ArticleDocument
$event->getDocument()->willReturn($document->reveal());

// Ensure the indexer methods are not called
$this->indexer->replaceWithGhostData()->shouldNotBeCalled();
$this->indexer->flush()->shouldNotBeCalled();

// Call the method and make sure it doesn't throw exceptions
$this->articleSubscriber->handleRemoveLocale($event->reveal());
}

public function testHandleRemoveLocale()
{
$event = $this->prophesize(RemoveLocaleEvent::class);
$document = $this->prophesize(ArticleDocument::class);
$event->getDocument()->willReturn($document->reveal());
$event->getLocale()->willReturn('en');

// Ensure the indexer methods are called
$this->indexer->replaceWithGhostData($document->reveal(), 'en')->shouldBeCalled();
$this->indexer->flush()->shouldBeCalled();

// Call the method
$this->articleSubscriber->handleRemoveLocale($event->reveal());
}

public function testHandleRemoveLocaleLiveWithInvalidDocument()
{
$event = $this->prophesize(RemoveLocaleEvent::class);
$document = $this->prophesize(\stdClass::class); // Not an ArticleDocument
$event->getDocument()->willReturn($document->reveal());

// Ensure the liveIndexer methods are not called
$this->liveIndexer->remove()->shouldNotBeCalled();
$this->liveIndexer->flush()->shouldNotBeCalled();

// Call the method and make sure it doesn't throw exceptions
$this->articleSubscriber->handleRemoveLocaleLive($event->reveal());
}

public function testHandleRemoveLocaleLive()
{
// Create a mock RemoveLocaleEvent with an ArticleDocument
$event = $this->prophesize(RemoveLocaleEvent::class);
$document = $this->prophesize(ArticleDocument::class);
$event->getDocument()->willReturn($document->reveal());
$event->getLocale()->willReturn('en');

// Ensure the liveIndexer methods are called
$this->liveIndexer->remove($document->reveal(), 'en')->shouldBeCalled();
$this->liveIndexer->flush()->shouldBeCalled();

// Call the method
$this->articleSubscriber->handleRemoveLocaleLive($event->reveal());
}
}
Loading
Loading