@openui5/sap.ui.fl 1.97.1 → 1.100.0

package/src/sap/ui/fl/FlexController.js

@@ -35,7 +35,7 @@ sap.ui.define([
 ) {
 	"use strict";
 
-	function revertChangesAndUpdateVariantModel(oComponent, aChanges) {
+	function revertChangesAndUpdateVariantModel(oComponent, bSkipUrlUpdate, aChanges) {
 		return Promise.resolve()
 			.then(function () {
 				if (aChanges.length !== 0) {
@@ -59,12 +59,15 @@ sap.ui.define([
 							}
 						});
 
-						URLHandler.update({
-							parameters: [],
-							updateURL: true,
-							updateHashEntry: true,
-							model: oModel
-						});
+						// Temporary fix, parameters generally should not be removed
+						if (!bSkipUrlUpdate) {
+							URLHandler.update({
+								parameters: [],
+								updateURL: true,
+								updateHashEntry: true,
+								model: oModel
+							});
+						}
 					}
 				}
 
@@ -81,20 +84,20 @@ sap.ui.define([
 	 * @alias sap.ui.fl.FlexController
 	 * @experimental Since 1.27.0
 	 * @author SAP SE
-	 * @version 1.97.1
+	 * @version 1.100.0
 	 */
 	var FlexController = function(sComponentName) {
 		this._oChangePersistence = undefined;
 		this._sComponentName = sComponentName || "";
 		if (this._sComponentName) {
-			this._createChangePersistence();
+			this._oChangePersistence = ChangePersistenceFactory.getChangePersistenceForComponent(this.getComponentName());
 		}
 	};
 
 	/**
 	 * Returns the component name of the FlexController
 	 *
-	 * @returns {String} the name of the component
+	 * @returns {string} the name of the component
 	 * @public
 	 */
 	FlexController.prototype.getComponentName = function() {
@@ -104,7 +107,7 @@ sap.ui.define([
 	/**
 	 * Sets the variant switch promise
 	 *
-	 * @param {promise} oPromise variant switch promise
+	 * @param {Promise} oPromise variant switch promise
 	 */
 	FlexController.prototype.setVariantSwitchPromise = function(oPromise) {
 		this._oVariantSwitchPromise = oPromise;
@@ -113,7 +116,7 @@ sap.ui.define([
 	/**
 	 * Returns the variant switch promise. By default this is a resolved promise
 	 *
-	 * @returns {promise} variant switch promise
+	 * @returns {Promise} variant switch promise
 	 */
 	FlexController.prototype.waitForVariantSwitch = function() {
 		if (!this._oVariantSwitchPromise) {
@@ -158,7 +161,7 @@ sap.ui.define([
 
 		var oChange = this.createBaseChange(oChangeSpecificData, oAppComponent);
 
-		return this._getChangeHandler(oChange, sControlType, oControl, JsControlTreeModifier)
+		return ChangeHandlerStorage.getChangeHandler(oChange.getChangeType(), sControlType, oControl, JsControlTreeModifier, oChange.getLayer())
 			.then(function(oChangeHandler) {
 				if (oChangeHandler) {
 					return oChangeHandler.completeChangeContent(oChange, oChangeSpecificData, {
@@ -440,21 +443,44 @@ sap.ui.define([
 		return Promise.all(aPromises);
 	};
 
+	FlexController.prototype._removeOtherLayerChanges = function(oAppComponent, sLayer, bRemoveOtherLayerChanges) {
+		if (bRemoveOtherLayerChanges && sLayer) {
+			var aLayersToReset = Object.values(Layer).filter(function(sLayerToCheck) {
+				return sLayerToCheck !== sLayer;
+			});
+			return this.removeDirtyChanges(aLayersToReset, oAppComponent, undefined, undefined, undefined, true);
+		}
+		return Promise.resolve();
+	};
+
 	/**
 	 * Saves all changes of a persistence instance.
 	 *
 	 * @param {sap.ui.core.UIComponent} [oAppComponent] - AppComponent instance
 	 * @param {boolean} [bSkipUpdateCache=false] - Indicates the cache should not be updated
 	 * @param {boolean} [bDraft=false] - Indicates if changes should be written as a draft
+	 * @param {string} [sLayer] - Layer for which the changes should be saved
+	 * @param {boolean} [bRemoveOtherLayerChanges=false] - Whether to remove changes on other layers before saving
 	 * @returns {Promise} resolving with an array of responses or rejecting with the first error
 	 * @public
 	 */
-	FlexController.prototype.saveAll = function(oAppComponent, bSkipUpdateCache, bDraft) {
-		var nParentVersion = bDraft ? Versions.getVersionsModel({
-			reference: Utils.normalizeReference(this._sComponentName),
-			layer: Layer.CUSTOMER // only the customer layer has draft active
-		}).getProperty("/persistedVersion") : undefined;
-		return this._oChangePersistence.saveDirtyChanges(oAppComponent, bSkipUpdateCache, undefined, nParentVersion)
+	FlexController.prototype.saveAll = function(oAppComponent, bSkipUpdateCache, bDraft, sLayer, bRemoveOtherLayerChanges) {
+		var sParentVersion;
+		var aDraftFilenames;
+		if (bDraft) {
+			var oVersionModel = Versions.getVersionsModel({
+				reference: Utils.normalizeReference(this._sComponentName),
+				layer: Layer.CUSTOMER // only the customer layer has draft active
+			});
+			sParentVersion = oVersionModel.getProperty("/persistedVersion");
+			var aVersions = oVersionModel.getProperty("/versions");
+			if (aVersions && aVersions.length > 0) {
+				var oLatestVersion = aVersions[0];
+				aDraftFilenames = oLatestVersion.version === sap.ui.fl.Versions.Draft ? oLatestVersion.filenames : undefined;
+			}
+		}
+		return this._removeOtherLayerChanges(oAppComponent, sLayer, bRemoveOtherLayerChanges)
+			.then(this._oChangePersistence.saveDirtyChanges.bind(this._oChangePersistence, oAppComponent, bSkipUpdateCache, undefined, sParentVersion, aDraftFilenames))
 			.then(function(oResult) {
 				if (bDraft && oResult && oResult.response) {
 					var vChangeDefinition = oResult.response;
@@ -491,29 +517,13 @@ sap.ui.define([
 
 		return this._oChangePersistence.getChangesForView(mPropertyBag)
 			.then(Applier.applyAllChangesForXMLView.bind(Applier, mPropertyBag))
-			.catch(this._handlePromiseChainError.bind(this, mPropertyBag.view));
+			.catch(handleXMLApplyError.bind(this, mPropertyBag.view));
 	};
 
-	FlexController.prototype._handlePromiseChainError = function(oView, oError) {
+	function handleXMLApplyError(oView, oError) {
 		Log.error("Error processing view " + oError + ".");
 		return oView;
-	};
-
-	/**
-	 * Retrieves the change handler for the given change and control
-	 *
-	 * @param {sap.ui.fl.Change} oChange - Change instance
-	 * @param {string} sControlType - Mame of the ui5 control type i.e. sap.m.Button
-	 * @param {sap.ui.core.Control} oControl - Control for which to retrieve the change handler
-	 * @param {sap.ui.core.util.reflection.BaseTreeModifier} oModifier - Control tree modifier
-	 * @returns {Promise} Change handler or undefined if not found, wrapped in a promise.
-	 * @private
-	 */
-	FlexController.prototype._getChangeHandler = function(oChange, sControlType, oControl, oModifier) {
-		var sChangeType = oChange.getChangeType();
-		var sLayer = oChange.getLayer();
-		return ChangeHandlerStorage.getChangeHandler(sChangeType, sControlType, oControl, oModifier, sLayer);
-	};
+	}
 
 	/**
 	 * Retrieves the changes for the complete UI5 component
@@ -542,17 +552,6 @@ sap.ui.define([
 		return this._oChangePersistence.checkForOpenDependenciesForControl(oSelector, oComponent);
 	};
 
-	/**
-	 * Creates a new instance of sap.ui.fl.Persistence based on the current component and caches the instance in a private member
-	 *
-	 * @returns {sap.ui.fl.Persistence} persistence instance
-	 * @private
-	 */
-	FlexController.prototype._createChangePersistence = function() {
-		this._oChangePersistence = ChangePersistenceFactory.getChangePersistenceForComponent(this.getComponentName());
-		return this._oChangePersistence;
-	};
-
 	/**
 	 * Reset changes on the server
 	 * If the reset is performed for an entire component, a browser reload is required.
@@ -568,23 +567,24 @@ sap.ui.define([
 	 */
 	FlexController.prototype.resetChanges = function(sLayer, sGenerator, oComponent, aSelectorIds, aChangeTypes) {
 		return this._oChangePersistence.resetChanges(sLayer, sGenerator, aSelectorIds, aChangeTypes)
-			.then(revertChangesAndUpdateVariantModel.bind(this, oComponent));
+			.then(revertChangesAndUpdateVariantModel.bind(this, oComponent, undefined));
 	};
 
 	/**
-	 * Removes unsaved changes and reverts these.
+	 * Removes unsaved changes and reverts these. If no control is provided, all dirty changes are removed.
 	 *
-	 * @param {string} sLayer - Layer for which changes shall be deleted
+	 * @param {string|string[]} vLayer - Layer or multiple layers for which changes shall be deleted
 	 * @param {sap.ui.core.Component} oComponent - Component instance
-	 * @param {sap.ui.core.Control} oControl - Control for which the changes should be removed
+	 * @param {sap.ui.core.Control} [oControl] - Control for which the changes should be removed
 	 * @param {string} [sGenerator] - Generator of changes (optional)
 	 * @param {string[]} [aChangeTypes] - Types of changes (optional)
+	 * @param {boolean} [bSkipUrlUpdate] - Whether to skip soft reload during variant model update
 	 *
 	 * @returns {Promise} Promise that resolves after the deletion took place
 	 */
-	FlexController.prototype.removeDirtyChanges = function(sLayer, oComponent, oControl, sGenerator, aChangeTypes) {
-		return this._oChangePersistence.removeDirtyChanges(sLayer, oComponent, oControl, sGenerator, aChangeTypes)
-			.then(revertChangesAndUpdateVariantModel.bind(this, oComponent));
+	FlexController.prototype.removeDirtyChanges = function(vLayer, oComponent, oControl, sGenerator, aChangeTypes, bSkipUrlUpdate) {
+		return this._oChangePersistence.removeDirtyChanges(vLayer, oComponent, oControl, sGenerator, aChangeTypes)
+		.then(revertChangesAndUpdateVariantModel.bind(this, oComponent, bSkipUrlUpdate));
 	};
 
 	/**
@@ -626,19 +626,5 @@ sap.ui.define([
 		return this._oChangePersistence.saveDirtyChanges(oAppComponent, false, aDirtyChanges);
 	};
 
-	/**
-	 * Send a flex/info request to the backend.
-	 *
-	 * @param {object} mPropertyBag Contains additional data needed for checking flex/info
-	 * @param {sap.ui.fl.Selector} mPropertyBag.selector Selector
-	 * @param {string} mPropertyBag.layer Layer on which the request is sent to the backend
-	 *
-	 * @returns {Promise<boolean>} Resolves the information if the application has content that can be reset and/or published
-	 */
-	FlexController.prototype.getResetAndPublishInfo = function(mPropertyBag) {
-		mPropertyBag.reference = this._sComponentName;
-		return this._oChangePersistence.getResetAndPublishInfo(mPropertyBag);
-	};
-
 	return FlexController;
-}, true);
+});

package/src/sap/ui/fl/FlexControllerFactory.js

@@ -10,6 +10,7 @@ sap.ui.define([
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/apply/_internal/changes/Applier",
 	"sap/ui/fl/apply/_internal/flexState/FlexState",
+	"sap/ui/fl/apply/_internal/flexState/ManifestUtils",
 	"sap/ui/fl/variants/VariantModel",
 	"sap/base/Log",
 	"sap/ui/performance/Measurement"
@@ -19,6 +20,7 @@ sap.ui.define([
 	Layer,
 	Applier,
 	FlexState,
+	ManifestUtils,
 	VariantModel,
 	Log,
 	Measurement
@@ -30,7 +32,7 @@ sap.ui.define([
 	 * @alias sap.ui.fl.FlexControllerFactory
 	 * @experimental Since 1.27.0
 	 * @author SAP SE
-	 * @version 1.97.1
+	 * @version 1.100.0
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.fl
@@ -46,7 +48,7 @@ sap.ui.define([
 	/**
 	 * Creates or returns an instance of the FlexController
 	 *
-	 * @param {String} sComponentName - Name of the component
+	 * @param {string} sComponentName - Name of the component
 	 * @returns {sap.ui.fl.FlexController} instance
 	 *
 	 */
@@ -73,7 +75,7 @@ sap.ui.define([
 	FlexControllerFactory.createForControl = function(oControl) {
 		try {
 			var oAppComponent = Utils.getAppComponentForControl(oControl);
-			var sComponentName = Utils.getComponentClassName(oAppComponent || oControl);
+			var sComponentName = ManifestUtils.getFlexReferenceForControl(oAppComponent || oControl);
 			return FlexControllerFactory.create(sComponentName);
 		} catch (oError) {
 			Log.error(oError.message, undefined, "sap.ui.fl.FlexControllerFactory");
@@ -97,7 +99,7 @@ sap.ui.define([
 
 		var sRestartingComponent = window.sessionStorage.getItem("sap.ui.rta.restart." + Layer.CUSTOMER);
 		if (sRestartingComponent) {
-			var sComponentId = Utils.getComponentClassName(oComponent);
+			var sComponentId = ManifestUtils.getFlexReferenceForControl(oComponent);
 			if (sRestartingComponent !== sComponentId && sRestartingComponent !== "true") {
 				Log.error("an application component was started " +
 					"which does not match the component for which the restart was triggered:\n" +

package/src/sap/ui/fl/LayerUtils.js

@@ -41,7 +41,7 @@ sap.ui.define([
 	 *
 	 * @namespace sap.ui.fl.LayerUtils
 	 * @author SAP SE
-	 * @version 1.97.1
+	 * @version 1.100.0
 	 */
 	var LayerUtils = {
 		_mLayersIndex: mLayersIndex,