cookiemonster

I eat cookie consent notices. Nom nom.

Cookiemonster automatically detects cookie notices on Web pages. It's intended to help with both detection of cookie notices that we don't currently block, and to identify webcompat reports as being related to cookie consent blocking.

Deployment status

Cookiemonster is currently being developed as a Web app which will help us run crawls and/or integrate with the webcompat reporter backend. It can also be used as a library. In the future, we could even bundle it in the browser.

Setup

Install Brave Browser, and xvfb, which is required for optimal headless operation.

Install dependencies and then setup browser profiles for future use:

npm install
npm run setup -- /path/to/brave

If the browser profiles need to be updated, remove the profiles directory and run the setup script again.

Running

Run the following:

npm run serve

...then visit localhost:3000 in your browser.

If needed, you can pass a path to a different browser binary, and a different port to run on, e.g.:

npm run serve -- /usr/bin/brave-nightly 8000

Using as a library

import { checkPage } from 'cookiemonster';

const result = await checkPage({
  url: 'https://example.com',        // URL to visit
  seconds: 4,                        // delay before checking for a notice
  interactive: false,                // show the browser while running?
  executablePath: '/path/to/binary', // what browser to run
  adblockLists: {                    // enable/disable filter lists by component id
    'cdbbhgbmjhfnhnmgeddbliobbofkgdhe': false,
  },
  screenshot: true,                  // return images of detected notices or full page (see Screenshots section)
});

Screenshots

The screenshot parameter can be set to true, false, always, fullPage, the behavior is summarized in the following table:

value	element detected	no element detected
true	🎯	❌
false	❌	❌
always	🎯	📄
fullPage	📄	📄

Legend:
🎯 - Screenshot of detected element
📄 - Screenshot of full page
❌ - No screenshot

Testing

npm run test

You can also pass a path to a different browser binary if necessary:

npm run test -- /usr/bin/brave-nightly

Generating test cases

There is a set of regression test cases in the testcases directory.

Each test case is a single self-contained HTML file. These files can be generated using a tool like nodeSavePageWE.