[remote-playback] Editorial improvements to text and code (#41852)

web-platform-tests · Sep 18, 2023 · 119e077 · 119e077
1 parent 5f31090
commit 119e077
Show file tree

Hide file tree

Showing 19 changed files with 77 additions and 76 deletions.
diff --git a/remote-playback/README.md b/remote-playback/README.md
@@ -8,7 +8,13 @@ File an issue: https://github.com/w3c/remote-playback/issues/new
 
 ## Hardware/network dependency
 
-The Remote Playback API requires to communicate with a device over the network.
-Some behavior would require a real devices to be implemented. In order to keep
-these tests automated, only behaviors that can be run without user gesture or
-specific configurations are available here.
+The Remote Playback API requires communication with a device over the network.
+Tests that end in `-manual.html` require a compatible device available on the
+local area network to run the tests; these tests must be run manually.
+
+Known browser/device combinations that can be used to run manual tests:
+
+| Browser             | Device |
+| -------             | ------ |
+| Chrome for Android  | [Chromecast](https://store.google.com/product/chromecast_google_tv?pli=1&hl=en-US) |
+| Safari              | Apple TV |
diff --git a/remote-playback/cancel-watch-availability.html b/remote-playback/cancel-watch-availability.html
@@ -1,23 +1,23 @@
 <!DOCTYPE html>
 <html>
-  <title>Tests various ways to call cancelWatchAvailability()</title>
+  <title>Tests cancelWatchAvailability()</title>
   <script src="/resources/testharness.js"></script>
   <script src="/resources/testharnessreport.js"></script>
   <script src="/common/media.js"></script>
   <script>
-    async_test((t) => {
+    async_test(t => {
       let v = document.createElement("video");
       v.src = getVideoURI("/media/movie_5");
 
       v.remote
         .watchAvailability(() => {})
         .then(
-          t.step_func((id) => {
+          t.step_func(id => {
             v.remote.cancelWatchAvailability(id).then(
               t.step_func(() => {
                 v.remote.cancelWatchAvailability(id).then(
                   t.unreached_func(),
-                  t.step_func_done((e) => {
+                  t.step_func_done(e => {
                     assert_equals(e.name, "NotFoundError");
                   })
                 );
@@ -27,26 +27,26 @@
           }),
           t.unreached_func()
         );
-    }, "Test that calling cancelWatchAvailability() with an id does remove the callback.");
+    }, "Test that calling cancelWatchAvailability() with an id does remove the callback, and calling cancelWatchAvailability with a removed id throws NotFoundError.");
 
-    async_test((t) => {
+    async_test(t => {
       let v = document.createElement("video");
       v.src = getVideoURI("/media/movie_5");
 
       Promise.all([
         v.remote.watchAvailability(() => {}),
         v.remote.watchAvailability(() => {}),
       ]).then(
-        t.step_func((ids) =>
+        t.step_func(ids =>
           v.remote.cancelWatchAvailability().then(
             t.step_func(() =>
               v.remote.cancelWatchAvailability(ids[0]).then(
                 t.unreached_func(),
-                t.step_func((e) => {
+                t.step_func(e => {
                   assert_equals(e.name, "NotFoundError");
                   v.remote.cancelWatchAvailability(ids[1]).then(
                     t.unreached_func(),
-                    t.step_func_done((e) =>
+                    t.step_func_done(e =>
                       assert_equals(e.name, "NotFoundError")
                     )
                   );
@@ -58,6 +58,6 @@
         ),
         t.unreached_func()
       );
-    }, "Test that calling cancelWatchAvailability() without an id removes all the callbacks.");
+    }, "Test that calling cancelWatchAvailability() without an id removes all the callbacks, and calling cancelWatchAvailability() with a removed id throws NotFoundError.");
   </script>
 </html>
diff --git a/remote-playback/disable-remote-playback-cancel-watch-availability-throws.html b/remote-playback/disable-remote-playback-cancel-watch-availability-throws.html
@@ -1,34 +1,33 @@
 <!DOCTYPE html>
 <html>
   <title>
-    Test that calling cancelWatchAvailability() when disableRemotePlayback
-    attribute is set throws an exception
+    Test that calling cancelWatchAvailability() when disableRemotePlayback attribute is set throws InvalidStateError
   </title>
   <script src="/resources/testharness.js"></script>
   <script src="/resources/testharnessreport.js"></script>
   <script src="/common/media.js"></script>
   <script>
-    async_test((t) => {
+    async_test(t => {
       let v = document.createElement("video");
       v.src = getVideoURI("/media/movie_5");
 
       v.remote
         .watchAvailability(() => {})
-        .then((id) => {
+        .then(id => {
           v.disableRemotePlayback = true;
           v.remote.cancelWatchAvailability(id).then(
             t.unreached_func(),
-            t.step_func((e) => {
+            t.step_func(e => {
               assert_equals(e.name, "InvalidStateError");
               v.remote.cancelWatchAvailability().then(
                 t.unreached_func(),
-                t.step_func_done((e) => {
+                t.step_func_done(e => {
                   assert_equals(e.name, "InvalidStateError");
                 })
               );
             })
           );
         }, t.unreached_func());
-    }, "Test that calling cancelWatchAvailability() when disableRemotePlayback attribute is set throws an exception.");
+    }, "Test that calling cancelWatchAvailability() when disableRemotePlayback attribute is set throws InvalidStateError.");
   </script>
 </html>
diff --git a/remote-playback/disable-remote-playback-prompt-throws.html b/remote-playback/disable-remote-playback-prompt-throws.html
@@ -1,14 +1,13 @@
 <!DOCTYPE html>
 <html>
   <title>
-    Test that calling prompt() when disableRemotePlayback attribute is set
-    throws an exception
+    Test that calling prompt() when disableRemotePlayback attribute is set throws an exception
   </title>
   <script src="/resources/testharness.js"></script>
   <script src="/resources/testharnessreport.js"></script>
   <script src="/common/media.js"></script>
   <script>
-    promise_test((t) => {
+    promise_test(t => {
       let v = document.createElement("video");
       v.src = getVideoURI("/media/movie_5");
       v.disableRemotePlayback = true;

diff --git a/remote-playback/disable-remote-playback-watch-availability-throws.html b/remote-playback/disable-remote-playback-watch-availability-throws.html
@@ -1,14 +1,13 @@
 <!DOCTYPE html>
 <html>
   <title>
-    Test that calling watchAvailability() when disableRemotePlayback attribute
-    is set throws an exception
+    Test that calling watchAvailability() when disableRemotePlayback attribute is set throws an exception
   </title>
   <script src="/resources/testharness.js"></script>
   <script src="/resources/testharnessreport.js"></script>
   <script src="/common/media.js"></script>
   <script>
-    promise_test((t) => {
+    promise_test(t => {
       let v = document.createElement("video");
       v.src = getVideoURI("/media/movie_5");
       v.disableRemotePlayback = true;

diff --git a/remote-playback/event-handlers-manual.html b/remote-playback/event-handlers-manual.html
@@ -1,6 +1,8 @@
 <!DOCTYPE html>
 <html>
-  <title>Test that all event handlers are called.</title>
+  <title>
+    Test that all event handlers are called when a remote playback device is connected
+  </title>
   <script src="/resources/testharness.js"></script>
   <script src="/resources/testharnessreport.js"></script>
   <script src="/common/media.js"></script>
@@ -30,7 +32,7 @@
     let v = document.createElement("video");
     v.src = getVideoURI("/media/movie_5");
 
-    async_test((t) => {
+    async_test(t => {
       let onConnectingCalled = false;
       let onConnectCalled = false;
       let onDisconnectCalled = false;
@@ -55,6 +57,6 @@
             assert_true(onDisconnectCalled, "ondisconnect was called");
           })
         );
-    }, "Test that all event handlers are called.");
+    }, "Test that all event handlers are called when a remote playback device is connected.");
   </script>
 </html>
diff --git a/remote-playback/prepare-device.js b/remote-playback/prepare-device.js
@@ -1,10 +1,8 @@
-var startButton = document.getElementById("start-button");
-startButton.onclick = function () {
+document.getElementById("start-button").onclick = () => {
   document.getElementById("prep").style.display = "none";
   document.getElementById("pick-device").style.display = "block";
 };
-var promptPrepButton = document.getElementById("prompt-button-prep");
-promptPrepButton.onclick = function () {
+document.getElementById("prompt-button-prep").onclick = () => {
   v.remote
     .prompt()
     .then(() => {})

diff --git a/remote-playback/prompt-and-cancel-selection-manual.html b/remote-playback/prompt-and-cancel-selection-manual.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <title>
-    Test that promise is rejected when user cancels device selection.
+    Test that the Promise returned by prompt() is rejected when user cancels device selection
   </title>
   <script src="/resources/testharness.js"></script>
   <script src="/resources/testharnessreport.js"></script>
@@ -17,7 +17,7 @@
     <button id="prompt-button">Pick device</button>
   </body>
   <script>
-    async_test((t) => {
+    async_test(t => {
       let v = document.createElement("video");
       v.src = getVideoURI("/media/movie_5");
 
@@ -27,11 +27,11 @@
           .prompt()
           .then(t.unreached_func())
           .catch(
-            t.step_func_done((error) =>
+            t.step_func_done(error =>
               assert_equals(error.name, "NotAllowedError")
             )
           )
       );
-    }, "Test that promise is rejected when user cancels device selection.");
+    }, "Test that the Promise returned by prompt() is rejected when user cancels device selection.");
   </script>
 </html>
diff --git a/remote-playback/prompt-and-select-device-manual.html b/remote-playback/prompt-and-select-device-manual.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 <html>
-  <title>Test that promise is resolved when user selects a device.</title>
+  <title>Test that the Promise returned by prompt() is resolved when user selects a device</title>
   <script src="/resources/testharness.js"></script>
   <script src="/resources/testharnessreport.js"></script>
   <script src="/common/media.js"></script>
@@ -26,13 +26,13 @@
     let v = document.createElement("video");
     v.src = getVideoURI("/media/movie_5");
 
-    async_test((t) => {
+    async_test(t => {
       let button = document.getElementById("prompt-button");
       button.onclick = t.step_func_done(() => {
         promise_test(() => {
           return v.remote.prompt();
         }, "Prompt resolves");
       });
-    }, "Test that promise is resolved when user selects a device.");
+    }, "Test that the Promise returned by prompt() is resolved when user selects a device.");
   </script>
 </html>
diff --git a/remote-playback/prompt-and-watch-availability-no-device-manual.html b/remote-playback/prompt-and-watch-availability-no-device-manual.html
@@ -1,8 +1,7 @@
 <!DOCTYPE html>
 <html>
   <title>
-    Test that watchAvailability returned false when there is no device for the
-    user to select.
+    Test that watchAvailability() runs the callback with false when there is no device for the user to select
   </title>
   <script src="/resources/testharness.js"></script>
   <script src="/resources/testharnessreport.js"></script>
@@ -29,12 +28,12 @@
     let v = document.createElement("video");
     v.src = getVideoURI("/media/movie_5");
 
-    async_test((t) => {
+    async_test(t => {
       let deviceAvailable = false;
       let button = document.getElementById("prompt-button");
       button.onclick = function () {
         v.remote
-          .watchAvailability(t.step_func((avail) => (deviceAvailable = avail)))
+          .watchAvailability(t.step_func(avail => (deviceAvailable = avail)))
           .then(
             t.step_func(() => {
               promise_rejects_js(t, NotFoundError, v.remote.prompt());
@@ -43,6 +42,6 @@
             t.unreached_func()
           );
       };
-    }, "Test that watchAvailability returned false when there is no device for the user to select.");
+    }, "Test that watchAvailability() runs the callback with false when there is no device for the user to select.");
   </script>
 </html>
diff --git a/remote-playback/prompt-and-watch-availability-with-device-manual.html b/remote-playback/prompt-and-watch-availability-with-device-manual.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <title>
-    Test that watchAvailability returned true when user selects device.
+    Test that watchAvailability() runs the callback with true when user selects a device
   </title>
   <script src="/resources/testharness.js"></script>
   <script src="/resources/testharnessreport.js"></script>
@@ -28,12 +28,12 @@
     let v = document.createElement("video");
     v.src = getVideoURI("/media/movie_5");
 
-    async_test((t) => {
+    async_test(t => {
       let deviceAvailable = false;
       let button = document.getElementById("prompt-button");
       button.onclick = () => {
         v.remote
-          .watchAvailability(t.step_func((avail) => (deviceAvailable = avail)))
+          .watchAvailability(t.step_func(avail => (deviceAvailable = avail)))
           .then(
             t.step_func(() => {
               v.remote
@@ -51,6 +51,6 @@
             t.unreached_func()
           );
       };
-    }, "Test that watchAvailability returned true when user selects device.");
+    }, "Test that watchAvailability() runs the callback with true when user selects a device.");
   </script>
 </html>
diff --git a/remote-playback/remote-video-control-pausing-manual.html b/remote-playback/remote-video-control-pausing-manual.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <link rel="stylesheet" href="styles.css" />
-  <title>Test that pause() on the local video is reflected on the remote device.</title>
+  <title>Test that pause() on the local video is reflected on the remote device</title>
   <script src="/resources/testharness.js"></script>
   <script src="/resources/testharnessreport.js"></script>
   <script src="/common/media.js"></script>
@@ -36,7 +36,7 @@
   <script>
     let v = document.getElementById("video");
 
-    async_test((t) => {
+    async_test(t => {
       let button = document.getElementById("prompt-button");
       button.onclick = t.step_func(() => {
         promise_test(() => {
@@ -58,7 +58,7 @@
         }
       };
 
-      let evaluate = (success) =>
+      let evaluate = success =>
         assert_true(success, "Video paused and has correct play position.");
 
       document.getElementById("yes").onclick = t.step_func_done(() =>
@@ -67,6 +67,6 @@
       document.getElementById("no").onclick = t.step_func_done(() =>
         evaluate(false)
       );
-    }, "Test if video is playing on remote device.");
+    }, "Test that pause() on the local video is reflected on the remote device.");
   </script>
 </html>
diff --git a/remote-playback/remote-video-control-seek-manual.html b/remote-playback/remote-video-control-seek-manual.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <link rel="stylesheet" href="styles.css" />
-  <title>Test that seek() on the local video is reflected on the remote device.</title>
+  <title>Test that seek() on the local video is reflected on the remote device</title>
   <script src="/resources/testharness.js"></script>
   <script src="/resources/testharnessreport.js"></script>
   <script src="/common/media.js"></script>
@@ -39,7 +39,7 @@
   <script>
     let v = document.getElementById("video");
 
-    async_test((t) => {
+    async_test(t => {
       let button = document.getElementById("prompt-button");
       button.onclick = t.step_func(() => {
         promise_test(() => {
@@ -64,7 +64,7 @@
         }
       };
 
-      let evaluate = (success) =>
+      let evaluate = success =>
         assert_true(success, "Video paused and has correct play position.");
 
       document.getElementById("yes").onclick = t.step_func_done(() =>
@@ -73,6 +73,6 @@
       document.getElementById("no").onclick = t.step_func_done(() =>
         evaluate(false)
       );
-    }, "Test if video is playing on remote device.");
+    }, "Test that seek() on the local video is reflected on the remote device.");
   </script>
 </html>