builder/lib/processors/bundlers/flexChangesBundler.js

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