@openui5/sap.ui.integration 1.120.10 → 1.121.1

package/src/sap/ui/integration/util/CsrfTokenHandler.js

@@ -8,16 +8,18 @@ sap.ui.define([
 	"sap/ui/base/Object",
 	"sap/base/util/isPlainObject",
 	"sap/base/util/merge",
-	"sap/ui/model/json/JSONModel"
+	"sap/ui/model/json/JSONModel",
+	"../cards/data/CsrfToken"
 ], function (
 	BaseObject,
 	isPlainObject,
 	merge,
-	JSONModel
+	JSONModel,
+	CsrfToken
 ) {
 	"use strict";
 
-	var rPattern = /\{\{csrfTokens.([^\}]+)/;
+	var rPattern = /\{\{csrfTokens.([^\}]+)\}\}/;
 	var TOKEN_DEFAULT_HEADER = "X-CSRF-Token";
 
 	/**
@@ -30,11 +32,10 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.120.10
+	 * @version 1.121.1
 	 *
 	 * @constructor
-	 * @param {sap.ui.integration.Host} oHost The Host which will be used for resolve CSRF tokens.
-	 * @param {object} oConfiguration The CSRF configuration from the manifest.
+	 * @param {object} mSettings Token handler settings
 	 * @private
 	 * @ui5-restricted sap.ui.integration
 	 * @alias sap.ui.integration.util.CsrfTokenHandler
@@ -48,102 +49,66 @@ sap.ui.define([
 
 			mSettings = mSettings || {};
 
+			this._mTokens = new Map();
+			this._oModel = mSettings.model;
+			/**
+			 * @deprecated As of version 1.121.0
+			 */
 			this._oHost = mSettings.host;
 			this._oConfiguration = mSettings.configuration;
+			this._oDataProviderFactory = mSettings.dataProviderFactory;
+
+			for (const [sTokenName, oTokenConfig] of Object.entries(mSettings.configuration)) {
+				this._mTokens.set(sTokenName, new CsrfToken(sTokenName, oTokenConfig, this));
+			}
 		}
 	});
 
