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.

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

fix: update terminal size dynamically #5250

Merged
merged 1 commit into from
Feb 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 13 additions & 2 deletions src/client/browserContext.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,21 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel,
this._channel.on('route', ({ route, request }) => this._onRoute(network.Route.from(route), network.Request.from(request)));
this._stdout = process.stdout;
this._stderr = process.stderr;
this._channel.on('stdout', ({ data }) => this._stdout.write(Buffer.from(data, 'base64')));
this._channel.on('stderr', ({ data }) => this._stderr.write(Buffer.from(data, 'base64')));
this._channel.on('stdout', ({ data }) => {
this._stdout.write(Buffer.from(data, 'base64'));
this._pushTerminalSize();
});
this._channel.on('stderr', ({ data }) => {
this._stderr.write(Buffer.from(data, 'base64'));
this._pushTerminalSize();
});
this._closedPromise = new Promise(f => this.once(Events.BrowserContext.Close, f));
}

private _pushTerminalSize() {
this._channel.setTerminalSizeNoReply({ rows: process.stdout.rows, columns: process.stdout.columns }).catch(() => {});
}

private _onPage(page: Page): void {
this._pages.add(page);
this.emit(Events.BrowserContext.Page, page);
Expand Down Expand Up @@ -279,6 +289,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel,
terminal?: boolean,
outputFile?: string
}) {
this._pushTerminalSize();
await this._channel.recorderSupplementEnable(params);
}
}
Expand Down
4 changes: 4 additions & 0 deletions src/dispatchers/browserContextDispatcher.ts
Original file line number Diff line number Diff line change
Expand Up @@ -154,4 +154,8 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
const crBrowserContext = this._object as CRBrowserContext;
return { session: new CDPSessionDispatcher(this._scope, await crBrowserContext.newCDPSession((params.page as PageDispatcher)._object)) };
}

