@ui5/builder 2.11.5 → 3.0.0-alpha.10

package/lib/processors/minifier.js

@@ -0,0 +1,90 @@
+const path = require("path");
+const terser = require("terser");
+const Resource = require("@ui5/fs").Resource;
+/**
+ * Preserve comments which contain:
+ * <ul>
+ *  <li>copyright notice</li>
+ *  <li>license terms</li>
+ *  <li>"@ui5-bundle"</li>
+ *  <li>"@ui5-bundle-raw-include"</li>
+ * </ul>
+ *
+ * @type {RegExp}
+ */
+const copyrightCommentsAndBundleCommentPattern = /copyright|\(c\)(?:[0-9]+|\s+[0-9A-za-z])|released under|license|\u00a9|^@ui5-bundle-raw-include |^@ui5-bundle /i;
+const debugFileRegex = /((?:\.view|\.fragment|\.controller|\.designtime|\.support)?\.js)$/;
+
+
+/**
+ * Result set
+ *
+ * @public
+ * @typedef {object} MinifierResult
+ * @property {module:@ui5/fs.Resource} resource Minified resource
+ * @property {module:@ui5/fs.Resource} dbgResource Debug (non-minified) variant
+ * @property {module:@ui5/fs.Resource} sourceMap Source Map
+ * @memberof module:@ui5/builder.processors
+ */
+
+/**
+ * Minifies the supplied resources.
+ *
+ * @public
+ * @alias module:@ui5/builder.processors.minifier
+ * @param {object} parameters Parameters
+ * @param {module:@ui5/fs.Resource[]} parameters.resources List of resources to be processed
+ * @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, options: {addSourceMappingUrl = true} = {}}) {
+	return Promise.all(resources.map(async (resource) => {
+		const dbgPath = resource.getPath().replace(debugFileRegex, "-dbg$1");
+		const dbgResource = await resource.clone();
+		dbgResource.setPath(dbgPath);
+
+		const filename = path.posix.basename(resource.getPath());
+		const code = await resource.getString();
+		try {
+			const sourceMapOptions = {
+				filename
+			};
+			if (addSourceMappingUrl) {
+				sourceMapOptions.url = filename + ".map";
+			}
+			const dbgFilename = path.posix.basename(dbgPath);
+			const result = await terser.minify({
+				// Use debug-name since this will be referenced in the source map "sources"
+				[dbgFilename]: code
+			}, {
+				output: {
+					comments: copyrightCommentsAndBundleCommentPattern,
+					wrap_func_args: false
+				},
+				compress: false,
+				mangle: {
+					reserved: [
+						"jQuery",
+						"jquery",
+						"sap",
+					]
+				},
+				sourceMap: sourceMapOptions
+			});
+			resource.setString(result.code);
+			const sourceMapResource = new Resource({
+				path: resource.getPath() + ".map",
+				string: result.map
+			});
+			return {resource, dbgResource, sourceMapResource};
+		} catch (err) {
+			// Note: err.filename contains the debug-name
+			throw new Error(
+				`Minification failed with error: ${err.message} in file ${filename} ` +
+				`(line ${err.line}, col ${err.col}, pos ${err.pos})`);
+		}
+	}));
+};

package/lib/processors/resourceListCreator.js

@@ -66,17 +66,6 @@ const DEFAULT_SUPPORT_RESOURCES_FILTER = [
 	"**/*.support.js"
 ];
 
