@bundle-stats/ui 4.13.0-beta.9 → 4.13.0-rc.1

package/src/components/bundle-modules/bundle-modules.tsx

@@ -1,13 +1,15 @@
 import React, { useCallback, useMemo } from 'react';
 import cx from 'classnames';
-import { SECTIONS, COMPONENT } from '@bundle-stats/utils';
+import { SECTIONS, COMPONENT, type Job } from '@bundle-stats/utils';
 
+import { WebpackChunk } from '@bundle-stats/utils';
 import { SortAction } from '../../types';
 import config from '../../config.json';
 import I18N from '../../i18n';
-import { Box } from '../../layout/box';
 import { MetricsDisplayType } from '../../constants';
+import { Box } from '../../layout/box';
 import { FlexStack } from '../../layout/flex-stack';
+import { Stack } from '../../layout/stack';
 import { Button } from '../../ui/button';
 import { ControlGroup } from '../../ui/control-group';
 import { EmptySet } from '../../ui/empty-set';
@@ -21,18 +23,22 @@ import { Tooltip } from '../../ui/tooltip';
 import { ComponentLink } from '../component-link';
 import { MetricsTable } from '../metrics-table';
 import { MetricsTableHeader } from '../metrics-table-header';
-import { MetricsTreemap } from '../metrics-treemap';
+import { MetricsTreemap, getTreemapNodes, getTreemapNodesGroupedByPath } from '../metrics-treemap';
 import { MetricsTableOptions } from '../metrics-table-options';
 import { MetricsDisplaySelector } from '../metrics-display-selector';
 import { MetricsTableTitle } from '../metrics-table-title';
 import { ModuleInfo } from '../module-info';
 import { generateFilterFieldsData } from './bundle-modules.utils';
 import { ModuleMetric } from './bundle-modules.constants';
-import type { Chunk, Job, ReportMetricModuleRow } from './bundle-modules.types';
+import type { ReportMetricModuleRow } from './bundle-modules.types';
 import * as I18N_MODULES from './bundle-modules.i18n';
 import css from './bundle-modules.module.css';
 import { useMetricsDisplayType } from '../../hooks/metrics-display-type';
 
+const DISPLAY_TYPE_GROUPS = {
+  [MetricsDisplayType.TREEMAP]: ['folder'],
+};
+
 interface RowHeaderProps {
   row: ReportMetricModuleRow;
   filters?: any;
@@ -60,11 +66,83 @@ const RowHeader = (props: RowHeaderProps) => {
   );
 };
 
