@bundle-stats/utils 4.3.0-beta.1 → 4.3.0-beta.3

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

@@ -2,7 +2,15 @@ import map from 'lodash/map';
 import orderBy from 'lodash/orderBy';
 import sum from 'lodash/sum';
 
-import { InsightType } from '../../config';
+import {
+  InsightType,
+  Job,
+  JobInsight,
+  JobInsightDuplicatePackagesData,
+  JobInsightDuplicatePackagesV3Data,
+  JobInsights,
+  MetricRun,
+} from '../../constants';
 import { Packages } from '../types';
 
 interface DuplicatePackage {
@@ -16,7 +24,116 @@ interface DuplicatePackageGroup {
   children: Array<DuplicatePackage>;
 }
 
-export const extractModulesPackagesDuplicate = (_: any, currentExtractedData: any) => {
+interface ModulesPackagesDuplicateData {
+  insights: {
+    duplicatePackages?: JobInsights['webpack']['duplicatePackages'];
+    duplicatePackagesV3: JobInsights['webpack']['duplicatePackagesV3'];
+  };
+  metrics: {
+    duplicatePackagesCount: MetricRun;
+  };
+}
+
+export const getDuplicatePackagesInsight = (
+  duplicatePackagesMap: Record<string, Array<string>>,
+  baselineDuplicatePackagesMap?: Record<string, Array<string>>,
+): JobInsight<JobInsightDuplicatePackagesV3Data> => {
+  const duplicateInstances: Array<string> = [];
+  const baselineDuplicateInstances: Array<string> = [];
+  const newDuplicateInstances: Array<string> = [];
+  const removedDuplicateInstances: Array<string> = [];
+
+  Object.entries(duplicatePackagesMap).forEach(([id, instances]) => {
+    instances.forEach((duplicateInstance) => {
+      if (duplicateInstance === id) {
+        return;
+      }
+
+      duplicateInstances.push(duplicateInstance);
+
+      if (baselineDuplicatePackagesMap?.[id]?.includes(duplicateInstance)) {
+        return;
+      }
+
+      newDuplicateInstances.push(duplicateInstance);
+    });
+  });
+
+  if (baselineDuplicatePackagesMap) {
+    Object.entries(baselineDuplicatePackagesMap).forEach(([id, instances]) => {
+      instances.forEach((duplicateInstance) => {
+        if (duplicateInstance === id) {
+          return;
+        }
+
+        baselineDuplicateInstances.push(duplicateInstance);
+
+        if (duplicatePackagesMap?.[id]?.includes(duplicateInstance)) {
+          return;
+        }
+
+        removedDuplicateInstances.push(duplicateInstance);
+      });
+    });
+  }
+
+  const duplicateInstancesCount = duplicateInstances.length;
+  const newDuplicateInstancesCount = newDuplicateInstances.length;
+  const removedDuplicateInstancesCount = removedDuplicateInstances.length;
+
+  let text: string;
+  let insightType: InsightType;
+
+  if (newDuplicateInstancesCount > 0 && removedDuplicateInstancesCount > 0) {
+    // New duplicate packages and removed duplicates
+    const item =
+      newDuplicateInstancesCount > 1 || removedDuplicateInstancesCount > 1 ? 'packages' : 'package';
+    text = `Bundle introduced ${newDuplicateInstancesCount} and removed ${removedDuplicateInstancesCount} duplicate ${item}`;
+    insightType = InsightType.ERROR;
+  } else if (newDuplicateInstancesCount > 0 && baselineDuplicatePackagesMap) {
+    // New duplicate packages and baseline comparison
+    const item = newDuplicateInstancesCount > 1 ? 'packages' : 'package';
+    text = `Bundle introduced ${newDuplicateInstancesCount} duplicate ${item}`;
+    insightType = InsightType.ERROR;
+  } else if (newDuplicateInstancesCount > 0) {
+    // New duplicate packages and no baseline
+    const item = newDuplicateInstancesCount > 1 ? 'packages' : 'package';
+    text = `Bundle contains ${newDuplicateInstancesCount} duplicate ${item}`;
+    insightType = InsightType.WARNING;
+  } else if (removedDuplicateInstancesCount > 0) {
+    // Removed duplicate packages
+    const item = removedDuplicateInstancesCount > 1 ? 'packages' : 'package';
+    text = `Bundle removed ${removedDuplicateInstancesCount} duplicate ${item}`;
+    insightType = InsightType.INFO;
+  } else if (
+    newDuplicateInstancesCount === 0 &&
+    removedDuplicateInstancesCount === 0 &&
+    duplicateInstancesCount > 0
+  ) {
+    // No change comparred with the baseline
+    const item = duplicateInstancesCount > 1 ? 'packages' : 'package';
+    text = `Bundle contains ${duplicateInstancesCount} duplicate ${item}`;
+    insightType = InsightType.WARNING;
+  } else {
+    // No change
+    text = 'Bundle does not contain duplicate packages';
+    insightType = InsightType.INFO;
+  }
+
+  return {
+    type: insightType,
+    data: {
+      text,
+      packages: duplicatePackagesMap,
+    },
+  };
+};
+
+export const extractModulesPackagesDuplicate = (
+  _: any,
+  currentExtractedData: any,
+  baselineJob?: Job,
+): ModulesPackagesDuplicateData => {
   const source: Packages = currentExtractedData?.metrics?.packages || {};
 
   // Group packages by name(uniq)
@@ -58,8 +175,16 @@ export const extractModulesPackagesDuplicate = (_: any, currentExtractedData: an
     });
   });
 
