Skip to content

Commit da19324

Browse files
mhsdesignmhsdesign
authoredJan 27, 2025··
Merge pull request #3910 from mhsdesign/bugfix/3908-delicate-operations-after-resolving-conflict
BUGFIX: Improve conflict resolution edge-cases in sync and publish workflow
·
9.0.0-beta209.0.0-beta18
2 parents 5e9e318 + 6ee4e83 commit da19324

File tree

7 files changed

+95
-66
lines changed

7 files changed

+95
-66
lines changed
 

‎Resources/Private/Translations/en/SyncWorkspaceDialog.xlf

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
<source>Discard all changes in workspace "{workspaceName}"</source>
5555
</trans-unit>
5656
<trans-unit id="resolutionStrategy.DISCARD_ALL.confirmation.message" xml:space="preserve">
57-
<source>You are about to discard all changes in workspace "{workspaceName}". This includes all changes on other sites.
57+
<source>You are about to discard all {numberOfChanges} change(s) in workspace "{workspaceName}". This includes all changes on other sites.
5858

5959
Do you wish to proceed? Be careful: This cannot be undone!</source>
6060
</trans-unit>

‎Tests/IntegrationTests/Fixtures/1Dimension/syncing.e2e.js

+36-26
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ fixture`Syncing`
2020
test('Syncing: Create a conflict state between two editors and choose "Discard all" as a resolution strategy during rebase', async t => {
2121
await prepareContentElementConflictBetweenAdminAndEditor(t);
2222
await chooseDiscardAllAsResolutionStrategy(t);
23-
await confirmAndPerformDiscardAll(t);
24-
await finishSynchronization(t);
23+
await performResolutionStrategy(t);
24+
await finishDiscard(t);
2525

2626
await assertThatWeAreOnPage(t, 'Home');
2727
await assertThatWeCannotSeePageInTree(t, 'Sync Demo #1');
@@ -32,7 +32,7 @@ test('Syncing: Create a conflict state between two editors and choose "Discard a
3232
test('Syncing: Create a conflict state between two editors and choose "Drop conflicting changes" as a resolution strategy during rebase', async t => {
3333
await prepareContentElementConflictBetweenAdminAndEditor(t);
3434
await chooseDropConflictingChangesAsResolutionStrategy(t);
35-
await confirmDropConflictingChanges(t);
35+
await performResolutionStrategy(t);
3636
await finishSynchronization(t);
3737

3838
await assertThatWeAreOnPage(t, 'Home');
@@ -47,7 +47,7 @@ test('Syncing: Create a conflict state between two editors, start and cancel res
4747
await startSynchronization(t);
4848
await assertThatConflictResolutionHasStarted(t);
4949
await chooseDropConflictingChangesAsResolutionStrategy(t);
50-
await confirmDropConflictingChanges(t);
50+
await performResolutionStrategy(t);
5151
await finishSynchronization(t);
5252

5353
await assertThatWeAreOnPage(t, 'Home');
@@ -56,44 +56,61 @@ test('Syncing: Create a conflict state between two editors, start and cancel res
5656
await assertThatWeCannotSeePageInTree(t, 'Sync Demo #3');
5757
});
5858

59-
test('Syncing: Create a conflict state between two editors and choose "Drop conflicting changes" as a resolution strategy, then cancel and choose "Discard all" as a resolution strategy during rebase', async t => {
59+
test('Syncing: Create a conflict state between two editors and switch between "Drop conflicting changes" and "Discard all" as a resolution strategy during rebase', async t => {
6060
await prepareContentElementConflictBetweenAdminAndEditor(t);
61+
62+
// switch back and forth
63+
await chooseDiscardAllAsResolutionStrategy(t);
64+
await cancelResolutionStrategy(t);
6165
await chooseDropConflictingChangesAsResolutionStrategy(t);
62-
await cancelDropConflictingChanges(t);
66+
await cancelResolutionStrategy(t);
6367
await chooseDiscardAllAsResolutionStrategy(t);
64-
await confirmAndPerformDiscardAll(t);
65-
await finishSynchronization(t);
68+
69+
await performResolutionStrategy(t);
70+
await finishDiscard(t);
6671

6772
await assertThatWeAreOnPage(t, 'Home');
6873
await assertThatWeCannotSeePageInTree(t, 'Sync Demo #1');
6974
await assertThatWeCannotSeePageInTree(t, 'Sync Demo #2');
7075
await assertThatWeCannotSeePageInTree(t, 'Sync Demo #3');
7176
});
7277

73-
test('Publish + Syncing: Create a conflict state between two editors, then try to publish and choose "Drop conflicting changes" as a resolution strategy during automatic rebase', async t => {
78+
test('Publish + Syncing: Create a conflict state between two editors, then try to publish the site and choose "Drop conflicting changes" as a resolution strategy during automatic rebase', async t => {
7479
await prepareDocumentConflictBetweenAdminAndEditor(t);
7580
await startPublishAll(t);
7681
await assertThatConflictResolutionHasStarted(t);
7782
await chooseDropConflictingChangesAsResolutionStrategy(t);
78-
await confirmDropConflictingChanges(t);
83+
await performResolutionStrategy(t);
7984
await finishPublish(t);
8085

8186
await assertThatWeAreOnPage(t, 'Home');
8287
await assertThatWeCannotSeePageInTree(t, 'This page will be deleted during sync');
8388
});
8489

85-
test('Publish + Syncing: Create a conflict state between two editors, then try to publish the document only and choose "Drop conflicting changes" as a resolution strategy during automatic rebase', async t => {
90+
test('Publish + Syncing: Create a conflict state between two editors, then try to publish the document and choose "Drop conflicting changes" as a resolution strategy during automatic rebase', async t => {
8691
await prepareDocumentConflictBetweenAdminAndEditor(t);
8792
await startPublishDocument(t);
8893
await assertThatConflictResolutionHasStarted(t);
8994
await chooseDropConflictingChangesAsResolutionStrategy(t);
90-
await confirmDropConflictingChanges(t);
95+
await performResolutionStrategy(t);
9196
await finishPublish(t);
9297

9398
await assertThatWeAreOnPage(t, 'Home');
9499
await assertThatWeCannotSeePageInTree(t, 'This page will be deleted during sync');
95100
});
96101

102+
test('Publish + Syncing: Create a conflict state between two editors, then try to publish the site and choose "Discard all" as a resolution strategy', async t => {
103+
await prepareDocumentConflictBetweenAdminAndEditor(t);
104+
await startPublishAll(t);
105+
await assertThatConflictResolutionHasStarted(t);
106+
await chooseDiscardAllAsResolutionStrategy(t);
107+
await performResolutionStrategy(t);
108+
await finishDiscard(t);
109+
110+
await assertThatWeAreOnPage(t, 'Home');
111+
await assertThatWeCannotSeePageInTree(t, 'This page will be deleted during sync');
112+
});
113+
97114
async function prepareContentElementConflictBetweenAdminAndEditor(t) {
98115
await loginAsEditorOnceToInitializeAContentStreamForTheirWorkspaceIfNeeded(t);
99116

@@ -317,6 +334,11 @@ async function finishPublish(t) {
317334
await t.wait(2000);
318335
}
319336

337+
async function finishDiscard(t) {
338+
await t.click(Selector('#neos-DiscardDialog-Acknowledge'));
339+
await t.wait(2000);
340+
}
341+
320342
async function startSynchronization(t) {
321343
await t.click(Selector('#neos-workspace-rebase'));
322344
await t.click(Selector('#neos-SyncWorkspace-Confirm'));
@@ -332,29 +354,17 @@ async function chooseDiscardAllAsResolutionStrategy(t) {
332354
await t.click(Selector('#neos-SelectResolutionStrategy-Accept'));
333355
}
334356

335-
async function confirmAndPerformDiscardAll(t) {
336-
await t.click(Selector('#neos-DiscardDialog-Confirm'));
337-
await t.expect(Selector('#neos-DiscardDialog-Acknowledge').exists)
338-
.ok('Acknowledge button for "Discard all" is not available.', {
339-
timeout: 30000
340-
});
341-
// For reasons unknown, we have to press the acknowledge button really
342-
// hard for testcafe to realize our intent...
343-
await t.wait(500);
344-
await t.click(Selector('#neos-DiscardDialog-Acknowledge'));
345-
}
346-
347357
async function chooseDropConflictingChangesAsResolutionStrategy(t) {
348358
await t.click(Selector('#neos-SelectResolutionStrategy-SelectBox'));
349359
await t.click(Selector('[role="button"]').withText('Drop conflicting changes'));
350360
await t.click(Selector('#neos-SelectResolutionStrategy-Accept'));
351361
}
352362

353-
async function confirmDropConflictingChanges(t) {
363+
async function performResolutionStrategy(t) {
354364
await t.click(Selector('#neos-ResolutionStrategyConfirmation-Confirm'));
355365
}
356366

357-
async function cancelDropConflictingChanges(t) {
367+
async function cancelResolutionStrategy(t) {
358368
await t.click(Selector('#neos-ResolutionStrategyConfirmation-Cancel'));
359369
}
360370

‎packages/neos-ui-redux-store/src/CR/Publishing/index.ts

+9-1
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,16 @@ export const reducer = (state: State = defaultState, action: Action): State => {
150150

151151
return null;
152152
}
153-
154153
switch (action.type) {
154+
// recursive publishing start, replacing the outer process
155+
case actionTypes.STARTED:
156+
return {
157+
mode: action.payload.mode,
158+
scope: action.payload.scope,
159+
process: {
160+
phase: PublishingPhase.START
161+
}
162+
};
155163
case actionTypes.CANCELLED:
156164
return null;
157165
case actionTypes.CONFIRMED:

‎packages/neos-ui-sagas/src/Publish/index.ts

+21-7
Original file line numberDiff line numberDiff line change
@@ -108,17 +108,30 @@ export function * watchPublishing({routes}: {routes: Routes}) {
108108

109109
if (conflictsWereResolved) {
110110
yield put(actions.CR.Publishing.resolveConflicts());
111-
112111
//
113-
// It may happen that after conflicts are resolved, the
114-
// document we're trying to publish no longer exists.
112+
// There are special cases after conflicts is resolved:
113+
//
114+
// * the document we're trying to publish no longer exists
115+
// * the site we're trying to publish no longer contains changes
116+
// * the document we're trying to publish no longer contains changes
115117
//
116118
// We need to finish the publishing operation in this
117-
// case, otherwise it'll lead to an error.
119+
// case, otherwise it'll lead to an error as there is nothing to do.
118120
//
119-
const publishingShouldContinue = scope === PublishingScope.DOCUMENT
120-
? Boolean(yield select(selectors.CR.Nodes.byContextPathSelector(ancestorId)))
121-
: true;
121+
// todo possibly add another phase to actively continue publishing and also make it more transparently if publishing cant continue
122+
// see: https://github.com/neos/neos-ui/issues/3908#issuecomment-2608232225
123+
let publishingShouldContinue = true;
124+
if (scope === PublishingScope.DOCUMENT) {
125+
if (!(yield select(selectors.CR.Nodes.byContextPathSelector(ancestorId)))) {
126+
publishingShouldContinue = false;
127+
} else if ((yield select(selectors.CR.Workspaces.publishableNodesInDocumentSelector)).length === 0) {
128+
publishingShouldContinue = false;
129+
}
130+
} else if (scope === PublishingScope.SITE) {
131+
if ((yield select(selectors.CR.Workspaces.publishableNodesSelector)).length === 0) {
132+
publishingShouldContinue = false;
133+
}
134+
}
122135

123136
if (publishingShouldContinue) {
124137
yield * attemptToPublishOrDiscard();
@@ -141,6 +154,7 @@ export function * watchPublishing({routes}: {routes: Routes}) {
141154
window.addEventListener('beforeunload', handleWindowBeforeUnload);
142155
yield * attemptToPublishOrDiscard();
143156
} catch (error) {
157+
console.error(error); // log client site errors
144158
yield put(actions.CR.Publishing.fail(error as AnyError));
145159
} finally {
146160
window.removeEventListener('beforeunload', handleWindowBeforeUnload);

‎packages/neos-ui-sagas/src/Sync/index.ts

+14-14
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ export const makeSyncPersonalWorkspace = (deps: {
8080
yield put(actions.CR.Syncing.fail(result.error));
8181
}
8282
} catch (error) {
83+
console.error(error); // log client site errors
8384
yield put(actions.CR.Syncing.fail(error as AnyError));
8485
} finally {
8586
window.removeEventListener('beforeunload', handleWindowBeforeUnload);
@@ -92,7 +93,7 @@ export const makeSyncPersonalWorkspace = (deps: {
9293
export const makeResolveConflicts = (deps: {
9394
syncPersonalWorkspace: ReturnType<typeof makeSyncPersonalWorkspace>
9495
}) => {
95-
const discardAll = makeDiscardAll(deps);
96+
const discardAll = makeDiscardAll();
9697

9798
function * resolveConflicts(conflicts: Conflict[]): any {
9899
while (true) {
@@ -119,8 +120,12 @@ export const makeResolveConflicts = (deps: {
119120
}
120121

121122
if (strategy === ResolutionStrategy.DISCARD_ALL) {
122-
yield * discardAll();
123-
return true;
123+
if (yield * waitForResolutionConfirmation()) {
124+
yield * discardAll();
125+
return false; // don't continue publishing as this is a deletes all
126+
}
127+
128+
continue;
124129
}
125130
}
126131

@@ -155,16 +160,15 @@ function * waitForRetry() {
155160
return Boolean(retried);
156161
}
157162

158-
const makeDiscardAll = (deps: {
159-
syncPersonalWorkspace: ReturnType<typeof makeSyncPersonalWorkspace>;
160-
}) => {
163+
const makeDiscardAll = () => {
161164
function * discardAll() {
162165
yield put(actions.CR.Publishing.start(
163166
PublishingMode.DISCARD,
164167
PublishingScope.ALL
165168
));
166-
167-
const {cancelled, failed}: {
169+
yield put(actions.CR.Publishing.confirm()); // todo auto-confirm this case
170+
yield put(actions.CR.Syncing.finish()); // stop syncing as discarding takes now over
171+
const {cancelled}: {
168172
cancelled: null | ReturnType<typeof actions.CR.Publishing.cancel>;
169173
failed: null | ReturnType<typeof actions.CR.Publishing.fail>;
170174
finished: null | ReturnType<typeof actions.CR.Publishing.finish>;
@@ -175,13 +179,9 @@ const makeDiscardAll = (deps: {
175179
});
176180

177181
if (cancelled) {
178-
yield put(actions.CR.Syncing.cancelResolution());
179-
} else if (failed) {
180-
yield put(actions.CR.Syncing.finish());
181-
} else {
182-
yield put(actions.CR.Syncing.confirmResolution());
183-
yield * deps.syncPersonalWorkspace(false);
182+
yield put(actions.CR.Publishing.cancel());
184183
}
184+
yield put(actions.CR.Publishing.finish());
185185
}
186186

187187
return discardAll;

‎packages/neos-ui/src/Containers/Modals/SyncWorkspaceDialog/ResolutionStrategyConfirmationDialog.tsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -175,8 +175,8 @@ const DiscardAllConfirmationDialog: React.FC<{
175175
/>
176176
<I18n
177177
id="Neos.Neos.Ui:SyncWorkspaceDialog:resolutionStrategy.DISCARD_ALL.confirmation.message"
178-
fallback={`You are about to discard all changes in workspace "${props.workspaceName}". This includes all changes on other sites. Do you wish to proceed? Be careful: This cannot be undone!`}
179-
params={props}
178+
fallback={`You are about to discard all ${props.totalNumberOfChangesInWorkspace} change(s) in workspace "${props.workspaceName}". This includes all changes on other sites. Do you wish to proceed? Be careful: This cannot be undone!`}
179+
params={{numberOfChanges: props.totalNumberOfChangesInWorkspace, workspaceName: props.workspaceName}}
180180
/>
181181
</div>
182182
</Dialog>

‎packages/neos-ui/src/Containers/Modals/SyncWorkspaceDialog/SyncWorkspaceDialog.tsx

+12-15
Original file line numberDiff line numberDiff line change
@@ -125,21 +125,18 @@ const SyncWorkspaceDialog: React.FC<SyncWorkspaceDialogProps> = (props) => {
125125
/>
126126
);
127127
case SyncingPhase.RESOLVING:
128-
if (props.syncingState.process.strategy === ResolutionStrategy.FORCE) {
129-
return (
130-
<ResolutionStrategyConfirmationDialog
131-
workspaceName={props.personalWorkspaceName}
132-
baseWorkspaceName={props.baseWorkspaceName}
133-
totalNumberOfChangesInWorkspace={props.totalNumberOfChangesInWorkspace}
134-
strategy={props.syncingState.process.strategy}
135-
conflicts={props.syncingState.process.conflicts}
136-
i18n={props.i18nRegistry}
137-
onCancelConflictResolution={handleCancelConflictResolution}
138-
onConfirmResolutionStrategy={handleConfirmResolutionStrategy}
139-
/>
140-
);
141-
}
142-
return null;
128+
return (
129+
<ResolutionStrategyConfirmationDialog
130+
workspaceName={props.personalWorkspaceName}
131+
baseWorkspaceName={props.baseWorkspaceName}
132+
totalNumberOfChangesInWorkspace={props.totalNumberOfChangesInWorkspace}
133+
strategy={props.syncingState.process.strategy}
134+
conflicts={props.syncingState.process.conflicts}
135+
i18n={props.i18nRegistry}
136+
onCancelConflictResolution={handleCancelConflictResolution}
137+
onConfirmResolutionStrategy={handleConfirmResolutionStrategy}
138+
/>
139+
);
143140
case SyncingPhase.ERROR:
144141
case SyncingPhase.SUCCESS:
145142
return (

0 commit comments

Comments
 (0)
Please sign in to comment.