@browserless.io/browserless 2.0.0-beta-8 → 2.1.1

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 (71) hide show
  1. package/CHANGELOG.md +19 -2
  2. package/README.md +10 -6
  3. package/bin/browserless.js +49 -13
  4. package/bin/scaffold/README.md +7 -7
  5. package/bin/scaffold/tsconfig.json +1 -1
  6. package/build/browserless.js +9 -2
  7. package/build/browsers/cdp-chromium.d.ts +1 -1
  8. package/build/browsers/cdp-chromium.js +4 -5
  9. package/build/browsers/index.d.ts +10 -0
  10. package/build/browsers/index.js +44 -0
  11. package/build/browsers/playwright-chromium.d.ts +1 -1
  12. package/build/browsers/playwright-chromium.js +1 -2
  13. package/build/browsers/playwright-firefox.d.ts +1 -1
  14. package/build/browsers/playwright-firefox.js +1 -2
  15. package/build/browsers/playwright-webkit.d.ts +1 -1
  16. package/build/browsers/playwright-webkit.js +1 -2
  17. package/build/config.d.ts +9 -0
  18. package/build/config.js +15 -0
  19. package/build/constants.d.ts +1 -0
  20. package/build/constants.js +1 -0
  21. package/build/data/classes.json +1 -1
  22. package/build/data/selectors.json +1 -1
  23. package/build/file-system.spec.js +1 -1
  24. package/build/http.d.ts +4 -0
  25. package/build/http.js +4 -0
  26. package/build/routes/chromium/http/content-post.body.json +8 -8
  27. package/build/routes/chromium/http/json-list.d.ts +15 -0
  28. package/build/routes/chromium/http/json-list.js +23 -0
  29. package/build/routes/chromium/http/json-list.response.json +52 -0
  30. package/build/routes/chromium/http/json-new.d.ts +15 -0
  31. package/build/routes/chromium/http/json-new.js +23 -0
  32. package/build/routes/chromium/http/json-new.response.json +44 -0
  33. package/build/routes/chromium/http/json-protocol-get.d.ts +15 -0
  34. package/build/routes/chromium/http/json-protocol-get.js +20 -0
  35. package/build/routes/chromium/http/json-protocol-get.response.json +6 -0
  36. package/build/routes/chromium/http/json-version-get.d.ts +15 -0
  37. package/build/routes/chromium/http/json-version-get.js +30 -0
  38. package/build/routes/chromium/http/json-version-get.response.json +37 -0
  39. package/build/routes/chromium/http/pdf-post.body.json +12 -8
  40. package/build/routes/chromium/http/scrape-post.body.json +8 -8
  41. package/build/routes/chromium/http/screenshot-post.body.json +8 -8
  42. package/build/routes/chromium/tests/json-version.spec.d.ts +1 -0
  43. package/build/routes/chromium/tests/json-version.spec.js +37 -0
  44. package/build/routes/chromium/utils/cdp.d.ts +2 -0
  45. package/build/routes/chromium/utils/cdp.js +14 -0
  46. package/build/types.d.ts +31 -0
  47. package/build/utils.d.ts +9 -0
  48. package/build/utils.js +17 -2
  49. package/package.json +15 -18
  50. package/src/browserless.ts +12 -1
  51. package/src/browsers/cdp-chromium.ts +7 -10
  52. package/src/browsers/index.ts +65 -2
  53. package/src/browsers/playwright-chromium.ts +3 -4
  54. package/src/browsers/playwright-firefox.ts +3 -4
  55. package/src/browsers/playwright-webkit.ts +3 -4
  56. package/src/config.ts +17 -0
  57. package/src/constants.ts +1 -0
  58. package/src/file-system.spec.ts +1 -1
  59. package/src/http.ts +4 -0
  60. package/src/routes/chromium/http/json-list.ts +50 -0
  61. package/src/routes/chromium/http/json-new.ts +50 -0
  62. package/src/routes/chromium/http/json-protocol-get.ts +38 -0
  63. package/src/routes/chromium/http/json-version-get.ts +55 -0
  64. package/src/routes/chromium/tests/json-version.spec.ts +52 -0
  65. package/src/routes/chromium/utils/cdp.ts +19 -0
  66. package/src/types.ts +38 -0
  67. package/src/utils.ts +26 -4
  68. package/static/docs/swagger.json +404 -10
  69. package/static/function/client.js +2328 -1975
  70. package/browser.json +0 -7
  71. package/scripts/install-cdp-json.js +0 -37