-/**
- * Hard coded debug bundle, to trigger separate analysis for this filename
- * because sap-ui-core.js and sap-ui-core-dbg.js have different includes
- *
- * @type {string[]}
- */
-const DEBUG_BUNDLES = [
-	"sap-ui-core-dbg.js",
-	"sap-ui-core-nojQuery-dbg.js"
-];
-
 /**
  * Creates and adds resources.json entry (itself) to the list.
  *
@@ -138,8 +127,7 @@ module.exports = async function({resources, dependencyResources = [], options})
 		debugResources: DEFAULT_DEBUG_RESOURCES_FILTER,
 		mergedResources: DEFAULT_BUNDLE_RESOURCES_FILTER,
 		designtimeResources: DEFAULT_DESIGNTIME_RESOURCES_FILTER,
-		supportResources: DEFAULT_SUPPORT_RESOURCES_FILTER,
-		debugBundles: DEBUG_BUNDLES
+		supportResources: DEFAULT_SUPPORT_RESOURCES_FILTER
 	}, options);
 
 	const pool = new LocatorResourcePool();
@@ -158,12 +146,10 @@ module.exports = async function({resources, dependencyResources = [], options})
 	}
 
 	await collector.determineResourceDetails({
-		pool,
 		debugResources: options.debugResources,
 		mergedResources: options.mergedResources,
 		designtimeResources: options.designtimeResources,
-		supportResources: options.supportResources,
-		debugBundles: options.debugBundles
+		supportResources: options.supportResources
 	});
 
 	// group resources by components and create ResourceInfoLists

package/lib/tasks/buildThemes.js

@@ -97,7 +97,7 @@ module.exports = async function({
 
 		if (log.isLevelEnabled("verbose")) {
 			if (!libraryAvailable) {
-				log.verbose(`Skipping ${resourcePath}: Library is not available`);
+				log.silly(`Skipping ${resourcePath}: Library is not available`);
 			}
 			if (!themeAvailable) {
 				log.verbose(`Skipping ${resourcePath}: sap.ui.core theme '${themeName}' is not available. ` +

package/lib/tasks/bundlers/generateBundle.js

@@ -1,4 +1,5 @@
 const moduleBundler = require("../../processors/bundlers/moduleBundler");
+const createModuleNameMapping = require("./utils/createModuleNameMapping");
 const ReaderCollectionPrioritized = require("@ui5/fs").ReaderCollectionPrioritized;
 
 /**
@@ -9,34 +10,101 @@ const ReaderCollectionPrioritized = require("@ui5/fs").ReaderCollectionPrioritiz
  * @param {object} parameters Parameters
  * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
  * @param {module:@ui5/fs.ReaderCollection} parameters.dependencies Collection to read dependency files
- * @param {module:@ui5/builder.tasks.TaskUtil|object} [parameters.taskUtil] TaskUtil
+ * @param {module:@ui5/project.build.helpers.TaskUtil|object} [parameters.taskUtil] TaskUtil
  * @param {object} parameters.options Options
  * @param {string} parameters.options.projectName Project name
  * @param {ModuleBundleDefinition} parameters.options.bundleDefinition Module bundle definition
- * @param {ModuleBundleOptions} parameters.options.bundleOptions Module bundle options
+ * @param {ModuleBundleOptions} [parameters.options.bundleOptions] Module bundle options
  * @returns {Promise} Promise resolving with <code>undefined</code> once data has been written
  */
 module.exports = function({
 	workspace, dependencies, taskUtil, options: {projectName, bundleDefinition, bundleOptions}
 }) {
-	const combo = new ReaderCollectionPrioritized({
-		name: `libraryBundler - prioritize workspace over dependencies: ${projectName}`,
+	let combo = new ReaderCollectionPrioritized({
+		name: `generateBundle - prioritize workspace over dependencies: ${projectName}`,
 		readers: [workspace, dependencies]
 	});
 
-	return combo.byGlob("/resources/**/*.{js,json,xml,html,properties,library}").then((resources) => {
-		return moduleBundler({
-			options: {
-				bundleDefinition,
-				bundleOptions
-			},
-			resources
-		}).then((bundles) => {
-			return Promise.all(bundles.map((bundle) => {
+	const optimize = !bundleOptions || bundleOptions.optimize !== false;
+	if (taskUtil) {
+		/* Scenarios
+			1. Optimize bundle with minification already done
+				Workspace:
+					* /resources/my/lib/Control.js 				[ui5:HasDebugVariant]
+					* /resources/my/lib/Control.js.map 			[ui5:HasDebugVariant]
+					* /resources/my/lib/Control-dbg.js 			[ui5:IsDebugVariant]
+
+				Bundler input:
+					* /resources/my/lib/Control.js
+					* /resources/my/lib/Control.js.map
+
+				=> Filter out debug resources
+
+			2. Optimize bundle with no minification
+				* /resources/my/lib/Control.js
+
+				=> No action necessary
+
+			3. Debug-bundle with minification already done
+				Workspace:
+					* /resources/my/lib/Control.js 				[ui5:HasDebugVariant]
+					* /resources/my/lib/Control.js.map 			[ui5:HasDebugVariant]
+					* /resources/my/lib/Control-dbg.js 			[ui5:IsDebugVariant]
+
+				Bundler input:
+					* /resources/my/lib/Control-dbg.js
+					* moduleNameMapping: [{"/resources/my/lib/Control-dbg.js": "my/lib/Control.js"}]
+
+				=> Filter out minified-resources (tagged as "HasDebugVariant", incl. source maps) and rename debug-files
+
+			4. Debug-bundle with no minification
+				* /resources/my/lib/Control.js
+
+				=> No action necessary
+
+			5. Bundle with external input (optimize or not), e.g. TS-project
+				Workspace:
+					* /resources/my/lib/Control.ts
+					* /resources/my/lib/Control.js
+					* /resources/my/lib/Control.js.map
+
+				Bundler input:
+					* /resources/my/lib/Control.js
+					* /resources/my/lib/Control.js.map
+		*/
+
+		// Omit -dbg files for optimize bundles and vice versa
+		const filterTag = optimize ?
+			taskUtil.STANDARD_TAGS.IsDebugVariant : taskUtil.STANDARD_TAGS.HasDebugVariant;
+		combo = combo.filter(function(resource) {
+			return !taskUtil.getTag(resource, filterTag);
+		});
+	}
+
+	return combo.byGlob("/resources/**/*.{js,json,xml,html,properties,library,js.map}").then((resources) => {
+		const options = {bundleDefinition, bundleOptions};
+		if (!optimize && taskUtil) {
+			options.moduleNameMapping = createModuleNameMapping({resources, taskUtil});
+		}
+		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) {
+						// Clear tag that might have been set by the minify task, in cases where
+						// the bundle name is identical to a source file
+						taskUtil.clearTag(sourceMap, taskUtil.STANDARD_TAGS.OmitFromBuildResult);
+					}
+				}
+				const writes = [workspace.write(bundle)];
+				if (sourceMap) {
+					writes.push(workspace.write(sourceMap));
 				}
-				return workspace.write(bundle);
+				return Promise.all(writes);
 			}));
 		});
 	});

package/lib/tasks/bundlers/generateComponentPreload.js

@@ -1,7 +1,6 @@
 const path = require("path");
 const moduleBundler = require("../../processors/bundlers/moduleBundler");
 const log = require("@ui5/logger").getLogger("builder:tasks:bundlers:generateComponentPreload");
-const ReaderCollectionPrioritized = require("@ui5/fs").ReaderCollectionPrioritized;
 const {negateFilters} = require("../../lbt/resources/ResourceFilterList");
 
 /**
@@ -11,8 +10,7 @@ const {negateFilters} = require("../../lbt/resources/ResourceFilterList");
  * @alias module:@ui5/builder.tasks.generateComponentPreload
  * @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 {module:@ui5/builder.tasks.TaskUtil|object} [parameters.taskUtil] TaskUtil
+ * @param {module:@ui5/project.build.helpers.TaskUtil|object} [parameters.taskUtil] TaskUtil
  * @param {object} parameters.options Options
  * @param {string} parameters.options.projectName Project name
  * @param {string[]} [parameters.options.excludes=[]] List of modules declared as glob patterns (resource name patterns)
@@ -23,25 +21,28 @@ const {negateFilters} = require("../../lbt/resources/ResourceFilterList");
  * inclusion overrides an earlier exclusion, and vice versa.
  * @param {string[]} [parameters.options.paths] Array of paths (or glob patterns) for component files
  * @param {string[]} [parameters.options.namespaces] Array of component namespaces
+ * @param {string[]} [parameters.options.skipBundles] Names of bundles that should not be created
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
 module.exports = function({
-	workspace, dependencies, taskUtil, options: {projectName, paths, namespaces, excludes = []}
+	workspace, taskUtil, options: {projectName, paths, namespaces, skipBundles = [], excludes = []}
 }) {
-	const combo = new ReaderCollectionPrioritized({
-		name: `generateComponentPreload - prioritize workspace over dependencies: ${projectName}`,
-		readers: [workspace, dependencies]
-	});
+	let nonDbgWorkspace = workspace;
+	if (taskUtil) {
+		nonDbgWorkspace = workspace.filter(function(resource) {
+			// Remove any debug variants
+			return !taskUtil.getTag(resource, taskUtil.STANDARD_TAGS.IsDebugVariant);
+		});
+	}
 
-	// TODO 3.0: Limit to workspace resources?
-	return combo.byGlob("/resources/**/*.{js,json,xml,html,properties,library}")
+	return nonDbgWorkspace.byGlob("/resources/**/*.{js,json,xml,html,properties,library,js.map}")
 		.then(async (resources) => {
 			let allNamespaces = [];
 			if (paths) {
 				allNamespaces = await Promise.all(paths.map(async (componentPath) => {
 					const globPath = "/resources/" + componentPath;
 					log.verbose(`Globbing for Components directories with configured path ${globPath}...`);
-					const components = await combo.byGlob(globPath); // TODO 3.0: Limit to workspace resources?
+					const components = await nonDbgWorkspace.byGlob(globPath);
 					return components.map((component) => {
 						const compDir = path.dirname(component.getPath()).replace(/^\/resources\//i, "");
 						log.verbose(`Found component namespace ${compDir}`);
@@ -65,6 +66,12 @@ module.exports = function({
 			const unusedFilterExcludes = new Set(allFilterExcludes);
 
 			const bundleDefinitions = allNamespaces.map((namespace) => {
+				const bundleName = `${namespace}/Component-preload.js`;
+				if (skipBundles.includes(bundleName)) {
+					log.verbose(`Skipping generation of bundle ${bundleName}`);
+					return null;
+				}
+
 				const filters = [
 					`${namespace}/`,
 					`${namespace}/**/manifest.json`,
@@ -94,7 +101,7 @@ module.exports = function({
 				});
 
 				return {
-					name: `${namespace}/Component-preload.js`,
+					name: bundleName,
 					defaultFileTypes: [
 						".js",
 						".control.xml",
@@ -127,7 +134,7 @@ module.exports = function({
 				});
 			}
 
-			return Promise.all(bundleDefinitions.map((bundleDefinition) => {
+			return Promise.all(bundleDefinitions.filter(Boolean).map((bundleDefinition) => {
 				log.verbose(`Generating ${bundleDefinition.name}...`);
 				return moduleBundler({
 					resources,
@@ -141,12 +148,19 @@ module.exports = function({
 				});
 			}));
 		})
-		.then((processedResources) => {
-			return Promise.all(processedResources.map((resource) => {
+		.then((results) => {
+			const bundles = Array.prototype.concat.apply([], results);
+			return Promise.all(bundles.map(({bundle, sourceMap}) => {
 				if (taskUtil) {
-					taskUtil.setTag(resource[0], taskUtil.STANDARD_TAGS.IsBundle);
+					taskUtil.setTag(bundle, taskUtil.STANDARD_TAGS.IsBundle);
+					// Clear tag that might have been set by the minify task, in cases where
+					// the bundle name is identical to a source file
+					taskUtil.clearTag(sourceMap, taskUtil.STANDARD_TAGS.OmitFromBuildResult);
 				}
-				return workspace.write(resource[0]);
+				return Promise.all([
+					workspace.write(bundle),
+					workspace.write(sourceMap)
+				]);
 			}));
 		});
 };

package/lib/tasks/bundlers/generateFlexChangesBundle.js

@@ -2,6 +2,7 @@ const log = require("@ui5/logger").getLogger("builder:tasks:bundlers:generateFle
 const flexChangesBundler = require("../../processors/bundlers/flexChangesBundler");
 const semver = require("semver");
 
+/* eslint "jsdoc/check-param-names": ["error", {"disableExtraPropertyReporting":true}] */
 /**
  * Task to create changesBundle.json file containing all changes stored in the /changes folder for easier consumption
  * at runtime.
@@ -14,12 +15,15 @@ const semver = require("semver");
  * @alias module:@ui5/builder.tasks.generateFlexChangesBundle
  * @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 {module:@ui5/project.build.helpers.TaskUtil|object} [parameters.taskUtil] TaskUtil
  * @param {object} [parameters.options] Options
- * @param {string} [parameters.options.namespace] Application Namespace
+ * @param {string} [parameters.options.projectNamespace] Project Namespace
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = async function({workspace, taskUtil, options: {namespace}}) {
+module.exports = async function({workspace, taskUtil, options = {}}) {
+	// Backward compatibility: "namespace" option got renamed to "projectNamespace"
+	const namespace = options.projectNamespace || options.namespace;
+
 	// Use the given namespace if available, otherwise use no namespace
 	// (e.g. in case no manifest.json is present)
 	let pathPrefix = "";