[FIX] ui5Framework: Improve error handling for duplicate lib declaration

Fixes: SAP/ui5-tooling#780

Author: matz3

lib/graph/helpers/ui5Framework.js

@@ -192,6 +192,22 @@ const utils = {
 		});
 		await projectGraph.resolveOptionalDependencies();
 	},
+	checkForDuplicateFrameworkProjects(projectGraph, frameworkGraph) {
+		// Check for duplicate framework libraries
+		const projectGraphProjectNames = projectGraph.getProjectNames();
+		const duplicateFrameworkProjectNames = frameworkGraph.getProjectNames()
+			.filter((name) => projectGraphProjectNames.includes(name));
+
+		if (duplicateFrameworkProjectNames.length) {
+			throw new Error(
+				`Duplicate framework library definition(s) found in project ${projectGraph.getRoot().getName()}: ` +
+				`${duplicateFrameworkProjectNames.join(", ")}. ` +
+				`Framework libraries should only be referenced via ui5.yaml configuration, ` +
+				`not in its dependencies (e.g. package.json). ` +
+				`Note that this error could also come from transitive dependencies.`
+			);
+		}
+	},
 	ProjectProcessor
 };
 
@@ -313,6 +329,8 @@ export default {
 			await projectProcessor.addProjectToGraph(libName);
 		}));
 
+		utils.checkForDuplicateFrameworkProjects(projectGraph, frameworkGraph);
+
 		log.verbose("Joining framework graph into project graph...");
 		projectGraph.join(frameworkGraph);
 		await utils.declareFrameworkDependenciesInGraph(projectGraph);

test/lib/graph/helpers/ui5Framework.js

@@ -5,6 +5,7 @@ import sinonGlobal from "sinon";
 import esmock from "esmock";
 import DependencyTreeProvider from "../../../../lib/graph/providers/DependencyTree.js";
 import projectGraphBuilder from "../../../../lib/graph/projectGraphBuilder.js";
