chrome-aws-lambda

Chromium Binary for AWS Lambda and Google Cloud Functions

Install

$ npm i chrome-aws-lambda

This will ship with appropriate binary for the latest stable release of puppeteer (usually updated within a day or two).

If you wish to install an older version of Chromium, take a look at Versioning.

Usage

The nodejs8.10 AWS Lambda runtime is required for this package to work properly.

const chromium = require('chrome-aws-lambda');
const puppeteer = require('puppeteer-core');

exports.handler = async (event, context) => {
  let result = null;
  let browser = null;

  try {
    browser = await puppeteer.launch({
      args: chromium.args,
      defaultViewport: chromium.defaultViewport,
      executablePath: await chromium.executablePath,
      headless: chromium.headless,
    });

    let page = await browser.newPage();

    await page.goto(event.url || 'https://example.com');

    result = await page.title();
  } catch (error) {
    return context.fail(error);
  } finally {
    if (browser !== null) {
      await browser.close();
    }
  }

  return context.succeed(result);
};

You should allocate at least 512 MB of RAM to your Lambda, 1600 MB is recommended.

API

Fonts

Since version 1.12.2, the font() method will download additional fonts and make them discoverable.

To use it, simply pass a HTTPS URL to a custom font face before launching Chromium, e.g.:

await chromium.font('https://raw.githack.com/googlei18n/noto-emoji/master/fonts/NotoColorEmoji.ttf');

Fonts with the same basename will only be downloaded if they are not already cached.

On non-headless environments, the font method is a no-op to avoid polluting the user space.

It's recommended that you use a CDN, like raw.githack.com or gitcdn.xyz.

Overloading

Since version 1.7.0, it's also possible to overload puppeteer / puppeteer-core API with useful methods:

• Frame
  • count(selector)
  • exists(selector)
  • fill(form, data, heuristic = 'name')
  • number(selector, decimal = null, index = null, property = 'textContent')
  • selectByLabel(selector, ...values)
  • string(selector, property = 'textContent')
  • waitUntilVisible(selector, timeout = null)
  • waitWhileVisible(selector, timeout = null)
• Page
  • clickAndWaitForNavigation(selector, options = null)
  • count(selector)
  • exists(selector)
  • fill(form, data, heuristic = 'name')
  • go(url, options = null)
  • number(selector, decimal = null, index = null, property = 'textContent')
  • selectByLabel(selector, ...values)
  • string(selector, property = 'textContent')
  • waitUntilVisible(selector, timeout = null)
  • waitWhileVisible(selector, timeout = null)

Besides the public API, the following browser-context methods will also be available if Page.go() is used:

• σ.$(selector, context = document)
• σ.$$(selector, index = null, context = document)
• σ.$x(expression, index = null, context = document)
• σ.$number(data, decimal = null, index = null, property = 'textContent')
• σ.$string(data, property = 'textContent')
• σ.$regexp(data, pattern, index = null, property = 'textContent')

To enable overloading, simply call the puppeteer property exposed by this package.

Versioning

This package is versioned based on the underlying puppeteer minor version:

Compiling

To compile your own version of Chromium check the Ansible playbook instructions.

AWS Lambda Layer

Lambda Layers is a new convenient way to manage common dependencies between different Lambda Functions.

The following set of (Linux) commands will create a well-structured layer of this package:

git clone https://github.com/alixaxel/chrome-aws-lambda.git && \
cd chrome-aws-lambda && \
npm pack && \
mkdir -p nodejs/node_modules/chrome-aws-lambda/ && \
tar --directory nodejs/node_modules/chrome-aws-lambda/ --extract --file chrome-aws-lambda-*.tgz --strip-components=1 && \
rm chrome-aws-lambda-*.tgz && \
zip -9 --filesync --move --recurse-paths _/chrome-aws-lambda.zip nodejs/

The above will create a _/chrome-aws-lambda.zip file, which can be uploaded to your Layers console.

Google Cloud Functions

Since version 1.11.2, it's also possible to use this package on Google/Firebase Cloud Functions.

The only additional requirement is that iltorb must also be added as a dependency:

$ npm i iltorb

According to our benchmarks, it's 40% to 50% faster than using the off-the-shelf puppeteer bundle.

Compression

The Chromium binary is compressed using the Brotli algorithm.

This allows us to get the best compression ratio and faster decompression times.

For this reason, a stripped-down version of iltorb is bundled as a dependency.

License

MIT