mirror of
https://github.com/microsoft/playwright.git
synced 2025-06-26 21:40:17 +00:00
bc27ca225e
Retaining traces in the following scenarios: - browser crash; - manual `browser.close()`; - implicit `browser.close()` from the `browser` fixture upon test end. This does not affect the library, where `browser.close()` will not retain the trace and will close the browser as fast as possible. References #31541, #31535, #31537.
77 lines
3.2 KiB
TypeScript
77 lines
3.2 KiB
TypeScript
/**
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import type { StackFrame } from '@protocol/channels';
|
|
import type { Browser } from './browser';
|
|
import type { BrowserContext } from './browserContext';
|
|
import type { APIRequestContext } from './fetch';
|
|
|
|
export interface ClientInstrumentation {
|
|
addListener(listener: ClientInstrumentationListener): void;
|
|
removeListener(listener: ClientInstrumentationListener): void;
|
|
removeAllListeners(): void;
|
|
onApiCallBegin(apiCall: string, params: Record<string, any>, frames: StackFrame[], userData: any, out: { stepId?: string }): void;
|
|
onApiCallEnd(userData: any, error?: Error): void;
|
|
onWillPause(): void;
|
|
|
|
runAfterCreateBrowserContext(context: BrowserContext): Promise<void>;
|
|
runAfterCreateRequestContext(context: APIRequestContext): Promise<void>;
|
|
runBeforeCloseBrowserContext(context: BrowserContext): Promise<void>;
|
|
runBeforeCloseRequestContext(context: APIRequestContext): Promise<void>;
|
|
runBeforeCloseBrowser(browser: Browser): Promise<void>;
|
|
}
|
|
|
|
export interface ClientInstrumentationListener {
|
|
onApiCallBegin?(apiName: string, params: Record<string, any>, frames: StackFrame[], userData: any, out: { stepId?: string }): void;
|
|
onApiCallEnd?(userData: any, error?: Error): void;
|
|
onWillPause?(): void;
|
|
|
|
runAfterCreateBrowserContext?(context: BrowserContext): Promise<void>;
|
|
runAfterCreateRequestContext?(context: APIRequestContext): Promise<void>;
|
|
runBeforeCloseBrowserContext?(context: BrowserContext): Promise<void>;
|
|
runBeforeCloseRequestContext?(context: APIRequestContext): Promise<void>;
|
|
runBeforeCloseBrowser?(browser: Browser): Promise<void>;
|
|
}
|
|
|
|
export function createInstrumentation(): ClientInstrumentation {
|
|
const listeners: ClientInstrumentationListener[] = [];
|
|
return new Proxy({}, {
|
|
get: (obj: any, prop: string | symbol) => {
|
|
if (typeof prop !== 'string')
|
|
return obj[prop];
|
|
if (prop === 'addListener')
|
|
return (listener: ClientInstrumentationListener) => listeners.push(listener);
|
|
if (prop === 'removeListener')
|
|
return (listener: ClientInstrumentationListener) => listeners.splice(listeners.indexOf(listener), 1);
|
|
if (prop === 'removeAllListeners')
|
|
return () => listeners.splice(0, listeners.length);
|
|
if (prop.startsWith('run')) {
|
|
return async (...params: any[]) => {
|
|
for (const listener of listeners)
|
|
await (listener as any)[prop]?.(...params);
|
|
};
|
|
}
|
|
if (prop.startsWith('on')) {
|
|
return (...params: any[]) => {
|
|
for (const listener of listeners)
|
|
(listener as any)[prop]?.(...params);
|
|
};
|
|
}
|
|
return obj[prop];
|
|
},
|
|
});
|
|
}
|