@ui5/builder 2.11.5 → 3.0.0-alpha.10

package/lib/lbt/bundle/BundleWriter.js

@@ -11,6 +11,8 @@ const SPACES_OR_TABS_ONLY = /^[ \t]+$/;
  *
  * Most methods have been extracted from JSMergeWriter.
  *
+ * columnOffset and lineOffset are used for sourcemap merging as reference to where we are at a given point in time
+ *
  * @author Frank Weigel
  * @since 1.27.0
  * @private
@@ -18,6 +20,8 @@ const SPACES_OR_TABS_ONLY = /^[ \t]+$/;
 class BundleWriter {
 	constructor() {
 		this.buf = "";
+		this.lineOffset = 0;
+		this.columnOffset = 0;
 		this.segments = [];
 		this.currentSegment = null;
 		this.currentSourceIndex = 0;
@@ -28,6 +32,11 @@ class BundleWriter {
 		let writeBuf = "";
 		for ( let i = 0; i < str.length; i++ ) {
 			writeBuf += str[i];
+			if (str[i] != null && str[i].split) {
+				const strSplit = str[i].split(NL);
+				this.lineOffset += strSplit.length - 1;
+				this.columnOffset += strSplit[strSplit.length - 1].length;
+			}
 		}
 		if ( writeBuf.length >= 1 ) {
 			this.buf += writeBuf;
@@ -40,15 +49,23 @@ class BundleWriter {
 	writeln(...str) {
 		for ( let i = 0; i < str.length; i++ ) {
 			this.buf += str[i];
+			if (str[i] != null && str[i].split) {
+				const strSplit = str[i].split(NL);
+				this.lineOffset += strSplit.length - 1;
+			}
 		}
 		this.buf += NL;
 		this.endsWithNewLine = true;
+		this.lineOffset += 1;
+		this.columnOffset = 0;
 	}
 
 	ensureNewLine() {
 		if ( !this.endsWithNewLine ) {
 			this.buf += NL;
 			this.endsWithNewLine = true;
+			this.lineOffset += 1;
+			this.columnOffset = 0;
 		}
 	}
 

package/lib/lbt/bundle/Resolver.js

@@ -289,15 +289,15 @@ class BundleResolver {
 
 				return collectModulesForSection(section).
 					then( (modules) => {
-						if ( section.mode == SectionType.Raw && section.sort ) {
+						if ( section.mode == SectionType.Raw && section.sort !== false ) {
 							// sort the modules in topological order
 							return topologicalSort(pool, modules).then( (modules) => {
-								log.verbose("      resolved modules (sorted): %s", modules);
+								log.silly("      resolved modules (sorted): %s", modules);
 								return modules;
 							});
 						}
 
-						log.verbose("      resolved modules: %s", modules);
+						log.silly("      resolved modules: %s", modules);
 						return modules;
 					}).then( function(modules) {
 						resolvedSection.modules = modules;

package/lib/lbt/resources/LocatorResource.js

@@ -1,14 +1,8 @@
 const Resource = require("./Resource");
 
-
-function extractName(path) {
-	return path.slice( "/resources/".length);
-}
-
-
 class LocatorResource extends Resource {
-	constructor(pool, resource) {
-		super(pool, extractName(resource.getPath()), null, resource.getStatInfo());
+	constructor(pool, resource, moduleName) {
+		super(pool, moduleName, null, resource.getStatInfo());
 		this.resource = resource;
 	}
 
@@ -17,7 +11,11 @@ class LocatorResource extends Resource {
 	}
 
 	getProject() {
-		return this.resource._project;
+		return this.resource.getProject();
+	}
+
+	getPath() {
+		return this.resource.getPath();
 	}
 }
 

package/lib/lbt/resources/LocatorResourcePool.js

@@ -2,12 +2,16 @@ const ResourcePool = require("./ResourcePool");
 const LocatorResource = require("./LocatorResource");
 
 class LocatorResourcePool extends ResourcePool {
-	prepare(resources) {
+	prepare(resources, moduleNameMapping) {
 		resources = resources.filter( (res) => !res.getStatInfo().isDirectory() );
 		return Promise.all(
-			resources.map(
-				(resource) => this.addResource( new LocatorResource(this, resource) )
-			).filter(Boolean)
+			resources.map((resource) => {
+				let moduleName = moduleNameMapping && moduleNameMapping[resource.getPath()];
+				if (!moduleName) {
+					moduleName = resource.getPath().slice("/resources/".length);
+				}
+				return this.addResource(new LocatorResource(this, resource, moduleName));
+			}).filter(Boolean)
 		);
 	}
 }

package/lib/lbt/resources/Resource.js

@@ -18,6 +18,13 @@ class Resource {
 	async buffer() {
 		return readFile(this.file);
 	}
+
+	/**
+	 * @returns {Promise<string>} String of the file content
+	 */
+	async string() {
+		return (await this.buffer()).toString();
+	}
 }
 
 module.exports = Resource;

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;
 			}
@@ -193,17 +194,16 @@ class ResourceCollector {
 	}
 
 	async determineResourceDetails({
-		debugResources, mergedResources, designtimeResources, supportResources, debugBundles
+		debugResources, mergedResources, designtimeResources, supportResources
 	}) {
 		const baseNames = new Set();
 		const debugFilter = new ResourceFilterList(debugResources);
 		const mergeFilter = new ResourceFilterList(mergedResources);
 		const designtimeFilter = new ResourceFilterList(designtimeResources);
 		const supportFilter = new ResourceFilterList(supportResources);
-		const debugBundleFilter = new ResourceFilterList(debugBundles);
 
 		const promises = [];
-		const nonBundledDebugResources = [];
+		const debugResourcesInfo = [];
 
 		for (const [name, info] of this._resources.entries()) {
 			if ( debugFilter.matches(name) ) {
@@ -231,13 +231,14 @@ class ResourceCollector {
 			}
 
 			if ( /(?:\.js|\.view\.xml|\.control\.xml|\.fragment\.xml)$/.test(name) ) {
-				if ( (!info.isDebug || debugBundleFilter.matches(name)) ) {
-					// Only analyze non-debug files and special debug bundles (like sap-ui-core-dbg.js)
+				if ( !info.isDebug ) {
+					// Only analyze non-dbg files in first run
 					promises.push(
 						this.enrichWithDependencyInfo(info)
 					);
 				} else {
-					nonBundledDebugResources.push(info);
+					// Collect dbg files to be handled in a second step (see below)
+					debugResourcesInfo.push(info);
 				}
 			}
 
@@ -279,19 +280,43 @@ class ResourceCollector {
 
 		await Promise.all(promises);
 
-		for (let i = nonBundledDebugResources.length - 1; i >= 0; i--) {
-			const dbgInfo = nonBundledDebugResources[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);
-			const newDbgInfo = new ResourceInfo(dbgInfo.name);
 
-			// 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);
+			// FIXME: "merged" property is only calculated in ResourceInfo#copyFrom
+			// Therefore using the same logic here to compute it.
 
-			this._resources.set(dbgInfo.name, newDbgInfo);
-		}
+			// 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.
+
+				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(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(debugName, newDbgInfo);
+			}
+		}));
 	}
 
 	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/lbt/utils/escapePropertiesFile.js

@@ -4,7 +4,7 @@ const nonAsciiEscaper = require("../../processors/nonAsciiEscaper");
  * Can be used to escape *.properties files.
  *
  * Input encoding is read from project configuration.
- * In case the resource belongs to no project (e.g. bundler is used standalone) the default is "ISO-8859-1".
+ * In case the resource belongs to no project (e.g. bundler is used standalone) the default is "UTF-8".
  *
  * @private
  * @param {Resource} resource the resource for which the content will be escaped
@@ -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 && 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 {

package/lib/lbt/utils/parseUtils.js

@@ -9,7 +9,7 @@ function parseJS(code, userOptions = {}) {
 	// allowed options and their defaults
 	const options = {
 		comment: false,
-		ecmaVersion: 2020,
+		ecmaVersion: 2021, // NOTE: Adopt JSModuleAnalyzer.js to allow new Syntax when upgrading to newer ECMA versions
 		range: false,
 		sourceType: "script",
 	};

package/lib/processors/bundlers/moduleBundler.js

@@ -89,10 +89,11 @@ const log = require("@ui5/logger").getLogger("builder:processors:bundlers:module
  *
  * @public
  * @typedef {object} ModuleBundleOptions
- * @property {boolean} [optimize=false] If set to 'true' the module bundle gets minified
- * @property {boolean} [decorateBootstrapModule=false] If set to 'false', the module won't be decorated
+ * @property {boolean} [optimize=true] Whether the module bundle gets minified
+ * @property {boolean} [sourceMap=true] Whether to generate a source map file for the bundle
+ * @property {boolean} [decorateBootstrapModule=false] If set to 'false', bootable bundles won't be decorated
  *   with an optimization marker
- * @property {boolean} [addTryCatchRestartWrapper=false] Whether to wrap bootable module bundles with
+ * @property {boolean} [addTryCatchRestartWrapper=false] Whether to wrap bootable bundles with
  *   a try/catch to filter out "Restart" errors
  * @property {boolean} [usePredefineCalls=false] If set to 'true', sap.ui.predefine is used for UI5 modules
  * @property {number} [numberOfParts=1] The number of parts the module bundle should be splitted
@@ -101,23 +102,41 @@ const log = require("@ui5/logger").getLogger("builder:processors:bundlers:module
  */
 
 /**
- * Legacy preload bundler.
+ * Result set
+ *
+ * @public
+ * @typedef {object} ModuleBundlerResult
+ * @property {module:@ui5/fs.Resource} bundle Bundle resource
+ * @property {module:@ui5/fs.Resource} sourceMap Source Map
+ * @memberof module:@ui5/builder.processors
+ */
+
+/**
+ * Legacy module bundler.
  *
  * @public
  * @alias module:@ui5/builder.processors.moduleBundler
  * @param {object} parameters Parameters
  * @param {module:@ui5/fs.Resource[]} parameters.resources Resources
  * @param {object} parameters.options Options
+ * @param {object} [parameters.options.moduleNameMapping]
+ 				Optional mapping of resource paths to module name in order to overwrite the default determination
  * @param {ModuleBundleDefinition} parameters.options.bundleDefinition Module bundle definition
- * @param {ModuleBundleOptions} parameters.options.bundleOptions Module bundle options
- * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving with module bundle resources
+ * @param {ModuleBundleOptions} [parameters.options.bundleOptions] Module bundle options
+ * @returns {Promise<module:@ui5/builder.processors.ModuleBundlerResult[]>}
+ * Promise resolving with module bundle resources
  */
-module.exports = function({resources, options: {bundleDefinition, bundleOptions}}) {
-//	console.log("preloadBundler bundleDefinition:");
-//	console.log(JSON.stringify(options.bundleDefinition, null, 4));
-
-	// TODO 3.0: Fix defaulting behavior, align with JSDoc
-	bundleOptions = bundleOptions || {optimize: true};
+module.exports = function({resources, options: {bundleDefinition, bundleOptions, moduleNameMapping}}) {
+	// Apply defaults without modifying the passed object
+	bundleOptions = Object.assign({}, {
+		optimize: true,
+		sourceMap: true,
+		decorateBootstrapModule: false,
+		addTryCatchRestartWrapper: false,
+		usePredefineCalls: false,
+		numberOfParts: 1,
+		ignoreMissingModules: false
+	}, bundleOptions);
 
 	const pool = new LocatorResourcePool({
 		ignoreMissingModules: bundleOptions.ignoreMissingModules
@@ -129,8 +148,7 @@ 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 ).
+	return pool.prepare( resources, moduleNameMapping ).
 		then( () => builder.createBundle(bundleDefinition, bundleOptions) ).
 		then( (results) => {
 			let bundles;
@@ -142,13 +160,20 @@ module.exports = function({resources, options: {bundleDefinition, bundleOptions}
 
 			return Promise.all(bundles.map((bundleObj) => {
 				if ( bundleObj ) {
-					const {name, content} = bundleObj;
+					const {name, content, sourceMap} = bundleObj;
 					// console.log("creating bundle as '%s'", "/resources/" + name);
-					const resource = new EvoResource({
+					const res = {};
+					res.bundle = new EvoResource({
 						path: "/resources/" + name,
 						string: content
 					});
-					return resource;
+					if (sourceMap) {
+						res.sourceMap = new EvoResource({
+							path: "/resources/" + name + ".map",
+							string: sourceMap
+						});
+					}
+					return res;
 				}
 			}));
 		});

package/lib/processors/jsdoc/lib/createIndexFiles.js

@@ -1,7 +1,7 @@
 /*
  * Node script to create cross-library API index files for use in the UI5 SDKs.
  *
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

package/lib/processors/jsdoc/lib/transformApiJson.js

@@ -1,7 +1,7 @@
 /*
  * Node script to preprocess api.json files for use in the UI5 SDKs.
  *
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -1154,7 +1154,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 		},
 
 		formatMethodCode: function (sName, aParams, aReturnValue) {
-			var result = '<pre class="prettyprint">' + sName + '(';
+			var result = '<pre>' + sName + '(';
 
 			if (aParams && aParams.length > 0) {
 				/* We consider only root level parameters so we get rid of all that are not on the root level */
@@ -1258,7 +1258,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 		 * @returns string - The code needed to create an object of that class
 		 */
 		formatConstructor: function (name, params) {
-			var result = '<pre class="prettyprint">new ';
+			var result = '<pre>new ';
 
 			if (name) {
 				result += name + '(';
@@ -1508,8 +1508,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 						name: oResult.static ? [self.name, oResult.name].join(".") : oResult.name,
 						type: "methods",
 						className: className,
-						text: text,
-						local: true
+						text: text
 					});
 				}
 			}
@@ -1549,7 +1548,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 		 * @param {string} [hrefAppend=""]
 		 * @returns {string} link
 		 */
-		createLink: function ({name, type, className, text=name, local=false, hrefAppend=""}) {
+		createLink: function ({name, type, className, text=name, hrefAppend=""}) {
 			let sLink;
 
 			// handling module's
@@ -1564,12 +1563,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 				sLink += hrefAppend;
 			}
 
-			if (local) {
-			  	let sScrollClass = "scrollTo" + type[0].toUpperCase() + type.slice(1, -1);
-				return `<a target="_self" class="jsdoclink ${sScrollClass}" data-target="${name}" href="api/${sLink}">${text}</a>`;
-			}
-
-			return `<a target="_self" class="jsdoclink" href="api/${sLink}">${text}</a>`;
+			return `<a target="_self" href="api/${sLink}">${text}</a>`;
 		},
 
 		/**
@@ -1597,7 +1591,7 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 						}
 
 						// topic:xxx Topic
-						aMatch = sTarget.match(/^topic:(\w{32})$/);
+						aMatch = sTarget.match(/^topic:(\w{32}(?:#\w*)?(?:\/\w*)?)$/);
 						if (aMatch) {
 							return '<a target="_self" href="topic/' + aMatch[1] + '">' + sText + '</a>';
 						}
@@ -1665,7 +1659,6 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 								name: aMatch[1] ? `${oSelf.name}.${aMatch[2]}` : aMatch[2],
 								type: "methods",
 								className: oSelf.name,
-								local: true,
 								text: sText
 							});
 						}
@@ -1677,7 +1670,6 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 								name: aMatch[1],
 								type: "annotations",
 								className: oSelf.name,
-								local: true,
 								text: sText
 							});
 						}
@@ -1704,7 +1696,6 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
 								name: aMatch[1],
 								type: "events",
 								className: oSelf.name,
-								local: true,
 								text: sText
 							});
 						}