[INTERNAL][WIP] VersionInfo: with manifest infos

minor adjustments

Author: tobiasso85

lib/processors/versionInfoGenerator.js

@@ -1,4 +1,6 @@
+const log = require("@ui5/logger").getLogger("builder:processors:versionInfogenerator");
 const resourceFactory = require("@ui5/fs").resourceFactory;
+const path = require("path");
 
 function pad(v) {
 	return String(v).padStart(2, "0");
@@ -18,52 +20,66 @@ function getTimestamp() {
 /**
  *
  * @param {module:@ui5/fs.Resource} manifestResource
- * @returns {Promise<DependencyInfos>}
+ * @returns {Promise<ManifestInfos>}
  */
 const processManifest = async (manifestResource) => {
 	const manifestContent = await manifestResource.getString();
 	const manifestObject = JSON.parse(manifestContent);
-	// TODO extract manifestHints
-	const manifestDependencies = manifestObject["sap.ui5"]["dependencies"];
 	const result = {
 		embeds: [],
 		libs: {},
 		id: undefined
 	};
-	if (manifestDependencies) {
-		Object.keys(manifestDependencies.libs).forEach((libKey) => {
-			result.libs[libKey] = {};
-			if (manifestDependencies.libs[libKey].lazy) {
-				result.libs[libKey].lazy = true;
-			}
-		});
+
+	// sap.ui5/dependencies is used for the manifestHints
+	if (manifestObject["sap.ui5"]) {
+		const manifestDependencies = manifestObject["sap.ui5"]["dependencies"];
+		if (manifestDependencies) {
+			Object.keys(manifestDependencies.libs).forEach((libKey) => {
+				result.libs[libKey] = {};
+				if (manifestDependencies.libs[libKey].lazy) {
+					result.libs[libKey].lazy = true;
+				}
+			});
+		}
 	}
 
-	// there for components
-	const manifestEmbeds = manifestObject["sap.app"]["embeds"];
-	if (manifestEmbeds) {
-		result.embeds = manifestEmbeds;
+	// sap.app/embeds is required for "components" in sap-ui-version.json
+	if (manifestObject["sap.app"]) {
+		const manifestEmbeds = manifestObject["sap.app"]["embeds"];
+		if (manifestEmbeds) {
+			result.embeds = manifestEmbeds;
+		}
+		result.id = manifestObject["sap.app"]["id"];
 	}
-	result.id = manifestObject["sap.app"]["id"];
 	return result;
 };
 
+/**
+ * Library Info
+ *
+ * @typedef {object<string, object>} DependencyInfos
+ */
+
 /**
  * Manifest Hint
  *
- * @public
- * @typedef {object} DependencyInfos
- * @property {object} libs The library object
- * @property {string[]} embeds embedded components
- * @property {string} id id
+ * @typedef {object} ManifestInfos
+ * @property {DependencyInfos} libs The library object
+ * @property {string[]} embeds embedded components, e.g. "sub/fold" (only relative path)
+ * @property {string} id the app id, e.g. "lib.a"
  *
  *
  * @example
  * {
- *  sap.chart: {
- *      lazy: true
+ *  libs: {
+ *   sap.chart: {
+ *       lazy: true
+ *   },
+ *   sap.f: { },
  *  },
- *  sap.f: { },
+ *  id: "lib.a",
+ *  embeds: ["sub"]
  * }
  *
  */
@@ -72,7 +88,6 @@ const processManifest = async (manifestResource) => {
 /**
  * Library Info object
  *
- * @public
  * @typedef {object} LibraryInfo
  * @property {string} name The library name
  * @property {string} version The library version
@@ -82,21 +97,22 @@ const processManifest = async (manifestResource) => {
 
 const getManifestPath = (filePath, subPath) => {
 	if (filePath.endsWith("manifest.json")) {
-		return filePath.substr(0, filePath.length - "manifest.json".length) + subPath + "/manifest.json";
+		const folderPathOfManifest = filePath.substr(0, filePath.length - "manifest.json".length) + subPath;
+		return path.posix.resolve(folderPathOfManifest + "/manifest.json");
 	}
 	return filePath;
 };
 
 /**
  *
- * @param {Map<string, DependencyInfos>} manifestHints
+ * @param {Map<string, DependencyInfos>} libraryInfosMap
  */
-const resolveTransitiveDependencies = (manifestHints) => {
-	const keys = [...manifestHints.keys()];
+const resolveTransitiveDependencies = (libraryInfosMap) => {
+	const keys = [...libraryInfosMap.keys()];
 	keys.sort();
 	const resolvedCache = new Map();
 	keys.forEach((libName) => {
-		resolve(libName, manifestHints, resolvedCache);
+		resolve(libName, libraryInfosMap, resolvedCache);
 	});
 };
 
@@ -106,22 +122,22 @@ const clone = (obj) => {
 
 /**
  *
- * @param {Map<string, DependencyInfos>} manifestHints
+ * @param {Map<string, DependencyInfos>} libraryInfosMap
  * @param {string} libName
  * @param {object} newObject
  */
-const setManifestHints = (manifestHints, libName, newObject) => {
-	const existingEntry = manifestHints.get(libName);
-	const newLibs = merge(existingEntry && existingEntry, newObject);
-	manifestHints.set(libName, newLibs);
+const setManifestHints = (libraryInfosMap, libName, newObject) => {
+	const existingEntry = libraryInfosMap.get(libName);
+	const newLibs = merge(existingEntry, newObject);
+	libraryInfosMap.set(libName, newLibs);
 };
 
 const merge = (existingEntry, newObject) => {
 	const newLibs = clone(newObject);
 	if (existingEntry) {
 		Object.keys(existingEntry).forEach((libName) => {
 			if (!existingEntry[libName].lazy && newLibs[libName] && newLibs[libName].lazy) {
-				newLibs[libName] = {};
+				delete newLibs[libName].lazy;
 			}
 			if (!newLibs[libName]) {
 				newLibs[libName] = existingEntry[libName];
@@ -134,30 +150,29 @@ const merge = (existingEntry, newObject) => {
 /**
  *
  * @param {string} libName
- * @param {Map<string, DependencyInfos>} manifestHints
+ * @param {Map<string, DependencyInfos>} libraryInfosMap
  * @param {Map<string, DependencyInfos>} resolvedCache
  * @returns {DependencyInfos} resolved dependencies
  */
-const resolve = (libName, manifestHints, resolvedCache) => {
+const resolve = (libName, libraryInfosMap, resolvedCache) => {
 	// check cache first
 	if ( resolvedCache.has(libName)) {
 		return resolvedCache.get(libName);
 	}
-	const manifestHint = manifestHints.get(libName); // lib.c
-	// console.log(`:processing: ${libName}`);
+	const manifestHint = libraryInfosMap.get(libName);
 	let resolved = {};
 	if (!manifestHint) {
-		console.error(`no manifest information in dependencies for ${libName}`);
+		log.error(`no manifest information in dependencies for ${libName}`);
 		resolvedCache.set(libName, resolved);
 		return resolved;
 	}
-	const keys = Object.keys(manifestHint); // [lib.b]
+	const keys = Object.keys(manifestHint);
 	keys.forEach((childLibName) => {
-		const childResolved = resolve(childLibName, manifestHints, resolvedCache);
+		const childResolved = resolve(childLibName, libraryInfosMap, resolvedCache);
 		resolved = merge(resolved, childResolved);
 	});
 	resolved = merge(resolved, manifestHint);
-	setManifestHints(manifestHints, libName, resolved);
+	setManifestHints(libraryInfosMap, libName, resolved);
 	resolvedCache.set(libName, resolved);
 	return resolved;
 };
@@ -213,7 +228,7 @@ module.exports = async function({options}) {
 				return embeddedPaths.includes(manifestResource.getPath());
 			});
 
-			// get all embeds manifests
+			// get all embedded manifests
 			return Promise.all(relevantManifests.map((relevantManifest) => {
 				return processManifest(relevantManifest).then((result) => {
 					dependencyInfoMap.set(result.id, result.libs);
@@ -225,8 +240,6 @@ module.exports = async function({options}) {
 		});
 	});
 
-	// gather embeds' manifest and do the same
-
 	await Promise.all(librariesPromises);
 
 	// resolve nested dependencies (transitive)