f63a123ece
This PR updates the socket transport code to swap between a Node web socket transport or a web one based on the `isNode` environment. It also adds unit tests to the browser tests that show we can connect in a browser.
121 lines
3.6 KiB
TypeScript
121 lines
3.6 KiB
TypeScript
/**
|
|
* Copyright 2020 Google Inc. All rights reserved.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import { ConnectionTransport } from './ConnectionTransport.js';
|
|
import { Browser } from './Browser.js';
|
|
import { assert } from './assert.js';
|
|
import { debugError } from '../common/helper.js';
|
|
import { Connection } from './Connection.js';
|
|
import { getFetch } from './fetch.js';
|
|
import { Viewport } from './PuppeteerViewport.js';
|
|
import { isNode } from '../environment.js';
|
|
|
|
/**
|
|
* Generic browser options that can be passed when launching any browser.
|
|
* @public
|
|
*/
|
|
export interface BrowserOptions {
|
|
ignoreHTTPSErrors?: boolean;
|
|
defaultViewport?: Viewport;
|
|
slowMo?: number;
|
|
}
|
|
|
|
const getWebSocketTransportClass = async () => {
|
|
return isNode
|
|
? (await import('../node/NodeWebSocketTransport.js')).NodeWebSocketTransport
|
|
: (await import('./BrowserWebSocketTransport.js'))
|
|
.BrowserWebSocketTransport;
|
|
};
|
|
|
|
/**
|
|
* Users should never call this directly; it's called when calling
|
|
* `puppeteer.connect`.
|
|
* @internal
|
|
*/
|
|
export const connectToBrowser = async (
|
|
options: BrowserOptions & {
|
|
browserWSEndpoint?: string;
|
|
browserURL?: string;
|
|
transport?: ConnectionTransport;
|
|
}
|
|
): Promise<Browser> => {
|
|
const {
|
|
browserWSEndpoint,
|
|
browserURL,
|
|
ignoreHTTPSErrors = false,
|
|
defaultViewport = { width: 800, height: 600 },
|
|
transport,
|
|
slowMo = 0,
|
|
} = options;
|
|
|
|
assert(
|
|
Number(!!browserWSEndpoint) + Number(!!browserURL) + Number(!!transport) ===
|
|
1,
|
|
'Exactly one of browserWSEndpoint, browserURL or transport must be passed to puppeteer.connect'
|
|
);
|
|
|
|
let connection = null;
|
|
if (transport) {
|
|
connection = new Connection('', transport, slowMo);
|
|
} else if (browserWSEndpoint) {
|
|
const WebSocketClass = await getWebSocketTransportClass();
|
|
const connectionTransport: ConnectionTransport = await WebSocketClass.create(
|
|
browserWSEndpoint
|
|
);
|
|
connection = new Connection(browserWSEndpoint, connectionTransport, slowMo);
|
|
} else if (browserURL) {
|
|
const connectionURL = await getWSEndpoint(browserURL);
|
|
const WebSocketClass = await getWebSocketTransportClass();
|
|
const connectionTransport: ConnectionTransport = await WebSocketClass.create(
|
|
connectionURL
|
|
);
|
|
connection = new Connection(connectionURL, connectionTransport, slowMo);
|
|
}
|
|
|
|
const { browserContextIds } = await connection.send(
|
|
'Target.getBrowserContexts'
|
|
);
|
|
return Browser.create(
|
|
connection,
|
|
browserContextIds,
|
|
ignoreHTTPSErrors,
|
|
defaultViewport,
|
|
null,
|
|
() => connection.send('Browser.close').catch(debugError)
|
|
);
|
|
};
|
|
|
|
async function getWSEndpoint(browserURL: string): Promise<string> {
|
|
const endpointURL = new URL('/json/version', browserURL);
|
|
|
|
const fetch = await getFetch();
|
|
try {
|
|
const result = await fetch(endpointURL.toString(), {
|
|
method: 'GET',
|
|
});
|
|
if (!result.ok) {
|
|
throw new Error(`HTTP ${result.statusText}`);
|
|
}
|
|
const data = await result.json();
|
|
return data.webSocketDebuggerUrl;
|
|
} catch (error) {
|
|
error.message =
|
|
`Failed to fetch browser webSocket URL from ${endpointURL}: ` +
|
|
error.message;
|
|
throw error;
|
|
}
|
|
}
|