@mui/internal-bundle-size-checker 1.0.9-canary.33 → 1.0.9-canary.34

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/internal-bundle-size-checker",
-  "version": "1.0.9-canary.33",
+  "version": "1.0.9-canary.34",
   "description": "Bundle size checker for MUI packages.",
   "type": "module",
   "main": "./src/index.js",
@@ -38,7 +38,7 @@
     "@types/micromatch": "^4.0.9",
     "@types/yargs": "^17.0.33"
   },
-  "gitSha": "cf68446433d3e1fcb7a2be55e7fdf866835c36b6",
+  "gitSha": "4c0f0d55b88cdb008a066a7de077b7a20def6245",
   "scripts": {
     "typescript": "tsc -p tsconfig.json",
     "test": "pnpm -w test --project @mui/internal-bundle-size-checker"

package/src/cli.js

@@ -85,7 +85,7 @@ async function reportCommand(argv) {
   // Get current repo info and coerce with provided arguments
   const currentRepo = await getCurrentRepoInfo();
   const owner = argOwner ?? currentRepo.owner;
-  const repo = argRepo ?? currentRepo.repo;
+  const repo = argRepo ?? currentRepo.name;
 
   if (typeof pr !== 'number') {
     throw new Error('Invalid pull request number. Please provide a valid --pr option.');
@@ -105,8 +105,18 @@ async function reportCommand(argv) {
     pull_number: pr,
   });
 
+  const getMergeBaseFromGithubApi = async (
+    /** @type {string} */ base,
+    /** @type {string} */ head,
+  ) => {
+    const { data } = await octokit.repos.compareCommits({ owner, repo, base, head });
+    return data.merge_base_commit.sha;
+  };
+
   // Generate and print the markdown report
-  const report = await renderMarkdownReport(prInfo);
+  const report = await renderMarkdownReport(prInfo, undefined, {
+    getMergeBase: getMergeBaseFromGithubApi,
+  });
   // eslint-disable-next-line no-console
   console.log(report);
 }

package/src/git.js

@@ -26,20 +26,25 @@ export async function getMergeBase(base, head) {
 
 /**
  * Gets the current repository owner and name from git remote
- * @returns {Promise<{owner: string | null, repo: string | null}>}
+ * @returns {Promise<string | null>}
  */
-export async function getCurrentRepoInfo() {
+async function getRemoteUrl(remote = 'origin') {
   try {
-    const { stdout } = await execa('git', ['remote', 'get-url', 'origin']);
-    const parsed = gitUrlParse(stdout.trim());
-    return {
-      owner: parsed.owner,
-      repo: parsed.name,
-    };
-  } catch (error) {
-    return {
-      owner: null,
-      repo: null,
-    };
+    const { stdout } = await execa('git', ['remote', 'get-url', remote]);
+    return stdout.trim();
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Gets the current repository owner and name from git remote
+ * @returns {Promise<{owner: string | null, name: string | null}>}
+ */
+export async function getCurrentRepoInfo() {
+  const remoteUrl = (await getRemoteUrl('upstream')) || (await getRemoteUrl('origin'));
+  if (!remoteUrl) {
+    return { owner: null, name: null };
   }
+  return gitUrlParse(remoteUrl);
 }

package/src/renderMarkdownReport.js

@@ -7,8 +7,7 @@
 import { calculateSizeDiff } from './sizeDiff.js';
 import { fetchSnapshot } from './fetchSnapshot.js';
 import { displayPercentFormatter, byteSizeChangeFormatter } from './formatUtils.js';
-import { octokit } from './github.js';
-import { getCurrentRepoInfo, getMergeBase } from './git.js';
+import { getMergeBase } from './git.js';
 import { fetchSnapshotWithFallback } from './fetchSnapshotWithFallback.js';
 
 /**
@@ -224,6 +223,7 @@ function getDetailsUrl(prInfo, options = {}) {
  * @param {string[]} [options.track] - Array of bundle IDs to track
  * @param {number} [options.fallbackDepth=3] - How many parent commits to try as fallback when base snapshot is missing
  * @param {number} [options.maxDetailsLines=100] - Maximum number of bundles to show in details section
+ * @param {(base: string, head: string) => Promise<string>} [options.getMergeBase] - Custom function to get merge base commit
  * @returns {Promise<string>} Markdown report
  */
 export async function renderMarkdownReport(prInfo, circleciBuildNumber, options = {}) {
@@ -233,22 +233,8 @@ export async function renderMarkdownReport(prInfo, circleciBuildNumber, options
   const repo = prInfo.base.repo.full_name;
   const { fallbackDepth = 3 } = options;
 
-  const [owner, repoName] = repo.split('/');
-
-  const currentRepo = await getCurrentRepoInfo();
-
-  let baseCommit;
-  if (owner === currentRepo.owner && repoName === currentRepo.repo) {
-    baseCommit = await getMergeBase(prInfo.base.sha, prCommit);
-  } else {
-    const { data } = await octokit.repos.compareCommits({
-      owner,
-      repo: repoName,
-      base: prInfo.base.sha,
-      head: prCommit,
-    });
-    baseCommit = data.merge_base_commit.sha;
-  }
+  const getMergeBaseFn = options.getMergeBase || getMergeBase;
+  const baseCommit = await getMergeBaseFn(prInfo.base.sha, prCommit);
 
   const [baseResult, prSnapshot] = await Promise.all([
     fetchSnapshotWithFallback(repo, baseCommit, fallbackDepth),

package/src/renderMarkdownReport.test.js

@@ -3,29 +3,21 @@ 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 fetchSnapshotWithFallback module
 vi.mock('./fetchSnapshotWithFallback.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 git module
+vi.mock('./git.js');
 
 describe('renderMarkdownReport', () => {
   const mockFetchSnapshot = vi.mocked(fetchSnapshotModule.fetchSnapshot);
   const mockFetchSnapshotWithFallback = vi.mocked(
     fetchSnapshotWithFallbackModule.fetchSnapshotWithFallback,
   );
+  const mockGetMergeBase = vi.mocked(gitModule.getMergeBase);
 
   /** @type {PrInfo} */
   const mockPrInfo = {
@@ -41,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 () => {
@@ -582,11 +561,83 @@ describe('renderMarkdownReport', () => {
     });
     mockFetchSnapshot.mockResolvedValueOnce(prSnapshot);
 
-    const result = await renderMarkdownReport(mockPrInfo, undefined, { fallbackDepth: 1 });
+    const result = await renderMarkdownReport(mockPrInfo, undefined, {
+      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, undefined, {
+      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, undefined, {
+        getMergeBase: customGetMergeBase,
+      }),
+    ).rejects.toThrow('Custom merge base error');
+
+    // Verify that custom getMergeBase was called
+    expect(customGetMergeBase).toHaveBeenCalledWith('abc123', 'def456');
+    expect(mockGetMergeBase).not.toHaveBeenCalled();
+  });
 });