Tests for requestIdleCallback deadline computation (#31177)

* Tests for requestIdleCallback deadline computation Deadline should be: - capped at 50ms - capped at 1000/60 (~16ms) when there is a pending rAF callback - capped at the time of the next timeout - be updated when the above conditions change, during the callback itself See whatwg/html#7166 Co-authored-by: Philip Jägenstedt <philip@foolip.org>
web-platform-tests · Apr 13, 2022 · 6ae31b2 · 6ae31b2
1 parent ba85ed7
commit 6ae31b2
Show file tree

Hide file tree

Showing 5 changed files with 117 additions and 0 deletions.
diff --git a/requestidlecallback/deadline-max-rAF-dynamic.html b/requestidlecallback/deadline-max-rAF-dynamic.html
@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<title>window.requestIdleCallback max idle period deadline (requestAnimationFrame).</title>
+<meta name="timeout" content="long">
+<link rel="author" title="Noam Rosenthal" href="mailto:noam@webkit.org" />
+<script src="/resources/testharness.js"></script>
+<script src="/resources/testharnessreport.js"></script>
+<script src="resources/ric-utils.js"></script>
+<script>
+
+promise_test(async () => {
+  for (let i = 0; i < getRICRetryCount(); ++i) {
+    const {before, after} = await new Promise(resolve => requestIdleCallback(async deadline => {
+      const before = deadline.timeRemaining();
+      const animationFramePromise = new Promise(requestAnimationFrame);
+      const after = deadline.timeRemaining();
+
+      // Waiting till rAF is handled before the next iteration, to avoid residual callacks between iterations.
+      await animationFramePromise;
+      resolve({before, after})
+    }))
+
+    assert_less_than_equal(after, before)
+    assert_less_than_equal(after, getPendingRenderDeadlineCap())
+  }
+
+}, 'Check that the deadline is changed if there is a new requestAnimationFrame from within requestIdleCallback.');
+</script>
+<h1>Test of requestIdleCallback deadline behavior</h1>
+<p>The test can pass accidentally as idle deadlines have a maximum but they can always be shorter.
+It runs multiple times to expose potential failures.</p>
+<div id="log"></div>
diff --git a/requestidlecallback/deadline-max-rAF.html b/requestidlecallback/deadline-max-rAF.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<title>window.requestIdleCallback max idle period deadline (requestAnimationFrame).</title>
+<meta name="timeout" content="long">
+<link rel="author" title="Noam Rosenthal" href="mailto:noam@webkit.org" />
+<script src="/resources/testharness.js"></script>
+<script src="/resources/testharnessreport.js"></script>
+<script src="resources/ric-utils.js"></script>
+<script>
+
+promise_test(async done => {
+  for (let i = 0; i < getRICRetryCount(); ++i) {
+    requestAnimationFrame(() => {})
+    assert_less_than_equal(await getDeadlineForNextIdleCallback(), getPendingRenderDeadlineCap())
+  }
+
+}, 'Check that the deadline is less than 16ms when there is a pending animation frame.');
+</script>
+<h1>Test of requestIdleCallback deadline behavior</h1>
+<p>The test can pass accidentally as idle deadlines have a maximum but they can always be shorter.
+It runs multiple times to expose potential failures.</p>
+<div id="log"></div>
diff --git a/requestidlecallback/deadline-max-timeout-dynamic.html b/requestidlecallback/deadline-max-timeout-dynamic.html
@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<title>window.requestIdleCallback max idle period deadline (dynamic timoeout).</title>
+<meta name="timeout" content="long">
+<link rel="author" title="Noam Rosenthal" href="mailto:noam@webkit.org" />
+<script src="/resources/testharness.js"></script>
+<script src="/resources/testharnessreport.js"></script>
+<script src="resources/ric-utils.js"></script>
+<script>
+
+promise_test(async () => {
+  for (let i = 0; i < getRICRetryCount(); ++i) {
+    for (const timeout of [10, 20, 30]) {
+      const {before, after} = await new Promise(resolve => requestIdleCallback(async deadline => {
+        const before = deadline.timeRemaining();
+        const timerPromise = new Promise(resolve => step_timeout(resolve, timeout));
+        const after = deadline.timeRemaining();
+        await timerPromise;
+        resolve({before, after})
+      }))
+
+      assert_less_than_equal(after, before)
+      assert_less_than_equal(after, timeout)
+    }
+  }
+
+}, 'Check that the deadline is changed if there is a new timeout from within requestIdleCallback.');
+</script>
+<h1>Test of requestIdleCallback deadline behavior</h1>
+<p>The test can pass accidentally as idle deadlines have a maximum but they can always be shorter.
+It runs multiple times to expose potential failures.</p>
+<div id="log"></div>
diff --git a/requestidlecallback/deadline-max.html b/requestidlecallback/deadline-max.html
@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<title>window.requestIdleCallback max idle period deadline.</title>
+<meta name="timeout" content="long">
+<link rel="author" title="Noam Rosenthal" href="mailto:noam@webkit.org" />
+<script src="/resources/testharness.js"></script>
+<script src="/resources/testharnessreport.js"></script>
+<script src="resources/ric-utils.js"></script>
+<script>
+
+promise_test(async done => {
+  for (let i = 0; i < getRICRetryCount(); ++i)
+    assert_less_than_equal(await getDeadlineForNextIdleCallback(), 50)
+
+}, 'Check that the deadline is less than 50ms.');
+</script>
+<h1>Test of requestIdleCallback deadline behavior</h1>
+<p>This test validates that deadlines returned for requestIdleCallback are less than 50ms.</p>
+<p>The test can pass accidentally as idle deadlines have a maximum but they can always be shorter.
+It runs multiple times to expose potential failures.</p>
+<div id="log"></div>
diff --git a/requestidlecallback/resources/ric-utils.js b/requestidlecallback/resources/ric-utils.js
@@ -0,0 +1,14 @@
+function getDeadlineForNextIdleCallback() {
+    return new Promise(
+        resolve =>
+            requestIdleCallback(deadline => resolve(deadline.timeRemaining()))
+    );
+}
+
+function getPendingRenderDeadlineCap() {
+    return 1000 / 60;
+}
+
+function getRICRetryCount() {
+    return 10;
+}