[FIX] npm translator: Remove deduped optional dependencies from tree

In some cases optional (pending) dependencies that have been deduped have not been removed from the dependency tree, no matter whether the "includeDeduped" flag was set or not.
SAP · Feb 14, 2019 · 3481154 · 3481154
1 parent 4d8527a
commit 3481154
Show file tree

Hide file tree

Showing 2 changed files with 99 additions and 5 deletions.
diff --git a/lib/translators/npm.js b/lib/translators/npm.js
@@ -461,8 +461,12 @@ class NpmTranslator {
 					`(child of ${parent.id})`);
 
 				const idx = parent.dependencies.indexOf(project);
-				const dedupedProject = this.createDedupedProject(project);
-				parent.dependencies.splice(idx, 1, dedupedProject);
+				if (this.includeDeduped) {
+					const dedupedProject = this.createDedupedProject(project);
+					parent.dependencies.splice(idx, 1, dedupedProject);
+				} else {
+					parent.dependencies.splice(idx, 1);
+				}
 			}
 
 			if (project.dependencies) {

diff --git a/test/lib/translators/npm.js b/test/lib/translators/npm.js
@@ -59,7 +59,7 @@ test("AppG: project with npm 'optionalDependencies' should not fail if optional
 test("AppCycleA: cyclic dev deps", (t) => {
 	const applicationCycleAPath = path.join(cycleDepsBasePath, "application.cycle.a");
 
-	return npmTranslator.generateDependencyTree(applicationCycleAPath, {includeDeduped: false}).then((parsedTree) => {
+	return npmTranslator.generateDependencyTree(applicationCycleAPath).then((parsedTree) => {
 		t.deepEqual(parsedTree, applicationCycleATree, "Parsed correctly");
 	});
 });
@@ -72,9 +72,16 @@ test("AppCycleA: cyclic dev deps - include deduped", (t) => {
 	});
 });
 
+test("AppCycleB: cyclic npm deps - Cycle via devDependency on second level - include deduped", (t) => {
+	const applicationCycleBPath = path.join(cycleDepsBasePath, "application.cycle.b");
+	return npmTranslator.generateDependencyTree(applicationCycleBPath, {includeDeduped: true}).then((parsedTree) => {
+		t.deepEqual(parsedTree, applicationCycleBTreeIncDeduped, "Parsed correctly");
+	});
+});
+
 test("AppCycleB: cyclic npm deps - Cycle via devDependency on second level", (t) => {
 	const applicationCycleBPath = path.join(cycleDepsBasePath, "application.cycle.b");
-	return npmTranslator.generateDependencyTree(applicationCycleBPath).then((parsedTree) => {
+	return npmTranslator.generateDependencyTree(applicationCycleBPath, {includeDeduped: false}).then((parsedTree) => {
 		t.deepEqual(parsedTree, applicationCycleBTree, "Parsed correctly");
 	});
 });
@@ -100,9 +107,16 @@ test("AppCycleD: cyclic npm deps - Cycles everywhere", (t) => {
 	});
 });
 
-test("AppCycleE: cyclic npm deps - Cycle via devDependency", (t) => {
+test("AppCycleE: cyclic npm deps - Cycle via devDependency - include deduped", (t) => {
 	const applicationCycleEPath = path.join(cycleDepsBasePath, "application.cycle.e");
 	return npmTranslator.generateDependencyTree(applicationCycleEPath, {includeDeduped: true}).then((parsedTree) => {
+		t.deepEqual(parsedTree, applicationCycleETreeIncDeduped, "Parsed correctly");
+	});
+});
+
+test("AppCycleE: cyclic npm deps - Cycle via devDependency", (t) => {
+	const applicationCycleEPath = path.join(cycleDepsBasePath, "application.cycle.e");
+	return npmTranslator.generateDependencyTree(applicationCycleEPath, {includeDeduped: false}).then((parsedTree) => {
 		t.deepEqual(parsedTree, applicationCycleETree, "Parsed correctly");
 	});
 });
@@ -394,6 +408,48 @@ const applicationCycleBTree = {
 				}
 			]
 		},
+		{
+			"id": "module.e",
+			"version": "1.0.0",
+			"path": path.join(cycleDepsBasePath, "module.e"),
+			"dependencies": [
+				{
+					"id": "module.d",
+					"version": "1.0.0",
+					"path": path.join(cycleDepsBasePath, "module.d"),
+					"dependencies": []
+				}
+			]
+		}
+	]
+};
+
+const applicationCycleBTreeIncDeduped = {
+	"id": "application.cycle.b",
+	"version": "1.0.0",
+	"path": path.join(cycleDepsBasePath, "application.cycle.b"),
+	"dependencies": [
+		{
+			"id": "module.d",
+			"version": "1.0.0",
+			"path": path.join(cycleDepsBasePath, "module.d"),
+			"dependencies": [
+				{
+					"id": "module.e",
+					"version": "1.0.0",
+					"path": path.join(cycleDepsBasePath, "module.e"),
+					"dependencies": [
+						{
+							"id": "module.d",
+							"version": "1.0.0",
+							"path": path.join(cycleDepsBasePath, "module.d"),
+							"dependencies": [],
+							"deduped": true
+						}
+					]
+				}
+			]
+		},
 		{
 			"id": "module.e",
 			"version": "1.0.0",
@@ -860,6 +916,40 @@ const applicationCycleDTree = {
 };
 
 const applicationCycleETree = {
+	"id": "application.cycle.e",
+	"version": "1.0.0",
+	"path": path.join(cycleDepsBasePath, "application.cycle.e"),
+	"dependencies": [
+		{
+			"id": "module.l",
+			"version": "1.0.0",
+			"path": path.join(cycleDepsBasePath, "module.l"),
+			"dependencies": [
+				{
+					"id": "module.m",
+					"version": "1.0.0",
+					"path": path.join(cycleDepsBasePath, "module.m"),
+					"dependencies": []
+				}
+			]
+		},
+		{
+			"id": "module.m",
+			"version": "1.0.0",
+			"path": path.join(cycleDepsBasePath, "module.m"),
+			"dependencies": [
+				{
+					"id": "module.l",
+					"version": "1.0.0",
+					"path": path.join(cycleDepsBasePath, "module.l"),
+					"dependencies": []
+				}
+			]
+		}
+	]
+};
+
+const applicationCycleETreeIncDeduped = {
 	"id": "application.cycle.e",
 	"version": "1.0.0",
 	"path": path.join(cycleDepsBasePath, "application.cycle.e"),