+  const baselineDuplicatePackages =
+    baselineJob?.insights?.webpack?.duplicatePackagesV3?.data?.packages ||
+    baselineJob?.insights?.webpack?.duplicatePackages?.data ||
+    {};
+
   if (!count) {
     return {
+      insights: {
+        duplicatePackagesV3: getDuplicatePackagesInsight({}, baselineDuplicatePackages),
+      },
       metrics: {
         duplicatePackagesCount: {
           value: count,
@@ -68,7 +193,12 @@ export const extractModulesPackagesDuplicate = (_: any, currentExtractedData: an
     };
   }
 
-  const duplicatePackagesByName = orderBy(duplicatePackages, 'value', 'desc').reduce(
+  // Group duplicate packages by name and order children by value
+  const duplicatePackagesByName: Record<string, DuplicatePackageGroup> = orderBy(
+    duplicatePackages,
+    'value',
+    'desc',
+  ).reduce(
     (agg, { name, ...duplicatePackageData }: DuplicatePackageGroup) => ({
       ...agg,
       [name]: {
@@ -80,21 +210,27 @@ export const extractModulesPackagesDuplicate = (_: any, currentExtractedData: an
   );
 
   // Generate v2 data structure
-  // @TODO remove in v4.0
-  const data = Object.entries(duplicatePackagesByName).reduce(
-    (agg, [packageName, duplicatePackageData]) => ({
-      ...agg,
-      [packageName]: (duplicatePackageData as DuplicatePackageGroup).children.map(({ id }) => id),
-    }),
-    {},
-  );
+  // @TODO remove in v5.0
+  const duplicatePackagesData: JobInsightDuplicatePackagesData = {};
+
+  Object.entries(duplicatePackagesByName).forEach(([packageName, packageData]) => {
+    if (!duplicatePackagesData[packageName]) {
+      duplicatePackagesData[packageName] = [];
+    }
+
+    duplicatePackagesData[packageName] = packageData.children.map(({ id }) => id);
+  });
 
   return {
     insights: {
       duplicatePackages: {
         type: InsightType.WARNING,
-        data,
+        data: duplicatePackagesData,
       },
+      duplicatePackagesV3: getDuplicatePackagesInsight(
+        duplicatePackagesData,
+        baselineDuplicatePackages,
+      ),
     },
     metrics: {
       duplicatePackagesCount: {

package/src/webpack/extract/modules-packages-new-insight.ts

@@ -0,0 +1,80 @@
+import { InsightType, Job, JobInsights } from '../../constants';
+import { Packages } from '../types';
+
+interface ModulesPackagesNewData {
+  insights?: {
+    newPackages: JobInsights['webpack']['newPackages'];
+  };
+}
+
+const getPackageNames = (packages: Packages): Set<string> => {
+  const result: Set<string> = new Set();
+
+  Object.values(packages).forEach((metricPackage) => {
+    result.add(metricPackage.name);
+  });
+
+  return result;
+};
+
+const getText = (newPackages: Array<string>) => {
+  if (newPackages.length === 1) {
+    return `Bundle introduced one new package: ${newPackages[0]}`;
+  }
+
+  const firstNewPackages = newPackages.slice(0, 3);
+  const otherPackages = newPackages.slice(3);
+
+  const text = `Bundle introduced ${newPackages.length} new packages: ${firstNewPackages.join(', ')}`;
+
+  if (otherPackages.length === 0) {
+    return text;
+  }
+
+  if (otherPackages.length === 1) {
+    return `${text} and one more`;
+  }
+
+  return `${text} and ${otherPackages.length} more`;
+};
+
+export const extractModulesPackagesNewInsight = (
+  _: any,
+  currentExtractedData: any,
+  baselineJob?: Job,
+): ModulesPackagesNewData | null => {
+  const currentMetricPackages = currentExtractedData?.metrics?.packages as Packages;
+  const baselineMetricPackages = baselineJob?.metrics?.webpack?.packages as Packages;
+
+  // Skip insight when the baseline data is missing
+  if (!baselineMetricPackages) {
+    return null;
+  }
+
+  const currentPackages = getPackageNames(currentMetricPackages);
+  const baselinePackages = getPackageNames(baselineMetricPackages);
+
+  const newPackages: Array<string> = [];
+
+  currentPackages.forEach((packageName) => {
+    if (!baselinePackages.has(packageName)) {
+      newPackages.push(packageName);
+    }
+  });
+
+  if (newPackages.length === 0) {
+    return null;
+  }
+
+  return {
+    insights: {
+      newPackages: {
+        type: InsightType.WARNING,
+        data: {
+          text: getText(newPackages),
+          packages: newPackages,
+        },
+      },
+    },
+  };
+};

package/types/config/index.d.ts

@@ -1,11 +1,6 @@
 export * from "./component-links";
 export * from "./file-types";
-export * from "./insights";
 export * from "./metrics";
 export * from "./delta";
 export const PACKAGES_SEPARATOR: ":";
 export const PACKAGE_ID_SEPARATOR: "~";
-export const SOURCE_PATH_WEBPACK_STATS: "webpack";
-export const SOURCE_PATH_LIGHTHOUSE: "lighthouse";
-export const SOURCE_PATH_BROWSERTIME: "browsertime";
-export const SOURCE_PATHS: string[];

package/types/constants.d.ts

@@ -1,10 +1,20 @@
+export declare enum Source {
+    webpack = "webpack",
+    lighthouse = "lighthouse",
+    browsertime = "browsertime"
+}
 export type SourceData = Record<string, unknown>;
+export declare enum InsightType {
+    ERROR = "error",
+    INFO = "info",
+    WARNING = "warning"
+}
 export declare enum MetricTypeType {
-    'METRIC_TYPE_NUMERIC' = "METRIC_TYPE_NUMERIC",
-    'METRIC_TYPE_SCORE' = "METRIC_TYPE_SCORE",
-    'METRIC_TYPE_FILE_SIZE' = "METRIC_TYPE_FILE_SIZE",
-    'METRIC_TYPE_DURATION' = "METRIC_TYPE_DURATION",
-    'METRIC_TYPE_PERCENTAGE' = "METRIC_TYPE_PERCENTAGE"
+    METRIC_TYPE_NUMERIC = "METRIC_TYPE_NUMERIC",
+    METRIC_TYPE_SCORE = "METRIC_TYPE_SCORE",
+    METRIC_TYPE_FILE_SIZE = "METRIC_TYPE_FILE_SIZE",
+    METRIC_TYPE_DURATION = "METRIC_TYPE_DURATION",
+    METRIC_TYPE_PERCENTAGE = "METRIC_TYPE_PERCENTAGE"
 }
 export interface MetricTypeConfig {
     label: string;
@@ -36,20 +46,53 @@ export interface MetricRunInfo {
     displayDelta?: string;
     displayDeltaPercentage?: string;
 }
+export type JobSection<T = object> = Record<Source, T>;
+export declare enum JobSectionId {
+    meta = "meta",
+    insights = "insights",
+    summary = "summary",
+    metrics = "metrics",
+    rawData = "rawData"
+}
 export interface JobSummaryItem {
     baseline: number;
     current: number;
 }
+export interface JobInsight<T = object> {
+    type: InsightType;
+    data: T & {
+        text?: string;
+    };
+}
+export interface JobInsightAssetsSizeTotalData {
+    md: string;
+    info: MetricRunInfo;
+}
+export type JobInsightDuplicatePackagesData = Record<string, Array<string>>;
+export interface JobInsightDuplicatePackagesV3Data {
+    packages: Record<string, Array<string>>;
+}
+export interface JobInsightNewPackagesData {
+    packages: Array<string>;
+}
 export type JobSummarySource = Record<string, JobSummaryItem>;
-export type JobSummary = Record<string, JobSummarySource>;
+export type JobSummary = JobSection<JobSummarySource>;
+export interface JobInsights {
+    [Source.webpack]: {
+        assetsSizeTotal: JobInsight<JobInsightAssetsSizeTotalData>;
+        duplicatePackages?: JobInsight<JobInsightDuplicatePackagesData>;
+        duplicatePackagesV3?: JobInsight<JobInsightDuplicatePackagesV3Data>;
+        newPackages?: JobInsight<JobInsightNewPackagesData>;
+    };
+}
 export type JobMetricsSource = Record<string, MetricRun | Record<string, MetricRun>>;
-export type JobMetrics = Record<string, JobMetricsSource>;
+export type JobMetrics = JobSection<JobMetricsSource>;
 export interface JobData {
-    meta?: any;
-    insights?: any;
-    summary?: JobSummary;
-    metrics?: JobMetrics;
-    rawData?: any;
+    [JobSectionId.meta]?: JobSection;
+    [JobSectionId.insights]?: JobInsights;
+    [JobSectionId.summary]?: JobSummary;
+    [JobSectionId.metrics]?: JobMetrics;
+    [JobSectionId.rawData]?: JobSection;
 }
 export interface Job extends JobData {
     internalBuildNumber: number;

package/types/utils/component-links.d.ts

@@ -25,8 +25,9 @@ export declare const BUNDLE_MODULES: ComponentLink;
 export declare const BUNDLE_MODULES_DUPLICATE: ComponentLink;
 export declare const getBundleModulesBySearch: (search: string) => ComponentLink;
 export declare const getBundleModulesByChunk: (chunkIds: Array<string>, chunkId: string, fileType?: string) => ComponentLink;
-export declare const BUNLDE_PACKAGES_COUNT: ComponentLink;
+export declare const BUNDLE_PACKAGES_COUNT: ComponentLink;
 export declare const BUNDLE_PACKAGES_DUPLICATE: ComponentLink;
+export declare const BUNDLE_PACKAGES_DUPLICATE_NEW: ComponentLink;
 export declare const getBundleAssetsFileTypeComponentLink: (fileType: string, label: string) => ComponentLink;
 export declare const getBundlePackagesByNameComponentLink: (search: string) => ComponentLink;
 export declare const getComponentStateQueryString: (params?: {}) => string;

package/types/webpack/extract/assets-size-total-insight.d.ts

@@ -5,9 +5,9 @@ export function extractAssetsSizeTotalInsight(_: any, currentExtractedData: any,
             data: {
                 text: string;
                 md: string;
-                info: import("../..").MetricRunInfo;
+                info: import("../../constants").MetricRunInfo;
             };
         };
     };
 };
-import { InsightType } from "../../config/insights";
+import { InsightType } from "../../constants";

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

@@ -1,21 +1,13 @@
-import { InsightType } from '../../config';
-export declare const extractModulesPackagesDuplicate: (_: any, currentExtractedData: any) => {
-    metrics: {
-        duplicatePackagesCount: {
-            value: number;
-        };
-    };
-    insights?: undefined;
-} | {
+import { Job, JobInsight, JobInsightDuplicatePackagesV3Data, JobInsights, MetricRun } from '../../constants';
+interface ModulesPackagesDuplicateData {
     insights: {
-        duplicatePackages: {
-            type: InsightType;
-            data: {};
-        };
+        duplicatePackages?: JobInsights['webpack']['duplicatePackages'];
+        duplicatePackagesV3: JobInsights['webpack']['duplicatePackagesV3'];
     };
     metrics: {
-        duplicatePackagesCount: {
-            value: number;
-        };
+        duplicatePackagesCount: MetricRun;
     };
-};
+}
+export declare const getDuplicatePackagesInsight: (duplicatePackagesMap: Record<string, Array<string>>, baselineDuplicatePackagesMap?: Record<string, Array<string>>) => JobInsight<JobInsightDuplicatePackagesV3Data>;
+export declare const extractModulesPackagesDuplicate: (_: any, currentExtractedData: any, baselineJob?: Job) => ModulesPackagesDuplicateData;
+export {};

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

@@ -0,0 +1,8 @@
+import { Job, JobInsights } from '../../constants';
+interface ModulesPackagesNewData {
+    insights?: {
+        newPackages: JobInsights['webpack']['newPackages'];
+    };
+}
+export declare const extractModulesPackagesNewInsight: (_: any, currentExtractedData: any, baselineJob?: Job) => ModulesPackagesNewData | null;
+export {};

package/lib/config/insights.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InsightType = void 0;
-var InsightType;
-(function (InsightType) {
-    InsightType["ERROR"] = "ERROR";
-    InsightType["INFO"] = "INFO";
-    InsightType["WARNING"] = "WARNING";
-})(InsightType = exports.InsightType || (exports.InsightType = {}));
-//# sourceMappingURL=insights.js.map

package/lib/config/insights.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"insights.js","sourceRoot":"","sources":["../../src/config/insights.ts"],"names":[],"mappings":";;;AAAA,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,8BAAe,CAAA;IACf,4BAAa,CAAA;IACb,kCAAmB,CAAA;AACrB,CAAC,EAJW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAItB"}

package/lib-esm/config/insights.js

@@ -1,7 +0,0 @@
-export var InsightType;
-(function (InsightType) {
-    InsightType["ERROR"] = "ERROR";
-    InsightType["INFO"] = "INFO";
-    InsightType["WARNING"] = "WARNING";
-})(InsightType || (InsightType = {}));
-//# sourceMappingURL=insights.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"insights.js","sourceRoot":"","sources":["../../src/config/insights.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,8BAAe,CAAA;IACf,4BAAa,CAAA;IACb,kCAAmB,CAAA;AACrB,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB"}

package/src/config/insights.ts

@@ -1,5 +0,0 @@
-export enum InsightType {
-  ERROR = 'ERROR',
-  INFO = 'INFO',
-  WARNING = 'WARNING',
-}

package/types/config/insights.d.ts

@@ -1,5 +0,0 @@
-export declare enum InsightType {
-    ERROR = "ERROR",
-    INFO = "INFO",
-    WARNING = "WARNING"
-}