@hyperwatch/useragent 3.9.1 → 4.0.0

package/scripts/compare-hyperwatch-uap.js

@@ -1,95 +0,0 @@
-const path = require('path');
-
-const useragent = require('../src/useragent');
-
-const month = new Date().toISOString().slice(0, 7);
-
-const filename = path.join(
-  __dirname,
-  '../data/sample',
-  `opencollective-${month}-parsed.json`
-);
-
-let uas;
-try {
-  uas = require(filename);
-} catch (err) {
-  uas = [];
-}
-
-// Transform Hyperwatch to their UAP Core equivalent
-const mapping = {
-  'Coc Coc Browser': 'Coc Coc',
-  'Coc Coc Bot Image': 'Coc Coc Bot',
-  'Coc Coc Bot Web': 'Coc Coc Bot',
-  'DuckDuckBot-Https': 'DuckDuckBot',
-  'Google Search App': 'Google',
-  'Mobile Safari UI/WKWebView': 'Safari WebView',
-  'Chrome Mobile WebView': 'Chrome WebView',
-  'Mobile Safari': 'Safari Mobile',
-  'WordPress.com': 'WordPress',
-  'python-requests': 'Python Requests',
-  'Android WebView': 'Android',
-  PaleMoon: 'Pale Moon',
-};
-
-// Transform UAP Core to their Hyperwatch equivalent
-const uapCoreMapping = {
-  'Chrome Mobile WebView': 'Chrome WebView',
-  'Chrome Mobile': 'Chrome',
-  'Edge Mobile': 'Edge',
-  'Firefox Alpha': 'Firefox',
-  'Firefox Beta': 'Firefox',
-  'Firefox Mobile': 'Firefox',
-  'Mail.RU_Bot': 'Mail.RU Bot',
-  'Opera Mobile': 'Opera',
-  'Samsung Internet': 'SamsungBrowser',
-  bingbot: 'BingBot',
-  coccocbot: 'Coc Coc Bot',
-  GmailImageProxy: 'GoogleImageProxy',
-  LINE: 'Line',
-  'Chrome Mobile iOS': 'Chrome',
-  'QQ Browser': 'QQBrowser',
-  'UC Browser': 'UCBrowser',
-  'Firefox iOS': 'Firefox',
-  'QQ Browser Mobile': 'QQBrowser',
-  'Sailfish Browser': 'SailfishBrowser',
-};
-
-for (const [ua, json] of Object.entries(uas)) {
-  if (!json) {
-    continue;
-  }
-  if (!json.family) {
-    console.log(`No result`, { hyperwatch: null }, ua);
-    continue;
-  }
-
-  // Transform Hyperwatch to their UAP Core equivalent
-  if (json.family && mapping[json.family]) {
-    json.family = mapping[json.family];
-  }
-
-  // Parse with UAP core only
-  const agent = useragent.parse(
-    ua,
-    /* enableCore */ false,
-    /* enableExtra */ false,
-    /* enableUapCore */ true
-  );
-  const result = agent.toJSON();
-
-  // Transform UAP Core result to its Hyperwatch equivalent
-  if (result.family && uapCoreMapping[result.family]) {
-    result.family = uapCoreMapping[result.family];
-  }
-
-  if (!result.family) {
-    // console.log(`New:`, { hyperwatch: json.family });
-    continue;
-  }
-
-  if (result.family !== json.family) {
-    console.log('Diff', { uap: result.family, hyperwatch: json.family });
-  }
-}

package/scripts/sample-benchmark.js

