@crawlee/browser-pool 4.0.0-beta.15 → 4.0.0-beta.151

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. package/README.md +14 -14
  2. package/abstract-classes/browser-controller.d.ts +74 -14
  3. package/abstract-classes/browser-controller.js +28 -24
  4. package/abstract-classes/browser-plugin.d.ts +48 -15
  5. package/abstract-classes/browser-plugin.js +69 -11
  6. package/anonymize-proxy.d.ts +5 -2
  7. package/anonymize-proxy.js +9 -5
  8. package/browser-pool.d.ts +100 -28
  9. package/browser-pool.js +199 -79
  10. package/container-proxy-server.d.ts +0 -1
  11. package/container-proxy-server.js +0 -1
  12. package/events.d.ts +2 -3
  13. package/events.js +0 -1
  14. package/fingerprinting/hooks.d.ts +0 -1
  15. package/fingerprinting/hooks.js +26 -10
  16. package/fingerprinting/types.d.ts +3 -4
  17. package/fingerprinting/types.js +0 -1
  18. package/fingerprinting/utils.d.ts +0 -1
  19. package/fingerprinting/utils.js +5 -6
  20. package/index.d.ts +14 -7
  21. package/index.js +5 -3
  22. package/launch-context.d.ts +20 -5
  23. package/launch-context.js +21 -10
  24. package/package.json +9 -9
  25. package/playwright/playwright-browser.d.ts +2 -6
  26. package/playwright/playwright-browser.js +16 -17
  27. package/playwright/playwright-controller.d.ts +0 -1
  28. package/playwright/playwright-controller.js +6 -3
  29. package/playwright/playwright-plugin.d.ts +10 -7
  30. package/playwright/playwright-plugin.js +40 -16
  31. package/proxy-server.d.ts +0 -1
  32. package/proxy-server.js +0 -1
  33. package/puppeteer/puppeteer-controller.d.ts +0 -1
  34. package/puppeteer/puppeteer-controller.js +16 -9
  35. package/puppeteer/puppeteer-plugin.d.ts +5 -3
  36. package/puppeteer/puppeteer-plugin.js +83 -46
  37. package/remote-browser-pool.d.ts +165 -0
  38. package/remote-browser-pool.js +195 -0
  39. package/remote-browser-provider.d.ts +83 -0
  40. package/remote-browser-provider.js +67 -0
  41. package/utils.d.ts +7 -1
  42. package/utils.js +19 -1
  43. package/abstract-classes/browser-controller.d.ts.map +0 -1
  44. package/abstract-classes/browser-controller.js.map +0 -1
  45. package/abstract-classes/browser-plugin.d.ts.map +0 -1
  46. package/abstract-classes/browser-plugin.js.map +0 -1
  47. package/anonymize-proxy.d.ts.map +0 -1
  48. package/anonymize-proxy.js.map +0 -1
  49. package/browser-pool.d.ts.map +0 -1
  50. package/browser-pool.js.map +0 -1
  51. package/container-proxy-server.d.ts.map +0 -1
  52. package/container-proxy-server.js.map +0 -1
  53. package/events.d.ts.map +0 -1
  54. package/events.js.map +0 -1
  55. package/fingerprinting/hooks.d.ts.map +0 -1
  56. package/fingerprinting/hooks.js.map +0 -1
  57. package/fingerprinting/types.d.ts.map +0 -1
  58. package/fingerprinting/types.js.map +0 -1
  59. package/fingerprinting/utils.d.ts.map +0 -1
  60. package/fingerprinting/utils.js.map +0 -1
  61. package/index.d.ts.map +0 -1
  62. package/index.js.map +0 -1
  63. package/launch-context.d.ts.map +0 -1
  64. package/launch-context.js.map +0 -1
  65. package/logger.d.ts +0 -3
  66. package/logger.d.ts.map +0 -1
  67. package/logger.js +0 -5
  68. package/logger.js.map +0 -1
  69. package/playwright/playwright-browser.d.ts.map +0 -1
  70. package/playwright/playwright-browser.js.map +0 -1
  71. package/playwright/playwright-controller.d.ts.map +0 -1
  72. package/playwright/playwright-controller.js.map +0 -1
  73. package/playwright/playwright-plugin.d.ts.map +0 -1
  74. package/playwright/playwright-plugin.js.map +0 -1
  75. package/proxy-server.d.ts.map +0 -1
  76. package/proxy-server.js.map +0 -1
  77. package/puppeteer/puppeteer-controller.d.ts.map +0 -1
  78. package/puppeteer/puppeteer-controller.js.map +0 -1
  79. package/puppeteer/puppeteer-plugin.d.ts.map +0 -1
  80. package/puppeteer/puppeteer-plugin.js.map +0 -1
  81. package/utils.d.ts.map +0 -1
  82. package/utils.js.map +0 -1
@@ -1,7 +1,6 @@
1
1
  import { tryCancel } from '@apify/timeout';
2
2
  import { BrowserController } from '../abstract-classes/browser-controller.js';
3
3
  import { anonymizeProxySugar } from '../anonymize-proxy.js';
