@crawlee/browser-pool 4.0.0-beta.211 → 4.0.0-beta.212

package/abstract-classes/browser-plugin.d.ts

@@ -81,6 +81,7 @@ export interface CreateLaunchContextOptions<Library extends CommonLibrary, Libra
  * feed them to {@link BrowserPool} for use.
  */
 export declare abstract class BrowserPlugin<Library extends CommonLibrary = CommonLibrary, LibraryOptions extends Dictionary | undefined = Parameters<Library['launch']>[0], LaunchResult extends CommonBrowser = UnwrapPromise<ReturnType<Library['launch']>>, NewPageOptions = Parameters<LaunchResult['newPage']>[0], NewPageResult = UnwrapPromise<ReturnType<LaunchResult['newPage']>>> {
+    #private;
     readonly name: string;
     /**
      * Kept `protected` rather than `#private` because the concrete plugins in this package are separate
@@ -136,7 +137,6 @@ export declare abstract class BrowserPlugin<Library extends CommonLibrary = Comm
      * Launches the browser using provided launch context.
      */
     launch(launchContext?: LaunchContext<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>): Promise<LaunchResult>;
-    private mergeArgsToHideWebdriver;
     protected throwAugmentedLaunchError(cause: unknown, executablePath: string | undefined, dockerImage: string, moduleInstallCommand: string): never;
     protected abstract addProxyToLaunchOptions(launchContext: LaunchContext<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>): Promise<void>;
     protected abstract isChromiumBasedBrowser(launchContext: LaunchContext<Library, LibraryOptions, LaunchResult, NewPageOptions, NewPageResult>): boolean;

package/abstract-classes/browser-plugin.js

@@ -125,7 +125,7 @@ export class BrowserPlugin {
         }
         if (!launchContext.isRemote && this.isChromiumBasedBrowser(launchContext)) {
             // This will set the args for chromium based browsers to hide the webdriver.
-            launchOptions.args = this.mergeArgsToHideWebdriver(launchOptions.args);
+            launchOptions.args = this.#mergeArgsToHideWebdriver(launchOptions.args);
             // When User-Agent is not set, and we're using Chromium in headless mode,
             // it is better to use DEFAULT_USER_AGENT to reduce chance of detection,
             // as otherwise 'HeadlessChrome' is present in User-Agent string.
@@ -139,7 +139,7 @@ export class BrowserPlugin {
         }
         return this._launch(launchContext);
     }
-    mergeArgsToHideWebdriver(originalArgs) {
+    #mergeArgsToHideWebdriver(originalArgs) {
         if (!originalArgs?.length) {
             return ['--disable-blink-features=AutomationControlled'];
         }

package/browser-pool.d.ts

@@ -337,7 +337,6 @@ export declare class BrowserPool<Options extends BrowserPoolOptions = BrowserPoo
      * until it's closed.
      */
     getPageId(page: PageReturn): string | undefined;
-    private createPageForBrowser;
     /**
      * Removes a browser controller from the pool. The underlying
      * browser will be closed after all its pages are closed.
@@ -408,17 +407,7 @@ export declare class BrowserPool<Options extends BrowserPoolOptions = BrowserPoo
      * re-armed and its listeners are dropped, so it cannot be used again.
      */
     destroy(): Promise<void>;
-    private getAllBrowserControllers;
-    private launchBrowser;
-    /**
-     * Picks plugins round robin.
-     */
-    private pickBrowserPlugin;
-    private pickBrowserWithFreeCapacity;
     private closeInactiveRetiredBrowsers;
-    private overridePageClose;
-    private executeHooks;
-    private closeRetiredBrowserWithNoPages;
     /**
      * Returns `true` if the pool can accept a new browser launch without exceeding `maxOpenBrowsers`.
      * Counts starting, active, and retired browsers.
@@ -437,7 +426,6 @@ export declare class BrowserPool<Options extends BrowserPoolOptions = BrowserPoo
      * @internal
      */
     hasActiveBrowserWithFreeCapacity(): boolean;
-    private initializeFingerprinting;
 }
 export interface BrowserPoolNewPageOptions<PageOptions, BP extends BrowserPlugin> extends NewPageOptions {
     /**

package/browser-pool.js

@@ -99,14 +99,16 @@ export class BrowserPool extends TypedEmitter {
     #prePageCloseHooks;
     #postPageCloseHooks;
     #pageCounter = 0;
-    // TS-private rather than `#`: tests observe page tracking and controller retirement directly
+    // oxlint-disable-next-line crawlee/prefer-private-fields -- tests observe page tracking and controller retirement directly
     pages = new Map();
     #pageIds = new WeakMap();
     #startingBrowserControllers = new Set();
+    // oxlint-disable-next-line crawlee/prefer-private-fields -- accessed by tests
     activeBrowserControllers = new Set();
+    // oxlint-disable-next-line crawlee/prefer-private-fields -- accessed by tests
     retiredBrowserControllers = new Set();
     #pageToBrowserController = new WeakMap();
-    // kept as TS-private: tests replace this interval through bracket access
+    // oxlint-disable-next-line crawlee/prefer-private-fields -- tests replace this interval through bracket access
     browserKillerInterval;
     #browserRetireInterval;
     #limiter = pLimit(1);
@@ -151,7 +153,7 @@ export class BrowserPool extends TypedEmitter {
         this.#postPageCloseHooks = postPageCloseHooks;
         // fingerprinting
         if (useFingerprints) {
-            this.initializeFingerprinting();
+            this.#initializeFingerprinting();
             // The fingerprint pre-launch hook goes last because of the fingerprint cache.
             // It is usual to generate proxy per browser and we want to know the proxyUrl for the caching.
             this.#preLaunchHooks = [...this.#preLaunchHooks, createFingerprintPreLaunchHook(this)];
@@ -180,7 +182,7 @@ export class BrowserPool extends TypedEmitter {
      * crawler's responsibility.
      */
     async newPage(options = {}) {
-        const { id = nanoid(), pageOptions, browserPlugin = this.pickBrowserPlugin(), session, proxyUrl = session?.proxyInfo?.url, ignoreTlsErrors = session?.proxyInfo?.ignoreTlsErrors, } = options;
+        const { id = nanoid(), pageOptions, browserPlugin = this.#pickBrowserPlugin(), session, proxyUrl = session?.proxyInfo?.url, ignoreTlsErrors = session?.proxyInfo?.ignoreTlsErrors, } = options;
         if (this.pages.has(id)) {
             throw new Error(`Page with ID: ${id} already exists.`);
         }
@@ -199,15 +201,15 @@ export class BrowserPool extends TypedEmitter {
         // TODO(crawlee@v4): bump p-limit to v5 and drop this AsyncResource.bind wrapper.
         // Limiter is necessary - https://github.com/apify/crawlee/issues/1126
         return this.#limiter(AsyncResource.bind(async () => {
-            let browserController = this.pickBrowserWithFreeCapacity(browserPlugin, { proxyUrl });
+            let browserController = this.#pickBrowserWithFreeCapacity(browserPlugin, { proxyUrl });
             if (!browserController)
-                browserController = await this.launchBrowser(id, {
+                browserController = await this.#launchBrowser(id, {
                     browserPlugin,
                     proxyUrl,
                     ignoreTlsErrors,
                 });
             tryCancel();
-            return await this.createPageForBrowser(id, browserController, pageOptions, proxyUrl, ignoreTlsErrors);
+            return await this.#createPageForBrowser(id, browserController, pageOptions, proxyUrl, ignoreTlsErrors);
         }));
     }
     /**
@@ -216,13 +218,13 @@ export class BrowserPool extends TypedEmitter {
      * configure the new browser.
      */
     async newPageInNewBrowser(options = {}) {
-        const { id = nanoid(), pageOptions, launchOptions, browserPlugin = this.pickBrowserPlugin() } = options;
+        const { id = nanoid(), pageOptions, launchOptions, browserPlugin = this.#pickBrowserPlugin() } = options;
         if (this.pages.has(id)) {
             throw new Error(`Page with ID: ${id} already exists.`);
         }
-        const browserController = await this.launchBrowser(id, { launchOptions, browserPlugin });
+        const browserController = await this.#launchBrowser(id, { launchOptions, browserPlugin });
         tryCancel();
-        return await this.createPageForBrowser(id, browserController, pageOptions);
+        return await this.#createPageForBrowser(id, browserController, pageOptions);
     }
     /**
      * Opens new pages with all available plugins and returns an array
@@ -288,7 +290,7 @@ export class BrowserPool extends TypedEmitter {
     getPageId(page) {
         return this.#pageIds.get(page);
     }
-    async createPageForBrowser(pageId, browserController, pageOptions = {}, proxyUrl, ignoreTlsErrors) {
+    async #createPageForBrowser(pageId, browserController, pageOptions = {}, proxyUrl, ignoreTlsErrors) {
         // This is needed for concurrent newPage calls to wait for the browser launch.
         // It's not ideal though, we need to come up with a better API.
         await browserController.waitForActive();
@@ -303,7 +305,7 @@ export class BrowserPool extends TypedEmitter {
                 });
             }
         }
-        await this.executeHooks(this.#prePageCreateHooks, pageId, browserController, finalPageOptions);
+        await this.#executeHooks(this.#prePageCreateHooks, pageId, browserController, finalPageOptions);
         tryCancel();
         let page;
         try {
@@ -316,13 +318,13 @@ export class BrowserPool extends TypedEmitter {
             if (browserController.totalPages >= this.#retireBrowserAfterPageCount) {
                 this.retireBrowserController(browserController);
             }
-            this.overridePageClose(page);
+            this.#overridePageClose(page);
         }
         catch (err) {
             this.retireBrowserController(browserController);
             throw new Error(`browserController.newPage() failed: ${browserController.id}\nCause:${err.message}.`);
         }
-        await this.executeHooks(this.#postPageCreateHooks, page, browserController);
+        await this.#executeHooks(this.#postPageCreateHooks, page, browserController);
         tryCancel();
         this.emit(BROWSER_POOL_EVENTS.PAGE_CREATED, page);
         return page;
@@ -422,7 +424,7 @@ export class BrowserPool extends TypedEmitter {
      * @return {Promise<void>}
      */
     async closeAllBrowsers() {
-        const controllers = this.getAllBrowserControllers();
+        const controllers = this.#getAllBrowserControllers();
         const promises = [...controllers]
             .filter((controller) => controller.isActive)
             .map(async (controller) => controller.close());
@@ -453,14 +455,14 @@ export class BrowserPool extends TypedEmitter {
         await this.releaseAllBrowsers();
         this.removeAllListeners();
     }
-    getAllBrowserControllers() {
+    #getAllBrowserControllers() {
         return new Set([
             ...this.#startingBrowserControllers,
             ...this.activeBrowserControllers,
             ...this.retiredBrowserControllers,
         ]);
     }
-    async launchBrowser(pageId, options) {
+    async #launchBrowser(pageId, options) {
         const { browserPlugin, launchOptions, proxyUrl, ignoreTlsErrors } = options;
         const browserController = browserPlugin.createController();
         this.#startingBrowserControllers.add(browserController);
@@ -481,7 +483,7 @@ export class BrowserPool extends TypedEmitter {
         try {
             // If the hooks or the launch fails, we need to delete the controller,
             // because otherwise it would be stuck in limbo without a browser.
-            await this.executeHooks(this.#preLaunchHooks, pageId, launchContext);
+            await this.#executeHooks(this.#preLaunchHooks, pageId, launchContext);
             tryCancel();
             const browser = await browserPlugin.launch(launchContext);
             tryCancel();
@@ -496,7 +498,7 @@ export class BrowserPool extends TypedEmitter {
         try {
             // If the launch fails on the post-launch hooks, we need to clean up
             // both the controller and the browser before throwing.
-            await this.executeHooks(this.#postLaunchHooks, pageId, browserController);
+            await this.#executeHooks(this.#postLaunchHooks, pageId, browserController);
         }
         catch (err) {
             this.#startingBrowserControllers.delete(browserController);
@@ -517,12 +519,12 @@ export class BrowserPool extends TypedEmitter {
     /**
      * Picks plugins round robin.
      */
-    pickBrowserPlugin() {
+    #pickBrowserPlugin() {
         const pluginIndex = this.#pageCounter % this.browserPlugins.length;
         this.#pageCounter++;
         return this.browserPlugins[pluginIndex];
     }
-    pickBrowserWithFreeCapacity(browserPlugin, options) {
+    #pickBrowserWithFreeCapacity(browserPlugin, options) {
         return [...this.activeBrowserControllers].find((controller) => {
             const hasCapacity = controller.activePages < this.#maxOpenPagesPerBrowser;
             const isCorrectPlugin = controller.browserPlugin === browserPlugin;
@@ -534,6 +536,7 @@ export class BrowserPool extends TypedEmitter {
                     (!options?.proxyUrl && !controller.proxyUrl)));
         });
     }
+    // oxlint-disable-next-line crawlee/prefer-private-fields -- accessed by tests
     async closeInactiveRetiredBrowsers() {
         const closedBrowserIds = [];
         for (const controller of this.retiredBrowserControllers) {
@@ -555,7 +558,7 @@ export class BrowserPool extends TypedEmitter {
             });
         }
     }
-    overridePageClose(page) {
+    #overridePageClose(page) {
         const originalPageClose = page.close;
         const browserController = this.#pageToBrowserController.get(page);
         const pageId = this.getPageId(page);
@@ -569,14 +572,14 @@ export class BrowserPool extends TypedEmitter {
             // so a timeout here would cancel the task of whoever awaited `page.close()`.
             let pageClosed = false;
             const closing = (async () => {
-                await this.executeHooks(this.#prePageCloseHooks, page, browserController);
+                await this.#executeHooks(this.#prePageCloseHooks, page, browserController);
                 await originalPageClose.apply(page, args).catch((err) => {
                     this.#log.debug(`Could not close page.\nCause:${err.message}`, { id: browserController.id });
                 });
                 // Whether the page itself is gone. Tracked separately from the sequence finishing,
                 // so that a slow hook does not get the browser retired.
                 pageClosed = true;
-                await this.executeHooks(this.#postPageCloseHooks, pageId, browserController);
+                await this.#executeHooks(this.#postPageCloseHooks, pageId, browserController);
             })();
             let timeout;
             const finished = await Promise.race([
@@ -600,16 +603,16 @@ export class BrowserPool extends TypedEmitter {
             }
             browserController.registerPageClosed(page);
             this.pages.delete(pageId);
-            this.closeRetiredBrowserWithNoPages(browserController);
+            this.#closeRetiredBrowserWithNoPages(browserController);
             this.emit(BROWSER_POOL_EVENTS.PAGE_CLOSED, page);
         };
     }
-    async executeHooks(hooks, ...args) {
+    async #executeHooks(hooks, ...args) {
         for (const hook of hooks) {
             await hook(...args);
         }
     }
-    closeRetiredBrowserWithNoPages(browserController) {
+    #closeRetiredBrowserWithNoPages(browserController) {
         if (browserController.activePages === 0 && this.retiredBrowserControllers.has(browserController)) {
             // Run this with a delay, otherwise page.close()
             // might fail with "Protocol error (Target.closeTarget): Target closed."
@@ -650,7 +653,7 @@ export class BrowserPool extends TypedEmitter {
         }
         return false;
     }
-    initializeFingerprinting() {
+    #initializeFingerprinting() {
         const { useFingerprintCache = true, fingerprintCacheSize = 10_000 } = this.fingerprintOptions;
         this.fingerprintGenerator = new FingerprintGenerator(this.fingerprintOptions.fingerprintGeneratorOptions);
         this.fingerprintInjector = new FingerprintInjector();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@crawlee/browser-pool",
-    "version": "4.0.0-beta.211",
+    "version": "4.0.0-beta.212",
     "description": "Rotate multiple browsers using popular automation libraries such as Playwright or Puppeteer.",
     "engines": {
         "node": ">=22.0.0"
@@ -31,9 +31,9 @@
     },
     "dependencies": {
         "@apify/timeout": "^1.0.1",
-        "@crawlee/core": "4.0.0-beta.211",
-        "@crawlee/types": "4.0.0-beta.211",
-        "@crawlee/utils": "4.0.0-beta.211",
+        "@crawlee/core": "4.0.0-beta.212",
+        "@crawlee/types": "4.0.0-beta.212",
+        "@crawlee/utils": "4.0.0-beta.212",
         "fingerprint-generator": "^2.1.68",
         "fingerprint-injector": "^2.1.68",
         "lodash.merge": "^4.6.2",
@@ -64,5 +64,5 @@
             }
         }
     },
-    "gitHead": "17bab8ab5b98554ca2db1d09bc5f61c59194a760"
+    "gitHead": "171a63a5d7f2a6d74cbce58479204ac20d30b87e"
 }

package/playwright/playwright-plugin.d.ts

@@ -15,7 +15,6 @@ export declare class PlaywrightPlugin extends BrowserPlugin<BrowserType, SafePar
      */
     useRemoteConnection(connection: RemoteConnection, parameters?: RemoteConnectionParameters): void;
     protected _launch(launchContext: LaunchContext<BrowserType>): Promise<PlaywrightBrowser>;
-    private throwOnFailedLaunch;
     createController(): PlaywrightController;
     protected addProxyToLaunchOptions(launchContext: LaunchContext<BrowserType>): Promise<void>;
     protected isChromiumBasedBrowser(): boolean;

package/playwright/playwright-plugin.js

@@ -55,7 +55,7 @@ export class PlaywrightPlugin extends BrowserPlugin {
         try {
             if (useIncognitoPages) {
                 browser = await this.library.launch(launchOptions).catch((error) => {
-                    return this.throwOnFailedLaunch(launchContext, error);
+                    return this.#throwOnFailedLaunch(launchContext, error);
                 });
                 if (anonymizedProxyUrl) {
                     browser.on('disconnected', async () => {
@@ -67,7 +67,7 @@ export class PlaywrightPlugin extends BrowserPlugin {
                 const browserContext = await this.library
                     .launchPersistentContext(userDataDir, launchOptions)
                     .catch((error) => {
-                    return this.throwOnFailedLaunch(launchContext, error);
+                    return this.#throwOnFailedLaunch(launchContext, error);
                 });
                 browserContext.once('close', () => {
                     if (userDataDir.includes('apify-playwright-firefox-taac-')) {
@@ -104,7 +104,7 @@ export class PlaywrightPlugin extends BrowserPlugin {
         }
         return browser;
     }
-    throwOnFailedLaunch(launchContext, cause) {
+    #throwOnFailedLaunch(launchContext, cause) {
         this.throwAugmentedLaunchError(cause, launchContext.launchOptions?.executablePath, '`apify/actor-node-playwright-*` (with a correct browser name)', 'Try installing the required dependencies by running `npx playwright install --with-deps` (https://playwright.dev/docs/browsers).');
     }
     createController() {

package/remote-browser-pool.d.ts

@@ -167,12 +167,4 @@ export declare class RemoteBrowserPool<Page = unknown> implements IBrowserPool<P
     [Symbol.asyncDispose](): Promise<void>;
     /** Closes all browsers, releases any still-open remote sessions, and tears down the wrapped pool. */
     destroy(): Promise<void>;
-    /** Resolves once the wrapped pool can serve another page without exceeding `maxOpenBrowsers`. */
-    private waitForFreeSlot;
-    /**
-     * Resolves on the next browser-retired / page-closed event, or after `slotPollIntervalMillis`. All
-     * concurrently-waiting `newPage` calls share a single promise (and a single pair of event listeners)
-     * per tick, so a fleet of saturated callers doesn't fan out into N listener pairs on the pool.
-     */
-    private nextCapacityChange;
 }

package/remote-browser-pool.js

@@ -148,7 +148,7 @@ export class RemoteBrowserPool {
      * allows it (either a new browser slot is free, or an active browser still has page capacity).
      */
     async newPage(options) {
-        await this.waitForFreeSlot();
+        await this.#waitForFreeSlot();
         return this.#pool.newPage(options);
     }
     async closePage(page, options) {
@@ -177,9 +177,9 @@ export class RemoteBrowserPool {
         await this.#registry.releaseAll();
     }
     /** Resolves once the wrapped pool can serve another page without exceeding `maxOpenBrowsers`. */
-    async waitForFreeSlot() {
+    async #waitForFreeSlot() {
         while (!this.browserPool.hasFreeBrowserSlot() && !this.browserPool.hasActiveBrowserWithFreeCapacity()) {
-            await this.nextCapacityChange();
+            await this.#nextCapacityChange();
         }
     }
     /**
@@ -187,7 +187,7 @@ export class RemoteBrowserPool {
      * concurrently-waiting `newPage` calls share a single promise (and a single pair of event listeners)
      * per tick, so a fleet of saturated callers doesn't fan out into N listener pairs on the pool.
      */
-    nextCapacityChange() {
+    #nextCapacityChange() {
         this.#capacityChange ??= new Promise((resolve) => {
             const done = () => {
                 clearTimeout(timer);