Sort manual chunks generated via a function by name (#4397)

lukastaegert · web-flow · commit 1738215510cd · 2022-02-10T09:11:40.000+01:00
* Sort manual chunks via functions are sorted by name

* Improve test
diff --git a/src/Bundle.ts b/src/Bundle.ts
@@ -156,7 +156,7 @@ export default class Bundle {
 	}
 
 	private assignManualChunks(getManualChunk: GetManualChunk): Map<Module, string> {
-		const manualChunkAliasByEntry = new Map<Module, string>();
+		const manualChunkAliasesWithEntry: [alias: string, module: Module][] = [];
 		const manualChunksApi = {
 			getModuleIds: () => this.graph.modulesById.keys(),
 			getModuleInfo: this.graph.getModuleInfo
@@ -165,10 +165,17 @@ export default class Bundle {
 			if (module instanceof Module) {
 				const manualChunkAlias = getManualChunk(module.id, manualChunksApi);
 				if (typeof manualChunkAlias === 'string') {
-					addModuleToManualChunk(manualChunkAlias, module, manualChunkAliasByEntry);
+					manualChunkAliasesWithEntry.push([manualChunkAlias, module]);
 				}
 			}
 		}
+		manualChunkAliasesWithEntry.sort(([aliasA], [aliasB]) =>
+			aliasA > aliasB ? 1 : aliasA < aliasB ? -1 : 0
+		);
+		const manualChunkAliasByEntry = new Map<Module, string>();
+		for (const [alias, module] of manualChunkAliasesWithEntry) {
+			addModuleToManualChunk(alias, module, manualChunkAliasByEntry);
+		}
 		return manualChunkAliasByEntry;
 	}
 
diff --git a/test/chunking-form/samples/manual-chunks-function/_config.js b/test/chunking-form/samples/manual-chunks-function/_config.js
@@ -1,3 +1,5 @@
+const assert = require('assert');
+
 module.exports = {
 	description: 'allows to define manual chunks via a function',
 	options: {
@@ -8,6 +10,19 @@ module.exports = {
 					return `chunk-${id[id.length - 4]}`;
 				}
 			}
-		}
+		},
+		plugins: [
+			{
+				generateBundle(options, bundle) {
+					// This also asserts the sorting order, which should be alphabetical
+					// between the manual chunks
+					assert.deepStrictEqual(Object.keys(bundle), [
+						'main-a.js',
+						'generated-chunk-b.js',
+						'generated-chunk-c.js'
+					]);
+				}
+			}
+		]
 	}
 };
diff --git a/test/chunking-form/samples/manual-chunks-function/_expected/amd/generated-chunk-b.js b/test/chunking-form/samples/manual-chunks-function/_expected/amd/generated-chunk-b.js
@@ -4,4 +4,8 @@ define((function () { 'use strict';
 
 	console.log('dep-b');
 
+	console.log('dep2-b');
+
+	console.log('dep3-b');
+
 }));
diff --git a/test/chunking-form/samples/manual-chunks-function/_expected/amd/main-a.js b/test/chunking-form/samples/manual-chunks-function/_expected/amd/main-a.js
@@ -4,6 +4,10 @@ define(['./generated-chunk-c', './generated-chunk-b'], (function (chunkC, chunkB
 
 	console.log('dep-a');
 
+	console.log('dep2-a');
+
+	console.log('dep3-a');
+
 	console.log('main-a');
 
 }));
diff --git a/test/chunking-form/samples/manual-chunks-function/_expected/cjs/generated-chunk-b.js b/test/chunking-form/samples/manual-chunks-function/_expected/cjs/generated-chunk-b.js
@@ -3,3 +3,7 @@
 console.log('dep2');
 
 console.log('dep-b');
+
+console.log('dep2-b');
+
+console.log('dep3-b');
diff --git a/test/chunking-form/samples/manual-chunks-function/_expected/cjs/main-a.js b/test/chunking-form/samples/manual-chunks-function/_expected/cjs/main-a.js
@@ -7,4 +7,8 @@ console.log('dep1');
 
 console.log('dep-a');
 
+console.log('dep2-a');
+
+console.log('dep3-a');
+
 console.log('main-a');
diff --git a/test/chunking-form/samples/manual-chunks-function/_expected/es/generated-chunk-b.js b/test/chunking-form/samples/manual-chunks-function/_expected/es/generated-chunk-b.js
@@ -1,3 +1,7 @@
 console.log('dep2');
 
 console.log('dep-b');
