Cleanup error location and origin information

webpack · Jun 4, 2018 · 53103a9 · 53103a9
1 parent 53f7deb
commit 53103a9
Show file tree

Hide file tree

Showing 28 changed files with 191 additions and 169 deletions.
diff --git a/lib/AsyncDependencyToInitialChunkError.js b/lib/AsyncDependencyToInitialChunkError.js
@@ -16,13 +16,13 @@ class AsyncDependencyToInitialChunkError extends WebpackError {
 	 * @param {TODO} loc location of dependency
 	 */
 	constructor(chunkName, module, loc) {
-		super();
+		super(
+			`It's not allowed to load an initial chunk on demand. The chunk name "${chunkName}" is already used by an entrypoint.`
+		);
 
 		this.name = "AsyncDependencyToInitialChunkError";
-		this.message = `It's not allowed to load an initial chunk on demand. The chunk name "${chunkName}" is already used by an entrypoint.`;
 		this.module = module;
-		this.origin = module;
-		this.originLoc = loc;
+		this.loc = loc;
 
 		Error.captureStackTrace(this, this.constructor);
 	}

diff --git a/lib/CaseSensitiveModulesWarning.js b/lib/CaseSensitiveModulesWarning.js
@@ -8,64 +8,60 @@ const WebpackError = require("./WebpackError");
 
 /** @typedef {import("./Module")} Module */
 
+/**
+ * @param {Module[]} modules the modules to be sorted
+ * @returns {Module[]} sorted version of original modules
+ */
+const sortModules = modules => {
+	return modules.slice().sort((a, b) => {
+		a = a.identifier();
+		b = b.identifier();
+		/* istanbul ignore next */
+		if (a < b) return -1;
+		/* istanbul ignore next */
+		if (a > b) return 1;
+		/* istanbul ignore next */
+		return 0;
+	});
+};
+
+/**
+ * @param {Module[]} modules each module from throw
+ * @returns {string} each message from provided moduels
+ */
+const createModulesListMessage = modules => {
+	return modules
+		.map(m => {
+			let message = `* ${m.identifier()}`;
+			const validReasons = m.reasons.filter(reason => reason.module);
+
+			if (validReasons.length > 0) {
+				message += `\n    Used by ${validReasons.length} module(s), i. e.`;
+				message += `\n    ${validReasons[0].module.identifier()}`;
+			}
+			return message;
+		})
+		.join("\n");
+};
+
 class CaseSensitiveModulesWarning extends WebpackError {
 	/**
 	 * Creates an instance of CaseSensitiveModulesWarning.
 	 * @param {Module[]} modules modules that were detected
 	 */
 	constructor(modules) {
-		super();
-
-		this.name = "CaseSensitiveModulesWarning";
-		const sortedModules = this._sort(modules);
-		const modulesList = this._moduleMessages(sortedModules);
-		this.message = `There are multiple modules with names that only differ in casing.
+		const sortedModules = sortModules(modules);
+		const modulesList = createModulesListMessage(sortedModules);
+		super(`There are multiple modules with names that only differ in casing.
 This can lead to unexpected behavior when compiling on a filesystem with other case-semantic.
 Use equal casing. Compare these module identifiers:
-${modulesList}`;
+${modulesList}`);
 
+		this.name = "CaseSensitiveModulesWarning";
 		this.origin = this.module = sortedModules[0];
 
 		Error.captureStackTrace(this, this.constructor);
 	}
-
-	/**
-	 * @private
-	 * @param {Module[]} modules the modules to be sorted
-	 * @returns {Module[]} sorted version of original modules
-	 */
-	_sort(modules) {
-		return modules.slice().sort((a, b) => {
-			a = a.identifier();
-			b = b.identifier();
-			/* istanbul ignore next */
-			if (a < b) return -1;
-			/* istanbul ignore next */
-			if (a > b) return 1;
-			/* istanbul ignore next */
-			return 0;
-		});
-	}
-
-	/**
-	 * @private
-	 * @param {Module[]} modules each module from throw
-	 * @returns {string} each message from provided moduels
-	 */
-	_moduleMessages(modules) {
-		return modules
-			.map(m => {
-				let message = `* ${m.identifier()}`;
-				const validReasons = m.reasons.filter(reason => reason.module);
-
-				if (validReasons.length > 0) {
-					message += `\n    Used by ${validReasons.length} module(s), i. e.`;
-					message += `\n    ${validReasons[0].module.identifier()}`;
-				}
-				return message;
-			})
-			.join("\n");
-	}
 }
 
 module.exports = CaseSensitiveModulesWarning;
