Merge pull request #5332 from mhsdesign/feature/workspace-has-changes…

…-flag

FEATURE: Introduce `Workspace::hasPublishableChanges`

Neos.ContentGraph.DoctrineDbalAdapter/src/ContentGraphReadModelAdapter.php

@@ -159,7 +159,7 @@ private function getBasicWorkspaceQuery(): QueryBuilder
         $queryBuilder = $this->dbal->createQueryBuilder();
 
         return $queryBuilder
-            ->select('ws.name, ws.baseWorkspaceName, ws.currentContentStreamId, cs.sourceContentStreamVersion = scs.version as upToDateWithBase')
+            ->select('ws.name, ws.baseWorkspaceName, ws.currentContentStreamId, cs.hasChanges, cs.sourceContentStreamVersion = scs.version as upToDateWithBase')
             ->from($this->tableNames->workspace(), 'ws')
             ->join('ws', $this->tableNames->contentStream(), 'cs', 'cs.id = ws.currentcontentstreamid')
             ->leftJoin('cs', $this->tableNames->contentStream(), 'scs', 'scs.id = cs.sourceContentStreamId');
@@ -188,11 +188,14 @@ private static function workspaceFromDatabaseRow(array $row): Workspace
             $baseWorkspaceName,
             ContentStreamId::fromString($row['currentContentStreamId']),
             $status,
+            $baseWorkspaceName === null
+                ? false
+                : (bool)$row['hasChanges'],
         );
     }
 
     /**
-     * @param array<string, mixed> $row todo fetch source content stream version and use for publishing as expected version
+     * @param array<string, mixed> $row
      */
     private static function contentStreamFromDatabaseRow(array $row): ContentStream
     {

Neos.ContentGraph.DoctrineDbalAdapter/src/DoctrineDbalContentGraphProjection.php

@@ -25,6 +25,7 @@
 use Neos\ContentRepository\Core\EventStore\InitiatingEventMetadata;
 use Neos\ContentRepository\Core\Feature\Common\EmbedsContentStreamId;
 use Neos\ContentRepository\Core\Feature\Common\InterdimensionalSiblings;
+use Neos\ContentRepository\Core\Feature\Common\PublishableToWorkspaceInterface;
 use Neos\ContentRepository\Core\Feature\ContentStreamClosing\Event\ContentStreamWasClosed;
 use Neos\ContentRepository\Core\Feature\ContentStreamClosing\Event\ContentStreamWasReopened;
 use Neos\ContentRepository\Core\Feature\ContentStreamCreation\Event\ContentStreamWasCreated;
@@ -239,8 +240,16 @@ public function apply(EventInterface $event, EventEnvelope $eventEnvelope): void
             WorkspaceWasRemoved::class => $this->whenWorkspaceWasRemoved($event),
             default => $event instanceof EmbedsContentStreamId || throw new \InvalidArgumentException(sprintf('Unsupported event %s', get_debug_type($event))),
         };
-        if ($event instanceof EmbedsContentStreamId && ContentStreamEventStreamName::isContentStreamStreamName($eventEnvelope->streamName)) {
-            $this->updateContentStreamVersion($event->getContentStreamId(), $eventEnvelope->version);
+        if (
+            $event instanceof EmbedsContentStreamId
+            && ContentStreamEventStreamName::isContentStreamStreamName($eventEnvelope->streamName)
+            && !(
+                // special case as we dont need to update anything. The handling above takes care of setting the version to 0
+                $event instanceof ContentStreamWasForked
+                || $event instanceof ContentStreamWasCreated
+            )
+        ) {
+            $this->updateContentStreamVersion($event->getContentStreamId(), $eventEnvelope->version, $event instanceof PublishableToWorkspaceInterface);
         }
     }
 

Neos.ContentGraph.DoctrineDbalAdapter/src/DoctrineDbalContentGraphSchemaBuilder.php

