builder/lib/tasks/bundlers/generateBundle.js

  1. import moduleBundler from "../../processors/bundlers/moduleBundler.js";
  2. import {applyDefaultsToBundleDefinition} from "./utils/applyDefaultsToBundleDefinition.js";
  3. import createModuleNameMapping from "./utils/createModuleNameMapping.js";
  4. import ReaderCollectionPrioritized from "@ui5/fs/ReaderCollectionPrioritized";
  6. /**
  7.  * @public
  8.  * @module @ui5/builder/tasks/bundlers/generateBundle
  9.  */
  11. /* eslint-disable max-len */
  12. /**
  13.  * Generates a bundle based on the given bundle definition
  14.  *
  15.  * @public
  16.  * @function default
  17.  * @static
  18.  *
  19.  * @param {object} parameters Parameters
  20.  * @param {@ui5/fs/DuplexCollection} parameters.workspace DuplexCollection to read and write files
  21.  * @param {@ui5/fs/ReaderCollection} parameters.dependencies Collection to read dependency files
  22.  * @param {@ui5/project/build/helpers/TaskUtil|object} [parameters.taskUtil] TaskUtil
  23.  * @param {object} parameters.options Options
  24.  * @param {string} parameters.options.projectName Project name
  25.  * @param {module:@ui5/builder/processors/bundlers/moduleBundler~ModuleBundleDefinition} parameters.options.bundleDefinition Module
  26.  * 			bundle definition
  27.  * @param {module:@ui5/builder/processors/bundlers/moduleBundler~ModuleBundleOptions} [parameters.options.bundleOptions] Module
  28.  * 			bundle options
  29.  * @returns {Promise} Promise resolving with <code>undefined</code> once data has been written
  30.  */
  31. /* eslint-enable max-len */
  32. export default async function({
  33. 	workspace, dependencies, taskUtil, options: {projectName, bundleDefinition, bundleOptions}
  34. }) {
  35. 	let combo = new ReaderCollectionPrioritized({
  36. 		name: `generateBundle - prioritize workspace over dependencies: ${projectName}`,
  37. 		readers: [workspace, dependencies]
  38. 	});
  40. 	const optimize = !bundleOptions || bundleOptions.optimize !== false;
  41. 	if (taskUtil) {
  42. 		/* Scenarios
  43. 			1. Optimize bundle with minification already done
  44. 				Workspace:
  45. 					* /resources/my/lib/Control.js 				[ui5:HasDebugVariant]
  46. 					* /resources/my/lib/Control.js.map 			[ui5:HasDebugVariant]
  47. 					* /resources/my/lib/Control-dbg.js 			[ui5:IsDebugVariant]
  49. 				Bundler input:
  50. 					* /resources/my/lib/Control.js
  51. 					* /resources/my/lib/Control.js.map
  53. 				=> Filter out debug resources
  55. 			2. Optimize bundle with no minification
  56. 				* /resources/my/lib/Control.js
  58. 				=> No action necessary
  60. 			3. Debug-bundle with minification already done
  61. 				Workspace:
  62. 					* /resources/my/lib/Control.js 				[ui5:HasDebugVariant]
  63. 					* /resources/my/lib/Control.js.map 			[ui5:HasDebugVariant]
  64. 					* /resources/my/lib/Control-dbg.js 			[ui5:IsDebugVariant]
  66. 				Bundler input:
  67. 					* /resources/my/lib/Control-dbg.js
  68. 					* moduleNameMapping: [{"/resources/my/lib/Control-dbg.js": "my/lib/Control.js"}]
  70. 				=> Filter out minified-resources (tagged as "HasDebugVariant", incl. source maps) and rename debug-files
  72. 			4. Debug-bundle with no minification
  73. 				* /resources/my/lib/Control.js
  75. 				=> No action necessary
  77. 			5. Bundle with external input (optimize or not), e.g. TS-project
  78. 				Workspace:
  79. 					* /resources/my/lib/Control.ts
  80. 					* /resources/my/lib/Control.js
  81. 					* /resources/my/lib/Control.js.map
  83. 				Bundler input:
  84. 					* /resources/my/lib/Control.js
  85. 					* /resources/my/lib/Control.js.map
  86. 		*/
  88. 		// Omit -dbg files for optimize bundles and vice versa
  89. 		const filterTag = optimize ?
  90. 			taskUtil.STANDARD_TAGS.IsDebugVariant : taskUtil.STANDARD_TAGS.HasDebugVariant;
  91. 		combo = taskUtil.resourceFactory.createFilterReader({
  92. 			reader: combo,
  93. 			callback: function(resource) {
  94. 				return !taskUtil.getTag(resource, filterTag);
  95. 			}
  96. 		});
  97. 	}
  98. 	const coreVersion = taskUtil?.getProject("sap.ui.core")?.getVersion();
  99. 	const allowStringBundling = taskUtil?.getProject().getSpecVersion().lt("4.0");
  100. 	return combo.byGlob("/resources/**/*.{js,json,xml,html,properties,library,js.map}").then((resources) => {
  101. 		const options = {
  102. 			bundleDefinition: applyDefaultsToBundleDefinition(bundleDefinition, taskUtil),
  103. 			bundleOptions,
  104. 			allowStringBundling
  105. 		};
  106. 		if (!optimize && taskUtil) {
  107. 			options.moduleNameMapping = createModuleNameMapping({resources, taskUtil});
  108. 		}
  109. 		if (coreVersion) {
  110. 			options.targetUi5CoreVersion = coreVersion;
  111. 		}
  112. 		return moduleBundler({options, resources}).then((bundles) => {
  113. 			return Promise.all(bundles.map(({bundle, sourceMap} = {}) => {
  114. 				if (!bundle) {
  115. 					// Skip empty bundles
  116. 					return;
  117. 				}
  118. 				if (taskUtil) {
  119. 					taskUtil.setTag(bundle, taskUtil.STANDARD_TAGS.IsBundle);
  120. 					if (sourceMap) {
  121. 						// Clear tag that might have been set by the minify task, in cases where
  122. 						// the bundle name is identical to a source file
  123. 						taskUtil.clearTag(sourceMap, taskUtil.STANDARD_TAGS.OmitFromBuildResult);
  124. 					}
  125. 				}
  126. 				const writes = [workspace.write(bundle)];
  127. 				if (sourceMap) {
  128. 					writes.push(workspace.write(sourceMap));
  129. 				}
  130. 				return Promise.all(writes);
  131. 			}));
  132. 		});
  133. 	});
  134. }