From bff61f3560831c0747480531b4ce93bc318e0991 Mon Sep 17 00:00:00 2001 From: mhsdesign <85400359+mhsdesign@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:38:29 +0200 Subject: [PATCH] !!! TASK: Declare `ProjectionService` as api to reset projections instead of ContentRepository --- .../Command/PerformanceMeasurementService.php | 6 ++-- .../PerformanceMeasurementServiceFactory.php | 3 +- .../CRBehavioralTestsSubjectProvider.php | 6 +++- .../Classes/Projection/Projections.php | 11 +++++- .../Classes/Service/ProjectionService.php | 34 +++++++++---------- .../Service/ProjectionServiceFactory.php | 24 +++++++++++++ .../Classes/Command/CrCommandController.php | 6 ++-- .../Features/Bootstrap/CRTestSuiteTrait.php | 8 +++-- .../Behavior/CRRegistrySubjectProvider.php | 6 +++- .../Classes/Command/CrCommandController.php | 4 +-- .../ProjectionReplayServiceFactory.php | 30 ---------------- .../Classes/Command/CrCommandController.php | 6 ++-- phpstan-baseline.neon | 4 --- 13 files changed, 80 insertions(+), 68 deletions(-) rename Neos.ContentRepositoryRegistry/Classes/Service/ProjectionReplayService.php => Neos.ContentRepository.Core/Classes/Service/ProjectionService.php (73%) create mode 100644 Neos.ContentRepository.Core/Classes/Service/ProjectionServiceFactory.php delete mode 100644 Neos.ContentRepositoryRegistry/Classes/Service/ProjectionReplayServiceFactory.php diff --git a/Neos.ContentRepository.BehavioralTests/Classes/Command/PerformanceMeasurementService.php b/Neos.ContentRepository.BehavioralTests/Classes/Command/PerformanceMeasurementService.php index 378d5351dfe..b11139eb9bb 100644 --- a/Neos.ContentRepository.BehavioralTests/Classes/Command/PerformanceMeasurementService.php +++ b/Neos.ContentRepository.BehavioralTests/Classes/Command/PerformanceMeasurementService.php @@ -32,6 +32,7 @@ use Neos\ContentRepository\Core\Feature\RootNodeCreation\Event\RootNodeAggregateWithNodeWasCreated; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateRootWorkspace; use Neos\ContentRepository\Core\NodeType\NodeTypeName; +use Neos\ContentRepository\Core\Projection\Projections; use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateClassification; use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateId; @@ -53,7 +54,8 @@ public function __construct( private readonly EventPersister $eventPersister, private readonly ContentRepository $contentRepository, private readonly Connection $connection, - private readonly ContentRepositoryId $contentRepositoryId + private readonly ContentRepositoryId $contentRepositoryId, + private readonly Projections $projections, ) { $this->contentStreamId = contentStreamId::fromString('cs-identifier'); $this->workspaceName = WorkspaceName::fromString('some-workspace'); @@ -74,7 +76,7 @@ public function removeEverything(): void { $eventTableName = DoctrineEventStoreFactory::databaseTableName($this->contentRepositoryId); $this->connection->executeStatement('TRUNCATE ' . $this->connection->quoteIdentifier($eventTableName)); - $this->contentRepository->resetProjectionStates(); + $this->projections->resetAll(); } public function createNodesForPerformanceTest(int $nodesPerLevel, int $levels): void diff --git a/Neos.ContentRepository.BehavioralTests/Classes/Command/PerformanceMeasurementServiceFactory.php b/Neos.ContentRepository.BehavioralTests/Classes/Command/PerformanceMeasurementServiceFactory.php index 1b3c9611228..23d7fb4a87b 100644 --- a/Neos.ContentRepository.BehavioralTests/Classes/Command/PerformanceMeasurementServiceFactory.php +++ b/Neos.ContentRepository.BehavioralTests/Classes/Command/PerformanceMeasurementServiceFactory.php @@ -36,7 +36,8 @@ public function build( $serviceFactoryDependencies->eventPersister, $serviceFactoryDependencies->contentRepository, $this->connection, - $serviceFactoryDependencies->contentRepositoryId + $serviceFactoryDependencies->contentRepositoryId, + $serviceFactoryDependencies->projections, ); } } diff --git a/Neos.ContentRepository.BehavioralTests/Classes/TestSuite/Behavior/CRBehavioralTestsSubjectProvider.php b/Neos.ContentRepository.BehavioralTests/Classes/TestSuite/Behavior/CRBehavioralTestsSubjectProvider.php index 19eb183ff16..22eaf714546 100644 --- a/Neos.ContentRepository.BehavioralTests/Classes/TestSuite/Behavior/CRBehavioralTestsSubjectProvider.php +++ b/Neos.ContentRepository.BehavioralTests/Classes/TestSuite/Behavior/CRBehavioralTestsSubjectProvider.php @@ -18,6 +18,8 @@ use Behat\Gherkin\Node\TableNode; use Doctrine\DBAL\Connection; use Neos\ContentRepository\Core\ContentRepository; +use Neos\ContentRepository\Core\Service\ProjectionService; +use Neos\ContentRepository\Core\Service\ProjectionServiceFactory; use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; use Neos\ContentRepository\TestSuite\Behavior\Features\Bootstrap\Helpers\GherkinTableNodeBasedContentDimensionSource; use Neos\EventStore\EventStoreInterface; @@ -179,7 +181,9 @@ protected function setUpContentRepository(ContentRepositoryId $contentRepository $databaseConnection = (new \ReflectionClass($eventStore))->getProperty('connection')->getValue($eventStore); $eventTableName = sprintf('cr_%s_events', $contentRepositoryId->value); $databaseConnection->executeStatement('TRUNCATE ' . $eventTableName); - $contentRepository->resetProjectionStates(); + /** @var ProjectionService $projectionService */ + $projectionService = $this->contentRepositoryRegistry->buildService($contentRepositoryId, $this->getObject(ProjectionServiceFactory::class)); + $projectionService->resetAllProjections(); return $contentRepository; } diff --git a/Neos.ContentRepository.Core/Classes/Projection/Projections.php b/Neos.ContentRepository.Core/Classes/Projection/Projections.php index 0bc7dffec20..b835a78b2b7 100644 --- a/Neos.ContentRepository.Core/Classes/Projection/Projections.php +++ b/Neos.ContentRepository.Core/Classes/Projection/Projections.php @@ -4,11 +4,13 @@ namespace Neos\ContentRepository\Core\Projection; +use Neos\ContentRepository\Core\Service\ProjectionService; + /** * An immutable set of Content Repository projections ({@see ProjectionInterface} * * @implements \IteratorAggregate - * @internal + * @internal only used by framework code or services such as {@see ProjectionService} */ final class Projections implements \IteratorAggregate, \Countable { @@ -86,6 +88,13 @@ public function getClassNames(): array return array_keys($this->projections); } + public function resetAll(): void + { + foreach ($this->projections as $projection) { + $projection->reset(); + } + } + /** * @return \Traversable> */ diff --git a/Neos.ContentRepositoryRegistry/Classes/Service/ProjectionReplayService.php b/Neos.ContentRepository.Core/Classes/Service/ProjectionService.php similarity index 73% rename from Neos.ContentRepositoryRegistry/Classes/Service/ProjectionReplayService.php rename to Neos.ContentRepository.Core/Classes/Service/ProjectionService.php index 00a946be01a..2978f7d0597 100644 --- a/Neos.ContentRepositoryRegistry/Classes/Service/ProjectionReplayService.php +++ b/Neos.ContentRepository.Core/Classes/Service/ProjectionService.php @@ -1,9 +1,11 @@ resolveProjectionClassName($projectionAliasOrClassName); - $this->contentRepository->resetProjectionState($projectionClassName); - $this->contentRepository->catchUpProjection($projectionClassName, $options); + $projection = $this->resolveProjection($projectionAliasOrClassName); + $projection->reset(); + $this->contentRepository->catchUpProjection($projection::class, $options); } public function replayAllProjections(CatchUpOptions $options, ?\Closure $progressCallback = null): void @@ -41,16 +40,15 @@ public function replayAllProjections(CatchUpOptions $options, ?\Closure $progres if ($progressCallback) { $progressCallback($classNamesAndAlias['alias']); } - $this->contentRepository->resetProjectionState($classNamesAndAlias['className']); - $this->contentRepository->catchUpProjection($classNamesAndAlias['className'], $options); + $projection = $this->projections->get($classNamesAndAlias['className']); + $projection->reset(); + $this->contentRepository->catchUpProjection($projection::class, $options); } } public function resetAllProjections(): void { - foreach ($this->projectionClassNamesAndAliases() as $classNamesAndAlias) { - $this->contentRepository->resetProjectionState($classNamesAndAlias['className']); - } + $this->projections->resetAll(); } public function highestSequenceNumber(): SequenceNumber @@ -67,15 +65,15 @@ public function numberOfProjections(): int } /** - * @return class-string> + * @return ProjectionInterface */ - private function resolveProjectionClassName(string $projectionAliasOrClassName): string + private function resolveProjection(string $projectionAliasOrClassName): ProjectionInterface { $lowerCaseProjectionName = strtolower($projectionAliasOrClassName); $projectionClassNamesAndAliases = $this->projectionClassNamesAndAliases(); foreach ($projectionClassNamesAndAliases as $classNamesAndAlias) { if (strtolower($classNamesAndAlias['className']) === $lowerCaseProjectionName || strtolower($classNamesAndAlias['alias']) === $lowerCaseProjectionName) { - return $classNamesAndAlias['className']; + return $this->projections->get($classNamesAndAlias['className']); } } throw new \InvalidArgumentException(sprintf( diff --git a/Neos.ContentRepository.Core/Classes/Service/ProjectionServiceFactory.php b/Neos.ContentRepository.Core/Classes/Service/ProjectionServiceFactory.php new file mode 100644 index 00000000000..337bd1df442 --- /dev/null +++ b/Neos.ContentRepository.Core/Classes/Service/ProjectionServiceFactory.php @@ -0,0 +1,24 @@ + + * @api + */ +class ProjectionServiceFactory implements ContentRepositoryServiceFactoryInterface +{ + public function build(ContentRepositoryServiceFactoryDependencies $serviceFactoryDependencies): ProjectionService + { + return new ProjectionService( + $serviceFactoryDependencies->projections, + $serviceFactoryDependencies->contentRepository, + $serviceFactoryDependencies->eventStore, + ); + } +} diff --git a/Neos.ContentRepository.LegacyNodeMigration/Classes/Command/CrCommandController.php b/Neos.ContentRepository.LegacyNodeMigration/Classes/Command/CrCommandController.php index 337a3aa66ce..c433cae6d18 100644 --- a/Neos.ContentRepository.LegacyNodeMigration/Classes/Command/CrCommandController.php +++ b/Neos.ContentRepository.LegacyNodeMigration/Classes/Command/CrCommandController.php @@ -19,12 +19,12 @@ use Doctrine\DBAL\Exception as DBALException; use Doctrine\DBAL\Exception\ConnectionException; use Neos\ContentRepository\Core\Projection\CatchUpOptions; +use Neos\ContentRepository\Core\Service\ProjectionServiceFactory; use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId; use Neos\ContentRepository\LegacyNodeMigration\LegacyMigrationService; use Neos\ContentRepository\LegacyNodeMigration\LegacyMigrationServiceFactory; use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; use Neos\ContentRepositoryRegistry\Factory\EventStore\DoctrineEventStoreFactory; -use Neos\ContentRepositoryRegistry\Service\ProjectionReplayServiceFactory; use Neos\Flow\Cli\CommandController; use Neos\Flow\Persistence\PersistenceManagerInterface; use Neos\Flow\Property\PropertyMapper; @@ -47,7 +47,7 @@ public function __construct( private readonly PropertyMapper $propertyMapper, private readonly ContentRepositoryRegistry $contentRepositoryRegistry, private readonly SiteRepository $siteRepository, - private readonly ProjectionReplayServiceFactory $projectionReplayServiceFactory, + private readonly ProjectionServiceFactory $projectionServiceFactory, ) { parent::__construct(); } @@ -120,7 +120,7 @@ public function migrateLegacyDataCommand(bool $verbose = false, string $config = } $this->connection->executeStatement('TRUNCATE ' . $connection->quoteIdentifier($eventTableName)); // we also need to reset the projections; in order to ensure the system runs deterministically - $projectionService = $this->contentRepositoryRegistry->buildService($contentRepositoryId, $this->projectionReplayServiceFactory); + $projectionService = $this->contentRepositoryRegistry->buildService($contentRepositoryId, $this->projectionServiceFactory); $projectionService->resetAllProjections(); $this->outputLine('Truncated events'); diff --git a/Neos.ContentRepository.TestSuite/Classes/Behavior/Features/Bootstrap/CRTestSuiteTrait.php b/Neos.ContentRepository.TestSuite/Classes/Behavior/Features/Bootstrap/CRTestSuiteTrait.php index 1dbe5f71716..7ddcc465794 100644 --- a/Neos.ContentRepository.TestSuite/Classes/Behavior/Features/Bootstrap/CRTestSuiteTrait.php +++ b/Neos.ContentRepository.TestSuite/Classes/Behavior/Features/Bootstrap/CRTestSuiteTrait.php @@ -27,6 +27,9 @@ use Neos\ContentRepository\Core\Projection\ContentGraph\VisibilityConstraints; use Neos\ContentRepository\Core\Service\ContentStreamPruner; use Neos\ContentRepository\Core\Service\ContentStreamPrunerFactory; +use Neos\ContentRepository\Core\Service\ProjectionService; +use Neos\ContentRepository\Core\Service\ProjectionServiceFactory; +use Neos\ContentRepository\Core\SharedModel\Exception\RootNodeAggregateDoesNotExist; use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateId; use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId; use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamState; @@ -279,8 +282,9 @@ abstract protected function getContentRepositoryService( */ public function iReplayTheProjection(string $projectionName): void { - $this->currentContentRepository->resetProjectionState($projectionName); - $this->currentContentRepository->catchUpProjection($projectionName, CatchUpOptions::create()); + /** @var ProjectionService $projectionService */ + $projectionService = $this->contentRepositoryRegistry->buildService($this->currentContentRepository->id, $this->getObject(ProjectionServiceFactory::class)); + $projectionService->replayProjection($projectionName, CatchUpOptions::create()); } protected function deserializeProperties(array $properties): PropertyValuesToWrite diff --git a/Neos.ContentRepositoryRegistry.TestSuite/Classes/Behavior/CRRegistrySubjectProvider.php b/Neos.ContentRepositoryRegistry.TestSuite/Classes/Behavior/CRRegistrySubjectProvider.php index c026f755119..611319cf0eb 100644 --- a/Neos.ContentRepositoryRegistry.TestSuite/Classes/Behavior/CRRegistrySubjectProvider.php +++ b/Neos.ContentRepositoryRegistry.TestSuite/Classes/Behavior/CRRegistrySubjectProvider.php @@ -17,6 +17,8 @@ use Neos\ContentRepository\Core\ContentRepository; use Neos\ContentRepository\Core\Factory\ContentRepositoryServiceFactoryInterface; use Neos\ContentRepository\Core\Factory\ContentRepositoryServiceInterface; +use Neos\ContentRepository\Core\Service\ProjectionService; +use Neos\ContentRepository\Core\Service\ProjectionServiceFactory; use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; use Neos\ContentRepositoryRegistry\Exception\ContentRepositoryNotFoundException; @@ -66,7 +68,9 @@ public function iInitializeContentRepository(string $contentRepositoryId): void $contentRepository->setUp(); self::$alreadySetUpContentRepositories[] = $contentRepository->id; } - $contentRepository->resetProjectionStates(); + /** @var ProjectionService $projectionService */ + $projectionService = $this->contentRepositoryRegistry->buildService($contentRepository->id, $this->getObject(ProjectionServiceFactory::class)); + $projectionService->resetAllProjections(); } /** diff --git a/Neos.ContentRepositoryRegistry/Classes/Command/CrCommandController.php b/Neos.ContentRepositoryRegistry/Classes/Command/CrCommandController.php index bbbbd040254..af3b60a8521 100644 --- a/Neos.ContentRepositoryRegistry/Classes/Command/CrCommandController.php +++ b/Neos.ContentRepositoryRegistry/Classes/Command/CrCommandController.php @@ -6,10 +6,10 @@ use Neos\ContentRepository\Core\Projection\CatchUpOptions; use Neos\ContentRepository\Core\Projection\ProjectionStatusType; use Neos\ContentRepository\Core\Service\ContentStreamPrunerFactory; +use Neos\ContentRepository\Core\Service\ProjectionServiceFactory; use Neos\ContentRepository\Core\Service\WorkspaceMaintenanceServiceFactory; use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; -use Neos\ContentRepositoryRegistry\Service\ProjectionReplayServiceFactory; use Neos\EventStore\Model\Event\SequenceNumber; use Neos\EventStore\Model\EventStore\StatusType; use Neos\Flow\Cli\CommandController; @@ -22,7 +22,7 @@ final class CrCommandController extends CommandController public function __construct( private readonly ContentRepositoryRegistry $contentRepositoryRegistry, - private readonly ProjectionReplayServiceFactory $projectionServiceFactory, + private readonly ProjectionServiceFactory $projectionServiceFactory, ) { parent::__construct(); } diff --git a/Neos.ContentRepositoryRegistry/Classes/Service/ProjectionReplayServiceFactory.php b/Neos.ContentRepositoryRegistry/Classes/Service/ProjectionReplayServiceFactory.php deleted file mode 100644 index 337297d9bb6..00000000000 --- a/Neos.ContentRepositoryRegistry/Classes/Service/ProjectionReplayServiceFactory.php +++ /dev/null @@ -1,30 +0,0 @@ - - * @internal this is currently only used by the {@see CrCommandController} - */ -#[Flow\Scope("singleton")] -final class ProjectionReplayServiceFactory implements ContentRepositoryServiceFactoryInterface -{ - - public function build(ContentRepositoryServiceFactoryDependencies $serviceFactoryDependencies): ContentRepositoryServiceInterface - { - return new ProjectionReplayService( - $serviceFactoryDependencies->projections, - $serviceFactoryDependencies->contentRepository, - $serviceFactoryDependencies->eventStore, - ); - } -} diff --git a/Neos.Neos/Classes/Command/CrCommandController.php b/Neos.Neos/Classes/Command/CrCommandController.php index e7e70822eb3..cb43bfb4ef8 100644 --- a/Neos.Neos/Classes/Command/CrCommandController.php +++ b/Neos.Neos/Classes/Command/CrCommandController.php @@ -7,6 +7,7 @@ use League\Flysystem\Filesystem; use League\Flysystem\Local\LocalFilesystemAdapter; use Neos\ContentRepository\Core\Projection\CatchUpOptions; +use Neos\ContentRepository\Core\Service\ProjectionServiceFactory; use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId; use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; @@ -15,7 +16,6 @@ use Neos\ContentRepository\Export\ImportService; use Neos\ContentRepository\Export\ImportServiceFactory; use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; -use Neos\ContentRepositoryRegistry\Service\ProjectionReplayServiceFactory; use Neos\Flow\Annotations as Flow; use Neos\Flow\Cli\CommandController; use Neos\Flow\Persistence\PersistenceManagerInterface; @@ -42,7 +42,7 @@ public function __construct( private readonly ResourceManager $resourceManager, private readonly PersistenceManagerInterface $persistenceManager, private readonly ContentRepositoryRegistry $contentRepositoryRegistry, - private readonly ProjectionReplayServiceFactory $projectionReplayServiceFactory, + private readonly ProjectionServiceFactory $projectionServiceFactory, private readonly AssetUsageService $assetUsageService, private readonly WorkspaceService $workspaceService, ) { @@ -116,7 +116,7 @@ public function importCommand(string $path, string $contentRepository = 'default $this->outputLine('Replaying projections'); - $projectionService = $this->contentRepositoryRegistry->buildService($contentRepositoryId, $this->projectionReplayServiceFactory); + $projectionService = $this->contentRepositoryRegistry->buildService($contentRepositoryId, $this->projectionServiceFactory); $projectionService->replayAllProjections(CatchUpOptions::create()); $this->outputLine('Assigning live workspace role'); diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon index ebbd2ba29a9..f8396255b0a 100644 --- a/phpstan-baseline.neon +++ b/phpstan-baseline.neon @@ -1,9 +1,5 @@ parameters: ignoreErrors: - - - message: "#^The internal method \"Neos\\\\ContentRepository\\\\Core\\\\Projection\\\\Projections\\:\\:getClassNames\" is called\\.$#" - count: 1 - path: Neos.ContentRepositoryRegistry/Classes/Service/ProjectionReplayService.php - message: "#^Method Neos\\\\Neos\\\\Controller\\\\Backend\\\\MenuHelper\\:\\:buildModuleList\\(\\) return type has no value type specified in iterable type array\\.$#"