serial: Add a test for large unidirectional transfers

reillyeon · chromium-wpt-export-bot · commit 2987fa6849da · 2021-10-01T17:55:01.000-07:00
This test attempts to receive data from a test serial device as quickly as possible in order to potentially reproduce issues with data loss. Bug: 1070798 Change-Id: I40a35c22fc2e3a31e31f4b1f038a2cc4e33fce37 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3120318 Auto-Submit: Reilly Grant <reillyg@chromium.org> Commit-Queue: Reilly Grant <reillyg@chromium.org> Reviewed-by: Chris Mumford <cmumford@google.com> Cr-Commit-Position: refs/heads/main@{#927455}
diff --git a/serial/resources/manual.js b/serial/resources/manual.js
@@ -1,7 +1,7 @@
 let manualTestPort = null;
 
 navigator.serial.addEventListener('disconnect', (e) => {
-  if (e.port === manualTestPort) {
+  if (e.target === manualTestPort) {
     manualTestPort = null;
   }
 })
@@ -31,7 +31,7 @@ async function getPortForManualTest() {
   return manualTestPort;
 }
 
-function manual_loopback_serial_test(func, name, properties) {
+function manual_serial_test(func, name, properties) {
   promise_test(async (test) => {
     await func(test, await getPortForManualTest());
   }, name, properties);
diff --git a/serial/serialPort_disconnect-manual.https.html b/serial/serialPort_disconnect-manual.https.html
@@ -13,7 +13,7 @@
       These tests require a serial device to be connected and disconnected.
     </p>
     <script>
-      manual_loopback_serial_test(async (t, port) => {
+      manual_serial_test(async (t, port) => {
         const watcher = new EventWatcher(t, navigator.serial, ['disconnect']);
 
         await port.open({baudRate: 115200, bufferSize: 1024});
@@ -47,7 +47,7 @@
         await port.close();
       }, 'Disconnect during read is detected.');
 
-      manual_loopback_serial_test(async (t, port) => {
+      manual_serial_test(async (t, port) => {
         const watcher = new EventWatcher(t, navigator.serial, ['disconnect']);
 
         await port.open({baudRate: 115200, bufferSize: 1024});
diff --git a/serial/serialPort_loopback-manual.https.html b/serial/serialPort_loopback-manual.https.html
@@ -14,7 +14,7 @@
       "loopback" device, with the transmit and receive pins wired together.
     </p>
     <script>
-      manual_loopback_serial_test(async (t, port) => {
+      manual_serial_test(async (t, port) => {
         await port.open({baudRate: 115200, bufferSize: 1024});
 
         // Create something much smaller than bufferSize above.
@@ -39,7 +39,7 @@
         await port.close();
       }, 'Can perform a series of small writes.');
 
-      manual_loopback_serial_test(async (t, port) => {
+      manual_serial_test(async (t, port) => {
         await port.open({baudRate: 115200, bufferSize: 1024});
 
         // Create something much larger than bufferSize above.
@@ -64,7 +64,7 @@
         await port.close();
       }, 'Can perform a series of large writes.');
 
-      manual_loopback_serial_test(async (t, port) => {
+      manual_serial_test(async (t, port) => {
         await port.open({baudRate: 115200, bufferSize: 64});
 
         const writer = port.writable.getWriter();
diff --git a/serial/serialPort_loopback_BreakError-manual.https.html b/serial/serialPort_loopback_BreakError-manual.https.html
@@ -14,7 +14,7 @@
       "loopback" device, with the transmit and receive pins wired together.
     </p>
     <script>
-      manual_loopback_serial_test(async (t, port) => {
+      manual_serial_test(async (t, port) => {
         await port.open({baudRate: 115200, bufferSize: 1024});
 
         let reader = port.readable.getReader();
diff --git a/serial/serialPort_loopback_BufferOverrunError-manual.https.html b/serial/serialPort_loopback_BufferOverrunError-manual.https.html
@@ -14,7 +14,7 @@
       "loopback" device, with the transmit and receive pins wired together.
     </p>
     <script>
-      manual_loopback_serial_test(async (t, port) => {
+      manual_serial_test(async (t, port) => {
         await port.open({baudRate: 115200, bufferSize: 1024});
 
         // Create something much larger than bufferSize above.
diff --git a/serial/serialPort_readable-manual.https.html b/serial/serialPort_readable-manual.https.html
@@ -0,0 +1,107 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title></title>
+    <script src="/resources/testharness.js"></script>
+    <script src="/resources/testharnessreport.js"></script>
+    <script src="resources/common.js"></script>
+    <script src="resources/manual.js"></script>
+  </head>
+  <body>
+    <p>
+      These tests require a device configured with the following Arduino sketch:
+
+      <pre>
+uint32_t seed = 0;
+uint32_t bytesToSend = 0;
+
+uint8_t nextByte() {
+  seed = (1103515245 * seed + 12345) % 0x8000000;
+  return (seed >> 16) & 0xFF;
+}
+
+void setup() {
+  Serial.begin(115200);
+}
+
+void loop() {
+  if (!Serial) {
+    return;
+  }
+
+  if (bytesToSend == 0) {
+    // Read the seed and number of bytes to send from the host as 32-bit
+    // little-endian values.
+    if (Serial.available() &lt 8) {
+      return;
+    }
+
+    uint8_t buf[8];
+    Serial.readBytes((char*)buf, sizeof buf);
+    seed = (uint32_t)buf[0] |
+            ((uint32_t)buf[1] &lt;&lt; 8) |
+            ((uint32_t)buf[2] &lt;&lt; 16) |
+            ((uint32_t)buf[3] &lt;&lt; 24);
+    bytesToSend = (uint32_t)buf[4] |
+                  ((uint32_t)buf[5] &lt;&lt; 8) |
+                  ((uint32_t)buf[6] &lt;&lt; 16) |
+                  ((uint32_t)buf[7] &lt;&lt; 24);
+  } else {
+    uint8_t buf[64];
+    uint32_t count = min(sizeof buf, bytesToSend);
+    for (uint32_t i = 0; i &lt; count; ++i) {
+      buf[i] = nextByte();
+    }
+    bytesToSend -= count;
+    Serial.write((char*)buf, count);
+  }
+}
+      </pre>
+    </p>
+    <p>
+      <progress id='progress'></progress>
+    </p>
+    <script>
+      let seed = 10;
+      const length = 1024 * 1024 * 10;
+
+      function next_byte() {
+        seed = (Math.imul(1103515245, seed) + 12345) % (1 << 31);
+        return (seed >> 16) & 0xFF;
+      }
+
+      manual_serial_test(async (t, port) => {
+        await port.open({baudRate: 115200, bufferSize: 1024});
+
+        const config = new DataView(new ArrayBuffer(8));
+        config.setUint32(0, seed, /*littleEndian=*/true);
+        config.setUint32(4, length, /*littleEndian=*/true);
+
+        const writer = port.writable.getWriter();
+        writer.write(config);
+
+        const progress = document.getElementById('progress');
+        progress.max = length;
+        progress.value = 0;
+
+        const reader = port.readable.getReader();
+        let bytesRead = 0;
+        while (bytesRead < length) {
+          const { value, done } = await reader.read();
+          assert_false(done);
+          for (let i = 0; i < value.byteLength; ++i) {
+            assert_equals(value[i], next_byte(),
+                          `mismatch at byte ${bytesRead + i}`);
+          }
+          bytesRead += value.byteLength;
+          progress.value = bytesRead;
+        }
+
+        writer.releaseLock();
+        reader.releaseLock();
+        await port.close();
+      }, `Reading ${length} bytes from the device succeeds.`);
+    </script>
+  </body>
+</html>
