@rushstack/playwright-browser-tunnel 0.2.4 → 0.3.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.
- package/CHANGELOG.json +38 -0
- package/CHANGELOG.md +15 -1
- package/LICENSE +24 -0
- package/{lib → lib-dts}/tsdoc-metadata.json +1 -1
- package/lib-esm/HttpServer.js +70 -0
- package/lib-esm/HttpServer.js.map +1 -0
- package/lib-esm/LaunchOptionsValidator.js +156 -0
- package/lib-esm/LaunchOptionsValidator.js.map +1 -0
- package/lib-esm/PlaywrightBrowserTunnel.js +467 -0
- package/lib-esm/PlaywrightBrowserTunnel.js.map +1 -0
- package/{src/index.ts → lib-esm/index.js} +2 -18
- package/lib-esm/index.js.map +1 -0
- package/{src/tunneledBrowserConnection/constants.ts → lib-esm/tunneledBrowserConnection/ITunneledBrowser.js} +2 -3
- package/lib-esm/tunneledBrowserConnection/ITunneledBrowser.js.map +1 -0
- package/lib-esm/tunneledBrowserConnection/ITunneledBrowserConnection.js +4 -0
- package/lib-esm/tunneledBrowserConnection/ITunneledBrowserConnection.js.map +1 -0
- package/lib-esm/tunneledBrowserConnection/TunneledBrowser.js +36 -0
- package/lib-esm/tunneledBrowserConnection/TunneledBrowser.js.map +1 -0
- package/lib-esm/tunneledBrowserConnection/TunneledBrowserConnection.js +195 -0
- package/lib-esm/tunneledBrowserConnection/TunneledBrowserConnection.js.map +1 -0
- package/lib-esm/tunneledBrowserConnection/constants.js +5 -0
- package/lib-esm/tunneledBrowserConnection/constants.js.map +1 -0
- package/{src/tunneledBrowserConnection/index.ts → lib-esm/tunneledBrowserConnection/index.js} +1 -4
- package/lib-esm/tunneledBrowserConnection/index.js.map +1 -0
- package/lib-esm/utilities.js +96 -0
- package/lib-esm/utilities.js.map +1 -0
- package/package.json +30 -7
- package/.rush/temp/chunked-rush-logs/playwright-browser-tunnel._phase_build.chunks.jsonl +0 -8
- package/.rush/temp/operation/_phase_build/all.log +0 -8
- package/.rush/temp/operation/_phase_build/log-chunks.jsonl +0 -8
- package/.rush/temp/operation/_phase_build/state.json +0 -3
- package/.rush/temp/rushstack+playwright-browser-tunnel-_phase_build-517a2999ebe527b217bbfe2e265943b73bf3856b.tar.log +0 -62
- package/.rush/temp/shrinkwrap-deps.json +0 -104
- package/config/api-extractor.json +0 -19
- package/config/rig.json +0 -7
- package/eslint.config.js +0 -18
- package/playwright.config.ts +0 -45
- package/rush-logs/playwright-browser-tunnel._phase_build.cache.log +0 -3
- package/rush-logs/playwright-browser-tunnel._phase_build.log +0 -8
- package/src/HttpServer.ts +0 -87
- package/src/LaunchOptionsValidator.ts +0 -234
- package/src/PlaywrightBrowserTunnel.ts +0 -650
- package/src/tunneledBrowserConnection/ITunneledBrowser.ts +0 -20
- package/src/tunneledBrowserConnection/ITunneledBrowserConnection.ts +0 -37
- package/src/tunneledBrowserConnection/TunneledBrowser.ts +0 -52
- package/src/tunneledBrowserConnection/TunneledBrowserConnection.ts +0 -232
- package/src/utilities.ts +0 -136
- package/temp/build/lint/_eslint-5eVG3S6w.json +0 -50
- package/temp/build/lint/lint.sarif +0 -258
- package/temp/build/typescript/ts_l9Fw4VUO.json +0 -1
- package/temp/playwright-browser-tunnel.api.md +0 -120
- package/tests/demo.spec.ts +0 -10
- package/tests/testFixture.ts +0 -22
- package/tsconfig.json +0 -6
- /package/{lib → lib-commonjs}/HttpServer.js +0 -0
- /package/{lib → lib-commonjs}/HttpServer.js.map +0 -0
- /package/{lib → lib-commonjs}/LaunchOptionsValidator.js +0 -0
- /package/{lib → lib-commonjs}/LaunchOptionsValidator.js.map +0 -0
- /package/{lib → lib-commonjs}/PlaywrightBrowserTunnel.js +0 -0
- /package/{lib → lib-commonjs}/PlaywrightBrowserTunnel.js.map +0 -0
- /package/{lib → lib-commonjs}/index.js +0 -0
- /package/{lib → lib-commonjs}/index.js.map +0 -0
- /package/{lib → lib-commonjs}/tunneledBrowserConnection/ITunneledBrowser.js +0 -0
- /package/{lib → lib-commonjs}/tunneledBrowserConnection/ITunneledBrowser.js.map +0 -0
- /package/{lib → lib-commonjs}/tunneledBrowserConnection/ITunneledBrowserConnection.js +0 -0
- /package/{lib → lib-commonjs}/tunneledBrowserConnection/ITunneledBrowserConnection.js.map +0 -0
- /package/{lib → lib-commonjs}/tunneledBrowserConnection/TunneledBrowser.js +0 -0
- /package/{lib → lib-commonjs}/tunneledBrowserConnection/TunneledBrowser.js.map +0 -0
- /package/{lib → lib-commonjs}/tunneledBrowserConnection/TunneledBrowserConnection.js +0 -0
- /package/{lib → lib-commonjs}/tunneledBrowserConnection/TunneledBrowserConnection.js.map +0 -0
- /package/{lib → lib-commonjs}/tunneledBrowserConnection/constants.js +0 -0
- /package/{lib → lib-commonjs}/tunneledBrowserConnection/constants.js.map +0 -0
- /package/{lib → lib-commonjs}/tunneledBrowserConnection/index.js +0 -0
- /package/{lib → lib-commonjs}/tunneledBrowserConnection/index.js.map +0 -0
- /package/{lib → lib-commonjs}/utilities.js +0 -0
- /package/{lib → lib-commonjs}/utilities.js.map +0 -0
- /package/{lib → lib-dts}/HttpServer.d.ts +0 -0
- /package/{lib → lib-dts}/HttpServer.d.ts.map +0 -0
- /package/{lib → lib-dts}/LaunchOptionsValidator.d.ts +0 -0
- /package/{lib → lib-dts}/LaunchOptionsValidator.d.ts.map +0 -0
- /package/{lib → lib-dts}/PlaywrightBrowserTunnel.d.ts +0 -0
- /package/{lib → lib-dts}/PlaywrightBrowserTunnel.d.ts.map +0 -0
- /package/{lib → lib-dts}/index.d.ts +0 -0
- /package/{lib → lib-dts}/index.d.ts.map +0 -0
- /package/{lib → lib-dts}/tunneledBrowserConnection/ITunneledBrowser.d.ts +0 -0
- /package/{lib → lib-dts}/tunneledBrowserConnection/ITunneledBrowser.d.ts.map +0 -0
- /package/{lib → lib-dts}/tunneledBrowserConnection/ITunneledBrowserConnection.d.ts +0 -0
- /package/{lib → lib-dts}/tunneledBrowserConnection/ITunneledBrowserConnection.d.ts.map +0 -0
- /package/{lib → lib-dts}/tunneledBrowserConnection/TunneledBrowser.d.ts +0 -0
- /package/{lib → lib-dts}/tunneledBrowserConnection/TunneledBrowser.d.ts.map +0 -0
- /package/{lib → lib-dts}/tunneledBrowserConnection/TunneledBrowserConnection.d.ts +0 -0
- /package/{lib → lib-dts}/tunneledBrowserConnection/TunneledBrowserConnection.d.ts.map +0 -0
- /package/{lib → lib-dts}/tunneledBrowserConnection/constants.d.ts +0 -0
- /package/{lib → lib-dts}/tunneledBrowserConnection/constants.d.ts.map +0 -0
- /package/{lib → lib-dts}/tunneledBrowserConnection/index.d.ts +0 -0
- /package/{lib → lib-dts}/tunneledBrowserConnection/index.d.ts.map +0 -0
- /package/{lib → lib-dts}/utilities.d.ts +0 -0
- /package/{lib → lib-dts}/utilities.d.ts.map +0 -0
|
@@ -0,0 +1,467 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
2
|
+
// See LICENSE in the project root for license information.
|
|
3
|
+
import { once } from 'node:events';
|
|
4
|
+
import { WebSocket } from 'ws';
|
|
5
|
+
import semver from 'semver';
|
|
6
|
+
import { TerminalProviderSeverity, TerminalStreamWritable } from '@rushstack/terminal';
|
|
7
|
+
import { Executable, FileSystem, Async } from '@rushstack/node-core-library';
|
|
8
|
+
import { getNormalizedErrorString, getWebSocketCloseReason, getWebSocketReadyStateString, WebSocketCloseCode } from './utilities';
|
|
9
|
+
import { LaunchOptionsValidator } from './LaunchOptionsValidator';
|
|
10
|
+
const validBrowserNames = new Set(['chromium', 'firefox', 'webkit']);
|
|
11
|
+
function isValidBrowserName(browserName) {
|
|
12
|
+
return validBrowserNames.has(browserName);
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Hosts a Playwright browser server and forwards traffic over a WebSocket tunnel.
|
|
16
|
+
* @beta
|
|
17
|
+
*/
|
|
18
|
+
export class PlaywrightTunnel {
|
|
19
|
+
constructor(options) {
|
|
20
|
+
this._playwrightBrowsersInstalled = new Set();
|
|
21
|
+
this._status = 'stopped';
|
|
22
|
+
this._keepRunning = false;
|
|
23
|
+
const { mode, terminal, onStatusChange, playwrightInstallPath, onBeforeLaunch } = options;
|
|
24
|
+
switch (mode) {
|
|
25
|
+
case 'poll-connection':
|
|
26
|
+
if (!options.wsEndpoint) {
|
|
27
|
+
throw new Error('wsEndpoint is required for poll-connection mode');
|
|
28
|
+
}
|
|
29
|
+
this._wsEndpoint = options.wsEndpoint;
|
|
30
|
+
this._listenPort = undefined;
|
|
31
|
+
break;
|
|
32
|
+
case 'wait-for-incoming-connection':
|
|
33
|
+
if (options.listenPort === undefined) {
|
|
34
|
+
throw new Error('listenPort is required for wait-for-incoming-connection mode');
|
|
35
|
+
}
|
|
36
|
+
this._wsEndpoint = undefined;
|
|
37
|
+
this._listenPort = options.listenPort;
|
|
38
|
+
break;
|
|
39
|
+
default:
|
|
40
|
+
throw new Error(`Invalid mode: ${mode}`);
|
|
41
|
+
}
|
|
42
|
+
this._mode = mode;
|
|
43
|
+
this._terminal = terminal;
|
|
44
|
+
this._onStatusChange = onStatusChange;
|
|
45
|
+
this._onBeforeLaunch = onBeforeLaunch;
|
|
46
|
+
this._playwrightInstallPath = playwrightInstallPath;
|
|
47
|
+
}
|
|
48
|
+
get status() {
|
|
49
|
+
return this._status;
|
|
50
|
+
}
|
|
51
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
52
|
+
set status(newStatus) {
|
|
53
|
+
this._status = newStatus;
|
|
54
|
+
this._onStatusChange(newStatus);
|
|
55
|
+
}
|
|
56
|
+
async waitForCloseAsync() {
|
|
57
|
+
const terminal = this._terminal;
|
|
58
|
+
const initWsPromise = this._initWsPromise;
|
|
59
|
+
if (initWsPromise) {
|
|
60
|
+
const ws = await initWsPromise;
|
|
61
|
+
await once(ws, 'close');
|
|
62
|
+
terminal.writeDebugLine('WebSocket connection closed. resolving init promise.');
|
|
63
|
+
this._initWsPromise = undefined;
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
async startAsync(options = {}) {
|
|
67
|
+
var _a;
|
|
68
|
+
this._keepRunning = (_a = options.keepRunning) !== null && _a !== void 0 ? _a : true;
|
|
69
|
+
const terminal = this._terminal;
|
|
70
|
+
terminal.writeLine(`keepRunning: ${this._keepRunning}`);
|
|
71
|
+
while (this._keepRunning) {
|
|
72
|
+
if (!this._initWsPromise) {
|
|
73
|
+
this._initWsPromise = this._initPlaywrightBrowserTunnelAsync();
|
|
74
|
+
}
|
|
75
|
+
else {
|
|
76
|
+
terminal.writeLine(`Tunnel is already running with status: ${this.status}`);
|
|
77
|
+
}
|
|
78
|
+
await this.waitForCloseAsync();
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
async stopAsync() {
|
|
82
|
+
var _a;
|
|
83
|
+
this._keepRunning = false;
|
|
84
|
+
if (this._pollInterval) {
|
|
85
|
+
clearInterval(this._pollInterval);
|
|
86
|
+
this._pollInterval = undefined;
|
|
87
|
+
}
|
|
88
|
+
await ((_a = this._initWsPromise) === null || _a === void 0 ? void 0 : _a.finally(() => {
|
|
89
|
+
var _a;
|
|
90
|
+
(_a = this._ws) === null || _a === void 0 ? void 0 : _a.close(WebSocketCloseCode.NORMAL_CLOSURE, 'Tunnel stopped');
|
|
91
|
+
}));
|
|
92
|
+
}
|
|
93
|
+
async [Symbol.asyncDispose]() {
|
|
94
|
+
this._terminal.writeLine('Disposing WebSocket connection.');
|
|
95
|
+
await this.stopAsync();
|
|
96
|
+
}
|
|
97
|
+
async cleanTempFilesAsync() {
|
|
98
|
+
const tmpPath = this._playwrightInstallPath;
|
|
99
|
+
this._terminal.writeLine(`Cleaning up temporary files in ${tmpPath}`);
|
|
100
|
+
try {
|
|
101
|
+
await FileSystem.ensureEmptyFolderAsync(tmpPath);
|
|
102
|
+
this._terminal.writeLine(`Temporary files cleaned up.`);
|
|
103
|
+
}
|
|
104
|
+
catch (error) {
|
|
105
|
+
this._terminal.writeLine(`Failed to clean up temporary files: ${getNormalizedErrorString(error)}`);
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
// TODO: We should implement an uninstall command to remove installed Playwright browsers
|
|
109
|
+
// public async uninstallPlaywrightBrowsersAsync(): Promise<void> {}
|
|
110
|
+
async _runCommandAsync(command, args) {
|
|
111
|
+
var _a, _b;
|
|
112
|
+
const tmpPath = this._playwrightInstallPath;
|
|
113
|
+
await FileSystem.ensureFolderAsync(tmpPath);
|
|
114
|
+
this._terminal.writeLine(`Running command: ${command} ${args.join(' ')} in ${tmpPath}`);
|
|
115
|
+
const cp = Executable.spawn(command, args, {
|
|
116
|
+
stdio: [
|
|
117
|
+
'ignore', // stdin
|
|
118
|
+
'pipe', // stdout
|
|
119
|
+
'pipe' // stderr
|
|
120
|
+
],
|
|
121
|
+
currentWorkingDirectory: tmpPath
|
|
122
|
+
});
|
|
123
|
+
(_a = cp.stdout) === null || _a === void 0 ? void 0 : _a.pipe(new TerminalStreamWritable({
|
|
124
|
+
terminal: this._terminal,
|
|
125
|
+
severity: TerminalProviderSeverity.log
|
|
126
|
+
}));
|
|
127
|
+
(_b = cp.stderr) === null || _b === void 0 ? void 0 : _b.pipe(new TerminalStreamWritable({
|
|
128
|
+
terminal: this._terminal,
|
|
129
|
+
severity: TerminalProviderSeverity.error
|
|
130
|
+
}));
|
|
131
|
+
await Executable.waitForExitAsync(cp, { throwOnNonZeroExitCode: true, throwOnSignal: true });
|
|
132
|
+
}
|
|
133
|
+
async _installPlaywrightCoreAsync({ playwrightVersion }) {
|
|
134
|
+
this._terminal.writeLine(`Installing playwright-core version ${playwrightVersion}`);
|
|
135
|
+
await this._runCommandAsync('npm', [
|
|
136
|
+
'install',
|
|
137
|
+
`playwright-core-${playwrightVersion}@npm:playwright-core@${playwrightVersion}`
|
|
138
|
+
]);
|
|
139
|
+
}
|
|
140
|
+
async _installPlaywrightBrowsersAsync({ playwrightVersion, browserName }) {
|
|
141
|
+
await this._installPlaywrightCoreAsync({ playwrightVersion });
|
|
142
|
+
this._terminal.writeLine(`Executing playwright-core version ${playwrightVersion}`);
|
|
143
|
+
await this._runCommandAsync('node', [
|
|
144
|
+
`node_modules/playwright-core-${playwrightVersion}/cli.js`,
|
|
145
|
+
'install',
|
|
146
|
+
browserName
|
|
147
|
+
]);
|
|
148
|
+
}
|
|
149
|
+
async _tryConnectAsync() {
|
|
150
|
+
const wsEndpoint = this._wsEndpoint;
|
|
151
|
+
if (!wsEndpoint) {
|
|
152
|
+
throw new Error('WebSocket endpoint is not defined');
|
|
153
|
+
}
|
|
154
|
+
return await new Promise((resolve, reject) => {
|
|
155
|
+
const ws = new WebSocket(wsEndpoint);
|
|
156
|
+
ws.on('open', () => {
|
|
157
|
+
this._terminal.writeLine(`WebSocket connection opened`);
|
|
158
|
+
resolve(ws);
|
|
159
|
+
});
|
|
160
|
+
ws.once('error', (error) => {
|
|
161
|
+
reject(error);
|
|
162
|
+
});
|
|
163
|
+
});
|
|
164
|
+
}
|
|
165
|
+
// TODO: Only supporting one test at a time.
|
|
166
|
+
// Need to support multiple simultaneous connections for parallel tests.
|
|
167
|
+
async _pollConnectionAsync() {
|
|
168
|
+
this._terminal.writeLine(`Waiting for WebSocket connection`);
|
|
169
|
+
return await new Promise((resolve, reject) => {
|
|
170
|
+
this._pollInterval = setInterval(() => {
|
|
171
|
+
if (this._pendingConnectionAttempt) {
|
|
172
|
+
return; // Skip if a connection attempt is already in progress
|
|
173
|
+
}
|
|
174
|
+
const connectionPromise = this._tryConnectAsync();
|
|
175
|
+
this._pendingConnectionAttempt = connectionPromise;
|
|
176
|
+
connectionPromise
|
|
177
|
+
.then((ws) => {
|
|
178
|
+
clearInterval(this._pollInterval);
|
|
179
|
+
this._pollInterval = undefined;
|
|
180
|
+
ws.removeAllListeners();
|
|
181
|
+
this._pendingConnectionAttempt = undefined;
|
|
182
|
+
resolve(ws);
|
|
183
|
+
})
|
|
184
|
+
.catch(() => {
|
|
185
|
+
// no-op - will retry on next interval
|
|
186
|
+
this._pendingConnectionAttempt = undefined;
|
|
187
|
+
});
|
|
188
|
+
}, 500);
|
|
189
|
+
});
|
|
190
|
+
}
|
|
191
|
+
async _waitForIncomingConnectionAsync() {
|
|
192
|
+
this._terminal.writeLine('Waiting for incoming WebSocket connection');
|
|
193
|
+
return await new Promise((resolve, reject) => {
|
|
194
|
+
const server = new WebSocket.Server({ port: this._listenPort });
|
|
195
|
+
const cleanup = () => {
|
|
196
|
+
server.removeAllListeners();
|
|
197
|
+
};
|
|
198
|
+
server.once('connection', (ws) => {
|
|
199
|
+
this._terminal.writeLine('Incoming WebSocket connection established');
|
|
200
|
+
// Stop listening immediately so the port is released
|
|
201
|
+
cleanup();
|
|
202
|
+
server.close((closeError) => {
|
|
203
|
+
if (closeError) {
|
|
204
|
+
this._terminal.writeLine(`Failed to close WebSocket server: ${closeError instanceof Error ? closeError.message : closeError}`);
|
|
205
|
+
}
|
|
206
|
+
resolve(ws);
|
|
207
|
+
});
|
|
208
|
+
});
|
|
209
|
+
server.once('error', (error) => {
|
|
210
|
+
this._terminal.writeLine(`WebSocket server error: ${getNormalizedErrorString(error)}`);
|
|
211
|
+
cleanup();
|
|
212
|
+
// Try to close (best-effort), then reject
|
|
213
|
+
server.close(() => reject(error));
|
|
214
|
+
});
|
|
215
|
+
});
|
|
216
|
+
}
|
|
217
|
+
// TODO: If a user runs this for the first time, `this._playwrightBrowsersInstalled` will be empty
|
|
218
|
+
// and it will try to install the browsers every time. We should persist this information. Maybe a cache file with text per
|
|
219
|
+
// machine instance?
|
|
220
|
+
async _setupPlaywrightAsync({ playwrightVersion, browserName }) {
|
|
221
|
+
const browserKey = `${playwrightVersion}-${browserName}`;
|
|
222
|
+
this._terminal.writeLine(`Checking for installed playwright browsers. Installed browsers: ${browserKey}`);
|
|
223
|
+
if (!this._playwrightBrowsersInstalled.has(browserKey)) {
|
|
224
|
+
this._terminal.writeLine(`Playwright browser not found. Installing playwright-core version ${playwrightVersion}`);
|
|
225
|
+
await this._installPlaywrightBrowsersAsync({ playwrightVersion, browserName });
|
|
226
|
+
this._playwrightBrowsersInstalled.add(browserKey);
|
|
227
|
+
}
|
|
228
|
+
this._terminal.writeLine(`Using playwright-core version ${playwrightVersion} for browser server`);
|
|
229
|
+
return await import(`${this._playwrightInstallPath}/node_modules/playwright-core-${playwrightVersion}`);
|
|
230
|
+
}
|
|
231
|
+
async _getPlaywrightBrowserServerProxyAsync({ browserName, playwrightVersion, launchOptions }) {
|
|
232
|
+
const terminal = this._terminal;
|
|
233
|
+
// Validate launch options against security allowlist
|
|
234
|
+
terminal.writeLine('Validating launch options against security allowlist...');
|
|
235
|
+
const validationResult = await LaunchOptionsValidator.validateLaunchOptionsAsync(launchOptions, terminal);
|
|
236
|
+
if (!validationResult.isValid) {
|
|
237
|
+
terminal.writeWarningLine(`Some launch options were denied: ${validationResult.deniedOptions.join(', ')}`);
|
|
238
|
+
terminal.writeWarningLine(`Using filtered launch options. Denied options have been removed.`);
|
|
239
|
+
}
|
|
240
|
+
// Use filtered options and ensure headless: false for headed tests in codespaces
|
|
241
|
+
// This is critical for the extension's purpose - enabling headed Playwright tests remotely
|
|
242
|
+
const safeOptions = {
|
|
243
|
+
...validationResult.filteredOptions,
|
|
244
|
+
headless: false
|
|
245
|
+
};
|
|
246
|
+
// Log the validated options, excluding 'headless' since it's always false for this extension
|
|
247
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
248
|
+
const { headless, ...logOptions } = safeOptions;
|
|
249
|
+
terminal.writeLine(`Launch options after validation: ${JSON.stringify(logOptions)} (headless: false enforced)`);
|
|
250
|
+
const playwright = await this._setupPlaywrightAsync({
|
|
251
|
+
playwrightVersion,
|
|
252
|
+
browserName
|
|
253
|
+
});
|
|
254
|
+
const { chromium, firefox, webkit } = playwright;
|
|
255
|
+
const browsers = { chromium, firefox, webkit };
|
|
256
|
+
const browserServer = await browsers[browserName].launchServer(safeOptions);
|
|
257
|
+
if (!browserServer) {
|
|
258
|
+
throw new Error(`Failed to launch browser server for ${browserName} with options: ${JSON.stringify(safeOptions)}`);
|
|
259
|
+
}
|
|
260
|
+
terminal.writeLine(`Launched ${browserName} browser server`);
|
|
261
|
+
const client = new WebSocket(browserServer.wsEndpoint());
|
|
262
|
+
return {
|
|
263
|
+
browserServer,
|
|
264
|
+
client
|
|
265
|
+
};
|
|
266
|
+
}
|
|
267
|
+
_validateHandshake(rawHandshake) {
|
|
268
|
+
if (typeof rawHandshake !== 'object' ||
|
|
269
|
+
rawHandshake === null ||
|
|
270
|
+
'action' in rawHandshake === false ||
|
|
271
|
+
'browserName' in rawHandshake === false ||
|
|
272
|
+
'playwrightVersion' in rawHandshake === false ||
|
|
273
|
+
'launchOptions' in rawHandshake === false ||
|
|
274
|
+
typeof rawHandshake.action !== 'string' ||
|
|
275
|
+
typeof rawHandshake.browserName !== 'string' ||
|
|
276
|
+
typeof rawHandshake.playwrightVersion !== 'string' ||
|
|
277
|
+
typeof rawHandshake.launchOptions !== 'object') {
|
|
278
|
+
throw new Error(`Invalid handshake: ${JSON.stringify(rawHandshake)}. Must be an object.`);
|
|
279
|
+
}
|
|
280
|
+
const { action, browserName, playwrightVersion, launchOptions } = rawHandshake;
|
|
281
|
+
if (action !== 'handshake') {
|
|
282
|
+
throw new Error(`Invalid action: ${action}. Expected 'handshake'.`);
|
|
283
|
+
}
|
|
284
|
+
const playwrightVersionSemver = semver.coerce(playwrightVersion);
|
|
285
|
+
if (!playwrightVersionSemver) {
|
|
286
|
+
throw new Error(`Invalid Playwright version: ${playwrightVersion}. Must be a valid semver version.`);
|
|
287
|
+
}
|
|
288
|
+
if (!isValidBrowserName(browserName)) {
|
|
289
|
+
throw new Error(`Invalid browser name: ${browserName}. Must be one of ${Array.from(validBrowserNames).join(', ')}.`);
|
|
290
|
+
}
|
|
291
|
+
return {
|
|
292
|
+
action,
|
|
293
|
+
launchOptions: launchOptions,
|
|
294
|
+
playwrightVersion: playwrightVersionSemver,
|
|
295
|
+
browserName
|
|
296
|
+
};
|
|
297
|
+
}
|
|
298
|
+
// ws1 is the tunnel websocket, ws2 is the browser server websocket
|
|
299
|
+
async _setupForwardingAsync(ws1, ws2) {
|
|
300
|
+
this._terminal.writeLine('Setting up message forwarding between ws1 and ws2');
|
|
301
|
+
this._terminal.writeLine(` ws1 (tunnel) readyState: ${getWebSocketReadyStateString(ws1.readyState)}`);
|
|
302
|
+
this._terminal.writeLine(` ws2 (browser) readyState: ${getWebSocketReadyStateString(ws2.readyState)}`);
|
|
303
|
+
const messageCount = { ws1ToWs2: 0, ws2ToWs1: 0 };
|
|
304
|
+
ws1.on('message', (data) => {
|
|
305
|
+
messageCount.ws1ToWs2++;
|
|
306
|
+
if (ws2.readyState === WebSocket.OPEN) {
|
|
307
|
+
ws2.send(data);
|
|
308
|
+
}
|
|
309
|
+
else {
|
|
310
|
+
this._terminal.writeLine(`ws2 not open (state: ${getWebSocketReadyStateString(ws2.readyState)}). Dropping message #${messageCount.ws1ToWs2}`);
|
|
311
|
+
}
|
|
312
|
+
});
|
|
313
|
+
ws2.on('message', (data) => {
|
|
314
|
+
messageCount.ws2ToWs1++;
|
|
315
|
+
if (ws1.readyState === WebSocket.OPEN) {
|
|
316
|
+
ws1.send(data);
|
|
317
|
+
}
|
|
318
|
+
else {
|
|
319
|
+
this._terminal.writeLine(`ws1 not open (state: ${getWebSocketReadyStateString(ws1.readyState)}). Dropping message #${messageCount.ws2ToWs1}`);
|
|
320
|
+
}
|
|
321
|
+
});
|
|
322
|
+
ws1.once('close', (code, reason) => {
|
|
323
|
+
const reasonStr = reason.toString() || 'no reason provided';
|
|
324
|
+
const codeDescription = getWebSocketCloseReason(code);
|
|
325
|
+
this._terminal.writeLine(`ws1 (tunnel) closed - code: ${code} (${codeDescription}), reason: ${reasonStr}`);
|
|
326
|
+
this._terminal.writeLine(` Messages forwarded: ws1->ws2: ${messageCount.ws1ToWs2}, ws2->ws1: ${messageCount.ws2ToWs1}`);
|
|
327
|
+
if (ws2.readyState === WebSocket.OPEN) {
|
|
328
|
+
this._terminal.writeLine(' Closing ws2 (browser) in response');
|
|
329
|
+
ws2.close(WebSocketCloseCode.NORMAL_CLOSURE, 'Tunnel closed');
|
|
330
|
+
}
|
|
331
|
+
});
|
|
332
|
+
ws2.once('close', (code, reason) => {
|
|
333
|
+
const reasonStr = reason.toString() || 'no reason provided';
|
|
334
|
+
const codeDescription = getWebSocketCloseReason(code);
|
|
335
|
+
this._terminal.writeLine(`ws2 (browser) closed - code: ${code} (${codeDescription}), reason: ${reasonStr}`);
|
|
336
|
+
this._terminal.writeLine(` Messages forwarded: ws1->ws2: ${messageCount.ws1ToWs2}, ws2->ws1: ${messageCount.ws2ToWs1}`);
|
|
337
|
+
if (ws1.readyState === WebSocket.OPEN) {
|
|
338
|
+
this._terminal.writeLine(' Closing ws1 (tunnel) in response');
|
|
339
|
+
ws1.close(WebSocketCloseCode.NORMAL_CLOSURE, 'Browser closed');
|
|
340
|
+
}
|
|
341
|
+
});
|
|
342
|
+
ws1.once('error', (error) => {
|
|
343
|
+
this._terminal.writeErrorLine(`ws1 (tunnel) WebSocket error: ${getNormalizedErrorString(error)}`);
|
|
344
|
+
this._terminal.writeErrorLine(` ws1 readyState: ${getWebSocketReadyStateString(ws1.readyState)}`);
|
|
345
|
+
});
|
|
346
|
+
ws2.once('error', (error) => {
|
|
347
|
+
this._terminal.writeErrorLine(`ws2 (browser) WebSocket error: ${getNormalizedErrorString(error)}`);
|
|
348
|
+
this._terminal.writeErrorLine(` ws2 readyState: ${getWebSocketReadyStateString(ws2.readyState)}`);
|
|
349
|
+
});
|
|
350
|
+
}
|
|
351
|
+
/**
|
|
352
|
+
* Initializes the Playwright browser tunnel by establishing a WebSocket connection
|
|
353
|
+
* and setting up the browser server.
|
|
354
|
+
* Returns when the handshake is complete and the browser server is running.
|
|
355
|
+
*/
|
|
356
|
+
async _initPlaywrightBrowserTunnelAsync() {
|
|
357
|
+
let handshake = undefined;
|
|
358
|
+
let client = undefined;
|
|
359
|
+
let browserServer = undefined;
|
|
360
|
+
this.status = 'waiting-for-connection';
|
|
361
|
+
const ws = this._mode === 'poll-connection'
|
|
362
|
+
? await this._pollConnectionAsync()
|
|
363
|
+
: await this._waitForIncomingConnectionAsync();
|
|
364
|
+
ws.on('open', () => {
|
|
365
|
+
this._terminal.writeLine(`WebSocket connection established`);
|
|
366
|
+
handshake = undefined;
|
|
367
|
+
});
|
|
368
|
+
ws.on('error', (error) => {
|
|
369
|
+
this._terminal.writeLine(`WebSocket error occurred: ${getNormalizedErrorString(error)}`);
|
|
370
|
+
});
|
|
371
|
+
ws.on('close', async (code, reason) => {
|
|
372
|
+
const reasonStr = reason.toString() || 'no reason provided';
|
|
373
|
+
const codeDescription = getWebSocketCloseReason(code);
|
|
374
|
+
this._initWsPromise = undefined;
|
|
375
|
+
this.status = 'stopped';
|
|
376
|
+
this._terminal.writeLine(`WebSocket connection closed - code: ${code} (${codeDescription}), reason: ${reasonStr}`);
|
|
377
|
+
this._terminal.writeLine(` handshake received: ${handshake !== undefined}`);
|
|
378
|
+
this._terminal.writeLine(` browserServer active: ${browserServer !== undefined}`);
|
|
379
|
+
if (browserServer) {
|
|
380
|
+
this._terminal.writeLine(' Closing browser server...');
|
|
381
|
+
await browserServer.close();
|
|
382
|
+
this._terminal.writeLine(' Browser server closed');
|
|
383
|
+
}
|
|
384
|
+
});
|
|
385
|
+
return await new Promise((resolve, reject) => {
|
|
386
|
+
const onMessageHandler = async (data) => {
|
|
387
|
+
const terminal = this._terminal;
|
|
388
|
+
if (!handshake) {
|
|
389
|
+
try {
|
|
390
|
+
const rawHandshakeString = data.toString();
|
|
391
|
+
const rawHandshake = JSON.parse(rawHandshakeString);
|
|
392
|
+
terminal.writeLine(`Received handshake: ${rawHandshakeString}`);
|
|
393
|
+
handshake = this._validateHandshake(rawHandshake);
|
|
394
|
+
// Call the onBeforeLaunch callback if provided
|
|
395
|
+
if (this._onBeforeLaunch) {
|
|
396
|
+
terminal.writeLine('Requesting user approval before launching browser server...');
|
|
397
|
+
const shouldProceed = await this._onBeforeLaunch(handshake);
|
|
398
|
+
if (!shouldProceed) {
|
|
399
|
+
terminal.writeLine('Browser server launch cancelled by user.');
|
|
400
|
+
ws.off('message', onMessageHandler);
|
|
401
|
+
ws.close(WebSocketCloseCode.NORMAL_CLOSURE, 'Launch cancelled by user');
|
|
402
|
+
reject(new Error('Browser server launch cancelled by user'));
|
|
403
|
+
return;
|
|
404
|
+
}
|
|
405
|
+
terminal.writeLine('User approved browser server launch.');
|
|
406
|
+
}
|
|
407
|
+
this.status = 'setting-up-browser-server';
|
|
408
|
+
const browserServerProxy = await this._getPlaywrightBrowserServerProxyAsync(handshake);
|
|
409
|
+
client = browserServerProxy.client;
|
|
410
|
+
browserServer = browserServerProxy.browserServer;
|
|
411
|
+
// Monitor browser server process for crashes
|
|
412
|
+
const browserProcess = browserServer.process();
|
|
413
|
+
if (browserProcess) {
|
|
414
|
+
browserProcess.on('exit', (code, signal) => {
|
|
415
|
+
terminal.writeErrorLine(`Browser server process exited - code: ${code}, signal: ${signal}`);
|
|
416
|
+
});
|
|
417
|
+
browserProcess.on('error', (err) => {
|
|
418
|
+
terminal.writeErrorLine(`Browser server process error: ${getNormalizedErrorString(err)}`);
|
|
419
|
+
});
|
|
420
|
+
terminal.writeDebugLine(`Browser server process started with PID: ${browserProcess.pid}`);
|
|
421
|
+
}
|
|
422
|
+
else {
|
|
423
|
+
terminal.writeDebugLine('Warning: Browser server process handle not available for monitoring');
|
|
424
|
+
}
|
|
425
|
+
this.status = 'browser-server-running';
|
|
426
|
+
// Send ack so that the counterpart also knows to start forwarding messages.
|
|
427
|
+
// NOTE: The 1-second delay is an intentional workaround. In the current
|
|
428
|
+
// protocol, the remote tunnel endpoint does not expose an explicit "ready"
|
|
429
|
+
// signal for when it has finished initializing its own forwarding logic
|
|
430
|
+
// after receiving the initial handshake. This
|
|
431
|
+
// delay avoids races where early messages could be dropped or mishandled
|
|
432
|
+
// if they arrive before the remote side is fully ready.
|
|
433
|
+
//
|
|
434
|
+
// TODO: A future improvement would be to replace this delay with a deterministic
|
|
435
|
+
// synchronization mechanism (e.g. an explicit "ready" message or event)
|
|
436
|
+
// instead of relying on a fixed timeout.
|
|
437
|
+
await Async.sleepAsync(2000);
|
|
438
|
+
ws.send(JSON.stringify({ action: 'handshakeAck' }));
|
|
439
|
+
await this._setupForwardingAsync(ws, client);
|
|
440
|
+
// Clean up message handler after successful handshake
|
|
441
|
+
ws.off('message', onMessageHandler);
|
|
442
|
+
resolve(ws);
|
|
443
|
+
}
|
|
444
|
+
catch (error) {
|
|
445
|
+
terminal.writeLine(`Error processing handshake: ${error}`);
|
|
446
|
+
this.status = 'error';
|
|
447
|
+
// Cleanup and close connection on error
|
|
448
|
+
ws.off('message', onMessageHandler);
|
|
449
|
+
ws.close(WebSocketCloseCode.INTERNAL_ERROR, 'Handshake error');
|
|
450
|
+
reject(error);
|
|
451
|
+
return;
|
|
452
|
+
}
|
|
453
|
+
}
|
|
454
|
+
else {
|
|
455
|
+
if (!client) {
|
|
456
|
+
terminal.writeLine('Browser WebSocket client is not initialized.');
|
|
457
|
+
ws.off('message', onMessageHandler);
|
|
458
|
+
ws.close(WebSocketCloseCode.INTERNAL_ERROR, 'Browser client not initialized');
|
|
459
|
+
return;
|
|
460
|
+
}
|
|
461
|
+
}
|
|
462
|
+
};
|
|
463
|
+
ws.on('message', onMessageHandler);
|
|
464
|
+
});
|
|
465
|
+
}
|
|
466
|
+
}
|
|
467
|
+
//# sourceMappingURL=PlaywrightBrowserTunnel.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PlaywrightBrowserTunnel.js","sourceRoot":"","sources":["../src/PlaywrightBrowserTunnel.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAG3D,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAGnC,OAAO,EAAgB,SAAS,EAAwB,MAAM,IAAI,CAAC;AACnE,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,wBAAwB,EAAE,sBAAsB,EAAkB,MAAM,qBAAqB,CAAC;AACvG,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AAE7E,OAAO,EACL,wBAAwB,EACxB,uBAAuB,EACvB,4BAA4B,EAC5B,kBAAkB,EACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,sBAAsB,EAAuC,MAAM,0BAA0B,CAAC;AAOvG,MAAM,iBAAiB,GAAgB,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAyB,CAAC,CAAC;AAC1G,SAAS,kBAAkB,CAAC,WAAmB;IAC7C,OAAO,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;AAC5C,CAAC;AAyDD;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAgB3B,YAAmB,OAAiC;QAZnC,iCAA4B,GAAgB,IAAI,GAAG,EAAE,CAAC;QAI/D,YAAO,GAAiB,SAAS,CAAC;QAElC,iBAAY,GAAY,KAAK,CAAC;QAOpC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,cAAc,EAAE,qBAAqB,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAE1F,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,iBAAiB;gBACpB,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;oBACxB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;gBACrE,CAAC;gBACD,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;gBACtC,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;gBAC7B,MAAM;YACR,KAAK,8BAA8B;gBACjC,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;oBACrC,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;gBAClF,CAAC;gBACD,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;gBAC7B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;gBACtC,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC;QAC7C,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QACtC,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QACtC,IAAI,CAAC,sBAAsB,GAAG,qBAAqB,CAAC;IACtD,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,gEAAgE;IAChE,IAAY,MAAM,CAAC,SAAuB;QACxC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QACzB,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,MAAM,QAAQ,GAAc,IAAI,CAAC,SAAS,CAAC;QAC3C,MAAM,aAAa,GAAmC,IAAI,CAAC,cAAc,CAAC;QAC1E,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,EAAE,GAAc,MAAM,aAAa,CAAC;YAC1C,MAAM,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;YACxB,QAAQ,CAAC,cAAc,CAAC,sDAAsD,CAAC,CAAC;YAChF,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAClC,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,UAAqC,EAAE;;QAC7D,IAAI,CAAC,YAAY,GAAG,MAAA,OAAO,CAAC,WAAW,mCAAI,IAAI,CAAC;QAChD,MAAM,QAAQ,GAAc,IAAI,CAAC,SAAS,CAAC;QAC3C,QAAQ,CAAC,SAAS,CAAC,gBAAgB,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACzB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,iCAAiC,EAAE,CAAC;YACjE,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,SAAS,CAAC,0CAA0C,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YAC9E,CAAC;YACD,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACjC,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,SAAS;;QACpB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC1B,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAClC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QACjC,CAAC;QACD,MAAM,CAAA,MAAA,IAAI,CAAC,cAAc,0CAAE,OAAO,CAAC,GAAG,EAAE;;YACtC,MAAA,IAAI,CAAC,GAAG,0CAAE,KAAK,CAAC,kBAAkB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QACvE,CAAC,CAAC,CAAA,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;QAChC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,iCAAiC,CAAC,CAAC;QAC5D,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,mBAAmB;QAC9B,MAAM,OAAO,GAAW,IAAI,CAAC,sBAAsB,CAAC;QACpD,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,kCAAkC,OAAO,EAAE,CAAC,CAAC;QACtE,IAAI,CAAC;YACH,MAAM,UAAU,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;YACjD,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;QAC1D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,uCAAuC,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrG,CAAC;IACH,CAAC;IAED,yFAAyF;IACzF,oEAAoE;IAE5D,KAAK,CAAC,gBAAgB,CAAC,OAAe,EAAE,IAAc;;QAC5D,MAAM,OAAO,GAAW,IAAI,CAAC,sBAAsB,CAAC;QACpD,MAAM,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,oBAAoB,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,OAAO,EAAE,CAAC,CAAC;QAExF,MAAM,EAAE,GAAiB,UAAU,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE;YACvD,KAAK,EAAE;gBACL,QAAQ,EAAE,QAAQ;gBAClB,MAAM,EAAE,SAAS;gBACjB,MAAM,CAAC,SAAS;aACjB;YACD,uBAAuB,EAAE,OAAO;SACjC,CAAC,CAAC;QAEH,MAAA,EAAE,CAAC,MAAM,0CAAE,IAAI,CACb,IAAI,sBAAsB,CAAC;YACzB,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,QAAQ,EAAE,wBAAwB,CAAC,GAAG;SACvC,CAAC,CACH,CAAC;QACF,MAAA,EAAE,CAAC,MAAM,0CAAE,IAAI,CACb,IAAI,sBAAsB,CAAC;YACzB,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,QAAQ,EAAE,wBAAwB,CAAC,KAAK;SACzC,CAAC,CACH,CAAC;QAEF,MAAM,UAAU,CAAC,gBAAgB,CAAC,EAAE,EAAE,EAAE,sBAAsB,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/F,CAAC;IAEO,KAAK,CAAC,2BAA2B,CAAC,EACxC,iBAAiB,EACqB;QACtC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sCAAsC,iBAAiB,EAAE,CAAC,CAAC;QACpF,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE;YACjC,SAAS;YACT,mBAAmB,iBAAiB,wBAAwB,iBAAiB,EAAE;SAChF,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,+BAA+B,CAAC,EAC5C,iBAAiB,EACjB,WAAW,EAC2C;QACtD,MAAM,IAAI,CAAC,2BAA2B,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC9D,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,qCAAqC,iBAAiB,EAAE,CAAC,CAAC;QACnF,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;YAClC,gCAAgC,iBAAiB,SAAS;YAC1D,SAAS;YACT,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,gBAAgB;QAC5B,MAAM,UAAU,GAAuB,IAAI,CAAC,WAAW,CAAC;QACxD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,MAAM,IAAI,OAAO,CAAY,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtD,MAAM,EAAE,GAAc,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;YAChD,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;gBACjB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;gBACxD,OAAO,CAAC,EAAE,CAAC,CAAC;YACd,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBACzB,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,4CAA4C;IAC5C,wEAAwE;IAChE,KAAK,CAAC,oBAAoB;QAChC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;QAC7D,OAAO,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC3C,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC,GAAG,EAAE;gBACpC,IAAI,IAAI,CAAC,yBAAyB,EAAE,CAAC;oBACnC,OAAO,CAAC,sDAAsD;gBAChE,CAAC;gBACD,MAAM,iBAAiB,GAAuB,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtE,IAAI,CAAC,yBAAyB,GAAG,iBAAiB,CAAC;gBACnD,iBAAiB;qBACd,IAAI,CAAC,CAAC,EAAa,EAAE,EAAE;oBACtB,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;oBAClC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;oBAC/B,EAAE,CAAC,kBAAkB,EAAE,CAAC;oBACxB,IAAI,CAAC,yBAAyB,GAAG,SAAS,CAAC;oBAC3C,OAAO,CAAC,EAAE,CAAC,CAAC;gBACd,CAAC,CAAC;qBACD,KAAK,CAAC,GAAG,EAAE;oBACV,sCAAsC;oBACtC,IAAI,CAAC,yBAAyB,GAAG,SAAS,CAAC;gBAC7C,CAAC,CAAC,CAAC;YACP,CAAC,EAAE,GAAG,CAAC,CAAC;QACV,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,+BAA+B;QAC3C,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,2CAA2C,CAAC,CAAC;QAEtE,OAAO,MAAM,IAAI,OAAO,CAAY,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtD,MAAM,MAAM,GAAoB,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YAEjF,MAAM,OAAO,GAAG,GAAS,EAAE;gBACzB,MAAM,CAAC,kBAAkB,EAAE,CAAC;YAC9B,CAAC,CAAC;YAEF,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE;gBAC/B,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,2CAA2C,CAAC,CAAC;gBAEtE,qDAAqD;gBACrD,OAAO,EAAE,CAAC;gBACV,MAAM,CAAC,KAAK,CAAC,CAAC,UAAkB,EAAE,EAAE;oBAClC,IAAI,UAAU,EAAE,CAAC;wBACf,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,qCACE,UAAU,YAAY,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,UACrD,EAAE,CACH,CAAC;oBACJ,CAAC;oBACD,OAAO,CAAC,EAAE,CAAC,CAAC;gBACd,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC7B,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,2BAA2B,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAEvF,OAAO,EAAE,CAAC;gBACV,0CAA0C;gBAC1C,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,kGAAkG;IAClG,2HAA2H;IAC3H,oBAAoB;IACZ,KAAK,CAAC,qBAAqB,CAAC,EAClC,iBAAiB,EACjB,WAAW,EAC2C;QACtD,MAAM,UAAU,GAAW,GAAG,iBAAiB,IAAI,WAAW,EAAE,CAAC;QACjE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,mEAAmE,UAAU,EAAE,CAAC,CAAC;QAC1G,IAAI,CAAC,IAAI,CAAC,4BAA4B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,oEAAoE,iBAAiB,EAAE,CACxF,CAAC;YACF,MAAM,IAAI,CAAC,+BAA+B,CAAC,EAAE,iBAAiB,EAAE,WAAW,EAAE,CAAC,CAAC;YAC/E,IAAI,CAAC,4BAA4B,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,iCAAiC,iBAAiB,qBAAqB,CAAC,CAAC;QAClG,OAAO,MAAM,MAAM,CAAC,GAAG,IAAI,CAAC,sBAAsB,iCAAiC,iBAAiB,EAAE,CAAC,CAAC;IAC1G,CAAC;IAEO,KAAK,CAAC,qCAAqC,CAAC,EAClD,WAAW,EACX,iBAAiB,EACjB,aAAa,EAC2D;QACxE,MAAM,QAAQ,GAAc,IAAI,CAAC,SAAS,CAAC;QAE3C,qDAAqD;QACrD,QAAQ,CAAC,SAAS,CAAC,yDAAyD,CAAC,CAAC;QAC9E,MAAM,gBAAgB,GACpB,MAAM,sBAAsB,CAAC,0BAA0B,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QAEnF,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;YAC9B,QAAQ,CAAC,gBAAgB,CACvB,oCAAoC,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAChF,CAAC;YACF,QAAQ,CAAC,gBAAgB,CAAC,kEAAkE,CAAC,CAAC;QAChG,CAAC;QAED,iFAAiF;QACjF,2FAA2F;QAC3F,MAAM,WAAW,GAAkB;YACjC,GAAG,gBAAgB,CAAC,eAAe;YACnC,QAAQ,EAAE,KAAK;SAChB,CAAC;QAEF,6FAA6F;QAC7F,6DAA6D;QAC7D,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,EAAE,GAAG,WAAW,CAAC;QAChD,QAAQ,CAAC,SAAS,CAChB,oCAAoC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,6BAA6B,CAC5F,CAAC;QAEF,MAAM,UAAU,GAAqC,MAAM,IAAI,CAAC,qBAAqB,CAAC;YACpF,iBAAiB;YACjB,WAAW;SACZ,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;QACjD,MAAM,QAAQ,GAAqC,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAEjF,MAAM,aAAa,GAAkB,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAE3F,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,uCAAuC,WAAW,kBAAkB,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAClG,CAAC;QACJ,CAAC;QAED,QAAQ,CAAC,SAAS,CAAC,YAAY,WAAW,iBAAiB,CAAC,CAAC;QAC7D,MAAM,MAAM,GAAc,IAAI,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC,CAAC;QAEpE,OAAO;YACL,aAAa;YACb,MAAM;SACP,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,YAAqB;QAC9C,IACE,OAAO,YAAY,KAAK,QAAQ;YAChC,YAAY,KAAK,IAAI;YACrB,QAAQ,IAAI,YAAY,KAAK,KAAK;YAClC,aAAa,IAAI,YAAY,KAAK,KAAK;YACvC,mBAAmB,IAAI,YAAY,KAAK,KAAK;YAC7C,eAAe,IAAI,YAAY,KAAK,KAAK;YACzC,OAAO,YAAY,CAAC,MAAM,KAAK,QAAQ;YACvC,OAAO,YAAY,CAAC,WAAW,KAAK,QAAQ;YAC5C,OAAO,YAAY,CAAC,iBAAiB,KAAK,QAAQ;YAClD,OAAO,YAAY,CAAC,aAAa,KAAK,QAAQ,EAC9C,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,sBAAsB,CAAC,CAAC;QAC5F,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,iBAAiB,EAAE,aAAa,EAAE,GAAG,YAAY,CAAC;QAE/E,IAAI,MAAM,KAAK,WAAW,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,mBAAmB,MAAM,yBAAyB,CAAC,CAAC;QACtE,CAAC;QACD,MAAM,uBAAuB,GAAyB,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;QACvF,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,+BAA+B,iBAAiB,mCAAmC,CAAC,CAAC;QACvG,CAAC;QACD,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CACb,yBAAyB,WAAW,oBAAoB,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACpG,CAAC;QACJ,CAAC;QAED,OAAO;YACL,MAAM;YACN,aAAa,EAAE,aAA8B;YAC7C,iBAAiB,EAAE,uBAAuB;YAC1C,WAAW;SACZ,CAAC;IACJ,CAAC;IAED,mEAAmE;IAC3D,KAAK,CAAC,qBAAqB,CAAC,GAAc,EAAE,GAAc;QAChE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,mDAAmD,CAAC,CAAC;QAC9E,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,8BAA8B,4BAA4B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACvG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,+BAA+B,4BAA4B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAExG,MAAM,YAAY,GAA2C,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;QAE1F,GAAG,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;YACzB,YAAY,CAAC,QAAQ,EAAE,CAAC;YACxB,IAAI,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;gBACtC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,wBAAwB,4BAA4B,CAAC,GAAG,CAAC,UAAU,CAAC,wBAAwB,YAAY,CAAC,QAAQ,EAAE,CACpH,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;YACzB,YAAY,CAAC,QAAQ,EAAE,CAAC;YACxB,IAAI,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;gBACtC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,wBAAwB,4BAA4B,CAAC,GAAG,CAAC,UAAU,CAAC,wBAAwB,YAAY,CAAC,QAAQ,EAAE,CACpH,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAY,EAAE,MAAc,EAAE,EAAE;YACjD,MAAM,SAAS,GAAW,MAAM,CAAC,QAAQ,EAAE,IAAI,oBAAoB,CAAC;YACpE,MAAM,eAAe,GAAW,uBAAuB,CAAC,IAAI,CAAC,CAAC;YAC9D,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,+BAA+B,IAAI,KAAK,eAAe,cAAc,SAAS,EAAE,CACjF,CAAC;YACF,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,mCAAmC,YAAY,CAAC,QAAQ,eAAe,YAAY,CAAC,QAAQ,EAAE,CAC/F,CAAC;YACF,IAAI,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;gBACtC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,qCAAqC,CAAC,CAAC;gBAChE,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;YAChE,CAAC;QACH,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAY,EAAE,MAAc,EAAE,EAAE;YACjD,MAAM,SAAS,GAAW,MAAM,CAAC,QAAQ,EAAE,IAAI,oBAAoB,CAAC;YACpE,MAAM,eAAe,GAAW,uBAAuB,CAAC,IAAI,CAAC,CAAC;YAC9D,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,gCAAgC,IAAI,KAAK,eAAe,cAAc,SAAS,EAAE,CAClF,CAAC;YACF,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,mCAAmC,YAAY,CAAC,QAAQ,eAAe,YAAY,CAAC,QAAQ,EAAE,CAC/F,CAAC;YACF,IAAI,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;gBACtC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,oCAAoC,CAAC,CAAC;gBAC/D,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;YACjE,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC1B,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,iCAAiC,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAClG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,qBAAqB,4BAA4B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC1B,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,kCAAkC,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACnG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,qBAAqB,4BAA4B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,iCAAiC;QAC7C,IAAI,SAAS,GAA2B,SAAS,CAAC;QAClD,IAAI,MAAM,GAA0B,SAAS,CAAC;QAC9C,IAAI,aAAa,GAA8B,SAAS,CAAC;QAEzD,IAAI,CAAC,MAAM,GAAG,wBAAwB,CAAC;QACvC,MAAM,EAAE,GACN,IAAI,CAAC,KAAK,KAAK,iBAAiB;YAC9B,CAAC,CAAC,MAAM,IAAI,CAAC,oBAAoB,EAAE;YACnC,CAAC,CAAC,MAAM,IAAI,CAAC,+BAA+B,EAAE,CAAC;QAEnD,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;YACjB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;YAC7D,SAAS,GAAG,SAAS,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACvB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,6BAA6B,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC3F,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,IAAY,EAAE,MAAc,EAAE,EAAE;YACpD,MAAM,SAAS,GAAW,MAAM,CAAC,QAAQ,EAAE,IAAI,oBAAoB,CAAC;YACpE,MAAM,eAAe,GAAW,uBAAuB,CAAC,IAAI,CAAC,CAAC;YAC9D,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;YAChC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;YACxB,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,uCAAuC,IAAI,KAAK,eAAe,cAAc,SAAS,EAAE,CACzF,CAAC;YACF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAyB,SAAS,KAAK,SAAS,EAAE,CAAC,CAAC;YAC7E,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,2BAA2B,aAAa,KAAK,SAAS,EAAE,CAAC,CAAC;YACnF,IAAI,aAAa,EAAE,CAAC;gBAClB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;gBACxD,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC;gBAC5B,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC;YACtD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,IAAI,OAAO,CAAY,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtD,MAAM,gBAAgB,GAAG,KAAK,EAAE,IAAa,EAAiB,EAAE;gBAC9D,MAAM,QAAQ,GAAc,IAAI,CAAC,SAAS,CAAC;gBAC3C,IAAI,CAAC,SAAS,EAAE,CAAC;oBACf,IAAI,CAAC;wBACH,MAAM,kBAAkB,GAAW,IAAI,CAAC,QAAQ,EAAE,CAAC;wBACnD,MAAM,YAAY,GAAY,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;wBAC7D,QAAQ,CAAC,SAAS,CAAC,uBAAuB,kBAAkB,EAAE,CAAC,CAAC;wBAChE,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;wBAElD,+CAA+C;wBAC/C,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;4BACzB,QAAQ,CAAC,SAAS,CAAC,6DAA6D,CAAC,CAAC;4BAClF,MAAM,aAAa,GAAY,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;4BACrE,IAAI,CAAC,aAAa,EAAE,CAAC;gCACnB,QAAQ,CAAC,SAAS,CAAC,0CAA0C,CAAC,CAAC;gCAC/D,EAAE,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;gCACpC,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,cAAc,EAAE,0BAA0B,CAAC,CAAC;gCACxE,MAAM,CAAC,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC,CAAC;gCAC7D,OAAO;4BACT,CAAC;4BACD,QAAQ,CAAC,SAAS,CAAC,sCAAsC,CAAC,CAAC;wBAC7D,CAAC;wBAED,IAAI,CAAC,MAAM,GAAG,2BAA2B,CAAC;wBAC1C,MAAM,kBAAkB,GACtB,MAAM,IAAI,CAAC,qCAAqC,CAAC,SAAS,CAAC,CAAC;wBAC9D,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC;wBACnC,aAAa,GAAG,kBAAkB,CAAC,aAAa,CAAC;wBAEjD,6CAA6C;wBAC7C,MAAM,cAAc,GAAwB,aAAa,CAAC,OAAO,EAAE,CAAC;wBACpE,IAAI,cAAc,EAAE,CAAC;4BACnB,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAmB,EAAE,MAAqB,EAAE,EAAE;gCACvE,QAAQ,CAAC,cAAc,CAAC,yCAAyC,IAAI,aAAa,MAAM,EAAE,CAAC,CAAC;4BAC9F,CAAC,CAAC,CAAC;4BACH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;gCACxC,QAAQ,CAAC,cAAc,CAAC,iCAAiC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;4BAC5F,CAAC,CAAC,CAAC;4BACH,QAAQ,CAAC,cAAc,CAAC,4CAA4C,cAAc,CAAC,GAAG,EAAE,CAAC,CAAC;wBAC5F,CAAC;6BAAM,CAAC;4BACN,QAAQ,CAAC,cAAc,CAAC,qEAAqE,CAAC,CAAC;wBACjG,CAAC;wBAED,IAAI,CAAC,MAAM,GAAG,wBAAwB,CAAC;wBAEvC,4EAA4E;wBAC5E,wEAAwE;wBACxE,2EAA2E;wBAC3E,wEAAwE;wBACxE,8CAA8C;wBAC9C,yEAAyE;wBACzE,wDAAwD;wBACxD,EAAE;wBACF,iFAAiF;wBACjF,wEAAwE;wBACxE,yCAAyC;wBACzC,MAAM,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;wBAE7B,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;wBACpD,MAAM,IAAI,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;wBAE7C,sDAAsD;wBACtD,EAAE,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;wBACpC,OAAO,CAAC,EAAE,CAAC,CAAC;oBACd,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,QAAQ,CAAC,SAAS,CAAC,+BAA+B,KAAK,EAAE,CAAC,CAAC;wBAC3D,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;wBAEtB,wCAAwC;wBACxC,EAAE,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;wBACpC,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;wBAC/D,MAAM,CAAC,KAAK,CAAC,CAAC;wBACd,OAAO;oBACT,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,MAAM,EAAE,CAAC;wBACZ,QAAQ,CAAC,SAAS,CAAC,8CAA8C,CAAC,CAAC;wBACnE,EAAE,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;wBACpC,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,cAAc,EAAE,gCAAgC,CAAC,CAAC;wBAC9E,OAAO;oBACT,CAAC;gBACH,CAAC;YACH,CAAC,CAAC;YACF,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport type { ChildProcess } from 'node:child_process';\nimport { once } from 'node:events';\n\nimport type { BrowserServer, BrowserType, LaunchOptions } from 'playwright-core';\nimport { type RawData, WebSocket, type WebSocketServer } from 'ws';\nimport semver from 'semver';\n\nimport { TerminalProviderSeverity, TerminalStreamWritable, type ITerminal } from '@rushstack/terminal';\nimport { Executable, FileSystem, Async } from '@rushstack/node-core-library';\n\nimport {\n getNormalizedErrorString,\n getWebSocketCloseReason,\n getWebSocketReadyStateString,\n WebSocketCloseCode\n} from './utilities';\nimport { LaunchOptionsValidator, type ILaunchOptionsValidationResult } from './LaunchOptionsValidator';\n\n/**\n * Allowed Playwright browser names.\n * @beta\n */\nexport type BrowserName = 'chromium' | 'firefox' | 'webkit';\nconst validBrowserNames: Set<string> = new Set(['chromium', 'firefox', 'webkit'] satisfies BrowserName[]);\nfunction isValidBrowserName(browserName: string): browserName is BrowserName {\n return validBrowserNames.has(browserName);\n}\n\n/**\n * Status values reported by {@link PlaywrightTunnel}.\n * @beta\n */\nexport type TunnelStatus =\n | 'waiting-for-connection'\n | 'browser-server-running'\n | 'stopped'\n | 'setting-up-browser-server'\n | 'error';\n\n/**\n * Handshake data exchanged during the initial WebSocket connection.\n * @beta\n */\nexport interface IHandshake {\n action: 'handshake';\n browserName: BrowserName;\n launchOptions: LaunchOptions;\n playwrightVersion: semver.SemVer;\n}\n\ntype TunnelMode = 'poll-connection' | 'wait-for-incoming-connection';\n\n/**\n * Options for configuring a {@link PlaywrightTunnel} instance.\n * @beta\n */\nexport type IPlaywrightTunnelOptions = {\n terminal: ITerminal;\n onStatusChange: (status: TunnelStatus) => void;\n playwrightInstallPath: string;\n /**\n * Optional callback invoked before launching the browser server.\n * Receives the handshake data including launch options.\n * If the callback returns false, the browser server launch will be aborted.\n * This allows the client to prompt the user for approval before starting.\n */\n onBeforeLaunch?: (handshake: IHandshake) => Promise<boolean> | boolean;\n} & (\n | {\n mode: 'poll-connection';\n wsEndpoint: string;\n }\n | {\n mode: 'wait-for-incoming-connection';\n listenPort: number;\n }\n);\n\ninterface IBrowserServerProxy {\n browserServer: BrowserServer;\n client: WebSocket;\n}\n\n/**\n * Hosts a Playwright browser server and forwards traffic over a WebSocket tunnel.\n * @beta\n */\nexport class PlaywrightTunnel {\n private readonly _terminal: ITerminal;\n private readonly _onStatusChange: (status: TunnelStatus) => void;\n private readonly _onBeforeLaunch?: (handshake: IHandshake) => Promise<boolean> | boolean;\n private readonly _playwrightBrowsersInstalled: Set<string> = new Set();\n private readonly _wsEndpoint: string | undefined;\n private readonly _listenPort: number | undefined;\n private readonly _playwrightInstallPath: string;\n private _status: TunnelStatus = 'stopped';\n private _initWsPromise?: Promise<WebSocket>;\n private _keepRunning: boolean = false;\n private _ws?: WebSocket;\n private _mode: TunnelMode;\n private _pendingConnectionAttempt?: Promise<WebSocket>;\n private _pollInterval?: NodeJS.Timeout;\n\n public constructor(options: IPlaywrightTunnelOptions) {\n const { mode, terminal, onStatusChange, playwrightInstallPath, onBeforeLaunch } = options;\n\n switch (mode) {\n case 'poll-connection':\n if (!options.wsEndpoint) {\n throw new Error('wsEndpoint is required for poll-connection mode');\n }\n this._wsEndpoint = options.wsEndpoint;\n this._listenPort = undefined;\n break;\n case 'wait-for-incoming-connection':\n if (options.listenPort === undefined) {\n throw new Error('listenPort is required for wait-for-incoming-connection mode');\n }\n this._wsEndpoint = undefined;\n this._listenPort = options.listenPort;\n break;\n default:\n throw new Error(`Invalid mode: ${mode}`);\n }\n\n this._mode = mode;\n this._terminal = terminal;\n this._onStatusChange = onStatusChange;\n this._onBeforeLaunch = onBeforeLaunch;\n this._playwrightInstallPath = playwrightInstallPath;\n }\n\n public get status(): TunnelStatus {\n return this._status;\n }\n\n // eslint-disable-next-line @typescript-eslint/naming-convention\n private set status(newStatus: TunnelStatus) {\n this._status = newStatus;\n this._onStatusChange(newStatus);\n }\n\n public async waitForCloseAsync(): Promise<void> {\n const terminal: ITerminal = this._terminal;\n const initWsPromise: Promise<WebSocket> | undefined = this._initWsPromise;\n if (initWsPromise) {\n const ws: WebSocket = await initWsPromise;\n await once(ws, 'close');\n terminal.writeDebugLine('WebSocket connection closed. resolving init promise.');\n this._initWsPromise = undefined;\n }\n }\n\n public async startAsync(options: { keepRunning?: boolean } = {}): Promise<void> {\n this._keepRunning = options.keepRunning ?? true;\n const terminal: ITerminal = this._terminal;\n terminal.writeLine(`keepRunning: ${this._keepRunning}`);\n while (this._keepRunning) {\n if (!this._initWsPromise) {\n this._initWsPromise = this._initPlaywrightBrowserTunnelAsync();\n } else {\n terminal.writeLine(`Tunnel is already running with status: ${this.status}`);\n }\n await this.waitForCloseAsync();\n }\n }\n\n public async stopAsync(): Promise<void> {\n this._keepRunning = false;\n if (this._pollInterval) {\n clearInterval(this._pollInterval);\n this._pollInterval = undefined;\n }\n await this._initWsPromise?.finally(() => {\n this._ws?.close(WebSocketCloseCode.NORMAL_CLOSURE, 'Tunnel stopped');\n });\n }\n\n public async [Symbol.asyncDispose](): Promise<void> {\n this._terminal.writeLine('Disposing WebSocket connection.');\n await this.stopAsync();\n }\n\n public async cleanTempFilesAsync(): Promise<void> {\n const tmpPath: string = this._playwrightInstallPath;\n this._terminal.writeLine(`Cleaning up temporary files in ${tmpPath}`);\n try {\n await FileSystem.ensureEmptyFolderAsync(tmpPath);\n this._terminal.writeLine(`Temporary files cleaned up.`);\n } catch (error) {\n this._terminal.writeLine(`Failed to clean up temporary files: ${getNormalizedErrorString(error)}`);\n }\n }\n\n // TODO: We should implement an uninstall command to remove installed Playwright browsers\n // public async uninstallPlaywrightBrowsersAsync(): Promise<void> {}\n\n private async _runCommandAsync(command: string, args: string[]): Promise<void> {\n const tmpPath: string = this._playwrightInstallPath;\n await FileSystem.ensureFolderAsync(tmpPath);\n this._terminal.writeLine(`Running command: ${command} ${args.join(' ')} in ${tmpPath}`);\n\n const cp: ChildProcess = Executable.spawn(command, args, {\n stdio: [\n 'ignore', // stdin\n 'pipe', // stdout\n 'pipe' // stderr\n ],\n currentWorkingDirectory: tmpPath\n });\n\n cp.stdout?.pipe(\n new TerminalStreamWritable({\n terminal: this._terminal,\n severity: TerminalProviderSeverity.log\n })\n );\n cp.stderr?.pipe(\n new TerminalStreamWritable({\n terminal: this._terminal,\n severity: TerminalProviderSeverity.error\n })\n );\n\n await Executable.waitForExitAsync(cp, { throwOnNonZeroExitCode: true, throwOnSignal: true });\n }\n\n private async _installPlaywrightCoreAsync({\n playwrightVersion\n }: Pick<IHandshake, 'playwrightVersion'>): Promise<void> {\n this._terminal.writeLine(`Installing playwright-core version ${playwrightVersion}`);\n await this._runCommandAsync('npm', [\n 'install',\n `playwright-core-${playwrightVersion}@npm:playwright-core@${playwrightVersion}`\n ]);\n }\n\n private async _installPlaywrightBrowsersAsync({\n playwrightVersion,\n browserName\n }: Pick<IHandshake, 'playwrightVersion' | 'browserName'>): Promise<void> {\n await this._installPlaywrightCoreAsync({ playwrightVersion });\n this._terminal.writeLine(`Executing playwright-core version ${playwrightVersion}`);\n await this._runCommandAsync('node', [\n `node_modules/playwright-core-${playwrightVersion}/cli.js`,\n 'install',\n browserName\n ]);\n }\n\n private async _tryConnectAsync(): Promise<WebSocket> {\n const wsEndpoint: string | undefined = this._wsEndpoint;\n if (!wsEndpoint) {\n throw new Error('WebSocket endpoint is not defined');\n }\n return await new Promise<WebSocket>((resolve, reject) => {\n const ws: WebSocket = new WebSocket(wsEndpoint);\n ws.on('open', () => {\n this._terminal.writeLine(`WebSocket connection opened`);\n resolve(ws);\n });\n ws.once('error', (error) => {\n reject(error);\n });\n });\n }\n\n // TODO: Only supporting one test at a time.\n // Need to support multiple simultaneous connections for parallel tests.\n private async _pollConnectionAsync(): Promise<WebSocket> {\n this._terminal.writeLine(`Waiting for WebSocket connection`);\n return await new Promise((resolve, reject) => {\n this._pollInterval = setInterval(() => {\n if (this._pendingConnectionAttempt) {\n return; // Skip if a connection attempt is already in progress\n }\n const connectionPromise: Promise<WebSocket> = this._tryConnectAsync();\n this._pendingConnectionAttempt = connectionPromise;\n connectionPromise\n .then((ws: WebSocket) => {\n clearInterval(this._pollInterval);\n this._pollInterval = undefined;\n ws.removeAllListeners();\n this._pendingConnectionAttempt = undefined;\n resolve(ws);\n })\n .catch(() => {\n // no-op - will retry on next interval\n this._pendingConnectionAttempt = undefined;\n });\n }, 500);\n });\n }\n\n private async _waitForIncomingConnectionAsync(): Promise<WebSocket> {\n this._terminal.writeLine('Waiting for incoming WebSocket connection');\n\n return await new Promise<WebSocket>((resolve, reject) => {\n const server: WebSocketServer = new WebSocket.Server({ port: this._listenPort });\n\n const cleanup = (): void => {\n server.removeAllListeners();\n };\n\n server.once('connection', (ws) => {\n this._terminal.writeLine('Incoming WebSocket connection established');\n\n // Stop listening immediately so the port is released\n cleanup();\n server.close((closeError?: Error) => {\n if (closeError) {\n this._terminal.writeLine(\n `Failed to close WebSocket server: ${\n closeError instanceof Error ? closeError.message : closeError\n }`\n );\n }\n resolve(ws);\n });\n });\n\n server.once('error', (error) => {\n this._terminal.writeLine(`WebSocket server error: ${getNormalizedErrorString(error)}`);\n\n cleanup();\n // Try to close (best-effort), then reject\n server.close(() => reject(error));\n });\n });\n }\n\n // TODO: If a user runs this for the first time, `this._playwrightBrowsersInstalled` will be empty\n // and it will try to install the browsers every time. We should persist this information. Maybe a cache file with text per\n // machine instance?\n private async _setupPlaywrightAsync({\n playwrightVersion,\n browserName\n }: Pick<IHandshake, 'playwrightVersion' | 'browserName'>): Promise<typeof import('playwright-core')> {\n const browserKey: string = `${playwrightVersion}-${browserName}`;\n this._terminal.writeLine(`Checking for installed playwright browsers. Installed browsers: ${browserKey}`);\n if (!this._playwrightBrowsersInstalled.has(browserKey)) {\n this._terminal.writeLine(\n `Playwright browser not found. Installing playwright-core version ${playwrightVersion}`\n );\n await this._installPlaywrightBrowsersAsync({ playwrightVersion, browserName });\n this._playwrightBrowsersInstalled.add(browserKey);\n }\n\n this._terminal.writeLine(`Using playwright-core version ${playwrightVersion} for browser server`);\n return await import(`${this._playwrightInstallPath}/node_modules/playwright-core-${playwrightVersion}`);\n }\n\n private async _getPlaywrightBrowserServerProxyAsync({\n browserName,\n playwrightVersion,\n launchOptions\n }: Pick<IHandshake, 'playwrightVersion' | 'browserName' | 'launchOptions'>): Promise<IBrowserServerProxy> {\n const terminal: ITerminal = this._terminal;\n\n // Validate launch options against security allowlist\n terminal.writeLine('Validating launch options against security allowlist...');\n const validationResult: ILaunchOptionsValidationResult =\n await LaunchOptionsValidator.validateLaunchOptionsAsync(launchOptions, terminal);\n\n if (!validationResult.isValid) {\n terminal.writeWarningLine(\n `Some launch options were denied: ${validationResult.deniedOptions.join(', ')}`\n );\n terminal.writeWarningLine(`Using filtered launch options. Denied options have been removed.`);\n }\n\n // Use filtered options and ensure headless: false for headed tests in codespaces\n // This is critical for the extension's purpose - enabling headed Playwright tests remotely\n const safeOptions: LaunchOptions = {\n ...validationResult.filteredOptions,\n headless: false\n };\n\n // Log the validated options, excluding 'headless' since it's always false for this extension\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { headless, ...logOptions } = safeOptions;\n terminal.writeLine(\n `Launch options after validation: ${JSON.stringify(logOptions)} (headless: false enforced)`\n );\n\n const playwright: typeof import('playwright-core') = await this._setupPlaywrightAsync({\n playwrightVersion,\n browserName\n });\n\n const { chromium, firefox, webkit } = playwright;\n const browsers: Record<BrowserName, BrowserType> = { chromium, firefox, webkit };\n\n const browserServer: BrowserServer = await browsers[browserName].launchServer(safeOptions);\n\n if (!browserServer) {\n throw new Error(\n `Failed to launch browser server for ${browserName} with options: ${JSON.stringify(safeOptions)}`\n );\n }\n\n terminal.writeLine(`Launched ${browserName} browser server`);\n const client: WebSocket = new WebSocket(browserServer.wsEndpoint());\n\n return {\n browserServer,\n client\n };\n }\n\n private _validateHandshake(rawHandshake: unknown): IHandshake {\n if (\n typeof rawHandshake !== 'object' ||\n rawHandshake === null ||\n 'action' in rawHandshake === false ||\n 'browserName' in rawHandshake === false ||\n 'playwrightVersion' in rawHandshake === false ||\n 'launchOptions' in rawHandshake === false ||\n typeof rawHandshake.action !== 'string' ||\n typeof rawHandshake.browserName !== 'string' ||\n typeof rawHandshake.playwrightVersion !== 'string' ||\n typeof rawHandshake.launchOptions !== 'object'\n ) {\n throw new Error(`Invalid handshake: ${JSON.stringify(rawHandshake)}. Must be an object.`);\n }\n\n const { action, browserName, playwrightVersion, launchOptions } = rawHandshake;\n\n if (action !== 'handshake') {\n throw new Error(`Invalid action: ${action}. Expected 'handshake'.`);\n }\n const playwrightVersionSemver: semver.SemVer | null = semver.coerce(playwrightVersion);\n if (!playwrightVersionSemver) {\n throw new Error(`Invalid Playwright version: ${playwrightVersion}. Must be a valid semver version.`);\n }\n if (!isValidBrowserName(browserName)) {\n throw new Error(\n `Invalid browser name: ${browserName}. Must be one of ${Array.from(validBrowserNames).join(', ')}.`\n );\n }\n\n return {\n action,\n launchOptions: launchOptions as LaunchOptions,\n playwrightVersion: playwrightVersionSemver,\n browserName\n };\n }\n\n // ws1 is the tunnel websocket, ws2 is the browser server websocket\n private async _setupForwardingAsync(ws1: WebSocket, ws2: WebSocket): Promise<void> {\n this._terminal.writeLine('Setting up message forwarding between ws1 and ws2');\n this._terminal.writeLine(` ws1 (tunnel) readyState: ${getWebSocketReadyStateString(ws1.readyState)}`);\n this._terminal.writeLine(` ws2 (browser) readyState: ${getWebSocketReadyStateString(ws2.readyState)}`);\n\n const messageCount: { ws1ToWs2: number; ws2ToWs1: number } = { ws1ToWs2: 0, ws2ToWs1: 0 };\n\n ws1.on('message', (data) => {\n messageCount.ws1ToWs2++;\n if (ws2.readyState === WebSocket.OPEN) {\n ws2.send(data);\n } else {\n this._terminal.writeLine(\n `ws2 not open (state: ${getWebSocketReadyStateString(ws2.readyState)}). Dropping message #${messageCount.ws1ToWs2}`\n );\n }\n });\n ws2.on('message', (data) => {\n messageCount.ws2ToWs1++;\n if (ws1.readyState === WebSocket.OPEN) {\n ws1.send(data);\n } else {\n this._terminal.writeLine(\n `ws1 not open (state: ${getWebSocketReadyStateString(ws1.readyState)}). Dropping message #${messageCount.ws2ToWs1}`\n );\n }\n });\n\n ws1.once('close', (code: number, reason: Buffer) => {\n const reasonStr: string = reason.toString() || 'no reason provided';\n const codeDescription: string = getWebSocketCloseReason(code);\n this._terminal.writeLine(\n `ws1 (tunnel) closed - code: ${code} (${codeDescription}), reason: ${reasonStr}`\n );\n this._terminal.writeLine(\n ` Messages forwarded: ws1->ws2: ${messageCount.ws1ToWs2}, ws2->ws1: ${messageCount.ws2ToWs1}`\n );\n if (ws2.readyState === WebSocket.OPEN) {\n this._terminal.writeLine(' Closing ws2 (browser) in response');\n ws2.close(WebSocketCloseCode.NORMAL_CLOSURE, 'Tunnel closed');\n }\n });\n ws2.once('close', (code: number, reason: Buffer) => {\n const reasonStr: string = reason.toString() || 'no reason provided';\n const codeDescription: string = getWebSocketCloseReason(code);\n this._terminal.writeLine(\n `ws2 (browser) closed - code: ${code} (${codeDescription}), reason: ${reasonStr}`\n );\n this._terminal.writeLine(\n ` Messages forwarded: ws1->ws2: ${messageCount.ws1ToWs2}, ws2->ws1: ${messageCount.ws2ToWs1}`\n );\n if (ws1.readyState === WebSocket.OPEN) {\n this._terminal.writeLine(' Closing ws1 (tunnel) in response');\n ws1.close(WebSocketCloseCode.NORMAL_CLOSURE, 'Browser closed');\n }\n });\n\n ws1.once('error', (error) => {\n this._terminal.writeErrorLine(`ws1 (tunnel) WebSocket error: ${getNormalizedErrorString(error)}`);\n this._terminal.writeErrorLine(` ws1 readyState: ${getWebSocketReadyStateString(ws1.readyState)}`);\n });\n ws2.once('error', (error) => {\n this._terminal.writeErrorLine(`ws2 (browser) WebSocket error: ${getNormalizedErrorString(error)}`);\n this._terminal.writeErrorLine(` ws2 readyState: ${getWebSocketReadyStateString(ws2.readyState)}`);\n });\n }\n\n /**\n * Initializes the Playwright browser tunnel by establishing a WebSocket connection\n * and setting up the browser server.\n * Returns when the handshake is complete and the browser server is running.\n */\n private async _initPlaywrightBrowserTunnelAsync(): Promise<WebSocket> {\n let handshake: IHandshake | undefined = undefined;\n let client: WebSocket | undefined = undefined;\n let browserServer: BrowserServer | undefined = undefined;\n\n this.status = 'waiting-for-connection';\n const ws: WebSocket =\n this._mode === 'poll-connection'\n ? await this._pollConnectionAsync()\n : await this._waitForIncomingConnectionAsync();\n\n ws.on('open', () => {\n this._terminal.writeLine(`WebSocket connection established`);\n handshake = undefined;\n });\n\n ws.on('error', (error) => {\n this._terminal.writeLine(`WebSocket error occurred: ${getNormalizedErrorString(error)}`);\n });\n\n ws.on('close', async (code: number, reason: Buffer) => {\n const reasonStr: string = reason.toString() || 'no reason provided';\n const codeDescription: string = getWebSocketCloseReason(code);\n this._initWsPromise = undefined;\n this.status = 'stopped';\n this._terminal.writeLine(\n `WebSocket connection closed - code: ${code} (${codeDescription}), reason: ${reasonStr}`\n );\n this._terminal.writeLine(` handshake received: ${handshake !== undefined}`);\n this._terminal.writeLine(` browserServer active: ${browserServer !== undefined}`);\n if (browserServer) {\n this._terminal.writeLine(' Closing browser server...');\n await browserServer.close();\n this._terminal.writeLine(' Browser server closed');\n }\n });\n\n return await new Promise<WebSocket>((resolve, reject) => {\n const onMessageHandler = async (data: RawData): Promise<void> => {\n const terminal: ITerminal = this._terminal;\n if (!handshake) {\n try {\n const rawHandshakeString: string = data.toString();\n const rawHandshake: unknown = JSON.parse(rawHandshakeString);\n terminal.writeLine(`Received handshake: ${rawHandshakeString}`);\n handshake = this._validateHandshake(rawHandshake);\n\n // Call the onBeforeLaunch callback if provided\n if (this._onBeforeLaunch) {\n terminal.writeLine('Requesting user approval before launching browser server...');\n const shouldProceed: boolean = await this._onBeforeLaunch(handshake);\n if (!shouldProceed) {\n terminal.writeLine('Browser server launch cancelled by user.');\n ws.off('message', onMessageHandler);\n ws.close(WebSocketCloseCode.NORMAL_CLOSURE, 'Launch cancelled by user');\n reject(new Error('Browser server launch cancelled by user'));\n return;\n }\n terminal.writeLine('User approved browser server launch.');\n }\n\n this.status = 'setting-up-browser-server';\n const browserServerProxy: IBrowserServerProxy =\n await this._getPlaywrightBrowserServerProxyAsync(handshake);\n client = browserServerProxy.client;\n browserServer = browserServerProxy.browserServer;\n\n // Monitor browser server process for crashes\n const browserProcess: ChildProcess | null = browserServer.process();\n if (browserProcess) {\n browserProcess.on('exit', (code: number | null, signal: string | null) => {\n terminal.writeErrorLine(`Browser server process exited - code: ${code}, signal: ${signal}`);\n });\n browserProcess.on('error', (err: Error) => {\n terminal.writeErrorLine(`Browser server process error: ${getNormalizedErrorString(err)}`);\n });\n terminal.writeDebugLine(`Browser server process started with PID: ${browserProcess.pid}`);\n } else {\n terminal.writeDebugLine('Warning: Browser server process handle not available for monitoring');\n }\n\n this.status = 'browser-server-running';\n\n // Send ack so that the counterpart also knows to start forwarding messages.\n // NOTE: The 1-second delay is an intentional workaround. In the current\n // protocol, the remote tunnel endpoint does not expose an explicit \"ready\"\n // signal for when it has finished initializing its own forwarding logic\n // after receiving the initial handshake. This\n // delay avoids races where early messages could be dropped or mishandled\n // if they arrive before the remote side is fully ready.\n //\n // TODO: A future improvement would be to replace this delay with a deterministic\n // synchronization mechanism (e.g. an explicit \"ready\" message or event)\n // instead of relying on a fixed timeout.\n await Async.sleepAsync(2000);\n\n ws.send(JSON.stringify({ action: 'handshakeAck' }));\n await this._setupForwardingAsync(ws, client);\n\n // Clean up message handler after successful handshake\n ws.off('message', onMessageHandler);\n resolve(ws);\n } catch (error) {\n terminal.writeLine(`Error processing handshake: ${error}`);\n this.status = 'error';\n\n // Cleanup and close connection on error\n ws.off('message', onMessageHandler);\n ws.close(WebSocketCloseCode.INTERNAL_ERROR, 'Handshake error');\n reject(error);\n return;\n }\n } else {\n if (!client) {\n terminal.writeLine('Browser WebSocket client is not initialized.');\n ws.off('message', onMessageHandler);\n ws.close(WebSocketCloseCode.INTERNAL_ERROR, 'Browser client not initialized');\n return;\n }\n }\n };\n ws.on('message', onMessageHandler);\n });\n }\n}\n"]}
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
2
2
|
// See LICENSE in the project root for license information.
|
|
3
|
-
|
|
4
3
|
/**
|
|
5
4
|
* Run a Playwright browser server in one environment and drive it from another environment by
|
|
6
5
|
* forwarding Playwright's WebSocket traffic through a tunnel.
|
|
@@ -16,23 +15,8 @@
|
|
|
16
15
|
*
|
|
17
16
|
* @packageDocumentation
|
|
18
17
|
*/
|
|
19
|
-
|
|
20
18
|
export { PlaywrightTunnel } from './PlaywrightBrowserTunnel';
|
|
21
|
-
export type {
|
|
22
|
-
BrowserName,
|
|
23
|
-
TunnelStatus,
|
|
24
|
-
IPlaywrightTunnelOptions,
|
|
25
|
-
IHandshake
|
|
26
|
-
} from './PlaywrightBrowserTunnel';
|
|
27
19
|
export { createTunneledBrowserAsync, tunneledBrowserConnection } from './tunneledBrowserConnection';
|
|
28
|
-
export
|
|
29
|
-
IDisposableTunneledBrowserConnection,
|
|
30
|
-
IDisposableTunneledBrowser
|
|
31
|
-
} from './tunneledBrowserConnection';
|
|
32
|
-
export {
|
|
33
|
-
isExtensionInstalledAsync,
|
|
34
|
-
EXTENSION_INSTALLED_FILENAME,
|
|
35
|
-
getNormalizedErrorString
|
|
36
|
-
} from './utilities';
|
|
20
|
+
export { isExtensionInstalledAsync, EXTENSION_INSTALLED_FILENAME, getNormalizedErrorString } from './utilities';
|
|
37
21
|
export { LaunchOptionsValidator, LAUNCH_OPTIONS_ALLOWLIST_FILENAME } from './LaunchOptionsValidator';
|
|
38
|
-
|
|
22
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAO7D,OAAO,EAAE,0BAA0B,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAKpG,OAAO,EACL,yBAAyB,EACzB,4BAA4B,EAC5B,wBAAwB,EACzB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,sBAAsB,EAAE,iCAAiC,EAAE,MAAM,0BAA0B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/**\n * Run a Playwright browser server in one environment and drive it from another environment by\n * forwarding Playwright's WebSocket traffic through a tunnel.\n *\n * @remarks\n * This package is intended for remote development and CI scenarios (for example: Codespaces,\n * devcontainers, or a separate \"browser host\" machine) where you want tests to run in one\n * environment but the actual browser process to run in another.\n *\n * The package provides two main APIs:\n * - {@link PlaywrightTunnel} - Run on the browser host to launch the real browser server and forward messages\n * - {@link tunneledBrowserConnection} - Run on the test runner to create a local endpoint that your Playwright client can connect to\n *\n * @packageDocumentation\n */\n\nexport { PlaywrightTunnel } from './PlaywrightBrowserTunnel';\nexport type {\n BrowserName,\n TunnelStatus,\n IPlaywrightTunnelOptions,\n IHandshake\n} from './PlaywrightBrowserTunnel';\nexport { createTunneledBrowserAsync, tunneledBrowserConnection } from './tunneledBrowserConnection';\nexport type {\n IDisposableTunneledBrowserConnection,\n IDisposableTunneledBrowser\n} from './tunneledBrowserConnection';\nexport {\n isExtensionInstalledAsync,\n EXTENSION_INSTALLED_FILENAME,\n getNormalizedErrorString\n} from './utilities';\nexport { LaunchOptionsValidator, LAUNCH_OPTIONS_ALLOWLIST_FILENAME } from './LaunchOptionsValidator';\nexport type { ILaunchOptionsAllowlist, ILaunchOptionsValidationResult } from './LaunchOptionsValidator';\n"]}
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
2
2
|
// See LICENSE in the project root for license information.
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
export const DEFAULT_LISTEN_PORT: number = 56767;
|
|
3
|
+
export {};
|
|
4
|
+
//# sourceMappingURL=ITunneledBrowser.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ITunneledBrowser.js","sourceRoot":"","sources":["../../src/tunneledBrowserConnection/ITunneledBrowser.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport type { Browser } from 'playwright-core';\n\n/**\n * Disposable handle returned by {@link createTunneledBrowserAsync}.\n * @beta\n */\nexport interface IDisposableTunneledBrowser {\n /**\n * The connected Playwright Browser instance.\n */\n browser: Browser;\n /**\n * Async dispose method that closes the browser connection.\n * Called automatically when using `await using` syntax.\n */\n [Symbol.asyncDispose]: () => Promise<void>;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ITunneledBrowserConnection.js","sourceRoot":"","sources":["../../src/tunneledBrowserConnection/ITunneledBrowserConnection.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport type { LaunchOptions } from 'playwright-core';\n\nimport type { BrowserName } from '../PlaywrightBrowserTunnel';\n\nexport interface IHandshake {\n action: 'handshake';\n browserName: BrowserName;\n launchOptions: LaunchOptions;\n playwrightVersion: string;\n}\n\nexport interface IHandshakeAck {\n action: 'handshakeAck';\n}\n\n/**\n * Disposable handle returned by {@link tunneledBrowserConnection}.\n * @beta\n */\nexport interface IDisposableTunneledBrowserConnection {\n /**\n * The WebSocket endpoint URL that the local Playwright client should connect to.\n */\n remoteEndpoint: string;\n /**\n * Dispose method that closes the WebSocket servers.\n * Called automatically when using `using` syntax.\n */\n [Symbol.dispose]: () => void;\n /**\n * Promise that resolves when the remote WebSocket server closes.\n */\n closePromise: Promise<void>;\n}\n"]}
|