package/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
- # [Latest](https://github.com/browserless/chrome/compare/v2.0.0...master)
2
- - Dependency updates.
1
+ # [Latest](https://github.com/browserless/chrome/compare/v2.1.0...main)
2
+ - Dependency updates.
3
+ - Add `clean` command to `@browserless.io/browserless` CLI.
4
+ - Adds support for `/json/list`, `/json/new` and `json/protocol` APIs (Chrome only).
5
+ - Removes legacy `browser.json` files since browserless now generates those and caches when requested.
6
+ - Only verify that internally managed browsers are installed when starting.
7
+
8
+ # [v2.1.0](https://github.com/browserless/browserless/compare/v2.0.0-beta-1...v2.1.0)
9
+ - Dependency updates.
10
+ - Name is now `@browserless.io/browserless` to reflect our npm package.
11
+ - NEW: SDK is now live here: https://www.npmjs.com/package/@browserless.io/browserless.
12
+ - Drops gulp and other gulp utilities in favor of our own. Move to modules in `scripts` dir.
13
+ - Many private class properties now use `protected` so they can be referenced in SDK extensions.
14
+ - Adds a `/json/version` route for older libraries that use it.
15
+ - Merge startup/test scripts into `scripts` dir.
16
+ - Moves installed browsers to `/usr/local/bin/playwright-browsers`.
17
+ - Merge root files into package.json where possible.
18
+ - README updates and fixes.
19
+ - Numerous link and copyright fixes.
3
20
 
4
21
  # [v2.0.0](https://github.com/browserless/chrome/compare/master...feat/browserless-2.0)
5
22
  browserless 2.0.0 represents the best body of work after running browserless for over 5 years. It contains mostly the same functionality and more, and is rebuilt to be more modular and offer a NodeJS SDK. It's also much lighter and faster than prior versions and includes a lot of semantic changes.
