1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as playwright from '@playwright/test';
import { ChildProcess, spawn } from 'child_process';
import { join } from 'path';
import * as mkdirp from 'mkdirp';
import { URI } from 'vscode-uri';
import { Logger, measureAndLog } from './logger';
import type { LaunchOptions } from './code';
import { PlaywrightDriver } from './playwrightDriver';
const root = join(__dirname, '..', '..', '..');
let port = 9000;
export async function launch(options: LaunchOptions): Promise<{ serverProcess: ChildProcess; driver: PlaywrightDriver }> {
// Launch server
const { serverProcess, endpoint } = await launchServer(options);
// Launch browser
const { browser, context, page } = await launchBrowser(options, endpoint);
return {
serverProcess,
driver: new PlaywrightDriver(browser, context, page, serverProcess, options)
};
}
async function launchServer(options: LaunchOptions) {
const { userDataDir, codePath, extensionsPath, logger, logsPath } = options;
const codeServerPath = codePath ?? process.env.VSCODE_REMOTE_SERVER_PATH;
const agentFolder = userDataDir;
await measureAndLog(mkdirp(agentFolder), `mkdirp(${agentFolder})`, logger);
const env = {
VSCODE_REMOTE_SERVER_PATH: codeServerPath,
...process.env
};
const args = [
'--disable-telemetry',
'--disable-workspace-trust',
`--port${port++}`,
'--enable-smoke-test-driver',
`--extensions-dir=${extensionsPath}`,
`--server-data-dir=${agentFolder}`,
'--accept-server-license-terms',
`--logsPath=${logsPath}`
];
if (options.verbose) {
args.push('--log=trace');
}
let serverLocation: string | undefined;
if (codeServerPath) {
const { serverApplicationName } = require(join(codeServerPath, 'product.json'));
serverLocation = join(codeServerPath, 'bin', `${serverApplicationName}${process.platform === 'win32' ? '.cmd' : ''}`);
logger.log(`Starting built server from '${serverLocation}'`);
} else {
serverLocation = join(root, `scripts/code-server.${process.platform === 'win32' ? 'bat' : 'sh'}`);
logger.log(`Starting server out of sources from '${serverLocation}'`);
}
logger.log(`Storing log files into '${logsPath}'`);
logger.log(`Command line: '${serverLocation}' ${args.join(' ')}`);
const serverProcess = spawn(
serverLocation,
args,
{ env }
);
logger.log(`Started server for browser smoke tests (pid: ${serverProcess.pid})`);
return {
serverProcess,
endpoint: await measureAndLog(waitForEndpoint(serverProcess, logger), 'waitForEndpoint(serverProcess)', logger)
};
}
async function launchBrowser(options: LaunchOptions, endpoint: string) {
const { logger, workspacePath, tracing, headless } = options;
const browser = await measureAndLog(playwright[options.browser ?? 'chromium'].launch({ headless: headless ?? false }), 'playwright#launch', logger);
browser.on('disconnected', () => logger.log(`Playwright: browser disconnected`));
const context = await measureAndLog(browser.newContext(), 'browser.newContext', logger);
if (tracing) {
try {
await measureAndLog(context.tracing.start({ screenshots: true, /* remaining options are off for perf reasons */ }), 'context.tracing.start()', logger);
} catch (error) {
logger.log(`Playwright (Browser): Failed to start playwright tracing (${error})`); // do not fail the build when this fails
}
}
const page = await measureAndLog(context.newPage(), 'context.newPage()', logger);
await measureAndLog(page.setViewportSize({ width: 1200, height: 800 }), 'page.setViewportSize', logger);
if (options.verbose) {
context.on('page', () => logger.log(`Playwright (Browser): context.on('page')`));
context.on('requestfailed', e => logger.log(`Playwright (Browser): context.on('requestfailed') [${e.failure()?.errorText} for ${e.url()}]`));
page.on('console', e => logger.log(`Playwright (Browser): window.on('console') [${e.text()}]`));
page.on('dialog', () => logger.log(`Playwright (Browser): page.on('dialog')`));
page.on('domcontentloaded', () => logger.log(`Playwright (Browser): page.on('domcontentloaded')`));
page.on('load', () => logger.log(`Playwright (Browser): page.on('load')`));
page.on('popup', () => logger.log(`Playwright (Browser): page.on('popup')`));
page.on('framenavigated', () => logger.log(`Playwright (Browser): page.on('framenavigated')`));
page.on('requestfailed', e => logger.log(`Playwright (Browser): page.on('requestfailed') [${e.failure()?.errorText} for ${e.url()}]`));
}
page.on('pageerror', async (error) => logger.log(`Playwright (Browser) ERROR: page error: ${error}`));
page.on('crash', () => logger.log('Playwright (Browser) ERROR: page crash'));
page.on('close', () => logger.log('Playwright (Browser): page close'));
page.on('response', async (response) => {
if (response.status() >= 400) {
logger.log(`Playwright (Browser) ERROR: HTTP status ${response.status()} for ${response.url()}`);
}
});
const payloadParam = `[${[
'["enableProposedApi",""]',
'["skipWelcome", "true"]',
'["skipReleaseNotes", "true"]',
`["logLevel","${options.verbose ? 'trace' : 'info'}"]`
].join(',')}]`;
await measureAndLog(page.goto(`${endpoint}&${workspacePath.endsWith('.code-workspace') ? 'workspace' : 'folder'}=${URI.file(workspacePath!).path}&payload=${payloadParam}`), 'page.goto()', logger);
return { browser, context, page };
}
function waitForEndpoint(server: ChildProcess, logger: Logger): Promise<string> {
return new Promise<string>((resolve, reject) => {
let endpointFound = false;
server.stdout?.on('data', data => {
if (!endpointFound) {
logger.log(`[server] stdout: ${data}`); // log until endpoint found to diagnose issues
}
const matches = data.toString('ascii').match(/Web UI available at (.+)/);
if (matches !== null) {
endpointFound = true;
resolve(matches[1]);
}
});
server.stderr?.on('data', error => {
if (!endpointFound) {
logger.log(`[server] stderr: ${error}`); // log until endpoint found to diagnose issues
}
if (error.toString().indexOf('EADDRINUSE') !== -1) {
reject(new Error(error));
}
});
});
}
|
