@obscurity/adtagfinder

Node.js module to identify HTTP requests made by advertising and analytics tags

Stats

StarsIssuesVersionUpdatedCreatedSize
@obscurity/adtagfinder
2.0.03 years ago3 years agoMinified + gzip package size for @obscurity/adtagfinder in KB

Readme

Ad Tag Finder

Build Status Codacy Badge Codacy Badge Greenkeeper badge npm

Node.js module to identify HTTP requests made by advertising and analytics tags

Using Ad Tag Finder in conjunction with your existing browser tests lets you:

  • make sure that front end changes don't break your advertising or analytics tracking
  • ensure that automated browsers tests aren't artificially inflating your metrics
  • be certain that no unexpected tags are making requests when your pages load

Ad Tag Finder can also help in any case where you need to identify or filter all or a subset of advertising tags.

Examples

Coming soon!

Live demo

Coming soon

Contents

  1. Installation
  2. Usage
  3. API
  4. Contributing
  5. License

Installation

npm install @obscurity/adtagfinder

Ad Tag Finder supports and is tested on the following Node.js runtime versions:

  • Current Release (9)
  • Active LTS (8)

Usage

Ad Tag Finder can be used with your browser automation tool of choice. In this example, we use Puppeteer to drive Chrome.

const puppeteer = require("puppeteer");
const adtagfinder = require("@obscurity/adtagfinder");

(async () => {
  const browser = await puppeteer.launch(
    process.env.DEBUG ? { headless: false, slowMo: 100 } : {}
  );
  const page = await browser.newPage();

  page.on("request", request => {
    let tag = adtagfinder.identifyUrl(request.url());
    if (tag) console.log(tag.name);
  });

  await page.goto("https://www.obscurity.ie", { waitUntil: "networkidle2" });
  browser.close();
})();

API

Ad Tag Finder is very simple, and exposes three functions:

  • identifyUrl (url)
  • findTagDefinition (expectedTag)
  • findTag (expectedTag, urls)

Contributing

Contributors (and feature/tag requests) are very welcome - check out out Contributing Guide.

License

Ad Tag Finder © Obscurity Ltd. It is released under the MIT Licence.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.