@@ -1,99 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const benchmarkResults = require('../data/benchmark-results.json');
-const useragent = require('../src/useragent');
-const {
-  average,
-  formatPercentage,
-  formatWithPrecision,
-  shuffle,
-  prettyJsonStringify,
-} = require('../src/utils');
-
-function benchmarkSample(filename) {
-  let uas;
-  try {
-    uas = require(path.join(__dirname, '../data/sample', filename));
-  } catch (err) {
-    uas = [];
-  }
-
-  const uasList = Object.keys(uas);
-  shuffle(uasList);
-  // Warm everything
-  for (const ua of uasList) {
-    useragent.parse(ua, true, true, true);
-  }
-
-  const benchmarkId = filename.replace('-parsed.json', '');
-  benchmarkResults[benchmarkId] = benchmarkResults[benchmarkId] || {};
-
-  const total = Object.keys(uas).length;
-  benchmarkResults[benchmarkId]['total'] = total;
-
-  const hyperwatchBenchmark = {},
-    uapBenchmark = {},
-    combinedBenchmark = {};
-  const hyperwatchMisses = [],
-    uapMisses = [],
-    combinedMisses = [];
-
-  for (const ua of uasList) {
-    const combinedStart = process.hrtime.bigint();
-    const combinedResult = useragent.parse(ua, true, true, true);
-    const combinedEnd = process.hrtime.bigint();
-    if (!combinedResult.family) {
-      combinedMisses.push(ua);
-    }
-    combinedBenchmark[ua] = Number(combinedEnd - combinedStart) / 1000 / 1000;
-
-    const hyperwatchStart = process.hrtime.bigint();
-    const hyperwatchResult = useragent.parse(ua, true, true, false);
-    const hyperwatchEnd = process.hrtime.bigint();
-    if (!hyperwatchResult.family) {
-      hyperwatchMisses.push(ua);
-    }
-    hyperwatchBenchmark[ua] =
-      Number(hyperwatchEnd - hyperwatchStart) / 1000 / 1000;
-
-    const uapStart = process.hrtime.bigint();
-    const uapResult = useragent.parse(ua, false, false, true);
-    const uapEnd = process.hrtime.bigint();
-    if (!uapResult.family) {
-      uapMisses.push(ua);
-    }
-    uapBenchmark[ua] = Number(uapEnd - uapStart) / 1000 / 1000;
-  }
-
-  benchmarkResults[benchmarkId]['hyperwatch'] = {
-    average: formatWithPrecision(average(Object.values(hyperwatchBenchmark))),
-    miss: hyperwatchMisses.length,
-    missPercentage: formatPercentage(hyperwatchMisses.length / total),
-  };
-
-  benchmarkResults[benchmarkId]['uap'] = {
-    average: formatWithPrecision(average(Object.values(uapBenchmark))),
-    miss: uapMisses.length,
-    missPercentage: formatPercentage(uapMisses.length / total),
-  };
-
-  benchmarkResults[benchmarkId]['combined'] = {
-    average: formatWithPrecision(average(Object.values(combinedBenchmark))),
-    miss: combinedMisses.length,
-    missPercentage: formatPercentage(combinedMisses.length / total),
-  };
-
-  fs.writeFileSync(
-    path.join(__dirname, '../data', 'benchmark-results.json'),
-    prettyJsonStringify(benchmarkResults)
-  );
-}
-
-fs.readdir(path.join(__dirname, '../data/sample'), (err, filenames) => {
-  filenames.forEach((filename) => {
-    if (filename.includes('parsed')) {
-      benchmarkSample(filename);
-    }
-  });
-});

package/scripts/sample-parse.js

@@ -1,37 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const { pick } = require('lodash');
-
-const useragent = require('../src/useragent');
-const { prettyJsonStringify } = require('../src/utils');
-
-function parse(filename) {
-  const uas = require(path.join(__dirname, '../data/sample', filename));
-
-  const fields = ['family', 'major', 'minor', 'patch', 'patch_minor'];
-
-  const parsedUas = {};
-
-  for (const ua of uas) {
-    const agent = useragent.parse(ua);
-
-    parsedUas[ua] = pick(agent.toJSON(), fields);
-  }
-
-  const parsedFilename = path.join(
-    __dirname,
-    '../data/sample',
-    filename.replace('.json', '-parsed.json')
-  );
-
-  fs.writeFileSync(parsedFilename, prettyJsonStringify(parsedUas));
-}
-
-fs.readdir(path.join(__dirname, '../data/sample'), (err, filenames) => {
-  filenames.forEach((filename) => {
-    if (filename.includes('.json') && !filename.includes('parsed')) {
-      parse(filename);
-    }
-  });
-});

package/scripts/update.js

