@bundle-stats/utils 4.2.2 → 4.2.3-beta.1

package/lib-esm/config/metrics.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../src/config/metrics.js"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,cAAc,EACd,cAAc,EACd,gBAAgB,GACjB,MAAM,iBAAiB,CAAC;AAEzB,MAAM,CAAC,MAAM,qBAAqB,GAAG,uBAAuB,CAAC;AAC7D,MAAM,CAAC,MAAM,oBAAoB,GAAG,sBAAsB,CAAC;AAC3D,MAAM,CAAC,MAAM,mBAAmB,GAAG,qBAAqB,CAAC;AACzD,MAAM,CAAC,MAAM,iBAAiB,GAAG,mBAAmB,CAAC;AACrD,MAAM,CAAC,MAAM,sBAAsB,GAAG,wBAAwB,CAAC;AAE/D,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,CAAC,mBAAmB,CAAC,EAAE;QACrB,cAAc,EAAE,KAAK;QACrB,SAAS,EAAE,YAAY;KACxB;IACD,CAAC,iBAAiB,CAAC,EAAE;QACnB,cAAc,EAAE,IAAI;QACpB,SAAS,EAAE,YAAY;KACxB;IACD,CAAC,oBAAoB,CAAC,EAAE;QACtB,cAAc,EAAE,KAAK;QACrB,SAAS,EAAE,cAAc;KAC1B;IACD,CAAC,qBAAqB,CAAC,EAAE;QACvB,cAAc,EAAE,KAAK;QACrB,SAAS,EAAE,cAAc;KAC1B;IACD,CAAC,sBAAsB,CAAC,EAAE;QACxB,cAAc,EAAE,IAAI;QACpB,SAAS,EAAE,gBAAgB;KAC5B;CACF,CAAC"}

package/src/config/delta.js

@@ -1,11 +0,0 @@
-export const DELTA_TYPE_NEGATIVE = 'NEGATIVE';
-export const DELTA_TYPE_NO_CHANGE = 'NO_CHANGE';
-export const DELTA_TYPE_POSITIVE = 'POSITIVE';
-
-export const DELTA_TYPE_LEVEL_LOW = 'LOW';
-export const DELTA_TYPE_LEVEL_HIGH = 'HIGH';
-
-export const DELTA_TYPE_LOW_NEGATIVE = `${DELTA_TYPE_LEVEL_LOW}_${DELTA_TYPE_NEGATIVE}`;
-export const DELTA_TYPE_HIGH_NEGATIVE = `${DELTA_TYPE_LEVEL_HIGH}_${DELTA_TYPE_NEGATIVE}`;
-export const DELTA_TYPE_LOW_POSITIVE = `${DELTA_TYPE_LEVEL_LOW}_${DELTA_TYPE_POSITIVE}`;
-export const DELTA_TYPE_HIGH_POSITIVE = `${DELTA_TYPE_LEVEL_HIGH}_${DELTA_TYPE_POSITIVE}`;

package/src/config/metrics.js

@@ -1,35 +0,0 @@
-import {
-  formatNumber,
-  formatDuration,
-  formatFileSize,
-  formatPercentage,
-} from '../utils/format';
-
-export const METRIC_TYPE_FILE_SIZE = 'METRIC_TYPE_FILE_SIZE';
-export const METRIC_TYPE_DURATION = 'METRIC_TYPE_DURATION';
-export const METRIC_TYPE_NUMERIC = 'METRIC_TYPE_NUMERIC';
-export const METRIC_TYPE_SCORE = 'METRIC_TYPE_SCORE';
-export const METRIC_TYPE_PERCENTAGE = 'METRIC_TYPE_PERCENTAGE';
-
-export const METRIC_TYPES = {
-  [METRIC_TYPE_NUMERIC]: {
-    biggerIsBetter: false,
-    formatter: formatNumber,
-  },
-  [METRIC_TYPE_SCORE]: {
-    biggerIsBetter: true,
-    formatter: formatNumber,
-  },
-  [METRIC_TYPE_DURATION]: {
-    biggerIsBetter: false,
-    formatter: formatDuration,
-  },
-  [METRIC_TYPE_FILE_SIZE]: {
-    biggerIsBetter: false,
-    formatter: formatFileSize,
-  },
-  [METRIC_TYPE_PERCENTAGE]: {
-    biggerIsBetter: true,
-    formatter: formatPercentage,
-  },
-};

