[INTERNAL] Adopt ui5-project changes

Author: RandomByte

lib/lbt/resources/LocatorResource.js

@@ -11,7 +11,7 @@ class LocatorResource extends Resource {
 	}
 
 	getProject() {
-		return this.resource._project;
+		return this.resource.getProject();
 	}
 
 	getPath() {

lib/lbt/utils/escapePropertiesFile.js

@@ -12,13 +12,10 @@ const nonAsciiEscaper = require("../../processors/nonAsciiEscaper");
  */
 module.exports = async function(resource) {
 	const project = resource.getProject();
-	let propertiesFileSourceEncoding = project &&
-			project.resources &&
-			project.resources.configuration &&
-			project.resources.configuration.propertiesFileSourceEncoding;
+	let propertiesFileSourceEncoding = project.getPropertiesFileSourceEncoding();
 
 	if (!propertiesFileSourceEncoding) {
-		if (project && ["0.1", "1.0", "1.1"].includes(project.specVersion)) {
+		if (project && ["0.1", "1.0", "1.1"].includes(project.getSpecVersion())) {
 			// default encoding to "ISO-8859-1" for old specVersions
 			propertiesFileSourceEncoding = "ISO-8859-1";
 		} else {

lib/processors/bundlers/moduleBundler.js

@@ -148,7 +148,6 @@ module.exports = function({resources, options: {bundleDefinition, bundleOptions,
 		log.verbose(`bundleDefinition: ${JSON.stringify(bundleDefinition, null, 2)}`);
 		log.verbose(`bundleOptions: ${JSON.stringify(bundleOptions, null, 2)}`);
 	}
-
 	return pool.prepare( resources, moduleNameMapping ).
 		then( () => builder.createBundle(bundleDefinition, bundleOptions) ).
 		then( (results) => {

lib/processors/manifestCreator.js

@@ -157,7 +157,9 @@ class LibraryBundle {
 /*
  * Creates the library manifest.json file for a UILibrary.
  */
-async function createManifest(libraryResource, libBundle, descriptorVersion, _include3rdParty, omitMinVersions) {
+async function createManifest(
+	libraryResource, libBundle, descriptorVersion, _include3rdParty, omitMinVersions, getProjectVersion
+) {
 	// create a Library wrapper around the .library XML
 	const library = await Library.from(libraryResource);
 
@@ -223,13 +225,6 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 			return version && version !== "@version@" && version !== "${version}";
 		}
 
-		function getProjectVersion() {
-			const project = libraryResource._project;
-			if ( project ) {
-				return project.version;
-			}
-		}
-
 		function getLibraryTitle() {
 			if ( library.getTitle() ) {
 				return library.getTitle();
@@ -321,7 +316,7 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 			embeds: findEmbeddedComponents(),
 			i18n,
 			applicationVersion: {
-				version: isValid(library.getVersion()) ? library.getVersion() : getProjectVersion()
+				version: isValid(library.getVersion()) ? library.getVersion() : getProjectVersion(library.getName())
 			},
 			title: getLibraryTitle(),
 			description: library.getDocumentation(),
@@ -398,7 +393,7 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 					_: "sap.ui.core"
 				}]
 			});
-			return normalizeVersion(getVersion(dummy));
+			return normalizeVersion(getProjectVersion(dummy.getLibraryName()));
 		}
 
 		function dependencies() {
@@ -410,7 +405,7 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 			if ( library.getDependencies() != null ) {
 				for (const dep of library.getDependencies()) {
 					dependencies.libs[dep.getLibraryName()] = {
-						minVersion: omitMinVersions ? "" : getVersion(dep),
+						minVersion: omitMinVersions ? "" : getProjectVersion(dep.getLibraryName()),
 						lazy: dep.isLazy() || undefined // suppress default (false)
 					};
 				}
@@ -619,33 +614,6 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 		return v.major + "." + v.minor;
 	}
 
-	function getVersion(dependency) {
-		const version = dependency.getVersion();
-		if ( version != null ) {
-			return version;
-		}
-
-		function hasName(entity) {
-			return entity.metadata && entity.metadata.name === dependency.getLibraryName();
-		}
-
-		const project = libraryResource._project;
-		if ( project ) {
-			if ( Array.isArray(project.dependencies) ) {
-				const lib = project.dependencies.find(hasName);
-				if ( lib ) {
-					return lib.version;
-				}
-			}
-			if ( hasName(project) ) {
-				return project.version;
-			}
-		}
-
-		throw new Error(
-			`Couldn't find version for library '${dependency.getLibraryName()}', project dependency missing?`);
-	}
-
 	return {
 		"_version": descriptorVersion.toString(),
 		"sap.app": createSapApp(),
@@ -657,7 +625,7 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 	};
 }
 
-module.exports = function({libraryResource, resources, options}) {
+module.exports = function({libraryResource, resources, getProjectVersion, options}) {
 	// merge options with defaults
 	options = Object.assign({
 		descriptorVersion: APP_DESCRIPTOR_V22, // TODO 3.0: change this to type string instead of a semver object
@@ -677,7 +645,7 @@ module.exports = function({libraryResource, resources, options}) {
 	}
 
 	return createManifest(libraryResource, libBundle, options.descriptorVersion, options.include3rdParty,
-		options.omitMinVersions)
+		options.omitMinVersions, getProjectVersion)
 		.then((manifest) => {
 			return new EvoResource({
 				path: resourcePathPrefix + "manifest.json",

lib/tasks/TaskUtil.js

@@ -136,6 +136,18 @@ class TaskUtil {
 		return this._projectBuildContext.registerCleanupTask(callback);
 	}
 
+	/**
+	 * Retrieve a single project from the dependency graph
+	 *
+	 * @param {string} projectName Name of the project to retrieve
+	 * @returns {module:@ui5/project.specifications.Project|undefined}
+	 *					project instance or undefined if the project is unknown to the graph
+	 * @public
+	 */
+	getProject(projectName) {
+		return this._projectBuildContext.getProject(projectName);
+	}
+
 	/**
 	 * Get an interface to an instance of this class that only provides those functions
 	 * that are supported by the given custom task extension specification version.

lib/tasks/bundlers/generateLibraryPreload.js

@@ -266,17 +266,17 @@ function getSapUiCoreBunDef(name, filters, preload) {
  * @param {object} parameters Parameters
  * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
  * @param {module:@ui5/builder.tasks.TaskUtil|object} [parameters.taskUtil] TaskUtil
+ * @param {object} parameters.options Options
+ * @param {module:@ui5/project.specifications.Project} parameters.options.project
  * @param {string[]} [parameters.options.excludes=[]] List of modules declared as glob patterns (resource name patterns)
  * that should be excluded from the library-preload.js bundle.
  * A pattern ending with a slash '/' will, similarly to the use of a single '*' or double '**' asterisk,
  * denote an arbitrary number of characters or folder names.
  * Re-includes should be marked with a leading exclamation mark '!'. The order of filters is relevant; a later
  * inclusion overrides an earlier exclusion, and vice versa.
- * @param {object} parameters.options Options
- * @param {string} parameters.options.projectName Project name
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = function({workspace, taskUtil, options: {projectName, excludes = []}}) {
+module.exports = function({workspace, taskUtil, options: {excludes = []}}) {
 	let nonDbgWorkspace = workspace;
 	if (taskUtil) {
 		nonDbgWorkspace = workspace.filter(function(resource) {
@@ -289,18 +289,17 @@ module.exports = function({workspace, taskUtil, options: {projectName, excludes
 		// Find all libraries and create a library-preload.js bundle
 
 		let p = Promise.resolve();
+		const project = taskUtil.getProject();
 
 		// Create core bundles for older versions (<1.97.0) which don't define bundle configuration in the ui5.yaml
 		// See: https://github.com/SAP/openui5/commit/ff127fd2d009162ea43ad312dec99d759ebc23a0
-		if (projectName === "sap.ui.core") {
-			const coreProject = resources[0]._project;
-			const coreSpecVersion = coreProject && coreProject.specVersion;
+		if (project.getName() === "sap.ui.core") {
 			// Instead of checking the sap.ui.core library version, the specVersion is checked against all versions
 			// that have been defined for sap.ui.core before the bundle configuration has been introduced.
 			// This is mainly to have an easier check without version parsing or using semver.
 			// If no project/specVersion is available, the bundles should also be created to not break potential
 			// existing use cases without a properly formed/formatted project tree.
-			if (!coreSpecVersion || ["0.1", "1.1", "2.0"].includes(coreSpecVersion)) {
+			if (["0.1", "1.1", "2.0"].includes(project.getSpecVersion())) {
 				const isEvo = resources.find((resource) => {
 					return resource.getPath() === "/resources/ui5loader.js";
 				});
@@ -378,14 +377,15 @@ module.exports = function({workspace, taskUtil, options: {projectName, excludes
 				} else {
 					// Fallback to "library.js" as library indicator
 					log.verbose(
-						`Could not find a ".library" file for project ${projectName}, falling back to "library.js".`);
+						`Could not find a ".library" file for project ${project.getName()}, ` +
+						`falling back to "library.js".`);
 					return workspace.byGlob("/resources/**/library.js");
 				}
 			}).then((libraryIndicatorResources) => {
 				if (libraryIndicatorResources.length < 1) {
 					// No library found - nothing to do
 					log.verbose(
-						`Could not find a ".library" or "library.js" file for project ${projectName}. ` +
+						`Could not find a ".library" or "library.js" file for project ${project.getName()}. ` +
 						`Skipping library preload bundling.`);
 					return;
 				}
@@ -425,7 +425,7 @@ module.exports = function({workspace, taskUtil, options: {projectName, excludes
 					} else {
 						log.verbose(
 							`Could not determine library namespace from file "${libraryIndicatorPath}" ` +
-							`for project ${projectName}. Skipping library preload bundling.`);
+							`for project ${project.getName()}. Skipping library preload bundling.`);
 						return Promise.resolve();
 					}
 				}));

lib/tasks/generateLibraryManifest.js

@@ -11,11 +11,12 @@ const manifestCreator = require("../processors/manifestCreator");
  * @alias module:@ui5/builder.tasks.generateLibraryManifest
  * @param {object} parameters Parameters
  * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
+ * @param {module:@ui5/builder.tasks.TaskUtil|object} [parameters.taskUtil] TaskUtil
  * @param {object} parameters.options Options
  * @param {string} parameters.options.projectName Project name
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = function({workspace, options: {projectName}}) {
+module.exports = function({workspace, taskUtil, options: {projectName}}) {
 	// Note:
 	// *.library files are needed to identify libraries
 	// *.json files are needed to avoid overwriting them
@@ -45,6 +46,9 @@ module.exports = function({workspace, options: {projectName}}) {
 						libraryResource: libraryIndicatorResource,
 						namespace: libraryNamespace,
 						resources,
+						getProjectVersion: (projectName) => {
+							return taskUtil.getProject(projectName)?.getVersion();
+						},
 						options: {
 						}
 					}).then((manifest) => {

lib/tasks/generateVersionInfo.js

@@ -19,7 +19,7 @@ module.exports = async ({workspace, dependencies, options: {rootProject, pattern
 	const resources = await dependencies.byGlob(pattern);
 
 	const libraryInfosPromises = resources.map((dotLibResource) => {
-		const namespace = dotLibResource._project.metadata.namespace;
+		const namespace = dotLibResource.getProject().getNamespace();
 		// pass all required resources to the processor
 		// the processor will then filter
 		return dependencies.byGlob(`/resources/${namespace}/**/${MANIFEST_JSON}`).then((manifestResources) => {
@@ -31,17 +31,17 @@ module.exports = async ({workspace, dependencies, options: {rootProject, pattern
 			return {
 				libraryManifest,
 				embeddedManifests,
-				name: dotLibResource._project.metadata.name,
-				version: dotLibResource._project.version
+				name: dotLibResource.getProject().getName(),
+				version: dotLibResource.getProject().getVersion()
 			};
 		});
 	});
 	const libraryInfos = await Promise.all(libraryInfosPromises);
 
 	const [versionInfoResource] = await versionInfoGenerator({
 		options: {
-			rootProjectName: rootProject.metadata.name,
-			rootProjectVersion: rootProject.version,
+			rootProjectName: rootProject.getName(),
+			rootProjectVersion: rootProject.getVersion(),
 			libraryInfos
 		}
 	});