Bug 1868591 - Fix PollPromise timeout warning. r=webdriver-reviewers,jdescottes

Differential Revision: https://phabricator.services.mozilla.com/D195783

Author: lutien

remote/shared/Sync.sys.mjs

@@ -267,6 +267,7 @@ export function PollPromise(func, options = {}) {
     timeout = null,
   } = options;
   const timer = Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer);
+  let didTimeOut = false;
 
   if (typeof func != "function") {
     throw new TypeError();
@@ -306,6 +307,7 @@ export function PollPromise(func, options = {}) {
             typeof end != "undefined" &&
             (start == end || new Date().getTime() >= end)
           ) {
+            didTimeOut = true;
             resolve(rejected);
           }
         })
@@ -319,7 +321,7 @@ export function PollPromise(func, options = {}) {
     timer.init(evalFn, interval, TYPE_REPEATING_SLACK);
   }).then(
     res => {
-      if (Number.isInteger(timeout)) {
+      if (didTimeOut) {
         lazy.logger.warn(`${errorMessage} after ${timeout} ms`);
       }
       timer.cancel();

remote/shared/test/xpcshell/test_Sync.js

@@ -9,6 +9,10 @@ const { setTimeout } = ChromeUtils.importESModule(
 const { AnimationFramePromise, Deferred, EventPromise, PollPromise } =
   ChromeUtils.importESModule("chrome://remote/content/shared/Sync.sys.mjs");
 
+const { Log } = ChromeUtils.importESModule(
+  "resource://gre/modules/Log.sys.mjs"
+);
+
 /**
  * Mimic a DOM node for listening for events.
  */
@@ -63,6 +67,21 @@ class MockElement {
   }
 }
 
+class MockAppender extends Log.Appender {
+  constructor(formatter) {
+    super(formatter);
+    this.messages = [];
+  }
+
+  append(message) {
+    this.doAppend(message);
+  }
+
+  doAppend(message) {
+    this.messages.push(message);
+  }
+}
+
 add_task(async function test_AnimationFramePromise() {
   let called = false;
   let win = {
@@ -387,3 +406,31 @@ add_task(async function test_PollPromise_interval() {
   );
   equal(2, nevals);
 });
+
+add_task(async function test_PollPromise_resolve() {
+  const log = Log.repository.getLogger("RemoteAgent");
+  const appender = new MockAppender(new Log.BasicFormatter());
+  appender.level = Log.Level.Info;
+  log.addAppender(appender);
+
+  const errorMessage = "PollingFailed";
+  const timeout = 100;
+
+  await new PollPromise(
+    (resolve, reject) => {
+      resolve();
+    },
+    { timeout, errorMessage }
+  );
+  Assert.equal(appender.messages.length, 0);
+
+  await new PollPromise(
+    (resolve, reject) => {
+      reject();
+    },
+    { timeout, errorMessage: "PollingFailed" }
+  );
+  Assert.equal(appender.messages.length, 1);
+  Assert.equal(appender.messages[0].level, Log.Level.Warn);
+  Assert.equal(appender.messages[0].message, "PollingFailed after 100 ms");
+});