Skip to content

Commit c29a2ac

Browse files
authored
feat!: Use Jackson in flow-data package (#22122)
* feat!: Use Jackson in flow-data package. Fixes #21153
1 parent 6f91592 commit c29a2ac

19 files changed

Lines changed: 1374 additions & 90 deletions

‎flow-data/src/main/java/com/vaadin/flow/data/provider/ArrayUpdater.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
import java.io.Serializable;
1919
import java.util.List;
2020

21+
import com.fasterxml.jackson.databind.JsonNode;
22+
2123
import elemental.json.JsonValue;
2224

2325
/**
@@ -55,7 +57,7 @@ public interface Update extends Serializable {
5557
* @param items
5658
* the items to set
5759
*/
58-
void set(int start, List<JsonValue> items);
60+
void set(int start, List<JsonNode> items);
5961

6062
/**
6163
* Commits changes for the given {@code updateId}.

‎flow-data/src/main/java/com/vaadin/flow/data/provider/BeanDataGenerator.java‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,11 @@
1515
*/
1616
package com.vaadin.flow.data.provider;
1717

18-
import com.vaadin.flow.internal.JsonSerializer;
18+
import com.fasterxml.jackson.databind.JsonNode;
19+
import com.fasterxml.jackson.databind.node.ObjectNode;
1920

20-
import elemental.json.JsonObject;
21-
import elemental.json.JsonValue;
21+
import com.vaadin.flow.internal.JacksonSerializer;
22+
import com.vaadin.flow.internal.JacksonUtils;
2223

2324
/**
2425
* A {@link DataGenerator} that sends all the fields of the objects in the model
@@ -44,12 +45,12 @@
4445
public class BeanDataGenerator<T> implements DataGenerator<T> {
4546

4647
@Override
47-
public void generateData(T item, JsonObject data) {
48-
JsonValue value = JsonSerializer.toJson(item);
49-
if (value instanceof JsonObject) {
50-
JsonObject object = (JsonObject) value;
51-
for (String key : object.keys()) {
52-
data.put(key, (JsonValue) object.get(key));
48+
public void generateData(T item, ObjectNode data) {
49+
JsonNode value = JacksonSerializer.toJson(item);
50+
if (value instanceof ObjectNode) {
51+
ObjectNode object = (ObjectNode) value;
52+
for (String key : JacksonUtils.getKeys(object)) {
53+
data.put(key, object.get(key));
5354
}
5455
} else {
5556
data.put("value", value);

‎flow-data/src/main/java/com/vaadin/flow/data/provider/CompositeDataGenerator.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
import java.util.LinkedHashSet;
1919
import java.util.Set;
2020

21-
import com.vaadin.flow.shared.Registration;
21+
import com.fasterxml.jackson.databind.node.ObjectNode;
2222

23-
import elemental.json.JsonObject;
23+
import com.vaadin.flow.shared.Registration;
2424

2525
/**
2626
* A {@link DataGenerator} that aggregates multiple DataGenerators and delegates
@@ -42,7 +42,7 @@ public class CompositeDataGenerator<T>
4242
final Set<DataGenerator<T>> dataGenerators = new LinkedHashSet<>();
4343

4444
@Override
45-
public void generateData(T item, JsonObject jsonObject) {
45+
public void generateData(T item, ObjectNode jsonObject) {
4646
dataGenerators
4747
.forEach(generator -> generator.generateData(item, jsonObject));
4848
}

‎flow-data/src/main/java/com/vaadin/flow/data/provider/DataCommunicator.java‎

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@
3333
import java.util.stream.Collectors;
3434
import java.util.stream.Stream;
3535

36+
import com.fasterxml.jackson.databind.JsonNode;
37+
import com.fasterxml.jackson.databind.node.ArrayNode;
38+
import com.fasterxml.jackson.databind.node.ObjectNode;
3639
import org.slf4j.Logger;
3740
import org.slf4j.LoggerFactory;
3841

@@ -46,7 +49,7 @@
4649
import com.vaadin.flow.function.SerializableConsumer;
4750
import com.vaadin.flow.function.SerializableSupplier;
4851
import com.vaadin.flow.internal.ExecutionContext;
49-
import com.vaadin.flow.internal.JsonUtils;
52+
import com.vaadin.flow.internal.JacksonUtils;
5053
import com.vaadin.flow.internal.NodeOwner;
5154
import com.vaadin.flow.internal.NullOwner;
5255
import com.vaadin.flow.internal.Range;
@@ -55,15 +58,10 @@
5558
import com.vaadin.flow.shared.Registration;
5659
import com.vaadin.flow.shared.communication.PushMode;
5760

58-
import elemental.json.Json;
59-
import elemental.json.JsonArray;
60-
import elemental.json.JsonObject;
61-
import elemental.json.JsonValue;
62-
6361
/**
6462
* DataProvider base class. This class is the base for all DataProvider
6563
* communication implementations. It uses data generators ({@link BiFunction}s)
66-
* to write {@link JsonObject}s representing each data object to be sent to the
64+
* to write {@link ObjectNode}s representing each data object to be sent to the
6765
* client-side.
6866
*
6967
* @param <T>
@@ -79,7 +77,7 @@ public class DataCommunicator<T> implements Serializable {
7977

8078
private final DataGenerator<T> dataGenerator;
8179
private final ArrayUpdater arrayUpdater;
82-
private final SerializableConsumer<JsonArray> dataUpdater;
80+
private final SerializableConsumer<ArrayNode> dataUpdater;
8381
private final StateNode stateNode;
8482

8583
// Keys that can be discarded once some specific update id gets confirmed
@@ -281,7 +279,7 @@ public void accept(T t) {
281279
*/
282280
public DataCommunicator(DataGenerator<T> dataGenerator,
283281
ArrayUpdater arrayUpdater,
284-
SerializableConsumer<JsonArray> dataUpdater, StateNode stateNode) {
282+
SerializableConsumer<ArrayNode> dataUpdater, StateNode stateNode) {
285283
this(dataGenerator, arrayUpdater, dataUpdater, stateNode, true);
286284
}
287285

@@ -309,7 +307,7 @@ public DataCommunicator(DataGenerator<T> dataGenerator,
309307
*/
310308
public DataCommunicator(DataGenerator<T> dataGenerator,
311309
ArrayUpdater arrayUpdater,
312-
SerializableConsumer<JsonArray> dataUpdater, StateNode stateNode,
310+
SerializableConsumer<ArrayNode> dataUpdater, StateNode stateNode,
313311
boolean fetchEnabled) {
314312
this.dataGenerator = dataGenerator;
315313
this.arrayUpdater = arrayUpdater;
@@ -1353,7 +1351,7 @@ private void flushUpdatedData() {
13531351
return;
13541352
}
13551353
dataUpdater.accept(updatedData.stream().map(this::generateJson)
1356-
.collect(JsonUtils.asArray()));
1354+
.collect(JacksonUtils.asArray()));
13571355
updatedData.clear();
13581356
}
13591357

@@ -1495,7 +1493,7 @@ private Activation collectKeysToFlush(final Range previousActive,
14951493
}
14961494
}
14971495

