builder/lib/processors/bundlers/flexChangesBundler.js

  1. const log = require("@ui5/logger").getLogger("builder:processors:bundlers:flexChangesBundler");
  2. const resourceFactory = require("@ui5/fs").resourceFactory;
  4. /**
  5.  * Bundles all supplied changes.
  6.  *
  7.  * @public
  8.  * @alias module:@ui5/builder.processors.flexChangesBundler
  9.  * @param {object} parameters Parameters
  10.  * @param {module:@ui5/fs.Resource[]} parameters.resources List of resources to be processed
  11.  * @param {object} parameters.options Options
  12.  * @param {string} parameters.options.pathPrefix Prefix for bundle path
  13.  * @param {string} parameters.options.hasFlexBundleVersion true if minUI5Version >= 1.73 than
  14.  *															create flexibility-bundle.json
  15.  * @param {object} [parameters.existingFlexBundle={}] Object with existing flexibility-bundle.json
  16.  * 															to merge with new changes
  17.  * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving with flex changes bundle resources
  18.  */
  19. module.exports = function({resources, options: {pathPrefix, hasFlexBundleVersion}, existingFlexBundle = {}}) {
  20. 	let bundleName = "changes-bundle.json";
  22. 	function sortByTimeStamp(a, b) {
  23. 		return a.creation > b.creation ? 1 : -1;
  24. 	}
  26. 	/**
  27. 	 * bundle changes resource to json string
  28. 	 *
  29. 	 * @param {Array} changesContent Array of resources files
  30. 	 * @returns {string} Json sting of changes and control variants
  31. 	 */
  32. 	function sortAndStringifyInFlexFormat(changesContent) {
  33. 		changesContent = changesContent.sort(sortByTimeStamp);
  34. 		const changes = [];
  35. 		const variantDependentControlChanges = [];
  36. 		const compVariants = [];
  37. 		const variants = [];
  38. 		const variantChanges = [];
  39. 		const variantManagementChanges = [];
  41. 		changesContent.forEach(function(content) {
  42. 			if (content.layer === "VENDOR") {
  43. 				content.support.user = "SAP";
  44. 			}
  45. 			switch (content.fileType) {
  46. 			case "change":
  47. 				if (content.appDescriptorChange && (content.appDescriptorChange === "true" ||
  48. 						content.appDescriptorChange == true)) {
  49. 					break;
  50. 				}
  51. 				if (content.variantReference && content.variantReference !== "") {
  52. 					variantDependentControlChanges.push(content);
  53. 				} else {
  54. 					changes.push(content);
  55. 				}
  56. 				break;
  57. 			case "variant":
  58. 				compVariants.push(content);
  59. 				break;
  60. 			case "ctrl_variant":
  61. 				variants.push(content);
  62. 				break;
  63. 			case "ctrl_variant_change":
  64. 				variantChanges.push(content);
  65. 				break;
  66. 			case "ctrl_variant_management_change":
  67. 				variantManagementChanges.push(content);
  68. 				break;
  69. 			}
  70. 		});
  72. 		if (!hasFlexBundleVersion && (compVariants.length != 0 || variants.length != 0 || variantChanges.length != 0 ||
  73. 				variantDependentControlChanges.length != 0 || variantManagementChanges.length != 0)) {
  74. 			throw new Error(
  75. 				"There are some control variant changes in the changes folder. This only works with a " +
  76. 				"minUI5Version 1.73.0. Please update the minUI5Version in the manifest.json to 1.73.0 or higher");
  77. 		}
  78. 		// create changes-bundle.json
  79. 		if (!hasFlexBundleVersion) {
  80. 			return JSON.stringify(changes);
  81. 		} else {
  82. 			bundleName = "flexibility-bundle.json";
  83. 			let newChangeFormat = {
  84. 				changes,
  85. 				compVariants,
  86. 				variants,
  87. 				variantChanges,
  88. 				variantDependentControlChanges,
  89. 				variantManagementChanges
  90. 			};
  91. 			if (Object.keys(existingFlexBundle).length > 0) {
  92. 				newChangeFormat = mergeFlexChangeBundles(newChangeFormat);
  93. 			}
  94. 			return JSON.stringify(newChangeFormat);
  95. 		}
  96. 	}
  98. 	/**
  99. 	 * Merge new and existing bundles
  100. 	 *
  101. 	 * @param {object} newFlexBundle Object with new content of flexibility-bundle.json
  102. 	 * @returns {object} Object with merged content of new and existing flexibility-bundle.json
  103. 	 */
  104. 	function mergeFlexChangeBundles(newFlexBundle) {
  105. 		const result = {};
  107. 		Object.keys(newFlexBundle).forEach((key) => {
  108. 			if (existingFlexBundle[key] && Array.isArray(existingFlexBundle[key])) {
  109. 				result[key] = existingFlexBundle[key].concat(newFlexBundle[key]);
  110. 			} else {
  111. 				result[key] = newFlexBundle[key];
  112. 			}
  113. 		});
  115. 		return result;
  116. 	}
  118. 	return Promise.all(resources.map((resource) => {
  119. 		return resource.getBuffer().then((buffer) => {
  120. 			return JSON.parse(buffer.toString());
  121. 		});
  122. 	})).then((changesContent) => {
  123. 		const nNumberOfChanges = changesContent.length;
  124. 		log.info("Changes collected. Number of changes: " + nNumberOfChanges);
  125. 		const result = [];
  126. 		if (nNumberOfChanges > 0) {
  127. 			changesContent = sortAndStringifyInFlexFormat(changesContent);
  128. 			result.push(resourceFactory.createResource({
  129. 				path: `${pathPrefix}/changes/${bundleName}`,
  130. 				string: changesContent
  131. 			}));
  132. 		}
  133. 		return result;
  134. 	});
  135. };