Skip to content

Commit 29d99a8

Browse files
author
Pekka Hyvönen
authored
feat: add support for @eventdata of type Component (#12334)
Makes it possible to use event data expressions that map to any Component / Element from server side state tree. For example it will be possible to use: - `@EventData("event.target") Component eventTarget` for `@DomEvent` - `@EventData("event.target") Element eventTarget` for `@DomEvent` - `DomEventRegistration::addEventDataElement(String expression)` to get any element mapped, - and fetch it with `DomEvent::getEventDataElement(String expression) Follow up for #11992, #3356
1 parent 7276d67 commit 29d99a8

19 files changed

Lines changed: 1051 additions & 124 deletions

File tree

‎flow-client/src/main/java/com/vaadin/client/flow/StateTree.java‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import com.vaadin.client.flow.collection.JsArray;
2323
import com.vaadin.client.flow.collection.JsCollections;
2424
import com.vaadin.client.flow.collection.JsMap;
25+
import com.vaadin.client.flow.dom.DomNode;
2526
import com.vaadin.client.flow.nodefeature.MapProperty;
2627
import com.vaadin.client.flow.nodefeature.NodeList;
2728
import com.vaadin.client.flow.nodefeature.NodeMap;
@@ -153,6 +154,28 @@ public void prepareForResync() {
153154
});
154155
}
155156

157+
/**
158+
* Returns the state node in the tree for the given dom node or {@code null}
159+
* if none found.
160+
* <p>
161+
* Comparison is done with Node.isSameNode() method which is same as
162+
* {@code ===} comparison.
163+
*
164+
* @param domNode
165+
* the dom node to find state node for
166+
* @return the state node or null
167+
*/
168+
public StateNode getStateNodeForDomNode(DomNode domNode) {
169+
final JsArray<StateNode> stateNodes = idToNode.mapValues();
170+
for (int i = 0; i < stateNodes.length(); i++) {
171+
StateNode stateNode = stateNodes.get(i);
172+
if (domNode.isSameNode(stateNode.getDomNode())) {
173+
return stateNode;
174+
}
175+
}
176+
return null;
177+
}
178+
156179
private void clearLists(StateNode stateNode) {
157180
stateNode.forEachFeature((feature, featureId) -> {
158181
if (feature instanceof NodeList) {

‎flow-client/src/main/java/com/vaadin/client/flow/binding/SimpleElementBindingStrategy.java‎

Lines changed: 86 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222

2323
import com.google.gwt.core.client.JavaScriptObject;
2424
import com.google.gwt.core.client.Scheduler;
25-
2625
import com.vaadin.client.ApplicationConfiguration;
2726
import com.vaadin.client.Command;
2827
import com.vaadin.client.Console;
@@ -1256,27 +1255,41 @@ private void handleDomEvent(Event event, BindingContext context) {
12561255
eventData = null;
12571256
} else {
12581257
eventData = Json.createObject();
1258+
}
1259+
for (String expressionString : expressions) {
1260+
if (expressionString
1261+
.startsWith(JsonConstants.SYNCHRONIZE_PROPERTY_TOKEN)) {
1262+
String property = expressionString.substring(
1263+
JsonConstants.SYNCHRONIZE_PROPERTY_TOKEN.length());
1264+
synchronizeProperties.add(property);
1265+
} else if (expressionString
1266+
.equals(JsonConstants.MAP_STATE_NODE_EVENT_DATA)) {
1267+
// map event.target to the closest state node
1268+
int targetNodeId = getClosestStateNodeIdToEventTarget(node,
1269+
event.getTarget());
1270+
eventData.put(JsonConstants.MAP_STATE_NODE_EVENT_DATA,
1271+
targetNodeId);
1272+
} else if (expressionString
1273+
.startsWith(JsonConstants.MAP_STATE_NODE_EVENT_DATA)) {
1274+
// map element returned by JS to the closest state node
1275+
String jsEvaluation = expressionString.substring(
1276+
JsonConstants.MAP_STATE_NODE_EVENT_DATA.length());
1277+
EventExpression expression = getOrCreateExpression(
1278+
jsEvaluation);
1279+
JsonValue expressionValue = expression.evaluate(event,
1280+
(Element) element);
1281+
// find the closest state node matching the expression value
1282+
int targetNodeId = getClosestStateNodeIdToDomNode(
1283+
node.getTree(), expressionValue, jsEvaluation);
1284+
eventData.put(expressionString, targetNodeId);
1285+
} else {
1286+
EventExpression expression = getOrCreateExpression(
1287+
expressionString);
12591288

1260-
for (String expressionString : expressions) {
1261-
if (expressionString
1262-
.startsWith(JsonConstants.SYNCHRONIZE_PROPERTY_TOKEN)) {
1263-
String property = expressionString.substring(
1264-
JsonConstants.SYNCHRONIZE_PROPERTY_TOKEN.length());
1265-
synchronizeProperties.add(property);
1266-
} else if (expressionString
1267-
.equals(JsonConstants.MAP_EVENT_TARGET)) {
1268-
int targetNodeId = getClosestStateNodeToTarget(node,
1269-
event.getTarget());
1270-
eventData.put(JsonConstants.MAP_EVENT_TARGET, targetNodeId);
1271-
} else {
1272-
EventExpression expression = getOrCreateExpression(
1273-
expressionString);
1274-
1275-
JsonValue expressionValue = expression.evaluate(event,
1276-
(Element) element);
1289+
JsonValue expressionValue = expression.evaluate(event,
1290+
(Element) element);
12771291

1278-
eventData.put(expressionString, expressionValue);
1279-
}
1292+
eventData.put(expressionString, expressionValue);
12801293
}
12811294
}
12821295

@@ -1466,42 +1479,81 @@ private static EventExpression getOrCreateExpression(
14661479
}
14671480

14681481
// This method could be moved somewhere to be reusable
1469-
private int getClosestStateNodeToTarget(StateNode topNode,
1482+
private int getClosestStateNodeIdToEventTarget(StateNode topNode,
14701483
EventTarget target) {
1484+
if (target == null) {
1485+
return -1;
1486+
}
14711487
try {
14721488
DomNode targetNode = DomApi.wrap(WidgetUtil.crazyJsCast(target));
1473-
1474-
// collect children and test eagerly for direct match
14751489
JsArray<StateNode> stack = JsCollections.array();
14761490
stack.push(topNode);
1491+
1492+
// collect children and test eagerly for direct match
14771493
for (int i = 0; i < stack.length(); i++) {
14781494
final StateNode stateNode = stack.get(i);
14791495
if (targetNode.isSameNode(stateNode.getDomNode())) {
14801496
return stateNode.getId();
14811497
}
1498+
// NOTE: for now not looking at virtual children on purpose.
1499+
// If needed (?), those can be included here to the search stack
14821500
stateNode.getList(NodeFeatures.ELEMENT_CHILDREN)
14831501
.forEach(child -> stack.push((StateNode) child));
14841502
}
14851503
// no direct match, all child element state nodes collected.
14861504
// bottom-up search elements until matching state node found
14871505
targetNode = DomApi.wrap(targetNode.getParentNode());
1488-
while (targetNode != null
1489-
&& !targetNode.isSameNode(topNode.getDomNode())) {
1490-
for (int i = stack.length() - 1; i > -1; i--) {
1491-
final StateNode stateNode = stack.get(i);
1492-
if (targetNode.isSameNode(stateNode.getDomNode())) {
1493-
return stateNode.getId();
1494-
}
1506+
return getStateNodeForElement(stack, targetNode);
1507+
} catch (Exception e) {
1508+
// not going to let event handling fail; just report nothing found
1509+
Console.debug(
1510+
"An error occurred when Flow tried to find a state node matching the element "
1511+
+ target + ", which was the event.target. Error: "
1512+
+ e.getMessage());
1513+
}
1514+
return -1; // no match / error;
1515+
}
1516+
1517+
private static int getStateNodeForElement(JsArray<StateNode> searchStack,
1518+
DomNode targetNode) {
1519+
while (targetNode != null) {
1520+
for (int i = searchStack.length() - 1; i > -1; i--) {
1521+
final StateNode stateNode = searchStack.get(i);
1522+
if (targetNode.isSameNode(stateNode.getDomNode())) {
1523+
return stateNode.getId();
1524+
}
1525+
}
1526+
targetNode = DomApi.wrap(targetNode.getParentNode());
1527+
}
1528+
return -1;
1529+
}
1530+
1531+
private int getClosestStateNodeIdToDomNode(StateTree stateTree,
1532+
Object domNodeReference, String eventDataExpression) {
1533+
if (domNodeReference == null) {
1534+
return -1;
1535+
}
1536+
try {
1537+
DomNode targetNode = DomApi
1538+
.wrap(WidgetUtil.crazyJsCast(domNodeReference));
1539+
while (targetNode != null) {
1540+
StateNode stateNodeForDomNode = stateTree
1541+
.getStateNodeForDomNode(targetNode);
1542+
if (stateNodeForDomNode != null) {
1543+
return stateNodeForDomNode.getId();
14951544
}
14961545
targetNode = DomApi.wrap(targetNode.getParentNode());
14971546
}
14981547
} catch (Exception e) {
14991548
// not going to let event handling fail; just report nothing found
15001549
Console.debug(
1501-
"Flow could not detect state node matching event.target");
1550+
"An error occurred when Flow tried to find a state node matching the element "
1551+
+ domNodeReference
1552+
+ ", returned by an event data expression "
1553+
+ eventDataExpression + ". Error: "
1554+
+ e.getMessage());
15021555
}
1503-
// no match / error; not considering topNode as it is reported as
1504-
// event.currentTarget
1505-
return -1;
1556+
return -1; // no match / error;
15061557
}
1558+
15071559
}

‎flow-server/src/main/java/com/vaadin/flow/component/ComponentEventBus.java‎

Lines changed: 82 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import java.util.LinkedHashMap;
2424
import java.util.List;
2525
import java.util.Objects;
26+
import java.util.Optional;
2627
import java.util.function.Consumer;
2728

2829
import com.vaadin.flow.dom.DebouncePhase;
@@ -269,7 +270,15 @@ private <T extends ComponentEvent<?>> void addDomTrigger(Class<T> eventType,
269270

270271
LinkedHashMap<String, Class<?>> eventDataExpressions = ComponentEventBusUtil
271272
.getEventDataExpressions(eventType);
272-
eventDataExpressions.keySet().forEach(registration::addEventData);
273+
274+
eventDataExpressions.forEach((expression, type) -> {
275+
if (Component.class.isAssignableFrom(type)
276+
|| type == Element.class) {
277+
registration.addEventDataElement(expression);
278+
} else {
279+
registration.addEventData(expression);
280+
}
281+
});
273282

274283
if (!"".equals(filter)) {
275284
registration.setFilter(filter);
@@ -291,7 +300,8 @@ private <T extends ComponentEvent<?>> void addDomTrigger(Class<T> eventType,
291300

292301
/**
293302
* Creates a list of data objects which can be passed to the constructor
294-
* returned by {@link #getEventConstructor(Class)} as parameters 3+.
303+
* returned by {@link ComponentEventBusUtil#getEventConstructor(Class)} as
304+
* parameters 3+.
295305
*
296306
* @param domEvent
297307
* the DOM event containing the data
@@ -307,16 +317,81 @@ private List<Object> createEventDataObjects(DomEvent domEvent,
307317
LinkedHashMap<String, Class<?>> expressions = ComponentEventBusUtil
308318
.getEventDataExpressions(eventType);
309319
expressions.forEach((expression, type) -> {
310-
JsonValue jsonValue = domEvent.getEventData().get(expression);
311-
if (jsonValue == null) {
312-
jsonValue = Json.createNull();
320+
if (Component.class.isAssignableFrom(type)
321+
|| type == Element.class) {
322+
eventDataObjects.add(parseStateNodeIdToComponentReference(
323+
domEvent, type, expression));
324+
} else {
325+
JsonValue jsonValue = domEvent.getEventData().get(expression);
326+
if (jsonValue == null) {
327+
jsonValue = Json.createNull();
328+
}
329+
Object value = JsonCodec.decodeAs(jsonValue, type);
330+
eventDataObjects.add(value);
313331
}
314-
Object value = JsonCodec.decodeAs(jsonValue, type);
315-
eventDataObjects.add(value);
316332
});
317333
return eventDataObjects;
318334
}
319335

336+
private Object parseStateNodeIdToComponentReference(DomEvent event,
337+
Class<?> expectedEventDataType, String eventDataExpression) {
338+
assert Component.class.isAssignableFrom(expectedEventDataType)
339+
|| Element.class == expectedEventDataType;
340+
341+
final Element mappedElement = event
342+
.getEventDataElement(eventDataExpression).orElse(null);
343+
344+
if (expectedEventDataType == Element.class || mappedElement == null) {
345+
return mappedElement;
346+
} else {
347+
final Optional<Component> componentMaybe = mappedElement
348+
.getComponent();
349+
if (componentMaybe.isPresent()) {
350+
final Component mappedComponent = componentMaybe.get();
351+
if (expectedEventDataType
352+
.isAssignableFrom(mappedComponent.getClass())) {
353+
return mappedComponent;
354+
} else {
355+
throw new IllegalStateException(String.format(
356+
"Error when trying to map event data for event '%s' "
357+
+ "in component %s from browser: the event data expression '%s'"
358+
+ " was mapped to an element with tag '%s' and "
359+
+ "node-id '%s', but it is mapped to a "
360+
+ "component of type '%s' instead of the "
361+
+ "expected type of %s.%n"
362+
+ "Either the event data expression returns the"
363+
+ " wrong element, or the type for the "
364+
+ "'@EventType(\"%s\")' should be changed from "
365+
+ "%s to %s",
366+
event.getType(),
367+
component.getClass().getSimpleName(),
368+
eventDataExpression, mappedElement.getTag(),
369+
mappedElement.getNode().getId(),
370+
mappedComponent.getClass().getSimpleName(),
371+
expectedEventDataType.getSimpleName(),
372+
eventDataExpression,
373+
mappedComponent.getClass().getSimpleName(),
374+
expectedEventDataType.getSimpleName()));
375+
}
376+
} else {
377+
throw new IllegalStateException(String.format(
378+
"Error when trying to map event data for event '%s' "
379+
+ "in component %s from browser: the event data expression '%s'"
380+
+ " was mapped to an element with tag '%s' and "
381+
+ "node-id '%s', but it doesn't have a "
382+
+ "component instance mapped to it.%n"
383+
+ "Either the event data expression returns the"
384+
+ " wrong element, or the type for the "
385+
+ "'@EventType(\"%s\")' should be changed from "
386+
+ "%s to Element",
387+
event.getType(), component.getClass().getSimpleName(),
388+
eventDataExpression, mappedElement.getTag(),
389+
mappedElement.getNode().getId(), eventDataExpression,
390+
expectedEventDataType));
391+
}
392+
}
393+
}
394+
320395
/**
321396
* Removes the given listener for the given event type.
322397
* <p>

‎flow-server/src/main/java/com/vaadin/flow/component/ComponentEventBusUtil.java‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,10 +170,12 @@ private static <T extends ComponentEvent<?>> Constructor<T> findEventConstructor
170170
eventDataConstructor = c;
171171
} else {
172172
throw new IllegalArgumentException(
173-
"Multiple DOM event constructors annotated with @"
173+
"More than one DOM event constructors annotated with @"
174174
+ EventData.class.getSimpleName()
175-
+ " found for " + eventType.getName() + ". "
176-
+ EVENT_CONSTRUCTOR_DEFINITION);
175+
+ " found for " + eventType.getName()
176+
+ ". There can be only one constructor with @"
177+
+ EventData.class.getSimpleName()
178+
+ " annotations present.");
177179
}
178180
}
179181
}

0 commit comments

Comments
 (0)