(#455) Added find input validation and tests

Author: s1hofmann

lib/screen.class.spec.ts

@@ -150,6 +150,19 @@ describe("Screen.", () => {
       );
     });
 
+    it("should throw on invalid search input", async () => {
+      // GIVEN
+      const SUT = new ScreenClass(providerRegistryMock);
+
+      // WHEN
+      const result = SUT.find({ foo: "bar" } as unknown as Image);
+
+      // THEN
+      await expect(result).rejects.toThrowError(
+        /find requires an Image, a text query or a window query.*/
+      );
+    });
+
     it("should resolve with sufficient confidence.", async () => {
       // GIVEN
       const matchResult = new MatchResult(0.99, searchRegion);
@@ -510,6 +523,19 @@ describe("Screen.", () => {
 
   describe("findAll", () => {
     describe("queries", () => {
+      it("should throw on invalid search input", async () => {
+        // GIVEN
+        const SUT = new ScreenClass(providerRegistryMock);
+
+        // WHEN
+        const result = SUT.findAll({ foo: "bar" } as unknown as Image);
+
+        // THEN
+        await expect(result).rejects.toThrowError(
+          /findAll requires an Image, a text query or a window query.*/
+        );
+      });
+
       it("should choose the correct finder implementation for images", async () => {
         // GIVEN
         const matchResult = new MatchResult(0.99, searchRegion);

lib/screen.class.ts

@@ -160,6 +160,14 @@ export class ScreenClass {
   ): Promise<FindResult> {
     const needle = await searchInput;
 
+    if (!isImage(needle) && !isTextQuery(needle) && !isWindowQuery(needle)) {
+      throw Error(
+        `find requires an Image, a text query or a window query, but received ${JSON.stringify(
+          needle
+        )}`
+      );
+    }
+
     try {
       if (isWindowQuery(needle)) {
         const windowHandle = await this.providerRegistry
@@ -247,6 +255,14 @@ export class ScreenClass {
   ): Promise<FindResult[]> {
     const needle = await searchInput;
 
+    if (!isImage(needle) && !isTextQuery(needle) && !isWindowQuery(needle)) {
+      throw Error(
+        `findAll requires an Image, a text query or a window query, but received ${JSON.stringify(
+          needle
+        )}`
+      );
+    }
+
     try {
       if (isWindowQuery(needle)) {
         const matches = await this.providerRegistry