@@ -1,67 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const fetch = require('node-fetch'); // eslint-disable-line node/no-unpublished-require
-const yaml = require('yamlparser'); // eslint-disable-line node/no-unpublished-require
-
-const { prettyJsonStringify } = require('../src/utils');
-
-fetch(
-  'https://raw.githubusercontent.com/ua-parser/uap-core/master/regexes.yaml'
-)
-  .then((response) => response.text())
-
-  .then((regexesYaml) => {
-    fs.writeFileSync(
-      path.resolve(__dirname, '..', 'regexes', 'uap-core.yml'),
-      regexesYaml
-    );
-
-    const regexesFirstYaml = fs
-      .readFileSync(path.resolve(__dirname, '..', 'regexes', 'first.yml'))
-      .toString();
-
-    const regexesExtraYaml = fs
-      .readFileSync(path.resolve(__dirname, '..', 'regexes', 'extra.yml'))
-      .toString();
-
-    const regexes = yaml.eval(regexesYaml);
-    const regexesExtra = yaml.eval(regexesExtraYaml);
-    const regexesFirst = yaml.eval(regexesFirstYaml);
-
-    fs.writeFileSync(
-      path.resolve(__dirname, '..', 'regexes', 'first.json'),
-      prettyJsonStringify(regexesFirst.user_agent_parsers)
-    );
-
-    fs.writeFileSync(
-      path.resolve(__dirname, '..', 'regexes', 'extra.json'),
-      prettyJsonStringify(regexesExtra.user_agent_parsers)
-    );
-
-    fs.writeFileSync(
-      path.resolve(__dirname, '..', 'regexes', 'uap-core-agent.json'),
-      prettyJsonStringify(regexes.user_agent_parsers)
-    );
-
-    fs.writeFileSync(
-      path.resolve(__dirname, '..', 'regexes', 'uap-core-os.json'),
-      prettyJsonStringify(regexes.os_parsers)
-    );
-
-    fs.writeFileSync(
-      path.resolve(__dirname, '..', 'regexes', 'uap-core-device.json'),
-      prettyJsonStringify(regexes.device_parsers)
-    );
-
-    const regexesCoreYaml = fs
-      .readFileSync(path.resolve(__dirname, '..', 'regexes', 'core.yml'))
-      .toString();
-
-    const regexesCore = yaml.eval(regexesCoreYaml);
-
-    fs.writeFileSync(
-      path.resolve(__dirname, '..', 'regexes', 'core.json'),
-      prettyJsonStringify(regexesCore)
-    );
-  });

package/test/lib/useragent-combined.js

@@ -1,31 +0,0 @@
-/* eslint-env mocha */
-
-const assert = require('assert');
-
-const { pick } = require('lodash');
-
-const useragent = require('../../src/useragent');
-
-const tests = require('./useragent-combined.json');
-
-const fields = ['family', 'major', 'minor', 'patch', 'patch_minor'];
-
-describe('useragent combined', () => {
-  for (const [ua, json] of tests) {
-    it(`should parse ${ua}`, () => {
-      const agent = useragent.parse(ua, true, true, true);
-      assert.deepStrictEqual(pick(agent.toJSON(), fields), json);
-    });
-  }
-
-  it('should re-construct from JSON', () => {
-    for (const [ua] of tests) {
-      const agentJson = useragent.parse(ua, true, true, true).toJSON();
-      const agent = useragent.fromJSON(agentJson);
-      assert.deepStrictEqual(
-        pick(agent.toJSON(), fields),
-        pick(agentJson, fields)
-      );
-    }
-  });
-});

package/test/lib/useragent-combined.json

@@ -1,12 +0,0 @@
-[
-  [
-    "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:54.0) Gecko/20100101 Firefox/54.0 O/x.d3v0.12",
-    {
-      "family": "Firefox",
-      "major": "54",
-      "minor": "0",
-      "patch": null,
-      "patch_minor": null
-    }
-  ]
-]

package/test/lib/useragent-core.js

@@ -1,31 +0,0 @@
-/* eslint-env mocha */
-
-const assert = require('assert');
-
-const { pick } = require('lodash');
-
-const useragent = require('../../src/useragent');
-
-const tests = require('./useragent-core.json');
-
-const fields = ['family', 'major', 'minor', 'patch', 'patch_minor'];
-
-describe('useragent core', () => {
-  for (const [ua, json] of tests) {
-    it(`should parse ${ua}`, () => {
-      const agent = useragent.parse(ua, true, false, false);
-      assert.deepStrictEqual(pick(agent.toJSON(), fields), json);
-    });
-  }
-
-  it('should re-construct from JSON', () => {
-    for (const [ua] of tests) {
-      const agentJson = useragent.parse(ua, true, false, false).toJSON();
-      const agent = useragent.fromJSON(agentJson);
-      assert.deepStrictEqual(
-        pick(agent.toJSON(), fields),
-        pick(agentJson, fields)
-      );
-    }
-  });
-});