@mui/internal-code-infra 0.0.4-canary.10 → 0.0.4-canary.101

package/src/changelog/categorizeCommits.test.ts

@@ -1,319 +0,0 @@
-import { describe, expect, it } from 'vitest';
-// eslint-disable-next-line import/extensions
-import { categorizeCommits } from './categorizeCommits.mjs';
-import type { FetchedCommitDetails, CategorizationConfig, LabelConfig } from './types';
-
-const baseLabelConfig: LabelConfig = {
-  plan: {
-    values: ['pro', 'premium'],
-  },
-  flags: {
-    'breaking change': { name: 'breaking change' },
-  },
-};
-
-function createCommit(
-  prNumber: number,
-  labels: string[],
-  overrides?: Partial<FetchedCommitDetails>,
-): FetchedCommitDetails {
-  return {
-    sha: `sha-${prNumber}`,
-    message: `feat: feature for PR #${prNumber}`,
-    labels,
-    prNumber,
-    html_url: `https://github.com/mui/mui-x/pull/${prNumber}`,
-    author: { login: 'dev', association: 'team' },
-    createdAt: null,
-    mergedAt: null,
-    ...overrides,
-  };
-}
-
-describe('categorizeCommits', () => {
-  describe('component strategy', () => {
-    const componentConfig: CategorizationConfig = {
-      strategy: 'component',
-      labels: baseLabelConfig,
-      sections: {
-        fallbackSection: 'Other',
-      },
-    };
-
-    it('should categorize commits by component label', () => {
-      const commits = [
-        createCommit(1, ['component: Button']),
-        createCommit(2, ['component: Checkbox']),
-        createCommit(3, ['component: Button']),
-      ];
-
-      const result = categorizeCommits(commits, componentConfig);
-
-      expect(result.size).toBe(2);
-      // Component labels are normalized to lowercase by parseCommitLabels
-      expect(result.get('Button')).toHaveLength(2);
-      expect(result.get('Checkbox')).toHaveLength(1);
-    });
-
-    it('should place commits without component labels in fallback section', () => {
-      const commits = [createCommit(1, []), createCommit(2, ['breaking change'])];
-
-      const result = categorizeCommits(commits, componentConfig);
-
-      expect(result.size).toBe(1);
-      expect(result.get('Other')).toHaveLength(2);
-    });
-
-    it('should place commits with multiple component labels in multiple sections', () => {
-      const commits = [createCommit(1, ['component: Button', 'component: Checkbox'])];
-
-      const result = categorizeCommits(commits, componentConfig);
-
-      expect(result.size).toBe(2);
-      // Component labels are normalized to lowercase by parseCommitLabels
-      expect(result.get('Button')).toHaveLength(1);
-      expect(result.get('Checkbox')).toHaveLength(1);
-      // Same commit object in both categories
-      expect(result.get('Button')?.[0].prNumber).toBe(1);
-      expect(result.get('Checkbox')?.[0].prNumber).toBe(1);
-    });
-
-    it('should use categoryOverride when present', () => {
-      const configWithOverrides: CategorizationConfig = {
-        ...componentConfig,
-        labels: {
-          ...baseLabelConfig,
-          categoryOverrides: {
-            'all components': 'General changes',
-          },
-        },
-      };
-
-      const commits = [
-        createCommit(1, ['component: Button', 'all components']),
-        createCommit(2, ['component: Checkbox']),
-        createCommit(3, ['component: Button', 'all components']),
-      ];
-
-      const result = categorizeCommits(commits, configWithOverrides);
-
-      expect(result.size).toBe(2);
-      expect(result.get('General changes')).toHaveLength(2);
-      expect(result.get('General changes')?.[0].prNumber).toBe(1);
-      expect(result.get('General changes')?.[1].prNumber).toBe(3);
-      // Component labels are normalized to lowercase by parseCommitLabels
-      expect(result.get('Checkbox')).toHaveLength(1);
-    });
-  });
-
-  describe('package strategy', () => {
-    const packageConfig: CategorizationConfig = {
-      strategy: 'package',
-      labels: baseLabelConfig,
-      packageNaming: {
-        mappings: {
-          'data grid': '@mui/x-data-grid',
-          charts: '@mui/x-charts',
-          pickers: '@mui/x-date-pickers',
-        },
-        genericScopes: ['docs', 'code-infra'],
-        plans: {
-          pro: {
-            '@mui/x-data-grid': '@mui/x-data-grid-pro',
-            '@mui/x-charts': '@mui/x-charts-pro',
-            '@mui/x-date-pickers': '@mui/x-date-pickers-pro',
-          },
-          premium: {
-            '@mui/x-data-grid': '@mui/x-data-grid-premium',
-          },
-        },
-      },
-      sections: {
-        fallbackSection: 'Other',
-      },
-    };
-
-    it('should categorize commits by scope to package mapping', () => {
-      const commits = [
-        createCommit(1, ['scope: data grid']),
-        createCommit(2, ['scope: charts']),
-        createCommit(3, ['scope: data grid']),
-      ];
-
-      const result = categorizeCommits(commits, packageConfig);
-
-      expect(result.size).toBe(2);
-      expect(result.get('@mui/x-data-grid')).toHaveLength(2);
-      expect(result.get('@mui/x-charts')).toHaveLength(1);
-    });
-
-    it('should place commits without scope in fallback section', () => {
-      const commits = [createCommit(1, []), createCommit(2, ['breaking change'])];
-
-      const result = categorizeCommits(commits, packageConfig);
-
-      expect(result.size).toBe(1);
-      expect(result.get('Other')).toHaveLength(2);
-    });
-
-    it('should place commits with multiple scope labels in multiple sections', () => {
-      const commits = [createCommit(1, ['scope: data grid', 'scope: charts'])];
-
-      const result = categorizeCommits(commits, packageConfig);
-
-      expect(result.size).toBe(2);
-      expect(result.get('@mui/x-data-grid')).toHaveLength(1);
-      expect(result.get('@mui/x-charts')).toHaveLength(1);
-    });
-
-    it('should use generic scopes directly as section names', () => {
-      const commits = [createCommit(1, ['scope: docs']), createCommit(2, ['scope: code-infra'])];
-
-      const result = categorizeCommits(commits, packageConfig);
-
-      expect(result.size).toBe(2);
-      expect(result.get('docs')).toHaveLength(1);
-      expect(result.get('code-infra')).toHaveLength(1);
-    });
-
-    it('should apply plan to package name when plan label is present', () => {
-      const commits = [
-        createCommit(1, ['scope: data grid', 'plan: pro']),
-        createCommit(2, ['scope: data grid', 'plan: premium']),
-        createCommit(3, ['scope: data grid']),
-      ];
-
-      const result = categorizeCommits(commits, packageConfig);
-
-      expect(result.size).toBe(3);
-      expect(result.get('@mui/x-data-grid-pro')).toHaveLength(1);
-      expect(result.get('@mui/x-data-grid-premium')).toHaveLength(1);
-      expect(result.get('@mui/x-data-grid')).toHaveLength(1);
-    });
-
-    it('should throw error when scope mapping is not found', () => {
-      const commits = [createCommit(42, ['scope: unknown-package'])];
-
-      expect(() => categorizeCommits(commits, packageConfig)).toThrow(
-        'No package mapping found for scope "unknown-package" in commit #42',
-      );
-    });
-
-    it('should throw error when plan mapping is not found for package', () => {
-      const commits = [createCommit(42, ['scope: charts', 'plan: premium'])];
-
-      expect(() => categorizeCommits(commits, packageConfig)).toThrow(
-        'No premium plan package mapping found for base package "@mui/x-charts" in commit #42',
-      );
-    });
-
-    it('should throw error when package naming config is missing', () => {
-      const configWithoutNaming: CategorizationConfig = {
-        strategy: 'package',
-        labels: baseLabelConfig,
-        sections: {
-          fallbackSection: 'Other',
-        },
-      };
-
-      const commits = [createCommit(1, ['scope: data grid'])];
-
-      expect(() => categorizeCommits(commits, configWithoutNaming)).toThrow(
-        'Package naming configuration is required for package-first strategy',
-      );
-    });
-
-    it('should use categoryOverride when present', () => {
-      const configWithOverrides: CategorizationConfig = {
-        ...packageConfig,
-        labels: {
-          ...baseLabelConfig,
-          categoryOverrides: {
-            'all packages': 'General changes',
-          },
-        },
-      };
-
-      const commits = [
-        createCommit(1, ['scope: data grid', 'all packages']),
-        createCommit(2, ['scope: charts']),
-      ];
-
-      const result = categorizeCommits(commits, configWithOverrides);
-
-      expect(result.size).toBe(2);
-      expect(result.get('General changes')).toHaveLength(1);
-      expect(result.get('@mui/x-charts')).toHaveLength(1);
-    });
-  });
-
-  describe('unknown strategy', () => {
-    it('should throw error for unknown strategy', () => {
-      const invalidConfig = {
-        strategy: 'invalid' as 'component',
-        labels: baseLabelConfig,
-        sections: {
-          fallbackSection: 'Other',
-        },
-      };
-
-      const commits = [createCommit(1, [])];
-
-      expect(() => categorizeCommits(commits, invalidConfig)).toThrow(
-        'Unknown categorization strategy: invalid',
-      );
-    });
-  });
-
-  describe('parsed labels', () => {
-    const config: CategorizationConfig = {
-      strategy: 'component',
-      labels: {
-        ...baseLabelConfig,
-        flags: {
-          'breaking change': { name: 'breaking change' },
-          enhancement: { name: 'enhancement' },
-        },
-      },
-      sections: {
-        fallbackSection: 'Other',
-      },
-    };
-
-    it('should include parsed labels in categorized commits', () => {
-      const commits = [createCommit(1, ['component: Button', 'breaking change', 'enhancement'])];
-
-      const result = categorizeCommits(commits, config);
-
-      const categorizedCommit = result.get('Button')?.[0];
-      expect(categorizedCommit?.parsed.components).toEqual(['Button']);
-      expect(categorizedCommit?.parsed.flags).toEqual(['breaking change', 'enhancement']);
-    });
-
-    it('should include plan in parsed labels', () => {
-      const commits = [createCommit(1, ['component: Button', 'plan: pro'])];
-
-      const result = categorizeCommits(commits, config);
-
-      // Component labels are normalized to lowercase by parseCommitLabels
-      const categorizedCommit = result.get('Button')?.[0];
-      expect(categorizedCommit?.parsed.plan).toBe('pro');
-    });
-  });
-
-  describe('empty input', () => {
-    const config: CategorizationConfig = {
-      strategy: 'component',
-      labels: baseLabelConfig,
-      sections: {
-        fallbackSection: 'Other',
-      },
-    };
-
-    it('should return empty map for empty commits array', () => {
-      const result = categorizeCommits([], config);
-
-      expect(result.size).toBe(0);
-    });
-  });
-});

