[INTERNAL][WIP] VersionInfo: with manifest infos

improved components structure

Author: tobiasso85

lib/processors/versionInfoGenerator.js

@@ -27,7 +27,8 @@ const processManifest = async (manifestResource) => {
 	const manifestDependencies = manifestObject["sap.ui5"]["dependencies"];
 	const result = {
 		embeds: [],
-		libs: {}
+		libs: {},
+		id: undefined
 	};
 	if (manifestDependencies) {
 		Object.keys(manifestDependencies.libs).forEach((libKey) => {
@@ -91,19 +92,6 @@ const getManifestPath = (filePath, subPath) => {
  * @param {Map<string, DependencyInfos>} manifestHints
  */
 const resolveTransitiveDependencies = (manifestHints) => {
-	// top level libraries
-	//  // lib.a => lib.c, lib.b
-	// 	// lib.b => lib.d
-	// 	// lib.c => lib.e, lib.b (true)
-	// 	// lib.d => lib.e (true)
-	// 	// lib.e =>
-	// TODO optimize duplicate resolve (e.g. cache)
-
-	// lib.c => lib.e, lib.b (true), lib.d
-	// lib.a => lib.c, lib.b, lib.d, lib.e
-	// lib.b => lib.d, lib.e (true)
-	// lib.d => lib.e (true)
-	// lib.e =>
 	const keys = [...manifestHints.keys()];
 	keys.sort();
 	const resolvedCache = new Map();
@@ -125,7 +113,6 @@ const clone = (obj) => {
 const setManifestHints = (manifestHints, libName, newObject) => {
 	const existingEntry = manifestHints.get(libName);
 	const newLibs = merge(existingEntry && existingEntry, newObject);
-	console.log(`  setting ${libName} ==> ${Object.keys(newLibs).join(", ")}`);
 	manifestHints.set(libName, newLibs);
 };
 
@@ -152,20 +139,22 @@ const merge = (existingEntry, newObject) => {
  * @returns {DependencyInfos} resolved dependencies
  */
 const resolve = (libName, manifestHints, resolvedCache) => {
-	// lib.c get entries
-	// lib.c => lib.b (true)
-	// lib.b =>
+	// check cache first
 	if ( resolvedCache.has(libName)) {
 		return resolvedCache.get(libName);
 	}
 	const manifestHint = manifestHints.get(libName); // lib.c
-	console.log(`:processing: ${libName}`);
-	const keys = Object.keys(manifestHint); // [lib.b]
+	// console.log(`:processing: ${libName}`);
 	let resolved = {};
+	if (!manifestHint) {
+		console.error(`no manifest information in dependencies for ${libName}`);
+		resolvedCache.set(libName, resolved);
+		return resolved;
+	}
+	const keys = Object.keys(manifestHint); // [lib.b]
 	keys.forEach((childLibName) => {
 		const childResolved = resolve(childLibName, manifestHints, resolvedCache);
 		resolved = merge(resolved, childResolved);
-		console.log(`resolved ${childLibName} with ${Object.keys(resolved).join(", ")}`);
 	});
 	resolved = merge(resolved, manifestHint);
 	setManifestHints(manifestHints, libName, resolved);
@@ -174,16 +163,6 @@ const resolve = (libName, manifestHints, resolvedCache) => {
 };
 
 
-const out = (libs) => {
-	const res = Object.keys(libs).map((libName) => {
-		if (libs[libName].lazy) {
-			return libName + " (" + libs[libName].lazy + ")";
-		}
-		return libName;
-	});
-	return res;
-};
-
 /**
  * Creates sap-ui-version.json.
  *
@@ -204,7 +183,6 @@ module.exports = async function({options}) {
 	}
 
 	const buildTimestamp = getTimestamp();
-	// TODO filter manifest.json if sap/embeds (we expect it contains the correct information)
 
 	const components = {};
 	/**
@@ -229,11 +207,6 @@ module.exports = async function({options}) {
 			return manifestHint.embeds;
 		}).then((embeds) => {
 			// filter
-			embeds.forEach((embed) => {
-				embeddedInfoMap.set(embed, {
-					library: libraryInfo.name
-				});
-			});
 			const embeddedPaths = embeds.map((embed) => {
 				return getManifestPath(libraryInfo.mainManifest.getPath(), embed);
 			});
@@ -245,6 +218,9 @@ module.exports = async function({options}) {
 			return Promise.all(relevantManifests.map((relevantManifest) => {
 				return processManifest(relevantManifest).then((result) => {
 					dependencyInfoMap.set(result.id, result.libs);
+					embeddedInfoMap.set(result.id, {
+						library: libraryInfo.name
+					});
 				});
 			}));
 		});
@@ -254,19 +230,9 @@ module.exports = async function({options}) {
 
 	await Promise.all(librariesPromises);
 
-	console.log("before:");
-	dependencyInfoMap.forEach((manifestHint, key) => {
-		console.log(`${key} => ${out(manifestHint).join(", ")}`);
-	});
-
 	// resolve nested dependencies (transitive)
 	resolveTransitiveDependencies(dependencyInfoMap);
 
-	console.log("\nafter:");
-	dependencyInfoMap.forEach((manifestHint, key) => {
-		console.log(`${key} => ${out(manifestHint).join(", ")}`);
-	});
-
 
 	const libraries = options.libraryInfos.map((libraryInfo) => {
 		const result = {
@@ -277,7 +243,6 @@ module.exports = async function({options}) {
 		};
 
 		const libs = dependencyInfoMap.get(libraryInfo.name);
-		// TODO: sort the libs
 		if (Object.keys(libs).length) {
 			result.manifestHints = {
 				dependencies: {
@@ -290,9 +255,7 @@ module.exports = async function({options}) {
 
 	// TODO sort!
 	embeddedInfoMap.forEach((embeddedInfo, libName) => {
-		components[libName] = {
-			library: embeddedInfo.library
-		};
+		components[libName] = embeddedInfo;
 		const libs = dependencyInfoMap.get(libName);
 		if (libs && Object.keys(libs).length) {
 			components[libName].manifestHints = {
@@ -303,14 +266,11 @@ module.exports = async function({options}) {
 		}
 	});
 
-	// sort alphabetically
+	// sort libraries alphabetically
 	libraries.sort((a, b) => {
 		return a.name.localeCompare(b.name);
 	});
 
-
-	// TODO enrich components
-
 	const versionJson = {
 		name: options.rootProjectName,
 		version: options.rootProjectVersion, // TODO: insert current application version here

test/lib/tasks/generateVersionInfo.js

@@ -321,7 +321,7 @@ test("integration: Library without i18n bundle with manifest", async (t) => {
 		string: `
 			{
 				"sap.app": {
-					"embeds": []
+					"embeds": ["sub/fold"]
 				},
 				"sap.ui5": {
 				    "dependencies": {
@@ -341,6 +341,30 @@ test("integration: Library without i18n bundle with manifest", async (t) => {
 		project: createProjectMetadata(["lib", "a"])
 	}));
 
+	// sub
+	await dependencies.write(resourceFactory.createResource({
+		path: "/resources/lib/a/sub/fold/manifest.json",
+		string: `
+			{
+				"sap.app": {
+					"id": "lib.a.sub.fold",
+					"embeds": []
+				},
+				"sap.ui5": {
+				    "dependencies": {
+				      "minUI5Version": "1.84",
+				      "libs": {
+				        "lib.c": {
+				          "minVersion": "1.84.0"
+				        }
+				      }
+				    }
+				}
+			}
+		`,
+		project: createProjectMetadata(["lib", "a", "sub", "fold"])
+	}));
+
 	// lib.c
 	await dependencies.write(resourceFactory.createResource({
 		path: "/resources/lib/c/.library",
@@ -431,7 +455,21 @@ test("integration: Library without i18n bundle with manifest", async (t) => {
 		dependencies
 	};
 	await assertCreatedVersionInfo(t, {
-		"components": {},
+		"components": {
+			"lib.a.sub.fold": {
+				"library": "lib.a",
+				"manifestHints": {
+					"dependencies": {
+						"libs": {
+							"lib.b": {
+								"lazy": true
+							},
+							"lib.c": {}
+						}
+					}
+				}
+			}
+		},
 		"libraries": [{
 			"manifestHints": {
 				"dependencies": {
@@ -639,7 +677,7 @@ test("integration: Library without i18n bundle with manifest max", async (t) =>
 		string: `
 			{
 				"sap.app": {
-					"embeds": []
+					"embeds": ["sub"]
 				},
 				"sap.ui5": {
 				    "dependencies": {
@@ -659,6 +697,29 @@ test("integration: Library without i18n bundle with manifest max", async (t) =>
 		project: createProjectMetadata(["lib", "a"])
 	}));
 
+	await dependencies.write(resourceFactory.createResource({
+		path: "/resources/lib/a/sub/manifest.json",
+		string: `
+			{
+				"sap.app": {
+					"embeds": [],
+					"id": "lib.a.sub"
+				},
+				"sap.ui5": {
+				    "dependencies": {
+				      "minUI5Version": "1.84",
+				      "libs": {
+				        "lib.c": {
+				          "minVersion": "1.84.0"
+				        }
+				      }
+				    }
+				}
+			}
+		`,
+		project: createProjectMetadata(["lib", "a", "sub"])
+	}));
+
 	// lib.c
 	await dependencies.write(resourceFactory.createResource({
 		path: "/resources/lib/c/.library",
@@ -828,7 +889,23 @@ test("integration: Library without i18n bundle with manifest max", async (t) =>
 		dependencies
 	};
 	await assertCreatedVersionInfo(t, {
-		"components": {},
+		"components": {
+			"lib.a.sub": {
+				"library": "lib.a",
+				"manifestHints": {
+					"dependencies": {
+						"libs": {
+							"lib.b": {
+								"lazy": true
+							},
+							"lib.d": {},
+							"lib.c": {},
+							"lib.e": {}
+						}
+					}
+				}
+			}
+		},
 		"libraries": [{
 			"manifestHints": {
 				"dependencies": {