Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

2.1 KB
Raw Blame
/**
 * 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 { ChannelOwner } from './channelOwner';
import { kNoTimeout } from './timeoutSettings';

import type * as api from '../../types/types';
import type { Protocol } from '../server/chromium/protocol';
import type * as channels from './channels';

export class CDPSession extends ChannelOwner<channels.CDPSessionChannel> implements api.CDPSession {
  static from(cdpSession: channels.CDPSessionChannel): CDPSession {
    return (cdpSession as any)._object;
  }

  constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.CDPSessionInitializer) {
    super(parent, type, guid, initializer);

    this._channel.on('event', event => {
      this.emit(event.method, event.params);
      this.emit('event', event);
    });

    this._channel.on('close', () => {
      this.emit('close', this);
    });

    this.on = super.on;
    this.addListener = super.addListener;
    this.off = super.removeListener;
    this.removeListener = super.removeListener;
    this.once = super.once;
  }

  async send<T extends keyof Protocol.CommandParameters>(
    method: T,
    params?: Protocol.CommandParameters[T],
    options: { timeout?: number, signal?: AbortSignal } = {}
  ): Promise<Protocol.CommandReturnValues[T]> {
    const result = await this._channel.send({ method, params }, { signal: options.signal, timeout: options.timeout ?? 0 });
    return result.result as Protocol.CommandReturnValues[T];
  }

  async detach() {
    return await this._channel.detach({}, kNoTimeout);
  }
}