Use toBeInstanceOf consistently in the unit-tests

Snuffleupagus · Snuffleupagus · commit 7609a422096c · 2026-03-19T17:18:25.000+01:00
There's currently a lot of unit-tests that manually check `instanceof`, let's replace that with the built-in Jasmine matcher function; see https://jasmine.github.io/api/edge/matchers.html#toBeInstanceOf
diff --git a/test/unit/api_spec.js b/test/unit/api_spec.js
diff --git a/test/unit/canvas_factory_spec.js b/test/unit/canvas_factory_spec.js
@@ -46,8 +46,8 @@ describe("canvas_factory", function () {
       }
 
       const { canvas, context } = canvasFactory.create(20, 40);
-      expect(canvas instanceof HTMLCanvasElement).toBe(true);
-      expect(context instanceof CanvasRenderingContext2D).toBe(true);
+      expect(canvas).toBeInstanceOf(HTMLCanvasElement);
+      expect(context).toBeInstanceOf(CanvasRenderingContext2D);
       expect(canvas.width).toBe(20);
       expect(canvas.height).toBe(40);
     });
@@ -83,8 +83,8 @@ describe("canvas_factory", function () {
       canvasFactory.reset(canvasAndContext, 60, 80);
 
       const { canvas, context } = canvasAndContext;
-      expect(canvas instanceof HTMLCanvasElement).toBe(true);
-      expect(context instanceof CanvasRenderingContext2D).toBe(true);
+      expect(canvas).toBeInstanceOf(HTMLCanvasElement);
+      expect(context).toBeInstanceOf(CanvasRenderingContext2D);
       expect(canvas.width).toBe(60);
       expect(canvas.height).toBe(80);
     });
diff --git a/test/unit/cmap_spec.js b/test/unit/cmap_spec.js
@@ -139,7 +139,7 @@ describe("cmap", function () {
       fetchBuiltInCMap,
       useCMap: null,
     });
-    expect(cmap instanceof CMap).toEqual(true);
+    expect(cmap).toBeInstanceOf(CMap);
     expect(cmap.useCMap).not.toBeNull();
     expect(cmap.builtInCMap).toBeFalsy();
     expect(cmap.length).toEqual(0x20a7);
@@ -166,7 +166,7 @@ describe("cmap", function () {
       fetchBuiltInCMap,
       useCMap: null,
     });
-    expect(cmap instanceof CMap).toEqual(true);
+    expect(cmap).toBeInstanceOf(CMap);
     expect(cmap.useCMap).toBeNull();
     expect(cmap.builtInCMap).toBeTruthy();
     expect(cmap.length).toEqual(0x20a7);
@@ -179,7 +179,7 @@ describe("cmap", function () {
       fetchBuiltInCMap,
       useCMap: null,
     });