package/src/utils/delta.js

@@ -1,94 +0,0 @@
-import round from 'lodash/round';
-
-import {
-  DELTA_TYPE_NO_CHANGE,
-  DELTA_TYPE_NEGATIVE,
-  DELTA_TYPE_POSITIVE,
-  DELTA_TYPE_LEVEL_HIGH,
-  DELTA_TYPE_LEVEL_LOW,
-} from '../config/delta';
-
-export const getDelta = (baseline, current) => {
-  const baselineValue = (baseline && baseline.value) || 0;
-  const currentValue = (current && current.value) || 0;
-
-  if (baselineValue === currentValue) {
-    return {
-      delta: 0,
-      deltaPercentage: 0,
-    };
-  }
-
-  if (baselineValue === 0) {
-    return {
-      delta: currentValue,
-      deltaPercentage: 100,
-    };
-  }
-
-  return {
-    delta: currentValue - baselineValue,
-    deltaPercentage: round((currentValue / baselineValue) * 100 - 100, 8),
-  };
-};
-
-/**
- * Format delta output
- *
- * @param {number} value Metric value
- * @param {Function} formatter Metric type formatter
- * @return {String} Delta output
- */
-export const formatDelta = (value, formatter) => {
-  // eslint-disable-next-line no-nested-ternary
-  let sign = value > 0
-    ? '+'
-    : (value < 0 ? '-' : '');
-
-  let absValue = Math.abs(value);
-
-  if (absValue > 0 && absValue < 0.01) {
-    sign = `~${sign}`;
-    absValue = 0.01;
-  }
-
-  if (absValue > 0.01) {
-    absValue = round(absValue, 2);
-  }
-
-  return `${sign}${formatter(absValue)}`;
-};
-
-/**
- *
- * Get delta type
- *
- * @param {number} deltaValue Delta value
- * @param {Boolean} biggerIsBetter Metric flag
- * @return {string} Delta type
- */
-export const getDeltaType = (deltaValue, biggerIsBetter) => {
-  if (deltaValue === 0) {
-    return DELTA_TYPE_NO_CHANGE;
-  }
-
-  const absDiff = Math.abs(deltaValue);
-  let level = '';
-
-  if (absDiff <= 5) {
-    level = DELTA_TYPE_LEVEL_LOW;
-  }
-
-  if (absDiff > 50) {
-    level = DELTA_TYPE_LEVEL_HIGH;
-  }
-
-  let type = '';
-  if ((deltaValue > 0 && biggerIsBetter) || (deltaValue < 0 && !biggerIsBetter)) {
-    type = DELTA_TYPE_POSITIVE;
-  } else {
-    type = DELTA_TYPE_NEGATIVE;
-  }
-
-  return `${level ? `${level}_` : ''}${type}`;
-};

package/src/utils/metrics.js

