pointerevent_movementxy.html?mouse WPT is failing

https://bugs.webkit.org/show_bug.cgi?id=258780
rdar://111635046

Reviewed by Wenson Hsieh.

Currently, we are failing the pointerevent_movementxy.html?mouse WPT
variant with the error "FAIL mouse pointerevent attributes
assert_equals: movementX should be 0 for event other than pointermove.
expected 0 but got 20". We fail this assertion because events that are
not of the pointermove type have non-zero movementX/Y values.

We address said issue in this commit by:

- Making sure that any event which isn't of type (mouse/pointer/touch)move
does not have non-zero movementX/movementY fields.
- Hardening against accidentally assigning movementX/movementY fields
outside of initialization, by making said fields private.
- Adjusting the expected result for the now passing WPT.

This commit also introduces some additional state into the
WebCore::Event class, through which we can consult if the Event was
constructed using an EventInit dictionary. We need this information
because the attribute values assigned from the EventInit dictionary
receive priority over other rules dictating the Event attribute.

* LayoutTests/imported/w3c/web-platform-tests/pointerevents/pointerevent_movementxy_mouse-expected.txt:
* Source/WebCore/dom/Event.cpp:
* Source/WebCore/dom/Event.h:
(WebCore::Event::isConstructedFromInitializer const):
* Source/WebCore/dom/MouseRelatedEvent.cpp:
(WebCore::isMoveEventType):
(WebCore::MouseRelatedEvent::init):
* Source/WebCore/dom/MouseRelatedEvent.h:

Canonical link: https://commits.webkit.org/265730@main

Author: aprotyas

LayoutTests/imported/w3c/web-platform-tests/pointerevents/pointerevent_movementxy_mouse-expected.txt

@@ -1,7 +1,5 @@
 Pointer Events movementX/Y attribute test
 
-Follow the test instructions with mouse. If you don't have the device skip it.
-
 Test Description: This test checks the movementX/Y properties of pointer events.
 Press down on the black square.
 Move your pointer slowly along a straight line to the red square.
@@ -10,5 +8,5 @@ Test passes if the proper behavior of the events is observed.
 
 
 
-FAIL mouse pointerevent attributes assert_equals: movementX should be 0 for event other than pointermove. expected 0 but got 20
+PASS mouse pointerevent attributes
 

Source/WebCore/dom/Event.cpp

@@ -84,6 +84,7 @@ Event::Event(const AtomString& eventType, const EventInit& initializer, IsTruste
         initializer.composed ? IsComposed::Yes : IsComposed::No }
 {
     ASSERT(!eventType.isNull());
+    m_isConstructedFromInitializer = true;
 }
 
 Event::~Event() = default;

Source/WebCore/dom/Event.h

@@ -160,6 +160,8 @@ class Event : public ScriptWrappable, public RefCounted<Event> {
 
     virtual void receivedTarget() { }
 
+    bool isConstructedFromInitializer() const { return m_isConstructedFromInitializer; }
+
 private:
     explicit Event(MonotonicTime createTime, const AtomString& type, IsTrusted, CanBubble, IsCancelable, IsComposed);
 
@@ -181,6 +183,10 @@ class Event : public ScriptWrappable, public RefCounted<Event> {
 
     unsigned m_eventPhase : 2;
 
+    // We consult this flag since the EventInit dictionary takes priority in initializing event attribute values.
+    // See step 4 of https://dom.spec.whatwg.org/#inner-event-creation-steps
+    unsigned m_isConstructedFromInitializer : 1 { false };
+
     AtomString m_type;
 
     RefPtr<EventTarget> m_currentTarget;

Source/WebCore/dom/MouseRelatedEvent.cpp

@@ -64,6 +64,14 @@ MouseRelatedEvent::MouseRelatedEvent(const AtomString& eventType, const MouseRel
     init(false, IntPoint(0, 0));
 }
 
+static inline bool isMoveEventType(const AtomString& eventType)
+{
+    auto& eventNames = WebCore::eventNames();
+    return eventType == eventNames.mousemoveEvent
+        || eventType == eventNames.pointermoveEvent
+        || eventType == eventNames.touchmoveEvent;
+}
+
 void MouseRelatedEvent::init(bool isSimulated, const IntPoint& windowLocation)
 {
     if (!isSimulated) {
@@ -76,6 +84,11 @@ void MouseRelatedEvent::init(bool isSimulated, const IntPoint& windowLocation)
     }
 
     initCoordinates();
+
+    if (!isConstructedFromInitializer() && !isMoveEventType(type())) {
+        m_movementX = 0;
+        m_movementY = 0;
+    }
 }
 
 void MouseRelatedEvent::initCoordinates()

Source/WebCore/dom/MouseRelatedEvent.h

@@ -96,12 +96,12 @@ class MouseRelatedEvent : public UIEventWithKeyState {
     // Expose these so MouseEvent::initMouseEvent can set them.
     IntPoint m_screenLocation;
     LayoutPoint m_clientLocation;
-    double m_movementX { 0 };
-    double m_movementY { 0 };
 
 private:
     void init(bool isSimulated, const IntPoint&);
 
+    double m_movementX { 0 };
+    double m_movementY { 0 };
     LayoutPoint m_pageLocation;
     LayoutPoint m_layerLocation;
     LayoutPoint m_offsetLocation;