@openui5/sap.ui.core 1.105.1 → 1.107.0

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

@@ -175,11 +175,13 @@ sap.ui.define([
 				oEntity = vDeleteProperty
 					? vCacheData[vCachePath] || vCacheData.$byPredicate[vCachePath]
 					: vCacheData, // deleting at root level
+				aMessages,
 				mHeaders,
 				iIndex = typeof vCachePath === "number" ? vCachePath : undefined,
 				sKeyPredicate = _Helper.getPrivateAnnotation(oEntity, "predicate"),
 				sEntityPath = _Helper.buildPath(sParentPath,
 					Array.isArray(vCacheData) ? sKeyPredicate : vDeleteProperty),
+				oModelInterface = that.oRequestor.getModelInterface(),
 				oRequestPromise,
 				sTransientGroup = _Helper.getPrivateAnnotation(oEntity, "transient"),
 				sTransientPredicate = _Helper.getPrivateAnnotation(oEntity, "transientPredicate");
@@ -194,6 +196,19 @@ sap.ui.define([
 			if (oEntity["@$ui5.context.isDeleted"]) {
 				throw new Error("Must not delete twice: " + sEditUrl);
 			}
+
+			aMessages = oModelInterface.getMessagesByPath(
+				_Helper.buildPath("/", that.sResourcePath, sEntityPath), true);
+
+			if (aMessages.length) {
+				aMessages = aMessages.filter(function (oMessage) {
+					return !oMessage.persistent;
+				});
+				_Helper.setPrivateAnnotation(oEntity, "messages", aMessages);
+			}
+
+			oModelInterface.reportStateMessages(that.sResourcePath, {}, [sEntityPath]);
+
 			oEntity["@$ui5.context.isDeleted"] = true;
 			if (Array.isArray(vCacheData)) {
 				oDeleted = that.addDeleted(vCacheData, iIndex, sKeyPredicate, oGroupLock,
@@ -221,6 +236,7 @@ sap.ui.define([
 					&& that.requestCount(oGroupLock || that.oRequestor.lockGroup("$auto", that)),
 				oGroupLock && oGroupLock.unlock() // unlock when all requests have been queued
 			]).then(function () {
+				_Helper.deletePrivateAnnotation(oEntity, "messages");
 				if (Array.isArray(vCacheData)) {
 					vCacheData.$deleted.splice(vCacheData.$deleted.indexOf(oDeleted), 1);
 					delete vCacheData.$byPredicate[sKeyPredicate];
@@ -232,10 +248,14 @@ sap.ui.define([
 				} else { // deleting at root level
 					oEntity["$ui5.deleted"] = true;
 				}
-				that.oRequestor.getModelInterface().reportStateMessages(that.sResourcePath,
-					{}, [sEntityPath]);
 			}, function (oError) {
-				var iDeletedIndex;
+				var iDeletedIndex,
+					aMessages = _Helper.getPrivateAnnotation(oEntity, "messages");
+
+				if (aMessages) {
+					oModelInterface.fireMessageChange({newMessages : aMessages});
+				}
+				_Helper.deletePrivateAnnotation(oEntity, "messages");
 
 				delete oEntity["@$ui5.context.isDeleted"];
 				if (Array.isArray(vCacheData)) {
@@ -491,7 +511,8 @@ sap.ui.define([
 				aSelect = _Helper.getQueryOptionsForPath(that.mQueryOptions, sPath).$select;
 				_Helper.updateSelected(that.mChangeListeners,
 					_Helper.buildPath(sPath, sPredicate || sTransientPredicate), oEntityData,
-					oCreatedEntity, aSelect);
+					oCreatedEntity, aSelect, /*fnCheckKeyPredicate*/ undefined,
+					/*bOkIfMissing*/ true);
 
 				that.removePendingRequest();
 				fnResolve(true);
@@ -622,7 +643,8 @@ sap.ui.define([
 		 *   special cases.
 		 */
 		function missingValue(oValue, sSegment, iPathLength, bAgain) {
-			var sPropertyName,
+			var vPermissions,
+				sPropertyName,
 				sPropertyPath = aSegments.slice(0, iPathLength).join("/"),
 				sPropertyMetaPath = _Helper.getMetaPath(sPropertyPath),
 				sReadLink;
@@ -647,10 +669,15 @@ sap.ui.define([
 				}
 			}
 
+			vPermissions = oValue[_Helper.getAnnotationKey(oValue, ".Permissions", sSegment)];
+			if (vPermissions === 0 || vPermissions === "None") {
+				return undefined;
+			}
+
 			return that.oRequestor.getModelInterface()
 				.fetchMetadata(that.sMetaPath + "/" + sPropertyMetaPath)
 				.then(function (oProperty) {
-					var vPermissions;
+					var vResult = false;
 
 					if (!oProperty) {
 						return invalidSegment(sSegment);
@@ -668,11 +695,6 @@ sap.ui.define([
 						}
 					}
 					if (!bTransient) {
-						vPermissions = oValue[
-							_Helper.getAnnotationKey(oValue, ".Permissions", sSegment)];
-						if (vPermissions === 0 || vPermissions === "None") {
-							return undefined;
-						}
 						// If there is no entity with a key predicate, try it with the cache root
 						// object (in case of SimpleCache, the root object of CollectionCache is an
 						// array)
@@ -680,12 +702,14 @@ sap.ui.define([
 							oEntity = oData;
 							iEntityPathLength = 0;
 						}
-						return oEntity && !bAgain
-							&& that.fetchLateProperty(oGroupLock, oEntity,
+						if (oEntity && !bAgain) {
+							vResult = that.fetchLateProperty(oGroupLock, oEntity,
 								aSegments.slice(0, iEntityPathLength).join("/"),
-								aSegments.slice(iEntityPathLength).join("/"),
-								aSegments.slice(iEntityPathLength, iPathLength).join("/"))
-							|| invalidSegment(sSegment);
+								aSegments.slice(iEntityPathLength).join("/"));
+						}
+						return typeof vResult === "boolean"
+							? invalidSegment(sSegment, /*bAsInfo*/vResult)
+							: vResult; // fetchLateProperty's promise
 					}
 					// inside a transient entity, implicit values are determined as follows
 					if (oProperty.$kind === "NavigationProperty") {
@@ -769,7 +793,7 @@ sap.ui.define([
 
 	/**
 	 * Fetches a missing property while drilling down into the cache. Writes it into the cache and
-	 * returns it so that drillDown can continue.
+	 * resolves so that the drill-down can proceed.
 	 *
 	 * @param {sap.ui.model.odata.v4.lib._GroupLock} oGroupLock
 	 *   A lock for the group ID (on which unlock has already been called)
@@ -785,19 +809,18 @@ sap.ui.define([
 	 *   The path of the requested property relative to oResource; this property is requested from
 	 *   the server. For annotations, except client annotations, the annotated property is requested
 	 *   from the server.
-	 * @param {string} sMissingPropertyPath
-	 *   The path of the missing property relative to oResource; this property is returned so that
-	 *   drillDown can proceed
-	 * @returns {sap.ui.base.SyncPromise|undefined}
-	 *   A promise resolving with the missing property value or <code>undefined</code> if the
-	 *   requested property is not an expected late property; it rejects with an error if the GET
-	 *   request failed, or if the key predicate or the ETag has changed
+	 * @returns {sap.ui.base.SyncPromise|boolean}
+	 *   A promise resolving w/o any result if the requested property is an expected late property,
+	 *   or a <code>boolean</code> value if it is not; it rejects with an error if the GET request
+	 *   failed, or if the key predicate or the ETag has changed. The returned <code>boolean</code>
+	 *   value tells if the issue can be safely ignored.
 	 *
 	 * @private
 	 */
 	_Cache.prototype.fetchLateProperty = function (oGroupLock, oResource, sResourcePath,
-			sRequestedPropertyPath, sMissingPropertyPath) {
-		var sFullResourceMetaPath,
+			sRequestedPropertyPath) {
+		var bDataRequested = false,
+			sFullResourceMetaPath,
 			sFullResourcePath,
 			sGroupId,
 			iIndexOfAt = sRequestedPropertyPath.indexOf("@"),
@@ -810,6 +833,11 @@ sap.ui.define([
 			aUpdateProperties,
 			that = this;
 
+		function onSubmit() {
+			bDataRequested = true;
+			that.oRequestor.getModelInterface().fireDataRequested();
+		}
+
 		/*
 		 * Visits the query options recursively descending $expand. Determines the target type, adds
 		 * key properties, ETag and key predicate to aUpdateProperties.
@@ -849,12 +877,12 @@ sap.ui.define([
 		}
 
 		if (!this.mLateQueryOptions) {
-			return undefined; // no autoExpandSelect
+			return false; // no autoExpandSelect
 		}
 
 		if (iIndexOfAt >= 0) {
 			if (sRequestedPropertyPath.startsWith("@$ui5.", iIndexOfAt)) {
-				return undefined; // do not request for a client annotation
+				return true; // send no request for a client annotation
 			}
 			sRequestedPropertyPath = sRequestedPropertyPath.slice(0, iIndexOfAt);
 		}
@@ -868,7 +896,7 @@ sap.ui.define([
 			[sRequestedPropertyPath], this.oRequestor.getModelInterface().fetchMetadata,
 			sFullResourceMetaPath);
 		if (!mQueryOptions) {
-			return undefined;
+			return false;
 		}
 
 		visitQueryOptions(mQueryOptions);
@@ -885,7 +913,7 @@ sap.ui.define([
 			sGroupId = _Helper.getPrivateAnnotation(oResource, "groupId");
 			oPromise = this.oRequestor.request("GET", sMergeBasePath,
 				sGroupId ? this.oRequestor.lockGroup(sGroupId, this) : oGroupLock.getUnlockedCopy(),
-				undefined, undefined, undefined, undefined, sFullResourceMetaPath, undefined,
+				undefined, undefined, onSubmit, undefined, sFullResourceMetaPath, undefined,
 				false, mQueryOptions
 			).then(function (oData) {
 				that.visitResponse(oData, mTypeForMetaPath, sFullResourceMetaPath, sResourcePath);
@@ -912,9 +940,15 @@ sap.ui.define([
 
 			_Helper.updateSelected(that.mChangeListeners, sResourcePath, oResource, oData,
 				aUpdateProperties);
-
-			// return the missing property, so that drillDown properly proceeds
-			return _Helper.drillDown(oResource, sMissingPropertyPath.split("/"));
+			if (bDataRequested) {
+				bDataRequested = false;
+				that.oRequestor.getModelInterface().fireDataReceived();
+			}
+		}).catch(function (oError) {
+			if (bDataRequested) {
+				that.oRequestor.getModelInterface().fireDataReceived(oError);
+			}
+			throw oError;
 		}).finally(function () { // clean up only after updateSelected!
 			delete that.mPropertyRequestByPath[sRequestPath];
 		});
@@ -1551,6 +1585,7 @@ sap.ui.define([
 		var oOldElement, sTransientPredicate;
 
 		if (iIndex === undefined) { // kept-alive element not in the list
+			oOldElement = aElements.$byPredicate[sPredicate];
 			aElements.$byPredicate[sPredicate] = oElement;
 		} else {
 			// the element might have moved due to parallel insert/delete
@@ -1565,6 +1600,8 @@ sap.ui.define([
 				_Helper.setPrivateAnnotation(oElement, "transientPredicate", sTransientPredicate);
 			}
 		}
+		_Helper.restoreUpdatingProperties(oOldElement, oElement);
+
 		// Note: iStart is not needed here because we know we have key predicates
 		this.visitResponse(oElement, mTypeForMetaPath,
 			_Helper.getMetaPath(_Helper.buildPath(this.sMetaPath, sPath)), sPath + sPredicate);
@@ -1591,7 +1628,7 @@ sap.ui.define([
 			delete mQueryOptions.$expand;
 			delete mQueryOptions.$orderby;
 			delete mQueryOptions.$select;
-			sExclusiveFilter = this.getFilterExcludingCreated();
+			sExclusiveFilter = this.getExclusiveFilter();
 			if (sExclusiveFilter) {
 				mQueryOptions.$filter = mQueryOptions.$filter
 					? "(" + mQueryOptions.$filter + ") and " + sExclusiveFilter
@@ -1717,6 +1754,8 @@ sap.ui.define([
 	 *   The new value
 	 * @param {string} [sEntityPath]
 	 *   Path of the entity, relative to the cache (as used by change listeners)
+	 * @param {boolean} [bUpdating]
+	 *   Whether the given property will not be overwritten by a creation POST(+GET) response
 	 * @returns {Promise}
 	 *   A promise which resolves with <code>undefined</code> once the value has been set, or is
 	 *   rejected with an error if setting fails somehow
@@ -1724,14 +1763,14 @@ sap.ui.define([
 	 *
 	 * @public
 	 */
-	_Cache.prototype.setProperty = function (sPropertyPath, vValue, sEntityPath) {
+	_Cache.prototype.setProperty = function (sPropertyPath, vValue, sEntityPath, bUpdating) {
 		var that = this;
 
 		this.checkSharedRequest();
 		return this.fetchValue(_GroupLock.$cached, sEntityPath, null, null, true)
 			.then(function (oEntity) {
 				_Helper.updateAll(that.mChangeListeners, sEntityPath, oEntity,
-					_Cache.makeUpdateData(sPropertyPath.split("/"), vValue));
+					_Cache.makeUpdateData(sPropertyPath.split("/"), vValue, bUpdating));
 			});
 	};
 
@@ -1915,7 +1954,7 @@ sap.ui.define([
 					mHeaders.Prefer = "return=minimal";
 				}
 				oPatchPromise = that.oRequestor.request("PATCH", sEditUrl, oPatchGroupLock,
-					mHeaders, oUpdateData, onSubmit, onCancel, /*sMetaPath*/undefined,
+					mHeaders, oUpdateData, onSubmit, onCancel, /*sMetaPath*/ undefined,
 					_Helper.buildPath(that.getOriginalResourcePath(oEntity), sEntityPath),
 					bAtFront, /*mQueryOptions*/ undefined, /*vOwner*/ undefined,
 					mergePatchRequests);
@@ -1947,7 +1986,7 @@ sap.ui.define([
 				}, function (oError) {
 					var sRetryGroupId = sGroupId;
 
-					if (!fnErrorCallback) {
+					if (!fnErrorCallback && !oError.canceled) {
 						onCancel();
 						throw oError;
 					}
@@ -1999,6 +2038,9 @@ sap.ui.define([
 				throw new Error("Cannot update '" + sPropertyPath + "': '" + sEntityPath
 					+ "' does not exist");
 			}
+
+			_Helper.deleteUpdating(sPropertyPath, oEntity);
+
 			sTransientGroup = _Helper.getPrivateAnnotation(oEntity, "transient");
 			if (sTransientGroup) {
 				if (typeof sTransientGroup !== "string") {
@@ -2310,6 +2352,34 @@ sap.ui.define([
 		this.aElements.$byPredicate[_Helper.getPrivateAnnotation(oElement, "predicate")] = oElement;
 	};
 
+	/**
+	 * Checks the given range of currently available elements to contain the given promise.
+	 *
+	 * @param {sap.ui.base.SyncPromise} oPromise
+	 *   The promise
+	 * @param {number} iStart
+	 *   The start index
+	 * @param {number} iEnd
+	 *   The end index (will not be filled)
+	 * @throws {Error}
+	 *   If there is an index no longer containing the promise
+	 *
+	 * @private
+	 */
+	_CollectionCache.prototype.checkRange = function (oPromise, iStart, iEnd) {
+		var i;
+
+		// if the request used $tail, not all indexes got the promise, so we cannot check
+		if (oPromise !== this.aElements.$tail) {
+			iEnd = Math.min(iEnd, this.aElements.length);
+			for (i = iStart; i < iEnd; i += 1) {
+				if (this.aElements[i] !== oPromise) {
+					throw new Error("Found data at an index being read from the back end");
+				}
+			}
+		}
+	};
+
 	/**
 	 * Creates an empty element for the given predicate to the cache, adds it to the cache and
 	 * returns it.
@@ -2443,15 +2513,15 @@ sap.ui.define([
 	};
 
 	/**
-	 * Returns a filter that excludes all created entities in this cache's collection (including
-	 * those that have been deleted on the client again).
+	 * Returns a filter that excludes all created entities in this cache's collection and all
+	 * entities that have been deleted on the client, but not on the server yet.
 	 *
 	 * @returns {string|undefined}
-	 *   The filter or <code>undefined</code> if there is no created entity.
+	 *   The filter or <code>undefined</code> if there is no such entity.
 	 *
 	 * @private
 	 */
-	_CollectionCache.prototype.getFilterExcludingCreated = function () {
+	_CollectionCache.prototype.getExclusiveFilter = function () {
 		var oElement,
 			aKeyFilters = [],
 			mTypeForMetaPath,
@@ -2476,9 +2546,7 @@ sap.ui.define([
 			}
 		}
 		(this.aElements.$deleted || []).forEach(function (oDeleted) {
-			if (oDeleted.created) {
-				addKeyFilter(that.aElements.$byPredicate[oDeleted.predicate]);
-			}
+			addKeyFilter(that.aElements.$byPredicate[oDeleted.predicate]);
 		});
 
 		return aKeyFilters.length ? "not (" + aKeyFilters.sort().join(" or ") + ")" : undefined;
@@ -2494,7 +2562,7 @@ sap.ui.define([
 	 * @private
 	 */
 	_CollectionCache.prototype.getQueryString = function () {
-		var sExclusiveFilter = this.getFilterExcludingCreated(),
+		var sExclusiveFilter = this.getExclusiveFilter(),
 			mQueryOptions = Object.assign({}, this.mQueryOptions),
 			sFilterOptions = mQueryOptions.$filter,
 			sQueryString = this.sQueryString;
@@ -2513,28 +2581,6 @@ sap.ui.define([
 		return sQueryString;
 	};
 
-	/**
-	 * Determines the offset to <code>$skip</code> due to deleted elements in other groups.
-	 *
-	 * @param {string} sGroupId - The group ID for the read request
-	 * @param {number} iStart - The start index for the read
-	 * @returns {number} The offset
-	 */
-	_CollectionCache.prototype.getReadOffset = function (sGroupId, iStart) {
-		var iOffset = 0;
-
-		(this.aElements.$deleted || []).forEach(function (oDeleteInfo) {
-			// if deleting in the same group, the entity is gone when the server reads
-			// created-persisted entities are excluded via filter
-			if (oDeleteInfo.groupId !== sGroupId && !oDeleteInfo.created
-					&& oDeleteInfo.index <= iStart) {
-				iOffset += 1;
-			}
-		});
-
-		return iOffset;
-	};
-
 	/**
 	 * Returns the resource path including the query string with $skip and $top if needed.
 	 *
@@ -2616,7 +2662,7 @@ sap.ui.define([
 			iResultLength = oResult.value.length,
 			i;
 
-		// simulate #getFilterExcludingCreated for newly created persisted
+		// simulate #getExclusiveFilter for newly created persisted
 		iEnd -= iFiltered;
 		iResultLength -= iFiltered;
 
@@ -2788,7 +2834,7 @@ sap.ui.define([
 				// count persisted inline creation rows which are refreshed separately during a
 				// side-effects refresh (see #refreshKeptElements) and might be deleted on server;
 				// increase prefetch to compensate for our exclusive filter (see
-				// #getFilterExcludingCreated) (JIRA: CPOUI5ODATAV4-1521)
+				// #getExclusiveFilter) (JIRA: CPOUI5ODATAV4-1521)
 				iCreatedPersisted += 1;
 			}
 		}
@@ -2960,8 +3006,7 @@ sap.ui.define([
 	 */
 	_CollectionCache.prototype.requestElements = function (iStart, iEnd, oGroupLock,
 			iTransientElements, fnDataRequested) {
-		var iOffset = this.getReadOffset(oGroupLock.getGroupId(), iStart),
-			oPromise,
+		var oPromise,
 			oReadRequest = {
 				iEnd : iEnd,
 				iStart : iStart
@@ -2972,12 +3017,13 @@ sap.ui.define([
 		this.bSentRequest = true;
 		oPromise = SyncPromise.all([
 			this.oRequestor.request("GET",
-				this.getResourcePathWithQuery(iStart + iOffset, iEnd + iOffset),
+				this.getResourcePathWithQuery(iStart, iEnd),
 				oGroupLock, undefined, undefined, fnDataRequested),
 			this.fetchTypes()
 		]).then(function (aResult) {
 			var iFiltered;
 
+			that.checkRange(oPromise, oReadRequest.iStart, oReadRequest.iEnd);
 			if (that.aElements.$tail === oPromise) {
 				that.aElements.$tail = undefined;
 			}
@@ -2986,6 +3032,7 @@ sap.ui.define([
 			return that.handleCount(oGroupLock, iTransientElements, oReadRequest.iStart,
 				oReadRequest.iEnd, aResult[0], iFiltered);
 		}).catch(function (oError) {
+			that.checkRange(oPromise, oReadRequest.iStart, oReadRequest.iEnd);
 			that.fill(undefined, oReadRequest.iStart, oReadRequest.iEnd);
 			throw oError;
 		}).finally(function () {
@@ -3138,8 +3185,8 @@ sap.ui.define([
 				for (i = 0, n = oResult.value.length; i < n; i += 1) {
 					oElement = oResult.value[i];
 					sPredicate = _Helper.getPrivateAnnotation(oElement, "predicate");
-					_Helper.updateAll(that.mChangeListeners, sPredicate,
-						that.aElements.$byPredicate[sPredicate], oElement,
+					_Helper.updateSelected(that.mChangeListeners, sPredicate,
+						that.aElements.$byPredicate[sPredicate], oElement, aPaths,
 						preventKeyPredicateChange);
 				}
 			});
@@ -3660,11 +3707,12 @@ sap.ui.define([
 				_Helper.getPrivateAnnotation(oOldValue, "predicate"));
 			// visit response to report the messages
 			that.visitResponse(oNewValue, aResult[1]);
-			_Helper.updateAll(that.mChangeListeners, "", oOldValue, oNewValue, function (sPath) {
-				// not (below) a $NavigationPropertyPath?
-				return !aPaths.some(function (sSideEffectPath) {
-					return _Helper.getRelativePath(sPath, sSideEffectPath) !== undefined;
-				});
+			_Helper.updateSelected(that.mChangeListeners, "", oOldValue, oNewValue, aPaths,
+				function (sPath) {
+					// not (below) a $NavigationPropertyPath?
+					return !aPaths.some(function (sSideEffectPath) {
+						return _Helper.getRelativePath(sPath, sSideEffectPath) !== undefined;
+					});
 			});
 		});
 
@@ -3993,16 +4041,22 @@ sap.ui.define([
 	 *   The property path split into an array of segments
 	 * @param {any} vValue
 	 *   The property value
+	 * @param {boolean} [bUpdating]
+	 *   Whether the given property will not be overwritten by a creation POST(+GET) response
 	 * @returns {object}
 	 *   The resulting object
 	 *
 	 * @private
 	 */
-	_Cache.makeUpdateData = function (aPropertyPath, vValue) {
+	_Cache.makeUpdateData = function (aPropertyPath, vValue, bUpdating) {
 		return aPropertyPath.reduceRight(function (vValue0, sSegment) {
 			var oResult = {};
 
 			oResult[sSegment] = vValue0;
+			if (bUpdating) {
+				oResult[sSegment + "@$ui5.updating"] = true;
+				bUpdating = false;
+			}
 			return oResult;
 		}, vValue);
 	};

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

@@ -19,9 +19,8 @@ sap.ui.define([
 		 * @param {sap.ui.model.odata.v4.lib._CollectionCache} oCache
 		 *   The cache to be enhanced
 		 * @param {object} oAggregation
-		 *   An object holding the information needed for data aggregation; see also
-		 *   <a href="http://docs.oasis-open.org/odata/odata-data-aggregation-ext/v4.0/">OData
-		 *   Extension for Data Aggregation Version 4.0</a>; must already be normalized by
+		 *   An object holding the information needed for data aggregation; see also "OData
+		 *   Extension for Data Aggregation Version 4.0"; must already be normalized by
 		 *   {@link _AggregationHelper.buildApply}
 		 * @param {function[]} [aAdditionalRowHandlers]
 		 *   Handlers for the additional response rows (which are automatically scanned for