Skip to content

Fix race condition in CleanupAddon.subscribeRenderingChanged #3725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
vogella wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Fix race condition in CleanupAddon.subscribeRenderingChanged #3725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions ...orkbench.addons.swt/src/org/eclipse/e4/ui/workbench/addons/cleanupaddon/CleanupAddon.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,16 +346,13 @@ private void subscribeRenderingChanged(
int visCount = modelService.countRenderableChildren(container);

// Remove stacks with no visible children from the display (but not the
// model)
final MElementContainer<MUIElement> theContainer = container;
if (visCount == 0) {
Display.getCurrent().asyncExec(() -> {
int visCount1 = modelService.countRenderableChildren(theContainer);
if (!isLastEditorStack(theContainer) && visCount1 == 0) {
theContainer.setToBeRendered(false);
transferPrimaryDataStackIfRemoved(theContainer);
}
});
// model). Since event delivery is synchronous (EventBroker.send via
// EventAdmin.sendEvent and Display.syncExec), the visCount reflects
// the actual state at the time of this event and can be acted upon
// immediately without deferring via asyncExec.
if (visCount == 0 && !isLastEditorStack(container)) {
container.setToBeRendered(false);
transferPrimaryDataStackIfRemoved(container);
} else if (container.getParent() != null) { // omit detached windows
// if there are rendered elements but none are 'visible' we should
// make the container invisible as well
Expand Down
10 changes: 3 additions & 7 deletions ...g.eclipse.e4.ui.tests/src/org/eclipse/e4/ui/tests/workbench/PartRenderingEngineTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.ui.tests.harness.util.DisplayHelper;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
Expand Down Expand Up @@ -2447,12 +2446,9 @@ public void ensureCleanUpAddonCleansUp() {
assertTrue(partStackForPartBPartC.isToBeRendered(), " PartStack with children should be rendered");
partService.hidePart(partB);
partService.hidePart(partC);
// DisplayHelper.waitForCondition() handles event processing via Display.sleep()
// and retries. Calling spinEventLoop() here creates a race condition where
// events may be processed before CleanupAddon's asyncExec() is queued (line 352).
assertTrue(
DisplayHelper.waitForCondition(Display.getDefault(), 30_000,
() -> !partStackForPartBPartC.isToBeRendered()), "CleanupAddon should ensure that partStack is not rendered anymore, as all childs have been removed");
contextRule.spinEventLoop();
assertFalse(partStackForPartBPartC.isToBeRendered(),
"CleanupAddon should ensure that partStack is not rendered anymore, as all childs have been removed");
// PartStack with IPresentationEngine.NO_AUTO_COLLAPSE should not be removed
// even if children are removed
partService.hidePart(editor, true);
Expand Down
Loading