From b29c0837b336a17d4aca09b9afbb82ac30748385 Mon Sep 17 00:00:00 2001
From: Sahir Vellani <sahir.vellani@microsoft.com>
Date: Mon, 24 Jun 2024 17:33:26 -0700
Subject: [PATCH] Swap PointerEvent.deviceProperties with
 PointerEvent.persistentDeviceId

Bring back a unique id on the base pointer event and remove
deviceProperties. Rather than deviceId, this will be called
persistentDeviceId.
Spec: https://github.com/w3c/pointerevents/pull/495

Change-Id: Ia284adc60bc4030b69dbec89d0e37117fecf3f83
Bug: 330760871
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/5643255
Commit-Queue: Sahir Vellani <sahir.vellani@microsoft.com>
Reviewed-by: Olga Gerchikov <gerchiko@microsoft.com>
Reviewed-by: Robert Flack <flackr@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1318886}
---
 ...eviceid-from-pointer-event.tentative.html} |  6 +--
 ...tdeviceid-is-unique-manual.tentative.html} | 31 ++++++------
 ...id-from-pointer-event-init.tentative.html} | 49 ++++++-------------
 3 files changed, 32 insertions(+), 54 deletions(-)
 rename pointerevents/{deviceproperties/get-device-properties-uniqueid-from-pointer-event.tentative.html => persistentDeviceId/get-persistendeviceid-from-pointer-event.tentative.html} (86%)
 rename pointerevents/{deviceproperties/unique-id-is-unique-manual.tentative.html => persistentDeviceId/persistentdeviceid-is-unique-manual.tentative.html} (82%)
 rename pointerevents/{deviceproperties/pointer-event-has-device-properties-uniqueid-from-pointer-event-init.tentative.html => persistentDeviceId/pointer-event-has-persistentdeviceid-from-pointer-event-init.tentative.html} (52%)

diff --git a/pointerevents/deviceproperties/get-device-properties-uniqueid-from-pointer-event.tentative.html b/pointerevents/persistentDeviceId/get-persistendeviceid-from-pointer-event.tentative.html
similarity index 86%
rename from pointerevents/deviceproperties/get-device-properties-uniqueid-from-pointer-event.tentative.html
rename to pointerevents/persistentDeviceId/get-persistendeviceid-from-pointer-event.tentative.html
index dc6b9379c11403..9f77c1c9e9559d 100644
--- a/pointerevents/deviceproperties/get-device-properties-uniqueid-from-pointer-event.tentative.html
+++ b/pointerevents/persistentDeviceId/get-persistendeviceid-from-pointer-event.tentative.html
@@ -16,13 +16,13 @@
 </style>
 <div id="logger" draggable="false"></div>
 <div id="console"></div>
-<!-- This test verifies that pointerEvent.deviceProperties.uniqueId is 0
+<!-- This test verifies that pointerEvent.persistentDeviceId is 0
      by default for a pointer with an invalid hardware id - in this case
      a testdriver generated event, which does not support hardware id. -->
 <script>
     function CheckDeviceId(event) {
         eventFired++;
-        assert_equals(event.deviceProperties.uniqueId, 0, "deviceId is 0");
+        assert_equals(event.persistentDeviceId, 0, "deviceId is 0");
     }
 
     window.addEventListener("pointerdown", CheckDeviceId, false);
@@ -41,5 +41,5 @@
         await actions.send();
 
         assert_true(eventFired == 2);
-    }, 'PointerEvent.deviceProperties.uniqueId');
+    }, 'PointerEvent.persistentDeviceId');
 </script>
\ No newline at end of file
diff --git a/pointerevents/deviceproperties/unique-id-is-unique-manual.tentative.html b/pointerevents/persistentDeviceId/persistentdeviceid-is-unique-manual.tentative.html
similarity index 82%
rename from pointerevents/deviceproperties/unique-id-is-unique-manual.tentative.html
rename to pointerevents/persistentDeviceId/persistentdeviceid-is-unique-manual.tentative.html
index 55db05353f5a2f..f9f15cfaea85a1 100644
--- a/pointerevents/deviceproperties/unique-id-is-unique-manual.tentative.html
+++ b/pointerevents/persistentDeviceId/persistentdeviceid-is-unique-manual.tentative.html
@@ -3,7 +3,7 @@
    Tentative; contingent on merge of:
    https://github.com/w3c/pointerevents/pull/495
 