@@ -1,92 +0,0 @@
-import get from 'lodash/get';
-
-import { METRIC_TYPE_NUMERIC, METRIC_TYPES } from '../config/metrics';
-import { formatDelta, getDelta, getDeltaType } from './delta';
-import { formatPercentage } from './format';
-
-import { metrics as webpackMetricTypes } from '../webpack/metrics';
-import { metrics as lighthouseMetricTypes } from '../lighthouse/metrics';
-import { metrics as browsertimeMeticTypes } from '../browsertime/metrics';
-
-/**
- * Create getMetricTypes handler
- *
- * @param {Object} metrics
- * @return {Function}
- */
-export const createGetMetricType =
-  (metrics) =>
-  /**
-   * Get metric type data
-   *
-   * @param {String} key Metric key
-   * @param {String} [type] Default metric type
-   * @return {import('../constants').MetricType}
-   */
-  // eslint-disable-next-line implicit-arrow-linebreak
-  (key, type) => {
-    /** @type {import('../constants').MetricTypeConfig} */
-    const metric = get(metrics, key);
-
-    if (metric && metric.type) {
-      return {
-        ...METRIC_TYPES[metric.type],
-        ...metric,
-      };
-    }
-
-    const resolvedType = type || METRIC_TYPE_NUMERIC;
-
-    return {
-      ...METRIC_TYPES[resolvedType],
-      type: resolvedType,
-      label: key,
-    };
-  };
-
-/**
- * Get global metric type
- *
- * @param {String} key Metric key
- * @param {import('../constants').MetricTypeType} [type] Default metric type
- * @return {import('../constants').MetricType}
- */
-export const getGlobalMetricType = createGetMetricType({
-  webpack: webpackMetricTypes,
-  lighthouse: lighthouseMetricTypes,
-  browsertime: browsertimeMeticTypes,
-});
-
-/**
- *
- * Get metric information
- *
- * @param {import('../constants').MetricType} metric Metric data
- * @param {number} currentValue Current value
- * @param {number} baselineValue Baseline value
- *
- * @return {import('../constants').MetricRunInfo}
- */
-export const getMetricRunInfo = (metric, currentValue, baselineValue) => {
-  const { formatter, biggerIsBetter } = metric;
-
-  const runInfo = {
-    value: currentValue,
-    displayValue: formatter(currentValue),
-  };
-
-  if (typeof baselineValue === 'undefined') {
-    return runInfo;
-  }
-
-  const { delta, deltaPercentage } = getDelta({ value: baselineValue }, { value: currentValue });
-
-  return {
-    ...runInfo,
-    delta,
-    deltaPercentage,
-    displayDelta: formatDelta(delta, formatter),
-    displayDeltaPercentage: formatDelta(deltaPercentage, formatPercentage),
-    deltaType: getDeltaType(deltaPercentage, biggerIsBetter),
-  };
-};

package/src/webpack/compare.js

@@ -1,81 +0,0 @@
-import { METRIC_TYPE_FILE_SIZE } from '../config/metrics';
-import { compareMetrics } from '../report/compare-metrics';
-import {
-  SECTION_WEBPACK_STATS,
-  SECTION_WEBPACK_SIZES,
-  SECTION_WEBPACK_ASSETS,
-  SECTION_WEBPACK_MODULES,
-  SECTION_WEBPACK_PACKAGES,
-  SECTIONS,
-} from './constants';
-import { selectors } from './selectors';
-
-/**
- * Compare stats metrics
- *
- * @param {Object[]} jobs - List of jobs to compare
- * @param {Array<Function>} [rowTransformers]
- *
- * @return {Object[]} Compared stats metrics
- */
-const compareStats = (jobs, rowTransformers) => compareMetrics(
-  jobs, selectors.stats, undefined, rowTransformers,
-);
-
-/**
- * Compare size metrics
- *
- * @param {Object[]} jobs - List of jobs to compare
- * @param {Array<Function>} [rowTransformers]
- *
- * @return {Object[]} Compared size metrics
- */
-const compareSizes = (jobs, rowTransformers) => compareMetrics(jobs, selectors.sizes, undefined, rowTransformers);
-
-/**
- * Compare asset metrics
- *
- * @param {Object[]} jobs - List of jobs to compare
- * @param {Array<Function>} [rowTransformers]
- *
- * @return {Object[]} Compared asset metrics
- */
-const compareAssets = (jobs, rowTransformers) => compareMetrics(jobs, selectors.assets, METRIC_TYPE_FILE_SIZE, rowTransformers);
-
-/**
- * Compare all modules
- *
- * @param {Object[]} jobs - List of jobs to compare
- * @param {Array<Function>} [rowTransformers]
- * @return {Object[]} Compared module metrics
- */
-const compareModules = (jobs, rowTransformers) => compareMetrics(jobs, selectors.modules, METRIC_TYPE_FILE_SIZE, rowTransformers);
-
-/**
- * Compare package metrics
- *
- * @param {Object[]} jobs - List of jobs to compare
- * @param {Array<Function>} [rowTransformers]
- *
- * @return {Object[]} Compared package metrics
- */
-const comparePackages = (jobs, rowTransformers) => compareMetrics(jobs, selectors.packages, METRIC_TYPE_FILE_SIZE, rowTransformers);
-
-export const compareBySection = {
-  [SECTION_WEBPACK_STATS]: compareStats,
-  [SECTION_WEBPACK_SIZES]: compareSizes,
-  [SECTION_WEBPACK_ASSETS]: compareAssets,
-  [SECTION_WEBPACK_MODULES]: compareModules,
-  [SECTION_WEBPACK_PACKAGES]: comparePackages,
-};
-
-/**
- * Compare webpack sections
- *
- * @param {Object[]} jobs - List of jobs to compare
- * @return {Object} Compared metrics by section
- */
-export const compare = (jobs) => SECTIONS.reduce((agg, sectionId) => ({
-  ...agg,
-  [sectionId]: compareBySection[sectionId](jobs),
-}), {});

