builder/lib/processors/bundlers/moduleBundler.js

  1. import BundleBuilder from "../../lbt/bundle/Builder.js";
  2. import LocatorResourcePool from "../../lbt/resources/LocatorResourcePool.js";
  3. import EvoResource from "@ui5/fs/Resource";
  4. import {getLogger} from "@ui5/logger";
  5. const log = getLogger("builder:processors:bundlers:moduleBundler");
  7. /**
  8.  * @public
  9.  * @module @ui5/builder/processors/bundlers/moduleBundler
  10.  */
  12. /**
  13.  * A ModuleBundleDefinitionSection specifies the embedding mode (either 'provided', 'raw', 'preload', 'require'
  14.  * or 'bundleInfo') and lists the resources that should be in- or excluded from the section.
  15.  * <p>
  16.  * <b>Module bundle section modes</b><br>
  17.  * <ul>
  18.  * 	<li>
  19.  *		<code>provided</code>: A section of mode 'provided' defines a set of modules that should not be included in
  20.  * the bundle file itself, but which should be assumed to be already loaded (or 'provided') by the environment into
  21.  * which the bundle module is loaded.
  22.  * 	</li>
  23.  *	<li>
  24.  *		<code>raw</code>: A 'raw' section determines the set of modules that should be embedded, sorts them according
  25.  *		to their dependencies and writes them out 1:1 without any transformation or wrapping (raw). Only JavaScript
  26.  *		sources can be embedded in a raw section.
  27.  *	</li>
  28.  *	<li>
  29.  *		<code>preload</code>: A 'preload' section packages resources that should be stored in the preload cache in the
  30.  *		client. They can embed any textual resource type (JavaScript, XML, JSON and .properties files) that the
  31.  *		bundling supports. UI5 modules are wrapped into a 'sap.ui.predefine' call. Other JavaScript modules will be
  32.  *		embedded into a 'jQuery.sap.registerPreload' call, or in a "sap.ui.require.preload" call when
  33.  *      the ui5loader is available.
  34.  *	</li>
  35.  *	<li>
  36.  *		<code>require</code>: A 'require' section is transformed into a sequence of jQuery.sap.require calls. The
  37.  *		list will be resolved like an include pattern list in any of the other sections and for each of the resolved
  38.  *		modules, a jQuery.sap.require will be created. In case the ui5loader is available, 'sap.ui.requireSync' is
  39.  *		used instead.
  40.  *	</li>
  41.  *	<li>
  42.  *		<code>bundleInfo</code>: A 'bundleInfo' section describes the content of another named bundle. This information
  43.  *		is transformed into a ui5loader-"bundlesUI5" configuration.
  44.  *		At runtime, if a module is known to be contained in a bundle, the loader will require that bundle before
  45.  *		the module itself.
  46.  *		This requires the ui5loader to be available at build time and UI5 version 1.74.0 or higher at runtime.
  47.  *	</li>
  48.  * </ul>
  49.  * </p>
  50.  *
  51.  * @public
  52.  * @typedef {object} ModuleBundleDefinitionSection
  53.  * @property {string} mode The embedding mode. Either 'provided', 'raw', 'preload', 'require' or 'bundleInfo'
  54.  * @property {string[]} filters List of modules declared as glob patterns (resource name patterns) that should be
  55.  *		in- or excluded.
  56.  * 		A pattern ending with a slash '/' will, similarly to the use of a single '*' or double '**' asterisk,
  57.  *		denote an arbitrary number of characters or folder names.
  58.  * 		Excludes should be marked with a leading exclamation mark '!'. The order of filters is relevant; a later
  59.  *		exclusion overrides an earlier inclusion, and vice versa.
  60.  * @example <caption>List of modules as glob patterns that should be in- or excluded</caption>
  61.  * // Includes everything from "some/path/to/module/",
  62.  * // but excludes the subfolder "some/path/to/module/to/be/excluded/"
  63.  * const section = {
  64.  * 	"filters": [
  65.  * 		"some/path/to/module/",
  66.  * 		"!some/path/to/module/to/be/excluded/"
  67.  * 	]
  68.  * };
  69.  *
  70.  * @property {boolean} [resolve=false] Whether (transitive) dependencies of modules that match the given filters
  71.  *		should be resolved and added to the module set
  72.  * @property {boolean} [resolveConditional=false] Whether conditional dependencies of modules should be resolved
  73.  * 		and added to the module set for this section
  74.  * @property {boolean} [renderer=false] Whether renderers for controls should be added to the module set
  75.  * @property {boolean} [declareRawModules=false] Whether raw modules should be declared after jQuery.sap.global
  76.  *		became available. With the usage of the ui5loader, this flag should be set to 'false'
  77.  * @property {boolean} [sort=true] Whether the modules should be sorted by their dependencies
  78.  */
  80. /* eslint-disable max-len */
  81. /**
  82.  * Module bundle definition
  83.  *
  84.  * @public
  85.  * @typedef {object} ModuleBundleDefinition
  86.  * @property {string} name The module bundle name
  87.  * @property {string[]} [defaultFileTypes=[".js", ".control.xml", ".fragment.html", ".fragment.json", ".fragment.xml", ".view.html", ".view.json", ".view.xml"]]
  88.  *   List of default file types to be included in the bundle
  89.  * @property {module:@ui5/builder/processors/bundlers/moduleBundler~ModuleBundleDefinitionSection[]} sections List of module bundle definition sections.
  90.  */
  91. /* eslint-enable max-len */
  93. /**
  94.  * Module bundle options
  95.  *
  96.  * @public
  97.  * @typedef {object} ModuleBundleOptions
  98.  * @property {boolean} [optimize=true] Whether the module bundle gets minified
  99.  * @property {boolean} [sourceMap=true] Whether to generate a source map file for the bundle
  100.  * @property {boolean} [decorateBootstrapModule=false] If set to 'false', bootable bundles won't be decorated
  101.  *   with an optimization marker
  102.  * @property {boolean} [addTryCatchRestartWrapper=false] Whether to wrap bootable bundles with
  103.  *   a try/catch to filter out "Restart" errors
  104.  * @property {boolean} [usePredefineCalls=false] If set to 'true', sap.ui.predefine is used for UI5 modules
  105.  * @property {number} [numberOfParts=1] The number of parts the module bundle should be splitted
  106.  * @property {boolean} [ignoreMissingModules=false] When searching for modules which are optional for further
  107.  *   processing, do not throw in case they are missing
  108.  */
  110. /**
  111.  * Result set
  112.  *
  113.  * @public
  114.  * @typedef {object} ModuleBundlerResult
  115.  * @property {@ui5/fs/Resource} bundle Bundle resource
  116.  * @property {@ui5/fs/Resource} sourceMap Source Map
  117.  */
  119. /* eslint-disable max-len */
  120. /**
  121.  * Legacy module bundler.
  122.  *
  123.  * @public
  124.  * @function default
  125.  * @static
  126.  *
  127.  * @param {object} parameters Parameters
  128.  * @param {@ui5/fs/Resource[]} parameters.resources Resources
  129.  * @param {object} parameters.options Options
  130.  * @param {object} [parameters.options.moduleNameMapping]
  131.  				Optional mapping of resource paths to module name in order to overwrite the default determination
  132.  * @param {module:@ui5/builder/processors/bundlers/moduleBundler~ModuleBundleDefinition} parameters.options.bundleDefinition Module
  133. 				bundle definition
  134.  * @param {module:@ui5/builder/processors/bundlers/moduleBundler~ModuleBundleOptions} [parameters.options.bundleOptions] Module
  135. 				bundle options
  136.  * @returns {Promise<module:@ui5/builder/processors/bundlers/moduleBundler~ModuleBundlerResult[]>}
  137.  * Promise resolving with module bundle resources
  138.  */
  139. /* eslint-enable max-len */
  140. export default function({resources, options: {bundleDefinition, bundleOptions, moduleNameMapping}}) {
  141. 	// Apply defaults without modifying the passed object
  142. 	bundleOptions = Object.assign({}, {
  143. 		optimize: true,
  144. 		sourceMap: true,
  145. 		decorateBootstrapModule: false,
  146. 		addTryCatchRestartWrapper: false,
  147. 		usePredefineCalls: false,
  148. 		numberOfParts: 1,
  149. 		ignoreMissingModules: false
  150. 	}, bundleOptions);
  152. 	const pool = new LocatorResourcePool({
  153. 		ignoreMissingModules: bundleOptions.ignoreMissingModules
  154. 	});
  155. 	const builder = new BundleBuilder(pool);
  157. 	if (log.isLevelEnabled("verbose")) {
  158. 		log.verbose(`Generating bundle:`);
  159. 		log.verbose(`bundleDefinition: ${JSON.stringify(bundleDefinition, null, 2)}`);
  160. 		log.verbose(`bundleOptions: ${JSON.stringify(bundleOptions, null, 2)}`);
  161. 	}
  162. 	return pool.prepare( resources, moduleNameMapping ).
  163. 		then( () => builder.createBundle(bundleDefinition, bundleOptions) ).
  164. 		then( (results) => {
  165. 			let bundles;
  166. 			if (results instanceof Array) {
  167. 				bundles = results;
  168. 			} else {
  169. 				bundles = [results];
  170. 			}
  172. 			return Promise.all(bundles.map((bundleObj) => {
  173. 				if ( bundleObj ) {
  174. 					const {name, content, sourceMap} = bundleObj;
  175. 					// console.log("creating bundle as '%s'", "/resources/" + name);
  176. 					const res = {};
  177. 					res.bundle = new EvoResource({
  178. 						path: "/resources/" + name,
  179. 						string: content
  180. 					});
  181. 					if (sourceMap) {
  182. 						res.sourceMap = new EvoResource({
  183. 							path: "/resources/" + name + ".map",
  184. 							string: sourceMap
  185. 						});
  186. 					}
  187. 					return res;
  188. 				}
  189. 			}));
  190. 		});
  191. }