package/README.md CHANGED
@@ -8,8 +8,7 @@
8
8
  ![Multi CI](https://github.com/browserless/chrome/actions/workflows/docker-multi.yml/badge.svg)
9
9
 
10
10
 
11
- > [Looking for v2.x.x of browserless? Check it out here](https://github.com/browserless/browserless).
12
- > NOTE: Version 1 is the version we currently still have running on browserless' hosted services, we would recommend self-hosted users migrate to v2.
11
+ > [Looking for v1.x.x of browserless? You can find it here](https://github.com/browserless/chrome/tree/v1), although we recommend migrating to v2.
13
12
 
14
13
  Browserless allows remote clients to connect and execute headless work, all inside of docker. It supports the standard, unforked Puppeteer and Playwright libraries, as well offering REST-based APIs for common actions like data collection, PDF generation and more.
15
14
 
@@ -24,14 +23,15 @@ If you've been struggling to deploy headless browsers without running into issue
24
23
  4. [Hosting](#hosting-providers)
25
24
  5. [Puppeteer](#puppeteer)
26
25
  6. [Playwright](#playwright)
27
- 7. [Licensing](#licensing)
28
- 8. [Changelog](https://github.com/browserless/chrome/blob/master/CHANGELOG.md)
26
+ 7. [Extending with NodeJS SDK](#extending-nodejs-skd)
27
+ 8. [Licensing](#licensing)
28
+ 9. [Changelog](https://github.com/browserless/chrome/blob/master/CHANGELOG.md)
29
29
 
30
30
  ## External links
31
31
 
32
32
  1. [Full documentation site](https://www.browserless.io/docs/start)
33
33
  2. [Live Debugger (using browserless.io)](https://chrome.browserless.io/)
34
- 3. [Docker](https://github.com/browserless/chrome/pkgs/container/basic)
34
+ 3. [Docker](https://github.com/browserless/browserless/pkgs/container/base)
35
35
  4. [Slack](https://join.slack.com/t/browserless/shared_invite/enQtMzA3OTMwNjA3MzY1LTRmMWU5NjQ0MTQ2YTE2YmU3MzdjNmVlMmU4MThjM2UxODNmNzNlZjVkY2U2NjdkMzYyNTgyZTBiMmE3Nzg0MzY)
36
36
 
37
37
  # Features
@@ -57,7 +57,7 @@ You still execute the script itself which gives you total control over what libr
57
57
 
58
58
  1. `docker run -p 3000:3000 ghcr.io/browserless/chrome`
59
59
  2. Visit `http://localhost:3000/docs` to see the documentation site.
60
- 3. See more at our [docker package](https://github.com/browserless/chrome/pkgs/container/basic).
60
+ 3. See more at our [docker package](https://github.com/browserless/browserless/pkgs/container/base).
61
61
 
62
62
  # Hosting Providers
63
63
 
@@ -102,6 +102,10 @@ const browser = await pw.chromium.connectOverCDP('ws://localhost:3000');
102
102
 
103
103
  After that, the rest of your code remains the same with no other changes required.
104
104
 
105
+ # Extending (NodeJS SKD)
106
+
107
+ Browserless comes with built-in extension capabilities, and allows for extending nearly any aspect of the system (for Version 2+). For more details on how to write your own routes, build docker images, and more, [see our SDK README.md](/bin/scaffold/README.md) or simply run "npx @browserless.io/browserless create" in a terminal and follow the onscreen prompts.
108
+
105
109
  # Usage with other libraries
106
110
 
107
111
  Most libraries allow you to specify a remote instance of Chrome to interact with. They are either looking for a websocket endpoint, a host and port, or some address. Browserless supports these by default, however if you're having issues please make an issue in this project and we'll try and work with the library authors to get them integrated with browserless. Please note that in V2 we no longer support selenium or webdriver integrations.
@@ -14,7 +14,9 @@ import fs from 'fs/promises';
14
14
  import path from 'path';
15
15
  import { spawn } from 'child_process';
16
16
 
17
- debug.enable('browserless*');
17
+ if (typeof process.env.DEBUG === 'undefined') {
18
+ debug.enable('browserless*');
19
+ }
18
20
 
19
21
  const log = debug('browserless.io:sdk:log');
20
22
  const promptLog = debug('browserless.io:prompt');
@@ -22,9 +24,17 @@ const promptLog = debug('browserless.io:prompt');
22
24
  const __dirname = path.dirname(fileURLToPath(import.meta.url));
23
25
  const cmd = process.argv[2];
24
26
  const subCMD = process.argv[3];
25
- const cwd = process.cwd();
26
- const allowedCMDs = ['build', 'dev', 'docker', 'start', 'create', 'help'];
27
- const srcDir = path.join(cwd, 'build');
27
+ const allowedCMDs = [
28
+ 'build',
29
+ 'dev',
30
+ 'docker',
31
+ 'start',
32
+ 'create',
33
+ 'help',
34
+ 'clean',
35
+ ];
36
+ const projectDir = process.cwd();
37
+ const compiledDir = path.join(projectDir, 'build');
28
38
  const packageJSON = readFile(path.join(__dirname, '..', 'package.json')).then(
29
39
  (r) => JSON.parse(r.toString()),
30
40
  );
@@ -59,7 +69,7 @@ const importClassOverride = async (files, className) => {
59
69
  return;
60
70
  }
61
71
 
62
- const classModuleFullFilePath = path.join(srcDir, classModuleFile);
72
+ const classModuleFullFilePath = path.join(compiledDir, classModuleFile);
63
73
 
64
74
  if (!classModuleFile) {
65
75
  return;
@@ -68,6 +78,12 @@ const importClassOverride = async (files, className) => {
68
78
  return (await import(classModuleFullFilePath)).default;
69
79
  };
70
80
 
81
+ const clean = async () =>
82
+ fs.rm(path.join(compiledDir), {
83
+ force: true,
84
+ recursive: true,
85
+ });
86
+
71
87
  const installDependencies = async (workingDirectory) =>
72
88
  new Promise((resolve, reject) => {
73
89
  spawn('npm', ['i'], {
@@ -88,7 +104,7 @@ const buildDockerImage = async (cmd) => {
88
104
  new Promise((resolve, reject) => {
89
105
  const [docker, ...args] = cmd.split(' ');
90
106
  spawn(docker, args, {
91
- cwd,
107
+ cwd: projectDir,
92
108
  stdio: 'inherit',
93
109
  }).once('close', (code) => {
94
110
  if (code === 0) {
@@ -105,7 +121,7 @@ const buildDockerImage = async (cmd) => {
105
121
  const buildTypeScript = async () =>
106
122
  new Promise((resolve, reject) => {
107
123
  spawn('npx', ['tsc', '--outDir', 'build'], {
108
- cwd,
124
+ cwd: projectDir,
109
125
  stdio: 'inherit',
110
126
  }).once('close', (code) => {
111
127
  if (code === 0) {
@@ -118,16 +134,16 @@ const buildTypeScript = async () =>
118
134
  });
119
135
 
120
136
  const getSourceFiles = async () => {
121
- const files = await fs.readdir(srcDir, { recursive: true });
137
+ const files = await fs.readdir(compiledDir, { recursive: true });
122
138
  const [httpRoutes, webSocketRoutes] = files.reduce(
123
139
  ([httpRoutes, webSocketRoutes], file) => {
124
140
  const parsed = path.parse(file);
125
141
  if (parsed.name.endsWith('http')) {
126
- httpRoutes.push(path.join(srcDir, file));
142
+ httpRoutes.push(path.join(compiledDir, file));
127
143
  }
128
144
 
129
145
  if (parsed.name.endsWith('ws')) {
130
- webSocketRoutes.push(path.join(srcDir, file));
146
+ webSocketRoutes.push(path.join(compiledDir, file));
131
147
  }
132
148
 
133
149
  return [httpRoutes, webSocketRoutes];
@@ -177,6 +193,9 @@ const getArgSwitches = () => {
177
193
  * and validation. Doesn't start the HTTP server.
178
194
  */
179
195
  const build = async () => {
196
+ log(`Cleaning build directory`);
197
+ await clean();
198
+
180
199
  log(`Compiling TypeScript`);
181
200
  await buildTypeScript();
182
201
 
@@ -309,7 +328,7 @@ const start = async (dev = false) => {
309
328
  };
310
329
 
311
330
  const buildDocker = async () => {
312
- const finalDockerPath = path.join(cwd, 'build', 'Dockerfile');
331
+ const finalDockerPath = path.join(projectDir, 'build', 'Dockerfile');
313
332
  const argSwitches = getArgSwitches();
314
333
 
315
334
  await build();
@@ -320,7 +339,10 @@ const buildDocker = async () => {
320
339
 
321
340
  log(`Generating Dockerfile at "${finalDockerPath}"`);
322
341
 
323
- await fs.writeFile(path.join(cwd, 'build', 'Dockerfile'), dockerContents);
342
+ await fs.writeFile(
343
+ path.join(projectDir, 'build', 'Dockerfile'),
344
+ dockerContents,
345
+ );
324
346
 
325
347
  const from =
326
348
  argSwitches.from ||
@@ -391,7 +413,7 @@ const create = async () => {
391
413
  throw new Error(`Name must not include special characters.`);
392
414
  }
393
415
 
394
- const installPath = path.join(cwd, directory);
416
+ const installPath = path.join(projectDir, directory);
395
417
  log(`Creating folder "${installPath}"...`);
396
418
  await fs.mkdir(installPath);
397
419
 
@@ -440,6 +462,15 @@ const help = () => {
440
462
  `);
441
463
  break;
442
464
 
465
+ case 'clean':
466
+ console.log(dedent`
467
+ Usage: npx @browserless.io/browserless clean
468
+
469
+ Description: Cleans the TypeScript generated JavaScript found
470
+ in the "build" directory and any other temporary assets.
471
+ `);
472
+ break;
473
+
443
474
  case 'dev':
444
475
  console.log(dedent`
445
476
  Usage: npx @browserless.io/browserless dev
@@ -492,6 +523,7 @@ const help = () => {
492
523
  Usage: npx @browserless.io/browserless [command] [arguments]
493
524
 
494
525
  Options:
526
+ clean Removes build artifacts and other temporary directories.
495
527
  create Creates a new scaffold project, installs dependencies, and exits.
496
528
  dev Compiles TypeScript, generates build assets and starts the server.
497
529
  build Compiles TypeScript, generates build assets and exits.
@@ -501,6 +533,10 @@ const help = () => {
501
533
  };
502
534
 
503
535
  switch (cmd) {
536
+ case 'clean':
537
+ clean();
538
+ break;
539
+
504
540
  case 'start':
505
541
  start(false);
506
542
  break;
@@ -106,16 +106,16 @@ By default most commands are non-interactive, such as the `build` and `dev` comm
106
106
 
107
107
  ## Routing
108
108
 
109
- Routing is, simply, a plain-old JavaScript object with certain expected properties. Many of the features of Browserless are exposed as options on routes so you can define many types of functionality with just a route definition.
109
+ Routing is based upon the JavaScript `class` fundamentals, and extends core classes inside of Browserless. Many of the features of Browserless are exposed as options on routes so you can define many types of functionality with just a simple route definition.
110
110
 
111
- Browserless has 4 different types of routes:
111
+ Browserless has 4 different types of primitive routes:
112
112
 
113
- - HTTP Routes that don't need a browser to run.
114
- - HTTP Routes that do need a browser to run.
115
- - WebSocket routes that don't a browser.
116
- - WebSockets that need a browser.
113
+ - HTTP Routes.
114
+ - HTTP Routes that require a browser.
115
+ - WebSockets Routes.
116
+ - WebSocket Routes require a browser.
117
117
 
118
- We use this same semantic in our own codebase, so feel free to see how those work in our open-source projects. All routes are TypeScript and all our modules are documented, so you should be able to effectively write routes and modules with your code editor and not necessarily need these examples open. Below are a few examples:
118
+ Internally, we use this same class-based system, so feel free to see how those work in our open-source repositories. All routes are TypeScript-based and all our modules are documented, so you should be able to effectively write routes and modules with your code editor and not necessarily need these examples open. Below are a few examples:
119
119
 
120
120
  ### Basic HTTP Route
121
121
  ```ts
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "extends": "./node_modules/@browserless.io/browserless/tsconfig.json",
3
- "include": ["./src/**/*"]
3
+ "include": ["./src/**/*"],
4
4
  }
@@ -1,5 +1,5 @@
1
1
  import * as path from 'path';
2
- import { BrowserManager, Config, FileSystem, HTTPServer, Limiter, Metrics, Monitoring, Router, Token, WebHooks, availableBrowsers, createLogger, getRouteFiles, makeExternalURL, printLogo, safeParse, } from '@browserless.io/browserless';
2
+ import { BrowserManager, CDPChromium, Config, FileSystem, HTTPServer, Limiter, Metrics, Monitoring, PlaywrightChromium, PlaywrightFirefox, PlaywrightWebkit, Router, Token, WebHooks, availableBrowsers, createLogger, getRouteFiles, makeExternalURL, printLogo, safeParse, } from '@browserless.io/browserless';
3
3
  import { readFile } from 'fs/promises';
4
4
  import { userInfo } from 'os';
5
5
  const routeSchemas = ['body', 'query'];
@@ -88,6 +88,12 @@ export class Browserless {
88
88
  async start() {
89
89
  const httpRoutes = [];
90
90
  const wsRoutes = [];
91
+ const internalBrowsers = [
92
+ CDPChromium,
93
+ PlaywrightFirefox,
94
+ PlaywrightChromium,
95
+ PlaywrightWebkit,
96
+ ];
91
97
  const [[httpRouteFiles, wsRouteFiles], installedBrowsers] = await Promise.all([getRouteFiles(this.config), availableBrowsers]);
92
98
  const docsLink = makeExternalURL(this.config.getExternalAddress(), '/docs');
93
99
  this.debug(printLogo(docsLink));
@@ -137,10 +143,11 @@ export class Browserless {
137
143
  wsRoutes.push(route);
138
144
  }
139
145
  }
140
- // Validate that browsers are installed and route paths are unique
146
+ // Validate that we have the browsers they are asking for
141
147
  [...httpRoutes, ...wsRoutes].forEach((route) => {
142
148
  if ('browser' in route &&
143
149
  route.browser &&
150
+ internalBrowsers.includes(route.browser) &&
144
151
  !installedBrowsers.some((b) => b.name === route.browser?.name)) {
145
152
  throw new Error(`Couldn't load route "${route.path}" due to missing browser of "${route.browser?.name}"`);
146
153
  }
@@ -38,7 +38,7 @@ export declare class CDPChromium extends EventEmitter {
38
38
  process: () => import("child_process").ChildProcess | null;
39
39
  launch: (options?: CDPLaunchOptions) => Promise<Browser>;
40
40
  wsEndpoint: () => string | null;
41
- publicWSEndpoint: (token: string) => string | null;
41
+ publicWSEndpoint: (token: string | null) => string | null;
42
42
  proxyPageWebSocket: (req: Request, socket: Duplex, head: Buffer) => Promise<void>;
43
43
  proxyWebSocket: (req: Request, socket: Duplex, head: Buffer) => Promise<void>;
44
44
  }
@@ -229,11 +229,10 @@ export class CDPChromium extends EventEmitter {
229
229
  if (!this.browserWSEndpoint) {
230
230
  return null;
231
231
  }
232
+ const serverURL = new URL(this.config.getExternalWebSocketAddress());
232
233
  const wsURL = new URL(this.browserWSEndpoint);
233
- const serverURL = new URL(this.config.getExternalAddress());
234
234
  wsURL.hostname = serverURL.hostname;
235
235
  wsURL.port = serverURL.port;
236
- wsURL.protocol = serverURL.protocol === 'https' ? 'wss' : 'ws';
237
236
  if (token) {
238
237
  wsURL.searchParams.set('token', token);
239
238
  }
@@ -244,14 +243,14 @@ export class CDPChromium extends EventEmitter {
244
243
  throw new ServerError(`No browserWSEndpoint found, did you launch first?`);
245
244
  }
246
245
  socket.once('close', resolve);
247
- this.debug(`Proxying ${req.parsed.href} to browser ${this.browserWSEndpoint}`);
248
246
  const [page] = await this.browser.pages();
249
247
  const pageLocation = `/devtools/page/${this.getPageId(page)}`;
250
248
  this.debug(`Proxying ${req.parsed.href} to page "${pageLocation}"`);
251
- req.url = pageLocation;
249
+ const target = new URL(pageLocation, this.browserWSEndpoint).href;
250
+ req.url = '';
252
251
  this.proxy.ws(req, socket, head, {
253
252
  changeOrigin: true,
254
- target: this.browserWSEndpoint,
253
+ target,
255
254
  }, (error) => {
256
255
  this.debug(`Error proxying session: ${error}`);
257
256
  this.close();
@@ -18,6 +18,16 @@ export declare class BrowserManager {
18
18
  * @returns Promise<string> of the fully-qualified path of the directory
19
19
  */
20
20
  protected generateDataDir: (sessionId?: string) => Promise<string>;
21
+ getProtocolJSON: () => Promise<object>;
22
+ getVersionJSON: () => Promise<{
23
+ Browser: string;
24
+ 'Debugger-Version': string;
25
+ 'Protocol-Version': string;
26
+ 'User-Agent': string;
27
+ 'V8-Version': string;
28
+ 'WebKit-Version': string;
29
+ webSocketDebuggerUrl: string;
30
+ }>;
21
31
  private generateSessionJson;
22
32
  close: (browser: BrowserInstance, session: BrowserlessSession) => Promise<void>;
23
33
  getAllSessions: () => Promise<BrowserlessSessionJSON[]>;
@@ -41,6 +41,50 @@ export class BrowserManager {
41
41
  });
42
42
  return dataDirPath;
43
43
  };
44
+ getProtocolJSON = async () => {
45
+ this.debug(`Launching Chrome to generate /json/protocol results`);
46
+ const browser = new CDPChromium({
47
+ blockAds: false,
48
+ config: this.config,
49
+ record: false,
50
+ userDataDir: null,
51
+ });
52
+ await browser.launch();
53
+ const wsEndpoint = browser.wsEndpoint();
54
+ if (!wsEndpoint) {
55
+ throw new Error('There was an error launching the browser');
56
+ }
57
+ const { port } = new URL(wsEndpoint);
58
+ const res = await fetch(`http://127.0.0.1:${port}/json/protocol`);
59
+ const protocolJSON = await res.json();
60
+ browser.close();
61
+ return protocolJSON;
62
+ };
63
+ getVersionJSON = async () => {
64
+ this.debug(`Launching Chrome to generate /json/version results`);
65
+ const browser = new CDPChromium({
66
+ blockAds: false,
67
+ config: this.config,
68
+ record: false,
69
+ userDataDir: null,
70
+ });
71
+ await browser.launch();
72
+ const wsEndpoint = browser.wsEndpoint();
73
+ if (!wsEndpoint) {
74
+ throw new Error('There was an error launching the browser');
75
+ }
76
+ const { port } = new URL(wsEndpoint);
77
+ const res = await fetch(`http://127.0.0.1:${port}/json/version`);
78
+ const meta = await res.json();
79
+ browser.close();
80
+ const { 'WebKit-Version': webkitVersion } = meta;
81
+ const debuggerVersion = webkitVersion.match(/\s\(@(\b[0-9a-f]{5,40}\b)/)[1];
82
+ return {
83
+ ...meta,
84
+ 'Debugger-Version': debuggerVersion,
85
+ webSocketDebuggerUrl: this.config.getExternalWebSocketAddress(),
86
+ };
87
+ };
44
88
  generateSessionJson = async (browser, session) => {
45
89
  const serverAddress = this.config.getExternalAddress();
46
90
  const sessions = [
@@ -31,7 +31,7 @@ export declare class PlaywrightChromium extends EventEmitter {
31
31
  newPage: () => Promise<Page>;
32
32
  launch: (options?: BrowserServerOptions) => Promise<playwright.BrowserServer>;
33
33
  wsEndpoint: () => string | null;
34
- publicWSEndpoint: (token: string) => string | null;
34
+ publicWSEndpoint: (token: string | null) => string | null;
35
35
  proxyPageWebSocket: () => Promise<void>;
36
36
  proxyWebSocket: (req: Request, socket: Duplex, head: Buffer) => Promise<void>;
37
37
  }
@@ -72,11 +72,10 @@ export class PlaywrightChromium extends EventEmitter {
72
72
  if (!this.browserWSEndpoint) {
73
73
  return null;
74
74
  }
75
+ const serverURL = new URL(this.config.getExternalWebSocketAddress());
75
76
  const wsURL = new URL(this.browserWSEndpoint);
76
- const serverURL = new URL(this.config.getExternalAddress());
77
77
  wsURL.hostname = serverURL.hostname;
78
78
  wsURL.port = serverURL.port;
79
- wsURL.protocol = serverURL.protocol === 'https' ? 'wss' : 'ws';
80
79
  if (token) {
81
80
  wsURL.searchParams.set('token', token);
82
81
  }
@@ -31,7 +31,7 @@ export declare class PlaywrightFirefox extends EventEmitter {
31
31
  newPage: () => Promise<Page>;
32
32
  launch: (options?: BrowserServerOptions) => Promise<playwright.BrowserServer>;
33
33
  wsEndpoint: () => string | null;
34
- publicWSEndpoint: (token: string) => string | null;
34
+ publicWSEndpoint: (token: string | null) => string | null;
35
35
  proxyPageWebSocket: () => Promise<void>;
36
36
  proxyWebSocket: (req: Request, socket: Duplex, head: Buffer) => Promise<void>;
37
37
  }
@@ -67,11 +67,10 @@ export class PlaywrightFirefox extends EventEmitter {
67
67
  if (!this.browserWSEndpoint) {
68
68
  return null;
69
69
  }
70
+ const serverURL = new URL(this.config.getExternalWebSocketAddress());
70
71
  const wsURL = new URL(this.browserWSEndpoint);
71
- const serverURL = new URL(this.config.getExternalAddress());
72
72
  wsURL.hostname = serverURL.hostname;
73
73
  wsURL.port = serverURL.port;
74
- wsURL.protocol = serverURL.protocol === 'https' ? 'wss' : 'ws';
75
74
  if (token) {
76
75
  wsURL.searchParams.set('token', token);
77
76
  }
@@ -31,7 +31,7 @@ export declare class PlaywrightWebkit extends EventEmitter {
31
31
  newPage: () => Promise<Page>;
32
32
  launch: (options?: BrowserServerOptions) => Promise<playwright.BrowserServer>;
33
33
  wsEndpoint: () => string | null;
34
- publicWSEndpoint: (token: string) => string | null;
34
+ publicWSEndpoint: (token: string | null) => string | null;
35
35
  proxyPageWebSocket: () => Promise<void>;
36
36
  proxyWebSocket: (req: Request, socket: Duplex, head: Buffer) => Promise<void>;
37
37
  }
@@ -67,11 +67,10 @@ export class PlaywrightWebkit extends EventEmitter {
67
67
  if (!this.browserWSEndpoint) {
68
68
  return null;
69
69
  }
70
+ const serverURL = new URL(this.config.getExternalWebSocketAddress());
70
71
  const wsURL = new URL(this.browserWSEndpoint);
71
- const serverURL = new URL(this.config.getExternalAddress());
72
72
  wsURL.hostname = serverURL.hostname;
73
73
  wsURL.port = serverURL.port;
74
- wsURL.protocol = serverURL.protocol === 'https' ? 'wss' : 'ws';
75
74
  if (token) {
76
75
  wsURL.searchParams.set('token', token);
77
76
  }
package/build/config.d.ts CHANGED
@@ -124,6 +124,15 @@ export declare class Config extends EventEmitter {
124
124
  * @returns {string} The URL to reach the server
125
125
  */
126
126
  getExternalAddress: () => string;
127
+ /**
128
+ * Returns the the fully-qualified WebSocket URL for the
129
+ * external address that browserless might be
130
+ * running behind *or* the server address if
131
+ * no external URL is provided.
132
+ *
133
+ * @returns {string} The URL to reach the server
134
+ */
135
+ getExternalWebSocketAddress: () => string;
127
136
  /**
128
137
  * When CORS is enabled, returns relevant CORS headers
129
138
  * to requests and for the OPTIONS call. Values can be
package/build/config.js CHANGED
@@ -335,6 +335,21 @@ export class Config extends EventEmitter {
335
335
  * @returns {string} The URL to reach the server
336
336
  */
337
337
  getExternalAddress = () => this.external ?? this.getServerAddress();
338
+ /**
339
+ * Returns the the fully-qualified WebSocket URL for the
340
+ * external address that browserless might be
341
+ * running behind *or* the server address if
342
+ * no external URL is provided.
343
+ *
344
+ * @returns {string} The URL to reach the server
345
+ */
346
+ getExternalWebSocketAddress = () => {
347
+ const httpAddress = new URL(this.external ?? this.getServerAddress());
348
+ httpAddress.protocol = httpAddress.protocol.startsWith('https')
349
+ ? 'wss:'
350
+ : 'ws:';
351
+ return httpAddress.href;
352
+ };
338
353
  /**
339
354
  * When CORS is enabled, returns relevant CORS headers
340
355
  * to requests and for the OPTIONS call. Values can be
@@ -2,3 +2,4 @@ export declare const encryptionAlgo = "aes-192-cbc";
2
2
  export declare const encryptionSep = ".";
3
3
  export declare const liveURLSep = ":";
4
4
  export declare const keyLength = 24;
5
+ export declare const BLESS_PAGE_IDENTIFIER = "BLESS";
@@ -2,3 +2,4 @@ export const encryptionAlgo = 'aes-192-cbc';
2
2
  export const encryptionSep = '.';
3
3
  export const liveURLSep = ':';
4
4
  export const keyLength = 24;
5
+ export const BLESS_PAGE_IDENTIFIER = 'BLESS';
@@ -1 +1 @@
1
- ["b-modal-banner--disabled","blocked","bodyBlocked","c24-cc-visible","cbar","cmp-open","consent-modal-open","consent-modal-overflow","CookiePolicy--show","cookies","cu_k_cookie_consent_modal_open","gcdc-locked","gdpr-infobar-visible","gdprbanner_consent_gdpr_consent","gdprCookieBanner-acceptedAll","hasCookieBanner","ibeugdpr-disabled","modal--is-open","modal-open","no_scroll","no-scroll","shopee-no-scroll","show-cookie-policy-info","sp-message-open","ta-cc-modal-open","touchevents-false","wt-cli-eu-country","wt-cli-geoip-on"]
1
+ ["b-modal-banner--disabled","blocked","bodyBlocked","c24-cc-visible","cbar","ccm-blocked","cmp-open","consent-modal-open","consent-modal-overflow","CookiePolicy--show","cookies","cu_k_cookie_consent_modal_open","gcdc-locked","gdpr-infobar-visible","gdprbanner_consent_gdpr_consent","gdprCookieBanner-acceptedAll","hasCookieBanner","ibeugdpr-disabled","idxrcookies-block-user-nav","modal--is-open","modal-open","no_scroll","no-scroll","noScroll","popin-gdpr-no-scroll","shopee-no-scroll","show-cookie-policy-info","sp-message-open","start-cookies","ta-cc-modal-open","touchevents-false","wt-cli-eu-country","wt-cli-geoip-on"]