@zorilla/puppeteer-extra-plugin-stealth 1.0.2 → 1.0.4

package/test/evasions/defaultArgs/index.test.ts

@@ -2,11 +2,11 @@ import { expect, test } from 'vitest';
 import Plugin, {
   argsToIgnore,
 } from '../../../src/evasions/defaultArgs/index.js';
-import {
-  addExtra,
-  getDefaultLaunchArgs,
-  vanillaPuppeteer,
-} from '../../util.js';
+import { addExtra, getDefaultLaunchArgs, vanillaPuppeteer } from '../../util';
+
+type BrowserCommandLineResponse = {
+  arguments: string[];
+};
 
 test('vanilla: uses args to ignore', async () => {
   const browser = await vanillaPuppeteer.launch({
@@ -16,9 +16,9 @@ test('vanilla: uses args to ignore', async () => {
   const page = await browser.newPage();
   const client =
     typeof page._client === 'function' ? page._client() : page._client;
-  const { arguments: launchArgs } = await client.send(
+  const { arguments: launchArgs } = (await client.send(
     'Browser.getBrowserCommandLine'
-  );
+  )) as BrowserCommandLineResponse;
   const ok = argsToIgnore.every(arg => launchArgs.includes(arg));
   if (!ok) {
     console.log({ argsToIgnore, launchArgs });
@@ -35,9 +35,9 @@ test('stealth: does not use args to ignore', async () => {
   const page = await browser.newPage();
   const client =
     typeof page._client === 'function' ? page._client() : page._client;
-  const { arguments: launchArgs } = await client.send(
+  const { arguments: launchArgs } = (await client.send(
     'Browser.getBrowserCommandLine'
-  );
+  )) as BrowserCommandLineResponse;
   const ok = argsToIgnore.every(arg => !launchArgs.includes(arg));
   if (!ok) {
     console.log({ argsToIgnore, launchArgs });

package/test/evasions/iframe.contentWindow/{index.test.js → index.test.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 // import Plugin from '../../../src/evasions/iframe.contentWindow/index.js'
 // NOTE: We're using the full plugin for testing here as `iframe.contentWindow` uses data set by `chrome.runtime`
 import Plugin from '@zorilla/puppeteer-extra-plugin-stealth';
@@ -9,7 +10,7 @@ import {
   getStealthFingerPrint,
   getVanillaFingerPrint,
   vanillaPuppeteer,
-} from '../../util.js';
+} from '../../util';
 
 // Fix CI issues with old versions
 const isOldPuppeteerVersion = () => {

package/test/evasions/media.codecs/{index.test.js → index.test.ts}

@@ -6,7 +6,7 @@ import {
   getStealthFingerPrint,
   getVanillaFingerPrint,
   vanillaPuppeteer,
-} from '../../util.js';
+} from '../../util';
 
 test.skip('vanilla: doesnt support proprietary codecs (requires fpcollect)', async () => {
   const { videoCodecs, audioCodecs } = await getVanillaFingerPrint();

package/test/evasions/navigator.hardwareConcurrency/{index.test.js → index.test.ts}

@@ -7,7 +7,7 @@ import {
   getStealthFingerPrint,
   getVanillaFingerPrint,
   vanillaPuppeteer,
-} from '../../util.js';
+} from '../../util';
 
 const fingerprintFn = page => page.evaluate('navigator.hardwareConcurrency');
 

package/test/evasions/navigator.languages/{index.test.js → index.test.ts}

@@ -6,7 +6,7 @@ import {
   getStealthFingerPrint,
   getVanillaFingerPrint,
   vanillaPuppeteer,
-} from '../../util.js';
+} from '../../util';
 
 // TODO: Vanilla seems fine, evasion obsolete?
 // Note: We keep it around for now, as we will need this method in a fingerprinting plugin later anyway

package/test/evasions/navigator.permissions/{index.test.js → index.test.ts}

@@ -7,7 +7,7 @@ import {
   getStealthFingerPrint,
   getVanillaFingerPrint,
   vanillaPuppeteer,
-} from '../../util.js';
+} from '../../util';
 
 test.skip('vanilla: is prompt (requires fpcollect)', async () => {
   const { permissions } = await getVanillaFingerPrint();

package/test/evasions/navigator.plugins/{index.test.js → index.test.ts}

@@ -6,10 +6,20 @@ import {
   getStealthFingerPrint,
   getVanillaFingerPrint,
   vanillaPuppeteer,
-} from '../../util.js';
+} from '../../util';
+
+type FingerPrintWithPlugins = {
+  plugins: {
+    length: number;
+  };
+  mimeTypes: {
+    length: number;
+  };
+};
 
 test.skip('vanilla: empty plugins, empty mimetypes (requires fpcollect)', async () => {
-  const { plugins, mimeTypes } = await getVanillaFingerPrint();
+  const { plugins, mimeTypes } =
+    await getVanillaFingerPrint<FingerPrintWithPlugins>();
   expect(plugins.length).toBe(0);
   expect(mimeTypes.length).toBe(0);
 });
@@ -35,7 +45,8 @@ test('vanilla: will not have modifications', async () => {
 });
 
 test.skip('stealth: has plugin, has mimetypes (requires fpcollect)', async () => {
-  const { plugins, mimeTypes } = await getStealthFingerPrint(Plugin);
+  const { plugins, mimeTypes } =
+    await getStealthFingerPrint<FingerPrintWithPlugins>(Plugin);
   expect(plugins.length).toBe(3);
   expect(mimeTypes.length).toBe(4);
 });

package/test/evasions/navigator.plugins/{mimeTypes.test.js → mimeTypes.test.ts}

@@ -1,10 +1,6 @@
 import { expect, test } from 'vitest';
 import Plugin from '../../../src/evasions/navigator.plugins/index.js';
-import {
-  addExtra,
-  getDefaultLaunchArgs,
-  vanillaPuppeteer,
-} from '../../util.js';
+import { addExtra, getDefaultLaunchArgs, vanillaPuppeteer } from '../../util';
 
 test('stealth: will have convincing mimeTypes', async () => {
   const puppeteer = addExtra(vanillaPuppeteer).use(Plugin());
@@ -55,7 +51,7 @@ test('stealth: will have convincing mimeTypes', async () => {
         })(),
         loopResult: (() => {
           let res = '';
-          for (var bK = 0; bK < window.navigator.mimeTypes.length; bK++)
+          for (let bK = 0; bK < window.navigator.mimeTypes.length; bK++)
             bK === window.navigator.mimeTypes.length - 1
               ? (res += window.navigator.mimeTypes[bK].type)
               : (res += window.navigator.mimeTypes[bK].type + ',');

package/test/evasions/navigator.plugins/{plugins.test.js → plugins.test.ts}

@@ -1,10 +1,6 @@
 import { expect, test } from 'vitest';
 import Plugin from '../../../src/evasions/navigator.plugins/index.js';
-import {
-  addExtra,
-  getDefaultLaunchArgs,
-  vanillaPuppeteer,
-} from '../../util.js';
+import { addExtra, getDefaultLaunchArgs, vanillaPuppeteer } from '../../util';
 
 test('stealth: will have convincing plugins', async () => {
   const puppeteer = addExtra(vanillaPuppeteer).use(Plugin());

package/test/evasions/navigator.vendor/{index.test.js → index.test.ts}

@@ -1,10 +1,6 @@
 import { expect, test } from 'vitest';
 import Plugin from '../../../src/evasions/navigator.vendor/index.js';
-import {
-  addExtra,
-  getDefaultLaunchArgs,
-  vanillaPuppeteer,
-} from '../../util.js';
+import { addExtra, getDefaultLaunchArgs, vanillaPuppeteer } from '../../util';
 
 test('vanilla: navigator.vendor is always Google Inc.', async () => {
   const browser = await vanillaPuppeteer.launch({

package/test/evasions/navigator.webdriver/{index.test.js → index.test.ts}

@@ -5,7 +5,7 @@ import {
   compareLooseVersionStrings,
   getDefaultLaunchArgs,
   vanillaPuppeteer,
-} from '../../util.js';
+} from '../../util';
 
 function getExpectedValue(looseVersionString) {
   if (compareLooseVersionStrings(looseVersionString, '89.0.4339.0') >= 0) {

package/test/evasions/sourceurl/{index.test.js → index.test.ts}

@@ -2,11 +2,7 @@ import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { expect, test } from 'vitest';
 import Plugin from '../../../src/evasions/sourceurl/index.js';
-import {
-  addExtra,
-  getDefaultLaunchArgs,
-  vanillaPuppeteer,
-} from '../../util.js';
+import { addExtra, getDefaultLaunchArgs, vanillaPuppeteer } from '../../util';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);

package/test/evasions/user-agent-override/{index.test.js → index.test.ts}

@@ -1,10 +1,6 @@
 import { expect, test } from 'vitest';
 import Plugin from '../../../src/evasions/user-agent-override/index.js';
-import {
-  addExtra,
-  getDefaultLaunchArgs,
-  vanillaPuppeteer,
-} from '../../util.js';
+import { addExtra, getDefaultLaunchArgs, vanillaPuppeteer } from '../../util';
 
 // Fixed since 2.1.1?
 // test('vanilla: Accept-Language header is missing', async () => {

package/test/evasions/webgl.vendor/{index.test.js → index.test.ts}

@@ -6,7 +6,7 @@ import {
   getStealthFingerPrint,
   getVanillaFingerPrint,
   vanillaPuppeteer,
-} from '../../util.js';
+} from '../../util';
 
 // FIXME: This changed in more recent chrome versions
 // test('vanilla: videoCard is Google Inc', async () => {
@@ -64,7 +64,7 @@ async function extendedTests() {
   // Make sure we not reveal our proxy through errors
   await test('errorOK', _ => {
     try {
-      return context.getParameter();
+      return (context as WebGLRenderingContext).getParameter(undefined as any);
     } catch (err) {
       return !err.stack.includes(`at Object.apply`);
     }
@@ -118,8 +118,13 @@ test.skip('stealth: webgl is native (requires fpcollect)', async () => {
  * @see https://stackoverflow.com/questions/49267764/how-to-get-the-video-card-driver-name-using-javascript-browser-side
  * @returns {Object}
  */
-function getVideoCardInfo(context = 'webgl') {
-  const gl = document.createElement('canvas').getContext(context);
+function getVideoCardInfo(
+  context: 'webgl' | 'webgl2' | 'experimental-webgl' = 'webgl'
+) {
+  const gl = document.createElement('canvas').getContext(context) as
+    | WebGLRenderingContext
+    | WebGL2RenderingContext
+    | null;
   if (!gl) {
     return {
       error: 'no webgl',

package/test/fpscanner.test.ts

@@ -1,54 +1,123 @@
-import fpscanner from 'fpscanner';
+import { readFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import type { Browser } from 'puppeteer';
 import { expect, test } from 'vitest';
 import Plugin from '../dist/index.js';
 import {
-  compareLooseVersionStrings,
-  getStealthFingerPrint,
-  getVanillaFingerPrint,
-} from './util.js';
-
-// Fix CI issues with old versions
-const isOldPuppeteerVersion = () => {
-  const version = process.env.PUPPETEER_VERSION;
-  if (!version) {
-    return false;
-  }
-  if (version === '1.9.0' || version === '1.6.2') {
-    return true;
-  }
-  return false;
+  addExtra,
+  dummyHTMLPath,
+  getDefaultLaunchArgs,
+  vanillaPuppeteer,
+} from './util';
+
+const require = createRequire(import.meta.url);
+
+// fpscanner v1.0.0 is a browser-side library — no longer a Node.js analyser.
+// We inject the ES bundle into the page and expose the class as a window global,
+// then call collectFingerprint() in the browser context to both collect and analyse.
+const getFpScannerBrowserCode = (): string => {
+  const fpScannerPath = require.resolve(
+    'fpscanner/dist/fpScanner.es.js'
+  ) as string;
+  const code = readFileSync(fpScannerPath, 'utf8');
+  // Replace `export { <name> as default };` with a window global assignment so
+  // the bundle can be injected as a regular (non-module) script tag.
+  return code.replace(/export \{([^}]+)\};?\s*$/, (_match, inner: string) => {
+    const name = inner.match(/(\w+)\s+as\s+default/)?.[1];
+    if (!name)
+      throw new Error('Could not find default export name in fpscanner bundle');
+    return `window.FingerprintScanner = ${name};`;
+  });
 };
 
-test.skip('vanilla: will fail multiple fpscanner tests (requires fpcollect build)', async () => {
-  const fingerPrint = await getVanillaFingerPrint();
-  const testedFingerPrints = fpscanner.analyseFingerprint(fingerPrint);
-  const failedChecks = Object.values(testedFingerPrints).filter(
-    val => val.consistent < 3
-  );
-
-  if (isOldPuppeteerVersion()) {
-    expect(failedChecks.length).toBe(8);
-  } else {
-    expect(failedChecks.length).toBe(7);
-  }
-});
+const fpScannerCode = getFpScannerBrowserCode();
+// GitHub's Windows runners can take over a minute to launch Chromium, inject
+// fpscanner, and finish the vanilla baseline collection.
+const fpscannerTestTimeout = process.platform === 'win32' ? 90000 : 30000;
 
-test.skip('stealth: will not fail a single fpscanner test (requires fpcollect build)', async () => {
-  const fingerPrint = await getStealthFingerPrint(Plugin);
-  const testedFingerPrints = fpscanner.analyseFingerprint(fingerPrint);
-  const failedChecks = Object.values(testedFingerPrints).filter(
-    val => val.consistent < 3
-  );
+type FastBotDetectionDetails = Record<
+  string,
+  { detected: boolean; severity: string }
+>;
 
-  if (failedChecks.length) {
-    console.warn('The following fingerprints failed:', failedChecks);
-  }
+interface FpScannerResult {
+  fastBotDetection: boolean;
+  fastBotDetectionDetails: FastBotDetectionDetails;
+}
+
+interface LaunchablePuppeteer {
+  launch(options?: { headless?: boolean; args?: string[] }): Promise<Browser>;
+}
 
-  if (compareLooseVersionStrings(fingerPrint.userAgent, '89.0.4339.0') >= 0) {
-    // Updated navigator.webdriver behavior breaks the fpscanner tests.
-    expect(failedChecks.length).toBe(1);
-    expect(failedChecks[0].name).toBe('WEBDRIVER');
-  } else {
-    expect(failedChecks.length).toBe(0);
+const getFpScannerResult = async (
+  puppeteer: LaunchablePuppeteer
+): Promise<FpScannerResult> => {
+  const browser = await puppeteer.launch({
+    headless: true,
+    args: getDefaultLaunchArgs(),
+  });
+  try {
+    const page = await browser.newPage();
+    await page.goto(`file://${dummyHTMLPath}`);
+    await page.addScriptTag({ content: fpScannerCode });
+    const result = await page.evaluate(async () => {
+      // FingerprintScanner is injected as a browser global via addScriptTag above
+      const FP = (window as Record<string, unknown>)
+        .FingerprintScanner as new () => {
+        collectFingerprint(opts: { encrypt: boolean }): Promise<unknown>;
+      };
+      const scanner = new FP();
+      return scanner.collectFingerprint({ encrypt: false });
+    });
+    return result as FpScannerResult;
+  } finally {
+    await browser.close();
   }
-});
+};
+
+test(
+  'vanilla: will fail multiple fpscanner bot detection checks',
+  async () => {
+    const result = await getFpScannerResult(vanillaPuppeteer);
+    const failedChecks = Object.entries(result.fastBotDetectionDetails)
+      .filter(([_name, val]) => val.detected)
+      .map(([name]) => name);
+
+    console.log('Vanilla failed checks:', failedChecks);
+    expect(result.fastBotDetection).toBe(true);
+    expect(failedChecks.length).toBeGreaterThan(0);
+  },
+  fpscannerTestTimeout
+);
+
+test(
+  'stealth: will pass core fpscanner automation checks',
+  async () => {
+    // PuppeteerExtra has a compatible launch() interface — assertion is safe
+    const stealthPuppeteer = addExtra(vanillaPuppeteer).use(
+      Plugin()
+    ) as unknown as LaunchablePuppeteer;
+    const result = await getFpScannerResult(stealthPuppeteer);
+    const failedChecks = Object.entries(result.fastBotDetectionDetails)
+      .filter(([_name, val]) => val.detected)
+      .map(([name]) => name);
+
+    if (failedChecks.length) {
+      console.warn('The following checks failed:', failedChecks);
+    }
+
+    // These are the automation signals that the stealth plugin explicitly addresses.
+    // Stealth overrides navigator.webdriver → hasWebdriver should not fire.
+    expect(result.fastBotDetectionDetails.hasWebdriver.detected).toBe(false);
+    // Stealth injects chrome.* objects → hasMissingChromeObject should not fire.
+    expect(result.fastBotDetectionDetails.hasMissingChromeObject.detected).toBe(
+      false
+    );
+    // Neither Selenium nor Playwright markers are present in a Puppeteer session.
+    expect(result.fastBotDetectionDetails.hasSeleniumProperty.detected).toBe(
+      false
+    );
+    expect(result.fastBotDetectionDetails.hasPlaywright.detected).toBe(false);
+  },
+  fpscannerTestTimeout
+);

package/test/index.test.ts

@@ -4,18 +4,26 @@ import { expect, test } from 'vitest';
 
 import Plugin from '../dist/index.js';
 
+type StealthPluginInstance = ReturnType<typeof Plugin> & {
+  opts: {
+    enabledEvasions: Set<string>;
+  };
+  availableEvasions: Set<string>;
+  dependencies: Set<string>;
+};
+
 test('is a function', async () => {
   expect(typeof Plugin).toBe('function');
 });
 
 test('should have the basic class members', async () => {
-  const instance = Plugin();
+  const instance = Plugin() as StealthPluginInstance;
   expect(instance.name).toBe(PLUGIN_NAME);
   expect(instance._isPuppeteerExtraPlugin).toBe(true);
 });
 
 test('should have the public child class members', async () => {
-  const instance = Plugin();
+  const instance = Plugin() as StealthPluginInstance;
   const prototype = Object.getPrototypeOf(instance);
   const childClassMembers = Object.getOwnPropertyNames(prototype);
 
@@ -29,12 +37,12 @@ test('should have the public child class members', async () => {
 });
 
 test('should have opts with default values', async () => {
-  const instance = Plugin();
+  const instance = Plugin() as StealthPluginInstance;
   expect(instance.opts.enabledEvasions).toEqual(instance.availableEvasions);
 });
 
 test('should add all dependencies dynamically', async () => {
-  const instance = Plugin();
+  const instance = Plugin() as StealthPluginInstance;
   const deps = new Set(
     [...instance.opts.enabledEvasions].map(e => `${PLUGIN_NAME}/evasions/${e}`)
   );
@@ -42,7 +50,7 @@ test('should add all dependencies dynamically', async () => {
 });
 
 test('should add all dependencies dynamically including changes', async () => {
-  const instance = Plugin();
+  const instance = Plugin() as StealthPluginInstance;
   const fakeDep = 'foobar';
   instance.enabledEvasions = new Set([fakeDep]);
   expect(instance.dependencies).toEqual(

package/test/service-worker.test.ts

@@ -1,10 +1,12 @@
 import fs from 'node:fs';
 import http from 'node:http';
+import type { AddressInfo } from 'node:net';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
+import type { Browser, Page, Target, WebWorker } from 'puppeteer';
 import { afterAll, beforeAll, expect, test } from 'vitest';
 import Plugin from '../dist/index.js';
-import { addExtra, getDefaultLaunchArgs, vanillaPuppeteer } from './util.js';
+import { addExtra, getDefaultLaunchArgs, vanillaPuppeteer } from './util';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -31,10 +33,13 @@ const httpServer = async () => {
     })
     .listen(0); // random free port
 
-  return `http://127.0.0.1:${server.address().port}/`;
+  const address = server.address() as AddressInfo;
+  return `http://127.0.0.1:${address.port}/`;
 };
 
-let browser, page, worker;
+let browser: Browser;
+let page: Page;
+let worker: WebWorker;
 
 beforeAll(async () => {
   const address = await httpServer();
@@ -45,16 +50,21 @@ beforeAll(async () => {
     .launch({ headless: true, args: getDefaultLaunchArgs() });
   page = await browser.newPage();
 
-  worker = new Promise(resolve => {
-    browser.on('targetcreated', async target => {
+  const workerPromise = new Promise<WebWorker>((resolve, reject) => {
+    browser.on('targetcreated', async (target: Target) => {
       if (target.type() === 'service_worker') {
-        resolve(target.worker());
+        const serviceWorker = await target.worker();
+        if (serviceWorker) {
+          resolve(serviceWorker);
+        } else {
+          reject(new Error('Target did not expose a service worker'));
+        }
       }
     });
   });
 
   await page.goto(address);
-  worker = await worker;
+  worker = await workerPromise;
 });
 
 afterAll(async () => {
@@ -82,9 +92,16 @@ test.skip('stealth: creepjs has good trust score', async () => {
 
 /* global OffscreenCanvas */
 function detectFingerprint() {
-  const results = {};
-
-  const props = [
+  const results: Record<string, string> = {};
+
+  const props: Array<
+    | 'userAgent'
+    | 'language'
+    | 'hardwareConcurrency'
+    | 'deviceMemory'
+    | 'languages'
+    | 'platform'
+  > = [
     'userAgent',
     'language',
     'hardwareConcurrency',
@@ -92,19 +109,23 @@ function detectFingerprint() {
     'languages',
     'platform',
   ];
-  props.forEach(el => {
-    results[el] = navigator[el].toString();
+  props.forEach(prop => {
+    results[prop] = String(navigator[prop]);
   });
 
   const canvasOffscreenWebgl = new OffscreenCanvas(256, 256);
   const contextWebgl = canvasOffscreenWebgl.getContext('webgl');
-  const rendererInfo = contextWebgl.getExtension('WEBGL_debug_renderer_info');
-  results.webglVendor = contextWebgl.getParameter(
-    rendererInfo.UNMASKED_VENDOR_WEBGL
-  );
-  results.webglRenderer = contextWebgl.getParameter(
-    rendererInfo.UNMASKED_RENDERER_WEBGL
-  );
+  if (contextWebgl) {
+    const rendererInfo = contextWebgl.getExtension('WEBGL_debug_renderer_info');
+    if (rendererInfo) {
+      results.webglVendor = String(
+        contextWebgl.getParameter(rendererInfo.UNMASKED_VENDOR_WEBGL)
+      );
+      results.webglRenderer = String(
+        contextWebgl.getParameter(rendererInfo.UNMASKED_RENDERER_WEBGL)
+      );
+    }
+  }
 
   results.timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;