-   This manual test validates the behavior of PointerEvent.deviceProperties.uniqueId.
+   This manual test validates the behavior of PointerEvent.persistentDeviceId.
    Specifically, this test ensures that pointing devices get their own unique id, and
    that the unique id is persistent over the session.
 
@@ -11,7 +11,7 @@
    pen and a mouse. Please follow the instructions exactly as written in order to ensure
    the correct results are obtained.
 -->
-<title>DeviceProperties.uniqueId is unique for pointer events from different devices</title>
+<title>persistentDeviceId is unique for pointer events from different devices</title>
 <script src="/resources/testharness.js"></script>
 <script src="/resources/testharnessreport.js"></script>
 <style>
@@ -94,13 +94,10 @@ <h2>Instructions</h2>
     setup({explicit_timeout: true, explicit_done: true});
 
     function LogDeviceId(event, list) {
-        if (event.deviceProperties) {
-            const uniqueId = event.deviceProperties.uniqueId;
-            currentuniqueid.innerText = uniqueId ? uniqueId : "Unknown";
-            if (!uniqueId) {
-                return;
-            }
-            list.push(uniqueId);
+        if (event.persistentDeviceId) {
+            const persistentDeviceId = event.persistentDeviceId;
+            currentuniqueid.innerText = persistentDeviceId ? persistentDeviceId : "Unknown";
+            list.push(persistentDeviceId);
         }
     }
 
@@ -117,17 +114,17 @@ <h2>Instructions</h2>
         let device2UniqueIds = new Set(device2Ids);
 
         test(function () {
-            assert_greater_than(device1Ids.length, 1, "Events from Device 1 have uniqueIds.");
-            assert_equals(device1UniqueIds.size, 1, "Device 1 has a consistent uniqueId.");
-        }, "uniqueId is consistent for device 1");
+            assert_greater_than(device1Ids.length, 1, "Events from Device 1 have deviceIds.");
+            assert_equals(device1UniqueIds.size, 1, "Device 1 has a consistent deviceId.");
+        }, "deviceId is consistent for device 1");
         test(function () {
-            assert_greater_than(device2Ids.length, 1, "Events from Device 2 have uniqueIds.");
-            assert_equals(device2UniqueIds.size, 1, "Device 2 has a consistent uniqueId.");
-        }, "uniqueId is consistent for device 2");
+            assert_greater_than(device2Ids.length, 1, "Events from Device 2 have deviceIds.");
+            assert_equals(device2UniqueIds.size, 1, "Device 2 has a consistent deviceId.");
+        }, "deviceId is consistent for device 2");
         test(function () {
             // Ensure the two sets are different.
-            assert_equals(device1UniqueIds.intersection(device2UniqueIds).size, 0, "Device 1 and 2 have different uniqueIds.");
-        }, "uniqueId is unique to device 1 and device 2");
+            assert_equals(device1UniqueIds.intersection(device2UniqueIds).size, 0, "Device 1 and 2 have different deviceIds.");
+        }, "deviceId is unique to device 1 and device 2");
         done();
     }
 
diff --git a/pointerevents/deviceproperties/pointer-event-has-device-properties-uniqueid-from-pointer-event-init.tentative.html b/pointerevents/persistentDeviceId/pointer-event-has-persistentdeviceid-from-pointer-event-init.tentative.html
similarity index 52%
rename from pointerevents/deviceproperties/pointer-event-has-device-properties-uniqueid-from-pointer-event-init.tentative.html
rename to pointerevents/persistentDeviceId/pointer-event-has-persistentdeviceid-from-pointer-event-init.tentative.html
index 33b2354ec63935..ef3f4d153566ac 100644
--- a/pointerevents/deviceproperties/pointer-event-has-device-properties-uniqueid-from-pointer-event-init.tentative.html
+++ b/pointerevents/persistentDeviceId/pointer-event-has-persistentdeviceid-from-pointer-event-init.tentative.html
@@ -7,22 +7,20 @@
 <script src="/resources/testharnessreport.js"></script>
 <div id="console"></div>
 