1498-
private List<JsonValue> getJsonItems(Range range) {
1496+
private List<JsonNode> getJsonItems(Range range) {
14991497
return range.stream()
15001498
.mapToObj(index -> activeKeyOrder.get(index - activeStart))
15011499
.map(keyMapper::get).map(this::generateJson)
@@ -1541,8 +1539,8 @@ private Activation activate(Range range) {
15411539
return new Activation(activeKeys, needsSizeRecheck);
15421540
}
15431541

1544-
private JsonValue generateJson(T item) {
1545-
JsonObject json = Json.createObject();
1542+
private JsonNode generateJson(T item) {
1543+
ObjectNode json = JacksonUtils.createObjectNode();
15461544
json.put("key", getKeyMapper().key(item));
15471545
dataGenerator.generateData(item, json);
15481546
return json;

‎flow-data/src/main/java/com/vaadin/flow/data/provider/DataGenerator.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
import java.io.Serializable;
1919

20-
import elemental.json.JsonObject;
20+
import com.fasterxml.jackson.databind.node.ObjectNode;
2121

2222
/**
2323
* A data generator for {@link DataCommunicator}. Used to inject custom data to
@@ -33,7 +33,7 @@
3333
public interface DataGenerator<T> extends Serializable {
3434

3535
/**
36-
* Adds custom data for the given item to its serialized {@code JsonObject}
36+
* Adds custom data for the given item to its serialized {@code ObjectNode}
3737
* representation. This JSON object will be sent to client-side
3838
* DataProvider.
3939
*
@@ -42,7 +42,7 @@ public interface DataGenerator<T> extends Serializable {
4242
* @param jsonObject
4343
* the JSON object being sent to the client
4444
*/
45-
void generateData(T item, JsonObject jsonObject);
45+
void generateData(T item, ObjectNode jsonObject);
4646

4747
/**
4848
* Informs the {@code DataGenerator} that the given data item has been

‎flow-data/src/main/java/com/vaadin/flow/data/provider/hierarchy/HierarchicalDataCommunicator.java‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727
import java.util.Set;
2828
import java.util.stream.Stream;
2929

30+
import com.fasterxml.jackson.databind.JsonNode;
31+
import com.fasterxml.jackson.databind.node.ObjectNode;
32+
3033
import com.vaadin.flow.data.provider.ArrayUpdater;
3134
import com.vaadin.flow.data.provider.CompositeDataGenerator;
3235
import com.vaadin.flow.data.provider.DataChangeEvent;
@@ -39,14 +42,10 @@
3942
import com.vaadin.flow.function.SerializableSupplier;
4043
import com.vaadin.flow.function.ValueProvider;
4144
import com.vaadin.flow.internal.ExecutionContext;
45+
import com.vaadin.flow.internal.JacksonUtils;
4246
import com.vaadin.flow.internal.Range;
4347
import com.vaadin.flow.internal.StateNode;
4448

45-
import elemental.json.Json;
46-
import elemental.json.JsonArray;
47-
import elemental.json.JsonObject;
48-
import elemental.json.JsonValue;
49-
5049
/**
5150
* WARNING: Direct use of this class in application code is not recommended and
5251
* may result in unexpected behavior. Use the API provided by the component
@@ -459,8 +458,8 @@ public boolean hasExpandedItems() {
459458
return !expandedItemIds.isEmpty();
460459
}
461460

462-
private JsonValue generateItemJson(T item) {
463-
JsonObject json = Json.createObject();
461+
private JsonNode generateItemJson(T item) {
462+
ObjectNode json = JacksonUtils.createObjectNode();
464463
json.put("key", getKeyMapper().key(item));
465464
dataGenerator.generateData(item, json);
466465
return json;

‎flow-data/src/test/java/com/vaadin/flow/data/provider/AbstractComponentDataGeneratorTest.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package com.vaadin.flow.data.provider;
1717

18+
import com.fasterxml.jackson.databind.node.ObjectNode;
1819
import org.junit.Test;
1920

2021
import com.vaadin.flow.component.Component;
@@ -23,15 +24,13 @@
2324
import com.vaadin.flow.dom.Element;
2425
import com.vaadin.flow.dom.ElementFactory;
2526

26-
import elemental.json.JsonObject;
27-
2827
public class AbstractComponentDataGeneratorTest {
2928

3029
private static class TestComponentDataGenerator
3130
extends AbstractComponentDataGenerator<String> {
3231

3332
@Override
34-
public void generateData(String item, JsonObject jsonObject) {
33+
public void generateData(String item, ObjectNode jsonObject) {
3534
}
3635

3736
@Override

‎flow-data/src/test/java/com/vaadin/flow/data/provider/AbstractLazyDataViewTest.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
import com.vaadin.flow.component.Component;
2525
import com.vaadin.flow.component.Tag;
2626
import com.vaadin.flow.tests.data.bean.Item;
27+
28+
import com.fasterxml.jackson.databind.JsonNode;
2729
import org.junit.Assert;
2830
import org.junit.Before;
2931
import org.junit.Rule;
@@ -33,8 +35,6 @@
3335
import org.mockito.Mockito;
3436
import org.mockito.MockitoAnnotations;
3537

36-
import elemental.json.JsonValue;
37-
3838
public class AbstractLazyDataViewTest {
3939

4040
private static final String ITEM1 = "foo";
@@ -70,7 +70,7 @@ public void clear(int start, int length) {
7070
}
7171

7272
@Override
73-
public void set(int start, List<JsonValue> items) {
73+
public void set(int start, List<JsonNode> items) {
7474

7575
}
7676

‎flow-data/src/test/java/com/vaadin/flow/data/provider/CompositeDataGeneratorTest.java‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,14 @@
1919
import java.util.Arrays;
2020
import java.util.List;
2121

22+
import com.fasterxml.jackson.databind.node.ObjectNode;
2223
import org.hamcrest.CoreMatchers;
2324
import org.junit.Assert;
2425
import org.junit.Test;
2526

27+
import com.vaadin.flow.internal.JacksonUtils;
2628
import com.vaadin.flow.shared.Registration;
2729

28-
import elemental.json.Json;
29-
import elemental.json.JsonObject;
30-
3130
import static org.junit.Assert.assertEquals;
3231

3332
/**
@@ -50,7 +49,7 @@ public MockDataGenerator(String jsonKey, String jsonValue) {
5049
}
5150

5251
@Override
53-
public void generateData(String item, JsonObject jsonObject) {
52+
public void generateData(String item, ObjectNode jsonObject) {
5453
jsonObject.put(jsonKey, jsonValue);
5554
processed.add(item);
5655
}
@@ -94,12 +93,12 @@ public void generateData_innerGeneratorsAreInvoked() {
9493
composite.addDataGenerator(mock2);
9594
composite.addDataGenerator(mock3);
9695

97-
JsonObject json = Json.createObject();
96+
ObjectNode json = JacksonUtils.createObjectNode();
9897
composite.generateData("item1", json);
9998

100-
Assert.assertEquals("value1", json.getString("mock1"));
101-
Assert.assertEquals("value2", json.getString("mock2"));
102-
Assert.assertEquals("value3", json.getString("mock3"));
99+
Assert.assertEquals("value1", json.get("mock1").asText());
100+
Assert.assertEquals("value2", json.get("mock2").asText());
101+
Assert.assertEquals("value3", json.get("mock3").asText());
103102
Assert.assertThat(mock1.getProcessed(), CoreMatchers.hasItem("item1"));
104103
Assert.assertThat(mock2.getProcessed(), CoreMatchers.hasItem("item1"));
105104
Assert.assertThat(mock3.getProcessed(), CoreMatchers.hasItem("item1"));
@@ -136,9 +135,9 @@ public void destroyData_innerGeneratorsAreInvoked() {
136135
composite.addDataGenerator(mock2);
137136
composite.addDataGenerator(mock3);
138137

139-
composite.generateData("item1", Json.createObject());
138+
composite.generateData("item1", JacksonUtils.createObjectNode());
140139
composite.refreshData("item1");
141-
composite.generateData("item2", Json.createObject());
140+
composite.generateData("item2", JacksonUtils.createObjectNode());
142141
composite.refreshData("item2");
143142
composite.destroyData("item1");
144143

@@ -165,9 +164,9 @@ public void destroyAllData_innerGeneratorsAreInvoked() {
165164
composite.addDataGenerator(mock2);
166165
composite.addDataGenerator(mock3);
167166

168-
composite.generateData("item1", Json.createObject());
167+
composite.generateData("item1", JacksonUtils.createObjectNode());
169168
composite.refreshData("item1");
170-
composite.generateData("item2", Json.createObject());
169+
composite.generateData("item2", JacksonUtils.createObjectNode());
171170
composite.refreshData("item2");
172171
composite.destroyAllData();
173172

@@ -185,7 +184,7 @@ public void dataGeneratorRegistration_remove_dataIsDestroyed() {
185184
Registration registration1 = composite.addDataGenerator(mock1);
186185
Registration registration2 = composite.addDataGenerator(mock2);
187186

188-
composite.generateData("item1", Json.createObject());
187+
composite.generateData("item1", JacksonUtils.createObjectNode());
189188
Assert.assertThat(mock1.getProcessed(), CoreMatchers.hasItem("item1"));
190189
Assert.assertThat(mock2.getProcessed(), CoreMatchers.hasItem("item1"));
191190

@@ -202,9 +201,9 @@ public void dataGeneratorRegistration_remove_dataIsDestroyed() {
202201
@Test
203202
public void addDataGenerator_orderIsPreserved() {
204203
CompositeDataGenerator<String> cdg = new CompositeDataGenerator<>();
205-
DataGenerator<String> dg1 = (String, JsonObject) -> {
204+
DataGenerator<String> dg1 = (String, ObjectNode) -> {
206205
};
207-
DataGenerator<String> dg2 = (String, JsonObject) -> {
206+
DataGenerator<String> dg2 = (String, ObjectNode) -> {
208207
};
209208
List<DataGenerator<String>> expected = Arrays.asList(dg1, dg2);
210209
cdg.addDataGenerator(dg1);

‎flow-data/src/test/java/com/vaadin/flow/data/provider/DataCommunicatorAsyncTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
import java.util.stream.IntStream;
1212
import java.util.stream.Stream;
1313

14+
import com.fasterxml.jackson.databind.JsonNode;
1415
import org.junit.Assert;
1516
import org.junit.Before;
1617
import org.junit.Test;
@@ -29,7 +30,6 @@
2930
import com.vaadin.flow.server.VaadinServletService;
3031
import com.vaadin.flow.server.VaadinSession;
3132
import com.vaadin.flow.shared.communication.PushMode;
32-
import elemental.json.JsonValue;
3333

3434
@RunWith(Parameterized.class)
3535
public class DataCommunicatorAsyncTest {
@@ -121,7 +121,7 @@ public void clear(int start, int length) {
121121
}
122122

123123
@Override
124-
public void set(int start, List<JsonValue> items) {
124+
public void set(int start, List<JsonNode> items) {
125125
lastSet = Range.withLength(start, items.size());
126126
}
127127

0 commit comments

Comments
 (0)