@openui5/sap.ui.core 1.117.1 → 1.119.0

package/src/sap/ui/model/odata/v2/ODataModel.js

@@ -35,8 +35,8 @@ sap.ui.define([
 	"sap/ui/base/SyncPromise",
 	"sap/ui/core/Configuration",
 	"sap/ui/core/library",
+	"sap/ui/core/Messaging",
 	"sap/ui/core/message/Message",
-	"sap/ui/core/message/MessageManager",
 	"sap/ui/core/message/MessageParser",
 	"sap/ui/model/_Helper",
 	"sap/ui/model/BindingMode",
@@ -58,7 +58,7 @@ sap.ui.define([
 ], function(_CreatedContextsCache, Context, ODataAnnotations, ODataContextBinding, ODataListBinding,
 		ODataTreeBinding, assert, Log, encodeURL, deepEqual, deepExtend, each, extend,
 		isEmptyObject, isPlainObject, merge, uid, UriParameters, SyncPromise, Configuration,
-		coreLibrary, Message, MessageManager, MessageParser, _Helper, BindingMode, BaseContext, FilterProcessor,
+		coreLibrary, Messaging, Message, MessageParser, _Helper, BindingMode, BaseContext, FilterProcessor,
 		Model, CountMode, MessageScope, ODataMetadata, ODataMetaModel, ODataMessageParser,
 		ODataPropertyBinding, ODataUtils, OperationMode, UpdateMethod, OData, URI, isCrossOriginURL
 ) {
@@ -181,8 +181,11 @@ sap.ui.define([
 	 * @param {Object<string,string>} [mParameters.serviceUrlParams]
 	 *   Map of URL parameters (name/value pairs) - these parameters will be attached to all
 	 *   requests, except for the <code>$metadata</code> request
-	 * @param {boolean} [mParameters.tokenHandling=true]
-	 *   Enable/disable security token handling
+	 * @param {boolean|"skipServerCache"} [mParameters.tokenHandling=true]
+	 *   Enable/disable security token handling. If the "skipServerCache" string value is provided, the security token
+	 *   is not cached with the server as key in order to avoid failing $batch requests when accessing services running
+	 *   on different back-end systems behind a reverse proxy (since 1.119).<br>
+	 *   Use this option only if the system landscape is known.
 	 * @param {boolean} [mParameters.tokenHandlingForGet=false]
 	 *   Send security token for GET requests in case read access logging is activated for the OData
 	 *   Service in the backend.
@@ -213,7 +216,7 @@ sap.ui.define([
 	 * This model is not prepared to be inherited from.
 	 *
 	 * @author SAP SE
-	 * @version 1.117.1
+	 * @version 1.119.0
 	 *
 	 * @public
 	 * @alias sap.ui.model.odata.v2.ODataModel
@@ -227,7 +230,7 @@ sap.ui.define([
 			var sUser,
 				sPassword,
 				mHeaders,
-				bTokenHandling,
+				vTokenHandling,
 				bWithCredentials,
 				sMaxDataServiceVersion,
 				bUseBatch,
@@ -272,7 +275,7 @@ sap.ui.define([
 				sUser = mParameters.user;
 				sPassword = mParameters.password;
 				mHeaders = mParameters.headers;
-				bTokenHandling = mParameters.tokenHandling;
+				vTokenHandling = mParameters.tokenHandling;
 				bWithCredentials = mParameters.withCredentials;
 				sMaxDataServiceVersion = mParameters.maxDataServiceVersion;
 				bUseBatch = mParameters.useBatch;
@@ -334,7 +337,7 @@ sap.ui.define([
 			this.mLaunderingState = {};
 			this.sDefaultUpdateMethod = sDefaultUpdateMethod || UpdateMethod.Merge;
 
-			this.bTokenHandling = bTokenHandling !== false;
+			this.bTokenHandling = vTokenHandling !== false;
 			this.bWithCredentials = bWithCredentials === true;
 			this.bUseBatch = bUseBatch !== false;
 			this.bRefreshAfterChange = bRefreshAfterChange !== false;
@@ -414,11 +417,11 @@ sap.ui.define([
 				this.oHeaders["sap-contextid-accept"] = "header";
 				this.mCustomHeaders["sap-contextid-accept"] = "header";
 			}
-			// Get/create shared data containers
-			var sServerUrl = this._getServerUrl();
 			//use warmup url if provided
 			this.sMetadataUrl = this.sWarmupUrl || this._createMetadataUrl("/$metadata");
-			this.oSharedServerData = ODataModel._getSharedData("server", sServerUrl);
+			this.oSharedServerData = vTokenHandling === "skipServerCache"
+				? undefined // server cache for security tokens is not used
+				: ODataModel._getSharedData("server", this._getServerUrl());
 			this.oSharedServiceData = ODataModel._getSharedData("service", this.sServiceUrl);
 			this.oSharedMetaData = ODataModel._getSharedData("meta", this.sMetadataUrl);
 
@@ -494,7 +497,7 @@ sap.ui.define([
 			if (this.bTokenHandling) {
 				if (this.oSharedServiceData.securityToken) {
 					this.oHeaders["x-csrf-token"] = this.oSharedServiceData.securityToken;
-				} else if (this.oSharedServerData.securityToken) {
+				} else if (this.oSharedServerData && this.oSharedServerData.securityToken) {
 					this.oSharedServiceData.securityToken = this.oSharedServerData.securityToken;
 					this.oHeaders["x-csrf-token"] = this.oSharedServiceData.securityToken;
 				}
@@ -3277,12 +3280,12 @@ sap.ui.define([
 	};
 
 	/**
-	 * Returns the current security token.
+	 * Returns the current security token if available; triggers a request to fetch the security token if it is not
+	 * available.
 	 *
-	 * If the token has not been requested from the server it will be requested first (synchronously).
-	 *
-	 * @returns {string} The security token
+	 * @returns {string|undefined} The security token; <code>undefined</code> if it is not available
 	 *
+	 * @deprecated since 1.119.0; use {@link #securityTokenAvailable} instead
 	 * @public
 	 */
 	ODataModel.prototype.getSecurityToken = function() {
@@ -3345,7 +3348,9 @@ sap.ui.define([
 				sToken = that._getHeader("x-csrf-token", oResponse.headers);
 				that._setSessionContextIdHeader(that._getHeader("sap-contextid", oResponse.headers));
 				if (sToken) {
-					that.oSharedServerData.securityToken = sToken;
+					if (that.oSharedServerData) {
+						that.oSharedServerData.securityToken = sToken;
+					}
 					that.oSharedServiceData.securityToken = sToken;
 					that.pSecurityToken = Promise.resolve(sToken);
 					// For compatibility with applications, that are using getHeaders() to retrieve the current
@@ -6427,7 +6432,7 @@ sap.ui.define([
 		} else {
 			delete this.mChangedEntities[sKey];
 		}
-		MessageManager.removeMessages(this.getMessagesByEntity(sKey,
+		Messaging.removeMessages(this.getMessagesByEntity(sKey,
 			/*bExcludePersistent*/!bDeleteEntity));
 
 		return pMetaDataLoaded;
@@ -6970,7 +6975,7 @@ sap.ui.define([
 			});
 			that._removeEntity(sKey);
 			//cleanup Messages for created Entry
-			MessageManager.removeMessages(
+			Messaging.removeMessages(
 				this.getMessagesByEntity(oContext.getPath(), true));
 		}
 	};
@@ -7808,7 +7813,7 @@ sap.ui.define([
 	/**
 	 * Sets the <code>MessageParser</code> that is invoked upon every back-end request.
 	 *
-	 * This message parser analyzes the response and notifies the <code>MessageManager</code> about added and deleted messages.
+	 * This message parser analyzes the response and notifies the <code>Messaging</code> about added and deleted messages.
 	 *
 	 * @param {object|null} [oParser] The <code>MessageParser</code> instance that parses the responses and adds messages to the <code>MessageManager</code>
 	 * @return {this} Model instance for method chaining

package/src/sap/ui/model/odata/v2/ODataTreeBinding.js

@@ -93,7 +93,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.TreeBinding
 	 * @hideconstructor
 	 * @public
-	 * @version 1.117.1
+	 * @version 1.119.0
 	 */
 	var ODataTreeBinding = TreeBinding.extend("sap.ui.model.odata.v2.ODataTreeBinding", /** @lends sap.ui.model.odata.v2.ODataTreeBinding.prototype */ {
 
@@ -2609,16 +2609,42 @@ sap.ui.define([
 	 */
 
 	/**
-	 * Creates a new binding context related to this binding instance.
+	 * Creates a new entry for the tree.
 	 *
-	 * The available API is the same as for the v2.ODataModel.
-	 * See the API documentation here: {@link sap.ui.model.odata.v2.ODataModel#createEntry createEntry}.
+	 * A context object is returned which can be inserted in the tree hierarchy via
+	 * {@link sap.ui.model.odata.v2.ODataTreeBinding#addContexts addContexts}.
+	 * <b>Note:</b> The back-end request to create the entry is sent with the batch group stored at this binding's model
+	 * for this binding's resolved path.
 	 *
-	 * This feature is only available when the underlying OData service exposes the "hierarchy-node-descendant-count-for" annotation.
-	 * See the constructor documentation for more details.
+	 * This feature is only available when the underlying OData service exposes the
+	 * "hierarchy-node-descendant-count-for" annotation. See
+	 * {@link sap.ui.model.odata.v2.ODataModel#bindTree} for more details.
 	 *
 	 * @function
 	 * @name sap.ui.model.odata.v2.ODataTreeBinding.prototype.createEntry
+	 * @param {object} [mParameters]
+	 *   A map of the following parameters:
+	 * @param {string} [mParameters.changeSetId]
+	 *   The ID of the <code>ChangeSet</code> that this request should belong to
+	 * @param {function} [mParameters.created]
+	 *   The callback function that is called after the metadata of the service has been loaded and the
+	 *   {@link sap.ui.model.odata.v2.Context} instance for the newly created entry is available;
+	 *   The {@link sap.ui.model.odata.v2.Context} instance for the newly created entry is passed as
+	 *   the first and only parameter.
+	 * @param {function} [mParameters.error]
+	 *   The error callback function
+	 * @param {Object<string,string>} [mParameters.headers]
+	 *   A map of headers
+	 * @param {array|object} [mParameters.properties]
+	 *   An array that specifies a set of properties or the initial data for the new entity as an object
+	 * @param {function} [mParameters.success]
+	 *   The success callback function
+	 * @param {Object<string,string>} [mParameters.urlParameters]
+	 *   A map of URL parameters
+	 * @returns {sap.ui.model.odata.v2.Context|undefined}
+	 *   An OData V2 context object that points to the newly created entry, or
+	 *   <code>undefined</code> if the service metadata are not yet loaded or if a
+	 *   <code>created</code> callback parameter is given
 	 * @private
 	 * @ui5-restricted
 	 */
@@ -2635,6 +2661,7 @@ sap.ui.define([
 	 *
 	 * @function
 	 * @name sap.ui.model.odata.v2.ODataTreeBinding.prototype.submitChanges
+	 * @deprecated Since 1.104 use {@link sap.ui.model.odata.v2.ODataModel#submitChanges} instead
 	 * @private
 	 * @ui5-restricted
 	 */

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

@@ -42,7 +42,7 @@ sap.ui.define([
 		 * @hideconstructor
 		 * @public
 		 * @since 1.39.0
-		 * @version 1.117.1
+		 * @version 1.119.0
 		 */
 		Context = BaseContext.extend("sap.ui.model.odata.v4.Context", {
 				constructor : constructor
@@ -94,6 +94,8 @@ sap.ui.define([
 		this.oSyncCreatePromise = oCreatePromise;
 		// a promise waiting for the deletion, also used as indicator for #isDeleted
 		this.oDeletePromise = null;
+		// avoids recursion when calling #doSetProperty within the createActivate event handler
+		this.bFiringCreateActivate = false;
 		this.iGeneration = iGeneration || 0;
 		this.bInactive = bInactive || undefined; // be in sync with the annotation
 		this.iIndex = iIndex;
@@ -242,6 +244,11 @@ sap.ui.define([
 	 * model itself ensures that all bindings depending on this context become unresolved, but no
 	 * attempt is made to restore these bindings in case of reset or failure.
 	 *
+	 * Deleting a child node is supported (@experimental as of version 1.118.0) in a recursive
+	 * hierarchy (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}). As a
+	 * precondition, <code>oAggregation.expandTo</code> must be equal to one, and the context must
+	 * not be {@link #setKeepAlive kept-alive} and hidden (for example due to a filter).
+	 *
 	 * @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}. Since 1.81, if this context
@@ -275,7 +282,8 @@ sap.ui.define([
 	 *     <li> a <code>null</code> group ID is used with a context which is not
 	 *       {@link #isKeepAlive kept alive},
 	 *     <li> the context is already being deleted,
-	 *     <li> the context's binding is a list binding with data aggregation.
+	 *     <li> the context's binding is a list binding with data aggregation,
+	 *     <li> the restrictions for deleting from a recursive hierarchy (see above) are not met.
 	 *   </ul>
 	 *
 	 * @function
@@ -298,7 +306,7 @@ sap.ui.define([
 		if (this.isDeleted()) {
 			throw new Error("Must not delete twice: " + this);
 		}
-		if (this.oBinding.mParameters.$$aggregation) {
+		if (_Helper.isDataAggregation(this.oBinding.mParameters)) {
 			throw new Error("Cannot delete " + this + " when using data aggregation");
 		}
 		this.oBinding.checkSuspended();
@@ -536,17 +544,16 @@ sap.ui.define([
 							bUpdating);
 					}
 
-					if (that.isInactive()) {
+					if (that.isInactive() && !that.bFiringCreateActivate) {
 						// early cache update so that the new value is properly available on the
 						// event listener
 						// runs synchronously - setProperty calls fetchValue with $cached
 						oCache.setProperty(oResult.propertyPath, vValue, sEntityPath, bUpdating)
 							.catch(that.oModel.getReporter());
-						if (oBinding.fireCreateActivate(that)) {
-							that.bInactive = false;
-						} else {
-							that.bInactive = 1;
-						}
+						that.bFiringCreateActivate = true;
+						that.bInactive = oBinding.fireCreateActivate(that) ? false : 1;
+						that.bFiringCreateActivate = false;
+						oCache.setInactive(sEntityPath, that.bInactive);
 					}
 
 					// if request is canceled fnPatchSent and fnErrorCallback are not called and
@@ -555,7 +562,7 @@ sap.ui.define([
 						bSkipRetry ? undefined : errorCallback, oResult.editUrl, sEntityPath,
 						oMetaModel.getUnitOrCurrencyPath(that.oModel.resolve(sPath, that)),
 						oBinding.isPatchWithoutSideEffects(), patchSent,
-						that.isEffectivelyKeptAlive.bind(that), that.isInactive()
+						that.isEffectivelyKeptAlive.bind(that)
 					).then(function () {
 						firePatchCompleted(true);
 					}, function (oError) {
@@ -689,16 +696,18 @@ sap.ui.define([
 	};
 
 	/**
-	 * Returns the value at the given path and removes it from the cache.
+	 * Returns the collection at the given path and removes it from the cache if it is marked as
+	 * transferable.
 	 *
-	 * @param {string} sPath - The relative path of the property
-	 * @returns {any} The value
+	 * @param {string} sPath - The relative path of the collection
+	 * @returns {object[]|undefined} The collection or <code>undefined</code>
+	 * @throws {Error} If the given path does not point to a collection.
 	 *
 	 * @private
 	 */
-	Context.prototype.getAndRemoveValue = function (sPath) {
+	Context.prototype.getAndRemoveCollection = function (sPath) {
 		return this.withCache(function (oCache, sCachePath) {
-			return oCache.getAndRemoveValue(sCachePath);
+			return oCache.getAndRemoveCollection(sCachePath);
 		}, sPath, true).getResult();
 	};
 
@@ -1130,6 +1139,35 @@ sap.ui.define([
 		return this.oSyncCreatePromise && this.oSyncCreatePromise.isPending();
 	};
 
+	/**
+	 * Moves this node to the given parent (in case of a recursive hierarchy, see
+	 * {@link #setAggregation}, where <code>oAggregation.expandTo</code> must be one). No other
+	 * {@link sap.ui.model.odata.v4.ODataListBinding#create creation}, {@link #delete deletion}, or
+	 * move must be pending, and no other modification (including collapse of some ancestor node)
+	 * must happen while this move is pending!
+	 *
+	 * This context's {@link #getIndex index} may change and it becomes "created persisted", with
+	 * {@link #isTransient} returning <code>false</code> etc.
+	 *
+	 * @param {object} oParameters - A parameter object
+	 * @param {sap.ui.model.odata.v4.Context} oParameters.parent - The new parent's context
+	 * @returns {Promise<void>}
+	 *   A promise which is resolved without a defined result when the move is finished, or
+	 *   rejected in case of an error
+	 * @throws (Error)
+	 *   If the parent is missing or (a descendant of) this node.
+	 *
+	 * @experimental As of version 1.119.0
+	 * @public
+	 */
+	Context.prototype.move = function ({parent : oParent}) {
+		if (!oParent || oParent === this) {
+			throw new Error("Unsupported parent context: " + oParent);
+		}
+
+		return Promise.resolve(this.oBinding.move(this, oParent));
+	};
+
 	/**
 	 * Patches the context data with the given patch data.
 	 *
@@ -1431,8 +1469,8 @@ sap.ui.define([
 	 * If the group ID has submit mode {@link sap.ui.model.odata.v4.SubmitMode.Auto} and there are
 	 * currently running updates or creates this method first waits for them to be processed.
 	 *
-	 * The events 'dataRequested' and 'dataReceived' are not fired. Whatever should happen in the
-	 * event handler attached to...
+	 * The 'dataRequested' and 'dataReceived' events are not fired unless a binding is refreshed
+	 * completely. Whatever should happen in the event handler attached to...
 	 * <ul>
 	 *   <li> 'dataRequested', can instead be done before calling {@link #requestSideEffects}.
 	 *   <li> 'dataReceived', can instead be done once the <code>oPromise</code> returned by
@@ -1440,7 +1478,7 @@ sap.ui.define([
 	 *     <code>oPromise.then(function () {...}, function () {...})</code>).
 	 * </ul>
 	 *
-	 * @param {object[]|string[]} aPathExpressions
+	 * @param {Array<sap.ui.model.odata.v4.ts.NavigationPropertyPathExpression|sap.ui.model.odata.v4.ts.PropertyPathExpression|string>} aPathExpressions
 	 *   The "14.5.11 Expression edm:NavigationPropertyPath" or
 	 *   "14.5.13 Expression edm:PropertyPath" objects describing which properties need to be
 	 *   loaded because they may have changed due to side effects of a previous update, for example
@@ -1721,7 +1759,8 @@ sap.ui.define([
 
 		if (this.iIndex === iVIRTUAL || this.isTransient() && !this.isInactive()
 			|| this.oBinding.getHeaderContext && this === this.oBinding.getHeaderContext()
-			|| this.oBinding.getParameterContext && this === this.oBinding.getParameterContext()) {
+			// only operation bindings have a parameter context, for others the function fails
+			|| this.oBinding.oOperation && this === this.oBinding.getParameterContext()) {
 			throw new Error("Cannot reset: " + this);
 		}
 
@@ -1754,12 +1793,29 @@ sap.ui.define([
 		this.bSelected = false;
 	};
 
+	/**
+	 * Sets this context's state from "persisted" to "created persisted".
+	 *
+	 * Note: this is a private and internal API. Do not call this!
+	 *
+	 * @throws {Error} If this context is already "created"
+	 *
+	 * @private
+	 */
+	Context.prototype.setCreatedPersisted = function () {
+		if (this.oCreatedPromise) {
+			throw new Error("Already 'created', currently transient: " + this.isTransient());
+		}
+		this.oCreatedPromise = Promise.resolve();
+		this.oSyncCreatePromise = SyncPromise.resolve();
+	};
+
 	/**
 	 * Sets the inactive flag to <code>true</code>
 	 *
 	 * Note: this is a private and internal API. Do not call this!
 	 *
-	 * @throws {Error} - If this context is not inactive
+	 * @throws {Error} If this context is not inactive
 	 *
 	 * @private
 	 * @see #isInactive
@@ -1786,9 +1842,13 @@ sap.ui.define([
 	 *
 	 * @param {boolean} bKeepAlive
 	 *   Whether to keep the context alive
-	 * @param {function} [fnOnBeforeDestroy]
-	 *   Callback function that is executed once for a kept-alive context just before it is
-	 *   destroyed, see {@link #destroy}. Supported since 1.84.0
+	 * @param {function((sap.ui.model.odata.v4.Context|undefined))} [fnOnBeforeDestroy]
+	 *   Callback function that is executed once for a kept-alive context without any argument just
+	 *   before the context is destroyed; see {@link #destroy}. If a context has been replaced in a
+	 *   list binding (see {@link #replaceWith} and
+	 *   {@link sap.ui.odata.v4.ODataContextBinding#execute}), the callback will later also be
+	 *   called just before the replacing context is destroyed, but with that context as the only
+	 *   argument. Supported since 1.84.0
 	 * @param {boolean} [bRequestMessages]
 	 *   Whether to request messages for this entity. Only used if <code>bKeepAlive</code> is
 	 *   <code>true</code>. Determines the messages property from the annotation

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

@@ -433,16 +433,25 @@ sap.ui.define([
 	 * Deregisters the given change listener from the given path.
 	 *
 	 * @param {string} sPath
-	 *   The path relative to the binding
+	 *   The absolute path
 	 * @param {object} oListener
 	 *   The change listener
 	 *
 	 * @private
 	 */
 	ODataBinding.prototype.doDeregisterChangeListener = function (sPath, oListener) {
-		if (this.oCache) {
-			this.oCache.deregisterChangeListener(sPath, oListener);
-		}
+		this.oCachePromise.then((oCache) => {
+			if (oCache) {
+				const sRelativePath = _Helper.getRelativePath(sPath, this.getResolvedPath());
+				if (sRelativePath !== undefined) {
+					oCache.deregisterChangeListener(sRelativePath, oListener);
+					return;
+				}
+			}
+			if (this.bRelative && this.oContext && this.oContext.getBinding) {
+				this.oContext.getBinding().doDeregisterChangeListener(sPath, oListener);
+			}
+		});
 	};
 
 	/**