@@ -129,7 +129,8 @@ private function createContentStreamTable(): Table
             (new Column('version', Type::getType(Types::INTEGER)))->setNotnull(true),
             DbalSchemaFactory::columnForContentStreamId('sourceContentStreamId')->setNotnull(false),
             (new Column('sourceContentStreamVersion', Type::getType(Types::INTEGER)))->setNotnull(false),
-            (new Column('closed', Type::getType(Types::BOOLEAN)))->setDefault(false)->setNotnull(true),
+            (new Column('closed', Type::getType(Types::BOOLEAN)))->setNotnull(true),
+            (new Column('hasChanges', Type::getType(Types::BOOLEAN)))->setNotnull(true),
         ]);
 
         return $contentStreamTable->setPrimaryKey(['id']);

Neos.ContentGraph.DoctrineDbalAdapter/src/Domain/Projection/Feature/ContentStream.php

@@ -20,7 +20,9 @@ private function createContentStream(ContentStreamId $contentStreamId, ?ContentS
             'id' => $contentStreamId->value,
             'version' => 0,
             'sourceContentStreamId' => $sourceContentStreamId?->value,
-            'sourceContentStreamVersion' => $sourceVersion?->value
+            'sourceContentStreamVersion' => $sourceVersion?->value,
+            'closed' => 0,
+            'hasChanges' => 0
         ]);
     }
 
@@ -49,11 +51,15 @@ private function removeContentStream(ContentStreamId $contentStreamId): void
         ]);
     }
 
