mirror of
https://github.com/microsoft/playwright.git
synced 2025-06-26 21:40:17 +00:00
115 lines
3.6 KiB
TypeScript
115 lines
3.6 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 { EventEmitter } from 'events';
|
||
|
import type { Browser } from './browser';
|
||
|
import type { BrowserContext } from './browserContext';
|
||
|
import type { BrowserType } from './browserType';
|
||
|
import type { Frame } from './frames';
|
||
|
import type { Page } from './page';
|
||
|
|
||
|
export type Attribution = {
|
||
|
browserType?: BrowserType;
|
||
|
browser?: Browser;
|
||
|
context?: BrowserContext;
|
||
|
page?: Page;
|
||
|
frame?: Frame;
|
||
|
};
|
||
|
|
||
|
export type CallMetadata = {
|
||
|
type: string;
|
||
|
method: string;
|
||
|
params: any;
|
||
|
stack: string;
|
||
|
};
|
||
|
|
||
|
export class SdkObject extends EventEmitter {
|
||
|
attribution: Attribution;
|
||
|
instrumentation: Instrumentation;
|
||
|
|
||
|
protected constructor(parent: SdkObject) {
|
||
|
super();
|
||
|
this.setMaxListeners(0);
|
||
|
this.attribution = { ...parent.attribution };
|
||
|
this.instrumentation = parent.instrumentation;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
export type ActionResult = {
|
||
|
logs: string[],
|
||
|
startTime: number,
|
||
|
endTime: number,
|
||
|
error?: Error,
|
||
|
};
|
||
|
|
||
|
export interface Instrumentation {
|
||
|
onContextCreated(context: BrowserContext): Promise<void>;
|
||
|
onContextWillDestroy(context: BrowserContext): Promise<void>;
|
||
|
onContextDidDestroy(context: BrowserContext): Promise<void>;
|
||
|
onActionCheckpoint(name: string, sdkObject: SdkObject, metadata: CallMetadata): Promise<void>;
|
||
|
onAfterAction(result: ActionResult, sdkObject: SdkObject, metadata: CallMetadata): Promise<void>;
|
||
|
}
|
||
|
|
||
|
export interface InstrumentationListener {
|
||
|
onContextCreated?(context: BrowserContext): Promise<void>;
|
||
|
onContextWillDestroy?(context: BrowserContext): Promise<void>;
|
||
|
onContextDidDestroy?(context: BrowserContext): Promise<void>;
|
||
|
onActionCheckpoint?(name: string, sdkObject: SdkObject, metadata: CallMetadata): Promise<void>;
|
||
|
onAfterAction?(result: ActionResult, sdkObject: SdkObject, metadata: CallMetadata): Promise<void>;
|
||
|
}
|
||
|
|
||
|
export class InstrumentationMultiplexer implements Instrumentation {
|
||
|
private _listeners: InstrumentationListener[];
|
||
|
|
||
|
constructor(listeners: InstrumentationListener[]) {
|
||
|
this._listeners = listeners;
|
||
|
}
|
||
|
|
||
|
async onContextCreated(context: BrowserContext): Promise<void> {
|
||
|
for (const listener of this._listeners)
|
||
|
await listener.onContextCreated?.(context);
|
||
|
}
|
||
|
|
||
|
async onContextWillDestroy(context: BrowserContext): Promise<void> {
|
||
|
for (const listener of this._listeners)
|
||
|
await listener.onContextWillDestroy?.(context);
|
||
|
}
|
||
|
|
||
|
async onContextDidDestroy(context: BrowserContext): Promise<void> {
|
||
|
for (const listener of this._listeners)
|
||
|
await listener.onContextDidDestroy?.(context);
|
||
|
}
|
||
|
|
||
|
async onActionCheckpoint(name: string, sdkObject: SdkObject, metadata: CallMetadata): Promise<void> {
|
||
|
for (const listener of this._listeners)
|
||
|
await listener.onActionCheckpoint?.(name, sdkObject, metadata);
|
||
|
}
|
||
|
|
||
|
async onAfterAction(result: ActionResult, sdkObject: SdkObject, metadata: CallMetadata): Promise<void> {
|
||
|
for (const listener of this._listeners)
|
||
|
await listener.onAfterAction?.(result, sdkObject, metadata);
|
||
|
}
|
||
|
}
|
||
|
|
||
|
export function internalCallMetadata(): CallMetadata {
|
||
|
return {
|
||
|
type: 'Internal',
|
||
|
method: '',
|
||
|
params: {},
|
||
|
stack: ''
|
||
|
};
|
||
|
}
|