/** * Copyright 2017 Google Inc. All rights reserved. * Modifications copyright (c) Microsoft Corporation. * * 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 { assert, eventsHelper } from '../../utils'; import { debugLogger } from '../utils/debugLogger'; import { helper } from '../helper'; import { ProtocolError } from '../protocolError'; import type { RegisteredListener } from '../../utils'; import type { ConnectionTransport, ProtocolRequest, ProtocolResponse } from '../transport'; import type { Protocol } from './protocol'; import type { RecentLogsCollector } from '../utils/debugLogger'; import type { ProtocolLogger } from '../types'; export const ConnectionEvents = { Disconnected: Symbol('ConnectionEvents.Disconnected') }; // CRPlaywright uses this special id to issue Browser.close command which we // should ignore. export const kBrowserCloseMessageId = -9999; export class CRConnection extends EventEmitter { private _lastId = 0; private readonly _transport: ConnectionTransport; readonly _sessions = new Map(); private readonly _protocolLogger: ProtocolLogger; private readonly _browserLogsCollector: RecentLogsCollector; _browserDisconnectedLogs: string | undefined; readonly rootSession: CRSession; _closed = false; constructor(transport: ConnectionTransport, protocolLogger: ProtocolLogger, browserLogsCollector: RecentLogsCollector) { super(); this.setMaxListeners(0); this._transport = transport; this._protocolLogger = protocolLogger; this._browserLogsCollector = browserLogsCollector; this.rootSession = new CRSession(this, null, ''); this._sessions.set('', this.rootSession); this._transport.onmessage = this._onMessage.bind(this); // onclose should be set last, since it can be immediately called. this._transport.onclose = this._onClose.bind(this); } _rawSend(sessionId: string, method: string, params: any): number { const id = ++this._lastId; const message: ProtocolRequest = { id, method, params }; if (sessionId) message.sessionId = sessionId; this._protocolLogger('send', message); this._transport.send(message); return id; } async _onMessage(message: ProtocolResponse) { this._protocolLogger('receive', message); if (message.id === kBrowserCloseMessageId) return; const session = this._sessions.get(message.sessionId || ''); if (session) session._onMessage(message); } _onClose(reason?: string) { this._closed = true; this._transport.onmessage = undefined; this._transport.onclose = undefined; this._browserDisconnectedLogs = helper.formatBrowserLogs(this._browserLogsCollector.recentLogs(), reason); this.rootSession.dispose(); Promise.resolve().then(() => this.emit(ConnectionEvents.Disconnected)); } close() { if (!this._closed) this._transport.close(); } async createBrowserSession(): Promise { const { sessionId } = await this.rootSession.send('Target.attachToBrowserTarget'); return new CDPSession(this.rootSession, sessionId); } } type SessionEventListener = (method: string, params?: Object) => void; export class CRSession extends EventEmitter { private readonly _connection: CRConnection; private _eventListener?: SessionEventListener; private readonly _callbacks = new Map void, reject: (e: ProtocolError) => void, error: ProtocolError }>(); private readonly _sessionId: string; private readonly _parentSession: CRSession | null; private _crashed: boolean = false; private _closed = false; override on: (event: T, listener: (payload: T extends symbol ? any : Protocol.Events[T extends keyof Protocol.Events ? T : never]) => void) => this; override addListener: (event: T, listener: (payload: T extends symbol ? any : Protocol.Events[T extends keyof Protocol.Events ? T : never]) => void) => this; override off: (event: T, listener: (payload: T extends symbol ? any : Protocol.Events[T extends keyof Protocol.Events ? T : never]) => void) => this; override removeListener: (event: T, listener: (payload: T extends symbol ? any : Protocol.Events[T extends keyof Protocol.Events ? T : never]) => void) => this; override once: (event: T, listener: (payload: T extends symbol ? any : Protocol.Events[T extends keyof Protocol.Events ? T : never]) => void) => this; constructor(connection: CRConnection, parentSession: CRSession | null, sessionId: string, eventListener?: SessionEventListener) { super(); this.setMaxListeners(0); this._connection = connection; this._parentSession = parentSession; this._sessionId = sessionId; this._eventListener = eventListener; this.on = super.on; this.addListener = super.addListener; this.off = super.removeListener; this.removeListener = super.removeListener; this.once = super.once; } _markAsCrashed() { this._crashed = true; } createChildSession(sessionId: string, eventListener?: SessionEventListener): CRSession { const session = new CRSession(this._connection, this, sessionId, eventListener); this._connection._sessions.set(sessionId, session); return session; } async send( method: T, params?: Protocol.CommandParameters[T] ): Promise { if (this._crashed || this._closed || this._connection._closed || this._connection._browserDisconnectedLogs) throw new ProtocolError(this._crashed ? 'crashed' : 'closed', undefined, this._connection._browserDisconnectedLogs); const id = this._connection._rawSend(this._sessionId, method, params); return new Promise((resolve, reject) => { this._callbacks.set(id, { resolve, reject, error: new ProtocolError('error', method) }); }); } _sendMayFail(method: T, params?: Protocol.CommandParameters[T]): Promise { return this.send(method, params).catch((error: ProtocolError) => debugLogger.log('error', error)); } _onMessage(object: ProtocolResponse) { if (object.id && this._callbacks.has(object.id)) { const callback = this._callbacks.get(object.id)!; this._callbacks.delete(object.id); if (object.error) { callback.error.setMessage(object.error.message); callback.reject(callback.error); } else { callback.resolve(object.result); } } else if (object.id && object.error?.code === -32001) { // Message to a closed session, just ignore it. } else { assert(!object.id, object?.error?.message || undefined); Promise.resolve().then(() => { if (this._eventListener) this._eventListener(object.method!, object.params); this.emit(object.method!, object.params); }); } } async detach() { if (this._closed) throw new Error(`Session already detached. Most likely the page has been closed.`); if (!this._parentSession) throw new Error('Root session cannot be closed'); // Ideally, detaching should resume any target, but there is a bug in the backend, // so we must Runtime.runIfWaitingForDebugger first. await this._sendMayFail('Runtime.runIfWaitingForDebugger'); await this._parentSession.send('Target.detachFromTarget', { sessionId: this._sessionId }); this.dispose(); } dispose() { this._closed = true; this._connection._sessions.delete(this._sessionId); for (const callback of this._callbacks.values()) { callback.error.setMessage(`Internal server error, session closed.`); callback.error.type = this._crashed ? 'crashed' : 'closed'; callback.error.logs = this._connection._browserDisconnectedLogs; callback.reject(callback.error); } this._callbacks.clear(); } } export class CDPSession extends EventEmitter { static Events = { Event: 'event', Closed: 'close', }; readonly guid: string; private _session: CRSession; private _listeners: RegisteredListener[] = []; constructor(parentSession: CRSession, sessionId: string) { super(); this.guid = `cdp-session@${sessionId}`; this._session = parentSession.createChildSession(sessionId, (method, params) => this.emit(CDPSession.Events.Event, { method, params })); this._listeners = [eventsHelper.addEventListener(parentSession, 'Target.detachedFromTarget', (event: Protocol.Target.detachedFromTargetPayload) => { if (event.sessionId === sessionId) this._onClose(); })]; } async send(method: string, params?: any) { return await this._session.send(method as any, params); } async detach() { return await this._session.detach(); } async attachToTarget(targetId: string) { const { sessionId } = await this.send('Target.attachToTarget', { targetId, flatten: true }); return new CDPSession(this._session, sessionId); } private _onClose() { eventsHelper.removeEventListeners(this._listeners); this._session.dispose(); this.emit(CDPSession.Events.Closed); } }