Merge pull request #284 from cuthbertLab/types-for-tests

Add better types for tests

Author: mscuthbert

tests/run_qunit_playwright.ts

@@ -1,21 +1,28 @@
-import { chromium } from '@playwright/test';
+import { chromium, type Browser, type Page } from '@playwright/test';
 
 /**
  * Loads the Vite-served QUnit page in headless Chromium and exits nonzero on failures.
  */
 async function main(): Promise<void> {
-    const browser = await chromium.launch();
-    const page = await browser.newPage();
+    const browser: Browser = await chromium.launch();
+    const page: Page = await browser.newPage();
 
     // Assumes vite dev server is running on 5173
-    await page.goto('http://localhost:5173/tests/', {waitUntil: 'domcontentloaded'});
+    await page.goto(
+        'http://localhost:5173/tests/',
+        {waitUntil: 'domcontentloaded'},
+    );
 
-    // Wait for QUnit to finish
-    await page.waitForFunction(() => (window as any).__qunit_done__ === true, null, {timeout: 120_000});
+    // Wait up to 2 minutes for QUnit to finish.  See types/qunit-globals.d.ts for the added python dunders
+    await page.waitForFunction(
+        () => globalThis.__qunit_done__,  // wait until this is Truthy
+        null,
+        {timeout: 120_000},  // in ms
+    );
 
     const { results, failures } = await page.evaluate(() => ({
-        results: (window as any).__qunit_results__,
-        failures: (window as any).__qunit_failures__ ?? [],
+        results: globalThis.__qunit_results__,
+        failures: globalThis.__qunit_failures__ ?? [],
     }));
     await browser.close();
 

tests/runner.ts

@@ -7,7 +7,6 @@ import * as music21 from '../src/main';
 // Import the test registry
 import m21_tests from './loadAll';
 
-
 type QUnit_fail = {
     module: string;
     name: string;
@@ -100,7 +99,7 @@ QUnit.testDone(details => {
 QUnit.start();
 
 QUnit.done(details => {
-    (globalThis as any).__qunit_done__ = true;
-    (globalThis as any).__qunit_results__ = details;
-    (globalThis as any).__qunit_failures__ = qunit_failures;
+    globalThis.__qunit_done__ = true;
+    globalThis.__qunit_results__ = details;
+    globalThis.__qunit_failures__ = qunit_failures;
 });

tests/types/qunit-globals.d.ts

@@ -0,0 +1,9 @@
+export {};
+
+declare global {
+    interface GlobalThis {
+        __qunit_done__?: boolean;
+        __qunit_results__?: QUnit.DoneDetails;
+        __qunit_failures__?: QUnit.TestDoneDetails[];
+    }
+}