From edd437907899a3686c4779efdb269d3c2ff6d0ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rene=CC=81?= Date: Sun, 13 Oct 2024 22:13:14 +0200 Subject: [PATCH] working proto MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: ReneĢ --- .../playwright-core/src/client/tracing.ts | 8 +++++ .../playwright-core/src/protocol/validator.ts | 10 ++++++ .../server/dispatchers/tracingDispatcher.ts | 14 ++++++++ .../src/server/trace/recorder/tracing.ts | 32 +++++++++++++++++++ packages/protocol/src/channels.ts | 17 ++++++++++ packages/protocol/src/protocol.yml | 12 +++++++ 6 files changed, 93 insertions(+) diff --git a/packages/playwright-core/src/client/tracing.ts b/packages/playwright-core/src/client/tracing.ts index b5c411cc65..9692943f6a 100644 --- a/packages/playwright-core/src/client/tracing.ts +++ b/packages/playwright-core/src/client/tracing.ts @@ -51,6 +51,14 @@ export class Tracing extends ChannelOwner implements ap await this._startCollectingStacks(traceName); } + async group(name: string, options: { location?: string } = {}) { + await this._channel.tracingGroup({ name, options }); + } + + async groupEnd() { + await this._channel.tracingGroupEnd(); + } + private async _startCollectingStacks(traceName: string) { if (!this._isTracing) { this._isTracing = true; diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts index 24ddf0014c..0453a43481 100644 --- a/packages/playwright-core/src/protocol/validator.ts +++ b/packages/playwright-core/src/protocol/validator.ts @@ -2280,6 +2280,9 @@ scheme.DialogAcceptParams = tObject({ scheme.DialogAcceptResult = tOptional(tObject({})); scheme.DialogDismissParams = tOptional(tObject({})); scheme.DialogDismissResult = tOptional(tObject({})); +scheme.TracingGroupOptions = tObject({ + location: tString, +}); scheme.TracingInitializer = tOptional(tObject({})); scheme.TracingTracingStartParams = tObject({ name: tOptional(tString), @@ -2295,6 +2298,13 @@ scheme.TracingTracingStartChunkParams = tObject({ scheme.TracingTracingStartChunkResult = tObject({ traceName: tString, }); +scheme.TracingTracingGroupParams = tObject({ + name: tString, + options: tType('TracingGroupOptions'), +}); +scheme.TracingTracingGroupResult = tOptional(tObject({})); +scheme.TracingTracingGroupEndParams = tOptional(tObject({})); +scheme.TracingTracingGroupEndResult = tOptional(tObject({})); scheme.TracingTracingStopChunkParams = tObject({ mode: tEnum(['archive', 'discard', 'entries']), }); diff --git a/packages/playwright-core/src/server/dispatchers/tracingDispatcher.ts b/packages/playwright-core/src/server/dispatchers/tracingDispatcher.ts index b8214fbe31..0a1e39aa68 100644 --- a/packages/playwright-core/src/server/dispatchers/tracingDispatcher.ts +++ b/packages/playwright-core/src/server/dispatchers/tracingDispatcher.ts @@ -33,14 +33,28 @@ export class TracingDispatcher extends Dispatcher { await this._object.start(params); } + // async startChunk(options: { name?: string, title?: string } = {}): Promise<{ traceName: string }> { async tracingStartChunk(params: channels.TracingTracingStartChunkParams): Promise { return await this._object.startChunk(params); } + + // async group(name: string, options: { location?: string } = {}): Promise { + async tracingGroup(params: channels.TracingTracingGroupParams): Promise { + const { name, options } = params; + await this._object.group(name, options); + } + + // async groupEnd(): Promise { + async tracingGroupEnd(params: channels.TracingTracingGroupEndParams): Promise { + await this._object.groupEnd(); + } + async tracingStopChunk(params: channels.TracingTracingStopChunkParams): Promise { const { artifact, entries } = await this._object.stopChunk(params); return { artifact: artifact ? ArtifactDispatcher.from(this, artifact) : undefined, entries }; diff --git a/packages/playwright-core/src/server/trace/recorder/tracing.ts b/packages/playwright-core/src/server/trace/recorder/tracing.ts index 97476d4b31..9e8e5fd642 100644 --- a/packages/playwright-core/src/server/trace/recorder/tracing.ts +++ b/packages/playwright-core/src/server/trace/recorder/tracing.ts @@ -80,6 +80,8 @@ export class Tracing extends SdkObject implements InstrumentationListener, Snaps private _allResources = new Set(); private _contextCreatedEvent: trace.ContextCreatedTraceEvent; private _pendingHarEntries = new Set(); + private _groupStack: string[] = []; + private _groupId = 0; constructor(context: BrowserContext | APIRequestContext, tracesDir: string | undefined) { super(context, 'tracing'); @@ -194,6 +196,34 @@ export class Tracing extends SdkObject implements InstrumentationListener, Snaps return { traceName: this._state.traceName }; } + async group(name: string, options: { location?: string } = {}): Promise { + const location = options.location?.split(':', 2); + const file = location?.[0], line = location?.[1]; + const event: trace.BeforeActionTraceEvent = { + type: 'before', + callId: `group-${this._groupId++}`, + startTime: monotonicTime(), + apiName: name, + class: 'Tracing', + method: 'group', + params: { }, + stack: [{ file: file || '', line: line ? parseInt(line, 10) : 0, column: 0 }], + }; + this._groupStack.push(event.callId); + this._appendTraceEvent(event); + } + + async groupEnd(): Promise { + const callId = this._groupStack.pop(); + assert(callId, 'Cannot end group that has not started'); + const event: trace.AfterActionTraceEvent = { + type: 'after', + callId, + endTime: monotonicTime(), + }; + this._appendTraceEvent(event); + } + private _startScreencast() { if (!(this._context instanceof BrowserContext)) return; @@ -357,6 +387,8 @@ export class Tracing extends SdkObject implements InstrumentationListener, Snaps const event = createBeforeActionTraceEvent(metadata); if (!event) return Promise.resolve(); + if (event.parentId === undefined && this._groupStack.length) + event.parentId = this._groupStack[this._groupStack.length - 1]; sdkObject.attribution.page?.temporarilyDisableTracingScreencastThrottling(); event.beforeSnapshot = `before@${metadata.id}`; this._state?.callIds.add(metadata.id); diff --git a/packages/protocol/src/channels.ts b/packages/protocol/src/channels.ts index 5ecc2f4077..9308c74261 100644 --- a/packages/protocol/src/channels.ts +++ b/packages/protocol/src/channels.ts @@ -4077,6 +4077,10 @@ export type DialogDismissResult = void; export interface DialogEvents { } +export type TracingGroupOptions = { + location: string, +}; + // ----------- Tracing ----------- export type TracingInitializer = {}; export interface TracingEventTarget { @@ -4085,6 +4089,8 @@ export interface TracingChannel extends TracingEventTarget, Channel { _type_Tracing: boolean; tracingStart(params: TracingTracingStartParams, metadata?: CallMetadata): Promise; tracingStartChunk(params: TracingTracingStartChunkParams, metadata?: CallMetadata): Promise; + tracingGroup(params: TracingTracingGroupParams, metadata?: CallMetadata): Promise; + tracingGroupEnd(params?: TracingTracingGroupEndParams, metadata?: CallMetadata): Promise; tracingStopChunk(params: TracingTracingStopChunkParams, metadata?: CallMetadata): Promise; tracingStop(params?: TracingTracingStopParams, metadata?: CallMetadata): Promise; } @@ -4112,6 +4118,17 @@ export type TracingTracingStartChunkOptions = { export type TracingTracingStartChunkResult = { traceName: string, }; +export type TracingTracingGroupParams = { + name: string, + options: TracingGroupOptions, +}; +export type TracingTracingGroupOptions = { + +}; +export type TracingTracingGroupResult = void; +export type TracingTracingGroupEndParams = {}; +export type TracingTracingGroupEndOptions = {}; +export type TracingTracingGroupEndResult = void; export type TracingTracingStopChunkParams = { mode: 'archive' | 'discard' | 'entries', }; diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml index c91cecbe6c..b722401dd3 100644 --- a/packages/protocol/src/protocol.yml +++ b/packages/protocol/src/protocol.yml @@ -3177,6 +3177,11 @@ Dialog: dismiss: +TracingGroupOptions: + type: object + properties: + location: string + Tracing: type: interface @@ -3196,6 +3201,13 @@ Tracing: returns: traceName: string + tracingGroup: + parameters: + name: string + options: TracingGroupOptions + + tracingGroupEnd: + tracingStopChunk: parameters: mode: