Class PageWrapper

test/e2e/shared/page-wrapper.ts:34–512

    ElementType extends null ? puppeteer.NodeFor<Selector>: ElementType;

export class PageWrapper {
  page: puppeteer.Page;
  evaluate: puppeteer.Page['evaluate'];
  waitForNavigation: puppeteer.Page['waitForNavigation'];
  bringToFront: puppeteer.Page['bringToFront'];
  evaluateOnNewDocument: puppeteer.Page['evaluateOnNewDocument'];
  removeScriptToEvaluateOnNewDocument: puppeteer.Page['removeScriptToEvaluateOnNewDocument'];
  locator: puppeteer.Page['locator'];

  constructor(page: puppeteer.Page) {
    this.page = page;
    this.evaluate = page.evaluate.bind(page);
    this.bringToFront = page.bringToFront.bind(page);
    this.evaluateOnNewDocument = page.evaluateOnNewDocument.bind(page);
    this.removeScriptToEvaluateOnNewDocument = page.removeScriptToEvaluateOnNewDocument.bind(page);
    this.waitForNavigation = page.waitForNavigation.bind(page);
    this.locator = page.locator.bind(page);
  }

  /**
   * `waitForFunction` runs in the test context and not in the page
   * context. If you want to evaluate code on the page, use
   * {@link PageWrapper.evaluate} within the `waitForFunction` callback.
   */
  async waitForFunction<T>(
      fn: (logger: Logger) => T | undefined | Promise<T|undefined>, asyncScope = new AsyncScope(),
      description?: string) {
    const signal = AsyncScope.abortSignal;
    const innerFunction = async (messages: string[]) => {
      let iterations = 0;
      const logger = {log: messages.push.bind(messages)};
      while (true) {
        signal?.throwIfAborted();
        const messagesBefore = messages.length;
        const result = await fn(logger);
        // On completing an iteration, remove any leftover messages from the previous iteration.
        messages.splice(0, messagesBefore);
        messages.push(`Iteration ${iterations++} result: ${result ? 'success' : `${result}`}`);
        signal?.throwIfAborted();
        if (result) {
          return result as Exclude<NonNullable<T>, false>;
        }
        await this.timeout(100);
      }
    };
    return await asyncScope.exec(innerFunction, description);
  }

  timeout(duration: number) {
    return new Promise<void>(resolve => setTimeout(resolve, duration));
  }

  async screenshot(): Promise<string> {
    await this.bringToFront();
    return await this.page.screenshot({
      encoding: 'base64',
    });
  }