Draft: FEATURE: Extract workspace metadata and user-assignment to Neos #5146

bwaidelich · 2024-06-17T07:25:49Z

Introduces WorkspacePublishingService as replacement for the current Neos Workspace "active record" model.

Introduces WorkspaceService as central authority to manage Neos workspaces.

Todos

Replace \Neos\Neos\Ui\ContentRepository\Service\WorkspaceService
Replace \Neos\Neos\Domain\Service\WorkspaceNameBuilder
Cleanup \Neos\Neos\Ui\Fusion\Helper\WorkspaceHelper
Fix \Neos\Neos\Command\WorkspaceCommandController

Related: #4726

Introduces `WorkspacePublishingService` as replacement for the current Neos `Workspace` "active record" model. Introduces `WorkspaceService` as central authority to manage Neos workspaces. Related: #4726

mhsdesign

Some early thoughts thanks for the progress so far ❤️

Notes from my side:

remove \Neos\Neos\Domain\Service\UserService::deletePersonalWorkspace and \Neos\Neos\Domain\Service\UserService::removeOwnerFromUsersWorkspaces
deprecate \Neos\Neos\Service\UserService::getPersonalWorkspaceName
remove WorkspaceNameBuilder again

mhsdesign · 2024-06-17T17:33:46Z

Neos.Neos/Classes/Domain/Service/WorkspaceService.php

+    ): WorkspaceName
+    {


Suggested change

): WorkspaceName

{

): WorkspaceName {

Thanks, but this is just a draft. Please don't add comments re cosmetics just yet

mhsdesign · 2024-06-17T17:34:41Z

Neos.ContentRepositoryRegistry/Classes/ContentRepositoryRegistry.php

+    /**
+     * @return array<ContentRepositoryId>
+     */
+    public function getContentRepositoryIds(): array


thanks i also need this for listing all content repositories via cli or for example for the new 9.0 neos setup :)

mhsdesign · 2024-06-17T17:35:05Z

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

-            // Check if name already match name pattern to prevent unnecessary transliteration
+        if (self::hasValidFormat($name)) {
            return self::fromString($name);
-        } catch (\InvalidArgumentException $e) {
-            // Okay, let's transliterate
        }


❤️ this part always bummed me :D

mhsdesign · 2024-06-17T17:36:45Z

Neos.Neos/Classes/Command/WorkspaceCommandController.php

