@openui5/sap.ui.rta 1.120.6 → 1.121.0

package/src/sap/ui/rta/plugin/additionalElements/AdditionalElementsPlugin.js

@@ -7,33 +7,35 @@
 sap.ui.define([
 	"sap/base/util/each",
 	"sap/base/Log",
+	"sap/ui/core/EventBus",
 	"sap/ui/core/IconPool",
 	"sap/ui/core/Lib",
 	"sap/ui/dt/OverlayRegistry",
 	"sap/ui/dt/OverlayUtil",
 	"sap/ui/fl/write/api/FieldExtensibility",
+	"sap/ui/rta/plugin/additionalElements/ActionExtractor",
 	"sap/ui/rta/plugin/additionalElements/AddElementsDialog",
 	"sap/ui/rta/plugin/additionalElements/AdditionalElementsAnalyzer",
-	"sap/ui/rta/plugin/Plugin",
-	"sap/ui/rta/Utils",
 	"sap/ui/rta/plugin/additionalElements/AdditionalElementsUtils",
 	"sap/ui/rta/plugin/additionalElements/CommandBuilder",
-	"sap/ui/rta/plugin/additionalElements/ActionExtractor"
+	"sap/ui/rta/plugin/Plugin",
+	"sap/ui/rta/Utils"
 ], function(
 	each,
 	Log,
+	EventBus,
 	IconPool,
 	Lib,
 	OverlayRegistry,
 	OverlayUtil,
 	FieldExtensibility,
+	ActionExtractor,
 	AddElementsDialog,
 	AdditionalElementsAnalyzer,
-	Plugin,
-	Utils,
 	AdditionalElementsUtils,
 	CommandBuilder,
-	ActionExtractor
+	Plugin,
+	Utils
 ) {
 	"use strict";
 
@@ -47,23 +49,33 @@ sap.ui.define([
 		});
 	}
 
-	function handleExtensibility(oControl) {
-		return FieldExtensibility.onControlSelected(oControl)
-
-		.then(function() {
-			return Promise.all([
-				Utils.isServiceUpToDate(oControl),
-				FieldExtensibility.isExtensibilityEnabled(oControl)
-			]);
-		})
-
-		.then(function(aResult) {
-			var bExtensibilityEnabled = !!aResult[1];
-			if (bExtensibilityEnabled) {
-				return FieldExtensibility.getExtensionData(oControl);
+	/**
+	 * Utility function to check if the OData service is updated in the meantime
+	 *
+	 * @param {sap.ui.core.Control} oControl - Control to be checked
+	 * @returns {Promise} resolves if service is up to date, rejects otherwise
+	 */
+	async function isServiceUpToDate(oControl) {
+		const oModel = oControl.getModel();
+		if (oModel && oModel.sServiceUrl) {
+			const bServiceOutdated = await FieldExtensibility.isServiceOutdated(oModel.sServiceUrl);
+			if (bServiceOutdated) {
+				FieldExtensibility.setServiceValid(oModel.sServiceUrl);
+				// needs FLP to trigger UI restart popup
+				EventBus.getInstance().publish("sap.ui.core.UnrecoverableClientStateCorruption", "RequestReload", {});
 			}
-			return undefined;
-		});
+		}
+	}
+
+	async function handleExtensibility(oControl) {
+		await FieldExtensibility.onControlSelected(oControl);
+		const bExtensibilityEnabled = await FieldExtensibility.isExtensibilityEnabled(oControl);
+
+		if (bExtensibilityEnabled) {
+			await isServiceUpToDate(oControl);
+			return FieldExtensibility.getExtensionData(oControl);
+		}
+		return undefined;
 	}
 
 	/**
@@ -77,7 +89,7 @@ sap.ui.define([
 	 * @class The plugin allows to add additional elements that exist either hidden in the UI or in the OData service
 	 * @extends sap.ui.rta.plugin.Plugin
 	 * @author SAP SE
-	 * @version 1.120.6
+	 * @version 1.121.0
 	 * @constructor
 	 * @private
 	 * @since 1.44
@@ -86,6 +98,7 @@ sap.ui.define([
 	var AdditionalElementsPlugin = Plugin.extend("sap.ui.rta.plugin.additionalElements.AdditionalElementsPlugin", {
 		// eslint-disable-next-line object-shorthand
 		constructor: function(...aArgs) {
+			this._getMenuItemsPromise = Promise.resolve();
 			const [oPropertyBag] = aArgs;
 			oPropertyBag.dialog = new AddElementsDialog();
 			Plugin.apply(this, aArgs);
@@ -280,7 +293,14 @@ sap.ui.define([
 
 				.then(function() {
 					var aSelectedElements = this.getDialog().getSelectedElements();
-					return CommandBuilder.createCommands(mParents, vSiblingElement, mActions, iIndex, aSelectedElements, sAggregationName, this);
+					return CommandBuilder.createCommands(mParents,
+						vSiblingElement,
+						mActions,
+						iIndex,
+						aSelectedElements,
+						sAggregationName,
+						this
+					);
 				}.bind(this))
 
 				.then(function() {
@@ -306,7 +326,13 @@ sap.ui.define([
 		},
 
 		_setDialogTitle(mActions, oParentElement, sControlName) {
-			var sDialogTitle = AdditionalElementsUtils.getText("HEADER_ADDITIONAL_ELEMENTS", mActions, oParentElement, PLURAL, sControlName);
+			var sDialogTitle = AdditionalElementsUtils.getText(
+				"HEADER_ADDITIONAL_ELEMENTS",
+				mActions,
+				oParentElement,
+				PLURAL,
+				sControlName
+			);
 			this.getDialog().setTitle(sDialogTitle);
 		},
 
@@ -324,7 +350,10 @@ sap.ui.define([
 		 * @protected
 		 */
 		_isEditable(oOverlay, mPropertyBag) {
-			return Promise.all([this._isEditableCheck(mPropertyBag.sourceElementOverlay, true), this._isEditableCheck(mPropertyBag.sourceElementOverlay, false)])
+			return Promise.all([
+				this._isEditableCheck(mPropertyBag.sourceElementOverlay, true),
+				this._isEditableCheck(mPropertyBag.sourceElementOverlay, false)
+			])
 			.then(function(aPromiseValues) {
 				return {
 					asSibling: aPromiseValues[0],
@@ -336,43 +365,36 @@ sap.ui.define([
 			});
 		},
 
-		_isEditableCheck(oOverlay, bOverlayIsSibling) {
-			return Promise.resolve()
-			.then(function() {
-				var mParents = AdditionalElementsUtils.getParents(bOverlayIsSibling, oOverlay, this);
+		async _isEditableCheck(oOverlay, bOverlayIsSibling) {
+			var mParents = AdditionalElementsUtils.getParents(bOverlayIsSibling, oOverlay, this);
 
-				if (!mParents.relevantContainerOverlay) {
-					return false;
-				}
+			if (!mParents.relevantContainerOverlay) {
+				return false;
+			}
 
-				return ActionExtractor.getActions(bOverlayIsSibling, oOverlay, this, true, this.getDesignTime())
-				.then(function(mActions) {
-					this.clearCachedElements();
-					return Utils.doIfAllControlsAreAvailable([oOverlay, mParents.parentOverlay], function() {
-						var bEditable = false;
-						// For the sibling case, check if anything is available for the same aggregation
-						if (bOverlayIsSibling) {
-							bEditable = isThereAnAggregationActionForSameAggregation(mActions, mParents);
-						} else {
-							bEditable = Object.keys(mActions).some(function(sAggregationName) {
-								if (mActions[sAggregationName].addViaDelegate) {
-									bEditable = this.checkAggregationsOnSelf(mParents.parentOverlay, "add", undefined, "delegate");
-								}
-								if (!bEditable && mActions[sAggregationName].reveal) {
-									return true;
-								}
-								return bEditable;
-							}.bind(this));
+			const mActions = await ActionExtractor.getActions(bOverlayIsSibling, oOverlay, this, true, this.getDesignTime());
+			// Prevents clear cached elements during the getMenuItems promise is pending
+			await this._getMenuItemsPromise;
+			this.clearCachedElements();
+			return Utils.doIfAllControlsAreAvailable([oOverlay, mParents.parentOverlay], function() {
+				var bEditable = false;
+				// For the sibling case, check if anything is available for the same aggregation
+				if (bOverlayIsSibling) {
+					bEditable = isThereAnAggregationActionForSameAggregation(mActions, mParents);
+				} else {
+					bEditable = Object.keys(mActions).some(function(sAggregationName) {
+						if (mActions[sAggregationName].addViaDelegate) {
+							bEditable = this.checkAggregationsOnSelf(mParents.parentOverlay, "add", undefined, "delegate");
+						}
+						if (!bEditable && mActions[sAggregationName].reveal) {
+							return true;
 						}
 						return bEditable;
 					}.bind(this));
-				}.bind(this))
-				.then(function(bEditable) {
-					bEditable &&=
-								this.hasStableId(oOverlay) // don't confuse the user/Web IDE by an editable overlay without stable ID
-								&& this.hasStableId(mParents.parentOverlay);
-					return bEditable;
-				}.bind(this));
+				}
+
+				bEditable &&= this.hasStableId(oOverlay) && this.hasStableId(mParents.parentOverlay);
+				return bEditable;
 			}.bind(this));
 		},
 
@@ -408,8 +430,12 @@ sap.ui.define([
 					aPromises.push({
 						aggregation: sAggregationName,
 						elementPromises: [
-							mActions.reveal ? AdditionalElementsAnalyzer.enhanceInvisibleElements(mParents.parent, mActions) : Promise.resolve([]),
-							mActions.addViaDelegate ? AdditionalElementsAnalyzer.getUnrepresentedDelegateProperties(mParents.parent, mActions.addViaDelegate) : Promise.resolve([])
+							mActions.reveal
+								? AdditionalElementsAnalyzer.enhanceInvisibleElements(mParents.parent, mActions)
+								: Promise.resolve([]),
+							mActions.addViaDelegate
+								? AdditionalElementsAnalyzer.getUnrepresentedDelegateProperties(mParents.parent, mActions.addViaDelegate)
+								: Promise.resolve([])
 						]
 					});
 				});
@@ -446,8 +472,13 @@ sap.ui.define([
 			var aMenuItems = [];
 			var oMenuItem;
 			this.clearCachedElements();
+			// Prevents clearing of cached elements before menu items are build. This happens when evaluate editable is running in parallel
+			this._getMenuItemsPromise =
 			// getAllElements() is called to set cached elements for the overlay -> which will result in menu item being enabled
-			return Promise.all([this.getAllElements(false, aElementOverlays), this.getAllElements(true, aElementOverlays)])
+			Promise.all([
+				this.getAllElements(false, aElementOverlays),
+				this.getAllElements(true, aElementOverlays)
+			])
 			.then(function(aElementsWithAggregations) {
 				var bHasChildren = aElementsWithAggregations[0].length > 0;
 				var bHasMultipleAggregations = aElementsWithAggregations[0].length > 1;
@@ -456,22 +487,51 @@ sap.ui.define([
 				var bIsAvailableForSibling = this.isAvailable(aElementOverlays, true);
 				if (bIsAvailableForSibling && (!bIsAvailableForChildren || !bHasChildren)) {
 					// Case 1: Only siblings -> No submenu required
-					oMenuItem = this._buildMenuItem("CTX_ADD_ELEMENTS_AS_SIBLING", true, aElementOverlays, aElementsWithAggregations, false);
+					oMenuItem = this._buildMenuItem(
+						"CTX_ADD_ELEMENTS_AS_SIBLING",
+						true,
+						aElementOverlays,
+						aElementsWithAggregations,
+						false
+					);
 				} else if (!bIsAvailableForSibling && bIsAvailableForChildren && !bHasMultipleAggregations) {
 					// Case 2: Only children, one aggregation -> No submenu required
-					oMenuItem = this._buildMenuItem("CTX_ADD_ELEMENTS_AS_CHILD", false, aElementOverlays, aElementsWithAggregations, false);
+					oMenuItem = this._buildMenuItem(
+						"CTX_ADD_ELEMENTS_AS_CHILD",
+						false,
+						aElementOverlays,
+						aElementsWithAggregations,
+						false
+					);
 				} else if (!bIsAvailableForSibling && bIsAvailableForChildren && bHasMultipleAggregations) {
 					// Case 3: Only children, multiple aggregations -> Submenu required
-					oMenuItem = this._buildMenuItem("CTX_ADD_ELEMENTS_AS_CHILD", false, aElementOverlays, aElementsWithAggregations, true);
+					oMenuItem = this._buildMenuItem(
+						"CTX_ADD_ELEMENTS_AS_CHILD",
+						false,
+						aElementOverlays,
+						aElementsWithAggregations,
+						true
+					);
 				} else if (bIsAvailableForChildren && bIsAvailableForSibling && bHasChildren && bHasSiblings) {
 					// Case 4: Children and siblings -> Submenu required
-					oMenuItem = this._buildMenuItem("CTX_ADD_ELEMENTS_CHILD_AND_SIBLING", false, aElementOverlays, aElementsWithAggregations, true);
+					oMenuItem = this._buildMenuItem(
+						"CTX_ADD_ELEMENTS_CHILD_AND_SIBLING",
+						false,
+						aElementOverlays,
+						aElementsWithAggregations,
+						true
+					);
 				}
 				if (oMenuItem) {
-					aMenuItems.push(this.enhanceItemWithResponsibleElement(oMenuItem, aElementOverlays, ["addViaDelegate", "reveal", "custom"]));
+					aMenuItems.push(this.enhanceItemWithResponsibleElement(
+						oMenuItem,
+						aElementOverlays,
+						["addViaDelegate", "reveal", "custom"]
+					));
 				}
 				return aMenuItems;
 			}.bind(this));
+			return this._getMenuItemsPromise;
 		},
 
 		_buildMenuItem(sPluginId, bOverlayIsSibling, aElementOverlays, aElementsWithAggregations, bHasSubMenu) {
@@ -549,7 +609,14 @@ sap.ui.define([
 					}.bind(this),
 					handler: function(bOverlayIsSibling, aElementOverlays) {
 						// showAvailableElements has optional parameters
-						return this.showAvailableElements(bOverlayIsSibling, sAggregationName, aElementOverlays, undefined, undefined, sDisplayText);
+						return this.showAvailableElements(
+							bOverlayIsSibling,
+							sAggregationName,
+							aElementOverlays,
+							undefined,
+							undefined,
+							sDisplayText
+						);
 					}.bind(this, bOverlayIsSibling),
 					icon: bOverlayIsSibling ? "sap-icon://BusinessSuiteInAppSymbols/icon-add-outside" : "sap-icon://add"
 				};

package/src/sap/ui/rta/plugin/additionalElements/AdditionalElementsUtils.js

@@ -17,7 +17,7 @@ sap.ui.define([
 	 * Helper object containing methods for the AdditionalElements plugin
 	 *
 	 * @author SAP SE
-	 * @version 1.120.6
+	 * @version 1.121.0
 	 * @private
 	 * @since 1.94
 	 */

package/src/sap/ui/rta/plugin/additionalElements/CommandBuilder.js

@@ -25,7 +25,7 @@ sap.ui.define([
 	 * Helper object to build the RTA commands resulting from the AdditionalElements Plugin
 	 *
 	 * @author SAP SE
-	 * @version 1.120.6
+	 * @version 1.121.0
 	 * @private
 	 * @since 1.94
 	 */
@@ -199,6 +199,10 @@ sap.ui.define([
 		return sUri;
 	}
 
+	function createFieldLabelId(oParentControl, sEntityType, sBindingPath) {
+		return (`${oParentControl.getId()}_${sEntityType}_${sBindingPath}`).replace("/", "_");
+	}
+
 	function createAddViaDelegateCommand(mPropertyBag, oParentAggregationDTMetadata) {
 		var oSelectedElement = mPropertyBag.selectedElement;
 		var mParents = mPropertyBag.parents;
@@ -216,7 +220,7 @@ sap.ui.define([
 		var sServiceUri = getODataServiceUriFromManifest(oManifest);
 
 		return oPlugin.getCommandFactory().getCommandFor(mParents.parent, sCommandName, {
-			newControlId: Utils.createFieldLabelId(oParent, oSelectedElement.entityType, oSelectedElement.bindingPath),
+			newControlId: createFieldLabelId(oParent, oSelectedElement.entityType, oSelectedElement.bindingPath),
 			index: iIndex !== undefined ? iIndex : iAddTargetIndex,
 			bindingString: oSelectedElement.bindingPath,
 			entityType: oSelectedElement.entityType, // needed for custom field support tool

package/src/sap/ui/rta/plugin/iframe/AddIFrame.js

@@ -85,7 +85,7 @@ sap.ui.define([
 				parameters: mURLParameters,
 				asContainer: bAsContainer
 			};
-			return oAddIFrameDialog.open(mAddIFrameDialogSettings);
+			return oAddIFrameDialog.open(mAddIFrameDialogSettings, oParent);
 		})
 		.then(function(mSettings) {
 			if (!mSettings) {
@@ -119,7 +119,7 @@ sap.ui.define([
 	 * @class The AddIFrame allows trigger AddIFrame operations on the overlay.
 	 * @extends sap.ui.rta.plugin.BaseCreate
 	 * @author SAP SE
-	 * @version 1.120.6
+	 * @version 1.121.0
 	 * @constructor
 	 * @private
 	 * @since 1.75