Merge pull request #2 from tomtomau/wait-for-error

rfc(error): improve timeout error stack trace for waitFor timeouts
hyraiq · Aug 26, 2020 · ecc6d62 · ecc6d62
2 parents 113c329 + ff2fb3d
commit ecc6d62
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 7 deletions.
diff --git a/dist/amd/wait.js b/dist/amd/wait.js
@@ -32,10 +32,12 @@ define(["require", "exports"], function (require, exports) {
             }
             return new Promise(function (rs) { return setTimeout(rs, options.interval); }).then(wait);
         }
+        // We generate the error here to capture the stack trace, but we will only throw it if it times out
+        var timeoutError = new Error(options.present ? 'Element not found' : 'Element not removed');
         return Promise.race([
             new Promise(function (_, rj) { return setTimeout(function () {
                 timedOut = true;
-                rj(new Error(options.present ? 'Element not found' : 'Element not removed'));
+                rj(timeoutError);
             }, options.timeout); }),
             wait()
         ]);

diff --git a/dist/commonjs/wait.js b/dist/commonjs/wait.js
@@ -31,10 +31,12 @@ function waitFor(getter, options) {
         }
         return new Promise(function (rs) { return setTimeout(rs, options.interval); }).then(wait);
     }
+    // We generate the error here to capture the stack trace, but we will only throw it if it times out
+    var timeoutError = new Error(options.present ? 'Element not found' : 'Element not removed');
     return Promise.race([
         new Promise(function (_, rj) { return setTimeout(function () {
             timedOut = true;
-            rj(new Error(options.present ? 'Element not found' : 'Element not removed'));
+            rj(timeoutError);
         }, options.timeout); }),
         wait()
     ]);

diff --git a/dist/es2015/wait.js b/dist/es2015/wait.js
@@ -20,10 +20,12 @@ export function waitFor(getter, options = { present: true, interval: 50, timeout
         }
         return new Promise(rs => setTimeout(rs, options.interval)).then(wait);
     }
+    // We generate the error here to capture the stack trace, but we will only throw it if it times out
+    const timeoutError = new Error(options.present ? 'Element not found' : 'Element not removed');
     return Promise.race([
         new Promise((_, rj) => setTimeout(() => {
             timedOut = true;
-            rj(new Error(options.present ? 'Element not found' : 'Element not removed'));
+            rj(timeoutError);
         }, options.timeout)),
         wait()
     ]);

diff --git a/dist/es2017/wait.js b/dist/es2017/wait.js
@@ -20,10 +20,12 @@ export function waitFor(getter, options = { present: true, interval: 50, timeout
         }
         return new Promise(rs => setTimeout(rs, options.interval)).then(wait);
     }
+    // We generate the error here to capture the stack trace, but we will only throw it if it times out
+    const timeoutError = new Error(options.present ? 'Element not found' : 'Element not removed');
     return Promise.race([
         new Promise((_, rj) => setTimeout(() => {
             timedOut = true;
-            rj(new Error(options.present ? 'Element not found' : 'Element not removed'));
+            rj(timeoutError);
         }, options.timeout)),
         wait()
     ]);

diff --git a/dist/native-modules/wait.js b/dist/native-modules/wait.js
@@ -29,10 +29,12 @@ export function waitFor(getter, options) {
         }
         return new Promise(function (rs) { return setTimeout(rs, options.interval); }).then(wait);
     }
+    // We generate the error here to capture the stack trace, but we will only throw it if it times out
+    var timeoutError = new Error(options.present ? 'Element not found' : 'Element not removed');
     return Promise.race([
         new Promise(function (_, rj) { return setTimeout(function () {
             timedOut = true;
-            rj(new Error(options.present ? 'Element not found' : 'Element not removed'));
+            rj(timeoutError);
         }, options.timeout); }),
         wait()
     ]);

diff --git a/dist/system/wait.js b/dist/system/wait.js
@@ -32,10 +32,12 @@ System.register([], function (exports_1, context_1) {
             }
             return new Promise(function (rs) { return setTimeout(rs, options.interval); }).then(wait);
         }
+        // We generate the error here to capture the stack trace, but we will only throw it if it times out
+        var timeoutError = new Error(options.present ? 'Element not found' : 'Element not removed');
         return Promise.race([
             new Promise(function (_, rj) { return setTimeout(function () {
                 timedOut = true;
-                rj(new Error(options.present ? 'Element not found' : 'Element not removed'));
+                rj(timeoutError);
             }, options.timeout); }),
             wait()
         ]);

diff --git a/src/wait.ts b/src/wait.ts
@@ -34,11 +34,14 @@ export function waitFor<T>(getter: () => T, options: {
     return new Promise(rs => setTimeout(rs, options.interval)).then(wait);
   }
 
+  // We generate the error here to capture the stack trace, but we will only throw it if it times out
+  const timeoutError = new Error(options.present ? 'Element not found' : 'Element not removed');
+
   return Promise.race([
     new Promise(
       (_, rj) => setTimeout(() => {
         timedOut = true;
-        rj(new Error(options.present ? 'Element not found' : 'Element not removed'));
+        rj(timeoutError);
       }, options.timeout)
     ),
     wait()