Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: forceSplitting not work with single-vendor #4708

Merged
merged 1 commit into from
Mar 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions e2e/cases/performance/single-vendor-splitting/index.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { basename } from 'node:path';
import { build } from '@e2e/helper';
import { expect, test } from '@playwright/test';

test('should allow to use `forceSplitting` when chunkSplit is "single-vendor"', async () => {
const rsbuild = await build({
cwd: __dirname,
});

const files = await rsbuild.unwrapOutputJSON();

const jsFiles = Object.keys(files)
.filter((name) => name.endsWith('.js'))
.map((name) => basename(name));

expect(jsFiles.length).toEqual(3);
expect(jsFiles).toContain('index.js');
expect(jsFiles).toContain('vendor.js');
expect(jsFiles).toContain('my-react.js');
});
23 changes: 23 additions & 0 deletions e2e/cases/performance/single-vendor-splitting/rsbuild.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import { defineConfig } from '@rsbuild/core';
import { pluginReact } from '@rsbuild/plugin-react';

export default defineConfig({
plugins: [
pluginReact({
splitChunks: {
react: false,
},
}),
],
output: {
filenameHash: false,
},
performance: {
chunkSplit: {
strategy: 'single-vendor',
forceSplitting: {
'my-react': /node_modules[\\/]react[\\/]/,
},
},
},
});
3 changes: 3 additions & 0 deletions e2e/cases/performance/single-vendor-splitting/src/App.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
const App = () => <div id="test">Hello Rsbuild!</div>;

export default App;
9 changes: 9 additions & 0 deletions e2e/cases/performance/single-vendor-splitting/src/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import React from 'react';
import { createRoot } from 'react-dom/client';
import App from './App';

const container = document.getElementById('root');
if (container) {
const root = createRoot(container);
root.render(React.createElement(App));
}
13 changes: 9 additions & 4 deletions packages/core/src/plugins/splitChunks.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import assert from 'node:assert';
import { NODE_MODULES_REGEX } from '../constants';
import type {
ChunkSplit,
ForceSplitting,
Polyfill,
RsbuildChunkSplit,
RsbuildPlugin,
Rspack,
SplitChunks,
Expand Down Expand Up @@ -32,7 +32,7 @@ interface SplitChunksContext {
/**
* User Rsbuild `chunkSplit` config
*/
userConfig: RsbuildChunkSplit;
userConfig: ChunkSplit;
/**
* The root path of current project
*/
Expand All @@ -43,7 +43,10 @@ interface SplitChunksContext {
polyfill: Polyfill;
}

function getForceSplittingGroups(forceSplitting: ForceSplitting): CacheGroups {
function getForceSplittingGroups(
forceSplitting: ForceSplitting,
strategy: ChunkSplit['strategy'],
): CacheGroups {
const cacheGroups: CacheGroups = {};
const pairs = Array.isArray(forceSplitting)
? forceSplitting.map(
Expand All @@ -56,7 +59,8 @@ function getForceSplittingGroups(forceSplitting: ForceSplitting): CacheGroups {
test: regexp,
name: key,
chunks: 'all',
priority: 0,
// ensure force splitting chunks have higher priority when chunkSplit is 'single-vendor'
priority: strategy === 'single-vendor' ? 1 : 0,
// Ignore minimum size, minimum chunks and maximum requests and always create chunks.
enforce: true,
};
Expand Down Expand Up @@ -263,6 +267,7 @@ export const pluginSplitChunks = (): RsbuildPlugin => ({
if (chunkSplit.forceSplitting) {
forceSplittingGroups = getForceSplittingGroups(
chunkSplit.forceSplitting,
chunkSplit.strategy,
);
}

Expand Down
6 changes: 3 additions & 3 deletions packages/core/src/types/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@ export interface PerformanceConfig {
/**
* Configure the chunk splitting strategy.
*/
chunkSplit?: RsbuildChunkSplit;
chunkSplit?: ChunkSplit;

/**
* Analyze the size of output files.
Expand Down Expand Up @@ -655,7 +655,7 @@ export interface PerformanceConfig {

export interface NormalizedPerformanceConfig extends PerformanceConfig {
printFileSize: PrintFileSizeOptions | boolean;
chunkSplit: RsbuildChunkSplit;
chunkSplit: ChunkSplit;
}

export type SplitChunks = Configuration extends {
Expand Down Expand Up @@ -693,7 +693,7 @@ export interface SplitCustom extends BaseSplitRules {
splitChunks?: SplitChunks;
}

export type RsbuildChunkSplit = BaseChunkSplit | SplitBySize | SplitCustom;
export type ChunkSplit = BaseChunkSplit | SplitBySize | SplitCustom;

export type DistPathConfig = {
/**
Expand Down
Loading