-    expect(cmap instanceof IdentityCMap).toEqual(true);
+    expect(cmap).toBeInstanceOf(IdentityCMap);
     expect(cmap.vertical).toEqual(false);
     expect(cmap.length).toEqual(0x10000);
     expect(function () {
@@ -198,7 +198,7 @@ describe("cmap", function () {
       // Shouldn't get here.
       expect(false).toEqual(true);
     } catch (reason) {
-      expect(reason instanceof Error).toEqual(true);
+      expect(reason).toBeInstanceOf(Error);
       expect(reason.message).toEqual("Unknown CMap name: null");
     }
   });
@@ -219,7 +219,7 @@ describe("cmap", function () {
       // Shouldn't get here.
       expect(false).toEqual(true);
     } catch (reason) {
-      expect(reason instanceof Error).toEqual(true);
+      expect(reason).toBeInstanceOf(Error);
       expect(reason.message).toEqual(
         "Ensure that the `cMapUrl` and `cMapPacked` API parameters are provided."
       );
@@ -245,7 +245,7 @@ describe("cmap", function () {
       // Shouldn't get here.
       expect(false).toEqual(true);
     } catch (reason) {
-      expect(reason instanceof Error).toEqual(true);
+      expect(reason).toBeInstanceOf(Error);
       const message = reason.message;
       expect(message.startsWith("Unable to load CMap at: ")).toEqual(true);
       expect(message.endsWith("/external/bcmaps/Adobe-Japan1-1")).toEqual(true);
diff --git a/test/unit/crypto_spec.js b/test/unit/crypto_spec.js
@@ -565,7 +565,7 @@ describe("CipherTransformFactory", function () {
       // Shouldn't get here.
       expect(false).toEqual(true);
     } catch (ex) {
-      expect(ex instanceof PasswordException).toEqual(true);
+      expect(ex).toBeInstanceOf(PasswordException);
       expect(ex.code).toEqual(PasswordResponses.NEED_PASSWORD);
     }
   }
@@ -578,7 +578,7 @@ describe("CipherTransformFactory", function () {
       // Shouldn't get here.
       expect(false).toEqual(true);
     } catch (ex) {
-      expect(ex instanceof PasswordException).toEqual(true);
+      expect(ex).toBeInstanceOf(PasswordException);
       expect(ex.code).toEqual(PasswordResponses.INCORRECT_PASSWORD);
     }
   }
diff --git a/test/unit/evaluator_spec.js b/test/unit/evaluator_spec.js
@@ -296,7 +296,7 @@ describe("evaluator", function () {
           // Shouldn't get here.
           expect(false).toEqual(true);
         } catch (reason) {
-          expect(reason instanceof FormatError).toEqual(true);
+          expect(reason).toBeInstanceOf(FormatError);
           expect(reason.message).toEqual(
             "Invalid command l: expected 2 args, but received 1 args."
           );
@@ -332,7 +332,7 @@ describe("evaluator", function () {
         // Shouldn't get here.
         expect(false).toEqual(true);
       } catch (reason) {
-        expect(reason instanceof FormatError).toEqual(true);
+        expect(reason).toBeInstanceOf(FormatError);
         expect(reason.message).toEqual("XObject should be a stream");
       }
     });
diff --git a/test/unit/event_utils_spec.js b/test/unit/event_utils_spec.js
@@ -243,7 +243,7 @@ describe("event_utils", function () {
           expect(false).toEqual(true);
         },
         function (reason) {
-          expect(reason instanceof Error).toEqual(true);
+          expect(reason).toBeInstanceOf(Error);
         }
       );
 
@@ -256,7 +256,7 @@ describe("event_utils", function () {
           expect(false).toEqual(true);
         },
         function (reason) {
-          expect(reason instanceof Error).toEqual(true);
+          expect(reason).toBeInstanceOf(Error);
         }
       );
 
@@ -270,7 +270,7 @@ describe("event_utils", function () {
           expect(false).toEqual(true);
         },
         function (reason) {
-          expect(reason instanceof Error).toEqual(true);
+          expect(reason).toBeInstanceOf(Error);
         }
       );
 
diff --git a/test/unit/message_handler_spec.js b/test/unit/message_handler_spec.js
@@ -194,7 +194,7 @@ describe("message_handler", function () {
         expect(false).toEqual(true);
       } catch (reason) {
         expect(log).toEqual("01pe");
-        expect(reason instanceof UnknownErrorException).toEqual(true);
+        expect(reason).toBeInstanceOf(UnknownErrorException);
         expect(reason.message).toEqual("should not read when errored");
       }
     });
diff --git a/test/unit/network_spec.js b/test/unit/network_spec.js
@@ -155,7 +155,7 @@ describe("network", function () {
         // Shouldn't get here.
         expect(false).toEqual(true);
       } catch (ex) {
-        expect(ex instanceof ResponseException).toEqual(true);
+        expect(ex).toBeInstanceOf(ResponseException);
         expect(ex.status).toEqual(0);
         expect(ex.missing).toEqual(false);
       }
diff --git a/test/unit/network_utils_spec.js b/test/unit/network_utils_spec.js
@@ -370,7 +370,7 @@ describe("network_utils", function () {
     function testCreateResponseError(url, status, missing) {
       const error = createResponseError(status, url);
 
-      expect(error instanceof ResponseException).toEqual(true);
+      expect(error).toBeInstanceOf(ResponseException);
       expect(error.message).toEqual(
         `Unexpected server response (${status}) while retrieving PDF "${url.href}".`
       );
diff --git a/test/unit/parser_spec.js b/test/unit/parser_spec.js
@@ -240,15 +240,15 @@ describe("parser", function () {
           const lexer = new Lexer(input);
 
           let obj = lexer.getObj();
-          expect(obj instanceof Cmd).toEqual(true);
+          expect(obj).toBeInstanceOf(Cmd);
           expect(obj.cmd).toEqual("\x14");
 
           obj = lexer.getObj();
-          expect(obj instanceof Cmd).toEqual(true);
+          expect(obj).toBeInstanceOf(Cmd);
           expect(obj.cmd).toEqual("q");
 
           obj = lexer.getObj();
-          expect(obj instanceof Cmd).toEqual(true);
+          expect(obj).toBeInstanceOf(Cmd);
           expect(obj.cmd).toEqual("Q");
 
           obj = lexer.getObj();
diff --git a/test/unit/primitives_spec.js b/test/unit/primitives_spec.js
@@ -371,8 +371,8 @@ describe("primitives", function () {
       const mergedFontDict = mergedDict.get("Font");
       const mergedSubFontDict = mergedSubDict.get("Font");
 
-      expect(mergedFontDict instanceof Dict).toEqual(true);
-      expect(mergedSubFontDict instanceof Dict).toEqual(true);
+      expect(mergedFontDict).toBeInstanceOf(Dict);
+      expect(mergedSubFontDict).toBeInstanceOf(Dict);
 
       const mergedFontDictKeys = [...mergedFontDict.getKeys()];
       const mergedSubFontDictKeys = [...mergedSubFontDict.getKeys()];
diff --git a/test/unit/svg_factory_spec.js b/test/unit/svg_factory_spec.js
@@ -46,7 +46,7 @@ describe("svg_factory", function () {
       }
 
       const svg = svgFactory.create(20, 40);
-      expect(svg instanceof SVGSVGElement).toBe(true);
+      expect(svg).toBeInstanceOf(SVGSVGElement);
       expect(svg.getAttribute("version")).toBe("1.1");
       expect(svg.getAttribute("width")).toBe("20px");
       expect(svg.getAttribute("height")).toBe("40px");
@@ -66,7 +66,7 @@ describe("svg_factory", function () {
       }
 
       const svg = svgFactory.createElement("svg:rect");
-      expect(svg instanceof SVGRectElement).toBe(true);
+      expect(svg).toBeInstanceOf(SVGRectElement);
     });
   });
 });
diff --git a/test/unit/util_spec.js b/test/unit/util_spec.js
@@ -35,8 +35,8 @@ describe("util", function () {
       }
 
       const exception = new DerivedException("Something went wrong");
-      expect(exception instanceof DerivedException).toEqual(true);
-      expect(exception instanceof BaseException).toEqual(true);
+      expect(exception).toBeInstanceOf(DerivedException);
+      expect(exception).toBeInstanceOf(BaseException);
       expect(exception.message).toEqual("Something went wrong");
       expect(exception.name).toEqual("DerivedException");
       expect(exception.foo).toEqual("bar");

Original file line number	Diff line number	Diff line change
`@@ -565,7 +565,7 @@ describe("CipherTransformFactory", function () {`
`565`	`565`	`// Shouldn't get here.`
`566`	`566`	`expect(false).toEqual(true);`
`567`	`567`	`} catch (ex) {`
`568`		`- expect(ex instanceof PasswordException).toEqual(true);`
	`568`	`+ expect(ex).toBeInstanceOf(PasswordException);`
`569`	`569`	`expect(ex.code).toEqual(PasswordResponses.NEED_PASSWORD);`
`570`	`570`	`}`
`571`	`571`	`}`
`@@ -578,7 +578,7 @@ describe("CipherTransformFactory", function () {`
`578`	`578`	`// Shouldn't get here.`
`579`	`579`	`expect(false).toEqual(true);`
`580`	`580`	`} catch (ex) {`
`581`		`- expect(ex instanceof PasswordException).toEqual(true);`
	`581`	`+ expect(ex).toBeInstanceOf(PasswordException);`
`582`	`582`	`expect(ex.code).toEqual(PasswordResponses.INCORRECT_PASSWORD);`
`583`	`583`	`}`
`584`	`584`	`}`
Original file line number	Diff line number	Diff line change
`@@ -194,7 +194,7 @@ describe("message_handler", function () {`
`194`	`194`	`expect(false).toEqual(true);`
`195`	`195`	`} catch (reason) {`
`196`	`196`	`expect(log).toEqual("01pe");`
`197`		`- expect(reason instanceof UnknownErrorException).toEqual(true);`
	`197`	`+ expect(reason).toBeInstanceOf(UnknownErrorException);`
`198`	`198`	`expect(reason.message).toEqual("should not read when errored");`
`199`	`199`	`}`
`200`	`200`	`});`
Original file line number	Diff line number	Diff line change
`@@ -155,7 +155,7 @@ describe("network", function () {`
`155`	`155`	`// Shouldn't get here.`
`156`	`156`	`expect(false).toEqual(true);`
`157`	`157`	`} catch (ex) {`
`158`		`- expect(ex instanceof ResponseException).toEqual(true);`
	`158`	`+ expect(ex).toBeInstanceOf(ResponseException);`
`159`	`159`	`expect(ex.status).toEqual(0);`
`160`	`160`	`expect(ex.missing).toEqual(false);`
`161`	`161`	`}`