builder/lib/tasks/bundlers/generateLibraryPreload.js

  1. const log = require("@ui5/logger").getLogger("builder:tasks:bundlers:generateLibraryPreload");
  2. const moduleBundler = require("../../processors/bundlers/moduleBundler");
  3. const ReaderCollectionPrioritized = require("@ui5/fs").ReaderCollectionPrioritized;
  4. const {negateFilters} = require("../../lbt/resources/ResourceFilterList");
  6. function getDefaultLibraryPreloadFilters(namespace, excludes) {
  7. 	const filters = [
  8. 		`${namespace}/`,
  9. 		`${namespace}/**/manifest.json`,
  10. 		`!${namespace}/*-preload.js`, // exclude all bundles
  11. 		`!${namespace}/designtime/`,
  12. 		`!${namespace}/**/*.designtime.js`,
  13. 		`!${namespace}/**/*.support.js`
  14. 	];
  16. 	if (Array.isArray(excludes)) {
  17. 		const allFilterExcludes = negateFilters(excludes);
  18. 		// Add configured excludes at the end of filter list
  19. 		allFilterExcludes.forEach((filterExclude) => {
  20. 			// Allow all excludes (!) and limit re-includes (+) to the library namespace
  21. 			if (filterExclude.startsWith("!") || filterExclude.startsWith(`+${namespace}/`)) {
  22. 				filters.push(filterExclude);
  23. 			} else {
  24. 				log.warn(`Configured preload exclude contains invalid re-include: !${filterExclude.substr(1)}. ` +
  25. 				`Re-includes must start with the library's namespace ${namespace}`);
  26. 			}
  27. 		});
  28. 	}
  30. 	return filters;
  31. }
  33. function getBundleDefinition(namespace, excludes) {
  34. 	// TODO: move to config of actual core project
  35. 	if (namespace === "sap/ui/core") {
  36. 		return {
  37. 			name: `${namespace}/library-preload.js`,
  38. 			sections: [
  39. 				{
  40. 					// exclude the content of sap-ui-core by declaring it as 'provided'
  41. 					mode: "provided",
  42. 					filters: [
  43. 						"ui5loader-autoconfig.js",
  44. 						"sap/ui/core/Core.js"
  45. 					],
  46. 					resolve: true
  47. 				},
  48. 				{
  49. 					mode: "preload",
  50. 					filters: [
  51. 						// Note: Don't pass configured preload excludes for sap.ui.core
  52. 						// as they are already hardcoded below.
  53. 						// In future the sap/ui/core/library-preload should be configured
  54. 						// as a custom bundle in the ui5.yaml.
  55. 						...getDefaultLibraryPreloadFilters(namespace),
  57. 						`!${namespace}/cldr/`,
  58. 						"*.js",
  59. 						"sap/base/",
  60. 						"sap/ui/base/",
  61. 						"sap/ui/dom/",
  62. 						"sap/ui/events/",
  63. 						"sap/ui/model/",
  64. 						"sap/ui/security/",
  65. 						"sap/ui/util/",
  66. 						"sap/ui/Global.js",
  68. 						// include only thirdparty that is very likely to be used
  69. 						"sap/ui/thirdparty/crossroads.js",
  70. 						"sap/ui/thirdparty/caja-html-sanitizer.js",
  71. 						"sap/ui/thirdparty/hasher.js",
  72. 						"sap/ui/thirdparty/signals.js",
  73. 						"sap/ui/thirdparty/jquery-mobile-custom.js",
  74. 						"sap/ui/thirdparty/jqueryui/jquery-ui-core.js",
  75. 						"sap/ui/thirdparty/jqueryui/jquery-ui-position.js",
  77. 						// other excludes (not required for productive scenarios)
  78. 						"!sap-ui-*.js",
  79. 						"!sap/ui/core/support/",
  80. 						"!sap/ui/core/plugin/DeclarativeSupport.js",
  81. 						"!sap/ui/core/plugin/LessSupport.js"
  83. 					],
  84. 					resolve: false,
  85. 					resolveConditional: false,
  86. 					renderer: true
  87. 				}
  88. 			]
  89. 		};
  90. 	}
  91. 	return {
  92. 		name: `${namespace}/library-preload.js`,
  93. 		sections: [
  94. 			{
  95. 				mode: "preload",
  96. 				filters: getDefaultLibraryPreloadFilters(namespace, excludes),
  97. 				resolve: false,
  98. 				resolveConditional: false,
  99. 				renderer: true
  100. 			}
  101. 		]
  102. 	};
  103. }
  105. function getDesigntimeBundleDefinition(namespace) {
  106. 	return {
  107. 		name: `${namespace}/designtime/library-preload.designtime.js`,
  108. 		sections: [
  109. 			{
  110. 				mode: "preload",
  111. 				filters: [
  112. 					`${namespace}/**/*.designtime.js`,
  113. 					`${namespace}/designtime/`,
  114. 					`!${namespace}/**/*-preload.designtime.js`,
  115. 					`!${namespace}/designtime/**/*.properties`,
  116. 					`!${namespace}/designtime/**/*.svg`,
  117. 					`!${namespace}/designtime/**/*.xml`
  118. 				],
  119. 				resolve: false,
  120. 				resolveConditional: false,
  121. 				renderer: false
  122. 			}
  123. 		]
  124. 	};
  125. }
  127. function getSupportFilesBundleDefinition(namespace) {
  128. 	return {
  129. 		name: `${namespace}/library-preload.support.js`,
  130. 		sections: [
  131. 			{
  132. 				mode: "preload",
  133. 				filters: [
  134. 					`${namespace}/**/*.support.js`,
  135. 					`!${namespace}/**/*-preload.support.js`
  136. 				],
  137. 				resolve: false,
  138. 				resolveConditional: false,
  139. 				renderer: false
  140. 			}
  141. 		]
  142. 	};
  143. }
  145. function createLibraryBundles(libraryNamespace, resources, excludes) {
  146. 	return Promise.all([
  147. 		moduleBundler({
  148. 			options: {
  149. 				bundleDefinition: getBundleDefinition(libraryNamespace, excludes),
  150. 				bundleOptions: {
  151. 					optimize: true,
  152. 					usePredefineCalls: true,
  153. 					ignoreMissingModules: true
  154. 				}
  155. 			},
  156. 			resources
  157. 		}),
  158. 		moduleBundler({
  159. 			options: {
  160. 				bundleDefinition: getDesigntimeBundleDefinition(libraryNamespace),
  161. 				bundleOptions: {
  162. 					optimize: true,
  163. 					usePredefineCalls: true,
  164. 					ignoreMissingModules: true,
  165. 					skipIfEmpty: true
  166. 				}
  167. 			},
  168. 			resources
  169. 		}),
  170. 		moduleBundler({
  171. 			options: {
  172. 				bundleDefinition: getSupportFilesBundleDefinition(libraryNamespace),
  173. 				bundleOptions: {
  174. 					optimize: false,
  175. 					usePredefineCalls: true,
  176. 					ignoreMissingModules: true,
  177. 					skipIfEmpty: true
  178. 				}
  179. 			},
  180. 			resources
  181. 		})
  182. 	]);
  183. }
  185. function getModuleBundlerOptions(config) {
  186. 	const moduleBundlerOptions = {};
  188. 	// required in sap-ui-core-nojQuery.js and sap-ui-core-nojQuery-dbg.js
  189. 	const providedSection = {
  190. 		mode: "provided",
  191. 		filters: [
  192. 			"jquery-ui-core.js",
  193. 			"jquery-ui-datepicker.js",
  194. 			"jquery-ui-position.js",
  195. 			"sap/ui/thirdparty/jquery.js",
  196. 			"sap/ui/thirdparty/jquery/*",
  197. 			"sap/ui/thirdparty/jqueryui/*"
  198. 		]
  199. 	};
  201. 	moduleBundlerOptions.bundleOptions = {
  202. 		optimize: config.preload,
  203. 		decorateBootstrapModule: config.preload,
  204. 		addTryCatchRestartWrapper: config.preload,
  205. 		usePredefineCalls: config.preload
  206. 	};
  208. 	moduleBundlerOptions.bundleDefinition = getSapUiCoreBunDef(config.name, config.filters, config.preload);
  210. 	if (config.provided) {
  211. 		moduleBundlerOptions.bundleDefinition.sections.unshift(providedSection);
  212. 	}
  214. 	return moduleBundlerOptions;
  215. }
  217. function getSapUiCoreBunDef(name, filters, preload) {
  218. 	const bundleDefinition = {
  219. 		name,
  220. 		sections: []
  221. 	};
  223. 	// add raw section
  224. 	bundleDefinition.sections.push({
  225. 		// include all 'raw' modules that are needed for the UI5 loader
  226. 		mode: "raw",
  227. 		filters,
  228. 		resolve: true, // dependencies for raw modules are taken from shims in .library files
  229. 		sort: true, // topological sort on raw modules is mandatory
  230. 		declareModules: false
  231. 	});
  233. 	if (preload) {
  234. 		// add preload section
  235. 		bundleDefinition.sections.push({
  236. 			mode: "preload",
  237. 			filters: [
  238. 				"sap/ui/core/Core.js"
  239. 			],
  240. 			resolve: true
  241. 		});
  242. 	}
  244. 	// add require section
  245. 	bundleDefinition.sections.push({
  246. 		mode: "require",
  247. 		filters: [
  248. 			"sap/ui/core/Core.js"
  249. 		]
  250. 	});
  252. 	return bundleDefinition;
  253. }
  255. /**
  256.  * Task for library bundling.
  257.  *
  258.  * @public
  259.  * @alias module:@ui5/builder.tasks.generateLibraryPreload
  260.  * @param {object} parameters Parameters
  261.  * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
  262.  * @param {module:@ui5/fs.AbstractReader} parameters.dependencies Reader or Collection to read dependency files
  263.  * @param {module:@ui5/builder.tasks.TaskUtil|object} [parameters.taskUtil] TaskUtil
  264.  * @param {string[]} [parameters.options.excludes=[]] List of modules declared as glob patterns (resource name patterns)
  265.  * that should be excluded from the library-preload.js bundle.
  266.  * A pattern ending with a slash '/' will, similarly to the use of a single '*' or double '**' asterisk,
  267.  * denote an arbitrary number of characters or folder names.
  268.  * Re-includes should be marked with a leading exclamation mark '!'. The order of filters is relevant; a later
  269.  * inclusion overrides an earlier exclusion, and vice versa.
  270.  * @param {object} parameters.options Options
  271.  * @param {string} parameters.options.projectName Project name
  272.  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  273.  */
  274. module.exports = function({workspace, dependencies, taskUtil, options: {projectName, excludes = []}}) {
  275. 	const combo = new ReaderCollectionPrioritized({
  276. 		name: `libraryBundler - prioritize workspace over dependencies: ${projectName}`,
  277. 		readers: [workspace, dependencies]
  278. 	});
  280. 	return combo.byGlob("/**/*.{js,json,xml,html,properties,library}").then((resources) => {
  281. 		// Find all libraries and create a library-preload.js bundle
  283. 		let p = Promise.resolve();
  285. 		// Create core bundles for older versions (<1.97.0) which don't define bundle configuration in the ui5.yaml
  286. 		// See: https://github.com/SAP/openui5/commit/ff127fd2d009162ea43ad312dec99d759ebc23a0
  287. 		if (projectName === "sap.ui.core") {
  288. 			const coreProject = resources[0]._project;
  289. 			const coreSpecVersion = coreProject && coreProject.specVersion;
  290. 			// Instead of checking the sap.ui.core library version, the specVersion is checked against all versions
  291. 			// that have been defined for sap.ui.core before the bundle configuration has been introduced.
  292. 			// This is mainly to have an easier check without version parsing or using semver.
  293. 			// If no project/specVersion is available, the bundles should also be created to not break potential
  294. 			// existing use cases without a properly formed/formatted project tree.
  295. 			if (!coreSpecVersion || ["0.1", "1.1", "2.0"].includes(coreSpecVersion)) {
  296. 				const isEvo = resources.find((resource) => {
  297. 					return resource.getPath() === "/resources/ui5loader.js";
  298. 				});
  299. 				let filters;
  300. 				if (isEvo) {
  301. 					filters = ["ui5loader-autoconfig.js"];
  302. 				} else {
  303. 					filters = ["jquery.sap.global.js"];
  304. 				}
  305. 				p = Promise.all([
  306. 					moduleBundler({
  307. 						options: getModuleBundlerOptions({name: "sap-ui-core.js", filters, preload: true}),
  308. 						resources
  309. 					}),
  310. 					moduleBundler({
  311. 						options: getModuleBundlerOptions({name: "sap-ui-core-dbg.js", filters, preload: false}),
  312. 						resources
  313. 					}),
  314. 					moduleBundler({
  315. 						options: getModuleBundlerOptions({
  316. 							name: "sap-ui-core-nojQuery.js", filters, preload: true, provided: true
  317. 						}),
  318. 						resources
  319. 					}),
  320. 					moduleBundler({
  321. 						options: getModuleBundlerOptions({
  322. 							name: "sap-ui-core-nojQuery-dbg.js", filters, preload: false, provided: true
  323. 						}),
  324. 						resources
  325. 					}),
  326. 				]).then((results) => {
  327. 					const bundles = Array.prototype.concat.apply([], results);
  328. 					return Promise.all(bundles.map((bundle) => {
  329. 						if (taskUtil) {
  330. 							taskUtil.setTag(bundle, taskUtil.STANDARD_TAGS.IsBundle);
  331. 						}
  332. 						return workspace.write(bundle);
  333. 					}));
  334. 				});
  335. 			}
  336. 		}
  338. 		return p.then(() => {
  339. 			return workspace.byGlob("/resources/**/.library").then((libraryIndicatorResources) => {
  340. 				if (libraryIndicatorResources.length > 0) {
  341. 					return libraryIndicatorResources;
  342. 				} else {
  343. 					// Fallback to "library.js" as library indicator
  344. 					log.verbose(
  345. 						`Could not find a ".library" file for project ${projectName}, falling back to "library.js".`);
  346. 					return workspace.byGlob("/resources/**/library.js");
  347. 				}
  348. 			}).then((libraryIndicatorResources) => {
  349. 				if (libraryIndicatorResources.length < 1) {
  350. 					// No library found - nothing to do
  351. 					log.verbose(
  352. 						`Could not find a ".library" or "library.js" file for project ${projectName}. ` +
  353. 						`Skipping library preload bundling.`);
  354. 					return;
  355. 				}
  357. 				return Promise.all(libraryIndicatorResources.map((libraryIndicatorResource) => {
  358. 					// Determine library namespace from library indicator file path
  359. 					// ending with either ".library" or "library.js" (see fallback logic above)
  360. 					// e.g. /resources/sap/foo/.library => sap/foo
  361. 					//      /resources/sap/bar/library.js => sap/bar
  362. 					const libraryNamespacePattern = /^\/resources\/(.*)\/(?:\.library|library\.js)$/;
  363. 					const libraryIndicatorPath = libraryIndicatorResource.getPath();
  364. 					const libraryNamespaceMatch = libraryIndicatorPath.match(libraryNamespacePattern);
  365. 					if (libraryNamespaceMatch && libraryNamespaceMatch[1]) {
  366. 						const libraryNamespace = libraryNamespaceMatch[1];
  367. 						return createLibraryBundles(libraryNamespace, resources, excludes)
  368. 							.then((results) => {
  369. 								const bundles = Array.prototype.concat.apply([], results);
  370. 								return Promise.all(bundles.map((bundle) => {
  371. 									if (bundle) {
  372. 										if (taskUtil) {
  373. 											taskUtil.setTag(bundle, taskUtil.STANDARD_TAGS.IsBundle);
  374. 										}
  375. 										return workspace.write(bundle);
  376. 									}
  377. 								}));
  378. 							});
  379. 					} else {
  380. 						log.verbose(
  381. 							`Could not determine library namespace from file "${libraryIndicatorPath}" ` +
  382. 							`for project ${projectName}. Skipping library preload bundling.`);
  383. 						return Promise.resolve();
  384. 					}
  385. 				}));
  386. 			});
  387. 		});
  388. 	});
  389. };