@tramvai/cli 6.68.0 → 6.68.2

package/src/builder/webpack/providers/shared.ts

@@ -1,6 +1,7 @@
 import type { Provider } from '@tinkoff/dippy';
 import { provide } from '@tinkoff/dippy';
 import { EventEmitter } from 'events';
+import { calculateBuildTime, maxMemoryRss } from '@tramvai/plugin-webpack-builder';
 import { CONFIG_MANAGER_TOKEN, WITH_BUILD_STATS_TOKEN } from '../../../di/tokens';
 import { closeWorkerPool, warmupWorkerPool } from '../../../library/webpack/utils/threadLoader';
 import {
@@ -11,9 +12,7 @@ import {
   WEBPACK_CLIENT_COMPILER_TOKEN,
   WEBPACK_SERVER_COMPILER_TOKEN,
 } from '../tokens';
-import { calculateBuildTime } from '../utils/calculateBuildTime';
 import { emitWebpackEvents } from '../utils/webpackEvents';
-import { maxMemoryRss } from '../utils/maxMemoryRss';
 
 export const sharedProviders: Provider[] = [
   provide({
@@ -31,8 +30,12 @@ export const sharedProviders: Provider[] = [
       const getMaxMemoryRss = maxMemoryRss();
       return () => {
         return {
-          clientBuildTime: getClientTime?.(),
-          serverBuildTime: getServerTime?.(),
+          client: {
+            buildTime: getClientTime?.(),
+          },
+          server: {
+            buildTime: getServerTime?.(),
+          },
           maxMemoryRss: getMaxMemoryRss?.(),
         };
       };

package/src/commands/benchmark/benchmark.ts

@@ -1,59 +1,194 @@
-import mdtable from 'mdtable';
-import prettyBytes from 'pretty-bytes';
+import { table, TableUserConfig } from 'table';
+import isEmpty from '@tinkoff/utils/is/empty';
+
 import type { Context } from '../../models/context';
 import type { CommandResult } from '../../models/command';
 import type { Result } from '../../api/benchmark';
+import type { CompilationStats } from '../../api/benchmark/types';
+import { DEFAULT_TIMES } from '../../api/benchmark/const';
 
 import { app } from '../index';
 
-const roundStats = (n: number) => Math.round(100 * n) / 100;
+export function toFixedDigits(num: number, digits = 2): number {
+  if (digits === 0) {
+    return Math.floor(num);
+  }
+  return +num.toFixed(digits);
+}
+
+const getUnit = (num: number) => (num > 1 ? 'mins' : 'min');
+
+export function formatCosts(costs: number): string {
+  // more than 1s
+  if (costs >= 1000) {
+    const sec = costs / 1000;
+    // more than 1min
+    if (sec >= 60) {
+      let mins = sec / 60;
+
+      mins = toFixedDigits(mins, 0);
+      const mUnit = getUnit(mins);
+      const restSec = toFixedDigits(sec % 60, 0);
+
+      if (restSec > 0) {
+        return `${mins}${mUnit} ${restSec}s`;
+      }
+      return `${mins}${mUnit}`;
+    }
+
+    return `${toFixedDigits(sec, 1)}s`;
+  }
+
+  if (costs >= 10) {
+    return `${+toFixedDigits(costs, 0)}ms`;
+  }
+
+  if (costs >= 1) {
+    return `${+toFixedDigits(costs, 1)}ms`;
+  }
+
+  let r = +toFixedDigits(costs, 2);
+
+  if (r === 0) {
+    r = +toFixedDigits(costs, 3);
+  }
+
+  return `${r}ms`;
+}
+
+const formatValues = (measures: Record<string, number>) => {
+  const result: [string, string][] = [];
+
+  for (const measureName in measures) {
+    const measureValue = measures[measureName];
+    result.push([measureName, formatCosts(measureValue)]);
+  }
+
+  return result;
+};
+
+const filterStats = (measures: Record<string, number>) => {
+  const entries = Object.entries(measures);
+  entries.sort((a, b) => b[1] - a[1]);
 
-const formatTimeStats = (stats: Result[string]['client']) => {
-  return `${roundStats(stats.mean)}ms ± ${roundStats(stats.variance)}%`;
+  return entries.slice(0, 5).reduce((acc, [key, value]) => {
+    acc[key] = value;
+    return acc;
+  }, {});
 };
 
-const formatMemoryStats = (stats: Result[string]['client']) => {
-  const value = prettyBytes(stats.mean, {
-    maximumFractionDigits: 2,
-  });
+const getInfo = (compilationStats: CompilationStats) => {
+  const { totalBuildCosts, loaderBuildCosts, pluginBuildCosts } = compilationStats;
+
+  const totalBuildInfo = formatValues(totalBuildCosts);
+  const loaderInfo = formatValues(filterStats(loaderBuildCosts));
+  const pluginInfo = formatValues(filterStats(pluginBuildCosts));
 
-  return `${value} ± ${roundStats(stats.variance)}%`;
+  return { totalBuildInfo, loaderInfo, pluginInfo };
 };
 
-const formatStatsTable = (stats: Result) => {
-  const header = [''] as string[];
-  const alignment = ['C'] as string[];
-  const rows = [['time'], ['mem']] as string[][];
+const mergeTotalInfo = (
+  server?: [string, string][] | undefined,
+  client?: [string, string][] | undefined
+) => {
+  const result = [];
 
-  for (const key in stats) {
-    header.push(key);
-    alignment.push('C');
+  for (let i = 0; i < (server?.length ?? client?.length); i++) {
+    result.push([
+      server?.[i][0] ?? client?.[i][0] ?? '-',
+      server?.[i][1] ?? '0',
+      client?.[i][1] ?? '0',
+    ]);
+  }
+
+  return result;
+};
 
-    const { client, server, maxMemoryRss } = stats[key];
+const mergeAdditionalInfo = (
+  server?: [string, string][] | undefined,
+  client?: [string, string][] | undefined
+) => {
+  const result = [];
 
-    rows[0].push(`${formatTimeStats(client)} / ${formatTimeStats(server)}`);
-    rows[1].push(formatMemoryStats(maxMemoryRss));
+  for (let i = 0; i < (server?.length ?? client?.length); i++) {
+    result.push([
+      server?.[i][0] ?? '-',
+      server?.[i][1] ?? '0',
+      client?.[i][0] ?? '-',
+      client?.[i][1] ?? 0,
+    ]);
   }
 
-  return mdtable(
-    {
-      header,
-      alignment,
-      rows,
-    },
-    {
-      borders: true,
-      padding: 1,
-    }
-  );
+  return result;
+};
+
+const formatBuildTime = (totalBuildTime) =>
+  totalBuildTime ? `${(totalBuildTime / 1000).toFixed(2)}s` : '-';
+
+const formatMemoryRss = (memoryRss) => (memoryRss ? `${(memoryRss / 1000000).toFixed(2)}mb` : '-');
+
+const formatStatsTables = (stats: Result, times: number | undefined = DEFAULT_TIMES) => {
+  const {
+    clientBuildTime,
+    clientCompilationStats,
+    serverBuildTime,
+    serverCompilationStats,
+    maxMemoryRss,
+    clientMaxMemoryRss,
+    serverMaxMemoryRss,
+  } = stats;
+  const serverInfo = !isEmpty(serverCompilationStats) && getInfo(serverCompilationStats);
+  const clientInfo = !isEmpty(clientCompilationStats) && getInfo(clientCompilationStats);
+
+  const totalBuildData = [
+    [`Mean durations (${times} times)`, 'server', 'client'],
+    ['Total build time', formatBuildTime(serverBuildTime), formatBuildTime(clientBuildTime)],
+    maxMemoryRss
+      ? ['Total memory', formatMemoryRss(maxMemoryRss), '']
+      : ['Total memory', formatMemoryRss(serverMaxMemoryRss), formatMemoryRss(clientMaxMemoryRss)],
+    ...mergeTotalInfo(serverInfo.totalBuildInfo, clientInfo.totalBuildInfo),
+  ].filter(Boolean);
+
+  const totalBuildTableConfig: TableUserConfig = {
+    columns: [{ alignment: 'left' }, { alignment: 'center' }, { alignment: 'center' }],
+  };
+
+  if (maxMemoryRss) {
+    // @ts-expect-error
+    totalBuildTableConfig.spanningCells = [{ col: 1, row: 2, colSpan: 2, alignment: 'center' }];
+  }
+
+  const mergedLoadersInfo = mergeAdditionalInfo(serverInfo.loaderInfo, clientInfo.loaderInfo);
+  const mergedPluginsInfo = mergeAdditionalInfo(serverInfo.pluginInfo, clientInfo.pluginInfo);
+  const additionalBuildData = [
+    ['server', '', 'client', ''],
+    ['Loaders', '', '', ''],
+    ...mergedLoadersInfo,
+    ['Plugins', '', '', ''],
+    ...mergedPluginsInfo,
+  ];
+
+  const additionalBuildTableConfig: TableUserConfig = {
+    spanningCells: [
+      { col: 0, row: 0, colSpan: 2, alignment: 'center' },
+      { col: 2, row: 0, colSpan: 2, alignment: 'center' },
+      { col: 0, row: 1, colSpan: 4, alignment: 'center' },
+      { col: 0, row: mergedLoadersInfo.length + 2, colSpan: 4, alignment: 'center' },
+    ],
+  };
+
+  return [
+    table(totalBuildData, totalBuildTableConfig),
+    table(additionalBuildData, additionalBuildTableConfig),
+  ];
 };
 
-export default async (context: Context, parameters): Promise<CommandResult | any> => {
+export default async (_context: Context, parameters): Promise<CommandResult | any> => {
   const { command, times, ...commandOptions } = parameters;
 
   const stats = await app.run('benchmark', { command, times, commandOptions });
 
-  console.log(formatStatsTable(stats));
+  formatStatsTables(stats, times).forEach((buildTable) => console.log(buildTable));
 
   return Promise.resolve({
     status: 'ok',

package/src/commands/benchmark/command.ts

@@ -32,11 +32,30 @@ export class BenchmarkCommand extends CLICommand<Params> {
       description:
         'Specify the names of the bundles that need to be collected, other bundles will not be collected and their request will fail with an error',
     },
+    {
+      name: '--fileCache',
+      value: '[fileCache]',
+      transformer: (value: string) => value !== 'false',
+      description: 'Enable/disable persistent file cache for used cli builder',
+    },
+    {
+      name: '-t, --buildType',
+      value: '[type]',
+      description: 'Build type <client|server>',
+      defaultValue: 'client',
+    },
     {
       name: '--times',
       value: '[times]',
       description: 'How many times to run single type of benchmark',
     },
+    {
+      name: '--experimentalWebpackWorkerThreads',
+      value: '[experimentalWebpackWorkerThreads]',
+      transformer: (value: string) => value !== 'false',
+      description:
+        'Enable new experimental @tramvai/api builder to run webpack compilation in worker threads',
+    },
   ];
 
   alias = 'bench';

package/src/config/configManager.ts

@@ -37,6 +37,7 @@ export interface Settings<E extends Env> {
   profile?: boolean;
   noServerRebuild?: boolean;
   noClientRebuild?: boolean;
+  benchmark?: boolean;
   resolveSymlinks?: boolean;
   showConfig?: boolean;
   onlyBundles?: string[];
@@ -131,6 +132,7 @@ export const createConfigManager = <C extends ConfigEntry = ConfigEntry, E exten
     profile: false,
     noClientRebuild: false,
     noServerRebuild: false,
+    benchmark: false,
     resolveSymlinks: true,
     disableProdOptimization: false,
     onlyBundles: [],

package/src/library/webpack/common/main.ts

@@ -3,6 +3,8 @@ import type Config from 'webpack-chain';
 import path from 'path';
 import { existsSync } from 'fs-extra';
 import findCacheDir from 'find-cache-dir';
+import { RsdoctorWebpackMultiplePlugin } from '@rsdoctor/webpack-plugin';
+import { getRsdoctorOptions } from '@tramvai/plugin-webpack-builder';
 import { ignoreWarnings } from '../utils/warningsFilter';
 import resolve from '../blocks/resolve';
 import ignoreLocales from '../blocks/ignoreLocales';
@@ -126,6 +128,12 @@ export default (configManager: ConfigManager<CliConfigEntry>) => (config: Config
       },
     ]);
 
+  if (configManager.benchmark) {
+    config
+      .plugin('rsdoctor-benchmark')
+      .use(RsdoctorWebpackMultiplePlugin, [getRsdoctorOptions(configManager.buildType)]);
+  }
+
   // TODO: remove after dropping support for node@14
   if (configManager.buildType === 'server') {
     config.plugin('node-performance').use(webpack.ProvidePlugin, [

package/src/library/webpack/utils/threadLoader.ts

@@ -43,6 +43,7 @@ const createWorkerPoolConfig = (configManager: ConfigManager<CliConfigEntry>) =>
 
 const isApplicable = (configManager: ConfigManager<CliConfigEntry>) => {
   return (
+    !configManager.benchmark &&
     process.env.TRAMVAI_DISABLE_THREAD_LOADER !== 'true' &&
     // thread-loader uses child_process.fork under the hood, and sometimes (50/50) work in these processes does not get into inspector.Session profile
     !process.env.TRAMVAI_CPU_PROFILE &&

package/src/typings/build/Builder.ts

@@ -1,3 +1,5 @@
+import { BuildStats } from '@tramvai/api/lib/builder/dev-server';
+
 export interface BuilderCustomOptions {
   [key: string]: Record<string, any>;
 }
@@ -35,8 +37,8 @@ interface BuilderAnalyzeOptions {
 }
 
 export type GetBuildStats = () => {
-  clientBuildTime?: number;
-  serverBuildTime?: number;
+  client?: BuildStats;
+  server?: BuildStats;
   maxMemoryRss?: number;
 };
 

package/lib/builder/webpack/utils/calculateBuildTime.d.ts

@@ -1,3 +0,0 @@
-import type { Compiler } from 'webpack';
-export declare const calculateBuildTime: (compiler: Compiler) => () => number;
-//# sourceMappingURL=calculateBuildTime.d.ts.map

package/lib/builder/webpack/utils/calculateBuildTime.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"calculateBuildTime.d.ts","sourceRoot":"","sources":["../../../../src/builder/webpack/utils/calculateBuildTime.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExC,eAAO,MAAM,kBAAkB,aAAc,QAAQ,iBAcpD,CAAC"}

package/lib/builder/webpack/utils/calculateBuildTime.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateBuildTime = void 0;
-const calculateBuildTime = (compiler) => {
-    let startTime = Date.now();
-    let timeDiff;
-    compiler.hooks.invalid.tap('calculateBuildTime', () => {
-        startTime = Date.now();
-    });
-    compiler.hooks.done.tap('calculateBuildTime', (stats) => {
-        timeDiff = Date.now() - startTime;
-    });
-    return () => {
-        return timeDiff;
-    };
-};
-exports.calculateBuildTime = calculateBuildTime;
-//# sourceMappingURL=calculateBuildTime.js.map

package/lib/builder/webpack/utils/calculateBuildTime.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"calculateBuildTime.js","sourceRoot":"","sources":["../../../../src/builder/webpack/utils/calculateBuildTime.ts"],"names":[],"mappings":";;;AAEO,MAAM,kBAAkB,GAAG,CAAC,QAAkB,EAAE,EAAE;IACvD,IAAI,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC3B,IAAI,QAAgB,CAAC;IAErB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,GAAG,EAAE;QACpD,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE;QACtD,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,EAAE;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;AACJ,CAAC,CAAC;AAdW,QAAA,kBAAkB,sBAc7B"}

package/lib/builder/webpack/utils/maxMemoryRss.d.ts

@@ -1,2 +0,0 @@
-export declare const maxMemoryRss: () => () => number;
-//# sourceMappingURL=maxMemoryRss.d.ts.map

package/lib/builder/webpack/utils/maxMemoryRss.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"maxMemoryRss.d.ts","sourceRoot":"","sources":["../../../../src/builder/webpack/utils/maxMemoryRss.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY,oBAWxB,CAAC"}

package/lib/builder/webpack/utils/maxMemoryRss.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.maxMemoryRss = void 0;
-const maxMemoryRss = () => {
-    let maxMemory = process.memoryUsage.rss();
-    const interval = setInterval(() => {
-        maxMemory = Math.max(maxMemory, process.memoryUsage.rss());
-    }, 5000);
-    return () => {
-        clearInterval(interval);
-        return maxMemory;
-    };
-};
-exports.maxMemoryRss = maxMemoryRss;
-//# sourceMappingURL=maxMemoryRss.js.map

package/lib/builder/webpack/utils/maxMemoryRss.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"maxMemoryRss.js","sourceRoot":"","sources":["../../../../src/builder/webpack/utils/maxMemoryRss.ts"],"names":[],"mappings":";;;AAAO,MAAM,YAAY,GAAG,GAAG,EAAE;IAC/B,IAAI,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;IAE1C,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;QAChC,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC;IAC7D,CAAC,EAAE,IAAI,CAAC,CAAC;IAET,OAAO,GAAG,EAAE;QACV,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxB,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;AACJ,CAAC,CAAC;AAXW,QAAA,YAAY,gBAWvB"}

package/src/api/benchmark/utils/stats.spec.ts

@@ -1,36 +0,0 @@
-import { getSamplesStats } from './stats';
-
-describe('getSamplesStats', () => {
-  it('base case', () => {
-    const samples = [1, 1, 1, 1, 1];
-
-    expect(getSamplesStats(samples)).toEqual({
-      samples,
-      mean: 1,
-      std: 0,
-      variance: 0,
-    });
-  });
-
-  it('case 1', () => {
-    const samples = [1, 2, 3, 4, 5, 6, 7];
-
-    expect(getSamplesStats(samples)).toEqual({
-      samples,
-      mean: 4,
-      std: 2,
-      variance: 50,
-    });
-  });
-
-  it('case 2', () => {
-    const samples = [100, 105, 103, 95, 102, 109, 98];
-
-    expect(getSamplesStats(samples)).toEqual({
-      samples,
-      mean: 101.71428571428571,
-      std: 4.266624149448022,
-      variance: 4.194714753670809,
-    });
-  });
-});

package/src/builder/webpack/utils/calculateBuildTime.ts

@@ -1,17 +0,0 @@
-import type { Compiler } from 'webpack';
-
-export const calculateBuildTime = (compiler: Compiler) => {
-  let startTime = Date.now();
-  let timeDiff: number;
-
-  compiler.hooks.invalid.tap('calculateBuildTime', () => {
-    startTime = Date.now();
-  });
-  compiler.hooks.done.tap('calculateBuildTime', (stats) => {
-    timeDiff = Date.now() - startTime;
-  });
-
-  return () => {
-    return timeDiff;
-  };
-};

package/src/builder/webpack/utils/maxMemoryRss.ts

@@ -1,12 +0,0 @@
-export const maxMemoryRss = () => {
-  let maxMemory = process.memoryUsage.rss();
-
-  const interval = setInterval(() => {
-    maxMemory = Math.max(maxMemory, process.memoryUsage.rss());
-  }, 5000);
-
-  return () => {
-    clearInterval(interval);
-    return maxMemory;
-  };
-};