[INTERNAL] SourceMaps follow-up

lib/lbt/resources/LocatorResource.js

@@ -1,9 +1,5 @@
 const Resource = require("./Resource");
 
-// function extractName(path) {
-// 	return path.slice( "/resources/".length);
-// }
-
 class LocatorResource extends Resource {
 	constructor(pool, resource, moduleName) {
 		super(pool, moduleName, null, resource.getStatInfo());

lib/processors/bundlers/moduleBundler.js

@@ -90,8 +90,7 @@ const log = require("@ui5/logger").getLogger("builder:processors:bundlers:module
  * @public
  * @typedef {object} ModuleBundleOptions
  * @property {boolean} [optimize=true] Whether the module bundle gets minified
- * @property {boolean} [sourceMap] Whether to generate a source map file for the bundle.
- *   Defaults to true if <code>optimize</code> is set to true
+ * @property {boolean} [sourceMap=true] Whether to generate a source map file for the bundle
  * @property {boolean} [decorateBootstrapModule=false] If set to 'false', the module won't be decorated
  *   with an optimization marker
  * @property {boolean} [addTryCatchRestartWrapper=false] Whether to wrap bootable module bundles with
@@ -124,12 +123,14 @@ const log = require("@ui5/logger").getLogger("builder:processors:bundlers:module
  				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/builder.processors.MinifierResult[]>} Promise resolving with module bundle resources
+ * @returns {Promise<module:@ui5/builder.processors.ModuleBundlerResult[]>}
+ * Promise resolving with module bundle resources
  */
 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,

lib/processors/minifier.js

@@ -34,12 +34,13 @@ const debugFileRegex = /((?:\.view|\.fragment|\.controller|\.designtime|\.suppor
  * @alias module:@ui5/builder.processors.minifier
  * @param {object} parameters Parameters
  * @param {module:@ui5/fs.Resource[]} parameters.resources List of resources to be processed
- * @param {boolean} [parameters.addSourceMappingUrl=true]
+ * @param {object} [parameters.options] Options
+ * @param {boolean} [parameters.options.addSourceMappingUrl=true]
  * 				Whether to add a sourceMappingURL reference to the end of the minified resource
  * @returns {Promise<module:@ui5/builder.processors.MinifierResult[]>}
  * 				Promise resolving with object of resource, dbgResource and sourceMap
  */
-module.exports = async function({resources, addSourceMappingUrl = true}) {
+module.exports = async function({resources, options: {addSourceMappingUrl = true} = {}}) {
 	return Promise.all(resources.map(async (resource) => {
 		const dbgPath = resource.getPath().replace(debugFileRegex, "-dbg$1");
 		const dbgResource = await resource.clone();

lib/tasks/bundlers/generateBundle.js

@@ -1,5 +1,5 @@
 const moduleBundler = require("../../processors/bundlers/moduleBundler");
-const ModuleName = require("../../lbt/utils/ModuleName");
+const createModuleNameMapping = require("./utils/createModuleNameMapping");
 const ReaderCollectionPrioritized = require("@ui5/fs").ReaderCollectionPrioritized;
 
 /**
@@ -21,7 +21,7 @@ module.exports = function({
 	workspace, dependencies, taskUtil, options: {projectName, bundleDefinition, bundleOptions}
 }) {
 	let combo = new ReaderCollectionPrioritized({
-		name: `libraryBundler - prioritize workspace over dependencies: ${projectName}`,
+		name: `generateBundle - prioritize workspace over dependencies: ${projectName}`,
 		readers: [workspace, dependencies]
 	});
 
@@ -82,34 +82,16 @@ module.exports = function({
 	}
 
 	return combo.byGlob("/resources/**/*.{js,json,xml,html,properties,library,js.map}").then((resources) => {
-		const moduleNameMapping = {};
+		const options = {bundleDefinition, bundleOptions};
 		if (!optimize && taskUtil) {
-			// For "unoptimized" bundles, the non-debug files have already been filtered out above.
-			// Now we need to create a mapping from the debug-variant resource path to the respective module name,
-			// which is basically the non-debug resource path, minus the "/resources/"" prefix.
-			// This mapping overwrites internal logic of the LocatorResourcePool which would otherwise determine
-			// the module name from the resource path, which would contain "-dbg" in this case. That would be
-			// incorrect since debug-variants should still keep the original module name.
-			for (let i = resources.length - 1; i >= 0; i--) {
-				const resourcePath = resources[i].getPath();
-				if (taskUtil.getTag(resourcePath, taskUtil.STANDARD_TAGS.IsDebugVariant)) {
-					const nonDbgPath = ModuleName.getNonDebugName(resourcePath);
-					if (!nonDbgPath) {
-						throw new Error(`Failed to resolve non-debug name for ${resourcePath}`);
-					}
-					moduleNameMapping[resourcePath] = nonDbgPath.slice("/resources/".length);
-				}
-			}
+			options.moduleNameMapping = createModuleNameMapping({resources, taskUtil});
 		}
-		return moduleBundler({
-			options: {
-				bundleDefinition,
-				bundleOptions,
-				moduleNameMapping
-			},
-			resources
-		}).then((bundles) => {
-			return Promise.all(bundles.map(({bundle, sourceMap}) => {
+		return moduleBundler({options, resources}).then((bundles) => {
+			return Promise.all(bundles.map(({bundle, sourceMap} = {}) => {
+				if (!bundle) {
+					// Skip empty bundles
+					return;
+				}
 				if (taskUtil) {
 					taskUtil.setTag(bundle, taskUtil.STANDARD_TAGS.IsBundle);
 					if (sourceMap) {

lib/tasks/bundlers/generateLibraryPreload.js

@@ -2,7 +2,7 @@ const log = require("@ui5/logger").getLogger("builder:tasks:bundlers:generateLib
 const moduleBundler = require("../../processors/bundlers/moduleBundler");
 const ReaderCollectionPrioritized = require("@ui5/fs").ReaderCollectionPrioritized;
 const {negateFilters} = require("../../lbt/resources/ResourceFilterList");
-const ModuleName = require("../../lbt/utils/ModuleName");
+const createModuleNameMapping = require("./utils/createModuleNameMapping");
 
 function getDefaultLibraryPreloadFilters(namespace, excludes) {
 	const filters = [
@@ -311,7 +311,7 @@ module.exports = function({workspace, dependencies, taskUtil, options: {projectN
 					return resource.getPath() === "/resources/ui5loader.js";
 				});
 
-				const unoptimizedModuleNameMapping = {};
+				let unoptimizedModuleNameMapping;
 				let unoptimizedResources = resources;
 				if (taskUtil) {
 					unoptimizedResources = await new ReaderCollectionPrioritized({
@@ -322,22 +322,10 @@ module.exports = function({workspace, dependencies, taskUtil, options: {projectN
 						return !taskUtil.getTag(resource, taskUtil.STANDARD_TAGS.HasDebugVariant);
 					}).byGlob("/**/*.{js,json,xml,html,properties,library,js.map}");
 
-					// For "unoptimized" bundles, the non-debug files have already been filtered out above.
-					// Now we need to create a mapping from the debug-variant resource path to the respective module
-					// name, which is basically the non-debug resource path, minus the "/resources/"" prefix.
-					// This mapping overwrites internal logic of the LocatorResourcePool which would otherwise determine
-					// the module name from the resource path, which would contain "-dbg" in this case. That would be
-					// incorrect since debug-variants should still keep the original module name.
-					for (let i = unoptimizedResources.length - 1; i >= 0; i--) {
-						const resourcePath = unoptimizedResources[i].getPath();
-						if (taskUtil.getTag(resourcePath, taskUtil.STANDARD_TAGS.IsDebugVariant)) {
-							const nonDbgPath = ModuleName.getNonDebugName(resourcePath);
-							if (!nonDbgPath) {
-								throw new Error(`Failed to resolve non-debug name for ${resourcePath}`);
-							}
-							unoptimizedModuleNameMapping[resourcePath] = nonDbgPath.slice("/resources/".length);
-						}
-					}
+					unoptimizedModuleNameMapping = createModuleNameMapping({
+						resources: unoptimizedResources,
+						taskUtil
+					});
 				}
 
 				let filters;

lib/tasks/bundlers/generateStandaloneAppBundle.js

@@ -1,7 +1,7 @@
 const log = require("@ui5/logger").getLogger("builder:tasks:bundlers:generateStandaloneAppBundle");
 const ReaderCollectionPrioritized = require("@ui5/fs").ReaderCollectionPrioritized;
 const moduleBundler = require("../../processors/bundlers/moduleBundler");
-const ModuleName = require("../../lbt/utils/ModuleName");
+const createModuleNameMapping = require("./utils/createModuleNameMapping");
 
 function getBundleDefinition(config) {
 	const bundleDefinition = {
@@ -101,7 +101,7 @@ module.exports = async function({workspace, dependencies, taskUtil, options: {pr
 		filters = ["jquery.sap.global.js"];
 	}
 
-	const unoptimizedModuleNameMapping = {};
+	let unoptimizedModuleNameMapping;
 	let unoptimizedResources = resources;
 	if (taskUtil) {
 		unoptimizedResources = await new ReaderCollectionPrioritized({
@@ -112,22 +112,10 @@ module.exports = async function({workspace, dependencies, taskUtil, options: {pr
 			return !taskUtil.getTag(resource, taskUtil.STANDARD_TAGS.HasDebugVariant);
 		}).byGlob("/resources/**/*.{js,json,xml,html,properties,library,js.map}");
 
-		// For "unoptimized" bundles, the non-debug files have already been filtered out above.
-		// Now we need to create a mapping from the debug-variant resource path to the respective module name,
-		// which is basically the non-debug resource path, minus the "/resources/"" prefix.
-		// This mapping overwrites internal logic of the LocatorResourcePool which would otherwise determine
-		// the module name from the resource path, which would contain "-dbg" in this case. That would be
-		// incorrect since debug-variants should still keep the original module name.
-		for (let i = unoptimizedResources.length - 1; i >= 0; i--) {
-			const resourcePath = unoptimizedResources[i].getPath();
-			if (taskUtil.getTag(resourcePath, taskUtil.STANDARD_TAGS.IsDebugVariant)) {
-				const nonDbgPath = ModuleName.getNonDebugName(resourcePath);
-				if (!nonDbgPath) {
-					throw new Error(`Failed to resolve non-debug name for ${resourcePath}`);
-				}
-				unoptimizedModuleNameMapping[resourcePath] = nonDbgPath.slice("/resources/".length);
-			}
-		}
+		unoptimizedModuleNameMapping = createModuleNameMapping({
+			resources: unoptimizedResources,
+			taskUtil
+		});
 	}
 
 	await Promise.all([

lib/tasks/bundlers/utils/createModuleNameMapping.js

@@ -0,0 +1,30 @@
+const ModuleName = require("../../../lbt/utils/ModuleName");
+
+/**
+ * For "unoptimized" bundles, the non-debug files have already been filtered out above.
+ * Now we need to create a mapping from the debug-variant resource path to the respective module
+ * name, which is basically the non-debug resource path, minus the "/resources/"" prefix.
+ * This mapping overwrites internal logic of the LocatorResourcePool which would otherwise determine
+ * the module name from the resource path, which would contain "-dbg" in this case. That would be
+ * incorrect since debug-variants should still keep the original module name.
+ *
+ * @private
+ * @param {object} parameters Parameters
+ * @param {module:@ui5/fs.Resource[]} parameters.resources List of resources
+ * @param {module:@ui5/builder.tasks.TaskUtil|object} parameters.taskUtil TaskUtil
+ * @returns {object} Module name mapping
+ */
+module.exports = function({resources, taskUtil}) {
+	const moduleNameMapping = {};
+	for (let i = resources.length - 1; i >= 0; i--) {
+		const resourcePath = resources[i].getPath();
+		if (taskUtil.getTag(resourcePath, taskUtil.STANDARD_TAGS.IsDebugVariant)) {
+			const nonDbgPath = ModuleName.getNonDebugName(resourcePath);
+			if (!nonDbgPath) {
+				throw new Error(`Failed to resolve non-debug name for ${resourcePath}`);
+			}
+			moduleNameMapping[resourcePath] = nonDbgPath.slice("/resources/".length);
+		}
+	}
+	return moduleNameMapping;
+};

lib/tasks/minify.js

@@ -18,7 +18,9 @@ module.exports = async function({workspace, taskUtil, options: {pattern, omitSou
 	const resources = await workspace.byGlob(pattern);
 	const processedResources = await minifier({
 		resources,
-		addSourceMappingUrl: !omitSourceMapResources
+		options: {
+			addSourceMappingUrl: !omitSourceMapResources
+		}
 	});
 
 	return Promise.all(processedResources.map(async ({resource, dbgResource, sourceMapResource}) => {

test/lib/processors/bundlers/moduleBundler.js

@@ -98,6 +98,7 @@ test.serial("Builder returns single bundle", async (t) => {
 	t.deepEqual(builder.createBundle.getCall(0).args[1], {
 		// default bundleOptions
 		optimize: true,
+		sourceMap: true,
 		decorateBootstrapModule: false,
 		addTryCatchRestartWrapper: false,
 		usePredefineCalls: false,
@@ -209,6 +210,7 @@ test.serial("Builder returns multiple bundles", async (t) => {
 	t.deepEqual(builder.createBundle.getCall(0).args[1], {
 		// default bundleOptions
 		optimize: true,
+		sourceMap: true,
 		decorateBootstrapModule: false,
 		addTryCatchRestartWrapper: false,
 		usePredefineCalls: false,
@@ -297,6 +299,7 @@ test.serial("bundleOptions default (no options passed)", async (t) => {
 	t.deepEqual(builder.createBundle.getCall(0).args[1], {
 		// default bundleOptions
 		optimize: true,
+		sourceMap: true,
 		decorateBootstrapModule: false,
 		addTryCatchRestartWrapper: false,
 		usePredefineCalls: false,
@@ -361,6 +364,7 @@ test.serial("bundleOptions default (empty options passed)", async (t) => {
 	t.deepEqual(builder.createBundle.getCall(0).args[1], {
 		// default bundleOptions
 		optimize: true,
+		sourceMap: true,
 		decorateBootstrapModule: false,
 		addTryCatchRestartWrapper: false,
 		usePredefineCalls: false,
@@ -383,6 +387,7 @@ test.serial("bundleOptions (all options passed)", async (t) => {
 	};
 	const bundleOptions = {
 		optimize: false,
+		sourceMap: false,
 		decorateBootstrapModule: true,
 		addTryCatchRestartWrapper: true,
 		usePredefineCalls: true,
@@ -440,6 +445,7 @@ test.serial("Passes ignoreMissingModules bundleOption to LocatorResourcePool", a
 	const effectiveBundleOptions = {
 		// Defaults
 		"optimize": true,
+		"sourceMap": true,
 		"decorateBootstrapModule": false,
 		"addTryCatchRestartWrapper": false,
 		"usePredefineCalls": false,
@@ -527,6 +533,7 @@ test.serial("Verbose Logging", async (t) => {
 	const effectiveBundleOptions = {
 		// Defaults
 		"optimize": true,
+		"sourceMap": true,
 		"decorateBootstrapModule": false,
 		"addTryCatchRestartWrapper": false,
 		"usePredefineCalls": false,