feat: Router parts to jackson (#21100)

caalador · web-flow · commit 2ad796b2cb9c · 2025-03-11T09:37:06.000+01:00
* feat: Router parts to jackson

Use jackson for router
and navigation.

* remove import

* Code and import cleanup
diff --git a/flow-server/src/main/java/com/vaadin/flow/component/EventData.java b/flow-server/src/main/java/com/vaadin/flow/component/EventData.java
@@ -23,8 +23,6 @@
 
 import com.vaadin.flow.dom.DomListenerRegistration;
 
-import elemental.json.JsonValue;
-
 /**
  * Maps data from a DOM event to a {@link ComponentEvent}.
  * <p>
@@ -39,9 +37,10 @@
  * expression is passed back to the server and injected into the annotated
  * {@link ComponentEvent} constructor parameter.
  * <p>
- * Supported parameter types are {@link String}, {@link JsonValue},
- * {@link Integer}, {@link Double}, {@link Boolean} and their respective
- * primitive types.
+ * Supported parameter types are {@link String},
+ * {@link elemental.json.JsonValue},
+ * {@link com.fasterxml.jackson.databind.JsonNode}, {@link Integer},
+ * {@link Double}, {@link Boolean} and their respective primitive types.
  *
  * @see DomEvent
  * @see DomListenerRegistration#addEventData(String)
diff --git a/flow-server/src/main/java/com/vaadin/flow/component/internal/UIInternals.java b/flow-server/src/main/java/com/vaadin/flow/component/internal/UIInternals.java
@@ -33,6 +33,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import com.fasterxml.jackson.databind.node.BaseJsonNode;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -54,6 +55,7 @@
 import com.vaadin.flow.dom.impl.BasicElementStateProvider;
 import com.vaadin.flow.function.SerializableConsumer;
 import com.vaadin.flow.internal.ConstantPool;
+import com.vaadin.flow.internal.JacksonCodec;
 import com.vaadin.flow.internal.JsonCodec;
 import com.vaadin.flow.internal.StateNode;
 import com.vaadin.flow.internal.StateTree;
@@ -84,6 +86,8 @@
 import com.vaadin.flow.shared.Registration;
 import com.vaadin.flow.shared.communication.PushMode;
 
+import elemental.json.JsonValue;
+
 /**
  * Holds UI-specific methods and data which are intended for internal use by the
  * framework.
@@ -130,7 +134,11 @@ public JavaScriptInvocation(String expression,
              */
             for (Object argument : parameters) {
                 // Throws IAE for unsupported types
-                JsonCodec.encodeWithTypeInfo(argument);
+                if (argument instanceof JsonValue) {
+                    JsonCodec.encodeWithTypeInfo(argument);
+                } else {
+                    JacksonCodec.encodeWithTypeInfo(argument);
+                }
             }
 
             this.expression = expression;
@@ -1131,7 +1139,7 @@ public void refreshCurrentRoute(boolean refreshRouteChain) {
                     + "Unable to refresh the current route.");
         } else {
             getRouter().navigate(ui, locationForRefresh,
-                    NavigationTrigger.REFRESH_ROUTE, null, true,
+                    NavigationTrigger.REFRESH_ROUTE, (BaseJsonNode) null, true,
                     refreshRouteChain || hasModalComponent());
         }
     }
diff --git a/flow-server/src/main/java/com/vaadin/flow/router/ErrorNavigationEvent.java b/flow-server/src/main/java/com/vaadin/flow/router/ErrorNavigationEvent.java
@@ -15,6 +15,8 @@
  */
 package com.vaadin.flow.router;
 
+import com.fasterxml.jackson.databind.node.BaseJsonNode;
+
 import com.vaadin.flow.component.UI;
 
 import elemental.json.JsonValue;
