@ui5/builder 3.0.0-alpha.5 → 3.0.0-alpha.6

package/CHANGELOG.md

@@ -2,7 +2,14 @@
 All notable changes to this project will be documented in this file.  
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-A list of unreleased changes can be found [here](https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.5...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.6...HEAD).
+
+<a name="v3.0.0-alpha.6"></a>
+## [v3.0.0-alpha.6] - 2022-04-26
+### Bug Fixes
+- **JSModuleAnalyzer:** Fix detection of bundle name ([#705](https://github.com/SAP/ui5-builder/issues/705)) [`aaeafd4`](https://github.com/SAP/ui5-builder/commit/aaeafd4a1fd194dd08e5ae47c29d90f0b4c7d197)
+- **generateResourcesJson:** Add raw-module info for debug bundles ([#736](https://github.com/SAP/ui5-builder/issues/736)) [`3b918e8`](https://github.com/SAP/ui5-builder/commit/3b918e83bfd38342778ecd4c58e648e99ad7cffc)
+
 
 <a name="v3.0.0-alpha.5"></a>
 ## [v3.0.0-alpha.5] - 2022-04-14
@@ -714,6 +721,7 @@ to load the custom bundle file instead.
 - Add ability to configure component preloads and custom bundles [`2241e5f`](https://github.com/SAP/ui5-builder/commit/2241e5ff98fd95f1f80cc74959655ae7a9c660e7)
 
 
+[v3.0.0-alpha.6]: https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.5...v3.0.0-alpha.6
 [v3.0.0-alpha.5]: https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.4...v3.0.0-alpha.5
 [v3.0.0-alpha.4]: https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.3...v3.0.0-alpha.4
 [v3.0.0-alpha.3]: https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.2...v3.0.0-alpha.3

package/lib/lbt/analyzer/JSModuleAnalyzer.js

@@ -301,6 +301,9 @@ class JSModuleAnalyzer {
 		 */
 		let bIsUi5Module = false;
 
+		// Module name via @ui5-bundle comment in first line. Overrides all other main module candidates.
+		let firstLineBundleName;
+
 		// first analyze the whole AST...
 		visit(ast, false);
 
@@ -314,7 +317,12 @@ class JSModuleAnalyzer {
 						log.verbose(`bundle include directive ${subModule}`);
 					} else if ( comment.value.startsWith("@ui5-bundle ") ) {
 						const bundleName = comment.value.slice("@ui5-bundle ".length);
-						setMainModuleInfo(bundleName, null);
+						if (comment.start === 0) {
+							// Remember the name from the first line to use it as final name
+							firstLineBundleName = bundleName;
+						} else {
+							setMainModuleInfo(bundleName, null);
+						}
 						log.verbose(`bundle name directive ${bundleName}`);
 					} else {
 						log.warn(`unrecognized bundle directive ${comment.value}`);
@@ -324,7 +332,10 @@ class JSModuleAnalyzer {
 		}
 
 		// ...and finally take conclusions about the file's content
-		if ( !mainModuleFound ) {
+		if ( firstLineBundleName ) {
+			// If the first line has a bundle name, use it and override all other found names
+			info.name = firstLineBundleName;
+		} else if ( !mainModuleFound ) {
 			// if there's exactly one module definition in this file but it didn't
 			// immediately qualify as main module, make it now the main module
 			if ( candidateName != null && nModuleDeclarations == 1 ) {

package/lib/lbt/resources/ResourceCollector.js

@@ -110,10 +110,11 @@ class ResourceCollector {
 	}
 
 	async enrichWithDependencyInfo(resourceInfo) {
-		return this._pool.getModuleInfo(resourceInfo.name).then(async (moduleInfo) => {
-			if ( moduleInfo.name ) {
+		return this._pool.getModuleInfo(resourceInfo.name, resourceInfo.module).then(async (moduleInfo) => {
+			if ( !resourceInfo.module && moduleInfo.name ) {
 				resourceInfo.module = moduleInfo.name;
 			}
+
 			if ( moduleInfo.dynamicDependencies ) {
 				resourceInfo.dynRequired = true;
 			}
@@ -279,37 +280,43 @@ class ResourceCollector {
 
 		await Promise.all(promises);
 
-		const debugBundlePromises = [];
-
-		for (let i = debugResourcesInfo.length - 1; i >= 0; i--) {
-			const dbgInfo = debugResourcesInfo[i];
-			const nonDebugName = ResourceInfoList.getNonDebugName(dbgInfo.name);
+		await Promise.all(debugResourcesInfo.map(async (dbgInfo) => {
+			const debugName = dbgInfo.name;
+			const nonDebugName = ResourceInfoList.getNonDebugName(debugName);
 			const nonDbgInfo = this._resources.get(nonDebugName);
 
 			// FIXME: "merged" property is only calculated in ResourceInfo#copyFrom
 			// Therefore using the same logic here to compute it.
+
+			// TODO: Idea: Use IsDebugVariant tag to decide whether to analyze the resource
+			// If the tag is set, we don't expect different analysis results so we can copy the info (else-path)
+			// Only when the tag is not set, we analyze the resource with its name (incl. -dbg)
+
 			if (!nonDbgInfo || (nonDbgInfo.included != null && nonDbgInfo.included.size > 0)) {
 				// We need to analyze the dbg resource if there is no non-dbg variant or
 				// it is a bundle because we will (usually) have different content.
-				debugBundlePromises.push(
-					this.enrichWithDependencyInfo(dbgInfo)
-				);
+
+				if (nonDbgInfo) {
+					// Always use the non-debug module name, if available
+					dbgInfo.module = nonDbgInfo.module;
+				}
+				await this.enrichWithDependencyInfo(dbgInfo);
 			} else {
 				// If the non-dbg resource is not a bundle, we can just copy over the info and skip
 				// analyzing the dbg variant as both should have the same info.
 
-				const newDbgInfo = new ResourceInfo(dbgInfo.name);
+				const newDbgInfo = new ResourceInfo(debugName);
 
 				// First copy info of analysis from non-dbg file (included, required, condRequired, ...)
 				newDbgInfo.copyFrom(null, nonDbgInfo);
 				// Then copy over info from dbg file to properly set name, isDebug, etc.
 				newDbgInfo.copyFrom(null, dbgInfo);
+				// Finally, set the module name to the non-dbg name
+				newDbgInfo.module = nonDbgInfo.module;
 
-				this._resources.set(dbgInfo.name, newDbgInfo);
+				this._resources.set(debugName, newDbgInfo);
 			}
-		}
-
-		await Promise.all(debugBundlePromises);
+		}));
 	}
 
 	createOrphanFilters() {

package/lib/lbt/resources/ResourceInfoList.js

@@ -48,7 +48,6 @@ class ResourceInfoList {
 		if ( myInfo == null ) {
 			myInfo = new ResourceInfo(relativeName);
 			myInfo.size = info.size;
-			myInfo.module = ResourceInfoList.getNonDebugName(info.name);
 			this.resources.push(myInfo);
 			this.resourcesByName.set(relativeName, myInfo);
 		}

package/lib/lbt/resources/ResourcePool.js

@@ -176,17 +176,18 @@ class ResourcePool {
 	/**
 	 * Retrieves the module info
 	 *
-	 * @param {string} name module name
+	 * @param {string} resourceName resource/module name
+	 * @param {string} [moduleName] module name, in case it differs from the resource name (e.g. for -dbg resources)
 	 * @returns {Promise<ModuleInfo>}
 	 */
-	async getModuleInfo(name) {
-		let info = this._dependencyInfos.get(name);
+	async getModuleInfo(resourceName, moduleName) {
+		let info = this._dependencyInfos.get(resourceName);
 		if ( info == null ) {
 			info = Promise.resolve().then(async () => {
-				const resource = await this.findResource(name);
-				return determineDependencyInfo( resource, this._rawModuleInfos.get(name), this );
+				const resource = await this.findResource(resourceName);
+				return determineDependencyInfo( resource, this._rawModuleInfos.get(moduleName || resourceName), this );
 			});
-			this._dependencyInfos.set(name, info);
+			this._dependencyInfos.set(resourceName, info);
 		}
 		return info;
 	}

package/lib/tasks/generateLibraryManifest.js

@@ -2,7 +2,6 @@
 
 const log = require("@ui5/logger").getLogger("builder:tasks:generateLibraryManifest");
 const manifestCreator = require("../processors/manifestCreator");
-const ReaderCollectionPrioritized = require("@ui5/fs").ReaderCollectionPrioritized;
 
 
 /**
@@ -12,23 +11,18 @@ const ReaderCollectionPrioritized = require("@ui5/fs").ReaderCollectionPrioritiz
  * @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/fs.AbstractReader} parameters.dependencies Reader or Collection to read dependency files
  * @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, dependencies, options: {projectName}}) {
-	const combo = new ReaderCollectionPrioritized({
-		name: `libraryManifestGenerator - prioritize workspace over dependencies: ${projectName}`,
-		readers: [workspace, dependencies]
-	});
+module.exports = function({workspace, options: {projectName}}) {
 	// Note:
 	// *.library files are needed to identify libraries
 	// *.json files are needed to avoid overwriting them
 	// *.js files are needed to identify nested components
 	// *.less, *.css, *.theming and *.theme files are needed to identify supported themes
 	// *.properties to identify existence of i18n bundles (e.g. messagebundle.properties)
-	return combo.byGlob("/**/*.{js,json,library,less,css,theming,theme,properties}").then((resources) => {
+	return workspace.byGlob("/resources/**/*.{js,json,library,less,css,theming,theme,properties}").then((resources) => {
 		// Find all libraries and create a manifest.json file
 		return workspace.byGlob("/resources/**/.library").then((libraryIndicatorResources) => {
 			if (libraryIndicatorResources.length < 1) {

package/lib/types/library/LibraryBuilder.js

@@ -112,7 +112,6 @@ class LibraryBuilder extends AbstractBuilder {
 		this.addTask("generateLibraryManifest", async () => {
 			return getTask("generateLibraryManifest").task({
 				workspace: resourceCollections.workspace,
-				dependencies: resourceCollections.dependencies,
 				taskUtil,
 				options: {
 					projectName: project.metadata.name

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/builder",
-	"version": "3.0.0-alpha.5",
+	"version": "3.0.0-alpha.6",
 	"description": "UI5 Tooling - Builder",
 	"author": {
 		"name": "SAP SE",
@@ -105,7 +105,7 @@
 		"url": "git@github.com:SAP/ui5-builder.git"
 	},
 	"dependencies": {
-		"@ui5/fs": "^3.0.0-alpha.2",
+		"@ui5/fs": "^3.0.0-alpha.3",
 		"@ui5/logger": "^3.0.1-alpha.1",
 		"cheerio": "1.0.0-rc.9",
 		"escape-unicode": "^0.2.0",