Do proper cleanup in VDragAndDropManager.endDrag(boolean) (#17163)

Change-Id: I5f9462923fce9f033bc89b791d68607a1e0fc5c7

5 files changed, 349 insertions, 15 deletions

diff --git a/client/src/com/vaadin/client/ui/dd/VDragAndDropManager.java b/client/src/com/vaadin/client/ui/dd/VDragAndDropManager.java
index 3a0b52b6af..47f8eb1b66 100644
--- a/client/src/com/vaadin/client/ui/dd/VDragAndDropManager.java
+++ b/client/src/com/vaadin/client/ui/dd/VDragAndDropManager.java
@@ -433,23 +433,14 @@ public class VDragAndDropManager {
                                                 .getNativeEvent());
                                 if (Math.abs(startX - currentX) > MINIMUM_DISTANCE_TO_START_DRAG
                                         || Math.abs(startY - currentY) > MINIMUM_DISTANCE_TO_START_DRAG) {
-                                    if (deferredStartRegistration != null) {
-                                        deferredStartRegistration
-                                                .removeHandler();
-                                        deferredStartRegistration = null;
-                                    }
+                                    ensureDeferredRegistrationCleanup();
                                     currentDrag.setCurrentGwtEvent(event
                                             .getNativeEvent());
                                     startDrag.execute();
                                 }
                                 break;
                             default:
-                                // on any other events, clean up the
-                                // deferred drag start
-                                if (deferredStartRegistration != null) {
-                                    deferredStartRegistration.removeHandler();
-                                    deferredStartRegistration = null;
-                                }
+                                ensureDeferredRegistrationCleanup();
                                 currentDrag = null;
                                 clearDragElement();
                                 break;
@@ -540,10 +531,10 @@ public class VDragAndDropManager {
     }
 
     private void endDrag(boolean doDrop) {
-        if (handlerRegistration != null) {
-            handlerRegistration.removeHandler();
-            handlerRegistration = null;
-        }
+
+        ensureDeferredRegistrationCleanup();
+        ensureHandlerRegistrationCleanup();
+
         boolean sendTransferableToServer = false;
         if (currentDropHandler != null) {
             if (doDrop) {
@@ -601,6 +592,20 @@ public class VDragAndDropManager {
 
     }
 
+    private void ensureHandlerRegistrationCleanup() {
+        if (handlerRegistration != null) {
+            handlerRegistration.removeHandler();
+            handlerRegistration = null;
+        }
+    }
+
+    private void ensureDeferredRegistrationCleanup() {
+        if (deferredStartRegistration != null) {
+            deferredStartRegistration.removeHandler();
+            deferredStartRegistration = null;
+        }
+    }
+
     private void removeActiveDragSourceStyleName(ComponentConnector dragSource) {
         dragSource.getWidget().removeStyleName(ACTIVE_DRAG_SOURCE_STYLENAME);
     }
diff --git a/uitest/src/com/vaadin/tests/dd/DDInterrupt.java b/uitest/src/com/vaadin/tests/dd/DDInterrupt.java
new file mode 100644
index 0000000000..1939bbbce5
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/dd/DDInterrupt.java
@@ -0,0 +1,87 @@
+package com.vaadin.tests.dd;
+
+import com.vaadin.annotations.Widgetset;
+import com.vaadin.event.dd.DragAndDropEvent;
+import com.vaadin.event.dd.DropHandler;
+import com.vaadin.event.dd.TargetDetailsImpl;
+import com.vaadin.event.dd.acceptcriteria.AcceptAll;
+import com.vaadin.event.dd.acceptcriteria.AcceptCriterion;
+import com.vaadin.server.VaadinRequest;
+import com.vaadin.tests.components.AbstractTestUI;
+import com.vaadin.tests.widgetset.TestingWidgetSet;
+import com.vaadin.ui.Button;
+import com.vaadin.ui.Button.ClickEvent;
+import com.vaadin.ui.CssLayout;
+import com.vaadin.ui.DragAndDropWrapper;
+import com.vaadin.ui.DragAndDropWrapper.DragStartMode;
+import com.vaadin.ui.Label;
+
+/**
+ * Test for interrupting drag-and-drop.
+ * 
+ * @author Vaadin Ltd
+ */
+@Widgetset(TestingWidgetSet.NAME)
+public class DDInterrupt extends AbstractTestUI {
+
+    private SpacebarPanner sp;
+
+    @Override
+    protected void setup(VaadinRequest vaadinRequest) {
+        final CssLayout layout = new CssLayout();
+        layout.setWidth("500px");
+        layout.setHeight("500px");
+
+        addButton("Click to interrupt next drag.", new Button.ClickListener() {
+
+            @Override
+            public void buttonClick(ClickEvent event) {
+                sp.interruptNext();
+            }
+        });
+
+        final Label draggableLabel = new Label("Drag me");
+        draggableLabel.setId("draggable");
+
+        DragAndDropWrapper dndLayoutWrapper = new DragAndDropWrapper(layout);
+        addComponent(dndLayoutWrapper);
+
+        DragAndDropWrapper labelWrapper = new DragAndDropWrapper(draggableLabel);
+        draggableLabel.setSizeUndefined();
+        labelWrapper.setDragStartMode(DragStartMode.COMPONENT);
+        labelWrapper.setSizeUndefined();
+
+        layout.addComponent(labelWrapper);
+
+        dndLayoutWrapper.setDropHandler(new DropHandler() {
+
+            @Override
+            public AcceptCriterion getAcceptCriterion() {
+                return AcceptAll.get();
+            }
+
+            @Override
+            public void drop(DragAndDropEvent event) {
+                TargetDetailsImpl targetDetails = (TargetDetailsImpl) event
+                        .getTargetDetails();
+                int x = targetDetails.getMouseEvent().getRelativeX();
+                int y = targetDetails.getMouseEvent().getRelativeY();
+
+                draggableLabel.setWidth(x, Unit.PIXELS);
+                draggableLabel.setHeight(y, Unit.PIXELS);
+            }
+        });
+
+        sp = SpacebarPanner.wrap(this);
+    }
+
+    @Override
+    protected Integer getTicketNumber() {
+        return 17163;
+    }
+
+    @Override
+    protected String getTestDescription() {
+        return "Hold space while clicking and dragging the label, or click the button before draggin the label. There should be no client-side exception.";
+    }
+}
diff --git a/uitest/src/com/vaadin/tests/dd/DDInterruptTest.java b/uitest/src/com/vaadin/tests/dd/DDInterruptTest.java
new file mode 100644
index 0000000000..e078bc4665
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/dd/DDInterruptTest.java
@@ -0,0 +1,97 @@
+/*
+ * Copyright 2000-2014 Vaadin Ltd.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ * 
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package com.vaadin.tests.dd;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.openqa.selenium.By;
+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.interactions.Actions;
+import org.openqa.selenium.support.ui.ExpectedCondition;
+
+import com.vaadin.testbench.elements.ButtonElement;
+import com.vaadin.testbench.elements.LabelElement;
+import com.vaadin.testbench.elements.UIElement;
+import com.vaadin.tests.tb3.MultiBrowserTest;
+
+/**
+ * Test for interrupting drag-and-drop.
+ * 
+ * @author Vaadin Ltd
+ */
+public class DDInterruptTest extends MultiBrowserTest {
+
+    private UIElement ui;
+
+    @Override
+    public void setup() throws Exception {
+        super.setup();
+        openTestURL("debug");
+        ui = $(UIElement.class).first();
+    }
+
+    @Test
+    public void testRegularDragging() {
+        dragElement();
+        assertNoNotifications();
+        assertDragged(true);
+    }
+
+    @Test
+    public void testTriggeredDragging() {
+        $(ButtonElement.class).first().click();
+        waitUntilTriggered(true);
+
+        dragElement();
+
+        waitUntilTriggered(false);
+        assertNoNotifications();
+        assertDragged(false);
+    }
+
+    private void dragElement() {
+        LabelElement label = $(LabelElement.class).id("draggable");
+        new Actions(driver).moveToElement(label).clickAndHold()
+                .moveByOffset(400, 400).perform();
+    }
+
+    private void assertNoNotifications() {
+        Assert.assertEquals(
+                "Notification found when there should have been none,", 0,
+                findElements(By.className("v-Notification")).size());
+    }
+
+    private void assertDragged(boolean dragged) {
+        Assert.assertEquals("Unexpected drag state,", dragged ? 1 : 0,
+                findElements(By.className("v-ddwrapper-over-bottom")).size());
+    }
+
+    private void waitUntilTriggered(final boolean triggered) {
+        waitUntil(new ExpectedCondition<Boolean>() {
+
+            @Override
+            public Boolean apply(WebDriver arg0) {
+                return triggered == hasCssClass(ui, "triggered");
+            }
+
+            @Override
+            public String toString() {
+                return String.format("UI to %s stylename 'triggered'",
+                        (triggered ? "get" : "lose"));
+            }
+        });
+    }
+}
diff --git a/uitest/src/com/vaadin/tests/dd/SpacebarPanner.java b/uitest/src/com/vaadin/tests/dd/SpacebarPanner.java
new file mode 100644
index 0000000000..d6179066fb
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/dd/SpacebarPanner.java
@@ -0,0 +1,20 @@
+package com.vaadin.tests.dd;
+
+import com.vaadin.server.AbstractExtension;
+import com.vaadin.ui.UI;
+
+public class SpacebarPanner extends AbstractExtension {
+
+    private static final long serialVersionUID = -7712258690917457123L;
+
+    public static SpacebarPanner wrap(UI ui) {
+        SpacebarPanner panner = new SpacebarPanner();
+        panner.extend(ui);
+        return panner;
+    }
+
+    public void interruptNext() {
+        getState().enabled = !getState().enabled;
+    }
+
+}
diff --git a/uitest/src/com/vaadin/tests/widgetset/client/dd/SpacebarPannerConnector.java b/uitest/src/com/vaadin/tests/widgetset/client/dd/SpacebarPannerConnector.java
new file mode 100644
index 0000000000..e13dd5030b
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/widgetset/client/dd/SpacebarPannerConnector.java
@@ -0,0 +1,125 @@
+package com.vaadin.tests.widgetset.client.dd;
+
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import com.google.gwt.dom.client.Element;
+import com.google.gwt.dom.client.NativeEvent;
+import com.google.gwt.event.dom.client.KeyCodes;
+import com.google.gwt.user.client.Event;
+import com.google.gwt.user.client.Event.NativePreviewEvent;
+import com.google.gwt.user.client.Event.NativePreviewHandler;
+import com.vaadin.client.ServerConnector;
+import com.vaadin.client.annotations.OnStateChange;
+import com.vaadin.client.extensions.AbstractExtensionConnector;
+import com.vaadin.client.ui.VUI;
+import com.vaadin.client.ui.dd.VDragAndDropManager;
+import com.vaadin.client.ui.ui.UIConnector;
+import com.vaadin.shared.ui.Connect;
+
+@Connect(com.vaadin.tests.dd.SpacebarPanner.class)
+public class SpacebarPannerConnector extends AbstractExtensionConnector {
+
+    Logger logger = Logger.getLogger(SpacebarPannerConnector.class
+            .getSimpleName());
+
+    private boolean trigger = false;
+    private VUI vui;
+    private boolean first = true;
+
+    @Override
+    protected void extend(ServerConnector target) {
+        UIConnector uic = (UIConnector) target;
+        vui = uic.getWidget();
+        Event.sinkEvents(vui.getElement(), Event.MOUSEEVENTS | Event.KEYEVENTS);
+        Event.addNativePreviewHandler(createNativePreviewHandler());
+    }
+
+    @OnStateChange("enabled")
+    private void trigger() {
+        if (first) {
+            // ignore initial state change
+            first = false;
+        } else {
+            trigger = true;
+            vui.addStyleName("triggered");
+        }
+    }
+
+    private NativePreviewHandler createNativePreviewHandler() {
+        return new NativePreviewHandler() {
+
+            private boolean spacebarDown = false;
+            private boolean shouldPan = false;
+            private boolean mouseDown = false;
+
+            private int lastMouseX;
+            private int lastMouseY;
+
+            @Override
+            public void onPreviewNativeEvent(NativePreviewEvent event) {
+                NativeEvent ne = event.getNativeEvent();
+                int type = event.getTypeInt();
+
+                switch (type) {
+                case Event.ONKEYDOWN:
+                    if (ne.getKeyCode() == KeyCodes.KEY_SPACE) {
+                        event.cancel();
+                        ne.preventDefault();
+                        ne.stopPropagation();
+                        spacebarDown = true;
+                        break;
+                    }
+                case Event.ONKEYUP:
+                    if (ne.getKeyCode() == KeyCodes.KEY_SPACE) {
+                        spacebarDown = false;
+                    }
+                    break;
+                case Event.ONMOUSEDOWN:
+                    logger.log(Level.INFO, "Drag started");
+                    lastMouseX = ne.getClientX();
+                    lastMouseY = ne.getClientY();
+
+                    shouldPan = spacebarDown || trigger;
+                    mouseDown = true;
+                    break;
+
+                case Event.ONMOUSEUP:
+                    shouldPan = false || trigger;
+                    mouseDown = false;
+                    break;
+
+                case Event.ONMOUSEMOVE:
+                    if (mouseDown && shouldPan) {
+                        logger.log(Level.INFO, "In mousemove: mouseDown:"
+                                + mouseDown + ", shouldPan: " + shouldPan);
+                        trigger = false;
+                        vui.removeStyleName("triggered");
+
+                        logger.log(Level.INFO, "Panning!");
+                        int currentClientX = ne.getClientX();
+                        int currentClientY = ne.getClientY();
+
+                        int deltaX = lastMouseX - currentClientX;
+                        int deltaY = lastMouseY - currentClientY;
+                        lastMouseX = currentClientX;
+                        lastMouseY = currentClientY;
+
+                        // this causes #17163
+                        VDragAndDropManager.get().interruptDrag();
+
+                        Element uiElement = vui.getElement();
+                        int top = uiElement.getScrollTop();
+                        int left = uiElement.getScrollLeft();
+
+                        uiElement.setScrollTop(top + deltaY);
+                        uiElement.setScrollLeft(left + deltaX);
+                    }
+
+                default:
+                    break;
+                }
+            }
+        };
+    }
+}