Feature Request: Connect Options - Allow Authorization Header

[dylanlive]

Feature Request

I'd like to connect to a browserWSEndpoint that is protected by authentication. It would be nice to be able to provide an Authorization Bearer <token> on the connection, and every request thereafter to that endpoint.

I'm specifically wanting the Authorization Header, but this probably could just be generic to allowing any headers on all requests.

I vision within the connect options, provide a headers option
https://github.com/puppeteer/puppeteer/blob/v9.1.1/docs/api.md#puppeteerconnectoptions

Example:

browser = await puppeteer.connect({
      browserWSEndpoint: "ws://my.server",
      headers: {
        Authorization: "Bearer hunter2"
      },
});

I'd imagine the change would happen here:

puppeteer/src/common/BrowserWebSocketTransport.ts

Line 21 in 943477c

const ws = new WebSocket(url);

To be something similar to:
websockets/ws#473 (comment)

I did see page.setExtraHTTPHeaders(headers), but I don't think this what I'm looking for as it shouldn't just be for a specific page, but for all websocket requests to the server.
https://github.com/puppeteer/puppeteer/blob/v9.1.1/docs/api.md#pagesetextrahttpheadersheaders

[jayflo]

Been looking into this myself. It seems like it may only be relevant when used from Node.js.

In the browser, this uses the javascript websocket (https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/WebSocket)

puppeteer/src/common/BrowserWebSocketTransport.ts

Line 21 in 89a85b4

const ws = new WebSocket(url);

which doesn't allow you to set headers.

Within Node.js it uses the https://github.com/websockets/ws package

puppeteer/src/node/NodeWebSocketTransport.ts

Line 22 in 89a85b4

const ws = new NodeWebSocket(url, [], {

which should allow you to set headers (https://github.com/websockets/ws/blob/master/doc/ws.md#new-websocketaddress-protocols-options) via Node.js's http(s).request options.

[stale]

We're marking this issue as unconfirmed because it has not had recent activity and we weren't able to confirm it yet. It will be closed if no further activity occurs within the next 30 days.

[dylanlive]

Please leave open :)

[stale]

We're marking this issue as unconfirmed because it has not had recent activity and we weren't able to confirm it yet. It will be closed if no further activity occurs within the next 30 days.

[dylanlive]

still valid

[dylanlive]

@jayflo Good catch! Finally got around to experimenting with some local changes using patch-package and I can confirm the correct area to add the headers to is

puppeteer/packages/puppeteer-core/src/common/NodeWebSocketTransport.ts

Lines 30 to 32 in f42336c

	headers: {
	'User-Agent': `Puppeteer ${packageVersion}`,
	},

Would be great to be able to optionally configure additional headers from puppeteer.connect() to that function