FEATURE: Integrate conflict resolution with publish/discard dialog workflow

[grebaldi]

Peek.2024-05-29.13-09.Publish.+.Sync.mp4

solves: #3761
fixes: #3845
fixes: #3785
builds on: #3762

The Problem

With the introduction of conflict resolution, users can synchronize their workspace with recent changes in the base workspace by clicking the "sync"-button that is placed aside the publish dropdown. When a workspace is in OUTDATED state, the "sync"-button shows up.

It may happen though that a workspace transitions into OUTDATED state without the UI taking notice of it. If the user then tries to publish their changes, publishing fails with an exception. Only after reloading the entire UI, they'll be able to trigger the "sync"-workflow.

Steps to reproduce

Assuming you have two user accounts with Neos.Neos:Editor role (let's call them "editor-a" and "editor-b"):

1. Log in as "editor-a"
2. Create a document "Test"
3. Add a text node to "Test"
4. Publish those changes
5. Edit the text node, without publishing that change
6. Log in as "editor-b" in a private window (keep "editor-a"'s window open!)
7. Sync "editor-b"'s workspace, so you can see document "Test"
8. Remove document "Test"
9. Publish that change
10. Switch to "editor-a"'s window (do not reload the page!)
11. Try to publish the change on the text node that is still pending
12. Observe:

• Pre-PR: Publishing results in an exception
• Post-PR: Publishing triggers conflict resolution

The solution

With this PR, the UI automatically triggers the sync and conflict resolution workflows if a publishing operation fails due to an outdated workspace.

Remaining TODOs

• Move Conflicts concept to Application\Shared namespace
  • Move ConflictsOccurred to Application\Shared namespace
  • Move Conflict to Application\Shared namespace
  • Move Conflicts to Application\Shared namespace
  • Move ConflictsBuilder to Application\Shared namespace
  • Move ReasonForConflict to Application\Shared namespace
  • Move TypeOfChange to Application\Shared namespace
  • Move IconLabel to Application\Shared namespace
• Add command handlers for all Publish-related commands & make sure they throw ConflictsOccurred
  • Move PublishChangesInDocument -> PublishChangesInDocument\PublishChangesInDocumentCommand
  • Create PublishChangesInDocumentCommandHandler
  • Ensure that PublishChangesInDocumentCommandHandler throws ConflictsOccurred
  • Move PublishChangesInSite -> PublishChangesInSite\PublishChangesInSiteCommand
  • Create PublishChangesInSiteCommandHandler
  • Ensure that PublishChangesInSiteCommandHandler throws ConflictsOccurred
• Turn ConflictsOccurred into a Result DTO rather than an exception
• Eliminate redundancy in catch (WorkspaceRebaseFailed $e) clauses
• Trigger conflict resolution from within Publish saga
  • Add conflicts case to PublishingResponse
  • Add PublishingState.CONFLICTS
• Fix: "Node could not be published, because of missing parentNode" after conflict resolution (happens when you do "Publish Document" on a document that gets removed by conflict resolution)
• Fix: TypeError node.children is undefined (regression after FEATURE: Collapse All Button in Content and Page Tree #3756 - Race Condition)
• Fix: You still can get stuck in an undefined state in which the saga ceases to continue (happens when the in-between sync is cancelled)
• Fix: BUG: The new conflict resolution e2e tests are sadly a bit flaky in ci :O #3785

[mhsdesign]

Id like to help reviewing this so we can soon make the changes Neos requires regarding the rename an removal of Node fields on 9.0-dev (whithout major conflicts against your pr)

[grebaldi]

@mhsdesign Don't worry about conflicts - I'll take care of keeping this PR up-to-date. So, unless anything upstream of the UI needs this change to move on, I'd say that everything else has more priority.

[grebaldi]

@pKallert
FYI: While rebasing, I encountered conflicts with the fix you've provided in #3634. To resolve this, I have moved the translation handling from BackendServiceController::publishChangesInDocumentAction to PublishChangesInDocumentCommandHandler::handle:

neos-ui/Classes/Application/PublishChangesInDocument/PublishChangesInDocumentCommandHandler.php

Lines 62 to 74 in faee8ca

	} catch (NodeAggregateCurrentlyDoesNotExist $e) {
	throw new \RuntimeException(
	$this->getLabel('NodeNotPublishedMissingParentNode'),
	1705053430,
	$e
	);
	} catch (NodeAggregateDoesCurrentlyNotCoverDimensionSpacePoint $e) {
	throw new \RuntimeException(
	$this->getLabel('NodeNotPublishedParentNodeNotInCurrentDimension'),
	1705053432,
	$e
	);
	} catch (WorkspaceRebaseFailed $e) {

Does that match your intend?

@mhsdesign
One of the conflicting commits was one of yours, but was introduced in #3634 as well: 29a73a1

So, same question goes to you as well :)

[mhsdesign]

Yes looks perfect thanks for taking care :)

[mhsdesign]

Hi i kindof forget about this ^^ Would this be something for the next beta to include?

And while navigating the code i found that this file is no longer in use packages/neos-ui-redux-store/src/UI/SyncWorkspaceModal/index.ts so we might as well delete that? Seems its a leftover from paulas previous pr?

[mhsdesign]

There where some changes in the e2e setup and the test dont pass all on 9.0 anymore but that might be fixed here as well. But i still happen to get publish errors when running the tests locally: And the tests fail at a later point because we just click the Discard button with the id #neos-DiscardDialog-Acknowledg even if its an error:

[mhsdesign]

That rebasing doesnt work is actually a core bug and will be resolved via: neos/neos-development-collection#5301 ... that fixes most of the tests locally but one is still failing ...

[mhsdesign]

Thank you so much ❤️ tested in combination with the new publishing v3 everything works again locally: neos/neos-development-collection#5301

(I solved conflicts with 9.0 and also pushed a few minor changes)