Skip to content

chore: no pw:api logs from internal playwright instance #39747

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.

Sign up for GitHub

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

Open
dgozman wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −6
Open

chore: no pw:api logs from internal playwright instance #39747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions packages/playwright-core/src/server/frames.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ import { isAbortError, ProgressController } from './progress';
import * as types from './types';
import { LongStandingScope, asLocator, assert, constructURLBasedOnBaseURL, makeWaitForNextTask, renderTitleForCall } from '../utils';
import { isSessionClosedError } from './protocolError';
import { debugLogger } from './utils/debugLogger';
import { eventsHelper } from './utils/eventsHelper';
import { isInvalidSelectorError } from '../utils/isomorphic/selectorParser';
import { ManualPromise } from '../utils/isomorphic/manualPromise';
Expand Down Expand Up @@ -244,7 +243,7 @@ export class FrameManager {
const navigationEvent: NavigationEvent = { url, name, newDocument: frame._currentDocument, isPublic: true };
this._fireInternalFrameNavigation(frame, navigationEvent);
if (!initial) {
debugLogger.log('api', ` navigated to "${url}"`);
frame.apiLog(` navigated to "${url}"`);
this._page.frameNavigatedToNewDocument(frame);
}
// Restore pending if any - see comments above about keepPending.
Expand All @@ -263,7 +262,7 @@ export class FrameManager {
frame._url = url;
const navigationEvent: NavigationEvent = { url, name: frame._name, isPublic: true };
this._fireInternalFrameNavigation(frame, navigationEvent);
debugLogger.log('api', ` navigated to "${url}"`);
frame.apiLog(` navigated to "${url}"`);
}

frameAbortedNavigation(frameId: string, errorText: string, documentId?: string) {
Expand Down Expand Up @@ -509,7 +508,7 @@ export class Frame extends SdkObject<FrameEventMap> {
this._firedLifecycleEvents.add(event);
this.emit(Frame.Events.AddLifecycle, event);
if (this === this._page.mainFrame() && this._url !== 'about:blank')
debugLogger.log('api', ` "${event}" event fired`);
this.apiLog(` "${event}" event fired`);
this._page.mainFrame()._recalculateNetworkIdle();
}

Expand Down Expand Up @@ -592,7 +591,7 @@ export class Frame extends SdkObject<FrameEventMap> {
this._firedLifecycleEvents.add('networkidle');
this.emit(Frame.Events.AddLifecycle, 'networkidle');
if (this === this._page.mainFrame() && this._url !== 'about:blank')
debugLogger.log('api', ` "networkidle" event fired`);
this.apiLog(` "networkidle" event fired`);
}
if (frameThatAllowsRemovingNetworkIdle !== this && this._firedLifecycleEvents.has('networkidle') && !isNetworkIdle) {
// Usually, networkidle is fired once and not removed after that.
Expand Down Expand Up @@ -755,7 +754,7 @@ export class Frame extends SdkObject<FrameEventMap> {
}

async querySelector(selector: string, options: types.StrictOptions): Promise<dom.ElementHandle<Element> | null> {
debugLogger.log('api', ` finding element using the selector "${selector}"`);
this.apiLog(` finding element using the selector "${selector}"`);
return this.selectors.query(selector, options);
}

Expand Down
6 changes: 6 additions & 0 deletions packages/playwright-core/src/server/instrumentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import { EventEmitter } from 'events';

import { createGuid } from './utils/crypto';
import { debugLogger } from './utils/debugLogger';

import type { Browser } from './browser';
import type { BrowserContext } from './browserContext';
Expand Down Expand Up @@ -57,6 +58,11 @@ export class SdkObject<EM extends EventMap = EventMap> extends EventEmitter<EM>
this.instrumentation = parent.instrumentation;
}

apiLog(message: string) {
if (!this.attribution.playwright.options.isInternalPlaywright)
debugLogger.log('api', message);
}

closeReason(): string | undefined {
return this.attribution.page?._closeReason ||
this.attribution.context?._closeReason ||
Expand Down
2 changes: 2 additions & 0 deletions packages/playwright-core/src/server/progress.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ export class ProgressController {
static createForSdkObject(sdkObject: SdkObject, callMetadata: CallMetadata) {
const logName = sdkObject.logName || 'api';
return new ProgressController(callMetadata, message => {
if (logName === 'api' && sdkObject.attribution.playwright.options.isInternalPlaywright)
return;
debugLogger.log(logName, message);
sdkObject.instrumentation.onCallLog(sdkObject, callMetadata, logName, message);
});
Expand Down
Loading