chore!: Change Dependency.toJson() to return Jackson ObjectNode (#22653)

Artur- · web-flow · commit 698fc8a90212 · 2025-11-04T06:48:58.000+01:00
Server-side code now uses Jackson's automatic bean serialization via valueToTree(). Client-side GWT tests use helper methods to manually construct elemental JSON when needed for testing.
diff --git a/flow-client/src/test-gwt/java/com/vaadin/client/GwtDependencyLoaderTest.java b/flow-client/src/test-gwt/java/com/vaadin/client/GwtDependencyLoaderTest.java
@@ -33,6 +33,8 @@
 import elemental.json.JsonArray;
 import elemental.json.JsonObject;
 
+import static com.vaadin.client.DependencyTestHelper.createDependencyJson;
+
 /**
  * This class is used to test {@link DependencyLoader} GWT functionality, that
  * is required to process dependencies with load mode {@link LoadMode#LAZY}.
@@ -151,15 +153,15 @@ public void testAllEagerDependenciesAreLoadedFirst() {
         String lazyCssUrl = "https://foo.bar/style.css";
 
         new DependencyLoader(registry).loadDependencies(createDependenciesMap(
-                new Dependency(Dependency.Type.JAVASCRIPT, lazyJsUrl,
-                        LoadMode.LAZY).toJson(),
-                new Dependency(Dependency.Type.STYLESHEET, lazyCssUrl,
-                        LoadMode.LAZY).toJson(),
+                createDependencyJson(Dependency.Type.JAVASCRIPT, lazyJsUrl,
+                        LoadMode.LAZY),
+                createDependencyJson(Dependency.Type.STYLESHEET, lazyCssUrl,
+                        LoadMode.LAZY),
 
-                new Dependency(Dependency.Type.JAVASCRIPT, eagerJsUrl,
-                        LoadMode.EAGER).toJson(),
-                new Dependency(Dependency.Type.STYLESHEET, eagerCssUrl,
-                        LoadMode.EAGER).toJson()));
+                createDependencyJson(Dependency.Type.JAVASCRIPT, eagerJsUrl,
+                        LoadMode.EAGER),
+                createDependencyJson(Dependency.Type.STYLESHEET, eagerCssUrl,
+                        LoadMode.EAGER)));
 
         assertEquals(Arrays.asList(eagerJsUrl, lazyJsUrl),
                 mockResourceLoader.loadingScripts);
@@ -176,14 +178,14 @@ public void testEnsureLazyDependenciesLoadedInOrder() {
         String cssUrl2 = "/2.css";
 
         new DependencyLoader(registry).loadDependencies(createDependenciesMap(
-                new Dependency(Dependency.Type.JAVASCRIPT, jsUrl1,
-                        LoadMode.LAZY).toJson(),
-                new Dependency(Dependency.Type.JAVASCRIPT, jsUrl2,
-                        LoadMode.LAZY).toJson(),
-                new Dependency(Dependency.Type.STYLESHEET, cssUrl1,
-                        LoadMode.LAZY).toJson(),
-                new Dependency(Dependency.Type.STYLESHEET, cssUrl2,
-                        LoadMode.LAZY).toJson()));
+                createDependencyJson(Dependency.Type.JAVASCRIPT, jsUrl1,
+                        LoadMode.LAZY),
+                createDependencyJson(Dependency.Type.JAVASCRIPT, jsUrl2,
+                        LoadMode.LAZY),
+                createDependencyJson(Dependency.Type.STYLESHEET, cssUrl1,
+                        LoadMode.LAZY),
+                createDependencyJson(Dependency.Type.STYLESHEET, cssUrl2,
+                        LoadMode.LAZY)));
 
         assertEquals(
                 "jsUrl1 should come before jsUrl2, because it was added earlier",
@@ -208,17 +210,17 @@ public void testDependenciesWithAllLoadModesAreProcessed() {
         new DependencyLoader(registry).loadDependencies(createDependenciesMap(
                 createInlineDependency(Dependency.Type.JAVASCRIPT,
                         inlineJsContents),
-                new Dependency(Dependency.Type.JAVASCRIPT, lazyJsUrl,
-                        LoadMode.LAZY).toJson(),
-                new Dependency(Dependency.Type.JAVASCRIPT, eagerJsUrl,
-                        LoadMode.EAGER).toJson(),
+                createDependencyJson(Dependency.Type.JAVASCRIPT, lazyJsUrl,
+                        LoadMode.LAZY),
+                createDependencyJson(Dependency.Type.JAVASCRIPT, eagerJsUrl,
+                        LoadMode.EAGER),
 
                 createInlineDependency(Dependency.Type.STYLESHEET,
                         inlineCssContents),
-                new Dependency(Dependency.Type.STYLESHEET, lazyCssUrl,
-                        LoadMode.LAZY).toJson(),
-                new Dependency(Dependency.Type.STYLESHEET, eagerCssUrl,
-                        LoadMode.EAGER).toJson()));
+                createDependencyJson(Dependency.Type.STYLESHEET, lazyCssUrl,
+                        LoadMode.LAZY),
+                createDependencyJson(Dependency.Type.STYLESHEET, eagerCssUrl,
+                        LoadMode.EAGER)));
 
         // When multiple LoadModes are used, no guarantees on the order can be
         // made except
@@ -264,8 +266,7 @@ private JsonArray mergeArrays(JsonArray jsonArray1, JsonArray jsonArray2) {
 
     private JsonObject createInlineDependency(Dependency.Type dependencyType,
             String contents) {
-        JsonObject json = new Dependency(dependencyType, "", LoadMode.INLINE)
-                .toJson();
+        JsonObject json = createDependencyJson(dependencyType, "", LoadMode.INLINE);
         json.remove(Dependency.KEY_URL);
         json.put(Dependency.KEY_CONTENTS, contents);
         return json;
diff --git a/flow-client/src/test/java/com/vaadin/client/DependencyLoaderTest.java b/flow-client/src/test/java/com/vaadin/client/DependencyLoaderTest.java
@@ -31,6 +31,7 @@
 import elemental.json.JsonArray;
 import elemental.json.JsonObject;
 
+import static com.vaadin.client.DependencyTestHelper.createDependencyJson;
 import static org.junit.Assert.assertEquals;
 
 /**
@@ -139,9 +140,9 @@ public void inlineStyleSheet(String styleSheetContents,
     public void loadStylesheet() {
         String TEST_URL = "http://foo.bar/baz";
 
-        new DependencyLoader(registry).loadDependencies(
-                createDependenciesMap(new Dependency(Dependency.Type.STYLESHEET,
-                        TEST_URL, LoadMode.EAGER).toJson()));
+        new DependencyLoader(registry)
+                .loadDependencies(createDependenciesMap(createDependencyJson(
+                        Dependency.Type.STYLESHEET, TEST_URL, LoadMode.EAGER)));
 
         assertEquals(Collections.singletonList(TEST_URL),
                 mockResourceLoader.loadingStyles);
@@ -151,9 +152,9 @@ public void loadStylesheet() {
     public void loadScript() {
         String TEST_URL = "http://foo.bar/baz.js";
 
-        new DependencyLoader(registry).loadDependencies(
-                createDependenciesMap(new Dependency(Dependency.Type.JAVASCRIPT,
-                        TEST_URL, LoadMode.EAGER).toJson()));
+        new DependencyLoader(registry)
+                .loadDependencies(createDependenciesMap(createDependencyJson(
+                        Dependency.Type.JAVASCRIPT, TEST_URL, LoadMode.EAGER)));
 
         assertEquals(Collections.singletonList(TEST_URL),
                 mockResourceLoader.loadingScripts);
@@ -166,12 +167,12 @@ public void loadMultiple() {
         String TEST_CSS_URL = "https://x.yz/styles.css";
 
         new DependencyLoader(registry).loadDependencies(createDependenciesMap(
-                new Dependency(Dependency.Type.JAVASCRIPT, TEST_JS_URL,
-                        LoadMode.EAGER).toJson(),
-                new Dependency(Dependency.Type.JAVASCRIPT, TEST_JS_URL2,
-                        LoadMode.EAGER).toJson(),
-                new Dependency(Dependency.Type.STYLESHEET, TEST_CSS_URL,
-                        LoadMode.EAGER).toJson()));
+                createDependencyJson(Dependency.Type.JAVASCRIPT, TEST_JS_URL,
+                        LoadMode.EAGER),
+                createDependencyJson(Dependency.Type.JAVASCRIPT, TEST_JS_URL2,
+                        LoadMode.EAGER),
+                createDependencyJson(Dependency.Type.STYLESHEET, TEST_CSS_URL,
+                        LoadMode.EAGER)));
 
         assertEquals(Arrays.asList(TEST_JS_URL, TEST_JS_URL2),
                 mockResourceLoader.loadingScripts);
@@ -187,14 +188,14 @@ public void ensureEagerDependenciesLoadedInOrder() {
         String cssUrl2 = "/2.css";
 
         new DependencyLoader(registry).loadDependencies(createDependenciesMap(
-                new Dependency(Dependency.Type.JAVASCRIPT, jsUrl1,
-                        LoadMode.EAGER).toJson(),
-                new Dependency(Dependency.Type.JAVASCRIPT, jsUrl2,
-                        LoadMode.EAGER).toJson(),
-                new Dependency(Dependency.Type.STYLESHEET, cssUrl1,
-                        LoadMode.EAGER).toJson(),
-                new Dependency(Dependency.Type.STYLESHEET, cssUrl2,
-                        LoadMode.EAGER).toJson()));
+                createDependencyJson(Dependency.Type.JAVASCRIPT, jsUrl1,
+                        LoadMode.EAGER),
+                createDependencyJson(Dependency.Type.JAVASCRIPT, jsUrl2,
+                        LoadMode.EAGER),
+                createDependencyJson(Dependency.Type.STYLESHEET, cssUrl1,
+                        LoadMode.EAGER),
+                createDependencyJson(Dependency.Type.STYLESHEET, cssUrl2,
+                        LoadMode.EAGER)));
 
         assertEquals(
                 "jsUrl1 should come before jsUrl2, because it was added earlier",
@@ -264,8 +265,8 @@ private JsonArray mergeArrays(JsonArray jsonArray1, JsonArray jsonArray2) {
 
     private JsonObject createInlineDependency(Dependency.Type dependencyType,
             String contents) {
-        JsonObject json = new Dependency(dependencyType, "", LoadMode.INLINE)
-                .toJson();
+        JsonObject json = createDependencyJson(dependencyType, "",
+                LoadMode.INLINE);
         json.remove(Dependency.KEY_URL);
         json.put(Dependency.KEY_CONTENTS, contents);
         return json;
diff --git a/flow-client/src/test/java/com/vaadin/client/DependencyTestHelper.java b/flow-client/src/test/java/com/vaadin/client/DependencyTestHelper.java
@@ -0,0 +1,86 @@
+/*
+ * Copyright 2000-2025 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.client;
+
+import com.vaadin.flow.shared.ui.Dependency;
+import com.vaadin.flow.shared.ui.LoadMode;
+
+import elemental.json.Json;
+import elemental.json.JsonObject;
+
+/**
+ * Test helper for creating Dependency JSON objects. Since Dependency no longer
+ * has toJson() method, this helper provides convenient methods for tests to
+ * create JSON representations.
+ */
+public class DependencyTestHelper {
+
+    /**
+     * Converts a Dependency object to its JSON representation.
+     *
+     * @param dependency
+     *            the dependency to convert
+     * @return JSON representation of the dependency
+     */
+    public static JsonObject dependencyToJson(Dependency dependency) {
+        JsonObject json = Json.createObject();
+        json.put(Dependency.KEY_URL, dependency.getUrl());
+        json.put(Dependency.KEY_TYPE, dependency.getType().name());
+        json.put(Dependency.KEY_LOAD_MODE, dependency.getLoadMode().name());
+        if (dependency.getId() != null) {
+            json.put(Dependency.KEY_ID, dependency.getId());
+        }
+        return json;
+    }
+
+    /**
+     * Creates a JSON representation of a dependency with the given parameters.
+     * Convenience method that creates a Dependency object and converts it to
+     * JSON.
+     *
+     * @param type
+     *            the dependency type
+     * @param url
+     *            the dependency URL
+     * @param loadMode
+     *            the load mode
+     * @return JSON representation of the dependency
+     */
+    public static JsonObject createDependencyJson(Dependency.Type type,
+            String url, LoadMode loadMode) {
+        return dependencyToJson(new Dependency(type, url, loadMode));
+    }
+
+    /**
+     * Creates a JSON representation of a dependency with the given parameters
+     * and ID. Convenience method that creates a Dependency object and converts
+     * it to JSON.
+     *
+     * @param type
+     *            the dependency type
+     * @param url
+     *            the dependency URL
+     * @param loadMode
+     *            the load mode
+     * @param id
+     *            the dependency ID
+     * @return JSON representation of the dependency
+     */
+    public static JsonObject createDependencyJson(Dependency.Type type,
+            String url, LoadMode loadMode, String id) {
+        return dependencyToJson(new Dependency(type, url, loadMode, id));
+    }
+}
diff --git a/flow-server/src/main/java/com/vaadin/flow/server/communication/UidlWriter.java b/flow-server/src/main/java/com/vaadin/flow/server/communication/UidlWriter.java
@@ -248,8 +248,8 @@ private static Map<LoadMode, ArrayNode> groupDependenciesByLoadMode(
 
     private static ObjectNode dependencyToJson(Dependency dependency,
             ResolveContext context) {
-        ObjectNode dependencyJson = JacksonUtils
-                .mapElemental(dependency.toJson());
+        ObjectNode dependencyJson = JacksonUtils.getMapper()
+                .valueToTree(dependency);
         if (dependency.getLoadMode() == LoadMode.INLINE) {
             dependencyJson.put(Dependency.KEY_CONTENTS,
                     getDependencyContents(dependency.getUrl(), context));
diff --git a/flow-server/src/main/java/com/vaadin/flow/shared/ui/Dependency.java b/flow-server/src/main/java/com/vaadin/flow/shared/ui/Dependency.java
@@ -19,9 +19,6 @@
 import java.util.Objects;
 import java.util.stream.Stream;
 
-import elemental.json.Json;
-import elemental.json.JsonObject;
-
 /**
  * Represents an html import, stylesheet or JavaScript to include on the page.
  *
@@ -32,7 +29,7 @@ public class Dependency implements Serializable {
 
     public static final String KEY_URL = "url";
     public static final String KEY_TYPE = "type";
-    public static final String KEY_LOAD_MODE = "mode";
+    public static final String KEY_LOAD_MODE = "loadMode";
     public static final String KEY_CONTENTS = "contents";
     public static final String KEY_ID = "id";
 
@@ -169,22 +166,6 @@ public String getId() {
         return id;
     }
 
-    /**
-     * Converts the object into json representation.
-     *
-     * @return json representation of the object
-     */
-    public JsonObject toJson() {
-        JsonObject jsonObject = Json.createObject();
-        jsonObject.put(KEY_URL, url);
-        jsonObject.put(KEY_TYPE, type.name());
-        jsonObject.put(KEY_LOAD_MODE, loadMode.name());
-        if (id != null) {
-            jsonObject.put(KEY_ID, id);
-        }
-        return jsonObject;
-    }
-
     @Override
     public int hashCode() {
         return Objects.hash(type, url, loadMode, id);
diff --git a/flow-server/src/test/java/com/vaadin/flow/internal/nodefeature/DependencyListTest.java b/flow-server/src/test/java/com/vaadin/flow/internal/nodefeature/DependencyListTest.java
@@ -122,17 +122,17 @@ private void validateDependency(String url, Type dependencyType,
         expectedJson.put(Dependency.KEY_TYPE, dependencyType.name());
         expectedJson.put(Dependency.KEY_LOAD_MODE, loadMode.name());
 
-        elemental.json.JsonObject actualJson = dependency.toJson();
-        ObjectNode actualMapped = JacksonUtils.mapElemental(actualJson);
+        ObjectNode actualJson = JacksonUtils.getMapper()
+                .valueToTree(dependency);
 
         // Remove the ID field from comparison since it's auto-generated for
         // some dependencies
-        actualMapped.remove(Dependency.KEY_ID);
+        actualJson.remove(Dependency.KEY_ID);
 
         assertTrue(String.format(
                 "Dependencies' json representations are different, expected = \n'%s'\n, actual = \n'%s'",
-                expectedJson.toString(), actualMapped.toString()),
-                JacksonUtils.jsonEquals(expectedJson, actualMapped));
+                expectedJson.toString(), actualJson.toString()),
+                JacksonUtils.jsonEquals(expectedJson, actualJson));
     }
 
     @Test
diff --git a/flow-server/src/test/java/com/vaadin/flow/shared/ui/DependencyTest.java b/flow-server/src/test/java/com/vaadin/flow/shared/ui/DependencyTest.java
@@ -17,8 +17,9 @@
 
 import org.hamcrest.CoreMatchers;
 import org.junit.Test;
+import tools.jackson.databind.JsonNode;
 
-import elemental.json.JsonObject;
+import com.vaadin.flow.internal.JacksonUtils;
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.core.Is.is;
@@ -61,20 +62,20 @@ public void checkJsonSerialization_2ArgsCTor() {
     }
 
     private void assertDependency(Dependency dependency) {
-        JsonObject dependencyJson = dependency.toJson();
+        JsonNode dependencyJson = JacksonUtils.createNode(dependency);
 
         assertThat("No contents should be present in json now",
-                dependencyJson.hasKey(Dependency.KEY_CONTENTS), is(false));
+                dependencyJson.has(Dependency.KEY_CONTENTS), is(false));
         assertThat(
                 "Dependency type should match corresponding enum name in pojo",
-                dependencyJson.getString(Dependency.KEY_TYPE),
+                dependencyJson.get(Dependency.KEY_TYPE).asText(),
                 is(dependency.getType().name()));
         assertThat("Dependency url should match corresponding url in pojo",
-                dependencyJson.getString(Dependency.KEY_URL),
+                dependencyJson.get(Dependency.KEY_URL).asText(),
                 is(dependency.getUrl()));
         assertThat(
                 "Dependency load mode should match corresponding enum name in pojo",
-                dependencyJson.getString(Dependency.KEY_LOAD_MODE),
+                dependencyJson.get(Dependency.KEY_LOAD_MODE).asText(),
                 is(dependency.getLoadMode().name()));
     }
 