+
+        $this->workspaceService->createWorkspace(
+            $contentRepositoryId,
+            \Neos\Neos\Domain\Model\WorkspaceTitle::fromString($title),


should probably be used instead of fq

This is a temporary work around, as the \Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceTitle will be replaces in the next step.
But you're right, I should probably rather import the new namespace if the other one is to be removed.

This is just a draft though

mhsdesign · 2024-06-17T17:38:02Z

Neos.Neos/Classes/Command/WorkspaceCommandController.php

@@ -359,16 +367,18 @@ 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'];


so we dont want to show the user id? Well i guess that makes sense as its too technical anyway and the human readable name with classification personal will already suffice?

I'll certainly re-add it, but with the new Workspace <-> Role assignment, maybe rather in some new showCommand() that lists all contributors and their role

mhsdesign · 2024-06-17T17:44:12Z

Neos.Neos/Classes/Domain/Model/User.php

+    /**
+     * @var string
+     */
+    protected $Persistence_Object_Identifier;


Suggested change

/**

* @var string

*/

protected $Persistence_Object_Identifier;

/**

* This property will be introduced via Flows persistence magic aspect

* We declare it here already as workaround to not have to use {@see PersistenceManager::getIdentifierByObject()} to access this identifier.

* @var string

*/

protected $Persistence_Object_Identifier;

nice "hack" idea ... :D I approve ... probably better than injecting the persistence manager to do the same? But the above property should get a nice doc comment

mhsdesign · 2024-06-17T17:44:46Z

Neos.Neos/Classes/Domain/Model/UserId.php

+ *
+ * @api
+ */
+final readonly class UserId implements \JsonSerializable


will this replace the cr's user id thing?

It probably won't replace it because the CR also has a concept of users (currently only used to store the initiatingUserId in the event metadata).
But IMO it makes sense to have a dedicated "Neos UserId" as well.. Maybe we can rename one to make the distinction clearer..

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

mhsdesign · 2024-06-18T13:12:39Z

Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php

cc @Sebobo there are quite some changes in this workspace controller ... just to inform you as youre working on this as well :D

mhsdesign · 2024-06-18T14:39:11Z

Neos.Neos/Classes/Domain/Service/WorkspaceService.php

+            ),
+            WorkspaceClassification::ROOT => WorkspacePermissions::create(
+                read: true,
+                publish: $this->privilegeManager->isPrivilegeTargetGrantedForRoles($userRoles, 'Neos.Workspace.Ui:Backend.PublishAllToLiveWorkspace'),


i think the privilge should belong to neos/neos or neos/neos-core still and not be moved via #5118

or as alternative of moving the Neos.Workspace.Ui:Backend.PublishAllToLiveWorkspace target back to neos, or creating a new empty target for this which will be interpreted here, we could check for the LivePublisher role?

$this->securityContext->hasRole('Neos.Neos:LivePublisher')

edit: we cant move the target back to Neos.Neos:Backend.PublishAllToLiveWorkspace because it protects Ui\Controller\WorkspaceController->publishWorkspaceAction which is in the other package.

yes, I was wondering the same.. There is some mismatch between workspace <-> user/role assignment and the global Flow roles & privileges..
I'll think about it tomorrow!

mhsdesign · 2024-06-22T09:14:43Z

Neos.ContentRepositoryRegistry/Classes/ContentRepositoryRegistry.php

+    /**
+     * @return array<ContentRepositoryId>
+     */
+    public function getContentRepositoryIds(): array
+    {
+        return array_map(ContentRepositoryId::fromString(...), array_keys($this->settings['contentRepositories']));
+    }


Suggested change

/**

* @return array<ContentRepositoryId>

*/

public function getContentRepositoryIds(): array

{

return array_map(ContentRepositoryId::fromString(...), array_keys($this->settings['contentRepositories']));

}

/**

* @return iterable<ContentRepositoryId>

*/

public function getContentRepositoryIds(): iterable

{

return array_map(ContentRepositoryId::fromString(...), array_keys($this->settings['contentRepositories'] ?? []));

}

this way we can easily introduce a collection dto at some point and it wont crash if nothing is configured.

mhsdesign · 2024-06-24T20:45:01Z

Neos.Neos/Classes/Domain/Model/UserInterface.php

Fyi since you wondered and i stumbled upon it ... we have this interface for the following reason:

#165 (comment)

and actually this thing is now useless with the new cr.

…ser-assignment-to-neos

Extracted from #5146 this just improves stability of the `WorkspaceName` value object by - Restricting the allowed value range to 30 lower case characters and properly enforce it - Adding a `tryFromString()` constructor - Exposing the `MAX_LENGTH` and use that for the corresponding database schemas - 100% test coverage Related: #4726

…ser-assignment-to-neos

Counter-part to neos/neos-development-collection#5146

…ser-assignment-to-neos

bwaidelich · 2024-09-06T08:36:38Z

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

 {
    /**
     * This prefix determines if a given workspace (name) is a user workspace.
     */
    public const PERSONAL_WORKSPACE_PREFIX = 'user-';

+    /**


Note: The following properties have been turned into actual fields to improve IDE support:
Constructor promoted arguments of an @internal constructor are all "internal", but in this case they are not. Besides the @deprecated tags are ignored otherwise

mhsdesign · 2024-09-06T09:41:46Z

Neos.Neos/Classes/Domain/Service/WorkspaceService.php

+        $workspaceNameCandidate = WorkspaceName::transliterateFromString($candidate);
+        $workspaceName = $workspaceNameCandidate;
+        while ($contentRepository->getWorkspaceFinder()->findOneByName($workspaceName) instanceof Workspace) {
+            $workspaceName = WorkspaceName::fromString(


with the lowercase enforcement generateRandomString is not safe and will crash

…ser-assignment-to-neos

and add initial behat tests

FEATURE: Extract workspace metadata and user-assignment to Neos

5f1e296

Introduces `WorkspacePublishingService` as replacement for the current Neos `Workspace` "active record" model. Introduces `WorkspaceService` as central authority to manage Neos workspaces. Related: #4726

github-actions bot added the 9.0 label Jun 17, 2024

mhsdesign reviewed Jun 17, 2024

View reviewed changes

bwaidelich commented Jun 18, 2024

View reviewed changes

Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceName.php Outdated Show resolved Hide resolved

mhsdesign reviewed Jun 18, 2024

View reviewed changes

mhsdesign reviewed Jun 22, 2024

View reviewed changes

mhsdesign reviewed Jun 24, 2024

View reviewed changes

bwaidelich added 4 commits June 28, 2024 11:31

Merge branch '9.0' into feature/4726-extract-workspace-metadata-and-u…

113e0b6

…ser-assignment-to-neos

Merge branch '9.0' into feature/4726-extract-workspace-metadata-and-u…

773de1a

…ser-assignment-to-neos

wip

8975a5f

Merge branch '9.0' into feature/4726-extract-workspace-metadata-and-u…

9c74b65

…ser-assignment-to-neos

bwaidelich mentioned this pull request Aug 2, 2024

!!! FEATURE: Stabilize WorkspaceName value object #5193

Merged

bwaidelich added 2 commits August 7, 2024 14:30

Merge branch '9.0' into feature/4726-extract-workspace-metadata-and-u…

4326424

…ser-assignment-to-neos

Mini tweaks

54df32a

bwaidelich added a commit to neos/neos-ui that referenced this pull request Aug 9, 2024

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

d588fbc

Counter-part to neos/neos-development-collection#5146

bwaidelich mentioned this pull request Aug 9, 2024

Draft: FEATURE: Extract workspace metadata and user-assignment to Neos neos/neos-ui#3838

Draft

bwaidelich added 2 commits August 16, 2024 11:07

wip

dccfb50

Merge branch '9.0' into feature/4726-extract-workspace-metadata-and-u…

723f26c

…ser-assignment-to-neos

bwaidelich commented Sep 6, 2024

View reviewed changes

mhsdesign reviewed Sep 6, 2024

View reviewed changes

mhsdesign and others added 5 commits September 9, 2024 10:04

WIP: Fix WorkspaceService as discussed with basti & christian

0af1fa2

Merge branch '9.0' into feature/4726-extract-workspace-metadata-and-u…

80e3aef

…ser-assignment-to-neos

Fix WorkspaceService::createRootWorkspace()

e705924

Use WorkspaceService in workspace::createroot CLI command

11aa9b3

Stabilize unique workspace name creation

bdfb954

and add initial behat tests

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Draft: FEATURE: Extract workspace metadata and user-assignment to Neos #5146

Draft: FEATURE: Extract workspace metadata and user-assignment to Neos #5146

bwaidelich commented Jun 17, 2024 •

edited

Loading

mhsdesign left a comment •

edited

Loading

mhsdesign Jun 17, 2024

bwaidelich Jun 18, 2024

mhsdesign Jun 17, 2024

mhsdesign Jun 17, 2024

mhsdesign Jun 17, 2024

bwaidelich Jun 18, 2024

mhsdesign Jun 17, 2024

bwaidelich Jun 18, 2024

mhsdesign Jun 17, 2024

mhsdesign Jun 17, 2024

bwaidelich Jun 18, 2024

mhsdesign Jun 18, 2024

mhsdesign Jun 18, 2024

mhsdesign Jun 27, 2024 •

edited

Loading

bwaidelich Jun 27, 2024

mhsdesign Jun 22, 2024

mhsdesign Jun 24, 2024

bwaidelich Sep 6, 2024

mhsdesign Sep 6, 2024

Draft: FEATURE: Extract workspace metadata and user-assignment to Neos #5146

Are you sure you want to change the base?

Draft: FEATURE: Extract workspace metadata and user-assignment to Neos #5146

Conversation

bwaidelich commented Jun 17, 2024 • edited Loading

Todos

mhsdesign left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhsdesign Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bwaidelich commented Jun 17, 2024 •

edited

Loading

mhsdesign left a comment •

edited

Loading

mhsdesign Jun 27, 2024 •

edited

Loading