Merge pull request #458 from nanasess/feature/bump-tools-cache

build: migrate to ESM and bump @actions/tool-cache to 4.x

Author: nanasess

__tests__/chromedriver-api.test.ts

@@ -5,12 +5,13 @@
  * Run with: RUN_CHROMEDRIVER_API_TESTS=1 pnpm test __tests__/chromedriver-api.test.ts
  */
 
+import { jest } from "@jest/globals";
 import {
   buildLegacyLatestReleaseUrl,
   extractDriverUrlFromJson,
   ChromeKnownGoodVersions,
   ChromeVersion,
-} from "../src/chromedriver-helper";
+} from "../src/chromedriver-helper.js";
 
 const JSON_URL =
   "https://googlechromelabs.github.io/chrome-for-testing/known-good-versions-with-downloads.json";
@@ -47,14 +48,15 @@ describeIfIntegration("Chrome for Testing JSON API", () => {
   it("can extract a chromedriver URL from a recent version", () => {
     // Find a version that has chromedriver downloads
     const withDriver = json.versions.find(
-      (v: ChromeVersion) => v.downloads.chromedriver && v.downloads.chromedriver.length > 0
+      (v: ChromeVersion) =>
+        v.downloads.chromedriver && v.downloads.chromedriver.length > 0,
     );
     expect(withDriver).toBeDefined();
 
     const url = extractDriverUrlFromJson(
       json,
       withDriver!.version,
-      withDriver!.downloads.chromedriver![0].platform
+      withDriver!.downloads.chromedriver![0].platform,
     );
     expect(url).not.toBeNull();
     expect(url).toMatch(/^https:\/\//);

__tests__/chromedriver-helper.test.ts

@@ -11,7 +11,7 @@ import {
   findFallbackVersion,
   getDefaultChromePath,
   getInstallPath,
-} from "../src/chromedriver-helper";
+} from "../src/chromedriver-helper.js";
 
 // ---------------------------------------------------------------------------
 // Mock API response fixture
@@ -106,7 +106,7 @@ describe("parseVersion3", () => {
 
   it("throws when version has fewer than 3 parts", () => {
     expect(() => parseVersion3("115.0")).toThrow(
-      "Version must have at least 3 parts"
+      "Version must have at least 3 parts",
     );
   });
 });
@@ -180,21 +180,21 @@ describe("convertArchForModernAPI", () => {
 describe("buildLegacyLatestReleaseUrl", () => {
   it("builds correct URL for version 114", () => {
     expect(buildLegacyLatestReleaseUrl(114)).toBe(
-      "https://chromedriver.storage.googleapis.com/LATEST_RELEASE_114"
+      "https://chromedriver.storage.googleapis.com/LATEST_RELEASE_114",
     );
   });
 });
 
 describe("buildLegacyDownloadUrl", () => {
   it("builds correct download URL", () => {
     expect(buildLegacyDownloadUrl("114.0.5735.90", "linux64")).toBe(
-      "https://chromedriver.storage.googleapis.com/114.0.5735.90/chromedriver_linux64.zip"
+      "https://chromedriver.storage.googleapis.com/114.0.5735.90/chromedriver_linux64.zip",
     );
   });
 
   it("builds correct URL for mac64", () => {
     expect(buildLegacyDownloadUrl("114.0.5735.90", "mac64")).toBe(
-      "https://chromedriver.storage.googleapis.com/114.0.5735.90/chromedriver_mac64.zip"
+      "https://chromedriver.storage.googleapis.com/114.0.5735.90/chromedriver_mac64.zip",
     );
   });
 });
@@ -204,29 +204,29 @@ describe("extractDriverUrlFromJson", () => {
     const url = extractDriverUrlFromJson(
       MOCK_API_RESPONSE,
       "131.0.6778.204",
-      "linux64"
+      "linux64",
     );
     expect(url).toBe(
-      "https://storage.googleapis.com/chrome-for-testing-public/131.0.6778.204/linux64/chromedriver-linux64.zip"
+      "https://storage.googleapis.com/chrome-for-testing-public/131.0.6778.204/linux64/chromedriver-linux64.zip",
     );
   });
 
   it("extracts URL for mac-arm64", () => {
     const url = extractDriverUrlFromJson(
       MOCK_API_RESPONSE,
       "131.0.6778.204",
-      "mac-arm64"
+      "mac-arm64",
     );
     expect(url).toBe(
-      "https://storage.googleapis.com/chrome-for-testing-public/131.0.6778.204/mac-arm64/chromedriver-mac-arm64.zip"
+      "https://storage.googleapis.com/chrome-for-testing-public/131.0.6778.204/mac-arm64/chromedriver-mac-arm64.zip",
     );
   });
 
   it("returns null for non-existent version", () => {
     const url = extractDriverUrlFromJson(
       MOCK_API_RESPONSE,
       "999.0.0.0",
-      "linux64"
+      "linux64",
     );
     expect(url).toBeNull();
   });
@@ -235,7 +235,7 @@ describe("extractDriverUrlFromJson", () => {
     const url = extractDriverUrlFromJson(
       MOCK_API_RESPONSE,
       "114.0.5735.90",
-      "win32"
+      "win32",
     );
     expect(url).toBeNull();
   });
@@ -274,27 +274,27 @@ describe("findFallbackVersion", () => {
 describe("getDefaultChromePath", () => {
   it("returns google-chrome-stable for linux", () => {
     expect(getDefaultChromePath("linux" as NodeJS.Platform)).toBe(
-      "google-chrome-stable"
+      "google-chrome-stable",
     );
   });
 
   it("returns macOS app path for darwin", () => {
     expect(getDefaultChromePath("darwin")).toBe(
-      "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/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
+      "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/Applications/Google Chrome.app/Contents/MacOS/Google Chrome",
     );
   });
 
   it("returns Windows exe path for win32", () => {
     expect(getDefaultChromePath("win32")).toBe(
-      "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe"
+      "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe",
     );
   });
 });
 
 describe("getInstallPath", () => {
   it("returns /usr/local/bin/chromedriver for linux", () => {
     expect(getInstallPath("linux" as NodeJS.Platform)).toBe(
-      "/usr/local/bin/chromedriver"
+      "/usr/local/bin/chromedriver",
     );
   });
 
@@ -304,7 +304,7 @@ describe("getInstallPath", () => {
 
   it("returns Windows SeleniumWebDrivers path for win32", () => {
     expect(getInstallPath("win32")).toBe(
-      "C:\\SeleniumWebDrivers\\ChromeDriver"
+      "C:\\SeleniumWebDrivers\\ChromeDriver",
     );
   });
 });

__tests__/chromedriver.ts

@@ -1,38 +1,41 @@
 import { Builder, Capabilities, until } from "selenium-webdriver";
-import * as chrome from "selenium-webdriver/chrome";
+// ESM (the project is "type":"module") requires an explicit extension for this
+// CJS subpath; without it Node throws ERR_MODULE_NOT_FOUND under ts-node.
+import * as chrome from "selenium-webdriver/chrome.js";
 
 (async () => {
   const timeout = 30000;
-  
+
   // Chrome options for better compatibility, especially on macOS
   const options = new chrome.Options();
   options.addArguments(
-    '--no-sandbox',
-    '--disable-dev-shm-usage',
-    '--disable-gpu',
-    '--disable-web-security',
-    '--disable-features=VizDisplayCompositor',
-    '--remote-debugging-port=9222',
-    '--disable-background-timer-throttling',
-    '--disable-backgrounding-occluded-windows',
-    '--disable-renderer-backgrounding'
+    "--no-sandbox",
+    "--disable-dev-shm-usage",
+    "--disable-gpu",
+    "--disable-web-security",
+    "--disable-features=VizDisplayCompositor",
+    "--remote-debugging-port=9222",
+    "--disable-background-timer-throttling",
+    "--disable-backgrounding-occluded-windows",
+    "--disable-renderer-backgrounding",
   );
-  
+
   // Add headless mode for CI environments
   if (process.env.CI) {
-    options.addArguments('--headless=new');
+    options.addArguments("--headless=new");
   }
-  
+
   // Set a custom user data directory to avoid permission issues
-  const userDataDir = process.platform === 'darwin' 
-    ? '/tmp/chrome-user-data-' + Date.now()
-    : undefined;
+  const userDataDir =
+    process.platform === "darwin"
+      ? "/tmp/chrome-user-data-" + Date.now()
+      : undefined;
   if (userDataDir) {
     options.addArguments(`--user-data-dir=${userDataDir}`);
   }
-  
+
   const driver = new Builder()
-    .forBrowser('chrome')
+    .forBrowser("chrome")
     .setChromeOptions(options)
     .build();
   try {

__tests__/equivalence.test.ts

@@ -7,6 +7,7 @@
 
 import { execSync } from "child_process";
 import * as path from "path";
+import { fileURLToPath } from "url";
 import {
   parseMajorVersion,
   parseVersion3,
@@ -19,7 +20,10 @@ import {
   getInstallPath,
   extractDriverUrlFromJson,
   findFallbackVersion,
-} from "../src/chromedriver-helper";
+} from "../src/chromedriver-helper.js";
+
+// ESM has no __dirname; derive this file's directory from import.meta.url.
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 // ---------------------------------------------------------------------------
 // Run shell script and parse output
@@ -164,7 +168,7 @@ describe("Shell ↔ TypeScript equivalence", () => {
       for (const line of lines) {
         const kv = parseKeyValue(line);
         expect(buildLegacyDownloadUrl(kv["VERSION"], kv["ARCH"])).toBe(
-          kv["URL"]
+          kv["URL"],
         );
       }
     });
@@ -175,9 +179,9 @@ describe("Shell ↔ TypeScript equivalence", () => {
       const lines = parseSection(shellOutput, "DEFAULT_CHROME_PATH");
       for (const line of lines) {
         const kv = parseKeyValue(line);
-        expect(
-          getDefaultChromePath(kv["PLATFORM"] as NodeJS.Platform)
-        ).toBe(kv["PATH"]);
+        expect(getDefaultChromePath(kv["PLATFORM"] as NodeJS.Platform)).toBe(
+          kv["PATH"],
+        );
       }
     });
   });
@@ -188,7 +192,7 @@ describe("Shell ↔ TypeScript equivalence", () => {
       for (const line of lines) {
         const kv = parseKeyValue(line);
         expect(getInstallPath(kv["PLATFORM"] as NodeJS.Platform)).toBe(
-          kv["PATH"]
+          kv["PATH"],
         );
       }
     });
@@ -202,7 +206,7 @@ describe("Shell ↔ TypeScript equivalence", () => {
         const result = extractDriverUrlFromJson(
           TEST_JSON,
           kv["VERSION"],
-          kv["PLATFORM"]
+          kv["PLATFORM"],
         );
         const expected = kv["URL"] === "null" ? null : kv["URL"];
         expect(result).toBe(expected);

__tests__/installer-download.test.ts

@@ -2,14 +2,23 @@
  * Unit tests for src/installer/download.ts.
  *
  * @actions/tool-cache is mocked so no real network or filesystem I/O occurs.
+ *
+ * The project is ESM, so the mock is registered with
+ * `jest.unstable_mockModule` and both the mocked module and the module under
+ * test are pulled in with dynamic `import()` *after* the mock is in place.
  */
 
-import * as tc from "@actions/tool-cache";
-import { downloadAndExtractZip } from "../src/installer/download";
+import { jest } from "@jest/globals";
+
+jest.unstable_mockModule("@actions/tool-cache", () => ({
+  downloadTool: jest.fn(),
+  extractZip: jest.fn(),
+}));
 
-jest.mock("@actions/tool-cache");
+const tc = await import("@actions/tool-cache");
+const { downloadAndExtractZip } = await import("../src/installer/download.js");
 
-const mockedTc = tc as jest.Mocked<typeof tc>;
+const mockedTc = jest.mocked(tc);
 
 describe("downloadAndExtractZip", () => {
   beforeEach(() => {

__tests__/installer-http.test.ts

@@ -13,18 +13,21 @@
  * typed-rest-client is mocked so no real network I/O occurs.
  */
 
+import { jest } from "@jest/globals";
+
 // Shared mock for the HttpClient instance method `get`. The module under test
 // constructs a single client at load time, so the constructor mock must return
-// an object backed by this shared mock.
-const mockGet = jest.fn();
+// an object backed by this shared mock. Declared before the mock factory so it
+// is captured by the closure when `await import()` evaluates http.ts.
+const mockGet = jest.fn() as jest.Mock<(url: string) => Promise<unknown>>;
 
-jest.mock("typed-rest-client/HttpClient", () => ({
+jest.unstable_mockModule("typed-rest-client/HttpClient.js", () => ({
   HttpClient: jest.fn().mockImplementation(() => ({
     get: mockGet,
   })),
 }));
 
-import { fetchText, fetchJson } from "../src/installer/http";
+const { fetchText, fetchJson } = await import("../src/installer/http.js");
 
 /**
  * Build a fake typed-rest-client response with the given status code and body.
@@ -33,7 +36,7 @@ import { fetchText, fetchJson } from "../src/installer/http";
 function makeResponse(statusCode: number, body: string) {
   return {
     message: { statusCode },
-    readBody: jest.fn().mockResolvedValue(body),
+    readBody: jest.fn(() => Promise.resolve(body)),
   };
 }