builder/lib/tasks/bundlers/generateFlexChangesBundle.js

  1. const log = require("@ui5/logger").getLogger("builder:tasks:bundlers:generateFlexChangesBundle");
  2. const flexChangesBundler = require("../../processors/bundlers/flexChangesBundler");
  3. const semver = require("semver");
  5. /**
  6.  * Task to create changesBundle.json file containing all changes stored in the /changes folder for easier consumption
  7.  * at runtime.
  8.  * If a change bundle is created, "sap.ui.fl" is added as a dependency to the manifest.json if not already present -
  9.  * if the dependency is already listed but lazy-loaded, lazy loading is disabled.
  10.  * If minUI5Version >= 1.73 flexibility-bundle.json will be create.
  11.  * If there are control variants and minUI5Version < 1.73 build will break and throw an error.
  12.  *
  13.  * @public
  14.  * @alias module:@ui5/builder.tasks.generateFlexChangesBundle
  15.  * @param {object} parameters Parameters
  16.  * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
  17.  * @param {module:@ui5/builder.tasks.TaskUtil|object} [parameters.taskUtil] TaskUtil
  18.  * @param {object} [parameters.options] Options
  19.  * @param {string} [parameters.options.namespace] Application Namespace
  20.  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  21.  */
  22. module.exports = async function({workspace, taskUtil, options: {namespace}}) {
  23. 	// Use the given namespace if available, otherwise use no namespace
  24. 	// (e.g. in case no manifest.json is present)
  25. 	let pathPrefix = "";
  26. 	if (namespace) {
  27. 		pathPrefix = `/resources/${namespace}`;
  28. 	}
  30. 	function updateJson(data) {
  31. 		// ensure the existence of the libs section in the dependencies
  32. 		data["sap.ui5"] = data["sap.ui5"] || {};
  33. 		data["sap.ui5"].dependencies = data["sap.ui5"].dependencies || {};
  34. 		const mLibs = data["sap.ui5"].dependencies.libs = data["sap.ui5"].dependencies.libs || {};
  36. 		if (mLibs["sap.ui.fl"]) {
  37. 			log.verbose("sap.ui.fl found in manifest.json");
  38. 			if (mLibs["sap.ui.fl"].lazy) {
  39. 				log.verbose("sap.ui.fl 'lazy' attribute found in manifest.json, setting it to false...");
  40. 				mLibs["sap.ui.fl"].lazy = false;
  41. 			}
  42. 		} else {
  43. 			log.verbose("sap.ui.fl not found in manifest.json, inserting it...");
  44. 			mLibs["sap.ui.fl"] = {};
  45. 		}
  46. 	}
  48. 	async function updateFLdependency() {
  49. 		const manifestResource = await workspace.byPath(`${pathPrefix}/manifest.json`);
  50. 		const manifestContent = JSON.parse(await manifestResource.getString());
  52. 		updateJson(manifestContent);
  53. 		manifestResource.setString(JSON.stringify(manifestContent, null, "\t"));
  55. 		await workspace.write(manifestResource);
  56. 	}
  58. 	async function readManifestMinUI5Version() {
  59. 		const manifestResource = await workspace.byPath(`${pathPrefix}/manifest.json`);
  60. 		const manifestContent = JSON.parse(await manifestResource.getString());
  62. 		manifestContent["sap.ui5"] = manifestContent["sap.ui5"] || {};
  63. 		manifestContent["sap.ui5"].dependencies = manifestContent["sap.ui5"].dependencies || {};
  64. 		return manifestContent["sap.ui5"].dependencies.minUI5Version =
  65. 			manifestContent["sap.ui5"].dependencies.minUI5Version || "";
  66. 	}
  68. 	log.verbose("Collecting flexibility changes");
  69. 	const allResources = await workspace.byGlob(
  70. 		`${pathPrefix}/changes/*.{change,variant,ctrl_variant,ctrl_variant_change,ctrl_variant_management_change}`);
  71. 	if (allResources.length > 0) {
  72. 		const version = semver.coerce(await readManifestMinUI5Version());
  73. 		let hasFlexBundleVersion = false;
  74. 		let flexBundle = {};
  75. 		if (semver.compare(version, "1.73.0") >= 0) {
  76. 			hasFlexBundleVersion = true;
  77. 			const flexBundleResource = await workspace.byPath(`${pathPrefix}/changes/flexibility-bundle.json`);
  78. 			if (flexBundleResource) {
  79. 				flexBundle = JSON.parse(await flexBundleResource.getString());
  80. 			}
  81. 		}
  82. 		const processedResources = await flexChangesBundler({
  83. 			resources: allResources,
  84. 			options: {
  85. 				pathPrefix,
  86. 				hasFlexBundleVersion
  87. 			},
  88. 			existingFlexBundle: flexBundle
  89. 		});
  90. 		await Promise.all(processedResources.map((resource) => {
  91. 			log.verbose("Writing flexibility changes bundle");
  92. 			return workspace.write(resource);
  93. 		}));
  94. 		// Add the sap.ui.fl dependency if a bundle has been created
  95. 		if (processedResources.length > 0) {
  96. 			await updateFLdependency();
  97. 		}
  99. 		// Do not write bundled source files to build result
  100. 		if (taskUtil) {
  101. 			allResources.forEach((resource) => {
  102. 				taskUtil.setTag(resource, taskUtil.STANDARD_TAGS.OmitFromBuildResult);
  103. 			});
  104. 		}
  105. 	}
  106. };