@openui5/sap.ui.fl 1.120.6 → 1.121.0

package/src/sap/ui/fl/apply/_internal/flexState/FlexState.js

@@ -14,7 +14,6 @@ sap.ui.define([
 	"sap/ui/fl/apply/_internal/flexObjects/FlexObjectFactory",
 	"sap/ui/fl/apply/_internal/flexObjects/States",
 	"sap/ui/fl/apply/_internal/flexState/appDescriptorChanges/prepareAppDescriptorMap",
-	"sap/ui/fl/apply/_internal/flexState/changes/prepareChangesMap",
 	"sap/ui/fl/apply/_internal/flexState/compVariants/prepareCompVariantsMap",
 	"sap/ui/fl/apply/_internal/flexState/DataSelector",
 	"sap/ui/fl/apply/_internal/flexState/InitialPrepareFunctions",
@@ -33,7 +32,6 @@ sap.ui.define([
 	FlexObjectFactory,
 	States,
 	prepareAppDescriptorMap,
-	prepareChangesMap,
 	prepareCompVariantsMap,
 	DataSelector,
 	InitialPrepareFunctions,
@@ -52,8 +50,6 @@ sap.ui.define([
 	 *	{
 	 * 		preparedMaps: {
 	 * 			appDescriptorMap: {},
-	 * 			changesMap: {},
-	 * 			variantsMap: {},
 	 * 			compVariantsMap: {},
 	 * 		},
 	 * 		storageResponse: {
@@ -76,7 +72,9 @@ sap.ui.define([
 	 * 		unfilteredStorageResponse: {...}, // same as above but without layer filtering
 	 * 		runtimePersistence: {
 	 * 			flexObjects: [...],
-	 * 			runtimeOnlyData: {}
+	 * 			runtimeOnlyData: {
+	 * 				liveDependencyMap: {...}
+	 * 			}
 	 * 		}
 	 *		partialFlexState: <boolean>,
 	 *		componentId: "<componentId>",
@@ -85,7 +83,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.apply._internal.flexState.FlexState
 	 * @since 1.73
-	 * @version 1.120.6
+	 * @version 1.121.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl.apply._internal
 	 */
@@ -101,7 +99,6 @@ sap.ui.define([
 		},
 		changes: {
 			initialPreparationFunctionName: "uiChanges",
-			prepareFunction: prepareChangesMap,
 			pathInResponse: ["changes"]
 		},
 		variants: {
@@ -184,6 +181,7 @@ sap.ui.define([
 	}
 
 	function initializeState(sMapName, mPropertyBag, sReference) {
+		mPropertyBag.reference = sReference;
 		var oUpdate = runInitialPreparation(sMapName, mPropertyBag);
 		if (oUpdate) {
 			updateInstance(sReference, oUpdate);
@@ -193,14 +191,14 @@ sap.ui.define([
 	var oFlexObjectsDataSelector = new DataSelector({
 		id: "flexObjects",
 		parameterKey: "reference",
-		executeFunction(oData, sReference) {
-			if (!_mInstances[sReference]) {
+		executeFunction(oData, mParameters) {
+			if (!_mInstances[mParameters.reference]) {
 				return [];
 			}
-			var oPersistence = _mInstances[sReference].runtimePersistence;
+			var oPersistence = _mInstances[mParameters.reference].runtimePersistence;
 			return oPersistence.flexObjects.concat(
 				oPersistence.runtimeOnlyData.flexObjects || [],
-				_mExternalData.flexObjects[sReference][_mInstances[sReference].componentId] || []
+				_mExternalData.flexObjects[mParameters.reference][_mInstances[mParameters.reference].componentId] || []
 			);
 		}
 	});
@@ -235,16 +233,13 @@ sap.ui.define([
 		return getInstanceEntryOrThrowError(sReference, "appDescriptorChanges");
 	}
 
-	function getChangesMap(sReference) {
-		return getInstanceEntryOrThrowError(sReference, "changes");
-	}
-
 	function getCompVariantsMap(sReference) {
 		return getInstanceEntryOrThrowError(sReference, "compVariants");
 	}
 
-	function buildRuntimePersistence(oStorageResponse, aExternalFlexObjects) {
-		var oFlexInstance = {
+	function buildRuntimePersistence(oFlexStateInstance, aExternalFlexObjects) {
+		const oStorageResponse = oFlexStateInstance.storageResponse;
+		var oRuntimePersistence = {
 			flexObjects: createFlexObjects(oStorageResponse),
 			runtimeOnlyData: {
 				flexObjects: []
@@ -253,13 +248,15 @@ sap.ui.define([
 		Object.keys(_mFlexObjectInfo).forEach(function(sMapName) {
 			var oUpdate = runInitialPreparation(sMapName, {
 				storageResponse: oStorageResponse,
-				externalData: aExternalFlexObjects
+				externalData: aExternalFlexObjects,
+				flexObjects: oRuntimePersistence.flexObjects,
+				componentId: oFlexStateInstance.componentId
 			});
 			if (oUpdate) {
-				oFlexInstance = merge(oFlexInstance, oUpdate);
+				oRuntimePersistence = merge(oRuntimePersistence, oUpdate);
 			}
 		});
-		return oFlexInstance;
+		return oRuntimePersistence;
 	}
 
 	function updateRuntimePersistence(sReference, oStorageResponse, oRuntimePersistence) {
@@ -292,7 +289,9 @@ sap.ui.define([
 					return oExistingFlexObject;
 				}
 				// If unknown change definitions are found, throw error (storage does not create flex objects)
-				throw new Error("Error updating runtime persistence: storage returned unknown flex objects");
+				const sErrorText = "Error updating runtime persistence: storage returned unknown flex objects";
+				Log.error(sErrorText);
+				throw new Error(sErrorText);
 			})
 		});
 
@@ -325,7 +324,7 @@ sap.ui.define([
 
 		if (!_mInstances[sReference].runtimePersistence) {
 			_mInstances[sReference].runtimePersistence = buildRuntimePersistence(
-				_mInstances[sReference].storageResponse,
+				_mInstances[sReference],
 				_mExternalData.flexObjects[sReference][mPropertyBag.componentId] || []
 			);
 			bDataUpdated = true;
@@ -355,7 +354,10 @@ sap.ui.define([
 
 	function loadFlexData(mPropertyBag) {
 		_mInitPromises[mPropertyBag.reference] = Loader.loadFlexData(mPropertyBag)
-		.then(function(mResponse) {
+		.then(async (mResponse) => {
+			mResponse.authors = await Loader.loadVariantsAuthors(mPropertyBag.reference);
+			return mResponse;
+		}).then((mResponse) => {
 			// The following line is used by the Flex Support Tool to set breakpoints - please adjust the tool if you change it!
 			_mInstances[mPropertyBag.reference] = merge({}, {
 				unfilteredStorageResponse: mResponse,
@@ -379,9 +381,6 @@ sap.ui.define([
 	function storeInfoInSession(sReference, mResponse) {
 		var oResponse = mResponse && mResponse.changes || {};
 		var oFlexInfoSession = FlexInfoSession.getByReference(sReference);
-		if (oFlexInfoSession === null) {
-			oFlexInfoSession = {};
-		}
 		if (oResponse.info !== undefined) {
 			oFlexInfoSession = Object.assign(oFlexInfoSession, oResponse.info);
 		}
@@ -418,6 +417,11 @@ sap.ui.define([
 		});
 	}
 
+	// TODO: the additional safeguard for the runtimePersistence will not be necessary after the FlexState.initialize rework
+	FlexState.getRuntimeOnlyData = function(sReference) {
+		return _mInstances[sReference]?.runtimePersistence?.runtimeOnlyData || {};
+	};
+
 	/**
 	 * Initializes the FlexState for a given reference. A request for the flex data is sent to the Loader and the response is saved.
 	 * The FlexState can only be initialized once, every subsequent init call will just resolve as soon as it is initialized.
@@ -557,12 +561,13 @@ sap.ui.define([
 
 	/**
 	 * Some save operations don't require a complete new data request, so the storage response gets a live update.
-	 * This will not invalidate the DataSelectors
+	 * This will also update the runtime persistence.
 	 *
 	 * @param {string} sReference - Flex reference of the app
 	 * @param {object[]} aUpdates - All new FlexObjects in JSON format
 	 */
 	FlexState.updateStorageResponse = function(sReference, aUpdates) {
+		const aFlexObjectUpdates = [];
 		aUpdates.forEach((oUpdate) => {
 			if (oUpdate.type === "ui2") {
 				_mInstances[sReference].unfilteredStorageResponse.changes.ui2personalization = oUpdate.newData;
@@ -571,23 +576,45 @@ sap.ui.define([
 				const sFileName = oUpdate.flexObject.fileName;
 				const aUnfiltered = ObjectPath.get(vPath, _mInstances[sReference].unfilteredStorageResponse.changes);
 				const aFiltered = ObjectPath.get(vPath, _mInstances[sReference].storageResponse.changes);
+				const iExistingFlexObjectIdx = _mInstances[sReference].runtimePersistence.flexObjects.findIndex(
+					(oFlexObject) => oFlexObject.getId() === sFileName
+				);
+				const oExistingFlexObject = _mInstances[sReference].runtimePersistence.flexObjects[iExistingFlexObjectIdx];
 				switch (oUpdate.type) {
 					case "add":
 						aUnfiltered.push(oUpdate.flexObject);
 						aFiltered.push(oUpdate.flexObject);
+						if (iExistingFlexObjectIdx < 0) {
+							throw new Error("Flex response includes unknown flex object");
+						}
 						break;
 					case "delete":
 						aFiltered.splice(aFiltered.findIndex((oFlexObject) => oFlexObject.fileName === sFileName), 1);
 						aUnfiltered.splice(aUnfiltered.findIndex((oFlexObject) => oFlexObject.fileName === sFileName), 1);
+						if (iExistingFlexObjectIdx >= 0) {
+							_mInstances[sReference].runtimePersistence.flexObjects.splice(iExistingFlexObjectIdx, 1);
+							aFlexObjectUpdates.push({ type: "removeFlexObject", updatedObject: oExistingFlexObject });
+						}
 						break;
 					case "update":
 						aFiltered.splice(aFiltered.findIndex((oFlexObject) => oFlexObject.fileName === sFileName), 1, oUpdate.flexObject);
-						aUnfiltered.splice(aUnfiltered.findIndex((oFlexObject) => oFlexObject.fileName === sFileName), 1, oUpdate.flexObject);
+						aUnfiltered.splice(
+							aUnfiltered.findIndex((oFlexObject) => oFlexObject.fileName === sFileName),
+							1,
+							oUpdate.flexObject
+						);
+						if (oExistingFlexObject && oExistingFlexObject.getState() !== States.LifecycleState.PERSISTED) {
+							oExistingFlexObject.setResponse(oUpdate.flexObject);
+							aFlexObjectUpdates.push({ type: "updateFlexObject", updatedObject: oExistingFlexObject });
+						}
 						break;
 					default:
 				}
 			}
 		});
+		if (aFlexObjectUpdates.length > 0) {
+			oFlexObjectsDataSelector.checkUpdate({ reference: sReference }, aFlexObjectUpdates);
+		}
 	};
 
 	FlexState.clearState = function(sReference) {
@@ -641,7 +668,10 @@ sap.ui.define([
 		_mExternalData.flexObjects[sReference] ||= {};
 		_mExternalData.flexObjects[sReference][sComponentId] ||= [];
 		_mExternalData.flexObjects[sReference][sComponentId].push(oFlexObject);
-		oFlexObjectsDataSelector.checkUpdate({ reference: sReference });
+		oFlexObjectsDataSelector.checkUpdate(
+			{ reference: sReference },
+			[{ type: "addFlexObject", updatedObject: oFlexObject }]
+		);
 	};
 
 	/**
@@ -671,29 +701,56 @@ sap.ui.define([
 			_mInstances[sReference].storageResponse = filterByMaxLayer(sReference, _mInstances[sReference].unfilteredStorageResponse);
 			// Storage response has changed, recreate the flex objects
 			_mInstances[sReference].runtimePersistence = buildRuntimePersistence(
-				_mInstances[sReference].storageResponse,
+				_mInstances[sReference],
 				_mExternalData.flexObjects[sReference][_mInstances[sReference].componentId] || []
 			);
 			oFlexObjectsDataSelector.checkUpdate({ reference: sReference });
 		}
 	};
 
+	/**
+	 * Adds a dirty flex object to the flex state.
+	 *
+	 * @param {string} sReference - Flexibility reference of the app
+	 * @param {sap.ui.fl.apply._internal.flexObjects.FlexObject} oFlexObject - Flexibility object
+	 */
 	FlexState.addDirtyFlexObject = function(sReference, oFlexObject) {
+		const sAdaptationLayer = FlexInfoSession.getByReference(sReference)?.adaptationLayer;
+		const bFlexObjectsOverAdaptationLayer = !!sAdaptationLayer
+			&& LayerUtils.isOverLayer(oFlexObject.getLayer(), sAdaptationLayer);
 		// FIXME: Currently called from the ChangePersistence which might be
 		// independent of FlexState in some test cases
 		// Once the ChangePersistence is no longer used
 		// make sure to remove the safeguard
-		if (_mInstances[sReference]) {
+		if (!bFlexObjectsOverAdaptationLayer && _mInstances[sReference]) {
 			_mInstances[sReference].runtimePersistence.flexObjects.push(oFlexObject);
-			oFlexObjectsDataSelector.checkUpdate({ reference: sReference });
+			oFlexObjectsDataSelector.checkUpdate(
+				{ reference: sReference },
+				[{ type: "addFlexObject", updatedObject: oFlexObject }]
+			);
 		}
 	};
 
+	/**
+	 * Adds a list of dirty flex objects to the flex state.
+	 *
+	 * @param {string} sReference - Flexibility reference of the app
+	 * @param {array.<sap.ui.fl.apply._internal.flexObjects.FlexObject>} aFlexObjects - Flexibility objects
+	 */
 	FlexState.addDirtyFlexObjects = function(sReference, aFlexObjects) {
+		const sAdaptationLayer = FlexInfoSession.getByReference(sReference)?.adaptationLayer;
+		aFlexObjects = !sAdaptationLayer ? aFlexObjects : aFlexObjects
+		.filter((oFlexObject) => !LayerUtils.isOverLayer(oFlexObject.getLayer(), sAdaptationLayer));
+
 		if (aFlexObjects.length > 0 && _mInstances[sReference]) {
 			_mInstances[sReference].runtimePersistence.flexObjects =
 				_mInstances[sReference].runtimePersistence.flexObjects.concat(aFlexObjects);
-			oFlexObjectsDataSelector.checkUpdate({ reference: sReference });
+			oFlexObjectsDataSelector.checkUpdate(
+				{ reference: sReference },
+				aFlexObjects.map(function(oFlexObject) {
+					return { type: "addFlexObject", updatedObject: oFlexObject };
+				})
+			);
 		}
 	};
 
@@ -703,10 +760,15 @@ sap.ui.define([
 		// Once the ChangePersistence is no longer used
 		// make sure to remove the safeguard
 		if (_mInstances[sReference]) {
-			var aFlexObjects = _mInstances[sReference].runtimePersistence.flexObjects;
-			var iIndex = aFlexObjects.indexOf(oFlexObject);
-			aFlexObjects.splice(iIndex, 1);
-			oFlexObjectsDataSelector.checkUpdate({ reference: sReference });
+			const aFlexObjects = _mInstances[sReference].runtimePersistence.flexObjects;
+			const iIndex = aFlexObjects.indexOf(oFlexObject);
+			if (iIndex >= 0) {
+				aFlexObjects.splice(iIndex, 1);
+				oFlexObjectsDataSelector.checkUpdate(
+					{ reference: sReference },
+					[{ type: "removeFlexObject", updatedObject: oFlexObject }]
+				);
+			}
 		}
 	};
 
@@ -716,21 +778,32 @@ sap.ui.define([
 		// Once the ChangePersistence is no longer used
 		// make sure to remove the safeguard
 		if (_mInstances[sReference] && aFlexObjects.length > 0) {
-			var aCurrentFlexObjects = _mInstances[sReference].runtimePersistence.flexObjects;
+			let bFlexObjectRemoved = false;
+			const aCurrentFlexObjects = _mInstances[sReference].runtimePersistence.flexObjects;
 			aFlexObjects.forEach(function(oFlexObject) {
-				var iIndex = aCurrentFlexObjects.indexOf(oFlexObject);
-				aCurrentFlexObjects.splice(iIndex, 1);
+				const iIndex = aCurrentFlexObjects.indexOf(oFlexObject);
+				if (iIndex >= 0) {
+					bFlexObjectRemoved = true;
+					aCurrentFlexObjects.splice(iIndex, 1);
+				}
 			});
-			oFlexObjectsDataSelector.checkUpdate({ reference: sReference });
+			if (bFlexObjectRemoved) {
+				oFlexObjectsDataSelector.checkUpdate(
+					{ reference: sReference },
+					aFlexObjects.map(function(oFlexObject) {
+						return { type: "removeFlexObject", updatedObject: oFlexObject };
+					})
+				);
+			}
 		}
 	};
 
-	FlexState.getFlexObjectsDataSelector = function() {
-		return oFlexObjectsDataSelector;
+	FlexState.getComponentIdForReference = function(sReference) {
+		return _mInstances[sReference]?.componentId;
 	};
 
-	FlexState.getUIChanges = function(sReference) {
-		return getChangesMap(sReference).changes;
+	FlexState.getFlexObjectsDataSelector = function() {
+		return oFlexObjectsDataSelector;
 	};
 
 	FlexState.getAppDescriptorChanges = function(sReference) {

package/src/sap/ui/fl/apply/_internal/flexState/InitialPrepareFunctions.js

@@ -4,16 +4,18 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
-	"sap/base/util/includes",
 	"sap/ui/core/Lib",
 	"sap/ui/fl/apply/_internal/controlVariants/Utils",
 	"sap/ui/fl/apply/_internal/flexObjects/FlexObjectFactory",
+	"sap/ui/fl/apply/_internal/flexObjects/getVariantAuthor",
+	"sap/ui/fl/apply/_internal/flexState/changes/DependencyHandler",
 	"sap/ui/fl/Layer"
 ], function(
-	includes,
 	Lib,
 	ControlVariantUtils,
 	FlexObjectFactory,
+	getVariantAuthor,
+	DependencyHandler,
 	Layer
 ) {
 	"use strict";
@@ -26,10 +28,16 @@ sap.ui.define([
 	 * @private
 	 * @ui5-restricted
 	 */
-	var InitialPrepareFunctions = {};
+	const InitialPrepareFunctions = {};
 
 	InitialPrepareFunctions.variants = function(mPropertyBag) {
-		var aVariantIds = (mPropertyBag.storageResponse.changes.variants || [])
+		// Exchange author  of fl variant from userID to user's name
+		mPropertyBag.flexObjects.forEach((oFlexObject) => {
+			if (oFlexObject.getFileType() === "ctrl_variant") {
+				oFlexObject.setAuthor(getVariantAuthor(oFlexObject, mPropertyBag.storageResponse.authors));
+			}
+		});
+		const aVariantIds = (mPropertyBag.storageResponse.changes.variants || [])
 		.map(function(oVariantDef) {
 			return oVariantDef.fileName;
 		})
@@ -72,7 +80,7 @@ sap.ui.define([
 			var sVariantReference = oFlexObject.fileType === "ctrl_variant"
 				? oFlexObject.variantManagementReference
 				: oFlexObject.variantReference;
-			if (sVariantReference && !includes(aVariantIds, sVariantReference)) {
+			if (sVariantReference && !aVariantIds.includes(sVariantReference)) {
 				var oResourceBundle = Lib.getResourceBundleFor("sap.ui.fl");
 				var oNewVariant = FlexObjectFactory.createFlVariant({
 					id: sVariantReference,
@@ -90,10 +98,18 @@ sap.ui.define([
 		return oUpdate;
 	};
 
-	InitialPrepareFunctions.uiChanges = function() {
-		// For now this is handled by the ChangePersistence
-		// to improve performance until we can distinguish changes during
-		// the data selector invalidation
+	InitialPrepareFunctions.uiChanges = function(mPropertyBag) {
+		const oDependencyMap = DependencyHandler.createEmptyDependencyMap();
+		mPropertyBag.flexObjects.forEach((oFlexObject) => {
+			if (oFlexObject.isA("sap.ui.fl.apply._internal.flexObjects.UIChange") && !oFlexObject.getVariantReference()) {
+				DependencyHandler.addChangeAndUpdateDependencies(oFlexObject, mPropertyBag.componentId, oDependencyMap);
+			}
+		});
+		return {
+			runtimeOnlyData: {
+				liveDependencyMap: oDependencyMap
+			}
+		};
 	};
 
 	return InitialPrepareFunctions;

package/src/sap/ui/fl/apply/_internal/flexState/Loader.js

@@ -7,11 +7,13 @@
 sap.ui.define([
 	"sap/ui/base/ManagedObject",
 	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
-	"sap/ui/fl/initial/_internal/Storage"
+	"sap/ui/fl/initial/_internal/Storage",
+	"sap/ui/fl/registry/Settings"
 ], function(
 	ManagedObject,
 	ManifestUtils,
-	ApplyStorage
+	ApplyStorage,
+	Settings
 ) {
 	"use strict";
 
@@ -100,7 +102,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.apply._internal.flexState.Loader
 	 * @since 1.74
-	 * @version 1.120.6
+	 * @version 1.121.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl.apply._internal.flexState
 	 */
@@ -152,6 +154,18 @@ sap.ui.define([
 			.then(filterInvalidFileNames.bind())
 			.then(migrateSelectorFlags.bind(undefined, isMigrationNeeded(mPropertyBag.manifest)))
 			.then(formatFlexData);
+		},
+
+		/**
+		 * Load the names of variants' authors for a given application.
+		 *
+		 * @param {string} sReference - Flex reference of application
+		 * @returns {Promise<object>} Resolving with a list of maps between user's ID and name
+		 */
+		async loadVariantsAuthors(sReference) {
+			// Loading settings to check the naming feature availability and prepare access to current user during naming exchange
+			const oSettings = await Settings.getInstance();
+			return oSettings?.isVariantAuthorNameAvailable() ? ApplyStorage.loadVariantsAuthors(sReference) : {};
 		}
 	};
 });

package/src/sap/ui/fl/apply/_internal/flexState/ManifestUtils.js

@@ -64,12 +64,21 @@ function(
 		throw new Error("No Manifest received, descriptor changes are not possible");
 	}
 
+	function getAppVersionFromManifest(oManifest) {
+		if (oManifest) {
+			var oSapApp = (oManifest.getEntry) ? oManifest.getEntry("sap.app") : oManifest["sap.app"];
+			var sAppVersion = oSapApp.applicationVersion?.version;
+			return sAppVersion;
+		}
+		return undefined;
+	}
+
 	/**
 	 * Provides utility functions for handling manifests; All function work with Manifest Objects or raw manifests
 	 *
 	 * @namespace sap.ui.fl.apply._internal.flexState.ManifestUtils
 	 * @since 1.74
-	 * @version 1.120.6
+	 * @version 1.121.0
 	 * @private
 	 */
 	var ManifestUtils = {
@@ -84,6 +93,17 @@ function(
 		 */
 		getAppIdFromManifest,
 
+		/**
+		 * Returns the app version
+		 *
+		 * @param {object|sap.ui.core.Manifest} oManifest - Manifest of the component
+		 * @returns {string} Version of application if it is available in the manifest, otherwise an empty string
+		 *
+		 * @private
+		 * @ui5-restricted sap.ui.fl, sap.ui.rta
+		 */
+		getAppVersionFromManifest,
+
 		getFlexReference,
 
 		/**

package/src/sap/ui/fl/apply/_internal/flexState/UI2Personalization/UI2PersonalizationState.js

@@ -16,7 +16,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.apply._internal.flexState.UI2Personalization.UI2PersonalizationState
 	 * @since 1.75
-	 * @version 1.120.6
+	 * @version 1.121.0
 	 * @private
 	 * @ui5-restricted
 	 */