Skip to content

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

2.5 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 { kNoTimeout } from './timeoutSettings';
import type { BrowserContext } from './browserContext';
import type * as api from '../../types/types';

export class Clock implements api.Clock {
  private _browserContext: BrowserContext;

  constructor(browserContext: BrowserContext) {
    this._browserContext = browserContext;
  }

  async install(options: { time?: number | string | Date } = { }) {
    await this._browserContext._channel.clockInstall({ ...(options.time !== undefined ? parseTime(options.time) : {}) }, kNoTimeout);
  }

  async fastForward(ticks: number | string) {
    await this._browserContext._channel.clockFastForward({ ...parseTicks(ticks) }, kNoTimeout);
  }

  async pauseAt(time: number | string | Date) {
    await this._browserContext._channel.clockPauseAt({ ...parseTime(time) }, kNoTimeout);
  }

  async resume() {
    await this._browserContext._channel.clockResume({}, kNoTimeout);
  }

  async runFor(ticks: number | string) {
    await this._browserContext._channel.clockRunFor({ ...parseTicks(ticks) }, kNoTimeout);
  }

  async setFixedTime(time: string | number | Date) {
    await this._browserContext._channel.clockSetFixedTime({ ...parseTime(time) }, kNoTimeout);
  }

  async setSystemTime(time: string | number | Date) {
    await this._browserContext._channel.clockSetSystemTime({ ...parseTime(time) }, kNoTimeout);
  }
}

function parseTime(time: string | number | Date): { timeNumber?: number, timeString?: string } {
  if (typeof time === 'number')
    return { timeNumber: time };
  if (typeof time === 'string')
    return { timeString: time };
  if (!isFinite(time.getTime()))
    throw new Error(`Invalid date: ${time}`);
  return { timeNumber: time.getTime() };
}

function parseTicks(ticks: string | number): { ticksNumber?: number, ticksString?: string } {
  return {
    ticksNumber: typeof ticks === 'number' ? ticks : undefined,
    ticksString: typeof ticks === 'string' ? ticks : undefined
  };
}