4
- import { log } from '../logger.js';
5
4
  const PROCESS_KILL_TIMEOUT_MILLIS = 5000;
6
5
  export class PuppeteerController extends BrowserController {
7
6
  normalizeProxyOptions(proxyUrl, pageOptions) {
@@ -12,7 +11,7 @@ export class PuppeteerController extends BrowserController {
12
11
  const username = decodeURIComponent(url.username);
13
12
  const password = decodeURIComponent(url.password);
14
13
  return {
15
- proxyServer: url.origin,
14
+ proxyServer: `${url.protocol}//${url.host}`,
16
15
  proxyUsername: username,
17
16
  proxyPassword: password,
18
17
  proxyBypassList: pageOptions?.proxyBypassList,
@@ -25,7 +24,7 @@ export class PuppeteerController extends BrowserController {
25
24
  }
26
25
  let close = async () => { };
27
26
  if (contextOptions.proxyServer) {
28
- const [anonymizedProxyUrl, closeProxy] = await anonymizeProxySugar(contextOptions.proxyServer, contextOptions.proxyUsername, contextOptions.proxyPassword);
27
+ const [anonymizedProxyUrl, closeProxy] = await anonymizeProxySugar(contextOptions.proxyServer, contextOptions.proxyUsername, contextOptions.proxyPassword, { ignoreProxyCertificate: this.launchContext.ignoreProxyCertificate });
29
28
  if (anonymizedProxyUrl) {
30
29
  contextOptions.proxyServer = anonymizedProxyUrl;
31
30
  delete contextOptions.proxyUsername;
@@ -58,7 +57,7 @@ export class PuppeteerController extends BrowserController {
58
57
  await context.close();
59
58
  }
60
59
  catch (error) {
61
- log.exception(error, 'Failed to close context.');
60
+ this.log.exception(error, 'Failed to close context.');
62
61
  }
63
62
  finally {
64
63
  await close();
@@ -84,7 +83,7 @@ export class PuppeteerController extends BrowserController {
84
83
  async _kill() {
85
84
  const browserProcess = this.browser.process();
86
85
  if (!browserProcess) {
87
- log.debug('Browser was connected using the `puppeteer.connect` method no browser to kill.');
86
+ this.log.debug('Browser was connected using the `puppeteer.connect` method no browser to kill.');
88
87
  return;
89
88
  }
90
89
  const timeout = setTimeout(() => {
@@ -98,14 +97,22 @@ export class PuppeteerController extends BrowserController {
98
97
  clearTimeout(timeout);
99
98
  }
100
99
  catch (error) {
101
- log.debug('Browser was already killed.', { error });
100
+ this.log.debug('Browser was already killed.', { error });
102
101
  }
103
102
  }
104
103
  async _getCookies(page) {
105
- return page.cookies();
104
+ const cookies = await page.browserContext().cookies();
105
+ // Puppeteer 25+ can report `sameSite: 'Default'`, which means the attribute is unspecified.
106
+ return cookies.map(({ sameSite, ...rest }) => ({
107
+ ...rest,
108
+ sameSite: sameSite === 'Default' ? undefined : sameSite,
109
+ }));
106
110
  }
107
111
  async _setCookies(page, cookies) {
108
- return page.setCookie(...cookies);
112
+ // BrowserContext.setCookie requires `url` or `domain`; the page-level API used to back-fill
113
+ // the page's current URL for us. Replicate that so callers who pass neither don't get rejected.
114
+ const pageUrl = page.url();
115
+ const normalized = cookies.map((cookie) => cookie.url || cookie.domain ? cookie : { ...cookie, url: pageUrl });
116
+ return page.browserContext().setCookie(...normalized);
109
117
  }
110
118
  }
111
- //# sourceMappingURL=puppeteer-controller.js.map
@@ -4,12 +4,14 @@ import type Puppeteer from 'puppeteer';
4
4
  import type * as PuppeteerTypes from 'puppeteer';
5
5
  import { BrowserPlugin } from '../abstract-classes/browser-plugin.js';
6
6
  import type { LaunchContext } from '../launch-context.js';
7
+ import type { RemoteConnection, RemoteConnectionParameters } from '../remote-browser-pool.js';
7
8
  import type { PuppeteerNewPageOptions } from './puppeteer-controller.js';
8
9
  import { PuppeteerController } from './puppeteer-controller.js';
9
10
  export declare class PuppeteerPlugin extends BrowserPlugin<typeof Puppeteer, PuppeteerTypes.LaunchOptions, PuppeteerTypes.Browser, PuppeteerNewPageOptions> {
11
+ /** Pages share cookies/storage on the remote browser (Puppeteer defaults to non-incognito). */
12
+ useRemoteConnection(connection: RemoteConnection, parameters?: RemoteConnectionParameters): void;
10
13
  protected _launch(launchContext: LaunchContext<typeof Puppeteer, PuppeteerTypes.LaunchOptions, PuppeteerTypes.Browser, PuppeteerNewPageOptions>): Promise<PuppeteerTypes.Browser>;
11
14
  createController(): PuppeteerController;
12
- protected _addProxyToLaunchOptions(_launchContext: LaunchContext<typeof Puppeteer, PuppeteerTypes.LaunchOptions, PuppeteerTypes.Browser, PuppeteerNewPageOptions>): Promise<void>;
13
- protected _isChromiumBasedBrowser(_launchContext: LaunchContext<typeof Puppeteer, PuppeteerTypes.LaunchOptions, PuppeteerTypes.Browser, PuppeteerNewPageOptions>): boolean;
15
+ protected addProxyToLaunchOptions(_launchContext: LaunchContext<typeof Puppeteer, PuppeteerTypes.LaunchOptions, PuppeteerTypes.Browser, PuppeteerNewPageOptions>): Promise<void>;
16
+ protected isChromiumBasedBrowser(_launchContext: LaunchContext<typeof Puppeteer, PuppeteerTypes.LaunchOptions, PuppeteerTypes.Browser, PuppeteerNewPageOptions>): boolean;
14
17
  }
15
- //# sourceMappingURL=puppeteer-plugin.d.ts.map
@@ -1,11 +1,18 @@
1
1
  import { readFile } from 'node:fs/promises';
2
2
  import { BrowserPlugin } from '../abstract-classes/browser-plugin.js';
3
3
  import { anonymizeProxySugar } from '../anonymize-proxy.js';
4
- import { log } from '../logger.js';
5
4
  import { noop } from '../utils.js';
6
5
  import { PuppeteerController } from './puppeteer-controller.js';
7
6
  const PROXY_SERVER_ARG = '--proxy-server=';
8
7
  export class PuppeteerPlugin extends BrowserPlugin {
8
+ /** Pages share cookies/storage on the remote browser (Puppeteer defaults to non-incognito). */
9
+ useRemoteConnection(connection, parameters = {}) {
10
+ super.useRemoteConnection(connection, parameters);
11
+ if (!this.useIncognitoPages) {
12
+ this.log.info('Remote Puppeteer connection — pages will share cookies and storage on the remote ' +
13
+ 'browser instance (useIncognitoPages defaults to false).');
14
+ }
15
+ }
9
16
  async _launch(launchContext) {
10
17
  let oldPuppeteerVersion = false;
11
18
  try {
@@ -17,58 +24,80 @@ export class PuppeteerPlugin extends BrowserPlugin {
17
24
  catch {
18
25
  // ignore
19
26
  }
20
- const { launchOptions, userDataDir, useIncognitoPages, proxyUrl } = launchContext;
21
- launchOptions.userDataDir = launchOptions.userDataDir ?? userDataDir;
22
- if (launchOptions.headless === false) {
23
- if (Array.isArray(launchOptions.args)) {
24
- launchOptions.args.push('--disable-site-isolation-trials');
25
- }
26
- else {
27
- launchOptions.args = ['--disable-site-isolation-trials'];
28
- }
29
- }
30
- if (launchOptions.headless === true && oldPuppeteerVersion) {
31
- launchOptions.headless = 'new';
32
- }
27
+ const { useIncognitoPages, proxyUrl, ignoreProxyCertificate } = launchContext;
33
28
  let browser;
34
- {
35
- const [anonymizedProxyUrl, close] = await anonymizeProxySugar(proxyUrl);
36
- if (proxyUrl) {
37
- const proxyArg = `${PROXY_SERVER_ARG}${anonymizedProxyUrl ?? proxyUrl}`;
29
+ if (this.remoteConnection) {
30
+ browser = await this.connectToRemoteBrowser(launchContext, async (url) => {
31
+ const connectOptions = this.remoteConnectionParameters?.connectOptions ?? {};
32
+ this.log.info('Connecting to remote browser via connect (CDP).');
33
+ return this.library.connect({ ...connectOptions, browserWSEndpoint: url });
34
+ });
35
+ }
36
+ else {
37
+ const { launchOptions, userDataDir, experimentalContainers } = launchContext;
38
+ if (experimentalContainers) {
39
+ throw new Error('Experimental containers are only available with Playwright');
40
+ }
41
+ launchOptions.userDataDir = launchOptions.userDataDir ?? userDataDir;
42
+ if (launchOptions.headless === false) {
38
43
  if (Array.isArray(launchOptions.args)) {
39
- launchOptions.args.push(proxyArg);
44
+ launchOptions.args.push('--disable-site-isolation-trials');
40
45
  }
41
46
  else {
42
- launchOptions.args = [proxyArg];
47
+ launchOptions.args = ['--disable-site-isolation-trials'];
43
48
  }
44
49
  }
45
- try {
46
- browser = await this.library.launch(launchOptions);
47
- if (anonymizedProxyUrl) {
48
- browser.on('disconnected', async () => {
49
- await close();
50
- });
51
- }
50
+ if (launchOptions.headless === true && oldPuppeteerVersion) {
51
+ launchOptions.headless = 'new';
52
52
  }
53
- catch (error) {
54
- await close();
55
- this._throwAugmentedLaunchError(error, launchContext.launchOptions?.executablePath, '`apify/actor-node-puppeteer-chrome`', "Try installing a browser, if it's missing, by running `npx @puppeteer/browsers install chromium --path [path]` and pointing `executablePath` to the downloaded executable (https://pptr.dev/browsers-api)");
53
+ {
54
+ const [anonymizedProxyUrl, close] = await anonymizeProxySugar(proxyUrl, undefined, undefined, {
55
+ ignoreProxyCertificate: launchContext.ignoreProxyCertificate,
56
+ });
57
+ if (proxyUrl) {
58
+ const proxyArg = `${PROXY_SERVER_ARG}${anonymizedProxyUrl ?? proxyUrl}`;
59
+ if (Array.isArray(launchOptions.args)) {
60
+ launchOptions.args.push(proxyArg);
61
+ }
62
+ else {
63
+ launchOptions.args = [proxyArg];
64
+ }
65
+ }
66
+ try {
67
+ browser = await this.library.launch(launchOptions);
68
+ if (anonymizedProxyUrl) {
69
+ browser.on('disconnected', async () => {
70
+ await close();
71
+ });
72
+ }
73
+ }
74
+ catch (error) {
75
+ await close();
76
+ this.throwAugmentedLaunchError(error, launchContext.launchOptions?.executablePath, '`apify/actor-node-puppeteer-chrome`', "Try installing a browser, if it's missing, by running `npx @puppeteer/browsers install chromium --path [path]` and pointing `executablePath` to the downloaded executable (https://pptr.dev/browsers-api)");
77
+ }
56
78
  }
57
79
  }
58
- browser.on('targetcreated', async (target) => {
80
+ const targetCreatedHandler = async (target) => {
59
81
  try {
60
82
  const page = await target.page();
61
83
  if (page) {
62
84
  page.on('error', (error) => {
63
- log.exception(error, 'Page crashed.');
85
+ this.log.exception(error, 'Page crashed.');
64
86
  page.close().catch(noop);
65
87
  });
66
88
  }
67
89
  }
68
90
  catch (error) {
69
- log.exception(error, 'Failed to retrieve page from target.');
91
+ this.log.exception(error, 'Failed to retrieve page from target.');
70
92
  }
71
- });
93
+ };
94
+ browser.on('targetcreated', targetCreatedHandler);
95
+ // Clean up the listener when a remote browser disconnects to prevent leaks
96
+ if (this.remoteConnection) {
97
+ browser.once('disconnected', () => {
98
+ browser.off('targetcreated', targetCreatedHandler);
99
+ });
100
+ }
72
101
  const boundMethods = [
73
102
  'newPage',
74
103
  'close',
@@ -78,6 +107,7 @@ export class PuppeteerPlugin extends BrowserPlugin {
78
107
  'version',
79
108
  'on',
80
109
  'process',
110
+ 'pages',
81
111
  ].reduce((map, method) => {
82
112
  map[method] = browser[method]?.bind(browser);
83
113
  return map;
@@ -89,22 +119,30 @@ export class PuppeteerPlugin extends BrowserPlugin {
89
119
  return async (...args) => {
90
120
  let page;
91
121
  if (useIncognitoPages) {
92
- const [anonymizedProxyUrl, close] = await anonymizeProxySugar(proxyUrl);
122
+ // Skip proxy setup for remote connections — proxy is managed by the remote service.
123
+ const effectiveProxyUrl = this.remoteConnection ? undefined : proxyUrl;
124
+ const [anonymizedProxyUrl, close] = effectiveProxyUrl
125
+ ? await anonymizeProxySugar(effectiveProxyUrl, undefined, undefined, {
126
+ ignoreProxyCertificate,
127
+ })
128
+ : [undefined, noop];
129
+ const proxyServer = anonymizedProxyUrl ?? effectiveProxyUrl;
130
+ const contextOptions = proxyServer ? { proxyServer } : {};
131
+ const context = (await browser[method](contextOptions));
93
132
  try {
94
- const context = (await browser[method]({
95
- proxyServer: anonymizedProxyUrl ?? proxyUrl,
96
- }));
97
133
  page = await context.newPage(...args);
98
- if (anonymizedProxyUrl) {
99
- page.on('close', async () => {
100
- await close();
101
- });
102
- }
103
134
  }
104
135
  catch (error) {
136
+ await context.close().catch(noop);
105
137
  await close();
106
138
  throw error;
107
139
  }
140
+ page.once('close', async () => {
141
+ if (anonymizedProxyUrl) {
142
+ await close();
143
+ }
144
+ await context.close().catch(noop);
145
+ });
108
146
  }
109
147
  else {
110
148
  page = await boundMethods.newPage(...args);
@@ -139,7 +177,7 @@ export class PuppeteerPlugin extends BrowserPlugin {
139
177
  createController() {
140
178
  return new PuppeteerController(this);
141
179
  }
142
- async _addProxyToLaunchOptions(_launchContext) {
180
+ async addProxyToLaunchOptions(_launchContext) {
143
181
  /*
144
182
  // DO NOT USE YET! DOING SO DISABLES CACHE WHICH IS 50% PERFORMANCE HIT!
145
183
  launchContext.launchOptions ??= {};
@@ -166,8 +204,7 @@ export class PuppeteerPlugin extends BrowserPlugin {
166
204
  }
167
205
  */
168
206
  }
169
- _isChromiumBasedBrowser(_launchContext) {
207
+ isChromiumBasedBrowser(_launchContext) {
170
208
  return true;
171
209
  }
172
210
  }
173
- //# sourceMappingURL=puppeteer-plugin.js.map
@@ -0,0 +1,165 @@
1
+ import type { IBrowserPool, NewPageOptions, PageState } from '@crawlee/types';
2
+ import type { BrowserPlugin } from './abstract-classes/browser-plugin.js';
3
+ import { BrowserPool } from './browser-pool.js';
4
+ import type { BrowserPoolHooks, BrowserPoolOptions } from './browser-pool.js';
5
+ import { RemoteBrowserProvider } from './remote-browser-provider.js';
6
+ /**
7
+ * The result of resolving a remote browser endpoint: the URL to connect to plus an optional opaque
8
+ * `context` object that is handed back to `release`.
9
+ */
10
+ export interface ResolvedRemoteEndpoint {
11
+ /** The browser endpoint URL to connect to. */
12
+ url: string;
13
+ /** Opaque metadata passed back to `release()` — e.g. session IDs, API tokens. */
14
+ context?: Record<string, unknown>;
15
+ }
16
+ /**
17
+ * A remote browser endpoint: either a static URL string, or a function called once per browser launch
18
+ * that returns a URL (optionally with a `context` for `release`).
19
+ *
20
+ * The function receives the `proxyUrl` resolved by Crawlee's proxy configuration for the launch, so it
21
+ * can forward it to the remote service's proxy API.
22
+ */
23
+ export type RemoteBrowserEndpoint = string | ((options?: {
24
+ proxyUrl?: string;
25
+ }) => string | ResolvedRemoteEndpoint | Promise<string | ResolvedRemoteEndpoint>);
26
+ /**
27
+ * The bridge a {@link RemoteBrowserPool} injects into a {@link BrowserPlugin} so the plugin can
28
+ * connect to a remote browser without owning any remote-session policy.
29
+ *
30
+ * The plugin only knows how to make the library-specific `connect()` call; everything else — resolving
31
+ * the endpoint, calling the user's `release()`, and guaranteeing release fires at most once — lives in
32
+ * the pool. The plugin calls {@link RemoteConnection.resolve|resolve} before connecting, stores the
33
+ * returned `token` on its launch context, and the controller later calls
34
+ * {@link RemoteConnection.release|release} with that token when the browser closes.
35
+ */
36
+ export interface RemoteConnection {
37
+ /** Resolves the endpoint for a single browser launch. The `token` identifies the session for release. */
38
+ resolve(options?: {
39
+ proxyUrl?: string;
40
+ }): Promise<{
41
+ url: string;
42
+ token: number;
43
+ }>;
44
+ /** Releases the remote session for `token`. Idempotent — safe to call from both `close()` and `kill()`. */
45
+ release(token: number): Promise<void>;
46
+ }
47
+ /**
48
+ * Per-plugin remote connection parameters, passed to {@link BrowserPlugin.useRemoteConnection}.
49
+ * The endpoint is supplied per-launch via {@link RemoteConnection}; these are the static connect()
50
+ * parameters (protocol, headers, timeouts, …).
51
+ */
52
+ export interface RemoteConnectionParameters {
53
+ /**
54
+ * Playwright only: which protocol to connect with. `'cdp'` uses `connectOverCDP()` (the default),
55
+ // @ts-ignore optional peer dependency or compatibility with es2022
56
+ * `'playwright'` uses `connect()` (Playwright's own WebSocket protocol). Ignored by Puppeteer.
57
+ */
58
+ protocol?: 'cdp' | 'playwright';
59
+ /** Extra options forwarded to the library `connect()` / `connectOverCDP()` call (endpoint excluded). */
60
+ connectOptions?: Record<string, unknown>;
61
+ }
62
+ export interface RemoteBrowserPoolOptions {
63
+ /**
64
+ * The browser plugin(s) used to connect to the remote service — e.g. `new PlaywrightPlugin(playwright.chromium)`
65
+ * or `new PuppeteerPlugin(puppeteer)`. The pool configures them for remote connection; do not set a local
66
+ * `launchOptions` on them.
67
+ */
68
+ browserPlugins: BrowserPlugin[];
69
+ /**
70
+ * The remote browser endpoint: a static URL, a function returning one per launch, or a
71
+ * {@link RemoteBrowserProvider} instance encapsulating a session create/release lifecycle.
72
+ */
73
+ endpoint: RemoteBrowserEndpoint | RemoteBrowserProvider<any>;
74
+ /**
75
+ * Cleanup callback invoked when a browser closes, crashes, or the pool is destroyed. Receives the
76
+ * `context` returned by a function endpoint. Errors are caught and logged. Ignored when `endpoint`
77
+ * is a {@link RemoteBrowserProvider} (its own `release()` is used instead).
78
+ */
79
+ release?: (info: {
80
+ endpoint: string;
81
+ context?: Record<string, unknown>;
82
+ }) => unknown;
83
+ /**
84
+ * Maximum number of remote browsers open at once. When reached, {@link RemoteBrowserPool.newPage|newPage}
85
+ * waits for a browser to close before connecting a new one. Set it to your service's concurrent-session limit
86
+ * to avoid `429` errors. Defaults to the {@link RemoteBrowserProvider.maxOpenBrowsers|provider's value}, or
87
+ * `Infinity`.
88
+ */
89
+ maxOpenBrowsers?: number;
90
+ /** Static connect() parameters (Playwright protocol selection, headers, timeouts, …). */
91
+ connection?: RemoteConnectionParameters;
92
+ /** Extra {@link BrowserPool} options (lifecycle hooks, page limits, fingerprinting, …). */
93
+ browserPoolOptions?: Omit<BrowserPoolOptions, 'browserPlugins'> & BrowserPoolHooks<any, any, any>;
94
+ /** Fallback poll interval (ms) while waiting for a free browser slot. The wait is event-driven; this only bounds it. @default 500 */
95
+ slotPollIntervalMillis?: number;
96
+ }
97
+ /**
98
+ * The remote-connection configuration a browser crawler accepts on its `remoteBrowser` option: the
99
+ * {@link RemoteBrowserPoolOptions} minus the `browserPlugins` (the crawler builds the correct one for its
100
+ * browser, which is what makes this path mismatch-proof) and minus `browserPoolOptions` — tuning the wrapping
101
+ * pool means building the pool yourself, through the `remote*BrowserPool()` factory for your crawler.
102
+ */
103
+ export type CrawlerRemoteBrowserOptions = Omit<RemoteBrowserPoolOptions, 'browserPlugins' | 'browserPoolOptions'>;
104
+ /**
105
+ * An {@link IBrowserPool} implementation for remote browser services.
106
+ *
107
+ * Unlike configuring a remote browser through a crawler's `launchContext`, this pool is the single owner
108
+ * of all remote-session concerns:
109
+ * - **endpoint resolution** — static URL, per-launch function, or {@link RemoteBrowserProvider};
110
+ * - **release lifecycle** — `release()` fires exactly once per session on close/crash/teardown (no leaks,
111
+ * no double-release);
112
+ * - **concurrency** — {@link RemoteBrowserPoolOptions.maxOpenBrowsers|maxOpenBrowsers} is enforced inside
113
+ * {@link RemoteBrowserPool.newPage|newPage}, which waits for a free slot rather than overshooting.
114
+ *
115
+ * The wrapped {@link BrowserPool} and its plugin only perform the library-specific `connect()` call.
116
+ *
117
+ * Pass an instance as the crawler's `browserPool` option:
118
+ *
119
+ * ```typescript
120
+ * import { PlaywrightPlugin, RemoteBrowserPool } from '@crawlee/browser-pool';
121
+ * import { PlaywrightCrawler } from 'crawlee';
122
+ // @ts-ignore optional peer dependency or compatibility with es2022
123
+ * import playwright from 'playwright';
124
+ *
125
+ * const browserPool = new RemoteBrowserPool({
126
+ * browserPlugins: [new PlaywrightPlugin(playwright.chromium)],
127
+ * endpoint: 'wss://production-sfo.browserless.io?token=xxx',
128
+ * maxOpenBrowsers: 2,
129
+ * });
130
+ *
131
+ * const crawler = new PlaywrightCrawler({ browserPool });
132
+ * ```
133
+ *
134
+ * @category Browser management
135
+ */
136
+ export declare class RemoteBrowserPool<Page = unknown> implements IBrowserPool<Page> {
137
+ #private;
138
+ /** The wrapped pool that performs the remote connections and serves pages. */
139
+ readonly browserPool: BrowserPool;
140
+ constructor(options: RemoteBrowserPoolOptions);
141
+ /** Maximum number of remote browsers that may be open at the same time. */
142
+ get maxOpenBrowsers(): number;
143
+ set maxOpenBrowsers(value: number);
144
+ /**
145
+ * Opens a new page, waiting first until {@link RemoteBrowserPoolOptions.maxOpenBrowsers|maxOpenBrowsers}
146
+ * allows it (either a new browser slot is free, or an active browser still has page capacity).
147
+ */
148
+ newPage(options?: NewPageOptions): Promise<Page>;
149
+ closePage(page: Page, options?: {
150
+ error?: Error;
151
+ }): Promise<void>;
152
+ extractPageState(page: Page): Promise<PageState>;
153
+ injectPageState(page: Page, state: PageState): Promise<void>;
154
+ [Symbol.asyncDispose](): Promise<void>;
155
+ /** Closes all browsers, releases any still-open remote sessions, and tears down the wrapped pool. */
156
+ destroy(): Promise<void>;
157
+ /** Resolves once the wrapped pool can serve another page without exceeding `maxOpenBrowsers`. */
158
+ private waitForFreeSlot;
159
+ /**
160
+ * Resolves on the next browser-retired / page-closed event, or after `slotPollIntervalMillis`. All
161
+ * concurrently-waiting `newPage` calls share a single promise (and a single pair of event listeners)
162
+ * per tick, so a fleet of saturated callers doesn't fan out into N listener pairs on the pool.
163
+ */
164
+ private nextCapacityChange;
165
+ }
@@ -0,0 +1,195 @@
1
+ import { serviceLocator } from '@crawlee/core';
2
+ import { BrowserPool } from './browser-pool.js';
3
+ import { BROWSER_CONTROLLER_EVENTS, BROWSER_POOL_EVENTS } from './events.js';
4
+ import { RemoteBrowserProvider } from './remote-browser-provider.js';
5
+ /**
6
+ * Owns the lifecycle of remote browser sessions for a single {@link RemoteBrowserPool}: endpoint
7
+ * resolution, the user's `release()` callback, and a release-at-most-once guarantee. Implements
8
+ * {@link RemoteConnection} so it can be injected into a plugin.
9
+ */
10
+ class RemoteSessionRegistry {
11
+ #sessions = new Map();
12
+ #nextToken = 0;
13
+ #endpoint;
14
+ #onRelease;
15
+ #log;
16
+ constructor(endpoint, onRelease, log) {
17
+ this.#endpoint = endpoint;
18
+ this.#onRelease = onRelease;
19
+ this.#log = log;
20
+ }
21
+ async resolve(options) {
22
+ const resolved = typeof this.#endpoint === 'function' ? await this.#endpoint(options) : this.#endpoint;
23
+ let result;
24
+ if (typeof resolved === 'string') {
25
+ if (!resolved)
26
+ throw new Error('Remote browser endpoint resolved to an empty string.');
27
+ result = { url: resolved };
28
+ }
29
+ else if (!resolved?.url) {
30
+ throw new Error("Remote browser endpoint() must return a URL string or an object with a non-empty 'url'.");
31
+ }
32
+ else {
33
+ result = resolved;
34
+ }
35
+ const token = this.#nextToken++;
36
+ this.#sessions.set(token, { url: result.url, context: result.context, released: false });
37
+ return { url: result.url, token };
38
+ }
39
+ async release(token) {
40
+ const session = this.#sessions.get(token);
41
+ // Release at most once per session — guards a close()/teardown race (the `released` flag is set
42
+ // synchronously before the awaited onRelease, so releaseAll() can't double-fire an in-flight release).
43
+ if (!session || session.released)
44
+ return;
45
+ session.released = true;
46
+ try {
47
+ await this.#onRelease?.({ endpoint: session.url, context: session.context });
48
+ }
49
+ catch (err) {
50
+ this.#log.warning('Remote browser release() failed.', { error: err?.message });
51
+ }
52
+ finally {
53
+ this.#sessions.delete(token);
54
+ }
55
+ }
56
+ /** Releases every session that is still open. Called on pool teardown so no remote session leaks. */
57
+ async releaseAll() {
58
+ await Promise.all([...this.#sessions.keys()].map(async (token) => this.release(token)));
59
+ }
60
+ }
61
+ /**
62
+ * An {@link IBrowserPool} implementation for remote browser services.
63
+ *
64
+ * Unlike configuring a remote browser through a crawler's `launchContext`, this pool is the single owner
65
+ * of all remote-session concerns:
66
+ * - **endpoint resolution** — static URL, per-launch function, or {@link RemoteBrowserProvider};
67
+ * - **release lifecycle** — `release()` fires exactly once per session on close/crash/teardown (no leaks,
68
+ * no double-release);
69
+ * - **concurrency** — {@link RemoteBrowserPoolOptions.maxOpenBrowsers|maxOpenBrowsers} is enforced inside
70
+ * {@link RemoteBrowserPool.newPage|newPage}, which waits for a free slot rather than overshooting.
71
+ *
72
+ * The wrapped {@link BrowserPool} and its plugin only perform the library-specific `connect()` call.
73
+ *
74
+ * Pass an instance as the crawler's `browserPool` option:
75
+ *
76
+ * ```typescript
77
+ * import { PlaywrightPlugin, RemoteBrowserPool } from '@crawlee/browser-pool';
78
+ * import { PlaywrightCrawler } from 'crawlee';
79
+ * import playwright from 'playwright';
80
+ *
81
+ * const browserPool = new RemoteBrowserPool({
82
+ * browserPlugins: [new PlaywrightPlugin(playwright.chromium)],
83
+ * endpoint: 'wss://production-sfo.browserless.io?token=xxx',
84
+ * maxOpenBrowsers: 2,
85
+ * });
86
+ *
87
+ * const crawler = new PlaywrightCrawler({ browserPool });
88
+ * ```
89
+ *
90
+ * @category Browser management
91
+ */
92
+ export class RemoteBrowserPool {
93
+ /** The wrapped pool that performs the remote connections and serves pages. */
94
+ browserPool;
95
+ /** The wrapped pool viewed through the {@link IBrowserPool} contract (the bare type widens pages to `never`). */
96
+ #pool;
97
+ #registry;
98
+ #slotPollIntervalMillis;
99
+ #log;
100
+ /** Shared by all `newPage` callers waiting for a free slot, so they don't each register their own listeners. */
101
+ #capacityChange;
102
+ constructor(options) {
103
+ const { browserPlugins, endpoint, release, maxOpenBrowsers, connection = {}, browserPoolOptions = {}, slotPollIntervalMillis = 500, } = options;
104
+ this.#log = serviceLocator.getLogger().child({ prefix: 'RemoteBrowserPool' });
105
+ this.#slotPollIntervalMillis = slotPollIntervalMillis;
106
+ // A RemoteBrowserProvider carries its own endpoint, release, and maxOpenBrowsers.
107
+ const provider = endpoint instanceof RemoteBrowserProvider ? endpoint : undefined;
108
+ const resolvedEndpoint = provider
109
+ ? (opts) => provider.connect(opts)
110
+ : endpoint;
111
+ const resolvedRelease = provider
112
+ ? ({ context }) => provider.release(context)
113
+ : release;
114
+ const resolvedMax = maxOpenBrowsers ?? provider?.maxOpenBrowsers;
115
+ this.#registry = new RemoteSessionRegistry(resolvedEndpoint, resolvedRelease, this.#log);
116
+ // Wire every plugin for remote connection.
117
+ for (const plugin of browserPlugins) {
118
+ plugin.useRemoteConnection(this.#registry, connection);
119
+ }
120
+ this.browserPool = new BrowserPool({ ...browserPoolOptions, browserPlugins });
121
+ this.#pool = this.browserPool;
122
+ // Release a browser's remote session once it closes. The registry dedupes (close() schedules a delayed
123
+ // kill(), so BROWSER_CLOSED can fire twice), and destroy()'s releaseAll() backstops any that never close.
124
+ this.browserPool.on(BROWSER_POOL_EVENTS.BROWSER_LAUNCHED, (controller) => {
125
+ controller.once(BROWSER_CONTROLLER_EVENTS.BROWSER_CLOSED, () => {
126
+ const token = controller.launchContext.remoteToken;
127
+ if (token !== undefined)
128
+ void this.#registry.release(token);
129
+ });
130
+ });
131
+ if (resolvedMax !== undefined) {
132
+ this.browserPool.maxOpenBrowsers = resolvedMax;
133
+ }
134
+ }
135
+ /** Maximum number of remote browsers that may be open at the same time. */
136
+ get maxOpenBrowsers() {
137
+ return this.browserPool.maxOpenBrowsers;
138
+ }
139
+ set maxOpenBrowsers(value) {
140
+ this.browserPool.maxOpenBrowsers = value;
141
+ }
142
+ /**
143
+ * Opens a new page, waiting first until {@link RemoteBrowserPoolOptions.maxOpenBrowsers|maxOpenBrowsers}
144
+ * allows it (either a new browser slot is free, or an active browser still has page capacity).
145
+ */
146
+ async newPage(options) {
147
+ await this.waitForFreeSlot();
148
+ return this.#pool.newPage(options);
149
+ }
150
+ async closePage(page, options) {
151
+ return this.#pool.closePage(page, options);
152
+ }
153
+ async extractPageState(page) {
154
+ return this.#pool.extractPageState(page);
155
+ }
156
+ async injectPageState(page, state) {
157
+ return this.#pool.injectPageState(page, state);
158
+ }
159
+ async [Symbol.asyncDispose]() {
160
+ await this.destroy();
161
+ }
162
+ /** Closes all browsers, releases any still-open remote sessions, and tears down the wrapped pool. */
163
+ async destroy() {
164
+ await this.browserPool.destroy();
165
+ // Backstop: release any sessions whose browser never emitted a close (e.g. dropped on teardown).
166
+ await this.#registry.releaseAll();
167
+ }
168
+ /** Resolves once the wrapped pool can serve another page without exceeding `maxOpenBrowsers`. */
169
+ async waitForFreeSlot() {
170
+ while (!this.browserPool.hasFreeBrowserSlot() && !this.browserPool.hasActiveBrowserWithFreeCapacity()) {
171
+ await this.nextCapacityChange();
172
+ }
173
+ }
174
+ /**
175
+ * Resolves on the next browser-retired / page-closed event, or after `slotPollIntervalMillis`. All
176
+ * concurrently-waiting `newPage` calls share a single promise (and a single pair of event listeners)
177
+ * per tick, so a fleet of saturated callers doesn't fan out into N listener pairs on the pool.
178
+ */
179
+ nextCapacityChange() {
180
+ this.#capacityChange ??= new Promise((resolve) => {
181
+ const done = () => {
182
+ clearTimeout(timer);
183
+ this.browserPool.off(BROWSER_POOL_EVENTS.BROWSER_RETIRED, done);
184
+ this.browserPool.off(BROWSER_POOL_EVENTS.PAGE_CLOSED, done);
185
+ this.#capacityChange = undefined;
186
+ resolve();
187
+ };
188
+ const timer = setTimeout(done, this.#slotPollIntervalMillis);
189
+ timer.unref?.();
190
+ this.browserPool.once(BROWSER_POOL_EVENTS.BROWSER_RETIRED, done);
191
+ this.browserPool.once(BROWSER_POOL_EVENTS.PAGE_CLOSED, done);
192
+ });
193
+ return this.#capacityChange;
194
+ }
195
+ }