feat: add dashboard feature flag (#6832)

Author: ugur-vaadin

vaadin-dashboard-flow-parent/vaadin-dashboard-flow-integration-tests/src/main/resources/vaadin-featureflags.properties

@@ -0,0 +1 @@
+com.vaadin.experimental.dashboardComponent=true

vaadin-dashboard-flow-parent/vaadin-dashboard-flow/src/main/java/com/vaadin/flow/component/dashboard/Dashboard.java

@@ -21,11 +21,13 @@
 
 import org.slf4j.LoggerFactory;
 
+import com.vaadin.experimental.FeatureFlags;
 import com.vaadin.flow.component.AttachEvent;
 import com.vaadin.flow.component.Component;
 import com.vaadin.flow.component.ComponentEventListener;
 import com.vaadin.flow.component.HasSize;
 import com.vaadin.flow.component.Tag;
+import com.vaadin.flow.component.UI;
 import com.vaadin.flow.component.dependency.JsModule;
 import com.vaadin.flow.component.dependency.NpmPackage;
 import com.vaadin.flow.dom.DomEvent;
@@ -69,6 +71,8 @@ public class Dashboard extends Component implements HasWidgets, HasSize {
 
     private boolean pendingUpdate = false;
 
+    private boolean featureFlagEnabled;
+
     /**
      * Creates an empty dashboard.
      */
@@ -496,6 +500,7 @@ public boolean isVisible() {
     @Override
     protected void onAttach(AttachEvent attachEvent) {
         super.onAttach(attachEvent);
+        checkFeatureFlag();
         getElement().executeJs(
                 "Vaadin.FlowComponentHost.patchVirtualContainer(this);");
         customizeItemMovedEvent();
@@ -773,6 +778,41 @@ private static JsonArray getSectionItems(JsonArray items,
         return null;
     }
 
+    /**
+     * Checks whether the Dashboard component feature flag is active. Succeeds
+     * if the flag is enabled, and throws otherwise.
+     *
+     * @throws ExperimentalFeatureException
+     *             when the {@link FeatureFlags#DASHBOARD_COMPONENT} feature is
+     *             not enabled
+     */
+    private void checkFeatureFlag() {
+        boolean enabled = featureFlagEnabled || getFeatureFlags()
+                .isEnabled(FeatureFlags.DASHBOARD_COMPONENT);
+        if (!enabled) {
+            throw new ExperimentalFeatureException();
+        }
+    }
+
+    /**
+     * Gets the feature flags for the current UI.
+     * <p>
+     * Not private in order to support mocking
+     *
+     * @return the current set of feature flags
+     */
+    FeatureFlags getFeatureFlags() {
+        return FeatureFlags
+                .get(UI.getCurrent().getSession().getService().getContext());
+    }
+
+    /**
+     * Only for test use.
+     */
+    void setFeatureFlagEnabled(boolean featureFlagEnabled) {
+        this.featureFlagEnabled = featureFlagEnabled;
+    }
+
     /**
      * The internationalization properties for {@link Dashboard}.
      */

vaadin-dashboard-flow-parent/vaadin-dashboard-flow/src/main/java/com/vaadin/flow/component/dashboard/DashboardWidget.java

@@ -8,8 +8,11 @@
  */
 package com.vaadin.flow.component.dashboard;
 
+import com.vaadin.experimental.FeatureFlags;
+import com.vaadin.flow.component.AttachEvent;
 import com.vaadin.flow.component.Component;
 import com.vaadin.flow.component.Tag;
+import com.vaadin.flow.component.UI;
 import com.vaadin.flow.component.dependency.JsModule;
 import com.vaadin.flow.component.dependency.NpmPackage;
 import com.vaadin.flow.component.shared.SlotUtils;
@@ -34,6 +37,8 @@ public class DashboardWidget extends Component {
 
     private int rowspan = 1;
 
+    private boolean featureFlagEnabled;
+
     /**
      * Returns the title of the widget.
      *
@@ -176,6 +181,12 @@ public boolean isVisible() {
         return true;
     }
 
+    @Override
+    protected void onAttach(AttachEvent attachEvent) {
+        super.onAttach(attachEvent);
+        checkFeatureFlag();
+    }
+
     private void notifyParentDashboardOrSection() {
         getParent().ifPresent(parent -> {
             if (parent instanceof Dashboard dashboard) {
@@ -185,4 +196,39 @@ private void notifyParentDashboardOrSection() {
             }
         });
     }
+
+    /**
+     * Checks whether the Dashboard component feature flag is active. Succeeds
+     * if the flag is enabled, and throws otherwise.
+     *
+     * @throws ExperimentalFeatureException
+     *             when the {@link FeatureFlags#DASHBOARD_COMPONENT} feature is
+     *             not enabled
+     */
+    private void checkFeatureFlag() {
+        boolean enabled = featureFlagEnabled || getFeatureFlags()
+                .isEnabled(FeatureFlags.DASHBOARD_COMPONENT);
+        if (!enabled) {
+            throw new ExperimentalFeatureException();
+        }
+    }
+
+    /**
+     * Gets the feature flags for the current UI.
+     * <p>
+     * Not private in order to support mocking
+     *
+     * @return the current set of feature flags
+     */
+    FeatureFlags getFeatureFlags() {
+        return FeatureFlags
+                .get(UI.getCurrent().getSession().getService().getContext());
+    }
+
+    /**
+     * Only for test use.
+     */
+    void setFeatureFlagEnabled(boolean featureFlagEnabled) {
+        this.featureFlagEnabled = featureFlagEnabled;
+    }
 }

vaadin-dashboard-flow-parent/vaadin-dashboard-flow/src/main/java/com/vaadin/flow/component/dashboard/ExperimentalFeatureException.java

@@ -0,0 +1,26 @@
+/**
+ * Copyright 2000-2024 Vaadin Ltd.
+ *
+ * This program is available under Vaadin Commercial License and Service Terms.
+ *
+ * See {@literal <https://vaadin.com/commercial-license-and-service-terms>} for the full
+ * license.
+ */
+package com.vaadin.flow.component.dashboard;
+
+/**
+ * An exception which is thrown when somebody attempts to use {@link Dashboard}
+ * or {@link DashboardWidget} components without activating the associated
+ * feature flag first.
+ *
+ * @author Vaadin Ltd
+ */
+public class ExperimentalFeatureException extends RuntimeException {
+    public ExperimentalFeatureException() {
+        super("The Dashboard component is currently an experimental feature and needs to be "
+                + "explicitly enabled. The component can be enabled using Copilot, in the "
+                + "experimental features tab, or by adding a "
+                + "`src/main/resources/vaadin-featureflags.properties` file with the following content: "
+                + "`com.vaadin.experimental.dashboardComponent=true`");
+    }
+}

vaadin-dashboard-flow-parent/vaadin-dashboard-flow/src/test/java/com/vaadin/flow/component/dashboard/tests/DashboardItemMoveTest.java renamed to vaadin-dashboard-flow-parent/vaadin-dashboard-flow/src/test/java/com/vaadin/flow/component/dashboard/DashboardItemMoveTest.java

@@ -6,7 +6,7 @@
  * See {@literal <https://vaadin.com/commercial-license-and-service-terms>} for the full
  * license.
  */
-package com.vaadin.flow.component.dashboard.tests;
+package com.vaadin.flow.component.dashboard;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -20,9 +20,6 @@
 import org.junit.Test;
 
 import com.vaadin.flow.component.Component;
-import com.vaadin.flow.component.dashboard.Dashboard;
-import com.vaadin.flow.component.dashboard.DashboardSection;
-import com.vaadin.flow.component.dashboard.DashboardWidget;
 
 import elemental.json.Json;
 import elemental.json.JsonArray;
@@ -37,11 +34,13 @@ public class DashboardItemMoveTest extends DashboardTestBase {
     @Override
     public void setup() {
         super.setup();
-        dashboard = new Dashboard();
-        dashboard.add(new DashboardWidget(), new DashboardWidget());
+        dashboard = getNewDashboard();
+        dashboard.setFeatureFlagEnabled(true);
+        dashboard.add(getNewWidget(), getNewWidget());
         dashboard.setEditable(true);
         DashboardSection section = dashboard.addSection();
-        section.add(new DashboardWidget(), new DashboardWidget());
+
+        section.add(getNewWidget(), getNewWidget());
         getUi().add(dashboard);
         fakeClientCommunication();
         itemsArray = getItemsArray(dashboard.getChildren().toList());

vaadin-dashboard-flow-parent/vaadin-dashboard-flow/src/test/java/com/vaadin/flow/component/dashboard/tests/DashboardItemResizeTest.java renamed to vaadin-dashboard-flow-parent/vaadin-dashboard-flow/src/test/java/com/vaadin/flow/component/dashboard/DashboardItemResizeTest.java

@@ -6,7 +6,7 @@
  * See {@literal <https://vaadin.com/commercial-license-and-service-terms>} for the full
  * license.
  */
-package com.vaadin.flow.component.dashboard.tests;
+package com.vaadin.flow.component.dashboard;
 
 import java.util.List;
 import java.util.concurrent.atomic.AtomicInteger;
@@ -17,9 +17,6 @@
 import org.junit.Test;
 
 import com.vaadin.flow.component.Component;
-import com.vaadin.flow.component.dashboard.Dashboard;
-import com.vaadin.flow.component.dashboard.DashboardSection;
-import com.vaadin.flow.component.dashboard.DashboardWidget;
 
 public class DashboardItemResizeTest extends DashboardTestBase {
     private Dashboard dashboard;
@@ -28,11 +25,11 @@ public class DashboardItemResizeTest extends DashboardTestBase {
     @Override
     public void setup() {
         super.setup();
-        dashboard = new Dashboard();
-        dashboard.add(new DashboardWidget());
+        dashboard = getNewDashboard();
+        dashboard.add(getNewWidget());
         dashboard.setEditable(true);
         DashboardSection section = dashboard.addSection();
-        section.add(new DashboardWidget());
+        section.add(getNewWidget());
         getUi().add(dashboard);
         fakeClientCommunication();
     }

vaadin-dashboard-flow-parent/vaadin-dashboard-flow/src/test/java/com/vaadin/flow/component/dashboard/tests/DashboardSerializableTest.java renamed to vaadin-dashboard-flow-parent/vaadin-dashboard-flow/src/test/java/com/vaadin/flow/component/dashboard/DashboardSerializableTest.java

@@ -6,7 +6,7 @@
  * See {@literal <https://vaadin.com/commercial-license-and-service-terms>} for the full
  * license.
  */
-package com.vaadin.flow.component.dashboard.tests;
+package com.vaadin.flow.component.dashboard;
 
 import com.vaadin.flow.testutil.ClassesSerializableTest;