Fix for unnecessary RPC request when clicking on CheckBox label (#8259)

Change-Id: I7efb8b10a0d1b19ffdc9eb1d29db1f00b45f17aa

diff --git a/client/src/com/vaadin/client/ui/checkbox/CheckBoxConnector.java b/client/src/com/vaadin/client/ui/checkbox/CheckBoxConnector.java
index a72049aa9069bc3c33fbe81af5ae153703f9ac56..28f6beefa69ff3444b0f08dbe87f154283cbc392 100644 (file)
--- a/client/src/com/vaadin/client/ui/checkbox/CheckBoxConnector.java
+++ b/client/src/com/vaadin/client/ui/checkbox/CheckBoxConnector.java
@@ -144,14 +144,18 @@ public class CheckBoxConnector extends AbstractFieldConnector implements
             return;
         }
 
-        getState().checked = getWidget().getValue();
-
-        // Add mouse details
-        MouseEventDetails details = MouseEventDetailsBuilder
-                .buildMouseEventDetails(event.getNativeEvent(), getWidget()
-                        .getElement());
-        getRpcProxy(CheckBoxServerRpc.class).setChecked(getState().checked,
-                details);
-
+        // We get click events also from the label text, which do not alter the
+        // actual value. The server-side is only interested in real changes to
+        // the state.
+        if (getState().checked != getWidget().getValue()) {
+            getState().checked = getWidget().getValue();
+
+            // Add mouse details
+            MouseEventDetails details = MouseEventDetailsBuilder
+                    .buildMouseEventDetails(event.getNativeEvent(), getWidget()
+                            .getElement());
+            getRpcProxy(CheckBoxServerRpc.class).setChecked(getState().checked,
+                    details);
+        }
     }
 }

diff --git a/uitest/src/com/vaadin/tests/components/checkbox/CheckBoxRpcCount.java b/uitest/src/com/vaadin/tests/components/checkbox/CheckBoxRpcCount.java
new file mode 100644 (file)
index 0000000..bd44e8a
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/components/checkbox/CheckBoxRpcCount.java
@@ -0,0 +1,62 @@
+/*
+ * 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.components.checkbox;
+
+import com.vaadin.server.VaadinRequest;
+import com.vaadin.shared.MouseEventDetails;
+import com.vaadin.shared.ui.checkbox.CheckBoxServerRpc;
+import com.vaadin.tests.components.AbstractTestUI;
+import com.vaadin.ui.CheckBox;
+import com.vaadin.ui.Label;
+
+public class CheckBoxRpcCount extends AbstractTestUI {
+
+    @Override
+    protected void setup(VaadinRequest request) {
+        final Label countLabel = new Label("No RPC calls made yet.");
+        countLabel.setId("count-label");
+        addComponent(countLabel);
+
+        CheckBox cb = new CheckBox("Click me to start counting...") {
+            {
+                // Register a new RPC that counts the number of invocations.
+                registerRpc(new CheckBoxServerRpc() {
+                    private int rpcCount = 0;
+
+                    @Override
+                    public void setChecked(boolean checked,
+                            MouseEventDetails mouseEventDetails) {
+                        rpcCount++;
+                        countLabel.setValue(rpcCount + " RPC call(s) made.");
+                    }
+
+                });
+            }
+        };
+        addComponent(cb);
+    }
+
+    @Override
+    protected String getTestDescription() {
+        return "Test for verifying that no extra RPC calls are made when clicking on CheckBox label.";
+    }
+
+    @Override
+    protected Integer getTicketNumber() {
+        return 8259;
+    }
+
+}

diff --git a/uitest/src/com/vaadin/tests/components/checkbox/CheckBoxRpcCountTest.java b/uitest/src/com/vaadin/tests/components/checkbox/CheckBoxRpcCountTest.java
new file mode 100644 (file)
index 0000000..c32051b
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/components/checkbox/CheckBoxRpcCountTest.java
@@ -0,0 +1,50 @@
+/*
+ * 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.components.checkbox;
+
+import static org.junit.Assert.assertEquals;
+
+import org.junit.Test;
+import org.openqa.selenium.By;
+import org.openqa.selenium.WebElement;
+
+import com.vaadin.tests.tb3.MultiBrowserTest;
+
+public class CheckBoxRpcCountTest extends MultiBrowserTest {
+
+    @Test
+    public void testNumberOfRpcCalls() {
+        openTestURL();
+
+        WebElement labelElem = driver.findElement(By
+                .cssSelector(".v-checkbox label"));
+        WebElement inputElem = driver.findElement(By
+                .cssSelector(".v-checkbox input"));
+        WebElement countElem = driver.findElement(By.id("count-label"));
+
+        // Click on the actual checkbox.
+        inputElem.click();
+        assertEquals("1 RPC call(s) made.", countElem.getText());
+
+        // Click on the checkbox label.
+        labelElem.click();
+        assertEquals("2 RPC call(s) made.", countElem.getText());
+
+        // Again on the label.
+        labelElem.click();
+        assertEquals("3 RPC call(s) made.", countElem.getText());
+    }
+}