+import Specification from "../../../../lib/specifications/Specification.js";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
@@ -27,6 +28,8 @@ test.beforeEach(async (t) => {
 		getLogger: sinon.stub().returns(t.context.log)
 	};
 
+	t.context.Openui5ResolverStub = sinon.stub();
+
 	t.context.Sapui5ResolverStub = sinon.stub();
 	t.context.Sapui5ResolverInstallStub = sinon.stub();
 	t.context.Sapui5ResolverStub.callsFake(() => {
@@ -480,6 +483,84 @@ test.serial("enrichProjectGraph should ignore root project without framework con
 	t.is(projectGraph.getSize(), 1, "Project graph should remain unchanged");
 });
 
+test.serial("enrichProjectGraph should throw error when projectGraph contains a framework library project " +
+"that is also defined in framework configuration", async (t) => {
+	const {
+		sinon, ui5Framework, utils,
+		Sapui5ResolverResolveVersionStub, Sapui5ResolverInstallStub
+	} = t.context;
+	const dependencyTree = {
+		id: "application.a",
+		version: "1.2.3",
+		path: applicationAPath,
+		configuration: {
+			specVersion: "2.0",
+			type: "application",
+			metadata: {
+				name: "application.a"
+			},
+			framework: {
+				name: "SAPUI5",
+				version: "1.100.0",
+				libraries: [{
+					name: "sap.ui.core"
+				}]
+			}
+		},
+		dependencies: [{
+			id: "@openui5/sap.ui.core",
+			version: "1.99.0",
+			path: libraryEPath,
+			configuration: {
+				specVersion: "2.0",
+				type: "library",
+				metadata: {
+					name: "sap.ui.core"
+				}
+			}
+		}]
+	};
+
+	const referencedLibraries = ["sap.ui.core"];
+	const libraryMetadata = {fake: "metadata"};
+
+	sinon.stub(utils, "getFrameworkLibrariesFromGraph").resolves(referencedLibraries);
+
+	Sapui5ResolverInstallStub.resolves({libraryMetadata});
+	Sapui5ResolverResolveVersionStub.resolves("1.100.0");
+
+	sinon.stub(utils, "ProjectProcessor")
+		.callsFake(({graph}) => {
+			return {
+				async addProjectToGraph() {
+					const fakeCoreProject = await Specification.create({
+						id: "@openui5/sap.ui.core",
+						version: "1.100.0",
+						modulePath: libraryEPath,
+						configuration: {
+							specVersion: "3.0",
+							kind: "project",
+							type: "library",
+							metadata: {
+								name: "sap.ui.core"
+							}
+						}
+					});
+					graph.addProject(fakeCoreProject);
+				}
+			};
+		});
+
+	const provider = new DependencyTreeProvider({dependencyTree});
+	const projectGraph = await projectGraphBuilder(provider);
+
+	await t.throwsAsync(ui5Framework.enrichProjectGraph(projectGraph), {
+		message: `Duplicate framework library definition(s) found in project application.a: sap.ui.core. ` +
+		`Framework libraries should only be referenced via ui5.yaml configuration, not in its ` +
+		`dependencies (e.g. package.json). Note that this error could also come from transitive dependencies.`
+	});
+});
+
 test.serial("utils.shouldIncludeDependency", (t) => {
 	const {utils} = t.context;
 	// root project dependency should always be included
@@ -963,6 +1044,64 @@ test.serial("utils.declareFrameworkDependenciesInGraph: No deprecation warnings
 	], `Root project has correct dependencies`);
 });
 
+test("utils.checkForDuplicateFrameworkProjects: No duplicates", (t) => {
+	const {utils, sinon} = t.context;
+
+	const projectGraph = {
+		getRoot: sinon.stub().returns({
+			getName: sinon.stub().returns("root-project")
+		}),
+		getProjectNames: sinon.stub().returns(["lib1", "lib2", "lib3"])
+	};
+	const frameworkGraph = {
+		getProjectNames: sinon.stub().returns(["sap.ui.core"])
+	};
+
+	t.notThrows(() => utils.checkForDuplicateFrameworkProjects(projectGraph, frameworkGraph));
+});
+
+test("utils.checkForDuplicateFrameworkProjects: One duplicate", (t) => {
+	const {utils, sinon} = t.context;
+
+	const projectGraph = {
+		getRoot: sinon.stub().returns({
+			getName: sinon.stub().returns("root-project")
+		}),
+		getProjectNames: sinon.stub().returns(["lib1", "sap.ui.core", "lib2", "lib3"])
+	};
+	const frameworkGraph = {
+		getProjectNames: sinon.stub().returns(["sap.ui.core"])
+	};
+
+	t.throws(() => utils.checkForDuplicateFrameworkProjects(projectGraph, frameworkGraph), {
+		message: "Duplicate framework library definition(s) found in project root-project: " +
+			"sap.ui.core. " +
+			"Framework libraries should only be referenced via ui5.yaml configuration, not in its dependencies " +
+			"(e.g. package.json). Note that this error could also come from transitive dependencies."
+	});
+});
+
+test("utils.checkForDuplicateFrameworkProjects: Two duplicates", (t) => {
+	const {utils, sinon} = t.context;
+
+	const projectGraph = {
+		getRoot: sinon.stub().returns({
+			getName: sinon.stub().returns("root-project")
+		}),
+		getProjectNames: sinon.stub().returns(["lib1", "sap.ui.core", "lib2", "sap.ui.layout", "lib3"])
+	};
+	const frameworkGraph = {
+		getProjectNames: sinon.stub().returns(["sap.ui.core", "sap.ui.layout", "sap.m"])
+	};
+
+	t.throws(() => utils.checkForDuplicateFrameworkProjects(projectGraph, frameworkGraph), {
+		message: "Duplicate framework library definition(s) found in project root-project: " +
+			"sap.ui.core, sap.ui.layout. " +
+			"Framework libraries should only be referenced via ui5.yaml configuration, not in its dependencies " +
+			"(e.g. package.json). Note that this error could also come from transitive dependencies."
+	});
+});
+
 test.serial("ProjectProcessor: Add project to graph", async (t) => {
 	const {sinon} = t.context;
 	const {ProjectProcessor} = t.context.utils;