Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: make debugp collect IO #1485

Merged
merged 1 commit into from
Mar 23, 2020
Merged

test: make debugp collect IO #1485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/chromium/crConnection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export class CRConnection extends platform.EventEmitter {
this.rootSession = new CRSession(this, '', 'browser', '');
this._sessions.set('', this.rootSession);
this._debugProtocol = platform.debug('pw:protocol');
(this._debugProtocol as any).color = '34';
}

static fromSession(session: CRSession): CRConnection {
Expand Down
1 change: 1 addition & 0 deletions src/firefox/ffConnection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ export class FFConnection extends platform.EventEmitter {
this.off = super.removeListener;
this.removeListener = super.removeListener;
this.once = super.once;
(this._debugProtocol as any).color = '34';
}

async send<T extends keyof Protocol.CommandParameters>(
Expand Down
24 changes: 17 additions & 7 deletions src/server/processLauncher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ import { TimeoutError } from '../errors';
import * as platform from '../platform';

const debugLauncher = platform.debug('pw:launcher');
const debugStdout = platform.debug('pw:stdio:out');
const debugStderr = platform.debug('pw:stdio:err');
(debugStdout as any).color = '178';
(debugStderr as any).color = '160';
const removeFolderAsync = platform.promisify(removeFolder);

export type LaunchProcessOptions = {
Expand Down Expand Up @@ -73,13 +77,19 @@ export async function launchProcess(options: LaunchProcessOptions): Promise<Laun
return result;
}

if (options.dumpio) {
spawnedProcess.stdout.pipe(process.stdout);
spawnedProcess.stderr.pipe(process.stderr);
} else {
spawnedProcess.stderr.on('data', () => {});
spawnedProcess.stdout.on('data', () => {});
}
const stdout = readline.createInterface({ input: spawnedProcess.stdout });
stdout.on('line', (data: string) => {
debugStdout(data);
if (options.dumpio)
console.log(`\x1b[33m[out]\x1b[0m ${data}`); // eslint-disable-line no-console
});

const stderr = readline.createInterface({ input: spawnedProcess.stderr });
stderr.on('line', (data: string) => {
debugStderr(data);
if (options.dumpio)
console.log(`\x1b[31m[err]\x1b[0m ${data}`); // eslint-disable-line no-console
});

let processClosed = false;
const waitForProcessToClose = new Promise((fulfill, reject) => {
Expand Down
1 change: 1 addition & 0 deletions src/webkit/wkConnection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ export class WKConnection {
this.browserSession = new WKSession(this, '', 'Browser has been closed.', (message: any) => {
this.rawSend(message);
});
(this._debugFunction as any).color = '34';
}

nextMessageId(): number {
Expand Down
4 changes: 2 additions & 2 deletions test/fixtures.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,14 @@ module.exports.describe = function({testRunner, expect, product, browserType, pl
it.slow()('should dump browser process stderr', async({server}) => {
let dumpioData = '';
const res = spawn('node', [path.join(__dirname, 'fixtures', 'dumpio.js'), playwrightPath, product, 'usewebsocket']);
res.stderr.on('data', data => dumpioData += data.toString('utf8'));
res.stdout.on('data', data => dumpioData += data.toString('utf8'));
await new Promise(resolve => res.on('close', resolve));
expect(dumpioData).toContain('message from dumpio');
});
it.slow()('should dump browser process stderr', async({server}) => {
let dumpioData = '';
const res = spawn('node', [path.join(__dirname, 'fixtures', 'dumpio.js'), playwrightPath, product]);
res.stderr.on('data', data => dumpioData += data.toString('utf8'));
res.stdout.on('data', data => dumpioData += data.toString('utf8'));
await new Promise(resolve => res.on('close', resolve));
expect(dumpioData).toContain('message from dumpio');
});
Expand Down
27 changes: 13 additions & 14 deletions test/playwright.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ const os = require('os');
const rm = require('rimraf').sync;
const GoldenUtils = require('./golden-utils');
const {Matchers} = require('../utils/testrunner/');
const readline = require('readline');

const YELLOW_COLOR = '\x1b[33m';
const RESET_COLOR = '\x1b[0m';
Expand Down Expand Up @@ -103,6 +104,8 @@ module.exports.describe = ({testRunner, product, playwrightPath}) => {
beforeAll(async state => {
state.browser = await browserType.launch(defaultBrowserOptions);
state.browserServer = state.browser.__server__;
state._stdout = readline.createInterface({ input: state.browserServer.process().stdout });
state._stderr = readline.createInterface({ input: state.browserServer.process().stderr });
});

afterAll(async state => {
Expand All @@ -112,22 +115,18 @@ module.exports.describe = ({testRunner, product, playwrightPath}) => {
});

beforeEach(async(state, test) => {
const onLine = (line) => test.output += line + '\n';
test.output = [];
const dumpout = data => test.output.push(`\x1b[33m[pw:stdio:out]\x1b[0m ${data}`);
const dumperr = data => test.output.push(`\x1b[31m[pw:stdio:err]\x1b[0m ${data}`);
state._stdout.on('line', dumpout);
state._stderr.on('line', dumperr);
if (dumpProtocolOnFailure)
state.browser._setDebugFunction(onLine);

let rl;
if (state.browserServer.process().stderr) {
rl = require('readline').createInterface({ input: state.browserServer.process().stderr });
test.output = '';
rl.on('line', onLine);
}

state.browser._setDebugFunction(data => test.output.push(`\x1b[32m[pw:protocol]\x1b[0m ${data}`));
state.tearDown = async () => {
if (rl) {
rl.removeListener('line', onLine);
rl.close();
}
state._stdout.off('line', dumpout);
state._stderr.off('line', dumperr);
state._stdout.close();
state._stderr.close();
if (dumpProtocolOnFailure)
state.browser._setDebugFunction(() => void 0);
};
Expand Down
6 changes: 4 additions & 2 deletions utils/testrunner/Reporter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,8 @@ class Reporter {
console.log(`${prefix} ${colors.red(`[TIMEOUT ${test.timeout}ms]`)} ${test.fullName} (${formatLocation(test.location)})`);
if (test.output) {
console.log(' Output:');
console.log(padLines(test.output, 4));
for (const line of test.output)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will indent poorly if a line of output is multiline.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to be consistent with requre('debug')

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

previously I could do test.output += JSON.stringify(obj, undefined, 2). Now I can't without breaking the indent.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We were never putting anything from stdio there at the first place, let's see how it looks first

console.log(' ' + line);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
console.log(' ' + line);
console.log(padLines(line, 4));

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are different things

}
} else if (test.result === 'failed') {
console.log(`${prefix} ${colors.red('[FAIL]')} ${test.fullName} (${formatLocation(test.location)})`);
Expand Down Expand Up @@ -253,7 +254,8 @@ class Reporter {
}
if (test.output) {
console.log(' Output:');
console.log(padLines(test.output, 4));
for (const line of test.output)
console.log(' ' + line);
}
}
}
Expand Down