+interface ViewMetricsTreemapProps {
+  metricsTableTitle: React.ReactNode;
+  jobs: Array<any>;
+  items: Array<any>;
+  displayType: { value: MetricsDisplayType; groupBy?: string };
+  emptyMessage: React.ReactNode;
+  showEntryInfo: React.ComponentProps<typeof MetricsTreemap>['onItemClick'];
+  updateSearch: (newSerarch: string) => void;
+  search: string;
+}
+
+const ViewMetricsTreemap = (props: ViewMetricsTreemapProps) => {
+  const {
+    metricsTableTitle,
+    jobs,
+    items,
+    displayType,
+    emptyMessage,
+    showEntryInfo,
+    updateSearch,
+    search,
+  } = props;
+
+  // Get treenodes based on group
+  const treeNodes = useMemo(() => {
+    if (displayType.groupBy === 'folder') {
+      return getTreemapNodesGroupedByPath(items);
+    }
+
+    return getTreemapNodes(items);
+  }, [items, displayType]);
+
+  // Search based on the group path on group title click
+  const onGroupClick = useCallback(
+    (groupPath: string) => {
+      // Clear seach when groupPath is emty (root)
+      if (groupPath === '') {
+        updateSearch('');
+        return;
+      }
+      // Search by group path
+      // 1. use `^` to match only the string beggining
+      // 2. add `/` suffix to exactly match the directory
+      const newSearch = `^${groupPath}/`;
+
+      // Reset search when toggling the same groupPath
+      if (newSearch === search) {
+        updateSearch('');
+        return;
+      }
+
+      updateSearch(newSearch);
+    },
+    [updateSearch, search],
+  );
+
+  return (
+    <>
+      <Table compact>
+        <MetricsTableHeader metricTitle={metricsTableTitle} showSum jobs={jobs} rows={items} />
+      </Table>
+      <MetricsTreemap
+        treeNodes={treeNodes}
+        nested={Boolean(displayType.groupBy)}
+        emptyMessage={emptyMessage}
+        onItemClick={showEntryInfo}
+        onGroupClick={onGroupClick}
+      />
+    </>
+  );
+};
+
 interface BundleModulesProps extends React.ComponentProps<'div'> {
   jobs?: Array<Job>;
   items?: Array<ReportMetricModuleRow>;
   allItems?: Array<ReportMetricModuleRow>;
-  chunks?: Array<Chunk>;
+  chunks?: Array<WebpackChunk>;
 
   totalRowCount: number;
 
@@ -116,7 +194,7 @@ export const BundleModules = (props: BundleModulesProps) => {
   const rootClassName = cx(css.root, className);
   const jobLabels = jobs?.map((job) => job?.label);
 
-  const [displayType, setDisplayType] = useMetricsDisplayType();
+  const [displayType, setDisplayType] = useMetricsDisplayType(DISPLAY_TYPE_GROUPS);
 
   const filterFieldsData = useMemo(
     () => generateFilterFieldsData({ filters, chunks, compareMode: jobs.length > 1 }),
@@ -170,12 +248,17 @@ export const BundleModules = (props: BundleModulesProps) => {
 
   return (
     <>
-      <div className={rootClassName}>
+      <Stack space="xsmall" as="section" className={rootClassName}>
         <Toolbar
           className={css.toolbar}
           renderActions={({ actionClassName }) => (
             <FlexStack space="xxsmall" className={cx(css.dropdown, actionClassName)}>
-              <MetricsDisplaySelector onSelect={setDisplayType} value={displayType} />
+              <MetricsDisplaySelector
+                onSelect={setDisplayType}
+                value={displayType.value}
+                groupBy={displayType.groupBy}
+                groups={DISPLAY_TYPE_GROUPS}
+              />
               <MetricsTableOptions
                 handleViewAll={resetAllFilters}
                 handleResetFilters={resetFilters}
@@ -197,55 +280,56 @@ export const BundleModules = (props: BundleModulesProps) => {
             />
           </FlexStack>
         </Toolbar>
-        <Box padding={['xsmall', 'small']} className={css.metricSelector}>
-          <ControlGroup as="nav">
-            <Button
-              outline
-              active={moduleMetric === ModuleMetric.SIZE}
-              size="small"
-              type="button"
-              onClick={() => setModuleMetric(ModuleMetric.SIZE)}
-            >
-              <Tooltip title="Size (excluding duplicate modules)">Module size</Tooltip>
-            </Button>
-            <Button
-              outline
-              active={moduleMetric === ModuleMetric.TOTAL_SIZE}
-              size="small"
-              type="button"
-              onClick={() => setModuleMetric(ModuleMetric.TOTAL_SIZE)}
-            >
-              <Tooltip title="Size (including duplicate modules)">Module total size</Tooltip>
-            </Button>
-          </ControlGroup>
+        <Box outline as="main">
+          <Box padding={['xsmall', 'small']} className={css.metricSelector}>
+            <ControlGroup as="nav">
+              <Button
+                outline
+                active={moduleMetric === ModuleMetric.SIZE}
+                size="small"
+                type="button"
+                onClick={() => setModuleMetric(ModuleMetric.SIZE)}
+              >
+                <Tooltip title="Size (excluding duplicate modules)">Module size</Tooltip>
+              </Button>
+              <Button
+                outline
+                active={moduleMetric === ModuleMetric.TOTAL_SIZE}
+                size="small"
+                type="button"
+                onClick={() => setModuleMetric(ModuleMetric.TOTAL_SIZE)}
+              >
+                <Tooltip title="Size (including duplicate modules)">Module total size</Tooltip>
+              </Button>
+            </ControlGroup>
+          </Box>
+          {displayType.value === MetricsDisplayType.TABLE && (
+            <MetricsTable
+              className={css.table}
+              items={items}
+              runs={jobs}
+              renderRowHeader={renderRowHeader}
+              emptyMessage={emptyMessage}
+              showHeaderSum
+              title={metricsTableTitle}
+              sort={sort}
+              updateSort={updateSort}
+            />
+          )}
+          {displayType.value === MetricsDisplayType.TREEMAP && (
+            <ViewMetricsTreemap
+              metricsTableTitle={metricsTableTitle}
+              jobs={jobs}
+              items={items}
+              displayType={displayType}
+              emptyMessage={emptyMessage}
+              showEntryInfo={showEntryInfo}
+              updateSearch={updateSearch}
+              search={search}
+            />
+          )}
         </Box>
-        {displayType === MetricsDisplayType.TABLE && (
-          <MetricsTable
-            className={css.table}
-            items={items}
-            runs={jobs}
-            renderRowHeader={renderRowHeader}
-            emptyMessage={emptyMessage}
-            showHeaderSum
-            title={metricsTableTitle}
-            sort={sort}
-            updateSort={updateSort}
-          />
-        )}
-        {displayType === MetricsDisplayType.TREEMAP && (
-          <>
-            <Table compact>
-              <MetricsTableHeader
-                metricTitle={metricsTableTitle}
-                showSum
-                jobs={jobs}
-                rows={items}
-              />
-            </Table>
-            <MetricsTreemap emptyMessage={emptyMessage} items={items} onItemClick={showEntryInfo} />
-          </>
-        )}
-      </div>
+      </Stack>
       {entryItem && (
         <ModuleInfo
           className={css.moduleInfo}

package/src/components/bundle-modules/bundle-modules.types.d.ts

@@ -1,10 +1,5 @@
-import { Module } from '@bundle-stats/utils/lib-esm/webpack/types';
-import { ReportMetricRun } from '@bundle-stats/utils/types/report/types';
-
-export interface Chunk {
-  id: string;
-  name: string;
-}
+import type { Module } from '@bundle-stats/utils/lib-esm/webpack/types';
+import type { ReportMetricRun } from '@bundle-stats/utils/types/report/types';
 
 export type ReportMetricModuleRow = {
   thirdParty: boolean;
@@ -12,13 +7,3 @@ export type ReportMetricModuleRow = {
   fileType: string;
 } & ReportMetricRun &
   Module;
-
-export interface Job {
-  label: string;
-  internalBuildNumber: number;
-  meta?: {
-    webpack?: {
-      chunks?: Array<Chunk>;
-    };
-  };
-}

package/src/components/bundle-modules/bundle-modules.utils.ts

@@ -2,12 +2,11 @@ import intersection from 'lodash/intersection';
 import get from 'lodash/get';
 import isEmpty from 'lodash/isEmpty';
 import union from 'lodash/union';
-import uniqBy from 'lodash/uniqBy';
 import orderBy from 'lodash/orderBy';
-import type { MetricRunInfo, ReportMetricRow } from '@bundle-stats/utils';
-// @ts-ignore
-import { MODULE_PATH_PACKAGES, type Module } from '@bundle-stats/utils/lib-esm/webpack';
 import {
+  type WebpackChunk,
+  type MetricRunInfo,
+  type ReportMetricRow,
   FILE_TYPE_LABELS,
   MODULE_CHUNK,
   MODULE_FILTERS,
@@ -19,10 +18,12 @@ import {
   getModuleSourceTypeFilters,
   getModuleFileTypeFilters,
 } from '@bundle-stats/utils';
+// @ts-ignore
+import { MODULE_PATH_PACKAGES, type Module } from '@bundle-stats/utils/lib-esm/webpack';
 import type { ReportMetricRun } from '@bundle-stats/utils/types/report/types';
 
 import type { FilterFieldsData, FilterGroupFieldData } from '../../types';
-import type { Chunk, Job, ReportMetricModuleRow } from './bundle-modules.types';
+import type { ReportMetricModuleRow } from './bundle-modules.types';
 import * as I18N from './bundle-modules.i18n';
 
 export const addRowFlags = (row: Module & ReportMetricRow): ReportMetricModuleRow => {
@@ -98,18 +99,6 @@ export const generateGetRowFilter =
   };
 /* eslint-enable prettier/prettier */
 
-export const extractChunkData = (jobs: Array<Job>) => {
-  const jobChunks = jobs.map((job) => job?.meta?.webpack?.chunks || []);
-  const chunks = uniqBy(jobChunks.flat(), ({ id }) => id);
-
-  const chunkIds = chunks?.map(({ id }) => id);
-
-  return {
-    chunks,
-    chunkIds,
-  };
-};
-
 export const generateFilters = (chunkIds: Array<string>, multipleJobs: boolean) => {
   const allEntriesFilters = {
     [MODULE_FILTERS.CHANGED]: false,
@@ -137,7 +126,7 @@ interface GetFiltersFormDataParams {
   /**
    * Chunk data
    */
-  chunks: Array<Chunk>;
+  chunks: Array<WebpackChunk>;
   /**
    * Compare mode
    */

package/src/components/bundle-modules/index.tsx

@@ -1,8 +1,10 @@
 import React, { useCallback, useMemo } from 'react';
+import type { Job } from '@bundle-stats/utils';
 // @ts-ignore
 import * as webpack from '@bundle-stats/utils/lib-esm/webpack';
 
 import type { SortAction } from '../../types';
+import { getJobsChunksData } from '../../utils/jobs';
 import { useRowsFilter } from '../../hooks/rows-filter';
 import { useRowsSort } from '../../hooks/rows-sort';
 import { useSearchParams } from '../../hooks/search-params';
@@ -10,7 +12,6 @@ import { useEntryInfo } from '../../hooks/entry-info';
 import { BundleModules as BaseComponent } from './bundle-modules';
 import {
   addRowFlags,
-  extractChunkData,
   generateGetRowFilter,
   generateFilters,
   getCustomSort,
@@ -64,7 +65,7 @@ interface BundleModulesProps
     | 'hideEntryInfo'
     | 'showEntryInfo'
   > {
-  jobs: Array<types.Job>;
+  jobs: Array<Job>;
   filters: Record<string, boolean>;
   search?: string;
   metric?: string;
@@ -78,7 +79,7 @@ export const BundleModules = (props: BundleModulesProps) => {
 
   const [moduleMetric, setModuleMetric] = useModuleMetric({ metric, setState });
 
-  const { chunks, chunkIds } = useMemo(() => extractChunkData(jobs), [jobs]);
+  const { chunks, chunkIds } = useMemo(() => getJobsChunksData(jobs), [jobs]);
 
   const { defaultFilters, allEntriesFilters } = useMemo(
     () => generateFilters(chunkIds, jobs.length > 1),

package/src/components/bundle-packages/bundle-packages.jsx

@@ -5,7 +5,9 @@ import { COMPONENT, PACKAGE_FILTERS, PACKAGES_SEPARATOR, SECTIONS } from '@bundl
 
 import config from '../../config.json';
 import I18N from '../../i18n';
+import { Box } from '../../layout/box';
 import { FlexStack } from '../../layout/flex-stack';
+import { Stack } from '../../layout/stack';
 import { InputSearch } from '../../ui/input-search';
 import { EmptySet } from '../../ui/empty-set';
 import { Filters } from '../../ui/filters';
@@ -22,9 +24,13 @@ import { SEARCH_PLACEHOLDER } from './bundle-packages.i18n';
 import css from './bundle-packages.module.css';
 import { MetricsDisplaySelector } from '../metrics-display-selector';
 import { MetricsDisplayType } from '../../constants';
-import { MetricsTreemap } from '../metrics-treemap';
+import { MetricsTreemap, getTreemapNodes, getTreemapNodesGroupedByPath } from '../metrics-treemap';
 import { useMetricsDisplayType } from '../../hooks/metrics-display-type';
 
+const DISPLAY_TYPE_GROUPS = {
+  [MetricsDisplayType.TREEMAP]: ['folder'],
+};
+
 const getDropdownFilters = ({ compareMode, filters }) => ({
   [PACKAGE_FILTERS.CHANGED]: {
     label: 'Changed',
@@ -113,6 +119,71 @@ RowHeader.propTypes = {
   search: PropTypes.string,
 };
 
+const ViewMetricsTreemap = (props) => {
+  const { metricsTableTitle, jobs, items, displayType, emptyMessage, showEntryInfo, updateSearch, search } = props;
+
+  // Get treenodes based on group
+  const treeNodes = useMemo(() => {
+    if (displayType.groupBy === 'folder') {
+      return getTreemapNodesGroupedByPath(items);
+    }
+
+    return getTreemapNodes(items);
+  }, [items, displayType.groupBy]);
+
+  // Search based on the group path on group title click
+  const onGroupClick = useCallback(
+    (groupPath) => {
+      // Clear seach when groupPath is emty (root)
+      if (groupPath === '') {
+        updateSearch('');
+        return;
+      }
+      // Search by group path
+      // 1. use `^` to match only the string beggining
+      // 2. add `/` suffix to exactly match the directory
+      const newSearch = `^${groupPath}/`;
+
+      // Reset search when toggling the same groupPath
+      if (newSearch === search) {
+        updateSearch('');
+        return;
+      }
+
+      updateSearch(newSearch);
+    },
+    [updateSearch, search],
+  );
+
+  return (
+    <>
+      <Table compact>
+        <MetricsTableHeader metricTitle={metricsTableTitle} showSum jobs={jobs} rows={items} />
+      </Table>
+      <MetricsTreemap
+        treeNodes={treeNodes}
+        nested={Boolean(displayType.groupBy)}
+        emptyMessage={emptyMessage}
+        onItemClick={showEntryInfo}
+        onGroupClick={onGroupClick}
+      />
+    </>
+  );
+};
+
+ViewMetricsTreemap.propTypes = {
+  jobs: PropTypes.arrayOf(PropTypes.object).isRequired, // eslint-disable-line react/forbid-prop-types
+  items: PropTypes.arrayOf(PropTypes.object).isRequired, // eslint-disable-line react/forbid-prop-types
+  metricsTableTitle: PropTypes.node.isRequired,
+  displayType: PropTypes.shape({
+    groupBy: PropTypes.string,
+  }).isRequired,
+  emptyMessage: PropTypes.node.isRequired,
+  showEntryInfo: PropTypes.func.isRequired,
+  updateSearch: PropTypes.func.isRequired,
+  search: PropTypes.string.isRequired,
+};
+
 export const BundlePackages = (props) => {
   const {
     className,
@@ -137,7 +208,7 @@ export const BundlePackages = (props) => {
 
   const jobLabels = jobs?.map((job) => job?.label);
 
-  const [displayType, setDisplayType] = useMetricsDisplayType();
+  const [displayType, setDisplayType] = useMetricsDisplayType(DISPLAY_TYPE_GROUPS);
 
   const dropdownFilters = useMemo(
     () => getDropdownFilters({ compareMode: jobs?.length > 1, filters }),
@@ -191,12 +262,12 @@ export const BundlePackages = (props) => {
 
   return (
     <>
-      <section className={cx(css.root, className)}>
+      <Stack space="xsmall" as="section" className={cx(css.root, className)}>
         <Toolbar
           className={css.toolbar}
           renderActions={({ actionClassName }) => (
             <FlexStack space="xxsmall" className={cx(css.dropdown, actionClassName)}>
-              <MetricsDisplaySelector onSelect={setDisplayType} value={displayType} />
+              <MetricsDisplaySelector onSelect={setDisplayType} value={displayType.value} groupBy={displayType.groupBy} groups={DISPLAY_TYPE_GROUPS} />
               <MetricsTableOptions
                 handleViewAll={resetAllFilters}
                 handleResetFilters={resetFilters}
@@ -219,8 +290,8 @@ export const BundlePackages = (props) => {
             />
           </FlexStack>
         </Toolbar>
-        <main>
-          {displayType === MetricsDisplayType.TABLE && (
+        <Box outline as="main">
+          {displayType.value === MetricsDisplayType.TABLE && (
             <MetricsTable
               runs={jobs}
               items={items}
@@ -232,21 +303,19 @@ export const BundlePackages = (props) => {
               updateSort={updateSort}
             />
           )}
-          {displayType === MetricsDisplayType.TREEMAP && (
-            <>
-              <Table compact>
-                <MetricsTableHeader
-                  metricTitle={metricsTableTitle}
-                  showSum
-                  jobs={jobs}
-                  rows={items}
-                />
-              </Table>
-              <MetricsTreemap emptyMessage={emptyMessage} items={items} onItemClick={showEntryInfo} />
-            </>
+          {displayType.value === MetricsDisplayType.TREEMAP && (
+            <ViewMetricsTreemap
+              jobs={jobs}
+              items={items}
+              displayType={displayType}
+              emptyMessage={emptyMessage}
+              showEntryInfo={showEntryInfo}
+              updateSearch={updateSearch}
+              search={search}
+            />
           )}
-        </main>
-      </section>
+        </Box>
+      </Stack>
       {entryItem && (
         <PackageInfo
           className={css.packageInfo}

package/src/components/bundle-packages/bundle-packages.module.css

@@ -2,14 +2,9 @@
   color: var(--color-text-light);
 }
 
-.toolbar {
-  border-bottom: 1px solid var(--color-outline);
-}
-
 .toolbarSearch {
   width: 100%;
   max-width: 240px;
-  margin-right: -1px; /** collapse border */
 }
 
 .hoverCard {

package/src/components/delta/delta.jsx

@@ -4,7 +4,7 @@ import cx from 'classnames';
 
 import css from './delta.module.css';
 
-export const Delta = ({ className, displayValue, deltaType, inverted }) => {
+export const Delta = ({ className = '', displayValue, deltaType, inverted = false }) => {
   const rootClassName = cx(css.root, className, inverted && css.inverted, css[deltaType]);
   return <span className={rootClassName}>{displayValue}</span>;
 };

package/src/components/delta/delta.module.css

@@ -4,6 +4,10 @@
   white-space: nowrap;
 }
 
+.CHANGE {
+  color: var(--color-info);
+}
+
 .HIGH_NEGATIVE {
   color: var(--color-red-dark);
 }
@@ -29,11 +33,16 @@
 }
 
 .inverted {
-  border-radius: var(--radius-small);
+  padding: 0 2px;
+  border-radius: var(--radius-xsmall);
   background-color: var(--color-gray-ultra-light);
   color: var(--color-light);
 }
 
+.inverted.CHANGE {
+  background: var(--color-info-light);
+}
+
 .inverted.HIGH_NEGATIVE {
   background: var(--color-red-dark);
 }

package/src/components/jobs-header/jobs-header.module.css

@@ -24,10 +24,6 @@
   background: linear-gradient(90deg, transparent, var(--color-background));
 }
 
-.item + .item {
-  margin-left: var(--space-small);
-}
-
 .item:first-child {
   border-left: 0;
   padding-left: 0;

package/src/components/metrics-display-selector/metrics-display-selector.module.css

@@ -1,10 +1,18 @@
-.button {
-  text-decoration: none;
+.buttonActive {
+  background: var(--color-highlight);
 }
 
-.buttonActive,
-.buttonActive:active,
-.buttonActive:focus {
-  color: var(--color-primary);
-  border-color: var(--color-primary);
+/* explicit ControlGroup last item styles to override ariakit injected sibling nodes */
+.itemLast {
+  border-top-right-radius: var(--radius-small) !important;
+  border-bottom-right-radius: var(--radius-small) !important;
+}
+
+.dropdownItemIcon {
+  opacity: 0;
+  transition: var(--transition-out);
+}
+
+.dropdownItemActive .dropdownItemIcon {
+  opacity: 1;
 }

package/src/components/metrics-display-selector/metrics-display-selector.stories.tsx

@@ -0,0 +1,33 @@
+import { action } from '@storybook/addon-actions'; // eslint-disable-line
+import { Meta, StoryObj } from '@storybook/react';
+
+import { MetricsDisplayType } from '../../constants';
+import { MetricsDisplaySelector } from '.';
+
+const meta: Meta<typeof MetricsDisplaySelector> = {
+  title: 'Components/MetricsDisplaySelector',
+  component: MetricsDisplaySelector,
+  args: {
+    onSelect: action('SELECT'),
+  },
+} as Meta;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    value: MetricsDisplayType.TABLE,
+  },
+};
+
+export const TreemapGroups: Story = {
+  args: {
+    value: MetricsDisplayType.TREEMAP,
+    groupBy: '',
+    groups: {
+      [MetricsDisplayType.TREEMAP]: ['folder'],
+    },
+  },
+};