Skip to content

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

2.0 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 { isTargetClosedError } from './errors';
import { kNoTimeout } from './timeoutSettings';

import type * as channels from './channels';

export interface Disposable {
  dispose: () => Promise<void>;
}

export class DisposableObject<T extends channels.DisposableChannel = channels.DisposableChannel> extends ChannelOwner<T> implements Disposable {
  static from(channel: channels.DisposableChannel): DisposableObject {
    return (channel as any)._object;
  }

  async [Symbol.asyncDispose]() {
    await this.dispose();
  }

  async dispose() {
    try {
      await this._channel.dispose({}, kNoTimeout);
    } catch (e) {
      if (isTargetClosedError(e))
        return;
      throw e;
    }
  }
}

export class DisposableStub implements Disposable {
  private _dispose: (() => Promise<void>) | undefined;

  constructor(dispose: () => Promise<void>) {
    this._dispose = dispose;
  }

  async [Symbol.asyncDispose]() {
    await this.dispose();
  }

  async dispose() {
    if (!this._dispose)
      return;
    try {
      const dispose = this._dispose;
      this._dispose = undefined;
      await dispose();
    } catch (e) {
      if (isTargetClosedError(e))
        return;
      throw e;
    }
  }
}

export async function disposeAll(disposables: Disposable[]) {
  const copy = [...disposables];
  disposables.length = 0;
  await Promise.all(copy.map(d => d.dispose()));
}