Improve wait_js_condition and WaitRange doc

- Rename min_wait to min_interval in wait_js_condition
- Add better documentation to wait_js_condition
- Set 0 as default value for delay

Change-Id: Ic083f8ebfb92f3758dfa18d4f09de0a63320d89e
Reviewed-on: https://chromium-review.googlesource.com/c/crossbench/+/6650992
Reviewed-by: Patrick Thier <[email protected]>
Commit-Queue: Camillo Bruni <[email protected]>

Author: camillobruni

crossbench/action_runner/default_action_runner.py

@@ -244,7 +244,7 @@ def _or_more_match(js_result: int) -> bool:
     try:
       actions.wait_js_condition(
           selector_script,
-          min_wait=0.2,
+          min_interval=0.2,
           timeout=timeout,
           arguments=(selector,),
           success_condition=success_condition)
@@ -269,7 +269,7 @@ def wait_for_condition(self, run: Run,
                          action: i_action.WaitForConditionAction) -> None:
     with run.actions("WaitForConditionAction", measure=False) as actions:
       actions.wait_js_condition(
-          action.condition, min_wait=0.1, timeout=action.timeout)
+          action.condition, min_interval=0.1, timeout=action.timeout)
 
   @override
   def wait_for_ready_state(self, run: Run,
@@ -379,7 +379,7 @@ def wait_for_download(self, run: Run,
                            f"{repr(self.info_stack)}")
       assert isinstance(ctx, DownloadsProbeContext)
 
-      wait_range = run.wait_range(min_wait=0.2, timeout=action.timeout, delay=0)
+      wait_range = run.wait_range(min_interval=0.2, timeout=action.timeout)
       for _ in wait_range.wait_with_backoff():
         if ctx.download_complete(action.pattern):
           return

crossbench/benchmarks/jetstream/jetstream_1_1.py

@@ -96,7 +96,8 @@ def setup(self, run: Run) -> None:
           url=self.get_run_url(run),
           ready_state=ReadyState.COMPLETE,
           timeout=dt.timedelta(seconds=10))
-      actions.wait_js_condition("return !!JetStream;", min_wait=0.01, timeout=2)
+      actions.wait_js_condition(
+          "return !!JetStream;", min_interval=0.01, timeout=2)
       actions.js("JetStream.initialize();")
       # Intercept console.log to capture the raw results.
       actions.js("""
@@ -121,7 +122,7 @@ def run_wait_until_done(self, run: Run) -> None:
           return (summaryElement.innerHTML.indexOf("Score") >= 0);
           """,
           0.5,
-          self.slow_duration,
+          timeout=self.slow_duration,
           delay=self.substory_duration)
 
 

crossbench/benchmarks/jetstream/jetstream_2.py

@@ -142,7 +142,9 @@ def setup(self, run: Run) -> None:
           timeout=dt.timedelta(seconds=10))
       if self._substories != self.SUBSTORIES:
         actions.wait_js_condition(
-            "return globalThis?.JetStream?.benchmarks?.length > 0;", 0.1, 10)
+            "return globalThis?.JetStream?.benchmarks?.length > 0;",
+            0.1,
+            timeout=10)
         actions.js(
             """
         let benchmarks = arguments[0];
@@ -153,7 +155,9 @@ def setup(self, run: Run) -> None:
       actions.wait_js_condition(
           """
         return document.querySelectorAll("#results>.benchmark").length > 0;
-      """, 1, self.duration + dt.timedelta(seconds=30))
+      """,
+          1,
+          timeout=self.duration + dt.timedelta(seconds=30))
 
 
 ProbeClsTupleT = tuple[Type[JetStream2Probe], ...]

crossbench/benchmarks/loading/config/login/google.py

