@mui/internal-bundle-size-checker 1.0.9-canary.5 → 1.0.9-canary.50

package/src/renderMarkdownReport.test.js

@@ -2,25 +2,22 @@
 import { vi, describe, it, expect, beforeEach } from 'vitest';
 import { renderMarkdownReport } from './renderMarkdownReport.js';
 import * as fetchSnapshotModule from './fetchSnapshot.js';
+import * as fetchSnapshotWithFallbackModule from './fetchSnapshotWithFallback.js';
+import * as gitModule from './git.js';
 
 // Mock the fetchSnapshot module
 vi.mock('./fetchSnapshot.js');
-// Mock the @octokit/rest module
-vi.mock('@octokit/rest', () => ({
-  Octokit: vi.fn(() => ({
-    repos: {
-      compareCommits: vi.fn(),
-      listCommits: vi.fn(),
-    },
-    pulls: {
-      get: vi.fn(),
-    },
-  })),
-}));
+// Mock the fetchSnapshotWithFallback module
+vi.mock('./fetchSnapshotWithFallback.js');
+// Mock the git module
+vi.mock('./git.js');
 
 describe('renderMarkdownReport', () => {
   const mockFetchSnapshot = vi.mocked(fetchSnapshotModule.fetchSnapshot);
-  const mockFetchSnapshotWithFallback = vi.mocked(fetchSnapshotModule.fetchSnapshotWithFallback);
+  const mockFetchSnapshotWithFallback = vi.mocked(
+    fetchSnapshotWithFallbackModule.fetchSnapshotWithFallback,
+  );
+  const mockGetMergeBase = vi.mocked(gitModule.getMergeBase);
 
   /** @type {PrInfo} */
   const mockPrInfo = {
@@ -36,26 +33,13 @@ describe('renderMarkdownReport', () => {
     },
   };
 
-  beforeEach(async () => {
+  beforeEach(() => {
     mockFetchSnapshot.mockClear();
     mockFetchSnapshotWithFallback.mockClear();
+    mockGetMergeBase.mockClear();
 
-    // Import and mock the octokit instance after mocking the module
-    const { octokit } = await import('./github.js');
-
-    // Set up default mock for compareCommits to return the base commit SHA
-    vi.mocked(octokit.repos.compareCommits).mockResolvedValue(
-      /** @type {any} */ ({
-        data: {
-          merge_base_commit: {
-            sha: mockPrInfo.base.sha,
-          },
-        },
-      }),
-    );
-
-    // Clear any previous mock calls
-    vi.mocked(octokit.repos.compareCommits).mockClear();
+    // Set up default mock for getMergeBase
+    mockGetMergeBase.mockResolvedValue(mockPrInfo.base.sha);
   });
 
   it('should generate markdown report with size increases', async () => {
@@ -264,39 +248,6 @@ describe('renderMarkdownReport', () => {
     `);
   });
 
-  it('should include CircleCI build number in details URL', async () => {
-    const baseSnapshot = {
-      '@mui/material/Button/index.js': { parsed: 15000, gzip: 4500 },
-    };
-
-    const prSnapshot = {
-      '@mui/material/Button/index.js': { parsed: 15000, gzip: 4500 },
-    };
-
-    mockFetchSnapshotWithFallback.mockResolvedValueOnce({
-      snapshot: baseSnapshot,
-      actualCommit: 'abc123',
-    });
-    mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
-
-    const result = await renderMarkdownReport(mockPrInfo, '12345');
-
-    expect(result).toContain('circleCIBuildNumber=12345');
-    expect(result).toMatchInlineSnapshot(`
-      "**Total Size Change:**  0B<sup>(0.00%)</sup> - **Total Gzip Change:**  0B<sup>(0.00%)</sup>
-      Files: 1 total (0 added, 0 removed, 0 changed)
-
-      <details>
-      <summary>Show details for 1 more bundle</summary>
-
-      **@mui/material/Button/index.js**&emsp;**parsed:**  0B<sup>(0.00%)</sup> **gzip:**  0B<sup>(0.00%)</sup>
-
-      </details>
-
-      [Details of bundle changes](https://frontend-public.mui.com/size-comparison/mui/material-ui/diff?prNumber=42&baseRef=master&baseCommit=abc123&headCommit=def456&circleCIBuildNumber=12345)"
-    `);
-  });
-
   it('should handle no changes', async () => {
     const baseSnapshot = {
       '@mui/material/Button/index.js': { parsed: 15000, gzip: 4500 },
@@ -348,13 +299,13 @@ describe('renderMarkdownReport', () => {
     });
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
-    const result = await renderMarkdownReport(mockPrInfo, undefined, {
+    const result = await renderMarkdownReport(mockPrInfo, {
       track: ['@mui/material/Button/index.js', '@mui/material/TextField/index.js'],
     });
 
     expect(result).toMatchInlineSnapshot(`
-      "| Bundle | Parsed Size | Gzip Size |
-      |----------|----------:|----------:|
+      "| Bundle | Parsed size | Gzip size |
+      |:----------|----------:|----------:|
       | @mui/material/Button/index.js | 🔺+400B<sup>(+2.67%)</sup> | 🔺+100B<sup>(+2.22%)</sup> |
       | @mui/material/TextField/index.js | 🔺+200B<sup>(+0.91%)</sup> | 🔺+100B<sup>(+1.54%)</sup> |
 
@@ -383,13 +334,13 @@ describe('renderMarkdownReport', () => {
     });
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
-    const result = await renderMarkdownReport(mockPrInfo, undefined, {
+    const result = await renderMarkdownReport(mockPrInfo, {
       track: ['@mui/material/Button/index.js', '@mui/material/TextField/index.js'],
     });
 
     expect(result).toMatchInlineSnapshot(`
-      "| Bundle | Parsed Size | Gzip Size |
-      |----------|----------:|----------:|
+      "| Bundle | Parsed size | Gzip size |
+      |:----------|----------:|----------:|
       | @mui/material/Button/index.js | 🔺+500B<sup>(+3.33%)</sup> | 🔺+150B<sup>(+3.33%)</sup> |
       | @mui/material/TextField/index.js | 🔺+300B<sup>(+1.36%)</sup> | 🔺+150B<sup>(+2.31%)</sup> |
 
@@ -418,13 +369,13 @@ describe('renderMarkdownReport', () => {
     });
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
-    const result = await renderMarkdownReport(mockPrInfo, undefined, {
+    const result = await renderMarkdownReport(mockPrInfo, {
       track: ['@mui/material/Button/index.js'],
     });
 
     expect(result).toMatchInlineSnapshot(`
-      "| Bundle | Parsed Size | Gzip Size |
-      |----------|----------:|----------:|
+      "| Bundle | Parsed size | Gzip size |
+      |:----------|----------:|----------:|
       | @mui/material/Button/index.js | 🔺+400B<sup>(+2.67%)</sup> | 🔺+100B<sup>(+2.22%)</sup> |
 
 
@@ -452,13 +403,13 @@ describe('renderMarkdownReport', () => {
     });
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
-    const result = await renderMarkdownReport(mockPrInfo, undefined, {
+    const result = await renderMarkdownReport(mockPrInfo, {
       track: ['@mui/material/Button/index.js', '@mui/material/TextField/index.js'],
     });
 
     expect(result).toMatchInlineSnapshot(`
-      "| Bundle | Parsed Size | Gzip Size |
-      |----------|----------:|----------:|
+      "| Bundle | Parsed size | Gzip size |
+      |:----------|----------:|----------:|
       | @mui/material/Button/index.js |  0B<sup>(0.00%)</sup> |  0B<sup>(0.00%)</sup> |
       | @mui/material/TextField/index.js |  0B<sup>(0.00%)</sup> |  0B<sup>(0.00%)</sup> |
 
@@ -485,13 +436,13 @@ describe('renderMarkdownReport', () => {
     });
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
-    const result = await renderMarkdownReport(mockPrInfo, undefined, {
+    const result = await renderMarkdownReport(mockPrInfo, {
       track: ['@mui/material/Button/index.js'],
     });
 
     expect(result).toMatchInlineSnapshot(`
-      "| Bundle | Parsed Size | Gzip Size |
-      |----------|----------:|----------:|
+      "| Bundle | Parsed size | Gzip size |
+      |:----------|----------:|----------:|
       | @mui/material/Button/index.js | 🔺+400B<sup>(+2.67%)</sup> | 🔺+100B<sup>(+2.22%)</sup> |
 
 
@@ -516,7 +467,7 @@ describe('renderMarkdownReport', () => {
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
     await expect(
-      renderMarkdownReport(mockPrInfo, undefined, {
+      renderMarkdownReport(mockPrInfo, {
         track: ['@mui/material/Button/index.js', '@mui/material/NonExistent/index.js'],
       }),
     ).rejects.toThrow(
@@ -577,11 +528,77 @@ describe('renderMarkdownReport', () => {
     });
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
-    const result = await renderMarkdownReport(mockPrInfo, undefined, { fallbackDepth: 1 });
+    const result = await renderMarkdownReport(mockPrInfo, { fallbackDepth: 1 });
 
     expect(result).toContain(
       'Using snapshot from parent commit parent1 (fallback from merge base abc123)',
     );
     expect(mockFetchSnapshotWithFallback).toHaveBeenCalledWith('mui/material-ui', 'abc123', 1);
   });
+
+  it('should throw error when default getMergeBase fails', async () => {
+    const prSnapshot = {
+      '@mui/material/Button/index.js': { parsed: 15000, gzip: 4500 },
+    };
+
+    // Mock getMergeBase to fail (simulating no merge base found)
+    mockGetMergeBase.mockRejectedValue(new Error('fatal: Not a valid object name abc123'));
+    mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
+
+    await expect(renderMarkdownReport(mockPrInfo)).rejects.toThrow(
+      'fatal: Not a valid object name abc123',
+    );
+
+    // Verify that getMergeBase was called with correct parameters
+    expect(mockGetMergeBase).toHaveBeenCalledWith('abc123', 'def456');
+  });
+
+  it('should use custom getMergeBase function when provided', async () => {
+    const baseSnapshot = {
+      '@mui/material/Button/index.js': { parsed: 15000, gzip: 4500 },
+    };
+
+    const prSnapshot = {
+      '@mui/material/Button/index.js': { parsed: 15400, gzip: 4600 },
+    };
+
+    const customGetMergeBase = vi.fn().mockResolvedValue('custom123');
+
+    // Reset mocks to ensure clean state for this test
+    mockFetchSnapshotWithFallback.mockReset();
+    mockFetchSnapshot.mockReset();
+
+    mockFetchSnapshotWithFallback.mockResolvedValueOnce({
+      snapshot: baseSnapshot,
+      actualCommit: 'custom123',
+    });
+    mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
+
+    const result = await renderMarkdownReport(mockPrInfo, { getMergeBase: customGetMergeBase });
+
+    // Verify that custom getMergeBase was called instead of default
+    expect(customGetMergeBase).toHaveBeenCalledWith('abc123', 'def456');
+    expect(mockGetMergeBase).not.toHaveBeenCalled();
+    expect(mockFetchSnapshotWithFallback).toHaveBeenCalledWith('mui/material-ui', 'custom123', 3);
+
+    expect(result).toContain('**Total Size Change:** 🔺+400B');
+  });
+
+  it('should throw error when custom getMergeBase fails', async () => {
+    const prSnapshot = {
+      '@mui/material/Button/index.js': { parsed: 15000, gzip: 4500 },
+    };
+
+    const customGetMergeBase = vi.fn().mockRejectedValue(new Error('Custom merge base error'));
+
+    mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
+
+    await expect(
+      renderMarkdownReport(mockPrInfo, { getMergeBase: customGetMergeBase }),
+    ).rejects.toThrow('Custom merge base error');
+
+    // Verify that custom getMergeBase was called
+    expect(customGetMergeBase).toHaveBeenCalledWith('abc123', 'def456');
+    expect(mockGetMergeBase).not.toHaveBeenCalled();
+  });
 });

package/src/sizeDiff.js

@@ -1,9 +1,4 @@
 /**
- * @description Represents a single bundle size entry
- * @typedef {Object} SizeSnapshotEntry
- * @property {number} parsed
- * @property {number} gzip
- *
  * @description Represents a single bundle size snapshot
  * @typedef {Object.<string, SizeSnapshotEntry>} SizeSnapshot
  *
@@ -36,6 +31,7 @@
  * @property {number} fileCounts.total - Total number of files
  */
 
+/** @type {SizeSnapshotEntry} */
 const nullSnapshot = { parsed: 0, gzip: 0 };
 
 /**

package/src/strings.js

@@ -0,0 +1,38 @@
+const illegalRe = /[/?<>\\:*|"]/g;
+// eslint-disable-next-line no-control-regex
+const controlRe = /[\x00-\x1f\x80-\x9f]/g;
+const reservedRe = /^\.+$/;
+const windowsReservedRe = /^(con|prn|aux|nul|com[0-9]|lpt[0-9])(\..*)?$/i;
+const windowsTrailingRe = /[. ]+$/;
+
+/**
+ * Inspired by https://github.com/parshap/node-sanitize-filename
+ *
+ * Replaces characters in strings that are illegal/unsafe for filenames.
+ * Unsafe characters are either removed or replaced by a substitute set
+ * in the optional `options` object.
+ *
+ * Illegal Characters on Various Operating Systems
+ * / ? < > \ : * | "
+ * https://kb.acronis.com/content/39790
+ *
+ * Unicode Control codes
+ * C0 0x00-0x1f & C1 (0x80-0x9f)
+ * http://en.wikipedia.org/wiki/C0_and_C1_control_codes
+ *
+ * Reserved filenames on Unix-based systems (".", "..")
+ * Reserved filenames in Windows ("CON", "PRN", "AUX", "NUL", "COM1",
+ * "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9",
+ * "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", and
+ * "LPT9") case-insesitively and with or without filename extensions.
+ * @param {string} input
+ */
+export function escapeFilename(input, replacement = '_') {
+  const sanitized = input
+    .replace(illegalRe, replacement)
+    .replace(controlRe, replacement)
+    .replace(reservedRe, replacement)
+    .replace(windowsReservedRe, replacement)
+    .replace(windowsTrailingRe, replacement);
+  return sanitized;
+}

package/src/types.d.ts

@@ -1,23 +1,3 @@
-// WebpackEntry type
-interface WebpackEntry {
-  import: string;
-  importName?: string;
-}
-
-// Webpack stats types
-interface StatsAsset {
-  name: string;
-  size: number;
-  related?: {
-    find: (predicate: (asset: any) => boolean) => { size: number; type: string };
-  };
-}
-
-interface StatsChunkGroup {
-  name: string;
-  assets: Array<{ name: string; size: number }>;
-}
-
 // Upload configuration with optional properties
 interface UploadConfig {
   repo?: string; // The repository name (e.g., "mui/material-ui")
@@ -41,6 +21,8 @@ interface ObjectEntry {
   import?: string; // Optional package name to import
   importedNames?: string[]; // Optional array of named imports
   externals?: string[]; // Optional array of packages to exclude from the bundle
+  track?: boolean; // Whether this bundle should be tracked in PR comments (defaults to false)
+  expand?: boolean; // Whether to expand the entry to include all exports
 }
 
 type EntryPoint = StringEntry | ObjectEntry;
@@ -49,6 +31,8 @@ type EntryPoint = StringEntry | ObjectEntry;
 interface BundleSizeCheckerConfigObject {
   entrypoints: EntryPoint[];
   upload?: UploadConfig | boolean | null;
+  comment?: boolean; // Whether to post PR comments (defaults to true)
+  replace?: Record<string, string>; // String replacements to apply during bundling
 }
 
 type BundleSizeCheckerConfig =
@@ -60,17 +44,18 @@ type BundleSizeCheckerConfig =
 interface NormalizedBundleSizeCheckerConfig {
   entrypoints: ObjectEntry[];
   upload: NormalizedUploadConfig | null; // null means upload is disabled
+  comment: boolean; // Whether to post PR comments
+  replace: Record<string, string>; // String replacements to apply during bundling
 }
 
 // Command line argument types
 interface CommandLineArgs {
   analyze?: boolean;
-  accurateBundles?: boolean;
   output?: string;
   verbose?: boolean;
   filter?: string[];
   concurrency?: number;
-  vite?: boolean;
+  debug?: boolean;
 }
 
 interface ReportCommandArgs {
@@ -91,7 +76,6 @@ interface DiffCommandArgs {
 interface PrCommandArgs {
   prNumber: number;
   output?: 'json' | 'markdown';
-  circleci?: string;
 }
 
 interface PrInfo {
@@ -108,3 +92,8 @@ interface PrInfo {
     sha: string;
   };
 }
+
+interface SizeSnapshotEntry {
+  parsed: number;
+  gzip: number;
+}

package/src/uploadSnapshot.js

@@ -1,4 +1,4 @@
-import fs from 'fs';
+import fs from 'node:fs';
 import { S3Client, PutObjectCommand, PutObjectTaggingCommand } from '@aws-sdk/client-s3';
 import { execa } from 'execa';
 import { fromEnv } from '@aws-sdk/credential-providers';
@@ -20,7 +20,7 @@ async function getCurrentCommitSHA() {
  */
 function sanitizeS3TagString(str) {
   // Replace disallowed characters with underscore
-  const safe = str.replace(/[^a-zA-Z0-9 +-=.:/@]+/g, '_');
+  const safe = str.replace(/[^a-zA-Z0-9 +\-=.:/@]+/g, '_');
   // Truncate to max lengths (256 for value)
   const maxLen = 256;
   return safe.length > maxLen ? safe.substring(0, maxLen) : safe;

package/src/worker.js

@@ -1,13 +1,9 @@
-import { pathToFileURL } from 'url';
-import path from 'path';
-import fs from 'fs/promises';
+import { pathToFileURL } from 'node:url';
+import fs from 'node:fs/promises';
 import chalk from 'chalk';
-import * as module from 'module';
+import * as module from 'node:module';
 import { byteSizeFormatter } from './formatUtils.js';
-import { getWebpackSizes } from './webpackBuilder.js';
-import { getViteSizes } from './viteBuilder.js';
-
-const require = module.createRequire(import.meta.url);
+import { getBundleSizes } from './builder.js';
 
 const rootDir = process.cwd();
 
@@ -21,11 +17,14 @@ async function getPeerDependencies(packageName) {
     /** @type {string | undefined} */
     let packageJsonPath;
 
+    const rootDirUrl = pathToFileURL(rootDir);
+
     if (module.findPackageJSON) {
       // findPackageJSON was added in: v23.2.0, v22.14.0
-      packageJsonPath = module.findPackageJSON(packageName, `${rootDir}/_.js`);
+      packageJsonPath = module.findPackageJSON(packageName, `${rootDirUrl}/index.mjs`);
     } else {
       // Try to resolve packageName/package.json
+      const require = module.createRequire(`${rootDirUrl}/index.mjs`);
       packageJsonPath = require.resolve(`${packageName}/package.json`, {
         paths: [rootDir],
       });
@@ -57,10 +56,10 @@ async function getPeerDependencies(packageName) {
 
 /**
  * Get sizes for a bundle
- * @param {{ entry: ObjectEntry, args: CommandLineArgs, index: number, total: number }} options
- * @returns {Promise<Array<[string, { parsed: number, gzip: number }]>>}
+ * @param {{ entry: ObjectEntry, args: CommandLineArgs, index: number, total: number, replace?: Record<string, string> }} options
+ * @returns {Promise<Array<[string, SizeSnapshotEntry]>>}
  */
-export default async function getSizes({ entry, args, index, total }) {
+export default async function getSizes({ entry, args, index, total, replace }) {
   // eslint-disable-next-line no-console -- process monitoring
   console.log(chalk.blue(`Compiling ${index + 1}/${total}: ${chalk.bold(`[${entry.id}]`)}`));
 
@@ -83,12 +82,7 @@ export default async function getSizes({ entry, args, index, total }) {
   }
 
   try {
-    let sizeMap;
-    if (args.vite) {
-      sizeMap = await getViteSizes(entry, args);
-    } else {
-      sizeMap = await getWebpackSizes(entry, args);
-    }
+    const { sizes: sizeMap, treemapPath } = await getBundleSizes(entry, args, replace);
 
     // Create a concise log message showing import details
     let entryDetails = '';
@@ -112,9 +106,8 @@ export default async function getSizes({ entry, args, index, total }) {
 ${chalk.green('✓')} ${chalk.green.bold(`Completed ${index + 1}/${total}: [${entry.id}]`)}
   ${chalk.cyan('Import:')}    ${entryDetails}
   ${chalk.cyan('Externals:')} ${entry.externals.join(', ')}
-  ${chalk.cyan('Bundler:')}   ${args.vite ? 'vite' : 'webpack'}
   ${chalk.cyan('Sizes:')}     ${chalk.yellow(byteSizeFormatter.format(entrySize.parsed))} (${chalk.yellow(byteSizeFormatter.format(entrySize.gzip))} gzipped)
-${args.analyze ? `  ${chalk.cyan('Analysis:')}  ${chalk.underline(pathToFileURL(path.join(rootDir, 'build', `${entry.id}.html`)).href)}` : ''}
+${args.analyze ? `  ${chalk.cyan('Analysis:')}  ${chalk.underline(pathToFileURL(treemapPath).href)}` : ''}
 `.trim(),
     );
 

package/tsconfig.build.json

@@ -0,0 +1,15 @@
+{
+  // This config is for emitting declarations (.d.ts) only
+  // Actual .ts source files are transpiled via babel
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "paths": {},
+    "emitDeclarationOnly": true,
+    "outDir": "./build",
+    "rootDir": "./src",
+    "noEmit": false
+  },
+  "include": ["src/**/*"],
+  // removing "cli" since its going to run directly and not really imported anywhere
+  "exclude": ["**/*.spec.*", "**/*.test.*", "**/setupVitest.ts"]
+}

package/tsconfig.json

@@ -1,8 +1,8 @@
 {
   "compilerOptions": {
     "target": "ES2022",
-    "module": "ESNext",
-    "moduleResolution": "node",
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
     "allowJs": true,
     "checkJs": true,
     "skipLibCheck": true,