+
+console.log('dep2-b');
+
+console.log('dep3-b');
diff --git a/test/chunking-form/samples/manual-chunks-function/_expected/es/main-a.js b/test/chunking-form/samples/manual-chunks-function/_expected/es/main-a.js
@@ -5,4 +5,8 @@ console.log('dep1');
 
 console.log('dep-a');
 
+console.log('dep2-a');
+
+console.log('dep3-a');
+
 console.log('main-a');
diff --git a/test/chunking-form/samples/manual-chunks-function/_expected/system/generated-chunk-b.js b/test/chunking-form/samples/manual-chunks-function/_expected/system/generated-chunk-b.js
@@ -7,6 +7,10 @@ System.register([], (function () {
 
 			console.log('dep-b');
 
+			console.log('dep2-b');
+
+			console.log('dep3-b');
+
 		})
 	};
 }));
diff --git a/test/chunking-form/samples/manual-chunks-function/_expected/system/main-a.js b/test/chunking-form/samples/manual-chunks-function/_expected/system/main-a.js
@@ -8,6 +8,10 @@ System.register(['./generated-chunk-c.js', './generated-chunk-b.js'], (function
 
 			console.log('dep-a');
 
+			console.log('dep2-a');
+
+			console.log('dep3-a');
+
 			console.log('main-a');
 
 		})
diff --git a/test/chunking-form/samples/manual-chunks-function/dep2-a.js b/test/chunking-form/samples/manual-chunks-function/dep2-a.js
@@ -0,0 +1 @@
+console.log('dep2-a');
diff --git a/test/chunking-form/samples/manual-chunks-function/dep2-b.js b/test/chunking-form/samples/manual-chunks-function/dep2-b.js
@@ -0,0 +1 @@
+console.log('dep2-b');
diff --git a/test/chunking-form/samples/manual-chunks-function/dep3-a.js b/test/chunking-form/samples/manual-chunks-function/dep3-a.js
@@ -0,0 +1 @@
+console.log('dep3-a');
diff --git a/test/chunking-form/samples/manual-chunks-function/dep3-b.js b/test/chunking-form/samples/manual-chunks-function/dep3-b.js
@@ -0,0 +1 @@
+console.log('dep3-b');
diff --git a/test/chunking-form/samples/manual-chunks-function/main-a.js b/test/chunking-form/samples/manual-chunks-function/main-a.js
@@ -1,4 +1,9 @@
+import './dep-c';
 import './dep-a';
+import './dep2-a'
+import './dep3-a'
 import './dep-b';
+import './dep2-b'
+import './dep3-b'
 
 console.log('main-a');

Original file line number	Diff line number	Diff line change
`@@ -156,7 +156,7 @@ export default class Bundle {`
`156`	`156`	`}`
`157`	`157`
`158`	`158`	`private assignManualChunks(getManualChunk: GetManualChunk): Map<Module, string> {`
`159`		`- const manualChunkAliasByEntry = new Map<Module, string>();`
	`159`	`+ const manualChunkAliasesWithEntry: [alias: string, module: Module][] = [];`
`160`	`160`	`const manualChunksApi = {`
`161`	`161`	`getModuleIds: () => this.graph.modulesById.keys(),`
`162`	`162`	`getModuleInfo: this.graph.getModuleInfo`
`@@ -165,10 +165,17 @@ export default class Bundle {`
`165`	`165`	`if (module instanceof Module) {`
`166`	`166`	`const manualChunkAlias = getManualChunk(module.id, manualChunksApi);`
`167`	`167`	`if (typeof manualChunkAlias === 'string') {`
`168`		`- addModuleToManualChunk(manualChunkAlias, module, manualChunkAliasByEntry);`
	`168`	`+ manualChunkAliasesWithEntry.push([manualChunkAlias, module]);`
`169`	`169`	`}`
`170`	`170`	`}`
`171`	`171`	`}`
	`172`	`+ manualChunkAliasesWithEntry.sort(([aliasA], [aliasB]) =>`
	`173`	`+ aliasA > aliasB ? 1 : aliasA < aliasB ? -1 : 0`
	`174`	`+ );`
	`175`	`+ const manualChunkAliasByEntry = new Map<Module, string>();`
	`176`	`+ for (const [alias, module] of manualChunkAliasesWithEntry) {`
	`177`	`+ addModuleToManualChunk(alias, module, manualChunkAliasByEntry);`
	`178`	`+ }`
`172`	`179`	`return manualChunkAliasByEntry;`
`173`	`180`	`}`
`174`	`181`