element-web/helpers.js

/*
Copyright 2018 New Vector Ltd

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.
*/

// puppeteer helpers

// TODO: rename to queryAndInnertext?
async function tryGetInnertext(page, selector) {
  const field = await page.$(selector);
  if (field != null) {
    const text_handle = await field.getProperty('innerText');
    return await text_handle.jsonValue();
  }
  return null;
}

async function innerText(page, field) {
  const text_handle = await field.getProperty('innerText');
  return await text_handle.jsonValue();
}

async function newPage() {
  const page = await browser.newPage();
  await page.setViewport({
    width: 1280,
    height: 800
  });
  return page;
}

function logConsole(page) {
  let buffer = "";
  page.on('console', msg => {
    buffer += msg.text() + '\n';
  });
  return {
    logs() {
      return buffer;
    }
  }
}

function logXHRRequests(page) {
  let buffer = "";
  page.on('request', req => {
    const type = req.resourceType();
    if (type === 'xhr' || type === 'fetch') {
      buffer += `${req.method()} ${req.url()} \n`;
      if (req.method() === "POST") {
        buffer += "  Post data: " + req.postData();
      }
    }
  });
  return {
    logs() {
      return buffer;
    }
  }
}

async function getOuterHTML(element_handle) {
  const html_handle = await element_handle.getProperty('outerHTML');
  return await html_handle.jsonValue();
}

async function printElements(label, elements) {
  console.log(label, await Promise.all(elements.map(getOuterHTML)));
}

async function replaceInputText(input, text) {
  // click 3 times to select all text
  await input.click({clickCount: 3});
  // then remove it with backspace
  await input.press('Backspace');
  // and type the new text
  await input.type(text);
}

// TODO: rename to waitAndQuery(Single)?
async function waitAndQuerySelector(page, selector, timeout = 500) {
  await page.waitForSelector(selector, {visible: true, timeout});
  return await page.$(selector);
}

async function waitAndQueryAll(page, selector, timeout = 500) {
  await page.waitForSelector(selector, {visible: true, timeout});
  return await page.$$(selector);
}

function waitForNewPage(timeout = 500) {
  return new Promise((resolve, reject) => {
    const timeoutHandle = setTimeout(() => {
      browser.removeEventListener('targetcreated', callback);
      reject(new Error(`timeout of ${timeout}ms for waitForNewPage elapsed`));
    }, timeout);

    const callback = async (target) => {
      clearTimeout(timeoutHandle);
      const page = await target.page();
      resolve(page);
    };

    browser.once('targetcreated', callback);
  });
} 

// other helpers

function randomInt(max) {
  return Math.ceil(Math.random()*max);
}

function riotUrl(path) {
  return riotserver + path;
}

function delay(ms) {
  return new Promise(resolve => setTimeout(resolve, ms));
}

module.exports = {
  tryGetInnertext,
  innerText,
  newPage,
  logConsole,
  logXHRRequests,
  getOuterHTML,
  printElements,
  replaceInputText,
  waitAndQuerySelector,
  waitAndQueryAll,
  waitForNewPage,
  randomInt,
  riotUrl,
  delay,
}