Merge pull request nut-tree#206 from nut-tree/fix/205/timeout-endless-loop

(nut-tree#205) fixed timer handling in validateResult

Author: svettwer

CHANGELOG.md

@@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file.
 
 ## upcomming release
 - Feature: Create screenshot from region [(#154)](https://github.com/nut-tree/nut.js/issues/154)
+- Bugfix: Endless loop in timeout function for long-running actions returning undefined [(#205)](https://github.com/nut-tree/nut.js/issues/205) 
 
 ## 1.5.0
 

lib/util/poll-action.function.spec.ts

@@ -130,13 +130,34 @@ describe("poll-action", () => {
         });
 
         // WHEN
-        try {
-            await timeout(updateInterval, maxDuration, action);
-        } catch (e) {
-            expect(e).toEqual(`Action timed out after ${maxDuration} ms`);
-        }
+        const SUT = () => timeout(updateInterval, maxDuration, action);
+
+        // THEN
+        await expect(SUT).rejects.toBe(`Action timed out after ${maxDuration} ms`);
+        expect(action).toBeCalledTimes(1);
+    });
+
+    it("should fail after timeout if no result is returned from long running action", async (done) => {
+        // GIVEN
+        const updateInterval = 100;
+        const maxDuration = 200;
+        const action = jest.fn(() => {
+            return new Promise<boolean>((resolve) => {
+                setTimeout(() => {
+                    resolve((undefined as unknown) as boolean);
+                }, 210);
+            });
+        });
+
+        // WHEN
+        const SUT = () => timeout(updateInterval, maxDuration, action);
 
         // THEN
+        await expect(SUT).rejects.toBe(`Action timed out after ${maxDuration} ms`);
         expect(action).toBeCalledTimes(1);
+        setTimeout(() => {
+            expect(action).toBeCalledTimes(1);
+            done();
+        }, 500);
     });
 });

lib/util/poll-action.function.ts

@@ -8,7 +8,7 @@ export function timeout<R>(updateIntervalMs: number, maxDurationMs: number, acti
     }
 
     function validateResult(result: R){
-      if (!result) {
+      if (!result && !timerCleaned) {
         interval = setTimeout(executeInterval, updateIntervalMs);
       } else {
         cleanupTimer();