/** * 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 { assert } from '../../utils'; import type { ConnectionTransport, ProtocolRequest, ProtocolResponse } from '../transport'; import type { Protocol } from './protocol'; import { EventEmitter } from 'events'; import { rewriteErrorMessage } from '../../utils/stackTrace'; import type { RecentLogsCollector } from '../../common/debugLogger'; import { debugLogger } from '../../common/debugLogger'; import type { ProtocolLogger } from '../types'; import { helper } from '../helper'; import { ProtocolError } from '../protocolError'; 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() { this._closed = true; this._transport.onmessage = undefined; this._transport.onclose = undefined; this._browserDisconnectedLogs = helper.formatBrowserLogs(this._browserLogsCollector.recentLogs()); 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 this.rootSession.createChildSession(sessionId); } } export const CRSessionEvents = { Disconnected: Symbol('Events.CDPSession.Disconnected') }; export class CRSession extends EventEmitter { private readonly _connection: CRConnection; _eventListener?: (method: string, params?: Object) => void; private readonly _callbacks = new Map void, reject: (e: ProtocolError) => void, error: ProtocolError, method: string}>(); 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; readonly guid: string; constructor(connection: CRConnection, parentSession: CRSession | null, sessionId: string) { super(); this.guid = `cdp-session@${sessionId}`; this.setMaxListeners(0); this._connection = connection; this._parentSession = parentSession; this._sessionId = sessionId; 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): CRSession { const session = new CRSession(this._connection, this, sessionId); this._connection._sessions.set(sessionId, session); return session; } private _closedErrorMessage() { if (this._crashed) return 'Target crashed'; if (this._connection._browserDisconnectedLogs !== undefined) return `Browser closed.` + this._connection._browserDisconnectedLogs; if (this._closed) return `Target closed`; } async send( method: T, params?: Protocol.CommandParameters[T] ): Promise { const closedErrorMessage = this._closedErrorMessage(); if (closedErrorMessage) throw new ProtocolError(true, closedErrorMessage); const id = this._connection._rawSend(this._sessionId, method, params); return new Promise((resolve, reject) => { this._callbacks.set(id, { resolve, reject, error: new ProtocolError(false), 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.reject(createProtocolError(callback.error, callback.method, object.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'); await this._parentSession.send('Target.detachFromTarget', { sessionId: this._sessionId }); this.dispose(); } dispose() { this._closed = true; this._connection._sessions.delete(this._sessionId); const errorMessage = this._closedErrorMessage()!; for (const callback of this._callbacks.values()) { callback.error.sessionClosed = true; callback.reject(rewriteErrorMessage(callback.error, errorMessage)); } this._callbacks.clear(); Promise.resolve().then(() => this.emit(CRSessionEvents.Disconnected)); } } function createProtocolError(error: ProtocolError, method: string, protocolError: { message: string; data: any; }): ProtocolError { let message = `Protocol error (${method}): ${protocolError.message}`; if ('data' in protocolError) message += ` ${protocolError.data}`; return rewriteErrorMessage(error, message); }