Skip to content

Commit 4797b06

Browse files
authored
[web] Fix drag failure when RMB pointer up event is not received (#22946)
1 parent 2cb3a30 commit 4797b06

3 files changed

Lines changed: 201 additions & 21 deletions

File tree

‎lib/web_ui/lib/src/engine/pointer_binding.dart‎

Lines changed: 128 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,13 @@ abstract class _BaseAdapter {
199199
}
200200

201201
if (_debugLogPointerEvents) {
202-
print(event.type);
202+
if (event is html.PointerEvent) {
203+
print('${event.type} '
204+
'${event.client.x.toStringAsFixed(1)},'
205+
'${event.client.y.toStringAsFixed(1)}');
206+
} else {
207+
print(event.type);
208+
}
203209
}
204210
// Report the event to semantics. This information is used to debounce
205211
// browser gestures. Semantics tells us whether it is safe to forward
@@ -381,6 +387,7 @@ class _ButtonSanitizer {
381387
}
382388

383389
_pressedButtons = _inferDownFlutterButtons(button, buttons);
390+
384391
return _SanitizedDetails(
385392
change: ui.PointerChange.down,
386393
buttons: _pressedButtons,
@@ -389,18 +396,6 @@ class _ButtonSanitizer {
389396

390397
_SanitizedDetails sanitizeMoveEvent({required int buttons}) {
391398
final int newPressedButtons = _htmlButtonsToFlutterButtons(buttons);
392-
// This could happen when the context menu is active and the user clicks
393-
// RMB somewhere else. The browser sends a down event with `buttons:0`.
394-
//
395-
// In this case, we keep the old `buttons` value so we don't confuse the
396-
// framework.
397-
if (_pressedButtons != 0 && newPressedButtons == 0) {
398-
return _SanitizedDetails(
399-
change: ui.PointerChange.move,
400-
buttons: _pressedButtons,
401-
);
402-
}
403-
404399
// This could happen when the user clicks RMB then moves the mouse quickly.
405400
// The brower sends a move event with `buttons:2` even though there's no
406401
// buttons down yet.
@@ -434,6 +429,30 @@ class _ButtonSanitizer {
434429
);
435430
}
436431

432+
_SanitizedDetails? sanitizeUpEventWithButtons({required int buttons}) {
433+
final int newPressedButtons = _htmlButtonsToFlutterButtons(buttons);
434+
// This could happen when the context menu is active and the user clicks
435+
// RMB somewhere else. The browser sends a down event with `buttons:0`.
436+
//
437+
// In this case, we keep the old `buttons` value so we don't confuse the
438+
// framework.
439+
if (_pressedButtons != 0 && newPressedButtons == 0) {
440+
return _SanitizedDetails(
441+
change: ui.PointerChange.move,
442+
buttons: _pressedButtons,
443+
);
444+
}
445+
446+
_pressedButtons = newPressedButtons;
447+
448+
return _SanitizedDetails(
449+
change: _pressedButtons == 0
450+
? ui.PointerChange.hover
451+
: ui.PointerChange.move,
452+
buttons: _pressedButtons,
453+
);
454+
}
455+
437456
_SanitizedDetails sanitizeCancelEvent() {
438457
_pressedButtons = 0;
439458
return _SanitizedDetails(
@@ -444,6 +463,7 @@ class _ButtonSanitizer {
444463
}
445464

446465
typedef _PointerEventListener = dynamic Function(html.PointerEvent event);
466+
const int kContextMenuButton = 2;
447467

448468
/// Adapter class to be used with browsers that support native pointer events.
449469
///
@@ -492,8 +512,16 @@ class _PointerAdapter extends _BaseAdapter with _WheelEventListenerMixin {
492512
_addPointerEventListener('pointerdown', (html.PointerEvent event) {
493513
final int device = event.pointerId!;
494514
final List<ui.PointerData> pointerData = <ui.PointerData>[];
515+
final _ButtonSanitizer sanitizer = _ensureSanitizer(device);
516+
if (event.button == kContextMenuButton) {
517+
_handleMissingRightMouseUpEvent(sanitizer,
518+
sanitizer._pressedButtons,
519+
sanitizer._pressedButtons & ~kContextMenuButton,
520+
event,
521+
pointerData);
522+
}
495523
final _SanitizedDetails details =
496-
_ensureSanitizer(device).sanitizeDownEvent(
524+
sanitizer.sanitizeDownEvent(
497525
button: event.button,
498526
buttons: event.buttons!,
499527
);
@@ -505,9 +533,19 @@ class _PointerAdapter extends _BaseAdapter with _WheelEventListenerMixin {
505533
final int device = event.pointerId!;
506534
final _ButtonSanitizer sanitizer = _ensureSanitizer(device);
507535
final List<ui.PointerData> pointerData = <ui.PointerData>[];
536+
final int buttonsBeforeEvent = sanitizer._pressedButtons;
508537
final Iterable<_SanitizedDetails> detailsList = _expandEvents(event).map(
509-
(html.PointerEvent expandedEvent) => sanitizer.sanitizeMoveEvent(buttons: expandedEvent.buttons!),
538+
(html.PointerEvent expandedEvent) {
539+
return sanitizer.sanitizeMoveEvent(buttons: expandedEvent.buttons!);
540+
},
510541
);
542+
_handleMissingRightMouseUpEvent(
543+
sanitizer,
544+
buttonsBeforeEvent,
545+
(sanitizer._inferDownFlutterButtons(event.button, event.buttons!)
546+
& kContextMenuButton),
547+
event,
548+
pointerData);
511549
for (_SanitizedDetails details in detailsList) {
512550
_convertEventsToPointerData(data: pointerData, event: event, details: details);
513551
}
@@ -541,6 +579,39 @@ class _PointerAdapter extends _BaseAdapter with _WheelEventListenerMixin {
541579
});
542580
}
543581

582+
// Handle special case where right mouse button no longer is pressed.
583+
// We need to synthesize right mouse up, otherwise drag gesture will fail
584+
// to complete or multiple RMB down events will lead to wrong state.
585+
void _handleMissingRightMouseUpEvent(_ButtonSanitizer sanitizer,
586+
int buttonsBeforeEvent, int buttonsAfterEvent, html.PointerEvent event,
587+
List<ui.PointerData> pointerData) {
588+
if ((buttonsBeforeEvent & kContextMenuButton) != 0 &&
589+
buttonsAfterEvent == 0) {
590+
final ui.PointerDeviceKind kind =
591+
_pointerTypeToDeviceKind(event.pointerType!);
592+
final int device = kind == ui.PointerDeviceKind.mouse
593+
? _mouseDeviceId : event.pointerId!;
594+
final double tilt = _computeHighestTilt(event);
595+
final Duration timeStamp = _BaseAdapter._eventTimeStampToDuration(event.timeStamp!);
596+
sanitizer._pressedButtons &= ~kContextMenuButton;
597+
_pointerDataConverter.convert(
598+
pointerData,
599+
change: ui.PointerChange.up,
600+
timeStamp: timeStamp,
601+
kind: kind,
602+
signalKind: ui.PointerSignalKind.none,
603+
device: device,
604+
physicalX: event.client.x.toDouble() * ui.window.devicePixelRatio,
605+
physicalY: event.client.y.toDouble() * ui.window.devicePixelRatio,
606+
buttons: sanitizer._pressedButtons,
607+
pressure: event.pressure as double,
608+
pressureMin: 0.0,
609+
pressureMax: 1.0,
610+
tilt: tilt,
611+
);
612+
}
613+
}
614+
544615
// For each event that is de-coalesced from `event` and described in
545616
// `details`, convert it to pointer data and store in `data`.
546617
void _convertEventsToPointerData({
@@ -782,6 +853,13 @@ class _MouseAdapter extends _BaseAdapter with _WheelEventListenerMixin {
782853
void setup() {
783854
_addMouseEventListener('mousedown', (html.MouseEvent event) {
784855
final List<ui.PointerData> pointerData = <ui.PointerData>[];
856+
if (event.button == kContextMenuButton) {
857+
_handleMissingRightMouseUpEvent(_sanitizer,
858+
_sanitizer._pressedButtons,
859+
_sanitizer._pressedButtons & ~kContextMenuButton,
860+
event,
861+
pointerData);
862+
}
785863
final _SanitizedDetails sanitizedDetails =
786864
_sanitizer.sanitizeDownEvent(
787865
button: event.button,
@@ -793,6 +871,14 @@ class _MouseAdapter extends _BaseAdapter with _WheelEventListenerMixin {
793871

794872
_addMouseEventListener('mousemove', (html.MouseEvent event) {
795873
final List<ui.PointerData> pointerData = <ui.PointerData>[];
874+
final int buttonsBeforeEvent = _sanitizer._pressedButtons;
875+
_handleMissingRightMouseUpEvent(
876+
_sanitizer,
877+
buttonsBeforeEvent,
878+
(_sanitizer._inferDownFlutterButtons(event.button, event.buttons!)
879+
& kContextMenuButton),
880+
event,
881+
pointerData);
796882
final _SanitizedDetails sanitizedDetails = _sanitizer.sanitizeMoveEvent(buttons: event.buttons!);
797883
_convertEventsToPointerData(data: pointerData, event: event, details: sanitizedDetails);
798884
_callback(pointerData);
@@ -803,7 +889,7 @@ class _MouseAdapter extends _BaseAdapter with _WheelEventListenerMixin {
803889
final bool isEndOfDrag = event.buttons == 0;
804890
final _SanitizedDetails sanitizedDetails = isEndOfDrag ?
805891
_sanitizer.sanitizeUpEvent()! :
806-
_sanitizer.sanitizeMoveEvent(buttons: event.buttons!);
892+
_sanitizer.sanitizeUpEventWithButtons(buttons: event.buttons!)!;
807893
_convertEventsToPointerData(data: pointerData, event: event, details: sanitizedDetails);
808894
_callback(pointerData);
809895
}, acceptOutsideGlasspane: true);
@@ -813,6 +899,32 @@ class _MouseAdapter extends _BaseAdapter with _WheelEventListenerMixin {
813899
});
814900
}
815901

902+
// Handle special case where right mouse button no longer is pressed.
903+
// We need to synthesize right mouse up, otherwise drag gesture will fail
904+
// to complete or multiple RMB down events will lead to wrong state.
905+
void _handleMissingRightMouseUpEvent(_ButtonSanitizer sanitizer,
906+
int buttonsBeforeEvent, int buttonsAfterEvent, html.MouseEvent event,
907+
List<ui.PointerData> pointerData) {
908+
if ((buttonsBeforeEvent & kContextMenuButton) != 0 &&
909+
buttonsAfterEvent == 0) {
910+
sanitizer._pressedButtons &= ~2;
911+
_pointerDataConverter.convert(
912+
pointerData,
913+
change: ui.PointerChange.up,
914+
timeStamp: _BaseAdapter._eventTimeStampToDuration(event.timeStamp!),
915+
kind: ui.PointerDeviceKind.mouse,
916+
signalKind: ui.PointerSignalKind.none,
917+
device: _mouseDeviceId,
918+
physicalX: event.client.x.toDouble() * ui.window.devicePixelRatio,
919+
physicalY: event.client.y.toDouble() * ui.window.devicePixelRatio,
920+
buttons: _sanitizer._pressedButtons,
921+
pressure: 1.0,
922+
pressureMin: 0.0,
923+
pressureMax: 1.0,
924+
);
925+
}
926+
}
927+
816928
// For each event that is de-coalesced from `event` and described in
817929
// `detailsList`, convert it to pointer data and store in `data`.
818930
void _convertEventsToPointerData({

‎lib/web_ui/lib/src/engine/pointer_converter.dart‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
// @dart = 2.12
66
part of engine;
77

8+
const bool _debugLogPointerConverter = false;
9+
810
class _PointerState {
911
_PointerState(this.x, this.y);
1012

@@ -237,6 +239,9 @@ class PointerDataConverter {
237239
double scrollDeltaX = 0.0,
238240
double scrollDeltaY = 0.0,
239241
}) {
242+
if (_debugLogPointerConverter) {
243+
print('>> device=$device change = $change buttons = $buttons');
244+
}
240245
assert(change != null); // ignore: unnecessary_null_comparison
241246
if (signalKind == null ||
242247
signalKind == ui.PointerSignalKind.none) {

‎lib/web_ui/test/engine/pointer_binding_test.dart‎

Lines changed: 68 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1224,6 +1224,57 @@ void testMain() {
12241224
},
12251225
);
12261226

1227+
_testEach<_ButtonedEventMixin>(
1228+
[
1229+
_PointerEventContext(),
1230+
],
1231+
'correctly handles missing right mouse button up when followed by move',
1232+
(_ButtonedEventMixin context) {
1233+
PointerBinding.instance.debugOverrideDetector(context);
1234+
// This can happen with the following gesture sequence:
1235+
//
1236+
// - Pops up the context menu by right clicking;
1237+
// - Clicks LMB to close context menu.
1238+
// - Moves mouse.
1239+
1240+
List<ui.PointerDataPacket> packets = <ui.PointerDataPacket>[];
1241+
ui.window.onPointerDataPacket = (ui.PointerDataPacket packet) {
1242+
packets.add(packet);
1243+
};
1244+
1245+
// Press RMB popping up the context menu, then release by LMB down and up.
1246+
// Browser won't send up event in that case.
1247+
glassPane.dispatchEvent(context.mouseDown(
1248+
button: 2,
1249+
buttons: 2,
1250+
));
1251+
expect(packets, hasLength(1));
1252+
expect(packets[0].data, hasLength(2));
1253+
expect(packets[0].data[0].change, equals(ui.PointerChange.add));
1254+
expect(packets[0].data[0].synthesized, equals(true));
1255+
1256+
expect(packets[0].data[1].change, equals(ui.PointerChange.down));
1257+
expect(packets[0].data[1].synthesized, equals(false));
1258+
expect(packets[0].data[1].buttons, equals(2));
1259+
packets.clear();
1260+
1261+
// User now hovers.
1262+
glassPane.dispatchEvent(context.mouseMove(
1263+
button: _kNoButtonChange,
1264+
buttons: 0,
1265+
));
1266+
expect(packets, hasLength(1));
1267+
expect(packets[0].data, hasLength(2));
1268+
expect(packets[0].data[0].change, equals(ui.PointerChange.up));
1269+
expect(packets[0].data[0].synthesized, equals(false));
1270+
expect(packets[0].data[0].buttons, equals(0));
1271+
expect(packets[0].data[1].change, equals(ui.PointerChange.hover));
1272+
expect(packets[0].data[1].synthesized, equals(false));
1273+
expect(packets[0].data[1].buttons, equals(0));
1274+
packets.clear();
1275+
},
1276+
);
1277+
12271278
_testEach<_ButtonedEventMixin>(
12281279
[
12291280
_PointerEventContext(),
@@ -1303,10 +1354,16 @@ void testMain() {
13031354
clientY: 20.0,
13041355
));
13051356
expect(packets, hasLength(1));
1306-
expect(packets[0].data, hasLength(1));
1357+
expect(packets[0].data, hasLength(3));
13071358
expect(packets[0].data[0].change, equals(ui.PointerChange.move));
1308-
expect(packets[0].data[0].synthesized, equals(false));
1359+
expect(packets[0].data[0].synthesized, equals(true));
13091360
expect(packets[0].data[0].buttons, equals(2));
1361+
expect(packets[0].data[1].change, equals(ui.PointerChange.up));
1362+
expect(packets[0].data[1].synthesized, equals(false));
1363+
expect(packets[0].data[1].buttons, equals(0));
1364+
expect(packets[0].data[2].change, equals(ui.PointerChange.hover));
1365+
expect(packets[0].data[2].synthesized, equals(false));
1366+
expect(packets[0].data[2].buttons, equals(0));
13101367
packets.clear();
13111368
},
13121369
);
@@ -1416,18 +1473,24 @@ void testMain() {
14161473

14171474
// Press RMB again. In Chrome, when RMB is clicked again while the
14181475
// context menu is still active, it sends a pointerdown/mousedown event
1419-
// with "buttons:0".
1476+
// with "buttons:0". We convert this to pointer up, pointer down.
14201477
glassPane.dispatchEvent(context.mouseDown(
14211478
button: 2,
14221479
buttons: 0,
14231480
clientX: 20.0,
14241481
clientY: 20.0,
14251482
));
14261483
expect(packets, hasLength(1));
1427-
expect(packets[0].data, hasLength(1));
1484+
expect(packets[0].data, hasLength(3));
14281485
expect(packets[0].data[0].change, equals(ui.PointerChange.move));
1429-
expect(packets[0].data[0].synthesized, equals(false));
1486+
expect(packets[0].data[0].synthesized, equals(true));
14301487
expect(packets[0].data[0].buttons, equals(2));
1488+
expect(packets[0].data[1].change, equals(ui.PointerChange.up));
1489+
expect(packets[0].data[1].synthesized, equals(false));
1490+
expect(packets[0].data[1].buttons, equals(0));
1491+
expect(packets[0].data[2].change, equals(ui.PointerChange.down));
1492+
expect(packets[0].data[2].synthesized, equals(false));
1493+
expect(packets[0].data[2].buttons, equals(2));
14311494
packets.clear();
14321495

14331496
// Release RMB.

0 commit comments

Comments
 (0)