Merge branch 'develop'

Author: s1hofmann

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.1.0-beta.3
+
+- Improved error handling on image search
+
+## 0.1.0-beta.2
+
+- Changed default `screen.config.resourceDirectory` to use `process.cwd()`
 
 ## 0.1.0-beta.1
 

index.e2e.spec.ts

@@ -33,6 +33,13 @@ const close = async () => {
   await mouse.leftClick();
 };
 
+describe("E2E screen test", () => {
+  it("should throw on invalid images", async () => {
+    jest.setTimeout(30000);
+    await expect(screen.find("mouse.png")).rejects.toContain("Failed to load image");
+  });
+});
+
 describe("E2E demo", () => {
   it("should run without throwing", async () => {
     jest.setTimeout(30000);

lib/adapter/vision.adapter.class.ts

@@ -57,8 +57,14 @@ export class VisionAdapter {
   public async findOnScreenRegion(
     matchRequest: MatchRequest,
   ): Promise<MatchResult> {
-    const matchResult = await this.finder.findMatch(matchRequest);
-    return Promise.resolve(matchResult);
+    return new Promise<MatchResult>(async (resolve, reject) => {
+      try {
+        const matchResult = await this.finder.findMatch(matchRequest);
+        resolve(matchResult);
+      } catch (e) {
+        reject(e);
+      }
+    });
   }
 
   /**

lib/provider/opencv/template-matching-finder.class.spec.ts

@@ -60,6 +60,8 @@ describe("Template-matching finder", () => {
     const result = SUT.findMatch(matchRequest);
 
     // THEN
-    expect(result).rejects.toEqual(`Failed to load image from '${pathToHaystack}'`);
+    await expect(result)
+      .rejects
+      .toThrowError(`Failed to load ${pathToHaystack}. Reason: 'Failed to load image from '${pathToHaystack}''.`);
   });
 });

lib/provider/opencv/template-matching-finder.class.ts

@@ -124,7 +124,7 @@ export class TemplateMatchingFinder implements FinderInterface {
       needle = await this.loadNeedle(needleInput);
     } catch (e) {
       throw new Error(
-        `Failed to load ${matchRequest.pathToNeedle}. Reason: '${e.message}'.`,
+        `Failed to load ${matchRequest.pathToNeedle}. Reason: '${e}'.`,
       );
     }
     if (!needle || needle.empty) {
@@ -190,12 +190,16 @@ export class TemplateMatchingFinder implements FinderInterface {
   }
 
   public async findMatch(matchRequest: MatchRequest, debug: boolean = false): Promise<MatchResult> {
-    const matches = await this.findMatches(matchRequest, debug);
-    return new Promise<MatchResult>((resolve, reject) => {
-      if (matches.length === 0) {
-        reject(`Unable to locate ${matchRequest.pathToNeedle}, no match!`);
+    return new Promise<MatchResult>(async (resolve, reject) => {
+      try {
+        const matches = await this.findMatches(matchRequest, debug);
+        if (matches.length === 0) {
+          reject(`Unable to locate ${matchRequest.pathToNeedle}, no match!`);
+        }
+        resolve(matches[0]);
+      } catch (e) {
+        reject(e);
       }
-      resolve(matches[0]);
     });
   }
 

lib/screen.class.spec.ts

@@ -61,6 +61,21 @@ describe("Screen.", () => {
       .toEqual(`No match for ${imagePath}. Required: ${SUT.config.confidence}, given: ${matchResult.confidence}`);
   });
 
+  it("should reject when search fails.", async () => {
+    const rejectionReason = "Search failed.";
+    VisionAdapter.prototype.findOnScreenRegion = jest.fn(() => {
+      return Promise.reject(rejectionReason);
+    });
+
+    const visionAdapterMock = new VisionAdapter();
+
+    const SUT = new Screen(visionAdapterMock);
+    const imagePath = "test/path/to/image.png";
+    await expect(SUT.find(imagePath))
+      .rejects
+      .toEqual(`Searching for ${imagePath} failed. Reason: '${rejectionReason}'`);
+  });
+
   it("should override default confidence value with parameter.", async () => {
     const minMatch = 0.8;
     const matchResult = new MatchResult(minMatch, searchRegion);

lib/screen.class.ts

@@ -44,16 +44,21 @@ export class Screen {
       minMatch,
     );
 
-    const matchResult = await this.vision.findOnScreenRegion(matchRequest);
-
-    return new Promise<Region>((resolve, reject) => {
-      if (matchResult.confidence >= minMatch) {
-        resolve(matchResult.location);
-      } else {
+    return new Promise<Region>(async (resolve, reject) => {
+      try {
+        const matchResult = await this.vision.findOnScreenRegion(matchRequest);
+        if (matchResult.confidence >= minMatch) {
+          resolve(matchResult.location);
+        } else {
+          reject(
+            `No match for ${pathToNeedle}. Required: ${minMatch}, given: ${
+              matchResult.confidence
+              }`,
+          );
+        }
+      } catch (e) {
         reject(
-          `No match for ${pathToNeedle}. Required: ${minMatch}, given: ${
-            matchResult.confidence
-            }`,
+          `Searching for ${pathToNeedle} failed. Reason: '${e}'`,
         );
       }
     });