diff --git a/lib/Compilation.js b/lib/Compilation.js
@@ -487,6 +487,7 @@ class Compilation extends Tapable {
 
 				const errorAndCallback = err => {
 					err.origin = module;
+					err.dependencies = dependencies;
 					this.errors.push(err);
 					if (bail) {
 						callback(err);
@@ -531,7 +532,7 @@ class Compilation extends Tapable {
 							if (err) {
 								semaphore.release();
 								return errorOrWarningAndCallback(
-									new ModuleNotFoundError(module, err, dependencies)
+									new ModuleNotFoundError(module, err)
 								);
 							}
 							if (!dependentModule) {

diff --git a/lib/EntryModuleNotFoundError.js b/lib/EntryModuleNotFoundError.js
@@ -8,10 +8,9 @@ const WebpackError = require("./WebpackError");
 
 class EntryModuleNotFoundError extends WebpackError {
 	constructor(err) {
-		super();
+		super("Entry module not found: " + err);
 
 		this.name = "EntryModuleNotFoundError";
-		this.message = "Entry module not found: " + err;
 		this.details = err.details;
 		this.error = err;
 

diff --git a/lib/HarmonyLinkingError.js b/lib/HarmonyLinkingError.js
@@ -8,9 +8,8 @@ const WebpackError = require("./WebpackError");
 module.exports = class HarmonyLinkingError extends WebpackError {
 	/** @param {string} message Error message */
 	constructor(message) {
-		super();
+		super(message);
 		this.name = "HarmonyLinkingError";
-		this.message = message;
 		this.hideStack = true;
 
 		Error.captureStackTrace(this, this.constructor);

diff --git a/lib/ModuleBuildError.js b/lib/ModuleBuildError.js
@@ -9,29 +9,32 @@ const { cutOffLoaderExecution } = require("./ErrorHelpers");
 
 class ModuleBuildError extends WebpackError {
 	constructor(module, err) {
-		super();
-
-		this.name = "ModuleBuildError";
-		this.message = "Module build failed: ";
+		let message = "Module build failed: ";
+		let details = undefined;
 		if (err !== null && typeof err === "object") {
 			if (typeof err.stack === "string" && err.stack) {
 				var stack = cutOffLoaderExecution(err.stack);
 				if (!err.hideStack) {
-					this.message += stack;
+					message += stack;
 				} else {
-					this.details = stack;
+					details = stack;
 					if (typeof err.message === "string" && err.message) {
-						this.message += err.message;
+						message += err.message;
 					} else {
-						this.message += err;
+						message += err;
 					}
 				}
 			} else if (typeof err.message === "string" && err.message) {
-				this.message += err.message;
+				message += err.message;
 			} else {
-				this.message += err;
+				message += err;
 			}
 		}
+
+		super(message);
+
+		this.name = "ModuleBuildError";
+		this.details = details;
 		this.module = module;
 		this.error = err;
 

diff --git a/lib/ModuleDependencyError.js b/lib/ModuleDependencyError.js
@@ -5,7 +5,6 @@
 "use strict";
 
 const WebpackError = require("./WebpackError");
-const formatLocation = require("./formatLocation");
 
 /** @typedef {import("./Module")} Module */
 
@@ -17,15 +16,15 @@ class ModuleDependencyError extends WebpackError {
 	 * @param {TODO} loc location of dependency
 	 */
 	constructor(module, err, loc) {
-		super();
+		super(err.message);
 
 		this.name = "ModuleDependencyError";
-		this.message = `${formatLocation(loc)} ${err.message}`;
 		this.details = err.stack
 			.split("\n")
 			.slice(1)
 			.join("\n");
-		this.origin = this.module = module;
+		this.module = module;
+		this.loc = loc;
 		this.error = err;
 
 		Error.captureStackTrace(this, this.constructor);

diff --git a/lib/ModuleDependencyWarning.js b/lib/ModuleDependencyWarning.js
@@ -5,19 +5,18 @@
 "use strict";
 
 const WebpackError = require("./WebpackError");
-const formatLocation = require("./formatLocation");
 
 module.exports = class ModuleDependencyWarning extends WebpackError {
 	constructor(module, err, loc) {
-		super();
+		super(err.message);
 
 		this.name = "ModuleDependencyWarning";
-		this.message = `${formatLocation(loc)} ${err.message}`;
 		this.details = err.stack
 			.split("\n")
 			.slice(1)
 			.join("\n");
-		this.origin = this.module = module;
+		this.module = module;
+		this.loc = loc;
 		this.error = err;
 
 		Error.captureStackTrace(this, this.constructor);

diff --git a/lib/ModuleError.js b/lib/ModuleError.js
@@ -9,12 +9,10 @@ const { cleanUp } = require("./ErrorHelpers");
 
 class ModuleError extends WebpackError {
 	constructor(module, err) {
-		super();
+		super(err && typeof err === "object" && err.message ? err.message : err);
 
 		this.name = "ModuleError";
 		this.module = module;
-		this.message =
-			err && typeof err === "object" && err.message ? err.message : err;
 		this.error = err;
 		this.details =
 			err && typeof err === "object" && err.stack

diff --git a/lib/ModuleNotFoundError.js b/lib/ModuleNotFoundError.js
@@ -7,16 +7,13 @@
 const WebpackError = require("./WebpackError");
 
 class ModuleNotFoundError extends WebpackError {
-	constructor(module, err, dependencies) {
-		super();
+	constructor(module, err) {
+		super("Module not found: " + err);
 
 		this.name = "ModuleNotFoundError";
-		this.message = "Module not found: " + err;
 		this.details = err.details;
 		this.missing = err.missing;
 		this.module = module;
-		this.origin = module;
-		this.dependencies = dependencies;
 		this.error = err;
 
 		Error.captureStackTrace(this, this.constructor);

diff --git a/lib/ModuleParseError.js b/lib/ModuleParseError.js
@@ -6,14 +6,18 @@
 
 const WebpackError = require("./WebpackError");
 
+/** @typedef {import("./Module")} Module */
+
 class ModuleParseError extends WebpackError {
+	/**
+	 * @param {Module} module the errored module
+	 * @param {string} source source code
+	 * @param {Error&any} err the parse error
+	 */
 	constructor(module, source, err) {
-		super();
-
-		this.name = "ModuleParseError";
-		this.message = "Module parse failed: " + err.message;
-		this.message +=
-			"\nYou may need an appropriate loader to handle this file type.";
+		let message = "Module parse failed: " + err.message;
+		let loc = undefined;
+		message += "\nYou may need an appropriate loader to handle this file type.";
 		if (
 			err.loc &&
 			typeof err.loc === "object" &&
@@ -22,19 +26,28 @@ class ModuleParseError extends WebpackError {
 			var lineNumber = err.loc.line;
 			if (/[\0\u0001\u0002\u0003\u0004\u0005\u0006\u0007]/.test(source)) {
 				// binary file
-				this.message += "\n(Source code omitted for this binary file)";
+				message += "\n(Source code omitted for this binary file)";
 			} else {
-				source = source.split("\n");
-				this.message +=
-					"\n| " +
-					source
-						.slice(Math.max(0, lineNumber - 3), lineNumber + 2)
-						.join("\n| ");
+				const sourceLines = source.split("\n");
+				const start = Math.max(0, lineNumber - 3);
+				const linesBefore = sourceLines.slice(start, lineNumber - 1);
+				const theLine = sourceLines[lineNumber - 1];
+				const linesAfter = sourceLines.slice(lineNumber, lineNumber + 2);
+				message +=
+					linesBefore.map(l => `\n| ${l}`).join("") +
+					`\n> ${theLine}` +
+					linesAfter.map(l => `\n| ${l}`).join("");
 			}
+			loc = err.loc;
 		} else {
-			this.message += "\n" + err.stack;
+			message += "\n" + err.stack;
 		}
+
+		super(message);
+
+		this.name = "ModuleParseError";
 		this.module = module;
+		this.loc = loc;
 		this.error = err;
 
 		Error.captureStackTrace(this, this.constructor);

diff --git a/lib/ModuleWarning.js b/lib/ModuleWarning.js
@@ -9,14 +9,14 @@ const { cleanUp } = require("./ErrorHelpers");
 
 class ModuleWarning extends WebpackError {
 	constructor(module, warning) {
-		super();
+		super(
+			warning && typeof warning === "object" && warning.message
+				? warning.message
+				: warning
+		);
 
 		this.name = "ModuleWarning";
 		this.module = module;
-		this.message =
-			warning && typeof warning === "object" && warning.message
-				? warning.message
-				: warning;
 		this.warning = warning;
 		this.details =
 			warning && typeof warning === "object" && warning.stack

diff --git a/lib/ParserHelpers.js b/lib/ParserHelpers.js
@@ -88,7 +88,7 @@ ParserHelpers.expressionIsUnsupported = (parser, message) => {
 		parser.state.current.addDependency(dep);
 		if (!parser.state.module) return;
 		parser.state.module.warnings.push(
-			new UnsupportedFeatureWarning(parser.state.module, message)
+			new UnsupportedFeatureWarning(parser.state.module, message, expr.loc)
 		);
 		return true;
 	};

diff --git a/lib/RemovedPluginError.js b/lib/RemovedPluginError.js
@@ -4,9 +4,7 @@ const WebpackError = require("./WebpackError");
 
 module.exports = class RemovedPluginError extends WebpackError {
 	constructor(message) {
-		super();
-
-		this.message = message;
+		super(message);
 
 		Error.captureStackTrace(this, this.constructor);
 	}