-<!-- This test verifies that pointerEvent.deviceProperties.uniqueId
+<!-- This test verifies that pointerEvent.persistentDeviceId
      can be set via PointerEventInit. -->
 <script>
-    const UNIQUE_ID = 1001;
-    const INVALID_UNIQUE_ID = 0;
+    const PERSISTENT_ID = 1001;
+    const INVALID_PERSISTENT_ID = 0;
 
-    function CheckDeviceId(event, uniqueId) {
-        assert_equals(event.deviceProperties.uniqueId, uniqueId, "uniqueId is populated");
+    function CheckDeviceId(event, persistentDeviceId) {
+        assert_equals(event.persistentDeviceId, persistentDeviceId, "persistentDeviceId is populated");
     }
 
     promise_test(async () => {
         if (!window.internals)
           return;
-        var deviceProps = new DeviceProperties({
-          uniqueId: 1001
-        });
+        var deviceId = PERSISTENT_ID;
         var downEvent = new PointerEvent("pointerdown",
           {pointerId: 1,
             bubbles: true,
@@ -31,9 +29,9 @@
             width: 100,
             height: 100,
             isPrimary: true,
-            deviceProperties: deviceProps
+            persistentDeviceId: deviceId
           });
-        CheckDeviceId(downEvent, UNIQUE_ID);
+        CheckDeviceId(downEvent, PERSISTENT_ID);
         var moveEvent = new PointerEvent("pointermove",
           {pointerId: 1,
             bubbles: true,
@@ -42,9 +40,9 @@
             width: 100,
             height: 100,
             isPrimary: true,
-            deviceProperties: deviceProps
+            persistentDeviceId: deviceId
           });
-        CheckDeviceId(moveEvent, UNIQUE_ID);
+        CheckDeviceId(moveEvent, PERSISTENT_ID);
         var upEvent = new PointerEvent("pointerup",
           {pointerId: 1,
             bubbles: true,
@@ -53,27 +51,10 @@
             width: 100,
             height: 100,
             isPrimary: true,
-            deviceProperties: deviceProps
+            persistentDeviceId: deviceId
           });
-        CheckDeviceId(upEvent, UNIQUE_ID);
-    }, 'PointerEvent.deviceProperties via DevicePropertiesInit');
-
-    promise_test(async () => {
-        if (!window.internals)
-          return;
-        var emptyDeviceProps = new DeviceProperties({});
-        var downEventEmptyProps = new PointerEvent("pointerdown",
-          {pointerId: 1,
-            bubbles: true,
-            cancelable: true,
-            pointerType: "pen",
-            width: 100,
-            height: 100,
-            isPrimary: true,
-            deviceProperties: emptyDeviceProps
-        });
-        CheckDeviceId(downEventEmptyProps, INVALID_UNIQUE_ID);
-    }, 'PointerEvent.deviceProperties via empty DevicePropertiesInit');
+        CheckDeviceId(upEvent, PERSISTENT_ID);
+    }, 'PointerEvent.persistentDeviceId via PointerEventInit');
 
     promise_test(async () => {
         if (!window.internals)
@@ -87,6 +68,6 @@
             height: 100,
             isPrimary: true,
         });
-        assert_equals(downEventEmptyProps.deviceProperties, null);
-    }, 'No deviceProperties in PointerEventInit');
+        assert_equals(downEventEmptyProps.persistentDeviceId, INVALID_PERSISTENT_ID);
+    }, 'No persistentDeviceId in PointerEventInit');
 </script>
\ No newline at end of file