@cliqz/autoconsent/lib/web/tab.ts

This is a library of rules for navigating through common consent popups on the web. These rules can be run in a Firefox webextension, or in a puppeteer orchestrated headless browser. Using these rules, opt-in and opt-out options can be selected automatica

import { waitFor } from "../cmps/base";
import { TabActor, MessageSender, Browser, FindResult } from "../types";

export default class TabActions implements TabActor {
  id: number;

  constructor(
    tabId: number,
    public url: string,
    public frame: any,
    private sendContentMessage: MessageSender,
    private browser: Browser
  ) {
    this.id = tabId;
  }

  async elementExists(selector, frameId = 0) {
    // console.log(`check for  ${selector} in tab ${this.id}, frame ${frameId}`);
    return this.sendContentMessage(
      this.id,
      {
        type: "elemExists",
        selector
      },
      {
        frameId
      }
    );
  }

  async clickElement(selector, frameId = 0) {
    // console.log(`click element ${selector} in tab ${this.id}`);
    return this.sendContentMessage(
      this.id,
      {
        type: "click",
        selector
      },
      {
        frameId
      }
    );
  }

  async clickElements(selector, frameId = 0) {
    // console.log(`click elements ${selector} in tab ${this.id}`);
    return this.sendContentMessage(
      this.id,
      {
        type: "click",
        all: true,
        selector
      },
      {
        frameId
      }
    );
  }

  async elementsAreVisible(selector, check, frameId = 0) {
    return this.sendContentMessage(
      this.id,
      {
        type: "elemVisible",
        selector,
        check
      },
      {
        frameId
      }
    );
  }

  async getAttribute(selector, attribute, frameId) {
    return this.sendContentMessage(
      this.id,
      {
        type: "getAttribute",
        selector,
        attribute
      },
      { frameId }
    );
  }

  async eval(script, frameId = 0) {
    // console.log(`run ${script} in tab ${this.id}`);
    return await this.sendContentMessage(
      this.id,
      {
        type: "eval",
        script
      },
      { frameId }
    );
  }

  async waitForElement(selector, timeout, frameId = 0) {
    const interval = 200;
    const times = Math.ceil(timeout / interval);
    return waitFor(
      () => this.elementExists(selector, frameId),
      times,
      interval
    );
  }

  async waitForThenClick(selector, timeout, frameId = 0) {
    await this.waitForElement(selector, timeout, frameId);
    await this.clickElement(selector, frameId);
    return true;
  }

  async hideElements(selectors, frameId = 0) {
    return this.sendContentMessage(
      this.id,
      {
        type: "hide",
        selectors
      },
      { frameId }
    );
  }

  async getBrowserTab() {
    return this.browser.tabs.get(this.id);
  }

  async goto(url) {
    return this.browser.tabs.update(this.id, { url });
  }

  wait(ms): Promise<true> {
    return new Promise(resolve => {
      setTimeout(() => resolve(true), ms);
    });
  }

  matches(matcherConfig: any) {
    return this.sendContentMessage(
      this.id,
      {
        type: "matches",
        config: matcherConfig
      },
      { frameId: 0 }
    );
  }

  executeAction(config: any, param?: any): Promise<boolean> {
    return this.sendContentMessage(
      this.id,
      {
        type: "executeAction",
        config,
        param
      },
      { frameId: 0 }
    );
  }
}