(#241) Added abort signal to OptionalSearchParameters

Author: s1hofmann

lib/optionalsearchparameters.class.ts

@@ -1,14 +1,17 @@
-import { Region } from "./region.class";
+import {Region} from "./region.class";
+import {AbortSignal} from "node-abort-controller";
 
 /**
  * {@link OptionalSearchParameters} serves as a data class holding location parameters for image search
  */
 export class OptionalSearchParameters {
-  /**
-   * {@link OptionalSearchParameters} class constructor
-   * @param searchRegion Optional {@link Region} to limit the search space to
-   * @param confidence Optional confidence value to configure image match confidence
-   * @param searchMultipleScales Optional flag to indicate if the search should be conducted at different scales
-   */
-  constructor(public searchRegion?: Region, public confidence?: number, public searchMultipleScales?: boolean) {}
+    /**
+     * {@link OptionalSearchParameters} class constructor
+     * @param searchRegion Optional {@link Region} to limit the search space to
+     * @param confidence Optional confidence value to configure image match confidence
+     * @param searchMultipleScales Optional flag to indicate if the search should be conducted at different scales
+     * @param abort An {@link AbortSignal} to cancel an ongoing call to `waitFor`
+     */
+    constructor(public searchRegion?: Region, public confidence?: number, public searchMultipleScales?: boolean, public abort?: AbortSignal) {
+    }
 }

lib/screen.class.e2e.spec.ts

@@ -124,7 +124,7 @@ describe("Screen.", () => {
 
         // WHEN
         const start = Date.now();
-        SUT.waitFor("calculator.png", timeout, undefined, signal).catch(e => {
+        SUT.waitFor("calculator.png", timeout, {abort: signal}).catch(e => {
             const end = Date.now();
 
             // THEN

lib/screen.class.ts

@@ -8,8 +8,7 @@ import {MatchRequest} from "./match-request.class";
 import {MatchResult} from "./match-result.class";
 import {Region} from "./region.class";
 import {timeout} from "./util/timeout.function";
-import { Image } from "./image.class";
-import {AbortSignal} from "node-abort-controller";
+import {Image} from "./image.class";
 
 export type FindHookCallback = (target: MatchResult) => Promise<void>;
 
@@ -102,16 +101,16 @@ export class Screen {
         );
 
         function validateSearchRegion(search: Region, screen: Region) {
-            if ( search.left < 0 || search.top < 0 || search.width < 0 || search.height < 0 ) {
+            if (search.left < 0 || search.top < 0 || search.width < 0 || search.height < 0) {
                 throw new Error(`Negative values in search region ${search}`)
             }
-            if ( isNaN(search.left) || isNaN(search.top) || isNaN(search.width) || isNaN(search.height) ) {
+            if (isNaN(search.left) || isNaN(search.top) || isNaN(search.width) || isNaN(search.height)) {
                 throw new Error(`NaN values in search region ${search}`)
             }
-            if ( search.width < 2 || search.height < 2 ) {
+            if (search.width < 2 || search.height < 2) {
                 throw new Error(`Search region ${search} is not large enough. Must be at least two pixels in both width and height.`)
             }
-            if ( search.left + search.width > screen.width || search.top + search.height > screen.height ) {
+            if (search.left + search.width > screen.width || search.top + search.height > screen.height) {
                 throw new Error(`Search region ${search} extends beyond screen boundaries (${screen.width}x${screen.height})`)
             }
         }
@@ -166,15 +165,13 @@ export class Screen {
      * @param templateImageFilename Filename of the template image, relative to {@link Screen.config.resourceDirectory}
      * @param timeoutMs Timeout in milliseconds after which {@link waitFor} fails
      * @param params {@link LocationParameters} which are used to fine tune search region and / or match confidence
-     * @param abort An {@link AbortSignal} to cancel an ongoing call to `waitFor`
      */
     public async waitFor(
         templateImageFilename: string,
         timeoutMs: number = 5000,
         params?: LocationParameters,
-        abort?: AbortSignal
     ): Promise<Region> {
-        return timeout(500, timeoutMs, () => this.find(templateImageFilename, params), {signal: abort});
+        return timeout(500, timeoutMs, () => this.find(templateImageFilename, params), {signal: params?.abort});
     }
 
     /**
@@ -242,8 +239,8 @@ export class Screen {
         fileName: string,
         fileFormat: FileType,
         filePath: string,
-        fileNamePrefix: string ,
-        fileNamePostfix: string){
+        fileNamePrefix: string,
+        fileNamePostfix: string) {
         const outputPath = generateOutputPath(fileName, {
             path: filePath,
             postfix: fileNamePostfix,

lib/util/timeout.function.spec.ts

@@ -1,7 +1,7 @@
 import {timeout} from "./timeout.function";
 import AbortController from "node-abort-controller";
 
-describe("poll-action", () => {
+describe("timeout", () => {
     it("should timeout after maxDuration if action rejects", async () => {
         // GIVEN
         const updateInterval = 200;