Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

feat(electron): types (#2231)

Browse source
This commit is contained in:
Joel Einbinder 2020-05-13 20:51:53 -07:00 committed by GitHub
parent 5c43fb4a96
commit dbef7de42a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 49 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
packages/playwright-electron/index.d.ts vendored
View file

@ -14,7 +14,41 @@
* limitations under the License.
*/
import * as types from 'playwright-core/types/types';
import { Logger, Page, JSHandle, ChromiumBrowserContext } from 'playwright-core/types/types';
import { BrowserWindow, BrowserWindowConstructorOptions } from 'electron';
export * from 'playwright-core/types/types';
export const electron: types.BrowserType<types.Electron>;
export type ElectronLaunchOptions = {
args?: string[],
cwd?: string,
env?: {[key: string]: string|number|boolean},
handleSIGINT?: boolean,
handleSIGTERM?: boolean,
handleSIGHUP?: boolean,
timeout?: number,
logger?: Logger,
};
export interface ElectronLauncher {
launch(executablePath: string, options?: ElectronLaunchOptions): Promise<ElectronApplication>;
}
export interface ElectronApplication {
on(event: 'window', listener: (page : ElectronPage) => void): this;
addListener(event: 'window', listener: (page : ElectronPage) => void): this;
waitForEvent(event: 'window', optionsOrPredicate?: { predicate?: (page : ElectronPage) => boolean, timeout?: number }): Promise<ElectronPage>;
on(event: 'close', listener: (exitCode? : number) => void): this;
addListener(event: 'close', listener: (exitCode? : number) => void): this;
waitForEvent(event: 'close', optionsOrPredicate?: { predicate?: (exitCode? : number) => boolean, timeout?: number }): Promise<number|undefined>;
context(): ChromiumBrowserContext;
windows(): ElectronPage[];
firstWindow(): Promise<ElectronPage>;
newBrowserWindow(options?: BrowserWindowConstructorOptions): Promise<ElectronPage>;
close(): Promise<void>;
evaluate: JSHandle<typeof import('electron')>['evaluate'];
evaluateHandle: JSHandle<typeof import('electron')>['evaluateHandle'];
}
export interface ElectronPage extends Page {
browserWindow: JSHandle<BrowserWindow>;
}
export const electron: ElectronLauncher;

20
src/server/electron.ts
View file

@ -31,6 +31,7 @@ import * as types from '../types';
import { BrowserServer } from './browserServer';
import { launchProcess, waitForLine } from './processLauncher';
import { BrowserContext } from '../browserContext';
import type {BrowserWindow} from 'electron';
type ElectronLaunchOptions = {
args?: string[],
@ -50,6 +51,11 @@ export const ElectronEvents = {
}
};
interface ElectronPage extends Page {
browserWindow: js.JSHandle<BrowserWindow>;
_browserWindowId: number;
}
export class ElectronApplication extends ExtendedEventEmitter {
private _logger: InnerLogger;
private _browserContext: CRBrowserContext;
@ -57,7 +63,7 @@ export class ElectronApplication extends ExtendedEventEmitter {
private _nodeSession: CRSession;
private _nodeExecutionContext: js.ExecutionContext | undefined;
private _nodeElectronHandle: js.JSHandle<any> | undefined;
private _windows = new Set<Page>();
private _windows = new Set<ElectronPage>();
private _lastWindowId = 0;
readonly _timeoutSettings = new TimeoutSettings();
@ -71,17 +77,17 @@ export class ElectronApplication extends ExtendedEventEmitter {
this._nodeSession = nodeConnection.rootSession;
}
private async _onPage(page: Page) {
private async _onPage(page: ElectronPage) {
// Needs to be sync.
const windowId = ++this._lastWindowId;
// Can be async.
const handle = await this._nodeElectronHandle!.evaluateHandle(({ BrowserWindow }, windowId) => BrowserWindow.fromId(windowId), windowId).catch(e => {});
if (!handle)
return;
(page as any).browserWindow = handle;
(page as any)._browserWindowId = windowId;
page.browserWindow = handle;
page._browserWindowId = windowId;
page.on(Events.Page.Close, () => {
(page as any).browserWindow.dispose();
page.browserWindow.dispose();
this._windows.delete(page);
});
this._windows.add(page);
@ -107,11 +113,11 @@ export class ElectronApplication extends ExtendedEventEmitter {
}, options);
for (const page of this._windows) {
if ((page as any)._browserWindowId === windowId)
if (page._browserWindowId === windowId)
return page;
}
return await this.waitForEvent(ElectronEvents.ElectronApplication.Window, (page: Page) => (page as any)._browserWindowId === windowId);
return await this.waitForEvent(ElectronEvents.ElectronApplication.Window, (page: ElectronPage) => page._browserWindowId === windowId);
}
context(): BrowserContext {