/hands-free-chrome

Headless Chrome utilities

Primary LanguageJavaScriptOtherNOASSERTION

Hands-free Chrome

Headless Chrome utilities.

travis build Coverage Status npm version Commitizen friendly

Current included features:

  • capture screenshots of web pages, generating png and/or pdf files
  • resize png screenshots to generate thumbnails
  • run as Microservice using Docker (Dockerfile included)
  • Web API

Prerequisites

Chrome version > 59.x must be installed.

WARNING: due to a known bug of Chrome 59 on macOS closing tabs doesn't work properly on that platform. See API documentation below for more info.

Node.js version > 8.1.0

Quick Start

$ npm install hands-free-chrome

then:

const HandsfreeChrome = require('hands-free-chrome');

let chrome = new HandsfreeChrome();

//capture a screenshot as png
chrome.captureScreenshot('<A VALID WEB PAGE URL>')
  .then(name => console.log(`Created file: ${name}.png`))
  .catch(err => console.log(err));

API

new HandsfreeChrome( [options] )

Constructor.

Instantiate a new HandsFreeChrome.

options is an optional object with the following properties:

  • port - integer, Headless Chrome listening port, default: 9999;
  • autoSelectChrome - boolean, enable/disable autoselection of installed Chrome, default: true (recommended);
  • chromeFlags - array of strings, Headless Chrome configuration, default: ['--disable-gpu', '--headless'];

HandsfreeChrome # captureScreenshot(url, [options])

Capture a screenshot of a web page and create image files.

Params:

  • url - string, a valid web page URL;
  • options - (optional) Object, screenshot configuration, with the following properties:
    • outputType - (optional) string, specifies the output file type, can be: png (default), pdf or both;
    • outputDir - (optional) string, directory path to contain generated screenshots. Default is <cwd>/screenshots;
    • metrics - object, screen metric properties, defaults to DesktopScreenMetrics, see the dedicated section below;
    • thumbnail - (optional) object { width: <px>, height: <px> }, if used produces a resized png of the screenshot of the specified dimensions. It works only if outputType is png.

HandsfreeChrome # captureScreenshotAsStream(url, [options])

Capture a screenshot of a web page and return a data readable stream.

Params:

  • url - string, a valid web page URL;
  • options - (optional) Object, screenshot configuration, with the following properties:
    • outputType - (optional) string, specifies the image file type, can be: png (default) or pdf;
    • metrics - object, screen metric properties, defaults to DesktopScreenMetrics, see the dedicated section below.

HandsfreeChrome # captureScreenshotAsStreamByTab(url, [options])

Capture a screenshot of a web page opening and closing a new browser tab and return a data readable stream.

WARNING: due to a known bug of Chrome 59 on macOS closing tabs doesn't work properly on that platform. To use this method please use Linux or Docker ;)

Params:

  • url - string, a valid web page URL;
  • options - (optional) Object, screenshot configuration, with the following properties:
    • outputType - (optional) string, specifies the image file type, can be: png (default) or pdf;
    • metrics - object, screen metric properties, defaults to DesktopScreenMetrics, see the dedicated section below.

HandsfreeChrome # resizePng(pngStream, [size])

Resize a png image given its stream and a size.

Params:

  • pngStream - Readable image stream;
  • size - (optional) object { width: <px>, height: <px> }, the size of the required thumbnail. If not provided, default is: { width: 320, height: 200 }.

Metrics Object

Metrics Object specifies some configuration options for Headless Chrome, like the browser window size, mobile emulation and so on. See Chrome DevTools Protocol page for more info.

Supported params are:

  width: number;
  height: number;
  deviceScaleFactor: (optional) number;
  mobile: (optional) boolean;
  fitWindow: (optional) boolean;

If metrics param is not specified or undefined in the above methods calls, then it defaults to: DesktopScreenMetrics, set as follows:

{
  width: 1920,
  height: 1080,
  deviceScaleFactor: 0,
  mobile: false,
  fitWindow: false
}

Web API Server

A Web API Server is now included in the package in order to expose the lib as Microservice.

After installing the npm package, running:

$ node ./node_modules/hands-free-chrome/dist/api

it starts a HTTP server at localhost, default port: 8000.

To start the API server listening at a different port, just set the PORT environment variable.

To start the underlying Headless Chrome instance at a different port, set the CHROME_PORT environment variable (default is 9222).

Example:

$ PORT=8080 node ./node_modules/hands-free-chrome/dist/api

Endpoints

POST /screenshots/actions/capture

Sends a request to capture a screenshot. It returns a response with a base64 encoded stream body with Content-Type equal to image/png or application/pdf.

POST body must be a JSON object with the following properties:

  • url: (Required) string, complete URL of the page to capture;
  • type: (Optional) string, image type for the requested screenshot: png or pdf (default is png);
  • thumbnail - (optional) object in the form of { width: <px>, height: <px> } to generate a thumbnail. If not provided a "full" screenshot is returned. It works only if type is png.

Example:

{
  "url": "https://en.wikipedia.org/wiki/Node.js",
  "type": "png"
}

GET /screenshots/{url}[?thumbnail=width,height]

Gets a screenshot thumbnail for the specified url path parameter. It returns a response with a base64 encoded stream body with Content-Type equal to image/png. The thumbnail will have the size specified by the thumbnail query param.

Path parameter is:

  • url - (required) string, complete URL percent-encoding URL of the page to capture;

Query parameter is:

  • thumbnail - (optional) string in the form of width,heigth to generate a thumbnail of the specifies size. If not provided default is 160,100.

Example:

curl --request GET \
  --url 'http://<your-server>/screenshots/http%3A%2F%2Fwww.corriere.it?thumbnail=160%2C100' \
  --header 'content-type: application/json'

Docker

Thanks to the provided Dockerfile it is possible to run this component + API server as a Microservice, exposing the Web API endopoints listed above.

In order to "dockerize" the microservice, from the project root directory:

  1. build the image:
$ docker build -t vvc/hfchrome .
  1. run the container (as default, API server is configured to listen at port 8000, see Dockerfile):
$ docker run --name hfc -p 8000:8000 -d --privileged vvc/hfchrome

Docker Compose

This project also includes a Docker Compose configuration in order to launch a composition of 3 microservices, as follows:

Docker Microservices

  • two Hands-free Chrome nodes (hfc1, hfc2) to capture screenshots;
  • one NGINX instance (hfc-nginx-lb) to act as a load balancer between the two nodes; it is also configured to cache images in order to avoid performing the same screenshot capture tasks in a given time window (see nginx/nginx.conf file).

To execute composed services, run the following commands in the project root directory:

$ docker-compose build
$ docker-compose up -d

NGINX is configured to listen at port 8000, exposed APIs are the same as described above.

License - "MIT License"

Copyright (c) 2017 Vivocha S.p.A.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.