-	/**
-	 * Map of all Promises which resolve to CSRF tokens. Keyed by the unique URL of each CSRF request. Shared by all cards.
-	 *
-	 * @static
-	 * @private
-	 */
-	CsrfTokenHandler._mTokens = new Map();
+	CsrfTokenHandler.prototype.getUsedToken = function (oDataConfig) {
+		const sTokenName = this._findTokenName(oDataConfig);
 
-	/**
-	 * Resolves CSRF placeholders to actual values within a data configuration object.
-	 *
-	 * @private
-	 * @ui5-restricted sap.ui.integration
-	 * @param {object} oDataConfig Data configuration object
-	 * @returns {Promise<object>} A promise which resolves with the data configuration object containing resolved CSRF token values
-	 */
-	CsrfTokenHandler.prototype.resolveToken = function (oDataConfig) {
-		var oCsrfTokenContext,
-			oCsrfTokenConfig;
+		return this._mTokens.get(sTokenName);
+	};
 
+	CsrfTokenHandler.prototype.fetchValue = function (sTokenName, oTokenConfig) {
 		// clone the data configuration,
 		// so we won't change the original settings
-		oDataConfig = merge({}, oDataConfig);
-
-		oCsrfTokenContext = this._findCsrfPlaceholder(oDataConfig);
-
-		if (!oCsrfTokenContext) {
-			return Promise.resolve(oDataConfig);
-		}
-
-		oCsrfTokenConfig = this._getCsrfConfig(oCsrfTokenContext.tokenName);
-
-		if (this._oHost) {
-			return this._oHost.getCsrfToken(oCsrfTokenConfig)
-				.then(function (sTokenValue) {
-					if (!sTokenValue) {
-						return this._resolveTokenByUrl(oDataConfig, oCsrfTokenContext);
-					}
-
-					this._replaceCsrfPlaceholder(oCsrfTokenContext, sTokenValue);
-					return oDataConfig;
-				}.bind(this))
-				.catch(function (sError) {
-					return Promise.reject(sError);
-				});
-		}
+		oTokenConfig = merge({}, oTokenConfig);
 
-		return this._resolveTokenByUrl(oDataConfig, oCsrfTokenContext);
+		return this._requestToken(sTokenName, oTokenConfig.data);
 	};
 
-	CsrfTokenHandler.prototype._resolveTokenByUrl = function (oDataConfig, oCsrfTokenContext) {
-		var sCsrfTokenName = oCsrfTokenContext.tokenName,
-			sCsrfUrl = this._getCsrfConfig(sCsrfTokenName).data.request.url;
-
-		if (CsrfTokenHandler._mTokens.has(sCsrfUrl)) {
-			return CsrfTokenHandler._mTokens.get(sCsrfUrl).then(function (sTokenValue) {
-				this._replaceCsrfPlaceholder(oCsrfTokenContext, sTokenValue);
-				return oDataConfig;
-			}.bind(this));
-		}
+	/**
+	 * @deprecated As of version 1.120.0
+	 */
+	CsrfTokenHandler.prototype.fetchValueByHost = function (oTokenConfig) {
+		if (this._oHost) {
+			// clone the data configuration,
+			// so we won't change the original settings
+			oTokenConfig = merge({}, oTokenConfig);
 
-		if (sCsrfTokenName) {
-			return this._requestToken(oDataConfig, oCsrfTokenContext);
+			return this._oHost.getCsrfToken(oTokenConfig);
 		}
 
-		return Promise.resolve(oDataConfig);
+		return Promise.resolve();
 	};
 
-	/**
-	 * Saves a reference to the DataProviderFactory to create own data requests.
-	 * Those CSRF placeholders may contain destinations placeholders which need to be resolved prior to making the request.
-	 *
-	 * @private
-	 * @ui5-restricted sap.ui.integration
-	 * @param {sap.ui.integration.util.DataProviderFactory} oDataProviderFactory the factory
-	 */
-	CsrfTokenHandler.prototype.setDataProviderFactory = function (oDataProviderFactory) {
-		this._oDataProviderFactory = oDataProviderFactory;
+	CsrfTokenHandler.prototype.onTokenFetched = function (sTokenName, sTokenValue) {
+		this._setCsrfModelValue(sTokenName, sTokenValue);
 	};
 
 	/**
 	 * Sets the host which is used to resolve tokens.
 	 * @param {sap.ui.integration.Host} oHost The host.
+	 * @deprecated As of version 1.121.0
 	 */
 	CsrfTokenHandler.prototype.setHost = function (oHost) {
 		this._oHost = oHost;
 	};
 
 	/**
-	 * Checks if a response contains an expired CSRF Token.
-	 * @param {object} oResponse The response.
+	 * @param {Response} oResponse The response.
+	 * @returns {boolean} Whether the response contains an expired CSRF token
 	 */
 	CsrfTokenHandler.prototype.isExpiredToken = function (oResponse) {
 		if (!oResponse) {
@@ -154,63 +119,94 @@ sap.ui.define([
 		return sXCSRFHeader && sXCSRFHeader.toLowerCase() === "required" && oResponse.status === 403;
 	};
 
+	CsrfTokenHandler.prototype.replacePlaceholders = function (vData) {
+		if (!vData) {
+			return vData;
+		}
+
+		if (Array.isArray(vData)) {
+			return vData.map((vValue) => {
+				this.replacePlaceholders(vValue);
+			});
+		}
+
+		if (isPlainObject(vData)) {
+			const oItemCopy = {};
+
+			for (const sKey in vData) {
+				oItemCopy[sKey] = this.replacePlaceholders(vData[sKey]);
+			}
+
+			return oItemCopy;
+		}
+
+		if (typeof vData === "string") {
+			const oToken = this._mTokens.get(this._getTokenName(vData));
+
+			if (oToken) {
+				return vData.replace(rPattern, oToken.value);
+			}
+		}
+
+		return vData;
+	};
+
 	/**
-	 * Executes a CSRF token request based on the data configuration object which contains a CSRF placeholder in its headers property.
+	 * Executes a CSRF token request
 	 *
 	 * @private
-	 * @param {object} oDataConfig Data configuration object
+	 * @param {string} sTokenName Token name in the current card
+	 * @param {object} oTokenDataConfig Token data configuration
 	 * @returns {Promise} Promise which resolves with the CSRF token
 	 */
-	CsrfTokenHandler.prototype._requestToken = function (oDataConfig, oCsrfTokenContext) {
-		var sCsrfTokenName = oCsrfTokenContext.tokenName,
-			oCsrfTokenConfig = this._getCsrfConfig(sCsrfTokenName);
-
-		if (!sCsrfTokenName || !oCsrfTokenConfig) {
+	CsrfTokenHandler.prototype._requestToken = function (sTokenName, oTokenDataConfig) {
+		if (!sTokenName || !oTokenDataConfig) {
 			return Promise.reject("CSRF definition is incorrect");
 		}
 
-		var pTokenValuePromise = new Promise(function (resolve, reject) {
-			var oCsrfTokenDataProvider = this._oDataProviderFactory.create(oCsrfTokenConfig.data);
-			oCsrfTokenDataProvider.getData().then(function (oData) {
-				var sTokenValue,
-					oModel;
-
-				if (oCsrfTokenConfig.data.path) {
-					oModel = new JSONModel(oData);
-					sTokenValue = oModel.getProperty(oCsrfTokenConfig.data.path);
-					oModel.destroy();
-				} else {
-					sTokenValue = oCsrfTokenDataProvider.getLastResponse().headers.get(TOKEN_DEFAULT_HEADER);
-				}
+		const oTokenDataProvider = this._oDataProviderFactory.create(oTokenDataConfig);
+		const pTokenValue = oTokenDataProvider.getData().then((oData) => {
+			var sTokenValue,
+				oModel;
+
+			if (oTokenDataConfig.path) {
+				oModel = new JSONModel(oData);
+				sTokenValue = oModel.getProperty(oTokenDataConfig.path);
+				oModel.destroy();
+			} else {
+				sTokenValue = oTokenDataProvider.getLastResponse().headers.get(TOKEN_DEFAULT_HEADER);
+			}
 
-				resolve(sTokenValue);
-			}).catch(function () {
-				reject("CSRF token cannot be resolved");
-			});
-		}.bind(this));
+			return sTokenValue;
+		}).catch(function () {
+			throw "CSRF token cannot be resolved";
+		});
 
-		this._registerToken(oCsrfTokenConfig, pTokenValuePromise);
+		/**
+		 * @deprecated As of version 1.120.0
+		 */
+		if (this._oHost) {
+			this._oHost.csrfTokenFetched(oTokenDataConfig, pTokenValue);
+		}
 
-		return pTokenValuePromise.then(function (sTokenValue) {
-			this._replaceCsrfPlaceholder(oCsrfTokenContext, sTokenValue);
-			return oDataConfig;
-		}.bind(this));
+		return pTokenValue;
 	};
 
-	/**
-	 * Deletes a token based on a data configuration object which contains a CSRF placeholder in its headers property.
-	 *
-	 * @private
-	 * @ui5-restricted sap.ui.integration
-	 * @param {object} oDataConfig Data configuration object
-	 */
-	CsrfTokenHandler.prototype.resetTokenByRequest = function (oDataConfig) {
-		var oCsrfTokenContext = this._findCsrfPlaceholder(oDataConfig);
-		if (!oCsrfTokenContext) {
+	CsrfTokenHandler.prototype.setExpiredTokenByRequest = function (oDataConfig) {
+		const sTokenName = this._findTokenName(oDataConfig);
+
+		if (!sTokenName) {
 			return;
 		}
 
-		this._deleteRegisteredToken(this._getCsrfConfig(oCsrfTokenContext.tokenName));
+		this._mTokens.get(sTokenName).setExpired();
+
+		/**
+		 * @deprecated As of version 1.120.0
+		 */
+		if (this._oHost) {
+			this._oHost.csrfTokenExpired(this._getTokenConfig(sTokenName));
+		}
 	};
 
 	/**
@@ -220,17 +216,17 @@ sap.ui.define([
 	 * @param {string} sCsrfTokenName The name of the CSRF object.
 	 * @returns {object} The CSRF configuration object.
 	 */
-	CsrfTokenHandler.prototype._getCsrfConfig = function (sCsrfTokenName) {
+	CsrfTokenHandler.prototype._getTokenConfig = function (sCsrfTokenName) {
 		return this._oConfiguration[sCsrfTokenName];
 	};
 
-	CsrfTokenHandler.prototype._replaceCsrfPlaceholder = function (oCsrfTokenContext, sTokenValue) {
-		var sPlaceholder = oCsrfTokenContext.object[oCsrfTokenContext.key];
-
-		oCsrfTokenContext.object[oCsrfTokenContext.key] = sPlaceholder.replace("{{csrfTokens." + oCsrfTokenContext.tokenName + "}}", sTokenValue);
+	CsrfTokenHandler.prototype._setCsrfModelValue = function (sTokenName, sTokenValue) {
+		this._oModel.setProperty(`/${sTokenName}`, {
+			value: sTokenValue
+		});
 	};
 
-	CsrfTokenHandler.prototype._findCsrfPlaceholder = function (oConfig) {
+	CsrfTokenHandler.prototype._findTokenName = function (oConfig) {
 		var vValue,
 			sKey,
 			sTokenName;
@@ -239,19 +235,15 @@ sap.ui.define([
 			vValue = oConfig[sKey];
 
 			if (typeof vValue === "string") {
-				sTokenName = this._getCsrfTokenName(vValue);
+				sTokenName = this._getTokenName(vValue);
 
 				if (sTokenName) {
-					return {
-						object: oConfig,
-						key: sKey,
-						tokenName: sTokenName
-					};
+					return sTokenName;
 				}
 			}
 
 			if (isPlainObject(vValue)) {
-				vValue = this._findCsrfPlaceholder(vValue);
+				vValue = this._findTokenName(vValue);
 
 				if (vValue) {
 					return vValue;
@@ -264,35 +256,25 @@ sap.ui.define([
 
 	/**
 	 * Returns the name from the CSRF placeholder.
-	 * For input of <code>{{csrfTokens.token1}}</code>, it will return <code>"token1"</code>
+	 * For input of <code>{csrfTokens>/token1}</code>, it will return <code>"token1"</code>
 	 *
 	 * @private
 	 * @param {string} sString the CSRF placeholder
 	 * @returns {string} The name of the placeholder or empty string
 	 */
-	CsrfTokenHandler.prototype._getCsrfTokenName = function (sString) {
-		var aMatches = sString.match(rPattern);
-		if (!aMatches) {
-			return "";
-		}
-
-		return aMatches[1];
-	};
+	CsrfTokenHandler.prototype._getTokenName = function (sString) {
+		const rBinding = /\{csrfTokens\>\/([^\/]*).*}/;
+		let aMatches = sString.match(rBinding);
 
-	CsrfTokenHandler.prototype._registerToken = function (mCSRFTokenConfig, pTokenValuePromise) {
-		CsrfTokenHandler._mTokens.set(mCSRFTokenConfig.data.request.url, pTokenValuePromise);
+		if (!aMatches) {
+			aMatches = sString.match(rPattern);
 
-		if (this._oHost) {
-			this._oHost.csrfTokenFetched(mCSRFTokenConfig, pTokenValuePromise);
+			if (!aMatches) {
+				return "";
+			}
 		}
-	};
 
-	CsrfTokenHandler.prototype._deleteRegisteredToken = function (mCSRFTokenConfig) {
-		CsrfTokenHandler._mTokens.delete(mCSRFTokenConfig.data.request.url);
-
-		if (this._oHost) {
-			this._oHost.csrfTokenExpired(mCSRFTokenConfig);
-		}
+		return aMatches[1];
 	};
 
 	return CsrfTokenHandler;

package/src/sap/ui/integration/util/DataProvider.js

@@ -29,7 +29,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.ManagedObject
 	 *
 	 * @author SAP SE
-	 * @version 1.120.10
+	 * @version 1.121.1
 	 *
 	 * @constructor
 	 * @private
@@ -41,6 +41,13 @@ sap.ui.define([
 		metadata: {
 			library: "sap.ui.integration",
 			properties: {
+				/**
+				 * Data provider configuration from the manifest
+				 */
+				configuration: {
+					type: "object"
+				},
+
 				/**
 				 * Data settings.
 				 */
@@ -110,6 +117,7 @@ sap.ui.define([
 
 	DataProvider.prototype.init = function () {
 		this._iCurrentRequestNumber = 0;
+		this._oDependencies = new Set();
 	};
 
 	/**
@@ -132,10 +140,10 @@ sap.ui.define([
 
 	/**
 	 * Sets a list of <code>sap.ui.integration.util.DataProvider</code> which will be considered dependencies of the current one.
-	 * @param {sap.ui.integration.util.DataProvider[]} aDependencies The list of dependencies.
+	 * @param {sap.ui.integration.util.DataProvider} oDependency The new dependency.
 	 */
-	DataProvider.prototype.setDependencies = function (aDependencies) {
-		this._aDependencies = aDependencies;
+	DataProvider.prototype.addDependency = function (oDependency) {
+		this._oDependencies.add(oDependency);
 	};
 
 	/**
@@ -189,6 +197,12 @@ sap.ui.define([
 			this._pInitialRequestPromise = pDataUpdate;
 		}
 
+		pDataUpdate.catch((e) => {
+			this.fireError({
+				message: e
+			});
+		});
+
 		return pDataUpdate;
 	};
 
@@ -263,7 +277,7 @@ sap.ui.define([
 		ManagedObject.prototype.destroy.apply(this, arguments);
 	};
 
-	DataProvider.prototype.getInitialRequestPromise = function () {
+	DataProvider.prototype.load = function () {
 		return this._pInitialRequestPromise;
 	};
 
@@ -303,11 +317,10 @@ sap.ui.define([
 	 * @return {Promise} Promise which fulfills when all dependencies are ready.
 	 */
 	DataProvider.prototype._waitDependencies = function () {
-		var aDependencies = this._aDependencies || [],
-			aPromises = [];
+		const aPromises = [];
 
-		aDependencies.forEach(function (oDataProvider) {
-			aPromises.push(oDataProvider.getInitialRequestPromise());
+		this._oDependencies.forEach((oDependency) => {
+			aPromises.push(oDependency.load());
 		});
 
 		return Promise.all(aPromises);

package/src/sap/ui/integration/util/DataProviderFactory.js

@@ -14,7 +14,8 @@ sap.ui.define([
 	"sap/ui/integration/util/ExtensionDataProvider",
 	"sap/ui/integration/util/JSONBindingHelper",
 	"sap/ui/integration/util/BindingHelper",
-	"sap/ui/integration/util/CsrfTokenHandler"
+	"sap/ui/integration/util/CsrfTokenHandler",
+	"sap/ui/model/json/JSONModel"
 ], function (
 	EventProvider,
 	Log,
@@ -26,7 +27,8 @@ sap.ui.define([
 	ExtensionDataProvider,
 	JSONBindingHelper,
 	BindingHelper,
-	CsrfTokenHandler
+	CsrfTokenHandler,
+	JSONModel
 ) {
 	"use strict";
 
@@ -38,7 +40,7 @@ sap.ui.define([
 	 * When destroyed, all data providers created by this class are also destroyed.
 	 *
 	 * @author SAP SE
-	 * @version 1.120.10
+	 * @version 1.121.1
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.integration, shell-toolkit
@@ -53,15 +55,20 @@ sap.ui.define([
 
 			this._oDestinations = mSettings.destinations;
 			this._oExtension = mSettings.extension;
-			this._oCsrfTokenHandler = mSettings.csrfTokenHandler;
 			this._oCard = mSettings.card;
 			this._oEditor = mSettings.editor;
 			this._oHost = mSettings.host;
 
 			if (mSettings.csrfTokensConfig) {
+				this._oCsrfTokensModel = new JSONModel();
 				this._oCsrfTokenHandler = new CsrfTokenHandler({
+					/**
+					 * @deprecated As of version 1.121.0
+					 */
 					host: mSettings.host,
-					configuration: mSettings.csrfTokensConfig
+					configuration: mSettings.csrfTokensConfig,
+					model: this._oCsrfTokensModel,
+					dataProviderFactory: this
 				});
 			}
 
@@ -154,31 +161,41 @@ sap.ui.define([
 			oDataProvider = new ExtensionDataProvider(oSettings, this._oExtension);
 		}
 
+		oDataProvider.setConfiguration(oDataConfiguration);
+
 		if (oCard) {
 			oDataProvider.setCard(oCard);
 			BindingHelper.propagateModels(oCard, oDataProvider);
 		} else if (oEditor) {
 			BindingHelper.propagateModels(oEditor, oDataProvider);
 		}
-		oDataProvider.bindObject("/");
 
+		oDataProvider.bindObject("/");
 		oDataProvider.setDestinations(this._oDestinations);
 
-		if (this._oCsrfTokenHandler) {
-			oDataProvider.setCsrfTokenHandler(this._oCsrfTokenHandler);
-			this._oCsrfTokenHandler.setDataProviderFactory(this);
-		}
-
 		if (oDataProvider.isA("sap.ui.integration.util.IServiceDataProvider")) {
 			oDataProvider.createServiceInstances(oServiceManager);
 		}
 
 		this._aDataProviders.push(oDataProvider);
 
+		if (this._oCsrfTokenHandler) {
+			const oToken = this._oCsrfTokenHandler.getUsedToken(oDataConfiguration);
+
+			if (oToken) {
+				oDataProvider.setCsrfTokenHandler(this._oCsrfTokenHandler);
+				oDataProvider.addDependency(oToken);
+				oDataProvider.setModel(this._oCsrfTokensModel, "csrfTokens");
+			}
+		}
+
 		if (bIsFilter) {
 			this._aFiltersProviders.push(oDataProvider);
 		} else {
-			oDataProvider.setDependencies(this._aFiltersProviders);
+			// TODO: check if the data provider uses filters before adding them to the dependency list
+			this._aFiltersProviders.forEach((oFilterDataProvider) => {
+				oDataProvider.addDependency(oFilterDataProvider);
+			});
 		}
 
 		return oDataProvider;
@@ -207,6 +224,9 @@ sap.ui.define([
 	DataProviderFactory.prototype.setHost = function (oHost) {
 		this._oHost = oHost;
 
+		/**
+		 * @deprecated As of version 1.121.0
+		 */
 		if (this._oCsrfTokenHandler) {
 			this._oCsrfTokenHandler.setHost(oHost);
 		}

package/src/sap/ui/integration/util/Destinations.js

@@ -29,7 +29,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.120.10
+	 * @version 1.121.1
 	 *
 	 * @constructor
 	 * @param {sap.ui.integration.Host} oHost The Host which will be used for resolving destinations.

package/src/sap/ui/integration/util/ErrorHandler.js

@@ -35,7 +35,7 @@ sap.ui.define([
 	 * Utility class for handling errors in the cards.
 	 *
 	 * @author SAP SE
-	 * @version 1.120.10
+	 * @version 1.121.1
 	 *
 	 * @private
 	 * @ui5-restricted
@@ -132,7 +132,8 @@ sap.ui.define([
 
 	ErrorHandler.configureErrorInfo = function (mErrorInfo, oCard) {
 		var sDetails = oCard.getTranslatedText("CARD_MANIFEST") + "\n" + formatJson(oCard._oCardManifest.getJson()) + "\n\n" +
-				oCard.getTranslatedText("CARD_STACK_TRACE") + "\n" + new Error().stack;
+				oCard.getTranslatedText("CARD_STACK_TRACE") + "\n" +
+				(mErrorInfo.originalError ? mErrorInfo.originalError.stack : new Error().stack);
 
 		return {
 			type: CardBlockingMessageType.Error,

package/src/sap/ui/integration/util/ExtensionDataProvider.js

@@ -17,7 +17,7 @@ sap.ui.define(["sap/ui/integration/util/DataProvider"], function (DataProvider)
 	 * @extends sap.ui.integration.util.DataProvider
 	 *
 	 * @author SAP SE
-	 * @version 1.120.10
+	 * @version 1.121.1
 	 *
 	 * @constructor
 	 * @private