async setTerminalSizeNoReply(params: channels.BrowserContextSetTerminalSizeNoReplyParams): Promise<void> {
this._context.terminalSize = params;
}
}
10 changes: 10 additions & 0 deletions src/protocol/channels.ts
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,7 @@ export interface BrowserContextChannel extends Channel {
pause(params?: BrowserContextPauseParams, metadata?: Metadata): Promise<BrowserContextPauseResult>;
recorderSupplementEnable(params: BrowserContextRecorderSupplementEnableParams, metadata?: Metadata): Promise<BrowserContextRecorderSupplementEnableResult>;
crNewCDPSession(params: BrowserContextCrNewCDPSessionParams, metadata?: Metadata): Promise<BrowserContextCrNewCDPSessionResult>;
setTerminalSizeNoReply(params: BrowserContextSetTerminalSizeNoReplyParams, metadata?: Metadata): Promise<BrowserContextSetTerminalSizeNoReplyResult>;
}
export type BrowserContextBindingCallEvent = {
binding: BindingCallChannel,
Expand Down Expand Up @@ -741,6 +742,15 @@ export type BrowserContextCrNewCDPSessionOptions = {
export type BrowserContextCrNewCDPSessionResult = {
session: CDPSessionChannel,
};
export type BrowserContextSetTerminalSizeNoReplyParams = {
rows?: number,
columns?: number,
};
export type BrowserContextSetTerminalSizeNoReplyOptions = {
rows?: number,
columns?: number,
};
export type BrowserContextSetTerminalSizeNoReplyResult = void;

// ----------- Page -----------
export type PageInitializer = {
Expand Down
5 changes: 5 additions & 0 deletions src/protocol/protocol.yml
Original file line number Diff line number Diff line change
Expand Up @@ -624,6 +624,11 @@ BrowserContext:
returns:
session: CDPSession

setTerminalSizeNoReply:
parameters:
rows: number?
columns: number?

events:

bindingCall:
Expand Down
4 changes: 4 additions & 0 deletions src/protocol/validator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,10 @@ export function createScheme(tChannel: (name: string) => Validator): Scheme {
scheme.BrowserContextCrNewCDPSessionParams = tObject({
page: tChannel('Page'),
});
scheme.BrowserContextSetTerminalSizeNoReplyParams = tObject({
rows: tOptional(tNumber),
columns: tOptional(tNumber),
});
scheme.PageSetDefaultNavigationTimeoutNoReplyParams = tObject({
timeout: tNumber,
});
Expand Down
1 change: 1 addition & 0 deletions src/server/browserContext.ts
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ export abstract class BrowserContext extends EventEmitter {
private _selectors?: Selectors;
readonly _actionListeners = new Set<ActionListener>();
private _origins = new Set<string>();
terminalSize: { rows?: number, columns?: number } = {};

constructor(browser: Browser, options: types.BrowserContextOptions, browserContextId: string | undefined) {
super();
Expand Down
5 changes: 4 additions & 1 deletion src/server/supplements/injected/recorder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ declare global {
playwrightRecorderSetUIState: (state: SetUIState) => Promise<void>;
playwrightRecorderResume: () => Promise<boolean>;
playwrightRecorderShowRecorderPage: () => Promise<void>;
playwrightRecorderPrintSelector: (text: string) => Promise<void>;
}
}

Expand Down Expand Up @@ -276,8 +277,10 @@ export class Recorder {

private _onClick(event: MouseEvent) {
if (this._state.uiState.mode === 'inspecting' && !this._isInToolbar(event.target as HTMLElement)) {
if (this._hoveredModel)
if (this._hoveredModel) {
copy(this._hoveredModel.selector);
window.playwrightRecorderPrintSelector(this._hoveredModel.selector);
}
}
if (this._shouldIgnoreMouseEvent(event))
return;
Expand Down
3 changes: 2 additions & 1 deletion src/server/supplements/recorder/outputs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export interface RecorderOutput {

export interface Writable {
write(data: string): void;
columns(): number;
}

export class OutputMultiplexer implements RecorderOutput {
Expand Down Expand Up @@ -156,7 +157,7 @@ export class TerminalOutput implements RecorderOutput {
}

popLn(text: string) {
const terminalWidth = process.stdout.columns || 80;
const terminalWidth = this._output.columns();
for (const line of text.split('\n')) {
const terminalLines = ((line.length - 1) / terminalWidth | 0) + 1;
for (let i = 0; i < terminalLines; ++i)
Expand Down
9 changes: 7 additions & 2 deletions src/server/supplements/recorderSupplement.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,8 @@ export class RecorderSupplement {
highlighterType = 'python';

const writable: Writable = {
write: (text: string) => context.emit(BrowserContext.Events.StdOut, text)
write: (text: string) => context.emit(BrowserContext.Events.StdOut, text),
columns: () => context.terminalSize.columns || 80
};
const outputs: RecorderOutput[] = [params.terminal ? new TerminalOutput(writable, highlighterType) : new FlushingTerminalOutput(writable)];
this._highlighterType = highlighterType;
Expand Down Expand Up @@ -142,7 +143,11 @@ export class RecorderSupplement {
}).catch(e => console.error(e));
});

await this._context.exposeBinding('playwrightRecorderState', false, ({ page }) => {
await this._context.exposeBinding('playwrightRecorderPrintSelector', false, (_, text) => {
this._context.emit(BrowserContext.Events.StdOut, `Selector: \x1b[38;5;130m${text}\x1b[0m\n`);
});

await this._context.exposeBinding('playwrightRecorderState', false, () => {
const state: State = {
uiState: this._recorderUIState,
canResume: this._app === 'pause',
Expand Down
4 changes: 4 additions & 0 deletions src/web/components/source.css
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@
user-select: none;
}

.source-line-number {
flex: none;
}

.source-line-highlighted {
background-color: #ffc0cb7f;
}