package/src/webpack/utils.js

@@ -1,155 +0,0 @@
-import last from 'lodash/last';
-import map from 'lodash/map';
-import round from 'lodash/round';
-
-import { PACKAGES_SEPARATOR, PACKAGE_ID_SEPARATOR } from '../config';
-import { createGetMetricType } from '../utils/metrics';
-import { metrics } from './metrics';
-
-// Md5 hash matcher
-const HASH_PATTERN = '[a-f|0-9]{5,32}';
-
-// Match has prefix
-const HASH_SEPARATOR_PATTERN = '[-|.]';
-
-// Match multiple extensions: .js, .js.gz, .min.js, .chunk.js
-const EXTENSION_PATTERN = /(?:\.[a-z|0-9]{2,}){1,}/;
-
-const PATTERNS = [
-  // Match path/name-HASH.ext, path/name.HASH.ext, path/name-HASH.chunk.ext
-  `(.*)${HASH_SEPARATOR_PATTERN}${HASH_PATTERN}(${EXTENSION_PATTERN.source})$`,
-
-  // Match static/HASH
-  `(static)/${HASH_PATTERN}(.*${EXTENSION_PATTERN.source})$`,
-].map((pattern) => new RegExp(pattern));
-
-const NO_BASENAME = /(^|.*\/)\..*$/;
-
-/**
- * Extract (guess) filename from a hashed filename
- */
-export const getAssetName = (assetFilepath) => {
-  if (!assetFilepath) {
-    return '';
-  }
-
-  let result;
-
-  for (let i = 0; i < PATTERNS.length && !result; i += 1) {
-    const pattern = PATTERNS[i];
-    const extracted = assetFilepath.replace(pattern, '$1$2');
-
-    if (extracted && extracted !== assetFilepath && !NO_BASENAME.test(extracted)) {
-      result = extracted;
-    }
-  }
-
-  if (!result) {
-    return assetFilepath;
-  }
-
-  return result;
-};
-
-// css ./node_modules/css-loader/dist/cjs.js??ref--6-0!./src/assets/styles/default.styl
-const NAME_WITH_LOADERS = /!/;
-
-// ./src/index.jsx + 27 modules
-const NAME_WITH_MODULES = /\s\+\s\d*\smodules$/;
-
-// css ../node_modules../node_modules/package-a
-const INVALID_CSS_PREFIX = /^css\s.*node_modules(?!\/)/;
-
-export const getModuleName = (name) => {
-  if (!name) {
-    return '';
-  }
-
-  if (NAME_WITH_LOADERS.test(name)) {
-    const normalizedName = last(name.split(NAME_WITH_LOADERS));
-
-    if (normalizedName?.trim()) {
-      return normalizedName;
-    }
-  }
-
-  if (NAME_WITH_MODULES.test(name)) {
-    return name.replace(NAME_WITH_MODULES, '');
-  }
-
-  if (INVALID_CSS_PREFIX.test(name)) {
-    return name.replace(INVALID_CSS_PREFIX, '');
-  }
-
-  return name;
-};
-
-/*
- * Calculate cache invalidation metric on the baseline data
- *
- * The metric is the ratio between the total file size of the files that have changed (exclude
- * deleted, added) and the total file size
- */
-export const calculateCacheInvalidation = (rows) => {
-  let cached = 0;
-  let invalidated = 0;
-
-  rows.forEach(({ changed, added, deleted, runs }) => {
-    // Added and deleted files do not count towards the caching index
-    if (added || deleted) {
-      return;
-    }
-
-    if (changed) {
-      invalidated += runs[1].value;
-    }
-
-    cached += runs[1].value;
-  });
-
-  if (cached === 0) {
-    return 0;
-  }
-
-  return round((invalidated / cached) * 100, 2);
-};
-
-export const getMetricAdded = (runs) => {
-  const [current, baseline] = map(runs, 'value');
-
-  return Boolean(current !== null && !baseline);
-};
-
-export const getMetricDeleted = (runs) => {
-  const [current, baseline] = map(runs, 'value');
-
-  return Boolean(baseline !== null && !current);
-};
-
-/**
- * Get webpack metric data
- *
- * @param {String} key - Webpack metric key
- * @return {Object} Metric data
- */
-export const getMetricType = createGetMetricType(metrics);
-
-/**
- * Get public package name from package id
- *
- * @param {String} packageId
- * @return {String} public package name
- */
-export const getPackagePublicName = (packageId) => {
-  // Split packages
-  const name = last(packageId.split(PACKAGES_SEPARATOR));
-
-  // Strip package suffix (eg: ~1)
-  return name.split(PACKAGE_ID_SEPARATOR)[0];
-};
-
-/**
- * @param {String|Number} chunkId
- * @return {String}
- */
-export const normalizeChunkId = (chunkId) => chunkId.toString();