-    private function updateContentStreamVersion(ContentStreamId $contentStreamId, Version $version): void
+    private function updateContentStreamVersion(ContentStreamId $contentStreamId, Version $version, bool $markAsDirty): void
     {
-        $this->dbal->update($this->tableNames->contentStream(), [
+        $updatePayload = [
             'version' => $version->value,
-        ], [
+        ];
+        if ($markAsDirty) {
+            $updatePayload['hasChanges'] = 1;
+        }
+        $this->dbal->update($this->tableNames->contentStream(), $updatePayload, [
             'id' => $contentStreamId->value,
         ]);
     }

Neos.ContentRepository.BehavioralTests/Tests/Behavior/Features/W7-WorkspacePublication/02-PublishWorkspace.feature

@@ -177,10 +177,7 @@ Feature: Workspace based content publishing
 
     # the user and live workspace are unchanged
     Then I expect exactly 1 event to be published on stream "Workspace:user-test"
-    Then I expect exactly 3 event to be published on stream "ContentStream:user-cs-identifier"
-    And event at index 2 is of type "ContentStreamWasReopened" with payload:
-      | Key                  | Expected                 |
-      | contentStreamId      | "user-cs-identifier"     |
+    Then I expect exactly 1 event to be published on stream "ContentStream:user-cs-identifier"
 
     Then I expect node aggregate identifier "nody-mc-nodeface" to lead to node user-cs-identifier;nody-mc-nodeface;{}
 

Neos.ContentRepository.Core/Classes/Feature/Common/PublishableToWorkspaceInterface.php

@@ -14,6 +14,7 @@
 
 namespace Neos\ContentRepository\Core\Feature\Common;
 
+use Neos\ContentRepository\Core\EventStore\EventInterface;
 use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId;
 use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName;
 
@@ -26,7 +27,7 @@
  *
  * @internal used internally for the publishing mechanism of workspaces
  */
-interface PublishableToWorkspaceInterface
+interface PublishableToWorkspaceInterface extends EventInterface
 {
     public function withWorkspaceNameAndContentStreamId(WorkspaceName $targetWorkspaceName, ContentStreamId $contentStreamId): self;
 }

Neos.ContentRepository.Core/Classes/Feature/ContentStreamForking/Event/ContentStreamWasForked.php

@@ -15,13 +15,14 @@
  */
 
 use Neos\ContentRepository\Core\EventStore\EventInterface;
+use Neos\ContentRepository\Core\Feature\Common\EmbedsContentStreamId;
 use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId;
 use Neos\EventStore\Model\Event\Version;
 
 /**
  * @api events are the persistence-API of the content repository
  */
-final readonly class ContentStreamWasForked implements EventInterface
+final readonly class ContentStreamWasForked implements EventInterface, EmbedsContentStreamId
 {
     public function __construct(
         /**
@@ -33,6 +34,11 @@ public function __construct(
     ) {
     }
 
+    public function getContentStreamId(): ContentStreamId
+    {
+        return $this->newContentStreamId;
+    }
+
     public static function fromArray(array $values): self
     {
         return new self(

Neos.ContentRepository.Core/Classes/Feature/WorkspaceCommandHandler.php

@@ -179,6 +179,11 @@ private function handlePublishWorkspace(
     ): \Generator {
         $workspace = $this->requireWorkspace($command->workspaceName, $commandHandlingDependencies);
         $baseWorkspace = $this->requireBaseWorkspace($workspace, $commandHandlingDependencies);
+        if (!$workspace->hasPublishableChanges()) {
+            // no-op
+            return;
+        }
+
         if (!$commandHandlingDependencies->contentStreamExists($workspace->currentContentStreamId)) {
             throw new \RuntimeException('Cannot publish nodes on a workspace with a stateless content stream', 1729711258);
         }
@@ -197,15 +202,6 @@ private function handlePublishWorkspace(
             )
         );
 
-        if ($rebaseableCommands->isEmpty()) {
-            // we have no changes, we just reopen; partial no-op
-            yield $this->reopenContentStream(
-                $workspace->currentContentStreamId,
-                $commandHandlingDependencies
-            );
-            return;
-        }
-
         try {
             yield from $this->publishWorkspace(
                 $workspace,
@@ -319,7 +315,6 @@ private function getCopiedEventsOfEventStream(
             $event = $this->eventNormalizer->denormalize($eventEnvelope->event);
 
             if ($event instanceof PublishableToWorkspaceInterface) {
-                /** @var EventInterface $copiedEvent */
                 $copiedEvent = $event->withWorkspaceNameAndContentStreamId($targetWorkspaceName, $targetContentStreamId);
                 // We need to add the event metadata here for rebasing in nested workspace situations
                 // (and for exporting)
@@ -358,14 +353,7 @@ private function handleRebaseWorkspace(
             $commandHandlingDependencies
         );
 
-        $rebaseableCommands = RebaseableCommands::extractFromEventStream(
-            $this->eventStore->load(
-                ContentStreamEventStreamName::fromContentStreamId($workspace->currentContentStreamId)
-                    ->getEventStreamName()
-            )
-        );
-
-        if ($rebaseableCommands->isEmpty()) {
+        if (!$workspace->hasPublishableChanges()) {
             // if we have no changes in the workspace we can fork from the base directly
             yield from $this->rebaseWorkspaceWithoutChanges(
                 $workspace,
@@ -376,6 +364,13 @@ private function handleRebaseWorkspace(
             return;
         }
 
+        $rebaseableCommands = RebaseableCommands::extractFromEventStream(
+            $this->eventStore->load(
+                ContentStreamEventStreamName::fromContentStreamId($workspace->currentContentStreamId)
+                    ->getEventStreamName()
+            )
+        );
+
         $commandSimulator = $this->commandSimulatorFactory->createSimulatorForWorkspace($baseWorkspace->workspaceName);
 
         $commandSimulator->run(
@@ -438,16 +433,17 @@ private function handlePublishIndividualNodesFromWorkspace(
         PublishIndividualNodesFromWorkspace $command,
         CommandHandlingDependencies $commandHandlingDependencies,
     ): \Generator {
-        if ($command->nodesToPublish->isEmpty()) {
+        $workspace = $this->requireWorkspace($command->workspaceName, $commandHandlingDependencies);
+        $baseWorkspace = $this->requireBaseWorkspace($workspace, $commandHandlingDependencies);
+        if ($command->nodesToPublish->isEmpty() || !$workspace->hasPublishableChanges()) {
             // noop
             return;
         }
 
-        $workspace = $this->requireWorkspace($command->workspaceName, $commandHandlingDependencies);
+        // todo check that fetching workspace throws if there is no content stream id for it
         if (!$commandHandlingDependencies->contentStreamExists($workspace->currentContentStreamId)) {
             throw new \RuntimeException('Cannot publish nodes on a workspace with a stateless content stream', 1710410114);
         }
-        $baseWorkspace = $this->requireBaseWorkspace($workspace, $commandHandlingDependencies);
         $this->requireContentStreamToNotBeClosed($baseWorkspace->currentContentStreamId, $commandHandlingDependencies);
         $baseContentStreamVersion = $commandHandlingDependencies->getContentStreamVersion($baseWorkspace->currentContentStreamId);
 
@@ -572,16 +568,17 @@ private function handleDiscardIndividualNodesFromWorkspace(
         DiscardIndividualNodesFromWorkspace $command,
         CommandHandlingDependencies $commandHandlingDependencies,
     ): \Generator {
-        if ($command->nodesToDiscard->isEmpty()) {
+        $workspace = $this->requireWorkspace($command->workspaceName, $commandHandlingDependencies);
+        $baseWorkspace = $this->requireBaseWorkspace($workspace, $commandHandlingDependencies);
+
+        if ($command->nodesToDiscard->isEmpty() || !$workspace->hasPublishableChanges()) {
             // noop
             return;
         }
 
-        $workspace = $this->requireWorkspace($command->workspaceName, $commandHandlingDependencies);
         if (!$commandHandlingDependencies->contentStreamExists($workspace->currentContentStreamId)) {
             throw new \RuntimeException('Cannot discard nodes on a workspace with a stateless content stream', 1710408112);
         }
-        $baseWorkspace = $this->requireBaseWorkspace($workspace, $commandHandlingDependencies);
 
         yield $this->closeContentStream(
             $workspace->currentContentStreamId,
@@ -673,7 +670,7 @@ private function handleDiscardWorkspace(
         $workspace = $this->requireWorkspace($command->workspaceName, $commandHandlingDependencies);
         $baseWorkspace = $this->requireBaseWorkspace($workspace, $commandHandlingDependencies);
 
-        if (!$this->hasEventsInContentStreamExceptForking(ContentStreamEventStreamName::fromContentStreamId($workspace->currentContentStreamId))) {
+        if (!$workspace->hasPublishableChanges()) {
             return;
         }
 
@@ -885,33 +882,8 @@ private function requireNonCircularRelationBetweenWorkspaces(Workspace $workspac
      */
     private function requireEmptyWorkspace(Workspace $workspace): void
     {
-        $workspaceContentStreamName = ContentStreamEventStreamName::fromContentStreamId(
-            $workspace->currentContentStreamId
-        );
-        if ($this->hasEventsInContentStreamExceptForking($workspaceContentStreamName)) {
+        if ($workspace->hasPublishableChanges()) {
             throw new WorkspaceIsNotEmptyException('The user workspace needs to be empty before switching the base workspace.', 1681455989);
         }
     }
-
-    /**
-     * @return bool
-     */
-    private function hasEventsInContentStreamExceptForking(
-        ContentStreamEventStreamName $workspaceContentStreamName,
-    ): bool {
-        // todo introduce workspace has changes instead
-        $workspaceContentStream = $this->eventStore->load($workspaceContentStreamName->getEventStreamName());
-
-        $fullQualifiedEventClassName = ContentStreamWasForked::class;
-        $shortEventClassName = substr($fullQualifiedEventClassName, strrpos($fullQualifiedEventClassName, '\\') + 1);
-
-        foreach ($workspaceContentStream as $eventEnvelope) {
-            if ($eventEnvelope->event->type->value === EventType::fromString($shortEventClassName)->value) {
-                continue;
-            }
-            return true;
-        }
-
-        return false;
-    }
 }

Neos.ContentRepository.Core/Classes/SharedModel/Workspace/Workspace.php

@@ -32,7 +32,11 @@ private function __construct(
         public ?WorkspaceName $baseWorkspaceName,
         public ContentStreamId $currentContentStreamId,
         public WorkspaceStatus $status,
+        private bool $hasPublishableChanges
     ) {
+        if ($this->isRootWorkspace() && $this->hasPublishableChanges) {
+            throw new \InvalidArgumentException('Root workspaces cannot have changes', 1730371566);
+        }
     }
 
     /**
@@ -43,8 +47,17 @@ public static function create(
         ?WorkspaceName $baseWorkspaceName,
         ContentStreamId $currentContentStreamId,
         WorkspaceStatus $status,
+        bool $hasPublishableChanges
     ): self {
-        return new self($workspaceName, $baseWorkspaceName, $currentContentStreamId, $status);
+        return new self($workspaceName, $baseWorkspaceName, $currentContentStreamId, $status, $hasPublishableChanges);
+    }
+
+    /**
+     * Indicates if the workspace contains changed to be published
+     */
+    public function hasPublishableChanges(): bool
+    {
+        return $this->hasPublishableChanges;
     }
 
     /**

Neos.ContentRepository.NodeMigration/src/NodeMigrationService.php

@@ -16,7 +16,6 @@
 use Neos\ContentRepository\NodeMigration\Filter\FiltersFactory;
 use Neos\ContentRepository\NodeMigration\Filter\InvalidMigrationFilterSpecified;
 use Neos\ContentRepository\NodeMigration\Transformation\TransformationsFactory;
-use Neos\Neos\PendingChangesProjection\ChangeFinder;
 
 /**
  * Node Migrations are manually written adjustments to the Node tree;
@@ -68,7 +67,7 @@ public function executeMigration(ExecuteMigration $command): void
 
         $targetWorkspaceWasCreated = false;
         if ($targetWorkspace = $this->contentRepository->findWorkspaceByName($command->targetWorkspaceName)) {
-            if (!$this->workspaceIsEmpty($targetWorkspace)) {
+            if ($targetWorkspace->hasPublishableChanges()) {
                 throw new MigrationException(sprintf('Target workspace "%s" already exists an is not empty. Please clear the workspace before.', $targetWorkspace->workspaceName->value));
             }
 
@@ -196,12 +195,4 @@ protected function executeSubMigration(
             }
         }
     }
-
-    private function workspaceIsEmpty(Workspace $workspace): bool
-    {
-        // todo introduce Workspace::hasPendingChanges
-        return $this->contentRepository
-                ->projectionState(ChangeFinder::class)
-                ->countByContentStreamId($workspace->currentContentStreamId) === 0;
-    }
 }

Neos.Neos/Classes/Command/WorkspaceCommandController.php

@@ -396,22 +396,15 @@ public function deleteCommand(string $workspace, bool $force = false, string $co
             $this->quit(3);
         }
 
-
-        try {
-            $nodesCount = $this->workspacePublishingService->countPendingWorkspaceChanges($contentRepositoryId, $workspaceName);
-        } catch (\Exception $exception) {
-            $this->outputLine('Could not fetch unpublished nodes for workspace %s, nothing was deleted. %s', [$workspaceName->value, $exception->getMessage()]);
-            $this->quit(4);
-        }
-
-        if ($nodesCount > 0) {
+        if ($crWorkspace->hasPublishableChanges()) {
             if ($force === false) {
+                $nodesCount = $this->workspacePublishingService->countPendingWorkspaceChanges($contentRepositoryId, $workspaceName);
                 $this->outputLine(
                     'Did not delete workspace "%s" because it contains %s unpublished node(s).'
-                        . ' Use --force to delete it nevertheless.',
+                    . ' Use --force to delete it nevertheless.',
                     [$workspaceName->value, $nodesCount]
                 );
-                $this->quit(5);
+                $this->quit(4);
             }
             $this->workspacePublishingService->discardAllWorkspaceChanges($contentRepositoryId, $workspaceName);
         }