feat: support tree shaking in DllPlugin

asapach · asapach · commit 6c0c52558c42 · 2018-05-18T22:57:29.000+03:00
This change introduces a new `entryOnly` flag to the DllPlugin options which limits the exposed modules to only those configured as entry points. This allows module concatenation and dead code removal optimizations to take place.
diff --git a/lib/DllPlugin.js b/lib/DllPlugin.js
@@ -33,7 +33,9 @@ class DllPlugin {
 			return true;
 		});
 		new LibManifestPlugin(this.options).apply(compiler);
-		new FlagInitialModulesAsUsedPlugin("DllPlugin").apply(compiler);
+		if (!this.options.entryOnly) {
+			new FlagInitialModulesAsUsedPlugin("DllPlugin").apply(compiler);
+		}
 	}
 }
 
diff --git a/schemas/plugins/DllPlugin.json b/schemas/plugins/DllPlugin.json
@@ -23,6 +23,10 @@
       "description": "Absolute path to the manifest json file (output)",
       "minLength": 1,
       "type": "string"
+    },
+    "entryOnly": {
+      "description": "If true, only entry points will be exposed",
+      "type": "boolean"
     }
   }
 }
diff --git a/test/configCases/dll-plugin-entry/0-create-dll/dep.js b/test/configCases/dll-plugin-entry/0-create-dll/dep.js
@@ -0,0 +1,5 @@
+export function foo() {
+	console.log("foo");
+}
+
+export const bar = "bar";
diff --git a/test/configCases/dll-plugin-entry/0-create-dll/index.js b/test/configCases/dll-plugin-entry/0-create-dll/index.js
@@ -0,0 +1,2 @@
+export { bar } from "./dep";
+export default 42;
diff --git a/test/configCases/dll-plugin-entry/0-create-dll/test.config.js b/test/configCases/dll-plugin-entry/0-create-dll/test.config.js
@@ -0,0 +1 @@
+exports.noTests = true;
diff --git a/test/configCases/dll-plugin-entry/0-create-dll/webpack.config.js b/test/configCases/dll-plugin-entry/0-create-dll/webpack.config.js
@@ -0,0 +1,20 @@
+var path = require("path");
+var webpack = require("../../../../");
+
+module.exports = {
+	entry: ["."],
+	output: {
+		filename: "dll.js",
+		chunkFilename: "[id].dll.js",
+		libraryTarget: "commonjs2"
+	},
+	plugins: [
+		new webpack.DllPlugin({
+			path: path.resolve(
+				__dirname,
+				"../../../js/config/dll-plugin-entry/manifest0.json"
+			),
+			entryOnly: true
+		})
+	]
+};
diff --git a/test/configCases/dll-plugin-entry/1-use-dll/index.js b/test/configCases/dll-plugin-entry/1-use-dll/index.js
@@ -0,0 +1,21 @@
+import Answer, { bar } from "dll/index";
+
+it("should load a module from dll", function() {
+	expect(require("dll/index")).toEqual({ bar: "bar", default: 42 });
+});
+
+it("should load an harmony module from dll (default export)", function() {
+	expect(Answer).toBe(42);
+});
+
+it("should load an harmony module from dll (star export)", function() {
+	expect(bar).toBe("bar");
+});
+
+it("should give modules the correct ids", function() {
+	expect(Object.keys(__webpack_modules__).filter(m => !m.startsWith("../.."))).toEqual([
+		"./index.js",
+		"dll-reference ../0-create-dll/dll.js",
+		"dll/index.js"
+	]);
+});
diff --git a/test/configCases/dll-plugin-entry/1-use-dll/webpack.config.js b/test/configCases/dll-plugin-entry/1-use-dll/webpack.config.js
@@ -0,0 +1,13 @@
+var webpack = require("../../../../");
+
+module.exports = {
+	plugins: [
+		new webpack.DllReferencePlugin({
+			manifest: require("../../../js/config/dll-plugin-entry/manifest0.json"), // eslint-disable-line node/no-missing-require
+			name: "../0-create-dll/dll.js",
+			scope: "dll",
+			sourceType: "commonjs2"
+		}),
+		new webpack.NamedModulesPlugin()
+	]
+};
diff --git a/test/configCases/dll-plugin-entry/2-error-non-entry/errors.js b/test/configCases/dll-plugin-entry/2-error-non-entry/errors.js
@@ -0,0 +1 @@
+module.exports = [[/Can't resolve 'dll\/dep'/]];
diff --git a/test/configCases/dll-plugin-entry/2-error-non-entry/index.js b/test/configCases/dll-plugin-entry/2-error-non-entry/index.js
@@ -0,0 +1 @@
+require("dll/dep");
diff --git a/test/configCases/dll-plugin-entry/2-error-non-entry/webpack.config.js b/test/configCases/dll-plugin-entry/2-error-non-entry/webpack.config.js
@@ -0,0 +1,13 @@
+var webpack = require("../../../../");
+
+module.exports = {
+	plugins: [
+		new webpack.DllReferencePlugin({
+			manifest: require("../../../js/config/dll-plugin-entry/manifest0.json"), // eslint-disable-line node/no-missing-require
+			name: "../0-create-dll/dll.js",
+			scope: "dll",
+			sourceType: "commonjs2"
+		}),
+		new webpack.NamedModulesPlugin()
+	]
+};

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,9 @@ class DllPlugin {`
`33`	`33`	`return true;`
`34`	`34`	`});`
`35`	`35`	`new LibManifestPlugin(this.options).apply(compiler);`
`36`		`- new FlagInitialModulesAsUsedPlugin("DllPlugin").apply(compiler);`
	`36`	`+ if (!this.options.entryOnly) {`
	`37`	`+ new FlagInitialModulesAsUsedPlugin("DllPlugin").apply(compiler);`
	`38`	`+ }`
`37`	`39`	`}`
`38`	`40`	`}`
`39`	`41`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,10 @@`
`23`	`23`	`"description": "Absolute path to the manifest json file (output)",`
`24`	`24`	`"minLength": 1,`
`25`	`25`	`"type": "string"`
	`26`	`+ },`
	`27`	`+ "entryOnly": {`
	`28`	`+ "description": "If true, only entry points will be exposed",`
	`29`	`+ "type": "boolean"`
`26`	`30`	`}`
`27`	`31`	`}`
`28`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export { bar } from "./dep";`
	`2`	`+export default 42;`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+module.exports = [[/Can't resolve 'dll\/dep'/]];`