@openui5/sap.ui.fl 1.140.0 → 1.141.1

package/src/sap/ui/fl/initial/_internal/StorageUtils.js

@@ -5,17 +5,19 @@
  */
 
 sap.ui.define([
+	"sap/base/util/isEmptyObject",
+	"sap/base/util/ObjectPath",
 	"sap/base/Log",
 	"sap/ui/fl/initial/_internal/FlexConfiguration",
 	"sap/ui/fl/Layer",
-	"sap/ui/fl/LayerUtils",
-	"sap/base/util/isEmptyObject"
+	"sap/ui/fl/LayerUtils"
 ], function(
+	isEmptyObject,
+	ObjectPath,
 	Log,
 	FlexConfiguration,
 	Layer,
-	LayerUtils,
-	isEmptyObject
+	LayerUtils
 ) {
 	"use strict";
 
@@ -25,7 +27,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.initial._internal.StorageUtils
 	 * @since 1.74
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 * @private
 	 * @ui5-restricted sap.ui.fl.initial._internal.Storage, sap.ui.fl.write._internal.Storage,
 	 * 	sap.ui.fl.initial._internal.connectors.ObjectStorageConnector, sap.ui.fl.initial._internal.connectors.ObjectPathConnector
@@ -104,6 +106,34 @@ sap.ui.define([
 		});
 	}
 
+	function getChangeCategoryPath(oChangeDefinition) {
+		switch (oChangeDefinition.fileType) {
+			case "change":
+				if (oChangeDefinition.selector && oChangeDefinition.selector.persistencyKey) {
+					return ["comp", "changes"];
+				}
+				if (oChangeDefinition.variantReference) {
+					return "variantDependentControlChanges";
+				}
+				if (oChangeDefinition.appDescriptorChange) {
+					return "appDescriptorChanges";
+				}
+				return "changes";
+			case "ctrl_variant":
+				return "variants";
+			case "ctrl_variant_change":
+				return "variantChanges";
+			case "ctrl_variant_management_change":
+				return "variantManagementChanges";
+			case "variant":
+				return ["comp", "variants"];
+			case "annotation_change":
+				return "annotationChanges";
+			default:
+				return "";
+		}
+	}
+
 	/**
 	 * Loads the connectors from the given namespaces.
 	 * This function is replaced in the Vanilla Flex bundle with a custom implementation.
@@ -343,11 +373,39 @@ sap.ui.define([
 	 * @ui5-restricted sap.ui.fl
 	 */
 	StorageUtils.isStorageResponseFilled = function(oResponse) {
-		return Object.keys(oResponse || {}).some(function(sKey) {
-			if (Array.isArray(oResponse[sKey])) {
-				return oResponse[sKey].length !== 0;
+		const oUI2Available = !isEmptyObject(oResponse.ui2personalization);
+		return oUI2Available || StorageUtils.getAllFlexObjectNamespaces().some(function(sKey) {
+			return ObjectPath.get(sKey, oResponse)?.length > 0;
+		});
+	};
+
+	/**
+	 * Updates the storage response with the provided updates by directly mutating the given response.
+	 *
+	 * @param {object} oResponse - Storage response to apply the updates to.
+	 * @param {sap.ui.fl.apply._internal.flexState.dataSelector.UpdateInfo[]} aUpdates - The updates to apply to the storage response.
+	 */
+	StorageUtils.updateStorageResponse = function(oResponse, aUpdates) {
+		aUpdates.forEach((oUpdate) => {
+			if (oUpdate.type === "ui2") {
+				oResponse.changes.ui2personalization = oUpdate.newData;
+			} else {
+				const vPath = getChangeCategoryPath(oUpdate.flexObject);
+				const sFileName = oUpdate.flexObject.fileName;
+				const aCache = ObjectPath.get(vPath, oResponse.changes);
+				switch (oUpdate.type) {
+					case "add":
+						aCache.push(oUpdate.flexObject);
+						break;
+					case "delete":
+						aCache.splice(aCache.findIndex((oFlexObject) => oFlexObject.fileName === sFileName), 1);
+						break;
+					case "update":
+						aCache.splice(aCache.findIndex((oFlexObject) => oFlexObject.fileName === sFileName), 1, oUpdate.flexObject);
+						break;
+					default:
+				}
 			}
-			return !isEmptyObject(oResponse[sKey]);
 		});
 	};
 

package/src/sap/ui/fl/initial/_internal/changeHandlers/ChangeHandlerRegistration.js

@@ -84,7 +84,7 @@ sap.ui.define([
 		 * @alias sap.ui.fl.registry.ChangeHandlerRegistration
 		 *
 		 * @author SAP SE
-		 * @version 1.140.0
+		 * @version 1.141.1
 		 * @private
 		 * @ui5-restricted sap.ui.fl
 		 *

package/src/sap/ui/fl/initial/_internal/changeHandlers/ChangeHandlerStorage.js

@@ -23,7 +23,7 @@ sap.ui.define([
 	 * @alias sap.ui.fl.registry.ChangeHandlerStorage
 	 *
 	 * @author SAP SE
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 * @private
 	 * @ui5-restricted sap.ui.fl
 	 *
@@ -135,10 +135,17 @@ sap.ui.define([
 		const sSkipNext = "ChangeHandlerStorage.registerChangeHandlersForControl.skip_next_then";
 
 		if (typeof mChangeHandlers === "string") {
-			oPromise = requireAsync(`${mChangeHandlers}.flexibility`)
-			.catch(function(oError) {
-				Log.error(`Flexibility change handler registration failed.\nControlType: ${sControlType}\n${oError.message}`);
-				return Promise.resolve(sSkipNext); // continue without a registration
+			oPromise = new Promise((resolve) => {
+				// TODO: The setTimeout is added to circumvent dependency issues caused by synchronous module loading.
+				// This shall be removed once sync loading is not used anymore in UI5. #todos10
+				setTimeout(() => {
+					requireAsync(`${mChangeHandlers}.flexibility`)
+					.then(resolve)
+					.catch(function(oError) {
+						Log.error(`Flexibility change handler registration failed.\nControlType: ${sControlType}\n${oError.message}`);
+						resolve(sSkipNext); // continue without a registration
+					});
+				}, 0);
 			});
 		}
 

package/src/sap/ui/fl/initial/_internal/connectors/Utils.js

@@ -62,7 +62,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.initial._internal.connectors.Utils
 	 * @since 1.70
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 * @private
 	 * @ui5-restricted sap.ui.fl.initial._internal.connectors, sap.ui.fl.write._internal.connectors, sap.ui.fl.write._internal.transport
 	 */

package/src/sap/ui/fl/{apply → initial}/_internal/preprocessors/ControllerExtension.js

@@ -7,14 +7,18 @@
 sap.ui.define([
 	"sap/base/Log",
 	"sap/ui/core/Component",
-	"sap/ui/fl/apply/_internal/flexState/FlexState",
+	"sap/ui/fl/initial/_internal/Loader",
 	"sap/ui/fl/initial/_internal/ManifestUtils",
+	"sap/ui/fl/initial/_internal/StorageUtils",
+	"sap/ui/fl/requireAsync",
 	"sap/ui/fl/Utils"
 ], function(
 	Log,
 	Component,
-	FlexState,
+	Loader,
 	ManifestUtils,
+	StorageUtils,
+	requireAsync,
 	Utils
 ) {
 	"use strict";
@@ -26,7 +30,7 @@ sap.ui.define([
 	 * @class
 	 * @constructor
 	 * @author SAP SE
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 * @since 1.27.0
 	 * @private
 	 * @ui5-restricted sap.ui.fl, sap.ui.core
@@ -102,7 +106,14 @@ sap.ui.define([
 			}
 			var sFlexReference = ManifestUtils.getFlexReferenceForControl(oAppComponent);
 
-			return FlexState.waitForInitialization(sFlexReference).then(() => {
+			return Loader.waitForInitialization(sFlexReference).then(async function() {
+				const oFlexData = Loader.getCachedFlexData(sFlexReference);
+				if (!StorageUtils.isStorageResponseFilled(oFlexData?.changes)) {
+					return [];
+				}
+
+				const FlexState = await requireAsync("sap/ui/fl/apply/_internal/flexState/FlexState");
+				await FlexState.waitForInitialization(sFlexReference);
 				const aFlexObjects = FlexState.getFlexObjectsDataSelector().get({reference: sFlexReference});
 				var aExtensionModules = aFlexObjects.filter(function(oChange) {
 					return isCodeExt(oChange) && isForController(sControllerName, oChange);

package/src/sap/ui/fl/{apply → initial}/_internal/preprocessors/RegistrationDelegator.js

@@ -13,14 +13,11 @@ sap.ui.define([
 	"sap/ui/fl/apply/_internal/changes/descriptor/Preprocessor",
 	"sap/ui/fl/apply/_internal/flexState/communication/FLPAboutInfo",
 	"sap/ui/fl/apply/_internal/preprocessors/ComponentLifecycleHooks",
-	"sap/ui/fl/apply/api/DelegateMediatorAPI",
-	"sap/ui/fl/changeHandler/ChangeAnnotation",
-	"sap/ui/fl/initial/_internal/changeHandlers/ChangeHandlerRegistration",
 	"sap/ui/fl/initial/_internal/ManifestUtils",
 	"sap/ui/base/DesignTime",
 	// the lower 2 are set as a callback in the "register...Processors" which are not detected as dependencies from the preload-building
-	"sap/ui/fl/apply/_internal/preprocessors/ControllerExtension",
-	"sap/ui/fl/apply/_internal/preprocessors/XmlPreprocessor"
+	"sap/ui/fl/initial/_internal/preprocessors/ControllerExtension",
+	"sap/ui/fl/initial/_internal/preprocessors/XmlPreprocessor"
 ], function(
 	MvcControllerExtensionProvider,
 	XMLView,
@@ -29,22 +26,20 @@ sap.ui.define([
 	Preprocessor,
 	FLPAboutInfo,
 	ComponentLifecycleHooks,
-	DelegateMediatorAPI,
-	ChangeAnnotation,
-	ChangeHandlerRegistration,
 	ManifestUtils,
 	DesignTime
 ) {
 	"use strict";
 
 	/**
-	 * This class takes care of all the registration (hooks) needed to run flex!
+	 * This module registers everything needed for the app to start,
+	 * without flex changes being involved yet.
 	 *
 	 * @name sap.ui.fl.apply._internal.preprocessors.RegistrationDelegator
 	 * @class
 	 * @constructor
 	 * @author SAP SE
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 * @since 1.43.0
 	 * @private
 	 */
@@ -53,15 +48,6 @@ sap.ui.define([
 		ComponentHooks.onInstanceCreated.register(ComponentLifecycleHooks.instanceCreatedHook);
 	}
 
-	function registerChangeHandlers() {
-		ChangeHandlerRegistration.registerPredefinedChangeHandlers();
-		ChangeHandlerRegistration.getChangeHandlersOfLoadedLibsAndRegisterOnNewLoadedLibs();
-		ChangeHandlerRegistration.registerAnnotationChangeHandler({
-			changeHandler: ChangeAnnotation,
-			isDefaultChangeHandler: true
-		});
-	}
-
 	function registerOnModelCreated() {
 		ComponentHooks.onModelCreated.register(ComponentLifecycleHooks.modelCreatedHook);
 	}
@@ -71,12 +57,12 @@ sap.ui.define([
 	}
 
 	function registerExtensionProvider() {
-		MvcControllerExtensionProvider.registerExtensionProvider("sap/ui/fl/apply/_internal/preprocessors/ControllerExtension");
+		MvcControllerExtensionProvider.registerExtensionProvider("sap/ui/fl/initial/_internal/preprocessors/ControllerExtension");
 	}
 
 	function registerXMLPreprocessor() {
 		if (XMLView.registerPreprocessor) {
-			XMLView.registerPreprocessor("viewxml", "sap.ui.fl.apply._internal.preprocessors.XmlPreprocessor");
+			XMLView.registerPreprocessor("viewxml", "sap.ui.fl.initial._internal.preprocessors.XmlPreprocessor");
 		}
 	}
 
@@ -98,21 +84,6 @@ sap.ui.define([
 		ExtensionPoint.registerExtensionProvider(getExtensionPointProvider);
 	}
 
-	function registerModelSpecificReadDelegates() {
-		DelegateMediatorAPI.registerReadDelegate({
-			modelType: "sap.ui.model.odata.v4.ODataModel",
-			delegate: "sap/ui/fl/write/_internal/delegates/ODataV4ReadDelegate"
-		});
-		DelegateMediatorAPI.registerReadDelegate({
-			modelType: "sap.ui.model.odata.v2.ODataModel",
-			delegate: "sap/ui/fl/write/_internal/delegates/ODataV2ReadDelegate"
-		});
-		DelegateMediatorAPI.registerReadDelegate({
-			modelType: "sap.ui.model.odata.ODataModel",
-			delegate: "sap/ui/fl/write/_internal/delegates/ODataV2ReadDelegate"
-		});
-	}
-
 	function registerFLPAboutInfo() {
 		FLPAboutInfo.initialize();
 	}
@@ -123,14 +94,12 @@ sap.ui.define([
 	 * @public
 	 */
 	RegistrationDelegator.registerAll = function() {
-		registerChangeHandlers();
 		registerLoadComponentEventHandler();
 		registerExtensionProvider();
 		registerChangesInComponent();
 		registerXMLPreprocessor();
 		registerDescriptorChangeHandler();
 		registerExtensionPointProvider();
-		registerModelSpecificReadDelegates();
 		registerOnModelCreated();
 		registerFLPAboutInfo();
 	};

package/src/sap/ui/fl/{apply → initial}/_internal/preprocessors/XmlPreprocessor.js

@@ -6,28 +6,24 @@
 
 sap.ui.define([
 	"sap/base/util/merge",
+	"sap/base/Log",
 	"sap/ui/core/util/reflection/XmlTreeModifier",
 	"sap/ui/core/Component",
-	"sap/ui/fl/apply/_internal/changes/Applier",
-	"sap/ui/fl/apply/_internal/changes/Utils",
-	"sap/ui/fl/apply/_internal/flexState/controlVariants/VariantManagementState",
-	"sap/ui/fl/apply/_internal/flexState/FlexObjectState",
-	"sap/ui/fl/apply/_internal/flexState/FlexState",
+	"sap/ui/fl/initial/_internal/Loader",
 	"sap/ui/fl/initial/_internal/ManifestUtils",
-	"sap/ui/fl/Utils",
-	"sap/base/Log"
+	"sap/ui/fl/initial/_internal/StorageUtils",
+	"sap/ui/fl/requireAsync",
+	"sap/ui/fl/Utils"
 ], function(
 	merge,
+	Log,
 	XmlTreeModifier,
 	Component,
-	Applier,
-	ChangesUtils,
-	VariantManagementState,
-	FlexObjectState,
-	FlexState,
+	Loader,
 	ManifestUtils,
-	Utils,
-	Log
+	StorageUtils,
+	requireAsync,
+	Utils
 ) {
 	"use strict";
 
@@ -38,7 +34,7 @@ sap.ui.define([
 	 * @class
 	 * @constructor
 	 * @author SAP SE
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 * @since 1.27.0
 	 * @private
 	 */
@@ -69,8 +65,10 @@ sap.ui.define([
 	 * @returns {Promise} resolving with an array of changes
 	 * @public
 	 */
-	function getChangesForView(mPropertyBag) {
+	async function getChangesForView(mPropertyBag) {
+		const FlexObjectState = await requireAsync("sap/ui/fl/apply/_internal/flexState/FlexObjectState");
 		const aAllApplicableUIChanges = FlexObjectState.getAllApplicableUIChanges(mPropertyBag.reference);
+		const ChangesUtils = await requireAsync("sap/ui/fl/apply/_internal/changes/Utils");
 		return aAllApplicableUIChanges.filter(ChangesUtils.isChangeInView.bind(undefined, mPropertyBag));
 	}
 
@@ -105,6 +103,13 @@ sap.ui.define([
 
 			const sReference = ManifestUtils.getFlexReferenceForControl(oAppComponent);
 
+			await Loader.waitForInitialization(sReference);
+			const oFlexData = Loader.getCachedFlexData(sReference);
+			if (!StorageUtils.isStorageResponseFilled(oFlexData.changes)) {
+				return oView;
+			}
+
+			const FlexState = await requireAsync("sap/ui/fl/apply/_internal/flexState/FlexState");
 			await FlexState.waitForInitialization(sReference);
 
 			const mPropertyBag = merge({
@@ -113,8 +118,9 @@ sap.ui.define([
 				view: oView,
 				reference: sReference
 			}, mProperties);
-			const aChanges = getChangesForView(mPropertyBag);
+			const aChanges = await getChangesForView(mPropertyBag);
 
+			const Applier = await requireAsync("sap/ui/fl/apply/_internal/changes/Applier");
 			await Applier.applyAllChangesForXMLView(mPropertyBag, aChanges);
 
 			Log.debug(`flex processing view ${mProperties.id} finished`);
@@ -159,13 +165,15 @@ sap.ui.define([
 		const sFlexReference = ManifestUtils.getFlexReferenceForControl(oAppComponent);
 		let sCacheKey = XmlPreprocessor.NOTAG;
 		if (sFlexReference) {
-			const oWrappedChangeFileContent = await FlexState.getStorageResponse(sFlexReference);
-			if (oWrappedChangeFileContent?.cacheKey) {
-				sCacheKey = trimEtag(oWrappedChangeFileContent.cacheKey);
+			await Loader.waitForInitialization(sFlexReference);
+			const oFlexData = Loader.getCachedFlexData(sFlexReference);
+			if (oFlexData && oFlexData.cacheKey && StorageUtils.isStorageResponseFilled(oFlexData.changes)) {
+				sCacheKey = trimEtag(oFlexData.cacheKey);
 
 				// If there are no changes, the standard variant is created after the variant management control is instantiated
 				// When the cache key is calculated before this happens, the standard variant id is unknown
 				// To avoid inconsistencies between page load and navigation scenarios, all standard variants are filtered
+				const VariantManagementState = await requireAsync("sap/ui/fl/apply/_internal/flexState/controlVariants/VariantManagementState");
 				const aFilteredCurrentControlVariantIds = VariantManagementState.getAllCurrentVariants(sFlexReference)
 				.filter((oVariant) => !oVariant.getStandardVariant())
 				.map((oVariant) => oVariant.getId());

package/src/sap/ui/fl/initial/_internal/storageResultDisassemble.js

@@ -51,7 +51,7 @@ function(
 	 * @name sap.ui.fl.initial._internal.storageResultDisassemble
 	 * @function
 	 * @since 1.70
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 * @private
 	 * @ui5-restricted sap.ui.fl.initial._internal.Storage
 	 * Disassembles a response with a variant section into one or more plain responses.

package/src/sap/ui/fl/initial/api/InitialFlexAPI.js

@@ -19,7 +19,7 @@ sap.ui.define([
 	 * @namespace
 	 * @alias module:sap/ui/fl/initial/api/InitialFlexAPI
 	 * @since 1.132
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 * @private
 	 * @ui5-restricted
 	 */

package/src/sap/ui/fl/interfaces/BaseLoadConnector.js

@@ -12,7 +12,7 @@ sap.ui.define([], function() {
 	 *
 	 * @name sap.ui.fl.interfaces.BaseLoadConnector
 	 * @since 1.79
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 *
 	 * @private
 	 * @ui5-restricted SAP Web IDE (Visual Editor), UX Tools

package/src/sap/ui/fl/interfaces/Delegate.js

@@ -106,7 +106,7 @@ sap.ui.define([
 	 * @private
 	 * @ui5-restricted
 	 * @since 1.78
-	 * @version 1.140.0
+	 * @version 1.141.1
 	 *
 	 * @private
 	 * @ui5-restricted