added tests verifying search region validation

Author: svettwer

lib/screen.class.spec.ts

@@ -283,6 +283,47 @@ describe("Screen.", () => {
             // THEN
             expect(matchRegion).toEqual(expectedMatchRegion);
         })
+
+        it.each([
+            ["with negative x coordinate", new Region(-1, 0, 100, 100)],
+            ["with negative y coordinate", new Region(0, -1, 100, 100)],
+            ["with negative width", new Region(0, 0, -100, 100)],
+            ["with negative height", new Region(0, 0, 100, -100)],
+            ["with region outside screen on x axis", new Region(1100, 0, 100, 100)],
+            ["with region outside screen on y axis", new Region(0, 1100, 100, 100)],
+            ["with region bigger than screen on x axis", new Region(0, 0, 1100, 100)],
+            ["with region bigger than screen on y axis", new Region(0, 0, 1000, 1100)],
+            ["with region of 1 px width", new Region(0, 0, 1, 1100)],
+            ["with region of 1 px height", new Region(0, 0, 100, 1)],
+            ["with region leaving screen on x axis", new Region(600, 0, 500, 100)],
+            ["with region leaving screen on y axis", new Region(0, 500, 100, 600)],
+            ["with NaN x coordinate", new Region("a" as unknown as number, 0, 100, 100)],
+            ["with NaN y coordinate", new Region(0, "a" as unknown as number, 100, 600)],
+            ["with NaN on width", new Region(0, 0, "a" as unknown as number, 100)],
+            ["with NaN on height", new Region(0, 0, 100, "a" as unknown as number)],
+        ])("should reject search regions %s", async (_, region) =>{
+
+            // GIVEN
+            const imagePath = "test/path/to/image.png"
+            const visionAdapterMock = new VisionAdapter();
+
+            const SUT = new Screen(visionAdapterMock);
+
+            const matchResult = new MatchResult(0.99, region);
+            VisionAdapter.prototype.findOnScreenRegion = jest.fn(() => {
+                return Promise.resolve(matchResult);
+            });
+
+            // WHEN
+            const findPromise = SUT.find(
+                imagePath,
+                {
+                    searchRegion: region
+                });
+
+            // THEN
+            await expect(findPromise).rejects.toContain(`Searching for ${imagePath} failed. Reason:`);
+        })
     });
 
 

lib/screen.class.ts

@@ -100,20 +100,24 @@ export class Screen {
             searchMultipleScales
         );
 
+        function validateSearchRegion(search: Region, screen: Region) {
+            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) ) {
+                throw new Error(`NaN values in search region ${search}`)
+            }
+            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 ) {
+                throw new Error(`Search region ${search} extends beyond screen boundaries (${screen.width}x${screen.height})`)
+            }
+        }
+
         return new Promise<Region>(async (resolve, reject) => {
             try {
-                if ( searchRegion.left < 0 || searchRegion.top < 0 || searchRegion.width < 0 || searchRegion.height < 0 ) {
-                    throw new Error(`Negative values in search region ${searchRegion}`)
-                }
-                if ( isNaN(searchRegion.left) || isNaN(searchRegion.top) || isNaN(searchRegion.width) || isNaN(searchRegion.height) ) {
-                    throw new Error(`NaN values in search region ${searchRegion}`)
-                }
-                if ( searchRegion.width < 2 || searchRegion.height < 2 ) {
-                    throw new Error(`Search region ${searchRegion} is not large enough. Must be at least two pixels in both width and height.`)
-                }
-                if ( searchRegion.left + searchRegion.width > screenSize.width || searchRegion.top + searchRegion.height > screenSize.height ) {
-                    throw new Error(`Search region ${searchRegion} extends beyond screen boundaries (${screenSize.width}x${screenSize.height})`)
-                }
+                validateSearchRegion(searchRegion, screenSize);
                 const matchResult = await this.vision.findOnScreenRegion(matchRequest);
                 if (matchResult.confidence >= minMatch) {
                     const possibleHooks = this.findHooks.get(templateImageFilename) || [];