@openui5/sap.ui.core 1.115.1 → 1.117.0

package/src/sap/ui/model/odata/v4/lib/_AggregationCache.js

@@ -42,6 +42,7 @@ sap.ui.define([
 	 *
 	 * @alias sap.ui.model.odata.v4.lib._AggregationCache
 	 * @borrows sap.ui.model.odata.v4.lib._CollectionCache#addKeptElement as #addKeptElement
+	 * @borrows sap.ui.model.odata.v4.lib._CollectionCache#removeKeptElement as #removeKeptElement
 	 * @borrows sap.ui.model.odata.v4.lib._CollectionCache#requestSideEffects as #requestSideEffects
 	 * @constructor
 	 * @extends sap.ui.model.odata.v4.lib._Cache
@@ -82,6 +83,7 @@ sap.ui.define([
 		}
 		this.oFirstLevel = this.createGroupLevelCache(null, bHasGrandTotal || !!fnLeaves);
 		this.addKeptElement = this.oFirstLevel.addKeptElement; // @borrows ...
+		this.removeKeptElement = this.oFirstLevel.removeKeptElement; // @borrows ...
 		this.requestSideEffects = this.oFirstLevel.requestSideEffects; // @borrows ...
 		this.oGrandTotalPromise = undefined;
 		if (bHasGrandTotal) {
@@ -115,8 +117,11 @@ sap.ui.define([
 		}
 	}
 
-	// make _AggregationCache a _Cache
+	// make _AggregationCache a _Cache, but actively disinherit some critical methods
 	_AggregationCache.prototype = Object.create(_Cache.prototype);
+	_AggregationCache.prototype._delete = null;
+	_AggregationCache.prototype.addTransientCollection = null;
+	_AggregationCache.prototype.getAndRemoveValue = null;
 
 	/**
 	 * Copies the given elements from a cache read into <code>this.aElements</code>.
@@ -147,7 +152,8 @@ sap.ui.define([
 		function addElement(oElement, i) {
 			var oOldElement = aElements[iOffset + i],
 				oKeptElement,
-				sPredicate = _Helper.getPrivateAnnotation(oElement, "predicate");
+				sPredicate = _Helper.getPrivateAnnotation(oElement, "transientPredicate")
+					|| _Helper.getPrivateAnnotation(oElement, "predicate");
 
 			if (oOldElement) { // check before overwriting
 				if (oOldElement === oElement) {
@@ -293,6 +299,86 @@ sap.ui.define([
 		return iCount;
 	};
 
+	/**
+	 * Creates a transient node with the parent identified by "@$ui5.node.parent", inserts it into
+	 * the hierarchy at the appropriate position, and adds a POST request to the batch
+	 * group with the given ID. See {@link sap.ui.model.odata.v4.lib._Cache#create} for more.
+	 *
+	 * @param {sap.ui.model.odata.v4.lib._GroupLock} oGroupLock
+	 *   A lock for the group ID
+	 * @param {sap.ui.base.SyncPromise} oPostPathPromise
+	 *   A SyncPromise resolving with the resource path for the POST request
+	 * @param {string} sPath
+	 *   The collection's path within the cache (as used by change listeners)
+	 * @param {string} sTransientPredicate
+	 *   A (temporary) key predicate for the transient entity: "($uid=...)"
+	 * @param {object} oEntityData
+	 *   The initial entity data, already cloned and cleaned of client-side annotations (except
+	 *   "@$ui5.node.parent" which contains the OData ID string needed for "...@odata.bind")
+	 * @param {boolean} bAtEndOfCreated
+	 *   Whether the newly created entity should be inserted after previously created entities or at
+	 *   the front of the list.
+	 * @param {function} fnErrorCallback
+	 *   A function which is called with an error object each time a POST request for the create
+	 *   fails
+	 * @param {function} fnSubmitCallback
+	 *   A function which is called just before a POST request for the create is sent
+	 * @returns {sap.ui.base.SyncPromise}
+	 *   A promise which is resolved with the created entity when the POST request has been
+	 *   successfully sent and the entity has been marked as non-transient
+	 * @throws {Error}
+	 *   If <code>this.oAggregation.expandTo > 1</code>, <code>bAtEndOfCreated</code> is set, or the
+	 *   parent is collapsed
+	 *
+	 * @public
+	 */
+	// @override sap.ui.model.odata.v4.lib._Cache#create
+	_AggregationCache.prototype.create = function (oGroupLock, oPostPathPromise, sPath,
+			sTransientPredicate, oEntityData, bAtEndOfCreated, fnErrorCallback, fnSubmitCallback) {
+		if (this.oAggregation.expandTo > 1) {
+			throw new Error("Unsupported expandTo: " + this.oAggregation.expandTo);
+		}
+		if (bAtEndOfCreated) {
+			throw new Error("Unsupported bAtEndOfCreated");
+		}
+
+		const aElements = this.aElements;
+		const sParentPath = oEntityData["@$ui5.node.parent"];
+		const sParentPredicate = sParentPath.slice(sParentPath.indexOf("("));
+		const oParentNode = aElements.$byPredicate[sParentPredicate];
+		if (oParentNode["@$ui5.node.isExpanded"] === false) {
+			throw new Error("Unsupported collapsed parent: " + sParentPath);
+		}
+
+		let oCache = _Helper.getPrivateAnnotation(oParentNode, "cache");
+		if (!oCache) {
+			oCache = this.createGroupLevelCache(oParentNode);
+			_Helper.setPrivateAnnotation(oParentNode, "cache", oCache);
+			_Helper.updateAll(this.mChangeListeners, sParentPredicate, oParentNode,
+				{"@$ui5.node.isExpanded" : true}); // not a leaf anymore
+		}
+
+		delete oEntityData["@$ui5.node.parent"];
+		const oResult = oCache.create(oGroupLock, oPostPathPromise, sPath, sTransientPredicate,
+			oEntityData, bAtEndOfCreated, fnErrorCallback, fnSubmitCallback);
+		// add @odata.bind to POST body only
+		_Helper.getPrivateAnnotation(oEntityData, "postBody")
+			[this.oAggregation.$ParentNavigationProperty + "@odata.bind"] = sParentPath;
+		oEntityData["@$ui5.node.level"] = oParentNode["@$ui5.node.level"] + 1;
+
+		const iIndex = aElements.indexOf(oParentNode) + 1;
+		aElements.splice(iIndex, 0, null); // create a gap
+		this.addElements(oEntityData, iIndex, oCache, 0);
+		aElements.$count += 1;
+
+		return oResult.then(function () {
+			aElements.$byPredicate[_Helper.getPrivateAnnotation(oEntityData, "predicate")]
+				= oEntityData;
+
+			return oEntityData;
+		});
+	};
+
 	/**
 	 * Creates a cache for the children (next group level or leaves) of the given group node.
 	 * Creates the first level cache if there is no group node.
@@ -793,9 +879,9 @@ sap.ui.define([
 	 * @param {sap.ui.model.odata.v4.lib._GroupLock} oGroupLock
 	 *   A lock for the group to associate the requests with;
 	 *   {@link sap.ui.model.odata.v4.lib._GroupLock#getUnlockedCopy} still needs to be called!
-	 * @returns {Promise|undefined}
-	 *   A promise resolving without a defined result when the read is finished, or rejecting in
-	 *   case of an error; <code>undefined</code> in case no count needs to be read
+	 * @returns {Promise<void>|undefined}
+	 *   A promise which is resolved without a defined result when the read is finished, or
+	 *   rejected in case of an error; <code>undefined</code> in case no count needs to be read
 	 * @throws {Error}
 	 *   If group ID is '$cached'. The error has a property <code>$cached = true</code>
 	 *
@@ -846,8 +932,8 @@ sap.ui.define([
 	 *   The function is called just before a back-end request is sent.
 	 *   If no back-end request is needed, the function is not called.
 	 * @returns {sap.ui.base.SyncPromise}
-	 *   A promise resolving without a defined result when the read is finished, or rejecting in
-	 *   case of an error
+	 *   A promise which is resolved without a defined result when the read is finished, or
+	 *   rejected in case of an error
 	 * @throws {Error} If given index or length is less than 0
 	 *
 	 * @private
@@ -918,8 +1004,8 @@ sap.ui.define([
 	 *   The function is called just before a back-end request is sent.
 	 *   If no back-end request is needed, the function is not called.
 	 * @returns {sap.ui.base.SyncPromise}
-	 *   A promise resolving without a defined result when the read is finished, or rejecting in
-	 *   case of an error
+	 *   A promise which is resolved without a defined result when the read is finished, or
+	 *   rejected in case of an error
 	 * @throws {Error} If index of placeholder at start of gap is less than 0, or if end of gap is
 	 *   before start
 	 *

package/src/sap/ui/model/odata/v4/lib/_AggregationHelper.js

@@ -407,9 +407,9 @@ sap.ui.define([
 		 * Builds the value for a "$apply" system query option based on the given data aggregation
 		 * information for a recursive hierarchy. If no query options are given, only a symbolic
 		 * "$apply" is constructed to avoid timing issues with metadata. The property paths for
-		 * DistanceFromRootProperty, DrillStateProperty, LimitedDescendantCountProperty, and
-		 * NodeProperty are stored at <code>oAggregation</code> using a "$" prefix (if not already
-		 * stored).
+		 * DistanceFromRootProperty, DrillStateProperty, LimitedDescendantCountProperty,
+		 * NodeProperty, and ParentNavigationProperty are stored at <code>oAggregation</code> using
+		 * a "$" prefix (if not already stored).
 		 *
 		 * @param {object} oAggregation
 		 *   An object holding the information needed for a recursive hierarchy; see
@@ -438,25 +438,17 @@ sap.ui.define([
 		 * @public
 		 */
 		buildApply4Hierarchy : function (oAggregation, mQueryOptions, bAllLevels) {
-			var sApply = "",
-				sHierarchyQualifier = oAggregation.hierarchyQualifier,
-				sMetaPath = oAggregation.$metaPath,
-				sNodeProperty = oAggregation.$NodeProperty,
-				sPath = oAggregation.$path,
-				mRecursiveHierarchy,
-				sSeparator = "",
-				oSyncPromise;
+			let mRecursiveHierarchy; // cache it on 1st access
 
 			function select(sProperty) {
-				var sPropertyPath;
-
 				if (mQueryOptions.$select) {
-					sPropertyPath = oAggregation["$" + sProperty];
+					let sPropertyPath = oAggregation["$" + sProperty];
 					if (!sPropertyPath) {
 						if (!mRecursiveHierarchy) {
-							mRecursiveHierarchy = oAggregation.$fetchMetadata(sMetaPath
-								+ "/@com.sap.vocabularies.Hierarchy.v1.RecursiveHierarchy#"
-								+ sHierarchyQualifier).getResult();
+							mRecursiveHierarchy = oAggregation.$fetchMetadata(oAggregation.$metaPath
+									+ "/@com.sap.vocabularies.Hierarchy.v1.RecursiveHierarchy#"
+									+ oAggregation.hierarchyQualifier
+								).getResult();
 						}
 
 						sPropertyPath = oAggregation["$" + sProperty]
@@ -466,14 +458,18 @@ sap.ui.define([
 				}
 			}
 
+			let sNodeProperty = oAggregation.$NodeProperty;
 			if (!sNodeProperty) {
 				sNodeProperty = "???";
 				if (mQueryOptions) {
-					oSyncPromise = oAggregation.$fetchMetadata(sMetaPath
-						+ "/@Org.OData.Aggregation.V1.RecursiveHierarchy#" + sHierarchyQualifier
-						+ "/NodeProperty/$PropertyPath");
+					const oSyncPromise = oAggregation.$fetchMetadata(oAggregation.$metaPath
+						+ "/@Org.OData.Aggregation.V1.RecursiveHierarchy#"
+						+ oAggregation.hierarchyQualifier);
 					if (oSyncPromise.isFulfilled()) {
-						sNodeProperty = oAggregation.$NodeProperty = oSyncPromise.getResult();
+						sNodeProperty = oAggregation.$NodeProperty
+							= oSyncPromise.getResult().NodeProperty.$PropertyPath;
+						oAggregation.$ParentNavigationProperty = oSyncPromise.getResult()
+							.ParentNavigationProperty.$NavigationPropertyPath;
 					}
 				}
 			}
@@ -486,7 +482,9 @@ sap.ui.define([
 				}
 			}
 
+			let sApply = "";
 			if (mQueryOptions.$filter || oAggregation.search) {
+				let sSeparator = "";
 				if (mQueryOptions.$filter) {
 					sApply = "filter(" + mQueryOptions.$filter;
 					sSeparator = ")/";
@@ -495,15 +493,15 @@ sap.ui.define([
 				if (oAggregation.search) {
 					sApply += sSeparator + "search(" + oAggregation.search;
 				}
-				sApply = "ancestors($root" + sPath
-					+ "," + sHierarchyQualifier
+				sApply = "ancestors($root" + oAggregation.$path
+					+ "," + oAggregation.hierarchyQualifier
 					+ "," + sNodeProperty
 					+ "," + sApply
 					+ "),keep start)/";
 			}
 			if (mQueryOptions.$$filterBeforeAggregate) { // children of a given parent
-				sApply += "descendants($root" + sPath + "," + sHierarchyQualifier
-					+ "," + sNodeProperty
+				sApply += "descendants($root" + oAggregation.$path
+					+ "," + oAggregation.hierarchyQualifier + "," + sNodeProperty
 					+ ",filter(" + mQueryOptions.$$filterBeforeAggregate + "),1)";
 				delete mQueryOptions.$$filterBeforeAggregate;
 				if (mQueryOptions.$orderby) {
@@ -516,8 +514,8 @@ sap.ui.define([
 					delete mQueryOptions.$orderby;
 				}
 				sApply += "com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root"
-					+ (sPath || "")
-					+ ",HierarchyQualifier='" + sHierarchyQualifier
+					+ (oAggregation.$path || "")
+					+ ",HierarchyQualifier='" + oAggregation.hierarchyQualifier
 					+ "',NodeProperty='" + sNodeProperty
 					+ "',Levels=" + (bAllLevels ? 999 : oAggregation.expandTo || 1)
 					+ ")";