Function captureScreenshot

core/util/runPuppet.js:386–463

(page, browser, selector, selectorMap, config, selectors, viewport, logger)

}

async function captureScreenshot (page, browser, selector, selectorMap, config, selectors, viewport, logger) {
  let filePath, logFilePath;
  const fullPage = (selector === NOCLIP_SELECTOR || selector === DOCUMENT_SELECTOR);
  if (selector) {
    filePath = selectorMap[selector].filePath;
    logFilePath = selectorMap[selector].logFilePath;
    ensureDirectoryPath(filePath); // logs in same dir

    try {
      await page.screenshot({
        path: filePath,
        fullPage
      });
      await writeScenarioLogs(config, logFilePath, logger);
    } catch (e) {
      logger.log('red', 'Error capturing..', e);
      await writeScenarioLogs(config, logFilePath, logger);
      return fs.copy(config.env.backstop + ERROR_SELECTOR_PATH, filePath);
    }
  } else {
    // OTHER-SELECTOR screenshot
    const selectorShot = async (s, path, logFilePath) => {
      const el = await page.$(s);
      if (el) {
        const box = await el.boundingBox();
        if (box) {
          // Resize the viewport to screenshot elements outside of the viewport
          if (config.useBoundingBoxViewportForSelectors !== false) {
            const bodyHandle = await page.$('body');
            const boundingBox = await bodyHandle.boundingBox();

            await page.setViewport({
              width: Math.max(viewport.width, Math.ceil(boundingBox.width)),
              height: Math.max(viewport.height, Math.ceil(boundingBox.height))
            });
          }

          const type = config.puppeteerOffscreenCaptureFix ? page : el;
          const params = config.puppeteerOffscreenCaptureFix
            ? {
                captureBeyondViewport: false,
                path,
                clip: box
              }
            : { captureBeyondViewport: false, path };

          await type.screenshot(params);
          await writeScenarioLogs(config, logFilePath, logger);
        } else {
          logger.log('yellow', `Element not visible for capturing: ${s}`);
          await writeScenarioLogs(config, logFilePath, logger);
          return fs.copy(config.env.backstop + HIDDEN_SELECTOR_PATH, path);
        }
      } else {
        logger.log('magenta', `Element not found for capturing: ${s}`);
        await writeScenarioLogs(config, logFilePath, logger);
        return fs.copy(config.env.backstop + SELECTOR_NOT_FOUND_PATH, path);
      }