package/src/changelog/filterCommits.test.ts

@@ -1,363 +0,0 @@
-import { describe, expect, it } from 'vitest';
-// eslint-disable-next-line import/extensions
-import { filterCommits } from './filterCommits.mjs';
-import type { FetchedCommitDetails, FilterConfig } from './types';
-
-function createCommit(overrides: Partial<FetchedCommitDetails> = {}): FetchedCommitDetails {
-  return {
-    sha: 'abc123',
-    message: 'test commit',
-    labels: [],
-    prNumber: 1,
-    html_url: 'https://github.com/test/repo/pull/1',
-    author: {
-      login: 'testuser',
-      association: 'contributor',
-    },
-    createdAt: '2025-01-01T00:00:00Z',
-    mergedAt: '2025-01-01T00:00:00Z',
-    ...overrides,
-  };
-}
-
-describe('filterCommits', () => {
-  describe('no filter config', () => {
-    it('should return all commits when filterConfig is undefined', () => {
-      const commits = [
-        createCommit({ sha: '1' }),
-        createCommit({ sha: '2' }),
-        createCommit({ sha: '3' }),
-      ];
-
-      const result = filterCommits(commits, undefined);
-
-      expect(result).toEqual(commits);
-    });
-
-    it('should return empty array for empty input', () => {
-      const result = filterCommits([], undefined);
-
-      expect(result).toEqual([]);
-    });
-  });
-
-  describe('excludeCommitByAuthors', () => {
-    it('should exclude commits by author login string match', () => {
-      const commits = [
-        createCommit({ sha: '1', author: { login: 'dependabot', association: 'contributor' } }),
-        createCommit({ sha: '2', author: { login: 'human-user', association: 'contributor' } }),
-        createCommit({
-          sha: '3',
-          author: { login: 'another-dependabot-account', association: 'contributor' },
-        }),
-      ];
-      const filterConfig: FilterConfig = {
-        excludeCommitByAuthors: ['dependabot'],
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      expect(result.map((c) => c.sha)).toEqual(['2']);
-    });
-
-    it('should exclude commits by author login regex match', () => {
-      const commits = [
-        createCommit({ sha: '1', author: { login: 'renovate[bot]', association: 'contributor' } }),
-        createCommit({ sha: '2', author: { login: 'human-user', association: 'contributor' } }),
-        createCommit({
-          sha: '3',
-          author: { login: 'dependabot[bot]', association: 'contributor' },
-        }),
-      ];
-      const filterConfig: FilterConfig = {
-        excludeCommitByAuthors: [/\[bot\]$/],
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      expect(result.map((c) => c.sha)).toEqual(['2']);
-    });
-
-    it('should handle commits with null author', () => {
-      const commits = [
-        createCommit({ sha: '1', author: null }),
-        createCommit({ sha: '2', author: { login: 'dependabot', association: 'contributor' } }),
-        createCommit({ sha: '3', author: { login: 'human-user', association: 'contributor' } }),
-      ];
-      const filterConfig: FilterConfig = {
-        excludeCommitByAuthors: ['dependabot'],
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      expect(result.map((c) => c.sha)).toEqual(['1', '3']);
-    });
-
-    it('should handle multiple author exclusion patterns', () => {
-      const commits = [
-        createCommit({
-          sha: '1',
-          author: { login: 'dependabot[bot]', association: 'contributor' },
-        }),
-        createCommit({ sha: '2', author: { login: 'renovate', association: 'contributor' } }),
-        createCommit({ sha: '3', author: { login: 'human-user', association: 'contributor' } }),
-      ];
-      const filterConfig: FilterConfig = {
-        excludeCommitByAuthors: [/\[bot\]$/, 'renovate'],
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      expect(result.map((c) => c.sha)).toEqual(['3']);
-    });
-
-    it('should handle empty excludeCommitByAuthors array', () => {
-      const commits = [createCommit({ sha: '1' }), createCommit({ sha: '2' })];
-      const filterConfig: FilterConfig = {
-        excludeCommitByAuthors: [],
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      expect(result.map((c) => c.sha)).toEqual(['1', '2']);
-    });
-  });
-
-  describe('excludeCommitWithLabels', () => {
-    it('should exclude commits with matching label string', () => {
-      const commits = [
-        createCommit({ sha: '1', labels: ['bug', 'skip-changelog'] }),
-        createCommit({ sha: '2', labels: ['enhancement'] }),
-        createCommit({ sha: '3', labels: ['internal', 'skip-changelog'] }),
-      ];
-      const filterConfig: FilterConfig = {
-        excludeCommitWithLabels: ['skip-changelog'],
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      expect(result.map((c) => c.sha)).toEqual(['2']);
-    });
-
-    it('should exclude commits with matching label regex', () => {
-      const commits = [
-        createCommit({ sha: '1', labels: ['scope: docs'] }),
-        createCommit({ sha: '2', labels: ['scope: core'] }),
-        createCommit({ sha: '3', labels: ['enhancement'] }),
-      ];
-      const filterConfig: FilterConfig = {
-        excludeCommitWithLabels: [/^scope: docs$/],
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      expect(result.map((c) => c.sha)).toEqual(['2', '3']);
-    });
-
-    it('should handle multiple label exclusion patterns', () => {
-      const commits = [
-        createCommit({ sha: '1', labels: ['skip-changelog'] }),
-        createCommit({ sha: '2', labels: ['internal'] }),
-        createCommit({ sha: '3', labels: ['enhancement'] }),
-        createCommit({ sha: '4', labels: ['docs-only'] }),
-      ];
-      const filterConfig: FilterConfig = {
-        excludeCommitWithLabels: ['skip-changelog', 'internal', /docs/],
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      expect(result.map((c) => c.sha)).toEqual(['3']);
-    });
-
-    it('should handle commits with empty labels array', () => {
-      const commits = [
-        createCommit({ sha: '1', labels: [] }),
-        createCommit({ sha: '2', labels: ['skip-changelog'] }),
-      ];
-      const filterConfig: FilterConfig = {
-        excludeCommitWithLabels: ['skip-changelog'],
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      expect(result.map((c) => c.sha)).toEqual(['1']);
-    });
-
-    it('should handle empty excludeCommitWithLabels array', () => {
-      const commits = [
-        createCommit({ sha: '1', labels: ['any-label'] }),
-        createCommit({ sha: '2', labels: [] }),
-      ];
-      const filterConfig: FilterConfig = {
-        excludeCommitWithLabels: [],
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      expect(result.map((c) => c.sha)).toEqual(['1', '2']);
-    });
-  });
-
-  describe('customFilter', () => {
-    it('should apply custom filter function', () => {
-      const commits = [
-        createCommit({ sha: '1', prNumber: 100 }),
-        createCommit({ sha: '2', prNumber: 200 }),
-        createCommit({ sha: '3', prNumber: 300 }),
-      ];
-      const filterConfig: FilterConfig = {
-        customFilter: (commit) => commit.prNumber >= 200,
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      expect(result.map((c) => c.sha)).toEqual(['2', '3']);
-    });
-
-    it('should apply custom filter after author and label filters', () => {
-      const commits = [
-        createCommit({
-          sha: '1',
-          author: { login: 'bot', association: 'contributor' },
-          prNumber: 100,
-        }),
-        createCommit({
-          sha: '2',
-          author: { login: 'human', association: 'contributor' },
-          prNumber: 200,
-        }),
-        createCommit({
-          sha: '3',
-          author: { login: 'human', association: 'contributor' },
-          prNumber: 300,
-        }),
-      ];
-      const filterConfig: FilterConfig = {
-        excludeCommitByAuthors: ['bot'],
-        customFilter: (commit) => commit.prNumber >= 250,
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      // sha: '1' excluded by author filter
-      // sha: '2' excluded by custom filter (prNumber < 250)
-      // sha: '3' passes both filters
-      expect(result.map((c) => c.sha)).toEqual(['3']);
-    });
-
-    it('should filter based on commit message content', () => {
-      const commits = [
-        createCommit({ sha: '1', message: '[skip ci] Update dependencies' }),
-        createCommit({ sha: '2', message: 'Fix critical bug' }),
-        createCommit({ sha: '3', message: 'chore: update config [skip ci]' }),
-      ];
-      const filterConfig: FilterConfig = {
-        customFilter: (commit) => !commit.message.includes('[skip ci]'),
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      expect(result.map((c) => c.sha)).toEqual(['2']);
-    });
-  });
-
-  describe('combined filters', () => {
-    it('should apply all filters together', () => {
-      const commits = [
-        createCommit({
-          sha: '1',
-          author: { login: 'dependabot[bot]', association: 'contributor' },
-          labels: ['dependencies'],
-        }),
-        createCommit({
-          sha: '2',
-          author: { login: 'human', association: 'team' },
-          labels: ['skip-changelog'],
-        }),
-        createCommit({
-          sha: '3',
-          author: { login: 'human', association: 'team' },
-          labels: ['bug'],
-          prNumber: 50,
-        }),
-        createCommit({
-          sha: '4',
-          author: { login: 'human', association: 'contributor' },
-          labels: ['enhancement'],
-          prNumber: 200,
-        }),
-      ];
-      const filterConfig: FilterConfig = {
-        excludeCommitByAuthors: [/\[bot\]$/],
-        excludeCommitWithLabels: ['skip-changelog'],
-        customFilter: (commit) => commit.prNumber >= 100,
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      // sha: '1' excluded by author filter (bot)
-      // sha: '2' excluded by label filter (skip-changelog)
-      // sha: '3' excluded by custom filter (prNumber < 100)
-      // sha: '4' passes all filters
-      expect(result.map((c) => c.sha)).toEqual(['4']);
-    });
-
-    it('should return empty array when all commits are filtered', () => {
-      const commits = [
-        createCommit({ sha: '1', author: { login: 'bot', association: 'contributor' } }),
-        createCommit({ sha: '2', labels: ['internal'] }),
-      ];
-      const filterConfig: FilterConfig = {
-        excludeCommitByAuthors: ['bot'],
-        excludeCommitWithLabels: ['internal'],
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      expect(result).toEqual([]);
-    });
-  });
-
-  describe('edge cases', () => {
-    it('should not mutate the original commits array', () => {
-      const commits = [
-        createCommit({ sha: '1', author: { login: 'bot', association: 'contributor' } }),
-        createCommit({ sha: '2', author: { login: 'human', association: 'contributor' } }),
-      ];
-      const originalLength = commits.length;
-      const filterConfig: FilterConfig = {
-        excludeCommitByAuthors: ['bot'],
-      };
-
-      filterCommits(commits, filterConfig);
-
-      expect(commits.length).toBe(originalLength);
-    });
-
-    it('should handle filterConfig with no filter properties set', () => {
-      const commits = [createCommit({ sha: '1' }), createCommit({ sha: '2' })];
-      const filterConfig: FilterConfig = {};
-
-      const result = filterCommits(commits, filterConfig);
-
-      expect(result.map((c) => c.sha)).toEqual(['1', '2']);
-    });
-
-    it('should use substring matching for string patterns in author exclusion', () => {
-      const commits = [
-        createCommit({ sha: '1', author: { login: 'my-bot-account', association: 'contributor' } }),
-        createCommit({ sha: '2', author: { login: 'botuser', association: 'contributor' } }),
-        createCommit({ sha: '3', author: { login: 'human', association: 'contributor' } }),
-      ];
-      const filterConfig: FilterConfig = {
-        excludeCommitByAuthors: ['bot'],
-      };
-
-      const result = filterCommits(commits, filterConfig);
-
-      // Both 'my-bot-account' and 'botuser' contain 'bot'
-      expect(result.map((c) => c.sha)).toEqual(['3']);
-    });
-  });
-});