@@ -69,6 +71,7 @@ public ErrorNavigationEvent(Router router, Location location, UI ui,
      *            includes navigation state info including for example the
      *            scroll position and the complete href of the RouterLink
      */
+    @Deprecated
     public ErrorNavigationEvent(Router router, Location location, UI ui,
             NavigationTrigger trigger, ErrorParameter<?> errorParameter,
             JsonValue state) {
@@ -77,6 +80,32 @@ public ErrorNavigationEvent(Router router, Location location, UI ui,
         this.errorParameter = errorParameter;
     }
 
+    /**
+     * Creates a new navigation event.
+     *
+     * @param router
+     *            the router handling the navigation, not {@code null}
+     * @param location
+     *            the new location, not {@code null}
+     * @param ui
+     *            the UI in which the navigation occurs, not {@code null}
+     * @param trigger
+     *            the type of user action that triggered this navigation event,
+     *            not {@code null}
+     * @param errorParameter
+     *            parameter containing navigation error information
+     * @param state
+     *            includes navigation state info including for example the
+     *            scroll position and the complete href of the RouterLink
+     */
+    public ErrorNavigationEvent(Router router, Location location, UI ui,
+            NavigationTrigger trigger, ErrorParameter<?> errorParameter,
+            BaseJsonNode state) {
+        super(router, location, ui, trigger, state, false);
+
+        this.errorParameter = errorParameter;
+    }
+
     /**
      * Gets the ErrorParameter if set.
      *
diff --git a/flow-server/src/main/java/com/vaadin/flow/router/NavigationEvent.java b/flow-server/src/main/java/com/vaadin/flow/router/NavigationEvent.java
@@ -18,7 +18,10 @@
 import java.util.EventObject;
 import java.util.Optional;
 
+import com.fasterxml.jackson.databind.node.BaseJsonNode;
+
 import com.vaadin.flow.component.UI;
+import com.vaadin.flow.internal.JacksonUtils;
 
 import elemental.json.JsonValue;
 
@@ -33,7 +36,7 @@ public class NavigationEvent extends EventObject {
     private final UI ui;
     private final NavigationTrigger trigger;
     private boolean forwardTo = false;
-    private JsonValue state = null;
+    private BaseJsonNode state = null;
     private boolean forceInstantiation = false;
     private boolean recreateLayoutChain = false;
 
@@ -82,11 +85,12 @@ public NavigationEvent(Router router, Location location, UI ui,
      *            indicates if this event is created as a result of
      *            {@link BeforeEvent#forwardTo} or not
      */
+    @Deprecated
     public NavigationEvent(Router router, Location location, UI ui,
             NavigationTrigger trigger, JsonValue state, boolean forwardTo) {
         this(router, location, ui, trigger);
 
-        this.state = state;
+        this.state = JacksonUtils.mapElemental(state);
         this.forwardTo = forwardTo;
     }
 
@@ -116,11 +120,76 @@ public NavigationEvent(Router router, Location location, UI ui,
      *            navigation target will be re-instantiated. Requires
      *            {@code forceInstantiation} to be true to have an effect.
      */
+    @Deprecated
     public NavigationEvent(Router router, Location location, UI ui,
             NavigationTrigger trigger, JsonValue state, boolean forwardTo,
             boolean forceInstantiation, boolean recreateLayoutChain) {
         this(router, location, ui, trigger);
 
+        this.state = JacksonUtils.mapElemental(state);
+        this.forwardTo = forwardTo;
+        this.forceInstantiation = forceInstantiation;
+        this.recreateLayoutChain = recreateLayoutChain;
+    }
+
+    /**
+     * Creates a new navigation event.
+     *
+     * @param router
+     *            the router handling the navigation, not {@code null}
+     * @param location
+     *            the new location, not {@code null}
+     * @param ui
+     *            the UI in which the navigation occurs, not {@code null}
+     * @param trigger
+     *            the type of user action that triggered this navigation event,
+     *            not {@code null}
+     * @param state
+     *            includes navigation state info including for example the
+     *            scroll position and the complete href of the RouterLink
+     * @param forwardTo
+     *            indicates if this event is created as a result of
+     *            {@link BeforeEvent#forwardTo} or not
+     */
+    public NavigationEvent(Router router, Location location, UI ui,
+            NavigationTrigger trigger, BaseJsonNode state, boolean forwardTo) {
+        this(router, location, ui, trigger);
+
+        this.state = state;
+        this.forwardTo = forwardTo;
+    }
+
+    /**
+     * Creates a new navigation event.
+     *
+     * @param router
+     *            the router handling the navigation, not {@code null}
+     * @param location
+     *            the new location, not {@code null}
+     * @param ui
+     *            the UI in which the navigation occurs, not {@code null}
+     * @param trigger
+     *            the type of user action that triggered this navigation event,
+     *            not {@code null}
+     * @param state
+     *            includes navigation state info including for example the
+     *            scroll position and the complete href of the RouterLink
+     * @param forwardTo
+     *            indicates if this event is created as a result of
+     *            {@link BeforeEvent#forwardTo} or not
+     * @param forceInstantiation
+     *            if set to {@code true}, the navigation target will always be
+     *            instantiated
+     * @param recreateLayoutChain
+     *            if set to {@code true}, the complete layout chain up to the
+     *            navigation target will be re-instantiated. Requires
+     *            {@code forceInstantiation} to be true to have an effect.
+     */
+    public NavigationEvent(Router router, Location location, UI ui,
+            NavigationTrigger trigger, BaseJsonNode state, boolean forwardTo,
+            boolean forceInstantiation, boolean recreateLayoutChain) {
+        this(router, location, ui, trigger);
+
         this.state = state;
         this.forwardTo = forwardTo;
         this.forceInstantiation = forceInstantiation;
@@ -166,7 +235,7 @@ public NavigationTrigger getTrigger() {
      *
      * @return the navigation state
      */
-    public Optional<JsonValue> getState() {
+    public Optional<BaseJsonNode> getState() {
         return state == null ? Optional.empty() : Optional.of(state);
     }
 
diff --git a/flow-server/src/main/java/com/vaadin/flow/router/Router.java b/flow-server/src/main/java/com/vaadin/flow/router/Router.java
@@ -20,6 +20,7 @@
 import java.util.Optional;
 
 import com.vaadin.flow.component.UI;
+import com.vaadin.flow.internal.JacksonUtils;
 import com.vaadin.flow.router.internal.DefaultRouteResolver;
 import com.vaadin.flow.router.internal.ErrorStateRenderer;
 import com.vaadin.flow.router.internal.ErrorTargetEntry;
@@ -34,6 +35,7 @@
 import com.vaadin.flow.server.VaadinService;
 import com.vaadin.flow.server.VaadinSession;
 
+import com.fasterxml.jackson.databind.node.BaseJsonNode;
 import org.slf4j.LoggerFactory;
 
 import elemental.json.JsonValue;
@@ -76,8 +78,10 @@ public Router(RouteRegistry registry) {
      *            the location object of the route
      */
     public void initializeUI(UI ui, Location location) {
-        ui.getPage().getHistory().setHistoryStateChangeHandler(e -> navigate(ui,
-                e.getLocation(), e.getTrigger(), e.getState().orElse(null)));
+        ui.getPage().getHistory()
+                .setHistoryStateChangeHandler(e -> navigate(ui, e.getLocation(),
+                        e.getTrigger(),
+                        JacksonUtils.mapElemental(e.getState().orElse(null))));
 
         int statusCode = navigate(ui, location, NavigationTrigger.PAGE_LOAD);
 
@@ -164,7 +168,7 @@ public Optional<NavigationState> resolveRouteNotFoundNavigationTarget() {
      * @see UI#navigate(String, QueryParameters)
      */
     public int navigate(UI ui, Location location, NavigationTrigger trigger) {
-        return navigate(ui, location, trigger, null);
+        return navigate(ui, location, trigger, (BaseJsonNode) null);
     }
 
     /**
@@ -189,7 +193,7 @@ public int navigate(UI ui, Location location, NavigationTrigger trigger) {
      * @see UI#navigate(String, QueryParameters)
      */
     public int navigate(UI ui, Location location, NavigationTrigger trigger,
-            JsonValue state) {
+            BaseJsonNode state) {
         return navigate(ui, location, trigger, state, false, false);
     }
 
@@ -222,7 +226,7 @@ public int navigate(UI ui, Location location, NavigationTrigger trigger,
      * @see UI#navigate(String, QueryParameters)
      */
     public int navigate(UI ui, Location location, NavigationTrigger trigger,
-            JsonValue state, boolean forceInstantiation,
+            BaseJsonNode state, boolean forceInstantiation,
             boolean recreateLayoutChain) {
         assert ui != null;
         assert location != null;
@@ -243,6 +247,69 @@ public int navigate(UI ui, Location location, NavigationTrigger trigger,
         return HttpStatusCode.NOT_MODIFIED.getCode();
     }
 
+    /**
+     * Navigates the given UI to the given location. For internal use only.
+     * <p>
+     * This method pushes to the browser history if the <code>trigger</code> is
+     * {@link NavigationTrigger#ROUTER_LINK} or
+     * {@link NavigationTrigger#UI_NAVIGATE}.
+     *
+     * @param ui
+     *            the UI to update, not <code>null</code>
+     * @param location
+     *            the location to navigate to, not <code>null</code>
+     * @param trigger
+     *            the type of user action that triggered this navigation, not
+     *            <code>null</code>
+     * @param state
+     *            includes navigation state info including for example the
+     *            scroll position and the complete href of the RouterLink
+     * @return the HTTP status code resulting from the navigation
+     * @see UI#navigate(String)
+     * @see UI#navigate(String, QueryParameters)
+     */
+    @Deprecated
+    public int navigate(UI ui, Location location, NavigationTrigger trigger,
+            JsonValue state) {
+        return navigate(ui, location, trigger, state, false, false);
+    }
+
+    /**
+     * Navigates the given UI to the given location. For internal use only.
+     * <p>
+     * This method pushes to the browser history if the <code>trigger</code> is
+     * {@link NavigationTrigger#ROUTER_LINK} or
+     * {@link NavigationTrigger#UI_NAVIGATE}.
+     *
+     * @param ui
+     *            the UI to update, not <code>null</code>
+     * @param location
+     *            the location to navigate to, not <code>null</code>
+     * @param trigger
+     *            the type of user action that triggered this navigation, not
+     *            <code>null</code>
+     * @param state
+     *            includes navigation state info including for example the
+     *            scroll position and the complete href of the RouterLink
+     * @param forceInstantiation
+     *            if set to {@code true}, the navigation target will always be
+     *            instantiated
+     * @param recreateLayoutChain
+     *            if set to {@code true}, the complete layout chain up to the
+     *            navigation target will be re-instantiated. Requires
+     *            {@code forceInstantiation} to be true to have an effect.
+     * @return the HTTP status code resulting from the navigation
+     * @see UI#navigate(String)
+     * @see UI#navigate(String, QueryParameters)
+     */
+    @Deprecated
+    public int navigate(UI ui, Location location, NavigationTrigger trigger,
+            JsonValue state, boolean forceInstantiation,
+            boolean recreateLayoutChain) {
+        return navigate(ui, location, trigger, JacksonUtils.mapElemental(state),
+                forceInstantiation, recreateLayoutChain);
+    }
+
     private boolean handleNavigationForLocation(UI ui, Location location) {
         if (ui.getInternals().hasLastHandledLocation()) {
             return !location.getPathWithQueryParameters()
@@ -253,7 +320,7 @@ private boolean handleNavigationForLocation(UI ui, Location location) {
     }
 
     private int handleNavigation(UI ui, Location location,
-            NavigationTrigger trigger, JsonValue state,
+            NavigationTrigger trigger, BaseJsonNode state,
             boolean forceInstantiation, boolean recreateLayoutChain) {
         NavigationState newState = getRouteResolver()
                 .resolve(new ResolveRequest(this, location));
@@ -284,7 +351,8 @@ private int handleNavigation(UI ui, Location location,
     }
 
     private int handleExceptionNavigation(UI ui, Location location,
-            Exception exception, NavigationTrigger trigger, JsonValue state) {
+            Exception exception, NavigationTrigger trigger,
+            BaseJsonNode state) {
         Optional<ErrorTargetEntry> maybeLookupResult = getErrorNavigationTarget(
                 exception);
 
diff --git a/flow-server/src/main/java/com/vaadin/flow/router/internal/AbstractNavigationStateRenderer.java b/flow-server/src/main/java/com/vaadin/flow/router/internal/AbstractNavigationStateRenderer.java
diff --git a/flow-server/src/test/java/com/vaadin/flow/router/internal/NavigationStateRendererTest.java b/flow-server/src/test/java/com/vaadin/flow/router/internal/NavigationStateRendererTest.java