package/types/config/delta.d.ts

@@ -1,9 +0,0 @@
-export const DELTA_TYPE_NEGATIVE: "NEGATIVE";
-export const DELTA_TYPE_NO_CHANGE: "NO_CHANGE";
-export const DELTA_TYPE_POSITIVE: "POSITIVE";
-export const DELTA_TYPE_LEVEL_LOW: "LOW";
-export const DELTA_TYPE_LEVEL_HIGH: "HIGH";
-export const DELTA_TYPE_LOW_NEGATIVE: string;
-export const DELTA_TYPE_HIGH_NEGATIVE: string;
-export const DELTA_TYPE_LOW_POSITIVE: string;
-export const DELTA_TYPE_HIGH_POSITIVE: string;

package/types/config/metrics.d.ts

@@ -1,35 +0,0 @@
-export const METRIC_TYPE_FILE_SIZE: "METRIC_TYPE_FILE_SIZE";
-export const METRIC_TYPE_DURATION: "METRIC_TYPE_DURATION";
-export const METRIC_TYPE_NUMERIC: "METRIC_TYPE_NUMERIC";
-export const METRIC_TYPE_SCORE: "METRIC_TYPE_SCORE";
-export const METRIC_TYPE_PERCENTAGE: "METRIC_TYPE_PERCENTAGE";
-export namespace METRIC_TYPES {
-    namespace METRIC_TYPE_NUMERIC {
-        export const biggerIsBetter: boolean;
-        export { formatNumber as formatter };
-    }
-    namespace METRIC_TYPE_SCORE {
-        const biggerIsBetter_1: boolean;
-        export { biggerIsBetter_1 as biggerIsBetter };
-        export { formatNumber as formatter };
-    }
-    namespace METRIC_TYPE_DURATION {
-        const biggerIsBetter_2: boolean;
-        export { biggerIsBetter_2 as biggerIsBetter };
-        export { formatDuration as formatter };
-    }
-    namespace METRIC_TYPE_FILE_SIZE {
-        const biggerIsBetter_3: boolean;
-        export { biggerIsBetter_3 as biggerIsBetter };
-        export { formatFileSize as formatter };
-    }
-    namespace METRIC_TYPE_PERCENTAGE {
-        const biggerIsBetter_4: boolean;
-        export { biggerIsBetter_4 as biggerIsBetter };
-        export { formatPercentage as formatter };
-    }
-}
-import { formatNumber } from "../utils/format";
-import { formatDuration } from "../utils/format";
-import { formatFileSize } from "../utils/format";
-import { formatPercentage } from "../utils/format";