@@ -95,7 +95,9 @@ def _submit_login_field(self, action: Actions, secret: UsernamePassword,
     action.wait_js_condition(
         ("return "
          f"document.querySelector(\"[aria-label='{aria_label}']\") != null &&"
-         f"document.getElementById({repr(button_name)}) != null;"), 0.2, 10)
+         f"document.getElementById({repr(button_name)}) != null;"),
+        0.2,
+        timeout=10)
     action.js("const inputField ="
               f" document.querySelector(\"[aria-label='{aria_label}']\");"
               f"inputField.value = {repr(input_val)};"
@@ -129,8 +131,7 @@ def run_with(self, runner: ActionRunner, run: Run,
           self.timeout(secret))
       action.wait_for_ready_state(ReadyState.COMPLETE, self.timeout(secret))
 
-      wait_range = run.wait_range(0.2, self.timeout(secret), 0)
-
+      wait_range = run.wait_range(0.2, self.timeout(secret))
       for _, _, time_left in wait_range.wait_with_backoff():
         current_url = action.current_url()
 

crossbench/benchmarks/motionmark/motionmark_1.py

@@ -305,7 +305,7 @@ def run(self, run: Run) -> None:
           return window.benchmarkRunnerClient.results._results != undefined
           """,
           0.5,
-          self.slow_duration,
+          timeout=self.slow_duration,
           delay=self.substory_duration / 4)
 
 

crossbench/benchmarks/speedometer/speedometer.py

@@ -197,7 +197,8 @@ def setup(self, run: Run) -> None:
     updated_url = self.get_run_url(run)
     with run.actions("Setup") as actions:
       actions.show_url(updated_url)
-      actions.wait_js_condition("return window.Suites !== undefined;", 0.5, 10)
+      actions.wait_js_condition(
+          "return window.Suites !== undefined;", 0.5, timeout=10)
       self._setup_substories(actions)
       self._setup_benchmark_client(actions)
       actions.wait(0.5)
@@ -257,7 +258,7 @@ def run(self, run: Run) -> None:
       actions.wait_js_condition(
           "return window.testDone",
           0.5,
-          self.slow_duration,
+          timeout=self.slow_duration,
           delay=self.substory_duration)
 
 

crossbench/plt/posix.py

@@ -556,7 +556,7 @@ def popen(self,
           self, host_platform_cmd, bufsize=bufsize, stdout=stdout,
           stderr=stderr, stdin=stdin)
       # tmp_pid_file might not have been immediately flushed:
-      for _ in WaitRange(0.01, 2).wait_with_backoff():
+      for _ in WaitRange(0.01, timeout=2).wait_with_backoff():
         if pid_str := self.cat(temp_pid_file):
           remote_pid = int(pid_str)
           remote_popen.set_remote_pid(remote_pid)

crossbench/probes/chrome_histograms.py

@@ -380,7 +380,7 @@ def dump_histograms(self, name: str) -> dict[str, ChromeHistogramSample]:
           ready_state=ReadyState.COMPLETE,
           timeout=dt.timedelta(seconds=10))
       actions.js(self.HISTOGRAM_SEND)
-      actions.wait_js_condition(self.HISTOGRAM_WAIT, 0.1, 10.0)
+      actions.wait_js_condition(self.HISTOGRAM_WAIT, 0.1, timeout=10.0)
       data = actions.js(self.HISTOGRAM_DATA)
       histogram_list = ObjectParser.sequence(data)
       histograms: dict[str, ChromeHistogramSample] = {}

crossbench/probes/perfetto/perfetto.py

@@ -244,7 +244,7 @@ def _stop_perfetto(self) -> None:
     # TODO(cbruni): replace with terminate_gracefully
     self.browser_platform.terminate(self._perfetto_pid)
     try:
-      for _ in WaitRange(1, 30).wait_with_backoff():
+      for _ in WaitRange(1, timeout=30).wait_with_backoff():
         if not self.browser_platform.process_info(self._perfetto_pid):
           break
     except TimeoutError:

crossbench/runner/actions.py

@@ -22,6 +22,7 @@
   from crossbench import plt
   from crossbench.browsers.browser import Browser
   from crossbench.exception import ExceptionAnnotationScope
+  from crossbench.helper.wait import WaitRange
   from crossbench.runner.run import Run
   from crossbench.runner.runner import Runner
   from crossbench.runner.timing import AnyTimeUnit, Timing
@@ -117,14 +118,24 @@ def js(self,
   def wait_js_condition(
       self,
       js_code: str,
-      min_wait: AnyTimeUnit,
+      min_interval: AnyTimeUnit,
       timeout: AnyTimeUnit,
       delay: AnyTimeUnit = 0,
       absolute_time: bool = False,
       arguments: Sequence[object] = (),
       success_condition: Callable[[Any], bool] = _default_success_condition
   ) -> None:
-    wait_range = self._run.wait_range(min_wait, timeout, delay)
+    """
+    Runs the `js_code` at a regular interval until either the `timeout` is
+    reached or the return value is true. The poll interval is exponentially
+    increasing with the WaitRange's default factor:
+    1. sleep for `delay`,                    check `js_code`
+    2. sleep for `min_interval`,             check `js_code`
+    2. sleep for `min_interval * 1.01 ** 1`, check `js_code`
+    ...
+    N. sleep for `min_interval * 1.01 ** N`, check `js_code`
+    """
+    wait_range : WaitRange = self._run.wait_range(min_interval, timeout, delay)
     assert "return" in js_code, (
         f"Missing return statement in js-wait code: {js_code}")
     for _, _, time_left in wait_range.wait_with_backoff():
@@ -145,7 +156,7 @@ def wait_for_ready_state(self, ready_state: ReadyState,
         f"""
           let state = document.readyState;
           return state === '{ready_state}' || state === "complete";
-        """, 0.2, timeout.total_seconds())
+        """, 0.2, timeout)
 
   def show_url(
       self,