adblock-plus-crx

Adblock-Plus crx base64 encoded binary for chromedriver

Usage no npm install needed!

<script type="module">
  import adblockPlusCrx from 'https://cdn.skypack.dev/adblock-plus-crx';
</script>

README

Adblock-Plus.crx

Adverts can slow and even break functional tests. If you run your functional tests using ChromeDriver you can install extensions like AdBlock-Plus as follows...

{
  ...
  "desiredCapabilities": {
    "javascriptEnabled": true,
    "acceptSslCerts": true,
    "browserName": "chrome",
    "chromeOptions": {
      "args": [ "no-sandbox" ],
      "extensions": [ "Q3Iy....AAAA=" ]
    }
  }
  ...
}

Where Q3Iy....AAAA= is the base64 encoded crx file you want to install. Unfortunately Adblock-Plus is around 600KB when encoded and not something you really want to include in a json file.

When using the excellent Nightwatch.js you can define configuration in nightwatch.conf.js instead of json.

var adBlockPlus = require('adblock-plus-crx')

module.exports = {
  ...
  "desiredCapabilities": {
    "javascriptEnabled": true,
    "acceptSslCerts": true,
    "browserName": "chrome",
    "chromeOptions": {
      "args": [ "no-sandbox" ],
      "extensions": [ adBlockPlus.base64() ]
    }
  }
  ...
}

Modifications

AdBlock-Plus opens a new tab on first run and since WebDriver tests typically start with a fresh profile each run gets more than a little annoying. We've disabled first run behaviour by setting suppress_first_run_page to true and recreating the crx.

Using a custom crx (instructions for OSX)

  1. Fork this project
  2. Rename the package
  3. Update the adblock-plus-crx version in package.json
  4. Add modifications to ./scripts/update.sh
  5. Run ./scripts/update.sh from forks root directory - i.e. the one containing package.json
  6. Commit your changes and publish to npm or a private repo.

Pull Requests

If you don't want to publish an alternative version of this package, I will consider pull requests for adblock-plus version updates and generally useful modifications, however the later should be done by amending ./scripts/update.sh. I cannot accept changes to the crx file itself.