@openui5/sap.ui.core 1.96.5 → 1.99.0

package/src/sap/ui/model/odata/v4/ODataParentBinding.js

@@ -9,12 +9,11 @@
 sap.ui.define([
 	"./Context",
 	"./ODataBinding",
-	"./SubmitMode",
 	"./lib/_Helper",
 	"sap/base/Log",
 	"sap/ui/base/SyncPromise",
 	"sap/ui/model/ChangeReason"
-], function (Context, asODataBinding, SubmitMode, _Helper, Log, SyncPromise, ChangeReason) {
+], function (Context, asODataBinding, _Helper, Log, SyncPromise, ChangeReason) {
 	"use strict";
 
 	/**
@@ -83,9 +82,10 @@ sap.ui.define([
 	 *   The new value which must be primitive
 	 * @param {sap.ui.model.odata.v4.lib._GroupLock} [oGroupLock]
 	 *   A lock for the group ID to be used for the PATCH request; without a lock, no PATCH is sent
-	 * @returns {sap.ui.base.SyncPromise} <code>undefined</code> for the general case which is
-	 *   handled generically by the caller {@link sap.ui.model.odata.v4.Context#doSetProperty}
-	 *   or a <code>SyncPromise</code> for the exceptional case
+	 * @returns {sap.ui.base.SyncPromise|undefined}
+	 *   <code>undefined</code> for the general case which is handled generically by the caller
+	 *   {@link sap.ui.model.odata.v4.Context#doSetProperty} or a <code>SyncPromise</code> for the
+	 *   exceptional case
 	 *
 	 * @abstract
 	 * @function
@@ -191,15 +191,16 @@ sap.ui.define([
 	 * "5.1.2 System Query Option $expand" and "5.1.3 System Query Option $select" in specification
 	 * "OData Version 4.0 Part 2: URL Conventions".
 	 *
-	 * @param {object} mQueryOptions The query options to be merged
-	 * @param {string} sBaseMetaPath This binding's meta path
-	 * @param {boolean} bCacheImmutable Whether the cache of this binding is immutable
+	 * @param {object} mQueryOptions - The query options to be merged
+	 * @param {string} sBaseMetaPath - This binding's meta path
+	 * @param {boolean} bCacheImmutable - Whether the cache of this binding is immutable
+	 * @param {boolean} bIsProperty - Whether the child is a property binding
 	 * @returns {boolean} Whether the query options can be fulfilled by this binding
 	 *
 	 * @private
 	 */
 	ODataParentBinding.prototype.aggregateQueryOptions = function (mQueryOptions, sBaseMetaPath,
-			bCacheImmutable) {
+			bCacheImmutable, bIsProperty) {
 		var mAggregatedQueryOptionsClone = _Helper.merge({},
 				bCacheImmutable && this.mLateQueryOptions || this.mAggregatedQueryOptions),
 			bChanged = false,
@@ -256,8 +257,9 @@ sap.ui.define([
 
 			// Top-level all query options in the aggregate are OK, even if not repeated in the
 			// child. In a $expand the child must also have them (and the second loop checks that
-			// they're equal).
-			return (!bInsideExpand || Object.keys(mAggregatedQueryOptions).every(function (sName) {
+			// they're equal). Property bindings are an exception to this rule.
+			return (bIsProperty || !bInsideExpand
+				|| Object.keys(mAggregatedQueryOptions).every(function (sName) {
 					return sName in mQueryOptions0 || sName === "$count" || sName === "$expand"
 						|| sName === "$select";
 				}))
@@ -299,8 +301,8 @@ sap.ui.define([
 	/**
 	 * Changes this binding's parameters and refreshes the binding.
 	 *
-	 * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if
-	 * there are pending changes. If there are changes, call
+	 * If there are pending changes that cannot be ignored, an error is thrown. Use
+	 * {@link #hasPendingChanges} to check if there are such pending changes. If there are, call
 	 * {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit the changes or
 	 * {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
 	 * {@link #changeParameters}.
@@ -313,12 +315,16 @@ sap.ui.define([
 	 *   Map of binding parameters, see {@link sap.ui.model.odata.v4.ODataModel#bindList} and
 	 *   {@link sap.ui.model.odata.v4.ODataModel#bindContext}
 	 * @throws {Error}
-	 *   If there are pending changes or if <code>mParameters</code> is missing, contains
-	 *   binding-specific or unsupported parameters, contains unsupported values, or contains the
-	 *   property "$expand" or "$select" when the model is in auto-$expand/$select mode.
-	 *   Since 1.90.0, binding-specific parameters are ignored if they are unchanged. Since 1.93.0,
-	 *   string values for "$expand" and "$select" are ignored if they are unchanged; pending
-	 *   changes are ignored if all parameters are unchanged.
+	 *   If there are pending changes that cannot be ignored or if <code>mParameters</code> is
+	 *   missing, contains binding-specific or unsupported parameters, contains unsupported values,
+	 *   or contains the property "$expand" or "$select" when the model is in auto-$expand/$select
+	 *   mode. Since 1.90.0, binding-specific parameters are ignored if they are unchanged. Since
+	 *   1.93.0, string values for "$expand" and "$select" are ignored if they are unchanged;
+	 *   pending changes are ignored if all parameters are unchanged. Since 1.97.0, pending changes
+	 *   are ignored if they relate to a
+	 *   {@link sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
+	 *   Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient} contexts
+	 *   of a {@link #getRootBinding root binding} do not count as pending changes.
 	 *
 	 * @public
 	 * @since 1.45.0
@@ -384,7 +390,7 @@ sap.ui.define([
 		}
 
 		if (sChangeReason) {
-			if (this.hasPendingChanges()) {
+			if (this.hasPendingChanges(true)) {
 				throw new Error("Cannot change parameters due to pending changes");
 			}
 			this.applyParameters(mBindingParameters, sChangeReason);
@@ -411,7 +417,7 @@ sap.ui.define([
 	 *
 	 * @returns {sap.ui.base.SyncPromise}
 	 *   A promise resolving without a defined result when the check is finished, or rejecting in
-	 *   case of an error (e.g. thrown by the change event handler of a control)
+	 *   case of an error
 	 * @throws {Error} If called with parameters
 	 *
 	 * @private
@@ -456,8 +462,11 @@ sap.ui.define([
 	 *   The absolute path to the collection in the cache where to create the entity
 	 * @param {string} sTransientPredicate
 	 *   A (temporary) key predicate for the transient entity: "($uid=...)"
-	 * @param {object} oInitialData
+	 * @param {object} [oInitialData={}]
 	 *   The initial data for the created entity
+	 * @param {boolean} bAtEndOfCreated
+	 *   Whether the newly created entity should be inserted after previously created entities, not
+	 *   before them
 	 * @param {function} fnErrorCallback
 	 *   A function which is called with an error object each time a POST request for the create
 	 *   fails
@@ -470,7 +479,8 @@ sap.ui.define([
 	 * @private
 	 */
 	ODataParentBinding.prototype.createInCache = function (oUpdateGroupLock, vCreatePath,
-			sCollectionPath, sTransientPredicate, oInitialData, fnErrorCallback, fnSubmitCallback) {
+			sCollectionPath, sTransientPredicate, oInitialData, bAtEndOfCreated, fnErrorCallback,
+			fnSubmitCallback) {
 		var that = this;
 
 		return this.oCachePromise.then(function (oCache) {
@@ -479,7 +489,8 @@ sap.ui.define([
 			if (oCache) {
 				sPathInCache = _Helper.getRelativePath(sCollectionPath, that.getResolvedPath());
 				return oCache.create(oUpdateGroupLock, vCreatePath, sPathInCache,
-					sTransientPredicate, oInitialData, fnErrorCallback, fnSubmitCallback
+					sTransientPredicate, oInitialData, bAtEndOfCreated, fnErrorCallback,
+					fnSubmitCallback
 				).then(function (oCreatedEntity) {
 					if (that.mCacheByResourcePath) {
 						// Ensure that cache containing non-transient created entity is recreated
@@ -490,8 +501,8 @@ sap.ui.define([
 				});
 			}
 			return that.oContext.getBinding().createInCache(oUpdateGroupLock, vCreatePath,
-				sCollectionPath, sTransientPredicate, oInitialData, fnErrorCallback,
-				fnSubmitCallback);
+				sCollectionPath, sTransientPredicate, oInitialData, bAtEndOfCreated,
+				fnErrorCallback, fnSubmitCallback);
 		});
 	};
 
@@ -563,46 +574,41 @@ sap.ui.define([
 	 * Deletes the entity in the cache. If the binding doesn't have a cache, it forwards to the
 	 * parent binding adjusting the path.
 	 *
-	 * @param {sap.ui.model.odata.v4.lib._GroupLock} oGroupLock
-	 *   A lock for the group ID to be used for the DELETE request; if no group ID is specified, it
-	 *   defaults to <code>getUpdateGroupId()</code>()
+	 * @param {sap.ui.model.odata.v4.lib._GroupLock} [oGroupLock]
+	 *   A lock for the group ID to be used for the DELETE request; w/o a lock, no DELETE is sent.
+	 *   For a transient entity, the lock is ignored (use NULL)!
 	 * @param {string} sEditUrl
-	 *   The edit URL to be used for the DELETE request
+	 *   The entity's edit URL to be used for the DELETE request;  w/o a lock, this is mostly
+	 *   ignored.
 	 * @param {string} sPath
 	 *   The path of the entity relative to this binding
 	 * @param {object} [oETagEntity]
 	 *   An entity with the ETag of the binding for which the deletion was requested. This is
 	 *   provided if the deletion is delegated from a context binding with empty path to a list
-	 *   binding.
+	 *   binding. W/o a lock, this is ignored.
+	 * @param {boolean} [bDoNotRequestCount]
+	 *   Whether not to request the new count from the server; useful in case of
+	 *   {@link sap.ui.model.odata.v4.Context#replaceWith} where it is known that the count remains
+	 *   unchanged; w/o a lock this should be true
 	 * @param {function} fnCallback
-	 *   A function which is called after the entity has been deleted from the server and from the
-	 *   cache; the index of the entity is passed as parameter
+	 *   A function which is called after a transient entity has been deleted from the cache or
+	 *   after the entity has been deleted from the server and from the cache; the index of the
+	 *   entity and the entity list are both passed as parameter, or none of them
 	 * @returns {sap.ui.base.SyncPromise}
 	 *   A promise which is resolved without a result in case of success, or rejected with an
-	 *   instance of <code>Error</code> in case of failure
+	 *   instance of <code>Error</code> in case of failure; returns <code>undefined</code> if the
+	 *   cache promise for this binding is not yet fulfilled
 	 * @throws {Error}
-	 *   If the group ID has {@link sap.ui.model.odata.v4.SubmitMode.Auto} or if the cache promise
-	 *   for this binding is not yet fulfilled
+	 *   If the cache is shared
 	 *
 	 * @private
 	 */
 	ODataParentBinding.prototype.deleteFromCache = function (oGroupLock, sEditUrl, sPath,
-			oETagEntity, fnCallback) {
-		var sGroupId;
-
-		if (this.oCache === undefined) {
-			throw new Error("DELETE request not allowed");
-		}
-
-		if (this.oCache) {
-			sGroupId = oGroupLock.getGroupId();
-			if (!this.oModel.isAutoGroup(sGroupId) && !this.oModel.isDirectGroup(sGroupId)) {
-				throw new Error("Illegal update group ID: " + sGroupId);
-			}
-			return this.oCache._delete(oGroupLock, sEditUrl, sPath, oETagEntity, fnCallback);
-		}
-		return this.oContext.getBinding().deleteFromCache(oGroupLock, sEditUrl,
-			_Helper.buildPath(this.oContext.iIndex, this.sPath, sPath), oETagEntity, fnCallback);
+			oETagEntity, bDoNotRequestCount, fnCallback) {
+		return this.withCache(function (oCache, sCachePath) {
+			return oCache._delete(oGroupLock, sEditUrl, sCachePath, oETagEntity, bDoNotRequestCount,
+				fnCallback);
+		}, sPath, /*bSync*/true);
 	};
 
 	/**
@@ -612,7 +618,7 @@ sap.ui.define([
 	 * @since 1.61
 	 */
 	ODataParentBinding.prototype.destroy = function () {
-//		this.mAggregatedQueryOptions = undefined;
+		// this.mAggregatedQueryOptions = undefined;
 		this.aChildCanUseCachePromises = [];
 		this.removeReadGroupLock();
 		this.oResumePromise = undefined;
@@ -641,15 +647,18 @@ sap.ui.define([
 	 *   The child binding's binding path relative to <code>oContext</code>
 	 * @param {object|sap.ui.base.SyncPromise} vChildQueryOptions
 	 *   The child binding's (aggregated) query options or a promise resolving with them
+	 * @param {boolean} bIsProperty
+	 *   Whether the child is a property binding
 	 * @returns {sap.ui.base.SyncPromise}
 	 *   A promise resolved with the reduced path for the child binding if the child binding can use
-	 *   this binding's or an ancestor binding's cache; <code>undefined</code> otherwise.
+	 *   this binding's or an ancestor binding's cache; resolved with <code>undefined</code>
+	 *   otherwise.
 	 *
 	 * @private
 	 * @see sap.ui.model.odata.v4.ODataMetaModel#getReducedPath
 	 */
 	ODataParentBinding.prototype.fetchIfChildCanUseCache = function (oContext, sChildPath,
-			vChildQueryOptions) {
+			vChildQueryOptions, bIsProperty) {
 		// getBaseForPathReduction must be called early, because the (virtual) parent context may be
 		// lost again when the path is needed
 		var sBaseForPathReduction = this.getBaseForPathReduction(),
@@ -759,9 +768,9 @@ sap.ui.define([
 				that.bAggregatedQueryOptionsInitial = false;
 			}
 			if (bIsAdvertisement) {
-				mWrappedChildQueryOptions = {"$select" : [sReducedChildMetaPath.slice(1)]};
+				mWrappedChildQueryOptions = {$select : [sReducedChildMetaPath.slice(1)]};
 				return that.aggregateQueryOptions(mWrappedChildQueryOptions, sBaseMetaPath,
-						bCacheImmutable)
+						bCacheImmutable, bIsProperty)
 					? sReducedPath
 					: undefined;
 			}
@@ -773,7 +782,7 @@ sap.ui.define([
 					that.oModel.oInterface.fetchMetadata);
 				if (mWrappedChildQueryOptions) {
 					return that.aggregateQueryOptions(mWrappedChildQueryOptions, sBaseMetaPath,
-							bCacheImmutable)
+							bCacheImmutable, bIsProperty)
 						? sReducedPath
 						: undefined;
 				}
@@ -781,7 +790,7 @@ sap.ui.define([
 			}
 			if (sReducedChildMetaPath === "value") { // symbolic name for operation result
 				return that.aggregateQueryOptions(mChildQueryOptions, sBaseMetaPath,
-						bCacheImmutable)
+						bCacheImmutable, bIsProperty)
 					? sReducedPath
 					: undefined;
 			}
@@ -825,7 +834,7 @@ sap.ui.define([
 		// catch the error, but keep the rejected promise
 		this.oCachePromise.catch(function (oError) {
 			that.oModel.reportError(that + ": Failed to enhance query options for "
-				+ "auto-$expand/$select for child " + sChildPath,  sClassName, oError);
+				+ "auto-$expand/$select for child " + sChildPath, sClassName, oError);
 		});
 		return oCanUseCachePromise;
 	};
@@ -858,9 +867,13 @@ sap.ui.define([
 		sMetaPath = _Helper.getMetaPath(oModel.resolve(this.sPath, oContext));
 		mConvertedQueryOptions = Object.assign({}, mQueryOptions, {$select : []});
 		return SyncPromise.all(mQueryOptions.$select.map(function (sSelectPath) {
-			return _Helper.fetchPropertyAndType(
-				fnFetchMetadata, sMetaPath + "/" + sSelectPath
-			).then(function () {
+			var sMetaSelectPath = sMetaPath + "/" + sSelectPath;
+
+			if (sMetaSelectPath.endsWith(".*")) { // fetch metadata for namespace itself
+				sMetaSelectPath = sMetaSelectPath.slice(0, -1);
+			}
+
+			return _Helper.fetchPropertyAndType(fnFetchMetadata, sMetaSelectPath).then(function () {
 				var mWrappedQueryOptions = _Helper.wrapChildQueryOptions(
 						sMetaPath, sSelectPath, {}, fnFetchMetadata);
 
@@ -892,8 +905,7 @@ sap.ui.define([
 			oParentBinding = this.oContext.getBinding();
 			sParentUpdateGroupId = oParentBinding.getUpdateGroupId();
 			if (sParentUpdateGroupId === this.getUpdateGroupId()
-					|| this.oModel.getGroupProperty(sParentUpdateGroupId, "submit")
-						!== SubmitMode.API) {
+					|| !this.oModel.isApiGroup(sParentUpdateGroupId)) {
 				return oParentBinding.getBaseForPathReduction();
 			}
 		}
@@ -992,16 +1004,24 @@ sap.ui.define([
 	 * @override
 	 * @see sap.ui.model.odata.v4.ODataBinding#hasPendingChangesInDependents
 	 */
-	ODataParentBinding.prototype.hasPendingChangesInDependents = function () {
-		var aDependents = this.getDependentBindings();
-
-		return aDependents.some(function (oDependent) {
+	ODataParentBinding.prototype.hasPendingChangesInDependents = function (bIgnoreKeptAlive0) {
+		return this.getDependentBindings().some(function (oDependent) {
 			var oCache = oDependent.oCache,
-				bHasPendingChanges;
+				bHasPendingChanges,
+				bIgnoreKeptAlive = bIgnoreKeptAlive0; // new copy for this dependent only
 
+			if (bIgnoreKeptAlive) {
+				if (oDependent.oContext.isKeepAlive()) {
+					return false; // changes can be safely ignored here
+				}
+				if (oDependent.oContext.getIndex() !== undefined) {
+					bIgnoreKeptAlive = false; // context of ODLB which is not kept alive: unsafe!
+				}
+			}
 			if (oCache !== undefined) {
 				// Pending changes for this cache are only possible when there is a cache already
-				if (oCache && oCache.hasPendingChangesForPath("")) {
+				if (oCache && oCache.hasPendingChangesForPath("", false,
+						bIgnoreKeptAlive && oDependent.mParameters.$$ownRequest)) {
 					return true;
 				}
 			} else if (oDependent.hasPendingChangesForPath("")) {
@@ -1010,14 +1030,17 @@ sap.ui.define([
 			if (oDependent.mCacheByResourcePath) {
 				bHasPendingChanges = Object.keys(oDependent.mCacheByResourcePath)
 					.some(function (sPath) {
-						return oDependent.mCacheByResourcePath[sPath].hasPendingChangesForPath("");
+						var oCacheForPath = oDependent.mCacheByResourcePath[sPath];
+
+						return oCacheForPath !== oCache // don't ask again
+							&& oCacheForPath.hasPendingChangesForPath("");
 					});
 				if (bHasPendingChanges) {
 					return true;
 				}
 			}
 			// Ask dependents, they might have no cache, but pending changes in mCacheByResourcePath
-			return oDependent.hasPendingChangesInDependents();
+			return oDependent.hasPendingChangesInDependents(bIgnoreKeptAlive);
 		})
 		|| this.oModel.withUnresolvedBindings("hasPendingChangesInCaches",
 				this.getResolvedPath().slice(1));
@@ -1060,9 +1083,11 @@ sap.ui.define([
 	 * @param {boolean} [bKeepCacheOnError]
 	 *   If <code>true</code>, the binding data remains unchanged if the refresh fails
 	 * @returns {sap.ui.base.SyncPromise}
-	 *   A promise resolving when all dependent bindings are refreshed; it is rejected if the
-	 *   binding's root binding is suspended and a group ID different from the binding's group ID is
-	 *   given
+	 *   A promise resolving when all dependent bindings are refreshed; it is rejected
+	 *   when the refresh fails; the promise is resolved immediately on a suspended binding
+	 * @throws {Error}
+	 *   If the binding's root binding is suspended and a group ID different from the binding's
+	 *   group ID is given
 	 *
 	 * @private
 	 */
@@ -1078,7 +1103,11 @@ sap.ui.define([
 	 * Recursively refreshes all dependent list bindings that have no own cache.
 	 *
 	 * @returns {sap.ui.base.SyncPromise}
-	 *   A promise resolving when all dependent list bindings without own cache are refreshed
+	 *   A promise resolving when all dependent list bindings without own cache are refreshed; it is
+	 *   rejected when the refresh fails; the promise is resolved immediately on a suspended binding
+	 * @throws {Error}
+	 *   If the binding's root binding is suspended and a group ID different from the binding's
+	 *   group ID is given
 	 *
 	 * @private
 	 */
@@ -1106,24 +1135,6 @@ sap.ui.define([
 		}
 	};
 
-	/**
-	 * Refreshes the binding; expects it to be suspended.
-	 *
-	 * @param {string} sGroupId
-	 *   The group ID to be used for the refresh
-	 * @throws {Error}
-	 *   If a group ID different from the binding's group ID is given
-
-	 * @private
-	 */
-	ODataParentBinding.prototype.refreshSuspended = function (sGroupId) {
-		if (sGroupId && sGroupId !== this.getGroupId()) {
-			throw new Error(this + ": Cannot refresh a suspended binding with group ID '"
-				+ sGroupId  + "' (own group ID is '" + this.getGroupId() + "')");
-		}
-		this.setResumeChangeReason(ChangeReason.Refresh);
-	};
-
 	/**
 	 * Loads side effects for the given context of this binding.
 	 *
@@ -1322,8 +1333,11 @@ sap.ui.define([
 
 	/**
 	 * Suspends this binding. A suspended binding does not fire change events nor does it trigger
-	 * data service requests. Call {@link #resume} to resume the binding.
-	 * Before 1.53.0, this method was not supported and threw an error.
+	 * data service requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method
+	 * was not supported and threw an error. Since 1.97.0, pending changes are ignored if they
+	 * relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this
+	 * binding. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient} contexts
+	 * of a {@link #getRootBinding root binding} do not count as pending changes.
 	 *
 	 * @throws {Error}
 	 *   If this binding
@@ -1331,7 +1345,7 @@ sap.ui.define([
 	 *   <li>is relative to a {@link sap.ui.model.odata.v4.Context},</li>
 	 *   <li>is an operation binding,</li>
 	 *   <li>has {@link sap.ui.model.Binding#isSuspended} set to <code>true</code>,</li>
-	 *   <li>has pending changes,</li>
+	 *   <li>has pending changes that cannot be ignored,</li>
 	 *   <li>is not a root binding. Use {@link #getRootBinding} to determine the root binding.</li>
 	 *   </ul>
 	 *
@@ -1356,7 +1370,7 @@ sap.ui.define([
 		if (this.bSuspended) {
 			throw new Error("Cannot suspend a suspended binding: " + this);
 		}
-		if (this.hasPendingChanges()) {
+		if (this.hasPendingChanges(true)) {
 			throw new Error("Cannot suspend a binding with pending changes: " + this);
 		}
 
@@ -1445,7 +1459,6 @@ sap.ui.define([
 		"adjustPredicate",
 		"destroy",
 		"doDeregisterChangeListener",
-		"fetchCache",
 		"getGeneration",
 		"hasPendingChangesForPath"
 	].forEach(function (sMethod) { // method (still) not final, allow for "super" calls