Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4914 from mhsdesign/bugfix/4298-dublicated-conten…
…tstream-in-import-and-export BUGFIX: Duplicated content stream in import and export
- Loading branch information
Showing
12 changed files
with
466 additions
and
2,103 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
216 changes: 216 additions & 0 deletions
216
Neos.ContentRepository.Export/Tests/Behavior/Features/Bootstrap/CrImportExportTrait.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,216 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Neos.ContentGraph.DoctrineDbalAdapter package. | ||
| * | ||
| * (c) Contributors of the Neos Project - www.neos.io | ||
| * | ||
| * This package is Open Source Software. For the full copyright and license | ||
| * information, please view the LICENSE file which was distributed with this | ||
| * source code. | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Neos\ContentGraph\DoctrineDbalAdapter\Tests\Behavior\Features\Bootstrap; | ||
|
|
||
| use Behat\Gherkin\Node\PyStringNode; | ||
| use Behat\Gherkin\Node\TableNode; | ||
| use League\Flysystem\Filesystem; | ||
| use League\Flysystem\InMemory\InMemoryFilesystemAdapter; | ||
| use Neos\ContentGraph\DoctrineDbalAdapter\DoctrineDbalContentGraphProjectionFactory; | ||
| use Neos\ContentRepository\Core\Factory\ContentRepositoryServiceFactoryDependencies; | ||
| use Neos\ContentRepository\Core\Factory\ContentRepositoryServiceFactoryInterface; | ||
| use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId; | ||
| use Neos\ContentRepository\Export\Event\ValueObject\ExportedEvents; | ||
| use Neos\ContentRepository\Export\ProcessorResult; | ||
| use Neos\ContentRepository\Export\Processors\EventExportProcessor; | ||
| use Neos\ContentRepository\Export\Processors\EventStoreImportProcessor; | ||
| use Neos\ContentRepository\Export\Severity; | ||
| use Neos\ContentRepository\TestSuite\Behavior\Features\Bootstrap\CRTestSuiteRuntimeVariables; | ||
| use PHPUnit\Framework\Assert; | ||
|
|
||
| /** | ||
| * @todo move this class somewhere where its autoloaded | ||
| */ | ||
| trait CrImportExportTrait | ||
| { | ||
| use CRTestSuiteRuntimeVariables; | ||
|
|
||
| private Filesystem $crImportExportTrait_filesystem; | ||
|
|
||
| private ?ProcessorResult $crImportExportTrait_lastMigrationResult = null; | ||
|
|
||
| /** @var array<string> */ | ||
| private array $crImportExportTrait_loggedErrors = []; | ||
|
|
||
| /** @var array<string> */ | ||
| private array $crImportExportTrait_loggedWarnings = []; | ||
|
|
||
| public function setupCrImportExportTrait() | ||
| { | ||
| $this->crImportExportTrait_filesystem = new Filesystem(new InMemoryFilesystemAdapter()); | ||
| } | ||
|
|
||
| /** | ||
| * @When /^the events are exported$/ | ||
| */ | ||
| public function theEventsAreExportedIExpectTheFollowingJsonl() | ||
| { | ||
| $eventExporter = $this->getContentRepositoryService( | ||
| new class ($this->crImportExportTrait_filesystem) implements ContentRepositoryServiceFactoryInterface { | ||
| public function __construct(private readonly Filesystem $filesystem) | ||
| { | ||
| } | ||
| public function build(ContentRepositoryServiceFactoryDependencies $serviceFactoryDependencies): EventExportProcessor { | ||
| return new EventExportProcessor( | ||
| $this->filesystem, | ||
| $serviceFactoryDependencies->contentRepository->getWorkspaceFinder(), | ||
| $serviceFactoryDependencies->eventStore | ||
| ); | ||
| } | ||
| } | ||
| ); | ||
| assert($eventExporter instanceof EventExportProcessor); | ||
|
|
||
| $eventExporter->onMessage(function (Severity $severity, string $message) { | ||
| if ($severity === Severity::ERROR) { | ||
| $this->crImportExportTrait_loggedErrors[] = $message; | ||
| } elseif ($severity === Severity::WARNING) { | ||
| $this->crImportExportTrait_loggedWarnings[] = $message; | ||
| } | ||
| }); | ||
| $this->crImportExportTrait_lastMigrationResult = $eventExporter->run(); | ||
| } | ||
|
|
||
| /** | ||
| * @When /^I import the events\.jsonl(?: into "([^"]*)")?$/ | ||
| */ | ||
| public function iImportTheFollowingJson(?string $contentStreamId = null) | ||
| { | ||
| $eventImporter = $this->getContentRepositoryService( | ||
| new class ($this->crImportExportTrait_filesystem, $contentStreamId ? ContentStreamId::fromString($contentStreamId) : null) implements ContentRepositoryServiceFactoryInterface { | ||
| public function __construct( | ||
| private readonly Filesystem $filesystem, | ||
| private readonly ?ContentStreamId $contentStreamId | ||
| ) { | ||
| } | ||
| public function build(ContentRepositoryServiceFactoryDependencies $serviceFactoryDependencies): EventStoreImportProcessor { | ||
| return new EventStoreImportProcessor( | ||
| false, | ||
| $this->filesystem, | ||
| $serviceFactoryDependencies->eventStore, | ||
| $serviceFactoryDependencies->eventNormalizer, | ||
| $this->contentStreamId | ||
| ); | ||
| } | ||
| } | ||
| ); | ||
| assert($eventImporter instanceof EventStoreImportProcessor); | ||
|
|
||
| $eventImporter->onMessage(function (Severity $severity, string $message) { | ||
| if ($severity === Severity::ERROR) { | ||
| $this->crImportExportTrait_loggedErrors[] = $message; | ||
| } elseif ($severity === Severity::WARNING) { | ||
| $this->crImportExportTrait_loggedWarnings[] = $message; | ||
| } | ||
| }); | ||
| $this->crImportExportTrait_lastMigrationResult = $eventImporter->run(); | ||
| } | ||
|
|
||
| /** | ||
| * @Given /^using the following events\.jsonl:$/ | ||
| */ | ||
| public function usingTheFollowingEventsJsonl(PyStringNode $string) | ||
| { | ||
| $this->crImportExportTrait_filesystem->write('events.jsonl', $string->getRaw()); | ||
| } | ||
|
|
||
| /** | ||
| * @AfterScenario | ||
| */ | ||
| public function failIfLastMigrationHasErrors(): void | ||
| { | ||
| if ($this->crImportExportTrait_lastMigrationResult !== null && $this->crImportExportTrait_lastMigrationResult->severity === Severity::ERROR) { | ||
| throw new \RuntimeException(sprintf('The last migration run led to an error: %s', $this->crImportExportTrait_lastMigrationResult->message)); | ||
| } | ||
| if ($this->crImportExportTrait_loggedErrors !== []) { | ||
| throw new \RuntimeException(sprintf('The last migration run logged %d error%s', count($this->crImportExportTrait_loggedErrors), count($this->crImportExportTrait_loggedErrors) === 1 ? '' : 's')); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @Then I expect the following jsonl: | ||
| */ | ||
| public function iExpectTheFollowingJsonL(PyStringNode $string): void | ||
| { | ||
| if (!$this->crImportExportTrait_filesystem->has('events.jsonl')) { | ||
| Assert::fail('No events were exported'); | ||
| } | ||
|
|
||
| $jsonL = $this->crImportExportTrait_filesystem->read('events.jsonl'); | ||
|
|
||
| $exportedEvents = ExportedEvents::fromJsonl($jsonL); | ||
| $eventsWithoutRandomIds = []; | ||
|
|
||
| foreach ($exportedEvents as $exportedEvent) { | ||
| // we have to remove the event id in \Neos\ContentRepository\Core\Feature\Common\NodeAggregateEventPublisher::enrichWithCommand | ||
| // and the initiatingTimestamp to make the events diff able | ||
| $eventsWithoutRandomIds[] = $exportedEvent | ||
| ->withIdentifier('random-event-uuid') | ||
| ->processMetadata(function (array $metadata) { | ||
| $metadata['initiatingTimestamp'] = 'random-time'; | ||
| return $metadata; | ||
| }); | ||
| } | ||
|
|
||
| Assert::assertSame($string->getRaw(), ExportedEvents::fromIterable($eventsWithoutRandomIds)->toJsonl()); | ||
| } | ||
|
|
||
| /** | ||
| * @Then I expect the following errors to be logged | ||
| */ | ||
| public function iExpectTheFollowingErrorsToBeLogged(TableNode $table): void | ||
| { | ||
| Assert::assertSame($table->getColumn(0), $this->crImportExportTrait_loggedErrors, 'Expected logged errors do not match'); | ||
| $this->crImportExportTrait_loggedErrors = []; | ||
| } | ||
|
|
||
| /** | ||
| * @Then I expect the following warnings to be logged | ||
| */ | ||
| public function iExpectTheFollowingWarningsToBeLogged(TableNode $table): void | ||
| { | ||
| Assert::assertSame($table->getColumn(0), $this->crImportExportTrait_loggedWarnings, 'Expected logged warnings do not match'); | ||
| $this->crImportExportTrait_loggedWarnings = []; | ||
| } | ||
|
|
||
| /** | ||
| * @Then I expect a MigrationError | ||
| * @Then I expect a MigrationError with the message | ||
| */ | ||
| public function iExpectAMigrationErrorWithTheMessage(PyStringNode $expectedMessage = null): void | ||
| { | ||
| Assert::assertNotNull($this->crImportExportTrait_lastMigrationResult, 'Expected the previous migration to contain errors, but no migration has been executed'); | ||
| Assert::assertSame(Severity::ERROR, $this->crImportExportTrait_lastMigrationResult->severity, sprintf('Expected the previous migration to contain errors, but it ended with severity "%s"', $this->crImportExportTrait_lastMigrationResult->severity->name)); | ||
| if ($expectedMessage !== null) { | ||
| Assert::assertSame($expectedMessage->getRaw(), $this->crImportExportTrait_lastMigrationResult->message); | ||
| } | ||
| $this->crImportExportTrait_lastMigrationResult = null; | ||
| } | ||
|
|
||
| /** | ||
| * @template T of object | ||
| * @param class-string<T> $className | ||
| * | ||
| * @return T | ||
| */ | ||
| abstract private function getObject(string $className): object; | ||
|
|
||
| protected function getTableNamePrefix(): string | ||
| { | ||
| return DoctrineDbalContentGraphProjectionFactory::graphProjectionTableNamePrefix( | ||
| $this->currentContentRepository->id | ||
| ); | ||
| } | ||
| } |
79 changes: 79 additions & 0 deletions
79
Neos.ContentRepository.Export/Tests/Behavior/Features/Bootstrap/FeatureContext.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| <?php | ||
| declare(strict_types=1); | ||
|
|
||
| /* | ||
| * This file is part of the Neos.ContentRepository package. | ||
| * | ||
| * (c) Contributors of the Neos Project - www.neos.io | ||
| * | ||
| * This package is Open Source Software. For the full copyright and license | ||
| * information, please view the LICENSE file which was distributed with this | ||
| * source code. | ||
| */ | ||
|
|
||
| require_once(__DIR__ . '/CrImportExportTrait.php'); | ||
|
|
||
| use Behat\Behat\Context\Context as BehatContext; | ||
| use Behat\Behat\Hook\Scope\BeforeScenarioScope; | ||
| use Neos\Behat\FlowBootstrapTrait; | ||
| use Neos\ContentGraph\DoctrineDbalAdapter\Tests\Behavior\Features\Bootstrap\CrImportExportTrait; | ||
| use Neos\ContentRepository\BehavioralTests\TestSuite\Behavior\CRBehavioralTestsSubjectProvider; | ||
| use Neos\ContentRepository\BehavioralTests\TestSuite\Behavior\GherkinPyStringNodeBasedNodeTypeManagerFactory; | ||
| use Neos\ContentRepository\BehavioralTests\TestSuite\Behavior\GherkinTableNodeBasedContentDimensionSourceFactory; | ||
| use Neos\ContentRepository\Core\ContentRepository; | ||
| use Neos\ContentRepository\Core\Factory\ContentRepositoryId; | ||
| use Neos\ContentRepository\Core\Factory\ContentRepositoryServiceFactoryInterface; | ||
| use Neos\ContentRepository\Core\Factory\ContentRepositoryServiceInterface; | ||
| use Neos\ContentRepository\TestSuite\Behavior\Features\Bootstrap\CRTestSuiteTrait; | ||
| use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; | ||
|
|
||
| /** | ||
| * Features context | ||
| */ | ||
| class FeatureContext implements BehatContext | ||
| { | ||
| use FlowBootstrapTrait; | ||
| use CrImportExportTrait; | ||
| use CRTestSuiteTrait; | ||
| use CRBehavioralTestsSubjectProvider; | ||
|
|
||
| protected ContentRepositoryRegistry $contentRepositoryRegistry; | ||
|
|
||
| public function __construct() | ||
| { | ||
| self::bootstrapFlow(); | ||
| $this->contentRepositoryRegistry = $this->getObject(ContentRepositoryRegistry::class); | ||
|
|
||
| $this->setupCRTestSuiteTrait(); | ||
| $this->setupCrImportExportTrait(); | ||
| } | ||
|
|
||
| /** | ||
| * @BeforeScenario | ||
| */ | ||
| public function resetContentRepositoryComponents(BeforeScenarioScope $scope): void | ||
| { | ||
| GherkinTableNodeBasedContentDimensionSourceFactory::reset(); | ||
| GherkinPyStringNodeBasedNodeTypeManagerFactory::reset(); | ||
| } | ||
|
|
||
| protected function getContentRepositoryService( | ||
| ContentRepositoryServiceFactoryInterface $factory | ||
| ): ContentRepositoryServiceInterface { | ||
| return $this->contentRepositoryRegistry->buildService( | ||
| $this->currentContentRepository->id, | ||
| $factory | ||
| ); | ||
| } | ||
|
|
||
| protected function createContentRepository( | ||
| ContentRepositoryId $contentRepositoryId | ||
| ): ContentRepository { | ||
| $this->contentRepositoryRegistry->resetFactoryInstance($contentRepositoryId); | ||
| $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); | ||
| GherkinTableNodeBasedContentDimensionSourceFactory::reset(); | ||
| GherkinPyStringNodeBasedNodeTypeManagerFactory::reset(); | ||
|
|
||
| return $contentRepository; | ||
| } | ||
| } |
45 changes: 45 additions & 0 deletions
45
Neos.ContentRepository.Export/Tests/Behavior/Features/Export/Export.feature
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| @contentrepository | ||
| Feature: As a user of the CR I want to export the event stream | ||
| Background: | ||
| Given using the following content dimensions: | ||
| | Identifier | Values | Generalizations | | ||
| | language | de, gsw, fr | gsw->de | | ||
| And using the following node types: | ||
| """yaml | ||
| 'Neos.ContentRepository.Testing:Document': [] | ||
| """ | ||
| And using identifier "default", I define a content repository | ||
| And I am in content repository "default" | ||
| And the command CreateRootWorkspace is executed with payload: | ||
| | Key | Value | | ||
| | workspaceName | "live" | | ||
| | workspaceTitle | "Live" | | ||
| | workspaceDescription | "The live workspace" | | ||
| | newContentStreamId | "cs-identifier" | | ||
| And the graph projection is fully up to date | ||
| And the command CreateRootNodeAggregateWithNode is executed with payload: | ||
| | Key | Value | | ||
| | contentStreamId | "cs-identifier" | | ||
| | nodeAggregateId | "lady-eleonode-rootford" | | ||
| | nodeTypeName | "Neos.ContentRepository:Root" | | ||
| And the event NodeAggregateWithNodeWasCreated was published with payload: | ||
| | Key | Value | | ||
| | contentStreamId | "cs-identifier" | | ||
| | nodeAggregateId | "nody-mc-nodeface" | | ||
| | nodeTypeName | "Neos.ContentRepository.Testing:Document" | | ||
| | originDimensionSpacePoint | {"language":"de"} | | ||
| | coveredDimensionSpacePoints | [{"language":"de"},{"language":"gsw"},{"language":"fr"}] | | ||
| | parentNodeAggregateId | "lady-eleonode-rootford" | | ||
| | nodeName | "child-document" | | ||
| | nodeAggregateClassification | "regular" | | ||
| And the graph projection is fully up to date | ||
|
|
||
| Scenario: Export the event stream | ||
| Then I expect exactly 3 events to be published on stream with prefix "ContentStream:cs-identifier" | ||
| When the events are exported | ||
| Then I expect the following jsonl: | ||
| """ | ||
| {"identifier":"random-event-uuid","type":"RootNodeAggregateWithNodeWasCreated","payload":{"contentStreamId":"cs-identifier","nodeAggregateId":"lady-eleonode-rootford","nodeTypeName":"Neos.ContentRepository:Root","coveredDimensionSpacePoints":[{"language":"de"},{"language":"gsw"},{"language":"fr"}],"nodeAggregateClassification":"root"},"metadata":{"commandClass":"Neos\\ContentRepository\\Core\\Feature\\RootNodeCreation\\Command\\CreateRootNodeAggregateWithNode","commandPayload":{"contentStreamId":"cs-identifier","nodeAggregateId":"lady-eleonode-rootford","nodeTypeName":"Neos.ContentRepository:Root","tetheredDescendantNodeAggregateIds":[]},"initiatingUserId":"system","initiatingTimestamp":"random-time"}} | ||
| {"identifier":"random-event-uuid","type":"NodeAggregateWithNodeWasCreated","payload":{"contentStreamId":"cs-identifier","nodeAggregateId":"nody-mc-nodeface","nodeTypeName":"Neos.ContentRepository.Testing:Document","originDimensionSpacePoint":{"language":"de"},"coveredDimensionSpacePoints":[{"language":"de"},{"language":"gsw"},{"language":"fr"}],"parentNodeAggregateId":"lady-eleonode-rootford","nodeName":"child-document","initialPropertyValues":[],"nodeAggregateClassification":"regular","succeedingNodeAggregateId":null},"metadata":{"initiatingTimestamp":"random-time"}} | ||
| """ |
Oops, something went wrong.