@bundle-stats/utils 3.4.0-alpha.5 → 4.0.0-alpha.7

package/src/webpack/{constants.ts → constants.js}

@@ -12,34 +12,19 @@ export const SECTIONS = [
   SECTION_WEBPACK_PACKAGES,
 ];
 
-export enum MetricId {
-  BundleSize = 'totalSizeByTypeALL',
-  TotalInitialSizeJS = 'totalInitialSizeJS',
-  TotalInitialSizeCSS = 'totalInitialSizeCSS',
-  CacheInvalidation = 'cacheInvalidation',
-  ModuleName = 'moduleCount',
-  DuplicateModulesCount = 'duplicateModulesCount',
-  DuplicateCode = 'duplicateCode',
-  ChunkCount = 'chunkCount',
-  AssetCount = 'assetCount',
-  PackageCount = 'packageCount',
-  DuplicatePackagesCount = 'duplicatePackagesCount',
-}
-
-export const SIZE_BY_TYPE_METRIC_ID_ALL = 'ALL';
-export const SIZE_BY_TYPE_METRIC_ID_PREFIX = 'totalSizeByType';
-
-export enum SizeByTypeMetricId {
-  JS = 'totalSizeByTypeJS',
-  CSS = 'totalSizeByTypeCSS',
-  IMG = 'totalSizeByTypeIMG',
-  Media = 'totalSizeByTypeMEDIA',
-  Font = 'totalSizeByTypeFONT',
-  HTML = 'totalSizeByTypeHTML',
-  Other = 'totalSizeByTypeOTHER',
-}
-
-export const SUMMARY_METRIC_PATHS = Object.values(MetricId);
+export const SUMMARY_METRIC_PATHS = [
+  'totalSizeByTypeALL',
+  'totalInitialSizeJS',
+  'totalInitialSizeCSS',
+  'cacheInvalidation',
+  'moduleCount',
+  'duplicateModulesCount',
+  'duplicateCode',
+  'chunkCount',
+  'assetCount',
+  'packageCount',
+  'duplicatePackagesCount',
+];
 
 const PACKAGE_PREFIX = /(?:node_modules|~)(?:\/\.pnpm)?/;
 const PACKAGE_SLUG = /[a-zA-Z0-9]+(?:[-|_|.]+[a-zA-Z0-9]+)*/;

package/src/webpack/extract/assets-size-total-insight.js

@@ -4,21 +4,21 @@ import template from 'lodash/template';
 import { INSIGHT_INFO } from '../../config/insights';
 import { getMetricRunInfo } from '../../utils/metrics';
 import { getMetricType } from '../utils';
-import { MetricId } from '../constants';
 
 const INFO_TEMPLATE = template(
   '<%= metric %> — <%= displayValue %> (<%= displayDeltaPercentage %>).',
 );
