Merge branch 'develop' into scales-configurable

Author: zephraph

README.md

@@ -5,7 +5,7 @@
 |Master |[![Build Status](https://travis-ci.com/nut-tree/nut.js.svg?branch=master)](https://travis-ci.com/nut-tree/nut.js)|[![Build status](https://ci.appveyor.com/api/projects/status/iohwxc5t46gcuvby/branch/master?svg=true)](https://ci.appveyor.com/project/s1hofmann/nut-js/branch/master)|
 |Develop|[![Build Status](https://travis-ci.com/nut-tree/nut.js.svg?branch=develop)](https://travis-ci.com/nut-tree/nut.js)|[![Build status](https://ci.appveyor.com/api/projects/status/iohwxc5t46gcuvby/branch/develop?svg=true)](https://ci.appveyor.com/project/s1hofmann/nut-js/branch/develop)|
 
-
+![Supported node versions](https://img.shields.io/badge/node-v10.x%20--%20v14.x-green)
 [![SonarCloud badge](https://sonarcloud.io/api/project_badges/measure?project=nut-tree%3Anut.js&metric=alert_status)](https://sonarcloud.io/dashboard?id=nut-tree%3Anut.js)
 [![SonarCloud Coverage](https://sonarcloud.io/api/project_badges/measure?project=nut-tree%3Anut.js&metric=coverage)](https://sonarcloud.io/component_measures?id=nut-tree%3Anut.js&metric=coverage)
 
@@ -35,6 +35,9 @@ but additionally gives you the possibility to navigate the screen based on image
 
 [nut-tree/trailmix](https://github.com/nut-tree/trailmix) contains a set of ready to use examples which demo the usage ot nut.js.
 
+# Discussion
+
+In [nut-tree/rfc](https://github.com/nut-tree/rfc) documents regarding larger design / implementation changes in nut.js are up for discussion.
 # Modules
 
 This list gives an overview on currently implemented and planned functionality.

lib/provider/opencv/find-edges.function.spec.ts

@@ -118,4 +118,25 @@ describe("poll-action", () => {
         expect(action).toBeCalledTimes(1);
         expect((end - start)).toBeLessThan(updateInterval);
     });
+
+    it("should fail if action does not resolve within timeout", async () => {
+        // GIVEN
+        const updateInterval = 100;
+        const maxDuration = 200;
+        const action = jest.fn(() => {
+            return new Promise((_, reject) => {
+                setTimeout(() => reject(), 300);
+            })
+        });
+
+        // WHEN
+        try {
+            await timeout(updateInterval, maxDuration, action);
+        } catch (e) {
+            expect(e).toEqual(`Action timed out after ${maxDuration} ms`);
+        }
+
+        // THEN
+        expect(action).toBeCalledTimes(1);
+    });
 });

lib/provider/opencv/find-edges.function.ts

@@ -1,41 +1,45 @@
 export function timeout<R>(updateIntervalMs: number, maxDurationMs: number, action: (...params: any) => Promise<R>): Promise<R> {
   return new Promise<R>((resolve, reject) => {
     let interval: NodeJS.Timeout;
-    const maxTimeout = setTimeout(
-      () => {
-        clearTimeout(maxTimeout);
-        if (interval) {
-          clearTimeout(interval);
-        }
-        reject(`Action timed out after ${maxDurationMs} ms`);
-      },
-      maxDurationMs
-    );
-    const startInterval = () => {
-      interval = setTimeout(function intervalFunc() {
-        action().then((result) => {
-          if (!result) {
-            interval = setTimeout(intervalFunc, updateIntervalMs);
-          } else {
-            clearTimeout(maxTimeout);
-            clearTimeout(interval);
-            resolve(result);
-          }
-        }).catch(() => {
-          interval = setTimeout(intervalFunc, updateIntervalMs);
-        });
-      }, updateIntervalMs);
-    };
+    let timerCleaned = false
+
+    function executeInterval() {
+      action().then(validateResult).catch(handleRejection);
+    }
 
-    action().then((result) => {
+    function validateResult(result: R){
       if (!result) {
-        startInterval();
+        interval = setTimeout(executeInterval, updateIntervalMs);
       } else {
-        clearTimeout(maxTimeout);
+        cleanupTimer();
         resolve(result);
       }
-    }).catch(() => {
-      startInterval();
-    });
+    }
+
+    function handleRejection() {
+      if(!timerCleaned){
+        interval = setTimeout(executeInterval, updateIntervalMs);
+      }
+    }
+
+    function cleanupTimer(){
+      timerCleaned = true
+      if(maxTimeout){
+        clearTimeout(maxTimeout);
+      }
+      if(interval){
+        clearTimeout(interval);
+      }
+    }
+
+    const maxTimeout = setTimeout(
+        () => {
+          cleanupTimer();
+          reject(`Action timed out after ${maxDurationMs} ms`);
+        },
+        maxDurationMs
+    );
+
+    executeInterval()
   });
 }