!!! FEATURE: Extract workspace metadata and user-assignment to Neos

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

@@ -24,31 +24,72 @@
  *
  * @api
  */
-class Workspace
+final readonly class Workspace
 {
     /**
      * This prefix determines if a given workspace (name) is a user workspace.
      */
     public const PERSONAL_WORKSPACE_PREFIX = 'user-';
 
+    /**
+     * @var WorkspaceName Workspace identifier, unique within one Content Repository instance
+     */
+    public WorkspaceName $workspaceName;
+
+    /**
+     * @var WorkspaceName|null Workspace identifier of the base workspace (i.e. the target when publishing changes) – if null this instance is considered a root (aka public) workspace
+     */
+    public ?WorkspaceName $baseWorkspaceName;
+
+    /**
+     * @deprecated with 9.0.0-beta12 metadata should be assigned to workspaces outside the Content Repository core
+     */
+    public WorkspaceTitle $workspaceTitle;
+
+    /**
+     * @deprecated with 9.0.0-beta12metadata should be assigned to workspaces outside the Content Repository core
+     */
+    public WorkspaceDescription $workspaceDescription;
+
+    /**
+     * The Content Stream this workspace currently points to – usually it is set to a new, empty content stream after publishing/rebasing the workspace
+     */
+    public ContentStreamId $currentContentStreamId;
+
+    /**
+     * The current status of this workspace
+     */
+    public WorkspaceStatus $status;
+
+    /**
+     * @deprecated with 9.0.0-beta12 owners/collaborators should be assigned to workspaces outside the Content Repository core
+     */
+    public string|null $workspaceOwner;
+
     /**
      * @internal
      */
     public function __construct(
-        public readonly WorkspaceName $workspaceName,
-        public readonly ?WorkspaceName $baseWorkspaceName,
-        public readonly WorkspaceTitle $workspaceTitle,
-        public readonly WorkspaceDescription $workspaceDescription,
-        public readonly ContentStreamId $currentContentStreamId,
-        public readonly WorkspaceStatus $status,
-        public readonly ?string $workspaceOwner
+        WorkspaceName $workspaceName,
+        ?WorkspaceName $baseWorkspaceName,
+        WorkspaceTitle $workspaceTitle,
+        WorkspaceDescription $workspaceDescription,
+        ContentStreamId $currentContentStreamId,
+        WorkspaceStatus $status,
+        ?string $workspaceOwner
     ) {
+        $this->workspaceName = $workspaceName;
+        $this->baseWorkspaceName = $baseWorkspaceName;
+        $this->workspaceTitle = $workspaceTitle;
+        $this->workspaceDescription = $workspaceDescription;
+        $this->currentContentStreamId = $currentContentStreamId;
+        $this->status = $status;
+        $this->workspaceOwner = $workspaceOwner;
     }
 
-
     /**
      * Checks if this workspace is a user's personal workspace
-     * @api
+     * @deprecated with 9.0.0-beta12 owners/collaborators should be assigned to workspaces outside the Content Repository core
      */
     public function isPersonalWorkspace(): bool
     {
@@ -59,7 +100,7 @@ public function isPersonalWorkspace(): bool
      * Checks if this workspace is shared only across users with access to internal workspaces, for example "reviewers"
      *
      * @return bool
-     * @api
+     * @deprecated with 9.0.0-beta12 owners/collaborators should be assigned to workspaces outside the Content Repository core
      */
     public function isPrivateWorkspace(): bool
     {
@@ -70,6 +111,7 @@ public function isPrivateWorkspace(): bool
      * Checks if this workspace is shared across all editors
      *
      * @return boolean
+     * @deprecated with 9.0.0-beta12 owners/collaborators should be assigned to workspaces outside the Content Repository core
      */
     public function isInternalWorkspace(): bool
     {

Neos.Neos/Classes/Command/WorkspaceCommandController.php

@@ -22,11 +22,9 @@
 use Neos\ContentRepository\Core\Feature\WorkspaceRebase\Dto\RebaseErrorHandlingStrategy;
 use Neos\ContentRepository\Core\Feature\WorkspaceRebase\Exception\WorkspaceRebaseFailed;
 use Neos\ContentRepository\Core\Projection\Workspace\Workspace;
-use Neos\ContentRepository\Core\Projection\Workspace\WorkspaceStatus;
 use Neos\ContentRepository\Core\Service\WorkspaceMaintenanceServiceFactory;
 use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId;
 use Neos\ContentRepository\Core\SharedModel\Exception\WorkspaceDoesNotExist;
-use Neos\ContentRepository\Core\SharedModel\User\UserId;
 use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId;
 use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceDescription;
 use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName;
@@ -36,9 +34,11 @@
 use Neos\Flow\Cli\CommandController;
 use Neos\Flow\Cli\Exception\StopCommandException;
 use Neos\Flow\Persistence\PersistenceManagerInterface;
+use Neos\Neos\Domain\Model\UserId;
+use Neos\Neos\Domain\Model\WorkspaceClassification;
 use Neos\Neos\Domain\Service\UserService;
-use Neos\Neos\Domain\Workspace\WorkspaceProvider;
-use Neos\Neos\PendingChangesProjection\ChangeFinder;
+use Neos\Neos\Domain\Service\WorkspacePublishingService;
+use Neos\Neos\Domain\Service\WorkspaceService;
 
 /**
  * The Workspace Command Controller
@@ -56,7 +56,10 @@ class WorkspaceCommandController extends CommandController
     protected ContentRepositoryRegistry $contentRepositoryRegistry;
 
     #[Flow\Inject]
-    protected WorkspaceProvider $workspaceProvider;
+    protected WorkspacePublishingService $workspacePublishingService;
+
+    #[Flow\Inject]
+    protected WorkspaceService $workspaceService;
 
     /**
      * Publish changes of a workspace
@@ -68,16 +71,14 @@ class WorkspaceCommandController extends CommandController
      */
     public function publishCommand(string $workspace, string $contentRepository = 'default'): void
     {
-        // @todo: bypass access control
-        $workspace = $this->workspaceProvider->provideForWorkspaceName(
+        $this->workspacePublishingService->publishWorkspace(
             ContentRepositoryId::fromString($contentRepository),
             WorkspaceName::fromString($workspace)
         );
-        $workspace->publishAllChanges();
 
         $this->outputLine(
             'Published all nodes in workspace %s to its base workspace',
-            [$workspace->name->value]
+            [$workspace]
         );
     }
 
@@ -92,19 +93,17 @@ public function publishCommand(string $workspace, string $contentRepository = 'd
      */
     public function discardCommand(string $workspace, string $contentRepository = 'default'): void
     {
-        // @todo: bypass access control
-        $workspace = $this->workspaceProvider->provideForWorkspaceName(
-            ContentRepositoryId::fromString($contentRepository),
-            WorkspaceName::fromString($workspace)
-        );
-
         try {
-            $workspace->discardAllChanges();
+            // @todo: bypass access control
+            $this->workspacePublishingService->discardAllWorkspaceChanges(
+                ContentRepositoryId::fromString($contentRepository),
+                WorkspaceName::fromString($workspace)
+            );
         } catch (WorkspaceDoesNotExist $exception) {
-            $this->outputLine('Workspace "%s" does not exist', [$workspace->name->value]);
+            $this->outputLine('Workspace "%s" does not exist', [$workspace]);
             $this->quit(1);
         }
-        $this->outputLine('Discarded all nodes in workspace %s', [$workspace->name->value]);
+        $this->outputLine('Discarded all nodes in workspace %s', [$workspace]);
     }
 
     /**
@@ -121,11 +120,11 @@ public function rebaseCommand(string $workspace, string $contentRepository = 'de
     {
         try {
             // @todo: bypass access control
-            $workspace = $this->workspaceProvider->provideForWorkspaceName(
+            $this->workspacePublishingService->rebaseWorkspace(
                 ContentRepositoryId::fromString($contentRepository),
-                WorkspaceName::fromString($workspace)
+                WorkspaceName::fromString($workspace),
+                $force ? RebaseErrorHandlingStrategy::STRATEGY_FORCE : RebaseErrorHandlingStrategy::STRATEGY_FAIL,
             );
-            $workspace->rebase($force ? RebaseErrorHandlingStrategy::STRATEGY_FORCE : RebaseErrorHandlingStrategy::STRATEGY_FAIL);
         } catch (WorkspaceDoesNotExist $exception) {
             $this->outputLine('Workspace "%s" does not exist', [$workspace]);
             $this->quit(1);
@@ -134,7 +133,7 @@ public function rebaseCommand(string $workspace, string $contentRepository = 'de
             $this->quit(1);
         }
 
-        $this->outputLine('Rebased workspace %s', [$workspace->name->value]);
+        $this->outputLine('Rebased workspace %s', [$workspace]);
     }
 
     /**
@@ -178,13 +177,23 @@ public function createCommand(
         string $contentRepository = 'default'
     ): void {
         $contentRepositoryId = ContentRepositoryId::fromString($contentRepository);
+
+        $this->workspaceService->createWorkspace(
+            $contentRepositoryId,
+            \Neos\Neos\Domain\Model\WorkspaceTitle::fromString($title ?? $workspace),
+            \Neos\Neos\Domain\Model\WorkspaceDescription::fromString($description ?? ''),
+            WorkspaceName::fromString($baseWorkspace),
+            \Neos\Neos\Domain\Model\UserId::fromString($owner),
+            WorkspaceClassification::PERSONAL,
+        );
+
         $contentRepositoryInstance = $this->contentRepositoryRegistry->get($contentRepositoryId);
 
         if ($owner === '') {
             $workspaceOwnerUserId = null;
         } else {
             $workspaceOwnerUserId = UserId::fromString($owner);
-            $workspaceOwner = $this->userService->findByUserIdentifier($workspaceOwnerUserId);
+            $workspaceOwner = $this->userService->findUserById($workspaceOwnerUserId);
             if ($workspaceOwner === null) {
                 $this->outputLine('The user "%s" specified as owner does not exist', [$owner]);
                 $this->quit(3);
@@ -198,7 +207,7 @@ public function createCommand(
                 WorkspaceTitle::fromString($title ?: $workspace),
                 WorkspaceDescription::fromString($description ?: $workspace),
                 ContentStreamId::create(),
-                $workspaceOwnerUserId
+                $workspaceOwnerUserId !== null ? \Neos\ContentRepository\Core\SharedModel\User\UserId::fromString($workspaceOwnerUserId->value) : null,
             ));
         } catch (WorkspaceAlreadyExists $workspaceAlreadyExists) {
             $this->outputLine('Workspace "%s" already exists', [$workspace]);
@@ -208,7 +217,7 @@ public function createCommand(
             $this->quit(2);
         }
 
-        if ($workspaceOwnerUserId instanceof UserId) {
+        if ($workspaceOwnerUserId !== null) {
             $this->outputLine(
                 'Created a new workspace "%s", based on workspace "%s", owned by "%s".',
                 [$workspace, $baseWorkspace, $owner]
@@ -243,13 +252,14 @@ public function deleteCommand(string $workspace, bool $force = false, string $co
             $this->quit(2);
         }
 
-        $workspace = $contentRepositoryInstance->getWorkspaceFinder()->findOneByName($workspaceName);
-        if (!$workspace instanceof Workspace) {
+        $crWorkspace = $contentRepositoryInstance->getWorkspaceFinder()->findOneByName($workspaceName);
+        if ($crWorkspace === null) {
             $this->outputLine('Workspace "%s" does not exist', [$workspaceName->value]);
             $this->quit(1);
         }
+        $workspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $workspaceName);
 
-        if ($workspace->isPersonalWorkspace()) {
+        if ($workspaceMetadata->classification === WorkspaceClassification::PERSONAL) {
             $this->outputLine(
                 'Did not delete workspace "%s" because it is a personal workspace.'
                     . ' Personal workspaces cannot be deleted manually.',
@@ -264,28 +274,28 @@ public function deleteCommand(string $workspace, bool $force = false, string $co
                 'Workspace "%s" cannot be deleted because the following workspaces are based on it:',
                 [$workspaceName->value]
             );
+
             $this->outputLine();
             $tableRows = [];
             $headerRow = ['Name', 'Title', 'Description'];
 
             foreach ($dependentWorkspaces as $dependentWorkspace) {
+                $dependentWorkspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $dependentWorkspace->workspaceName);
                 $tableRows[] = [
                     $dependentWorkspace->workspaceName->value,
-                    $dependentWorkspace->workspaceTitle->value,
-                    $dependentWorkspace->workspaceDescription->value
+                    $dependentWorkspaceMetadata->title->value,
+                    $dependentWorkspaceMetadata->description->value
                 ];
             }
             $this->output->outputTable($tableRows, $headerRow);
             $this->quit(3);
         }
 
+
         try {
-            $nodesCount = $contentRepositoryInstance->projectionState(ChangeFinder::class)
-                ->countByContentStreamId(
-                    $workspace->currentContentStreamId
-                );
+            $nodesCount = $this->workspacePublishingService->countPendingWorkspaceChanges($contentRepositoryId, $workspaceName);
         } catch (\Exception $exception) {
-            $this->outputLine('Could not fetch unpublished nodes for workspace %s, nothing was deleted. %s', [$workspace->workspaceName->value, $exception->getMessage()]);
+            $this->outputLine('Could not fetch unpublished nodes for workspace %s, nothing was deleted. %s', [$workspaceName->value, $exception->getMessage()]);
             $this->quit(4);
         }
 
@@ -299,11 +309,7 @@ public function deleteCommand(string $workspace, bool $force = false, string $co
                 $this->quit(5);
             }
             // @todo bypass access control?
-            $workspace = $this->workspaceProvider->provideForWorkspaceName(
-                $contentRepositoryId,
-                $workspaceName
-            );
-            $workspace->discardAllChanges();
+            $this->workspacePublishingService->discardAllWorkspaceChanges($contentRepositoryId, $workspaceName);
         }
 
         $contentRepositoryInstance->handle(
@@ -359,20 +365,52 @@ public function listCommand(string $contentRepository = 'default'): void
         }
 
         $tableRows = [];
-        $headerRow = ['Name', 'Base Workspace', 'Title', 'Owner', 'Description', 'Status', 'Content Stream'];
+        $headerRow = ['Name', 'Classification', 'Base Workspace', 'Title', 'Description', 'Status', 'Content Stream'];
 
         foreach ($workspaces as $workspace) {
+            $workspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $workspace->workspaceName);
+
             /* @var Workspace $workspace */
             $tableRows[] = [
                 $workspace->workspaceName->value,
-                $workspace->baseWorkspaceName?->value ?: '',
-                $workspace->workspaceTitle->value,
-                $workspace->workspaceOwner ?: '',
-                $workspace->workspaceDescription->value,
+                $workspaceMetadata->classification->value,
+                $workspace->baseWorkspaceName?->value ?: '-',
+                $workspaceMetadata->title->value,
+                $workspaceMetadata->description->value,
                 $workspace->status->value,
                 $workspace->currentContentStreamId->value,
             ];
         }
         $this->output->outputTable($tableRows, $headerRow);
     }
+
+    /**
+     * Display details for the specified workspace
+     *
+     * @param string $workspace Name of the workspace to show
+     * @param string $contentRepository The name of the content repository. (Default: 'default')
+     * @throws StopCommandException
+     */
+    public function showCommand(string $workspace, string $contentRepository = 'default'): void
+    {
+        $contentRepositoryId = ContentRepositoryId::fromString($contentRepository);
+        $contentRepositoryInstance = $this->contentRepositoryRegistry->get($contentRepositoryId);
+
+        $workspaceName = WorkspaceName::fromString($workspace);
+        $workspacesInstance = $contentRepositoryInstance->getWorkspaceFinder()->findOneByName($workspaceName);
+
+        if ($workspacesInstance === null) {
+            $this->outputLine('Workspace "%s" not found.', [$workspaceName->value]);
+            $this->quit();
+        }
+        $workspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $workspaceName);
+
+        $this->outputFormatted('Name: <b>%s</b>', [$workspacesInstance->workspaceName->value]);
+        $this->outputFormatted('Classification: <b>%s</b>', [$workspaceMetadata->classification->value]);
+        $this->outputFormatted('Base Workspace: <b>%s</b>', [$workspacesInstance->baseWorkspaceName?->value ?: '-']);
+        $this->outputFormatted('Title: <b>%s</b>', [$workspaceMetadata->title->value]);
+        $this->outputFormatted('Description: <b>%s</b>', [$workspaceMetadata->description->value]);
+        $this->outputFormatted('Status: <b>%s</b>', [$workspacesInstance->status->value]);
+        $this->outputFormatted('Content Stream: <b>%s</b>', [$workspacesInstance->currentContentStreamId->value]);
+    }
 }

Neos.Neos/Classes/Domain/Workspace/DiscardingResult.php → Neos.Neos/Classes/Domain/Model/DiscardingResult.php

@@ -12,7 +12,7 @@
 
 declare(strict_types=1);
 
-namespace Neos\Neos\Domain\Workspace;
+namespace Neos\Neos\Domain\Model;
 
 use Neos\Flow\Annotations as Flow;