@openui5/sap.ui.core 1.104.0 → 1.105.1

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

@@ -42,7 +42,7 @@ sap.ui.define([
 		 * @hideconstructor
 		 * @public
 		 * @since 1.39.0
-		 * @version 1.104.0
+		 * @version 1.105.1
 		 */
 		Context = BaseContext.extend("sap.ui.model.odata.v4.Context", {
 				constructor : constructor
@@ -126,6 +126,7 @@ sap.ui.define([
 			// ensure to return a promise that is resolved w/o data
 			&& Promise.resolve(oCreatePromise).then(function () {});
 		this.oSyncCreatePromise = oCreatePromise;
+		this.bDeleted = false; // deleted on the client, but not on the server yet
 		this.iGeneration = iGeneration || 0;
 		this.bInactive = bInactive || undefined; // be in sync with the annotation
 		this.iIndex = iIndex;
@@ -276,16 +277,27 @@ sap.ui.define([
 	};
 
 	/**
-	 * Deletes the OData entity this context points to.
+	 * Deletes the OData entity this context points to. The context is removed from the binding
+	 * immediately, even if {@link sap.ui.model.odata.v4.SubmitMode.API} is used, and the request is
+	 * only sent later when {@link sap.ui.model.odata.v4.ODataModel#submitBatch} is called. As long
+	 * as the context is deleted on the client, but not yet on the server, {@link #isDeleted}
+	 * returns <code>true</code>.
+	 *
+	 * Since 1.105 such a pending deletion is a pending change. It causes
+	 * <code>hasPendingChanges</code> to return <code>true</code> for the context, the binding
+	 * containing it, and the model. <code>resetChanges</code> in binding or model cancels the
+	 * deletion and restores the context.
+	 *
+	 * The usage of a group ID with {@link sap.ui.model.odata.v4.SubmitMode.API} is possible since
+	 * 1.105 - this is an experimental API.
 	 *
 	 * The context must not be used anymore after successful deletion.
 	 *
 	 * @param {string} [sGroupId]
 	 *   The group ID to be used for the DELETE request; if not specified, the update group ID for
-	 *   the context's binding is used, see {@link #getUpdateGroupId}; the resulting group ID must
-	 *   not have {@link sap.ui.model.odata.v4.SubmitMode.API}. Since 1.81, if this context is
-	 *   transient (see {@link #isTransient}), no group ID needs to be specified. Since 1.98.0, you
-	 *   can use <code>null</code> to prevent the DELETE request in case of a kept-alive context
+	 *   the context's binding is used, see {@link #getUpdateGroupId}. Since 1.81, if this context
+	 *   is transient (see {@link #isTransient}), no group ID needs to be specified. Since 1.98.0,
+	 *   you can use <code>null</code> to prevent the DELETE request in case of a kept-alive context
 	 *   that is not in the collection and of which you know that it does not exist on the server
 	 *   anymore (for example, a draft after activation).
 	 * @param {boolean} [bDoNotRequestCount]
@@ -294,24 +306,40 @@ sap.ui.define([
 	 *   Since 1.98.0, this is implied if a <code>null</code> group ID is used.
 	 * @returns {Promise}
 	 *   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, e.g. if the given context does not point
-	 *   to an entity, if it is not part of a list binding, if there are pending changes for the
-	 *   context's binding, if the resulting group ID has SubmitMode.API, or if the deletion on the
-	 *   server fails.
-	 *   <p>
-	 *   The error instance is flagged with <code>isConcurrentModification</code> in case a
-	 *   concurrent modification (e.g. by another user) of the entity between loading and deletion
-	 *   has been detected; this should be shown to the user who needs to decide whether to try
-	 *   deletion again. If the entity does not exist, we assume it has already been deleted by
-	 *   someone else and report success.
-	 * @throws {Error} If the given group ID is invalid, if this context's root binding is
-	 *   suspended, or if this context is not transient (see {@link #isTransient}) and has pending
-	 *   changes (see {@link #hasPendingChanges}), or if a <code>null</code> group ID is used with
-	 *   a context which is not kept-alive (see {@link #isKeepAlive}) or is still in the collection
-	 *   (has an index, see {@link #getIndex})
+	 *   instance of <code>Error</code> in case of failure, for example if:
+	 *   <ul>
+	 *     <li> the given context does not point to an entity,
+	 *     <li> the deletion on the server fails,
+	 *     <li> the deletion is canceled via <code>resetChanges</code> (in this case the error
+	 *       instance has the property <code>canceled</code> with value <code>true</code>).
+	 *   </ul>
+	 *   The error instance has the property <code>isConcurrentModification</code> with value
+	 *   <code>true</code> in case a concurrent modification (e.g. by another user) of the entity
+	 *   between loading and deletion has been detected; this should be shown to the user who needs
+	 *   to decide whether to try deletion again. If the entity does not exist, we assume it has
+	 *   already been deleted by someone else and report success.
+	 * @throws {Error} If
+	 *   <ul>
+	 *     <li> the given group ID is invalid,
+	 *     <li> this context's root binding is suspended,
+	 *     <li> a <code>null</code> group ID is used with a context which is not kept-alive
+	 *       (see {@link #isKeepAlive}),
+	 *     <li> the context is already being deleted,
+	 *     <li> the resulting group ID has {@link sap.ui.model.odata.v4.SubmitMode.API}, and the
+	 *       context is kept alive (see {@link #isKeepAlive}), but not in the current collection,
+	 *     <li> (only before 1.105) the resulting group ID has
+	 *       {@link sap.ui.model.odata.v4.SubmitMode.API}
+	 *   </ul>
 	 *
 	 * @function
 	 * @public
+	 * @see {#hasPendingChanges}
+	 * @see {sap.ui.model.odata.v4.ODataContextBinding#hasPendingChanges}
+	 * @see {sap.ui.model.odata.v4.ODataListBinding#hasPendingChanges}
+	 * @see {sap.ui.model.odata.v4.ODataModel#hasPendingChanges}
+	 * @see {sap.ui.model.odata.v4.ODataContextBinding#resetChanges}
+	 * @see {sap.ui.model.odata.v4.ODataListBinding#resetChanges}
+	 * @see {sap.ui.model.odata.v4.ODataModel#resetChanges}
 	 * @since 1.41.0
 	 */
 	Context.prototype.delete = function (sGroupId, bDoNotRequestCount/*, bRejectIfNotFound*/) {
@@ -319,11 +347,12 @@ sap.ui.define([
 			oModel = this.oModel,
 			that = this;
 
+		if (this.isDeleted()) {
+			throw new Error("Must not delete twice: " + this);
+		}
 		this.oBinding.checkSuspended();
 		if (this.isTransient()) {
 			sGroupId = null;
-		} else if (this.hasPendingChanges()) {
-			throw new Error("Cannot delete due to pending changes");
 		} else if (sGroupId === null) {
 			if (!(this.bKeepAlive && this.iIndex === undefined)) {
 				throw new Error("Cannot delete " + this);
@@ -334,15 +363,15 @@ sap.ui.define([
 		} else {
 			oModel.checkGroupId(sGroupId);
 			oGroupLock = this.oBinding.lockGroup(sGroupId, true, true);
-			sGroupId = oGroupLock.getGroupId();
-			if (this.oModel.isApiGroup(sGroupId)) {
-				throw new Error("Illegal update group ID: " + sGroupId);
-			}
 		}
 
-		return this._delete(oGroupLock, /*oETagEntity*/null, bDoNotRequestCount).then(function () {
+		this.bDeleted = true;
+
+		return Promise.resolve(this._delete(oGroupLock, /*oETagEntity*/null, bDoNotRequestCount))
+		.then(function () {
 			var sResourcePathPrefix = that.sPath.slice(1);
 
+			that.bDeleted = false;
 			// Messages have been updated via _Cache#_delete; "that" is already destroyed; remove
 			// all dependent caches in all bindings
 			oModel.getAllBindings().forEach(function (oBinding) {
@@ -353,6 +382,8 @@ sap.ui.define([
 				oGroupLock.unlock(true);
 			}
 			oModel.reportError("Failed to delete " + that, sClassName, oError);
+			that.bDeleted = false;
+			that.checkUpdate();
 			throw oError;
 		});
 	};
@@ -405,6 +436,7 @@ sap.ui.define([
 	 *   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, for example if the annotation belongs to
 	 *   the read-only namespace "@$ui5.*"
+	 * @throws {Error} If the context is deleted
 	 *
 	 * @private
 	 */
@@ -414,6 +446,12 @@ sap.ui.define([
 			oValue,
 			that = this;
 
+		if (this.isDeleted()) {
+			if (oGroupLock) {
+				oGroupLock.unlock();
+			}
+			throw new Error("must not modify a deleted entity: " + this);
+		}
 		if (oGroupLock && this.isTransient() && !this.isInactive()) {
 			oValue = this.getValue();
 			oPromise = oValue && _Helper.getPrivateAnnotation(oValue, "transient");
@@ -875,12 +913,28 @@ sap.ui.define([
 	 */
 	Context.prototype.hasPendingChanges = function () {
 		return this.isTransient()
+			|| this.isDeleted()
 			|| this.oModel.getDependentBindings(this).some(function (oDependentBinding) {
 				return oDependentBinding.hasPendingChanges();
 			})
 			|| this.oModel.withUnresolvedBindings("hasPendingChangesInCaches", this.sPath.slice(1));
 	};
 
+	/**
+	 * Returns whether this context is deleted on the client, but not on the server yet. The result
+	 * of this function can also be accessed via the "@$ui5.context.isDeleted" instance annotation
+	 * at the entity.
+	 *
+	 * @returns {boolean} <code>true</code> if this context is deleted
+	 *
+	 * @public
+	 * @see #delete
+	 * @since 1.105
+	 */
+	Context.prototype.isDeleted = function () {
+		return this.bDeleted;
+	};
+
 	/**
 	 * Tells whether the group node that this context points to is expanded.
 	 *
@@ -1617,8 +1671,8 @@ sap.ui.define([
 	 *     <li> {@link sap.ui.model.odata.v4.ODataListBinding#resetChanges}.
 	 *   </ul>
 	 * @throws {Error}
-	 *   If the binding's root binding is suspended, for invalid group IDs, or if the new value is
-	 *   not primitive
+	 *   If the binding's root binding is suspended, for invalid group IDs, if the new value is
+	 *   not primitive, or if the context is deleted
 	 *
 	 * @public
 	 * @see #getProperty

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

@@ -313,6 +313,7 @@ sap.ui.define([
 				undefined, sGroupId, oOldCache);
 		}
 		if (oOldCache && oOldCache !== oCache) {
+			oOldCache.deregisterChangeListener("", this);
 			oOldCache.setActive(false);
 		}
 		if (this.mLateQueryOptions) {
@@ -330,9 +331,12 @@ sap.ui.define([
 	 * @since 1.66
 	 */
 	ODataBinding.prototype.destroy = function () {
+		var that = this;
+
 		this.mCacheByResourcePath = undefined;
 		this.oCachePromise.then(function (oOldCache) {
 			if (oOldCache) {
+				oOldCache.deregisterChangeListener("", that);
 				oOldCache.setActive(false);
 			}
 		}, function () {});
@@ -381,7 +385,7 @@ sap.ui.define([
 	 * @private
 	 */
 	ODataBinding.prototype.doDeregisterChangeListener = function (sPath, oListener) {
-		this.oCache.deregisterChange(sPath, oListener);
+		this.oCache.deregisterChangeListener(sPath, oListener);
 	};
 
 	/**
@@ -540,7 +544,7 @@ sap.ui.define([
 		// With $$aggregation, no auto-$expand/$select is needed
 		oQueryOptionsPromise = this.doFetchQueryOptions(oContext);
 		if (this.oModel.bAutoExpandSelect && this.aChildCanUseCachePromises
-				&& !this.mParameters.$$aggregation) {
+				&& !_Helper.isDataAggregation(this.mParameters)) {
 			// For auto-$expand/$select, wait for query options of dependent bindings:
 			// Promise.resolve() ensures all dependent bindings are created and have sent their
 			// query options promise to this binding via fetchIfChildCanUseCache.
@@ -703,7 +707,7 @@ sap.ui.define([
 			}
 			// Can only become undefined when a list binding's context has been parked and is
 			// destroyed later. Such a context does no longer have a subpath of the binding's
-			// path. The only caller in this case is ODataPropertyBinding#deregisterChange
+			// path. The only caller in this case is ODataPropertyBinding#deregisterChangeListener
 			// which can safely be ignored.
 			return sRelativePath;
 		}
@@ -1293,8 +1297,7 @@ sap.ui.define([
 
 	/**
 	 * Recursively visits all dependent bindings of (the given context of) this binding. Bindings
-	 * with an own cache will request side effects themselves as applicable. Bindings mentioned
-	 * in <code>mNavigationPropertyPaths</code> will refresh themselves.
+	 * with an own cache will request side effects themselves as applicable.
 	 *
 	 * @param {string} sGroupId
 	 *   The group ID to be used for requesting side effects
@@ -1304,9 +1307,6 @@ sap.ui.define([
 	 *   because they may have changed due to side effects of a previous update
 	 * @param {sap.ui.model.odata.v4.Context} [oContext]
 	 *   The context for which to request side effects; if missing, the whole binding is affected
-	 * @param {object} mNavigationPropertyPaths
-	 *   Hash set of collection-valued navigation property meta paths (relative to this binding's
-	 *   cache root) which need to be refreshed, maps string to <code>true</code>; read-only
 	 * @param {Promise[]} aPromises
 	 *   List of (sync) promises which is extended for each call to
 	 *   {@link sap.ui.model.odata.v4.ODataParentBinding#requestSideEffects} or

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

@@ -74,7 +74,7 @@ sap.ui.define([
 		 * @mixes sap.ui.model.odata.v4.ODataParentBinding
 		 * @public
 		 * @since 1.37.0
-		 * @version 1.104.0
+		 * @version 1.105.1
 		 *
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getGroupId as #getGroupId
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getRootBinding as #getRootBinding
@@ -235,7 +235,10 @@ sap.ui.define([
 		// the context(s) in that uppermost binding. Note that no data may be available in the
 		// uppermost context binding and hence the deletion would not work there, BCP 1980308439.
 		var oEmptyPathParentContext = this._findEmptyPathParentContext(this.oElementContext),
-			oEmptyPathParentBinding = oEmptyPathParentContext.getBinding();
+			oEmptyPathParentBinding = oEmptyPathParentContext.getBinding(),
+			oDeleteParentContext = oEmptyPathParentBinding.getContext(),
+			oReturnValueContext = oEmptyPathParentBinding.oReturnValueContext,
+			that = this;
 
 		// In case the uppermost parent reached with empty paths is a list binding, delete there.
 		if (!oEmptyPathParentBinding.execute) {
@@ -249,27 +252,27 @@ sap.ui.define([
 			// deleteFromCache call below. In Context#delete the error is reported.
 		}
 
-		return this.deleteFromCache(oGroupLock, sEditUrl, "", null, bDoNotRequestCount,
-			function () {
-				oEmptyPathParentBinding._destroyContextAfterDelete();
-			});
-	};
-
-	/**
-	 * Destroys the element context and, if available, the return value context, and fires a
-	 * change. The method is called by #_delete, possibly at another context binding for the same
-	 * entity, after the successful deletion in the back end.
-	 *
-	 * @private
-	 */
-	ODataContextBinding.prototype._destroyContextAfterDelete = function () {
-		this.oElementContext.destroy();
-		this.oElementContext = null;
-		if (this.oReturnValueContext) {
-			this.oReturnValueContext.destroy();
-			this.oReturnValueContext = null;
+		oEmptyPathParentBinding.oElementContext = null;
+		if (oReturnValueContext) {
+			oEmptyPathParentBinding.oReturnValueContext = null;
 		}
 		this._fireChange({reason : ChangeReason.Remove});
+		return this.deleteFromCache(oGroupLock, sEditUrl, "", null).then(function () {
+			oEmptyPathParentContext.destroy();
+			if (oReturnValueContext) {
+				oReturnValueContext.destroy();
+			}
+		}, function (oError) {
+			if (!oEmptyPathParentBinding.isRelative()
+					|| oDeleteParentContext === oEmptyPathParentBinding.getContext()) {
+				oEmptyPathParentBinding.oElementContext = oEmptyPathParentContext;
+				if (oReturnValueContext) {
+					oEmptyPathParentBinding.oReturnValueContext = oReturnValueContext;
+				}
+				that._fireChange({reason : ChangeReason.Insert});
+			}
+			throw oError;
+		});
 	};
 
 	/**
@@ -1450,9 +1453,6 @@ sap.ui.define([
 	 */
 	ODataContextBinding.prototype.requestSideEffects = function (sGroupId, aPaths, oContext) {
 		var oModel = this.oModel,
-			// Hash set of collection-valued navigation property meta paths (relative to the cache's
-			// root) which need to be refreshed, maps string to <code>true</code>
-			mNavigationPropertyPaths = {},
 			aPromises = [],
 			that = this;
 
@@ -1476,10 +1476,9 @@ sap.ui.define([
 			try {
 				aPromises.push(
 					this.oCache.requestSideEffects(this.lockGroup(sGroupId), aPaths,
-						mNavigationPropertyPaths, oContext && oContext.getPath().slice(1)));
+						oContext && oContext.getPath().slice(1)));
 
-				this.visitSideEffects(sGroupId, aPaths, oContext, mNavigationPropertyPaths,
-					aPromises);
+				this.visitSideEffects(sGroupId, aPaths, oContext, aPromises);
 
 				return SyncPromise.all(aPromises.map(reportError)).then(function () {
 					return that.refreshDependentListBindingsWithoutCache();