Merge pull request webpack#3175 from BrainCrumbz/feat/ruleset-error-context

sokra · web-flow · commit 72cf5f633621 · 2016-10-26T12:36:00.000+02:00
feat(ruleset): show context in error when `exclude` holds undefined item
diff --git a/lib/RuleSet.js b/lib/RuleSet.js
@@ -51,7 +51,7 @@
 <condition>: { and: [<condition>] }
 <condition>: { or: [<condition>] }
 <condition>: { not: [<condition>] }
-<condition>: { test: <condition>, include: <condition>, exclude: <codition> }
+<condition>: { test: <condition>, include: <condition>, exclude: <condition> }
 
 
 normalized:
@@ -106,23 +106,37 @@ RuleSet.normalizeRule = function(rule) {
 	var newRule = {};
 	var useSource;
 	var resourceSource;
+	var condition;
 
 	if(rule.test || rule.include || rule.exclude) {
 		checkResourceSource("test + include + exclude");
-		newRule.resource = RuleSet.normalizeCondition({
+		condition = {
 			test: rule.test,
 			include: rule.include,
 			exclude: rule.exclude
-		});
+		};
+		try {
+			newRule.resource = RuleSet.normalizeCondition(condition);
+		} catch (error) {
+			throw new Error(RuleSet.buildErrorMessage(condition, error));
+		}
 	}
 
 	if(rule.resource) {
 		checkResourceSource("resource");
-		newRule.resource = RuleSet.normalizeCondition(rule.resource);
+		try {
+			newRule.resource = RuleSet.normalizeCondition(rule.resource);
+		} catch (error) {
+			throw new Error(RuleSet.buildErrorMessage(rule.resource, error));
+		}
 	}
 
 	if(rule.issuer) {
-		newRule.issuer = RuleSet.normalizeCondition(rule.issuer);
+		try {
+			newRule.issuer = RuleSet.normalizeCondition(rule.issuer);
+		} catch (error) {
+			throw new Error(RuleSet.buildErrorMessage(rule.issuer, error));
+		}
 	}
 
 	if(rule.loader && rule.loaders)
@@ -179,6 +193,14 @@ RuleSet.normalizeRule = function(rule) {
 	return newRule;
 };
 
+RuleSet.buildErrorMessage = function buildErrorMessage(condition, error) {
+	var conditionAsText = JSON.stringify(condition, function(key, value) {
+		return (value === undefined) ? "undefined" : value;
+	}, 2)
+	var message = error.message + " in " + conditionAsText;
+	return message;
+};
+
 RuleSet.normalizeUse = function normalizeUse(use) {
 	if(Array.isArray(use)) {
 		return use.map(RuleSet.normalizeUse).reduce(function(arr, items) {
diff --git a/test/RuleSet.test.js b/test/RuleSet.test.js
@@ -268,4 +268,66 @@ describe("RuleSet", function() {
 			(match(loader, 'style.css')).should.eql(['css']);
 		}, /No loader specified/)
 	});
+	describe('when exclude array holds an undefined item', function() {
+		function errorHasContext(err) {
+			if (/Expected condition but got falsy value/.test(err)
+				&& /test/.test(err)
+				&& /include/.test(err)
+				&& /exclude/.test(err)
+				&& /node_modules/.test(err)
+				&& /undefined/.test(err)) {
+				return true;
+			}
+		}
+		it('should throw with context', function() {
+			should.throws(function() {
+				var loader = new RuleSet([{
+					test: /\.css$/,
+					loader: 'css',
+					include: [
+						'src',
+					],
+					exclude: [
+						'node_modules',
+						undefined,
+					],
+				}]);
+				(match(loader, 'style.css')).should.eql(['css']);
+			}, errorHasContext)
+		});
+		it('in resource should throw with context', function() {
+			should.throws(function() {
+				var loader = new RuleSet([{
+					resource: {
+						test: /\.css$/,
+						include: [
+							'src',
+						],
+						exclude: [
+							'node_modules',
+							undefined,
+						],
+					},
+				}]);
+				(match(loader, 'style.css')).should.eql(['css']);
+			}, errorHasContext)
+		});
+		it('in issuer should throw with context', function() {
+			should.throws(function() {
+				var loader = new RuleSet([{
+					issuer: {
+						test: /\.css$/,
+						include: [
+							'src',
+						],
+						exclude: [
+							'node_modules',
+							undefined,
+						],
+					},
+				}]);
+				(match(loader, 'style.css')).should.eql(['css']);
+			}, errorHasContext)
+		});
+	});
 });