+const METRIC_NAME = 'totalSizeByTypeALL';
 
 export const extractAssetsSizeTotalInsight = (
   webpackStats,
   currentExtractedData,
   baselineBundleStats,
 ) => {
-  const currentValue = get(currentExtractedData, ['metrics', MetricId.BundleSize, 'value'], 0);
-  const baselineValue = get(baselineBundleStats, ['metrics', 'webpack', MetricId.BundleSize, 'value'], 0);
+  const currentValue = get(currentExtractedData, ['metrics', METRIC_NAME, 'value'], 0);
+  const baselineValue = get(baselineBundleStats, ['metrics', 'webpack', METRIC_NAME, 'value'], 0);
 
-  const metric = getMetricType(MetricId.BundleSize);
+  const metric = getMetricType(METRIC_NAME);
   const info = getMetricRunInfo(metric, currentValue, baselineValue);
   const { displayDeltaPercentage, displayValue } = info;
 

package/src/webpack/extract/assets-size.js

@@ -4,9 +4,11 @@ import sum from 'lodash/sum';
 
 import { FILE_TYPE_CSS, FILE_TYPE_JS, FILE_TYPES } from '../../config/file-types';
 import { getFileType } from '../../utils/file-types';
-import { SIZE_BY_TYPE_METRIC_ID_PREFIX, SIZE_BY_TYPE_METRIC_ID_ALL } from '../constants';
 
-const getMetricName = (fileType) => `${SIZE_BY_TYPE_METRIC_ID_PREFIX}${fileType}`;
+const METRIC_NAME_ALL = 'ALL';
+const METRIC_NAME_PREFIX = 'totalSizeByType';
+
+const getMetricName = (fileType) => `${METRIC_NAME_PREFIX}${fileType}`;
 
 const generateInitialSizeByType = () => FILE_TYPES.reduce((accumulator, fileType) => ({
   ...accumulator,
@@ -50,7 +52,7 @@ export const extractAssetsSize = (webpackStats, currentExtractedData) => {
 
   const sizes = calculateTotalByType(bundleAssets);
   const generic = {
-    [getMetricName(SIZE_BY_TYPE_METRIC_ID_ALL)]: {
+    [getMetricName(METRIC_NAME_ALL)]: {
       value: sum(map(bundleAssets, 'value')),
     },
     ...calculateInitialTotals(bundleAssets),

package/src/webpack/extract/{assets.js → assets.ts}

@@ -1,17 +1,46 @@
-import get from 'lodash/get';
 import isEmpty from 'lodash/isEmpty';
 
 import { getAssetName, normalizeChunkId } from '../utils';
 
 const IGNORE_PATTERN = /\.(map|LICENSE\.txt)$/;
 
-export const extractAssets = (webpackStats) => {
-  const webpackAssets = get(webpackStats, 'assets', []);
-  const webpackChunks = get(webpackStats, 'chunks', []);
-  const webpackEntrypoints = get(webpackStats, 'entrypoints', {});
+interface WebpackStatsAsset {
+  name: string;
+  size: number;
+}
 
-  const entryItems = Object.values(webpackEntrypoints)
-    .map(({ assets: items }) => items)
+interface WebpackStatsEntrypointAsset {
+  name: string;
+}
+
+interface WebpackStatsEntrypoint {
+  // Webpack 5 provides { name, size }
+  assets: Array<WebpackStatsEntrypointAsset | string>;
+}
+
+type WebpackStatsEntrypoints = Record<string, WebpackStatsEntrypoint>;
+
+interface WebpackStatsChunk {
+  id: string;
+  entry: boolean;
+  initial: boolean;
+  files: Array<string>;
+  names: Array<string>;
+}
+
+export const extractAssets = (webpackStats: any) => {
+  const webpackAssets: Array<WebpackStatsAsset> = webpackStats?.assets || [];
+  const webpackChunks: Array<WebpackStatsChunk> = webpackStats?.chunks || [];
+  const webpackEntrypoints: WebpackStatsEntrypoints = webpackStats?.entrypoints || {};
+
+  const entrypointsAssets = Object.values(webpackEntrypoints)
+    .map(({ assets: items }) => items.map((item) => {
+      if (typeof item === 'object') {
+        return item.name;
+      }
+
+      return item;
+    }))
     .flat();
 
   const initialItems = webpackChunks
@@ -43,7 +72,7 @@ export const extractAssets = (webpackStats) => {
       [normalizedName]: {
         name: baseName,
         value: size,
-        isEntry: entryItems.includes(name),
+        isEntry: entrypointsAssets.includes(name),
         isInitial: initialItems.includes(name),
         isChunk: Boolean(assetChunk),
         ...(assetChunk ? { chunkId: assetChunk.id } : {}),
@@ -57,10 +86,10 @@ export const extractAssets = (webpackStats) => {
     },
     ...(!isEmpty(normalizedChunks)
       ? {
-          meta: {
-            chunks: normalizedChunks.map(({ id, name }) => ({ id, name })),
-          },
-        }
+        meta: {
+          chunks: normalizedChunks.map(({ id, name }) => ({ id, name })),
+        },
+      }
       : {}),
   };
 };

package/src/webpack/extract/index.js

@@ -1,6 +1,5 @@
 import merge from 'lodash/merge';
 
-import * as budgetsInsights from '../../transformers/budgets-insights';
 import { extractAssets } from './assets';
 import { extractAssetsCacheInvalidation } from './assets-cache-invalidation';
 import { extractAssetsChunkCount } from './assets-chunk-count';
@@ -27,11 +26,10 @@ const extractFns = [
   extractModulesPackages,
   extractModulesPackagesCount,
   extractModulesPackagesDuplicate,
-  budgetsInsights.getExtract('webpack'),
 ];
 
-export const extract = (webpackStats, baseline, options) =>
-  extractFns.reduce(
-    (agg, extractFn) => merge({}, agg, extractFn(webpackStats, agg, baseline, options)),
-    {},
-  );
+export const extract = (webpackStats, baseline) => extractFns.reduce((agg, extractFn) => merge(
+  {},
+  agg,
+  extractFn(webpackStats, agg, baseline),
+), {});

package/src/webpack/extract/modules-packages-duplicate.js

@@ -3,7 +3,7 @@ import map from 'lodash/map';
 import orderBy from 'lodash/orderBy';
 import sum from 'lodash/sum';
 
-import { InsightType } from '../../constants';
+import { INSIGHT_WARNING } from '../../config';
 
 export const extractModulesPackagesDuplicate = (webpackStats, currentExtractedData) => {
   const source = get(currentExtractedData, 'metrics.packages', {});
@@ -89,7 +89,7 @@ export const extractModulesPackagesDuplicate = (webpackStats, currentExtractedDa
   return {
     insights: {
       duplicatePackages: {
-        type: InsightType.WARNING,
+        type: INSIGHT_WARNING,
         data,
       },
     },

package/src/webpack/{metrics.ts → metrics.js}

@@ -3,80 +3,76 @@ import {
   METRIC_TYPE_NUMERIC,
   METRIC_TYPE_PERCENTAGE,
 } from '../config/metrics';
-import { MetricId, SizeByTypeMetricId } from './constants';
 
 export const metrics = {
-  [MetricId.BundleSize]: {
+  totalSizeByTypeALL: {
     label: 'Bundle Size',
     description: 'Sum of all assets emitted by webpack.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_FILE_SIZE,
-    biggerIsBetter: false,
   },
-  [MetricId.TotalInitialSizeJS]: {
+  totalInitialSizeJS: {
     label: 'Initial JS',
     description: 'Sum of all JavaScript assets that are labeled as initial(eg: vendor.js, app.js).',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_FILE_SIZE,
-    biggerIsBetter: false,
   },
-  [MetricId.TotalInitialSizeCSS]: {
+  totalInitialSizeCSS: {
     label: 'Initial CSS',
     description: 'Sum of all CSS assets that are labeled as initial(eg: vendor.css, app.css).',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_FILE_SIZE,
-    biggerIsBetter: false,
   },
-  [MetricId.CacheInvalidation]: {
+  cacheInvalidation: {
     label: 'Cache Invalidation',
     description: 'Ratio between the total changed assets and Bundle Size.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_PERCENTAGE,
     biggerIsBetter: false,
   },
-  [MetricId.ChunkCount]: {
+  chunkCount: {
     label: 'Chunks',
     description: 'Total number of chunks generated by webpack.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
-  [MetricId.AssetCount]: {
+  assetCount: {
     label: 'Assets',
     description: 'Total number of assets emitted by webpack.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
-  [MetricId.ModuleName]: {
+  moduleCount: {
     label: 'Modules',
     description: 'Total number of modules bundled by webpack.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#modules-1',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
-  [MetricId.DuplicateModulesCount]: {
+  duplicateModulesCount: {
     label: 'Duplicate Modules',
     description: 'Total number of modules that belong to more than one chunk.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#modules-1',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
-  [MetricId.DuplicateCode]: {
+  duplicateCode: {
     label: 'Duplicate Code',
     description: 'The percentage of total duplicate module size from the total module size.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#modules-1',
     type: METRIC_TYPE_PERCENTAGE,
     biggerIsBetter: false,
   },
-  [MetricId.PackageCount]: {
+  packageCount: {
     label: 'Packages',
     description: 'Total number of packages bundled by webpack.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#packages',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
-  [MetricId.DuplicatePackagesCount]: {
+  duplicatePackagesCount: {
     label: 'Duplicate Packages',
     description: 'Total number of packages that are duplicated.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#packages',
@@ -84,40 +80,33 @@ export const metrics = {
     biggerIsBetter: false,
   },
   sizes: {
-    [SizeByTypeMetricId.JS]: {
+    totalSizeByTypeJS: {
       label: 'JS',
       type: METRIC_TYPE_FILE_SIZE,
-      biggerIsBetter: false,
     },
-    [SizeByTypeMetricId.CSS]: {
+    totalSizeByTypeCSS: {
       label: 'CSS',
       type: METRIC_TYPE_FILE_SIZE,
-      biggerIsBetter: false,
     },
-    [SizeByTypeMetricId.IMG]: {
+    totalSizeByTypeIMG: {
       label: 'IMG',
       type: METRIC_TYPE_FILE_SIZE,
-      biggerIsBetter: false,
     },
-    [SizeByTypeMetricId.Media]: {
+    totalSizeByTypeMEDIA: {
       label: 'Media',
       type: METRIC_TYPE_FILE_SIZE,
-      biggerIsBetter: false,
     },
-    [SizeByTypeMetricId.Font]: {
+    totalSizeByTypeFONT: {
       label: 'Fonts',
       type: METRIC_TYPE_FILE_SIZE,
-      biggerIsBetter: false,
     },
-    [SizeByTypeMetricId.HTML]: {
+    totalSizeByTypeHTML: {
       label: 'HTML',
       type: METRIC_TYPE_FILE_SIZE,
-      biggerIsBetter: false,
     },
-    [SizeByTypeMetricId.Other]: {
+    totalSizeByTypeOTHER: {
       label: 'Other',
       type: METRIC_TYPE_FILE_SIZE,
-      biggerIsBetter: false,
     },
   },
 };

package/types/constants.d.ts

@@ -157,9 +157,3 @@ export interface BrowsertimeMetrics {
     visualComplete95: MetricRun;
     visualComplete99: MetricRun;
 }
-export declare enum InsightType {
-    ERROR = "ERROR",
-    WARNING = "WARNING",
-    INFO = "INFO",
-    SUCCESS = "SUCCESS"
-}

package/types/index.d.ts

@@ -1,7 +1,5 @@
 export * from "./browsertime";
 export * from "./config";
-export * from "./constants";
 export * from "./jobs";
 export * from "./report";
 export * from "./utils";
-export * as transformers from "./transformers";

package/types/jobs/create-job.d.ts

@@ -1 +1 @@
-export function createJob(source: any, baseline: any, options?: {}): {};
+export function createJob(source: any, baseline: any): {};

package/types/jobs/create-jobs.d.ts

@@ -1 +1 @@
-export function createJobs(sources: any, options: any): any;
+export function createJobs(sources: any): any;

package/types/report/add-row-metric-data.d.ts

@@ -1,5 +1,5 @@
 import * as types from './types';
-export declare const getAddRowMetricData: (metricType?: string | undefined) => (row: types.ReportRow) => {
+export declare const getAddRowMetricData: (metricType?: string) => (row: types.ReportRow) => {
     biggerIsBetter: any;
     label: any;
     changed: boolean;

package/types/webpack/constants.d.ts

@@ -1,33 +1,9 @@
-export declare const SECTION_WEBPACK_STATS = "stats";
-export declare const SECTION_WEBPACK_SIZES = "sizes";
-export declare const SECTION_WEBPACK_ASSETS = "assets";
-export declare const SECTION_WEBPACK_MODULES = "modules";
-export declare const SECTION_WEBPACK_PACKAGES = "packages";
-export declare const SECTIONS: string[];
-export declare enum MetricId {
-    BundleSize = "totalSizeByTypeALL",
-    TotalInitialSizeJS = "totalInitialSizeJS",
-    TotalInitialSizeCSS = "totalInitialSizeCSS",
-    CacheInvalidation = "cacheInvalidation",
-    ModuleName = "moduleCount",
-    DuplicateModulesCount = "duplicateModulesCount",
-    DuplicateCode = "duplicateCode",
-    ChunkCount = "chunkCount",
-    AssetCount = "assetCount",
-    PackageCount = "packageCount",
-    DuplicatePackagesCount = "duplicatePackagesCount"
-}
-export declare const SIZE_BY_TYPE_METRIC_ID_ALL = "ALL";
-export declare const SIZE_BY_TYPE_METRIC_ID_PREFIX = "totalSizeByType";
-export declare enum SizeByTypeMetricId {
-    JS = "totalSizeByTypeJS",
-    CSS = "totalSizeByTypeCSS",
-    IMG = "totalSizeByTypeIMG",
-    Media = "totalSizeByTypeMEDIA",
-    Font = "totalSizeByTypeFONT",
-    HTML = "totalSizeByTypeHTML",
-    Other = "totalSizeByTypeOTHER"
-}
-export declare const SUMMARY_METRIC_PATHS: MetricId[];
-export declare const MODULE_PATH_PACKAGES: RegExp;
-export declare const PACKAGE_PATH_NAME: RegExp;
+export const SECTION_WEBPACK_STATS: "stats";
+export const SECTION_WEBPACK_SIZES: "sizes";
+export const SECTION_WEBPACK_ASSETS: "assets";
+export const SECTION_WEBPACK_MODULES: "modules";
+export const SECTION_WEBPACK_PACKAGES: "packages";
+export const SECTIONS: string[];
+export const SUMMARY_METRIC_PATHS: string[];
+export const MODULE_PATH_PACKAGES: RegExp;
+export const PACKAGE_PATH_NAME: RegExp;

package/types/webpack/extract/assets.d.ts

@@ -1,8 +1,11 @@
-export function extractAssets(webpackStats: any): {
+export declare const extractAssets: (webpackStats: any) => {
     meta?: {
-        chunks: any;
+        chunks: {
+            id: string;
+            name: string;
+        }[];
     } | undefined;
     metrics: {
-        assets: any;
+        assets: {};
     };
 };

package/types/webpack/extract/index.d.ts

@@ -1 +1 @@
-export function extract(webpackStats: any, baseline: any, options: any): {};
+export function extract(webpackStats: any, baseline: any): {};

package/types/webpack/extract/modules-packages-duplicate.d.ts

@@ -8,7 +8,7 @@ export function extractModulesPackagesDuplicate(webpackStats: any, currentExtrac
 } | {
     insights: {
         duplicatePackages: {
-            type: InsightType;
+            type: string;
             data: {};
         };
     };
@@ -18,4 +18,3 @@ export function extractModulesPackagesDuplicate(webpackStats: any, currentExtrac
         };
     };
 };
-import { InsightType } from "../../constants";

package/types/webpack/extract/modules-packages.d.ts

@@ -4,4 +4,4 @@ export declare const getPackageMetaFromModulePath: (modulePath: string) => {
     name: unknown;
     path: string;
 } | null;
-export declare const extractModulesPackages: (webpackStats?: any, currentExtractedData?: WebpackMetricsModules | undefined) => WebpackMetricsPackages;
+export declare const extractModulesPackages: (webpackStats?: any, currentExtractedData?: WebpackMetricsModules) => WebpackMetricsPackages;