@openui5/sap.ui.core 1.98.0 → 1.101.0

package/src/sap/ui/model/xml/XMLModel.js

@@ -47,7 +47,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.ClientModel
 	 *
 	 * @author SAP SE
-	 * @version 1.98.0
+	 * @version 1.101.0
 	 *
 	 * @param {object} oData either the URL where to load the XML from or an XML
 	 * @public

package/src/sap/ui/model/xml/XMLPropertyBinding.js

@@ -48,7 +48,7 @@ sap.ui.define([
 	 * Checks whether this Binding would provide new values and in case it changed, fires a change
 	 * event with change reason <code>sap.ui.model.ChangeReason.Change</code>.
 	 *
-	 * @param {boolean} bForceupdate
+	 * @param {boolean} [bForceupdate]
 	 *   Whether the change event will be fired regardless of the binding's state
 	 */
 	XMLPropertyBinding.prototype.checkUpdate = function(bForceupdate){

package/src/sap/ui/performance/trace/FESR.js

@@ -203,7 +203,7 @@ sap.ui.define([
 	}
 
 	function onInteractionFinished(oFinishedInteraction) {
-		var sStepName = oFinishedInteraction.trigger + "_" + oFinishedInteraction.event;
+		var sStepName = oFinishedInteraction.semanticStepName ? oFinishedInteraction.semanticStepName : oFinishedInteraction.trigger + "_" + oFinishedInteraction.event;
 		var oFESRHandle = FESR.onBeforeCreated({
 			stepName: sStepName,
 			appNameLong: oFinishedInteraction.stepComponent || oFinishedInteraction.component,

package/src/sap/ui/performance/trace/FESRHelper.js

@@ -0,0 +1,72 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([], function () {
+"use strict";
+
+	/**
+	 * FESRHelper API
+	 * Provides helper functionality for FESR and consumers of FESR
+	 *
+	 * @namespace
+	 * @since 1.100
+	 * @alias module:sap/ui/performance/trace/FESRHelper
+	 * @static
+	 * @public
+	 */
+    var FESRHelper = {
+        /**
+         * This namespace is only used inside the FESRHelper.
+         *
+         * @const
+         * @private
+         */
+        FESR_NAMESPACE: "http://schemas.sap.com/sapui5/extension/sap.ui.core.FESR/1",
+
+        /**
+         * Add semantic stepname for an event of a given element used for FESR.
+         *
+         * @param {sap.ui.core.Element} oElement The element the semantic stepname should be applied to
+         * @param {string} sEventId The event ID the semantic stepname is valid for
+         * @param {string} sStepname The semantic stepname
+         *
+         * @public
+         * @since 1.100
+         */
+        setSemanticStepname: function (oElement, sEventId, sStepname) {
+            var oCustomData = oElement.data("sap-ui-custom-settings");
+            if (oCustomData === null) {
+                oCustomData = {};
+            }
+            if (!oCustomData[this.FESR_NAMESPACE]) {
+                oCustomData[this.FESR_NAMESPACE] = {};
+            }
+            oCustomData[this.FESR_NAMESPACE][sEventId] = sStepname;
+            oElement.data("sap-ui-custom-settings", oCustomData);
+        },
+
+
+        /**
+         * Get semantic stepname for an event of a given element used for FESR.
+         *
+         * @param {sap.ui.core.Element} oElement The element conatining the semantic stepname
+         * @param {string} sEventId The event ID of the semantic stepname
+         * @returns {string} The semantic stepname for the given event ID
+         *
+         * @public
+         * @since 1.100
+         */
+        getSemanticStepname: function (oElement, sEventId) {
+            var oCustomFesrData = oElement && oElement.data("sap-ui-custom-settings") && oElement.data("sap-ui-custom-settings")[this.FESR_NAMESPACE];
+            if (!oCustomFesrData) {
+                return;
+            }
+            return oCustomFesrData[sEventId];
+        }
+    };
+
+    return FESRHelper;
+});

package/src/sap/ui/performance/trace/Interaction.js

@@ -8,12 +8,13 @@
 sap.ui.define([
 	"sap/ui/performance/Measurement",
 	"sap/ui/performance/XHRInterceptor",
+	"sap/ui/performance/trace/FESRHelper",
 	"sap/base/util/LoaderExtensions",
 	"sap/base/util/now",
 	"sap/base/util/uid",
 	"sap/base/Log",
 	"sap/ui/thirdparty/URI"
-], function(Measurement, XHRInterceptor, LoaderExtensions, now, uid, Log, URI) {
+], function(Measurement, XHRInterceptor, FESRHelper, LoaderExtensions, now, uid, Log, URI) {
 
 	"use strict";
 
@@ -477,6 +478,7 @@ sap.ui.define([
 			oPendingInteraction.start = iTime;
 			if (oSrcElement && oSrcElement.getId) {
 				oPendingInteraction.trigger = oSrcElement.getId();
+				oPendingInteraction.semanticStepName = FESRHelper.getSemanticStepname(oSrcElement, sType);
 			}
 			/*eslint-disable no-console */
 			if (Log.isLoggable(null, "sap.ui.Performance")) {
@@ -626,13 +628,15 @@ sap.ui.define([
 					var elem = oBrowserElement;
 					if (elem && oElement.getId() === elem.getId()) {
 						oPendingInteraction.trigger = oElement.getId();
+						oPendingInteraction.semanticStepName = FESRHelper.getSemanticStepname(oElement, sEventId);
 						oPendingInteraction.event = sEventId;
 					    bMatched = true;
 					} else {
 						while (elem && elem.getParent()) {
 							elem = elem.getParent();
 							if (oElement.getId() === elem.getId()) {
-								oPendingInteraction.trigger = oElement.getId();
+						oPendingInteraction.trigger = oElement.getId();
+						oPendingInteraction.semanticStepName = FESRHelper.getSemanticStepname(oElement, sEventId);
 								oPendingInteraction.event = sEventId;
 								//if we find no direct match we consider the last control event for the trigger/event (step name)
 								break;

package/src/sap/ui/performance/trace/Passport.js

@@ -53,7 +53,7 @@ sap.ui.define(["sap/ui/performance/XHRInterceptor", "sap/ui/thirdparty/URI"], fu
 	var Passport = {};
 
 	/**
-	 * @returns {String} a generated a passport header
+	 * @returns {string} a generated a passport header
 	 * @private
 	 */
 	Passport.header = function(trcLvl, RootID, TransID, component, action) {
@@ -125,7 +125,7 @@ sap.ui.define(["sap/ui/performance/XHRInterceptor", "sap/ui/thirdparty/URI"], fu
 	};
 
 	/**
-	 * @param {String} lvl Tracing level to be calculated
+	 * @param {string} lvl Tracing level to be calculated
 	 * @return {int[]} Array with two int representations of characters for trace level
 	 * @private
 	 */
@@ -151,7 +151,7 @@ sap.ui.define(["sap/ui/performance/XHRInterceptor", "sap/ui/thirdparty/URI"], fu
 	};
 
 	/**
-	 * @returns {String} a generated GUID
+	 * @returns {string} a generated GUID
 	 * @private
 	 */
 	Passport.createGUID = function() {

package/src/sap/ui/qunit/qunit-2-css.js

@@ -7,8 +7,8 @@
 (function() {
 	"use strict";
 
-	/*global jQuery */
-
-	var sUrl = jQuery.sap.getModulePath("sap.ui.thirdparty.qunit-2", ".css");
-	jQuery.sap.includeStyleSheet(sUrl);
+	var oLink = document.createElement("link");
+	oLink.rel = "stylesheet";
+	oLink.href = sap.ui.require.toUrl("sap/ui/thirdparty/qunit-2.css");
+	document.head.appendChild(oLink);
 }());

package/src/sap/ui/qunit/qunit-css.js

@@ -7,8 +7,8 @@
 (function() {
 	"use strict";
 
-	/*global jQuery */
-
-	var sUrl = jQuery.sap.getModulePath("sap.ui.thirdparty.qunit", ".css");
-	jQuery.sap.includeStyleSheet(sUrl);
+	var oLink = document.createElement("link");
+	oLink.rel = "stylesheet";
+	oLink.href = sap.ui.require.toUrl("sap/ui/thirdparty/qunit.css");
+	document.head.appendChild(oLink);
 }());

package/src/sap/ui/qunit/utils/ControlIterator.js

@@ -53,7 +53,7 @@ sap.ui.define(['sap/ui/core/Core', "sap/ui/VersionInfo"],
 	 * @namespace
 	 *
 	 * @author SAP SE
-	 * @version 1.98.0
+	 * @version 1.101.0
 	 *
 	 * @public
 	 * @since 1.48.0

package/src/sap/ui/qunit/utils/MemoryLeakCheck.js

@@ -27,7 +27,7 @@ sap.ui.define([ 'sap/ui/core/Element', 'sap/ui/core/Control', 'sap/ui/core/Core'
 	 * @namespace
 	 *
 	 * @author SAP SE
-	 * @version 1.98.0
+	 * @version 1.101.0
 	 *
 	 * @public
 	 * @since 1.48.0

package/src/sap/ui/test/BranchTracking.js

@@ -660,6 +660,7 @@
 		QUnit.begin(function () {
 			var sFileName, aHits;
 
+			jQuery("body").css("overflow", "scroll"); // always show scrollbar, avoid flickering
 			jQuery("#qunit-modulefilter-dropdown-list").css("max-height", "none");
 
 			jQuery("#qunit-modulefilter-dropdown").on("click", function (oMouseEvent) {

package/src/sap/ui/test/Opa5.js

@@ -25,7 +25,9 @@ sap.ui.define([
 		'sap/ui/dom/includeStylesheet',
 		'sap/ui/thirdparty/jquery',
 		'sap/ui/test/_OpaUriParameterParser',
-		"sap/ui/test/_ValidationParameters"
+		'sap/ui/test/_ValidationParameters',
+		'sap/base/util/extend',
+		'sap/base/util/isPlainObject'
 ],
 	function (Opa,
 			OpaPlugin,
@@ -47,7 +49,9 @@ sap.ui.define([
 			includeStylesheet,
 			$,
 			_OpaUriParameterParser,
-			_ValidationParameters) {
+			_ValidationParameters,
+			extend,
+			isPlainObject) {
 		"use strict";
 
 		var oLogger = _OpaLogger.getLogger("sap.ui.test.Opa5"),
@@ -1115,7 +1119,7 @@ sap.ui.define([
 		/**
 		 * Settings for a new page object, consisting of actions and assertions.
 		 *
-		 * @typedef {Object} sap.ui.test.PageObjectDefinition
+		 * @typedef {object} sap.ui.test.PageObjectDefinition
 		 *
 		 * @property {string} [viewName]
 		 *   When a <code>viewName</code> is given, all <code>waitFor</code> calls inside of the page object
@@ -1390,9 +1394,9 @@ sap.ui.define([
 		function _getPathToExpansion(options) {
 			var aPath;
 			["ancestor", "descendant", "sibling"].forEach(function (sMatcher) {
-				if (options[sMatcher] && jQuery.isPlainObject(options[sMatcher])) {
+				if (options[sMatcher] && isPlainObject(options[sMatcher])) {
 					aPath = [sMatcher];
-				} else if (options.matchers && options.matchers[sMatcher] && jQuery.isPlainObject(options.matchers[sMatcher])) {
+				} else if (options.matchers && options.matchers[sMatcher] && isPlainObject(options.matchers[sMatcher])) {
 					aPath = ["matchers", sMatcher];
 				}
 			});
@@ -1416,7 +1420,7 @@ sap.ui.define([
 		// return a new object ("options" remains unchanged)
 		function _substituteExpansion(options, aPath, oControl) {
 			if (aPath) {
-				var oResult = jQuery.extend({}, options);
+				var oResult = extend({}, options);
 				var oPath = oResult;
 				var i = 0;
 				while (i < aPath.length - 1) {

package/src/sap/ui/test/OpaBuilder.js

@@ -285,7 +285,7 @@ sap.ui.define(
          *
          * @param {sap.ui.test.Opa5} [oOpaInstance] the Opa5 instance to operate on
          * @param {string | RegExp} [vId] the id of the target control(s)
-         * @param {string} [vControlType] the type of the target control(s)
+         * @param {string} [sControlType] the type of the target control(s)
          * @param {boolean} [bDialogElement] if true, only popover and dialogs are searched for
          * @param {sap.ui.test.matchers.Matcher | function | Array | Object} [vMatchers] additional matchers to filter target control(s)
          * @param {sap.ui.test.actions.Action | function | Array} [vActions] the actions to be performed on target control(s)
@@ -417,12 +417,12 @@ sap.ui.define(
         /**
          * Defines the control type of the target control(s).
          *
-         * @param {string} vControlType the type of the target control(s)
+         * @param {string} sControlType the type of the target control(s)
          * @returns {this} this OpaBuilder instance
          * @public
          */
-        OpaBuilder.prototype.hasType = function (vControlType) {
-            return this.options({controlType: vControlType});
+        OpaBuilder.prototype.hasType = function (sControlType) {
+            return this.options({controlType: sControlType});
         };
 
         /**
@@ -490,7 +490,7 @@ sap.ui.define(
          * Adds a matcher that checks for a certain number of aggregation items.
          *
          * @param {string} sAggregationName the aggregation name
-         * @param [int] iNumber length to check against
+         * @param {int} iNumber length to check against
          * @returns {this} this OpaBuilder instance
          * @public
          */
@@ -669,8 +669,8 @@ sap.ui.define(
          * @returns {this} this OpaBuilder instance
          * @public
          */
-        OpaBuilder.prototype.doEnterText = function (sText, bClearFirst, bKeepFocus, bPressEnterKey, sIdSuffix) {
-            return this.do(OpaBuilder.Actions.enterText(sText, bClearFirst, bKeepFocus, bPressEnterKey, sIdSuffix));
+        OpaBuilder.prototype.doEnterText = function (sText, bClearTextFirst, bKeepFocus, bPressEnterKey, sIdSuffix) {
+            return this.do(OpaBuilder.Actions.enterText(sText, bClearTextFirst, bKeepFocus, bPressEnterKey, sIdSuffix));
         };
 
         /**

package/src/sap/ui/test/TestUtils.js

@@ -33,6 +33,8 @@ sap.ui.define([
 		rODataHeaders = /^(OData-Version|DataServiceVersion)$/,
 		bRealOData = sRealOData === "true" || sRealOData === "direct",
 		iRequestCount = 0,
+		sOptimisticBatch = oUriParameters.get("optimisticBatch"),
+		bOptimisticBatch = sOptimisticBatch === null ? undefined : sOptimisticBatch === "true",
 		bSupportAssistant = oUriParameters.get("supportAssistant") === "true",
 		TestUtils;
 
@@ -799,6 +801,15 @@ sap.ui.define([
 			}
 		},
 
+		/**
+		 * @returns {boolean|undefined}
+		 *   <code>true</code> if optimistic batch should be used, <code>undefined</code> if not
+		 *   specified.
+		 */
+		isOptimisticBatch : function () {
+			return bOptimisticBatch;
+		},
+
 		/**
 		 * @returns {boolean}
 		 *   <code>true</code> if the real OData service is used.

package/src/sap/ui/test/_UsageReport.js

@@ -24,7 +24,7 @@ sap.ui.define([
             }
 
             // separate report enablement from the report logic: conditionally send XHRs if reporting is explicitly enabled
-            var oPrototype = sap.ui.test._UsageReport.prototype;
+            var oPrototype = _UsageReport.prototype;
             Object.keys(oPrototype).forEach(function (sKey) {
                 var bIsSpecialFunction = ["constructor", "getMetadata"].indexOf(sKey) > -1;
                 if (oPrototype.hasOwnProperty(sKey) && typeof oPrototype[sKey] === "function" && !bIsSpecialFunction) {

package/src/sap/ui/test/generic/GenericTestCollection.js

@@ -0,0 +1,176 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([], function() {
+	"use strict";
+
+	/**
+	 * @typedef sap.ui.test.generic.GenericTestCollection.ObjectCapabilities
+	 *
+	 * @param {string} moduleName
+	 *    Name of the module that contains the class. If not given, it is assumed that a module
+	 *    with the same name as the class (dots replaced by slashes) exports the class.
+	 *    When given, the module is loaded and the class is retrieved via its global name
+	 * @param {boolean|function} create
+	 *    Explicit false if the control can't be instantiated via constructor or factory function
+	 *    expecting the following parameters: Class, mSettings
+	 * @param {boolean} rendererHasDependencies
+	 *    Control renderer has dependencies to parent or child controls and can't be rendered standalone
+	 * @param {Object<string, sap.ui.test.generic.GenericTestCollection.ExcludeReason|any>} properties
+	 *    A map containing the property name as key and either an {@link sap.ui.test.generic.GenericTestCollection.ExcludeReason ExcludeReason}
+	 *    or a "value to set" as value
+	 * @param {Object<string, sap.ui.test.generic.GenericTestCollection.ExcludeReason|function>} aggregations
+	 *    A map containing the aggregation name as key and either an {@link sap.ui.test.generic.GenericTestCollection.ExcludeReason ExcludeReason}
+	 *    or the class which should be used as value
+	 * @param {int} [apiVersion=2]
+	 *    The API version of the control's renderer should be set in case the renderer does not support
+	 *    semantic rendering
+	 * @param {object} [knownIssues=undefined]
+	 *    Exceptions for known but not fixed issues
+	 * @param {boolean} knownIssues.Id
+	 *    Exception for known duplicate ID issues
+	 * @param {boolean} knownIssues.memoryLeaks
+	 *    Exception for known memory leak issues
+	 *
+	 * @private
+	 * @ui5-restricted Only for DIST layer libraries
+	 */
+
+	/**
+	 * @namespace
+	 * @alias sap.ui.test.generic.GenericTestCollection
+	 * @private
+	 * @ui5-restricted Only for DIST layer libraries
+	 * @since 1.100
+	 */
+	var GenericTestCollection = {
+		/**
+		 * Marker for exclude reasons.
+		 *
+		 * @enum {string}
+		 * @private
+		 */
+		ExcludeReason: {
+			/**
+			 * The property or aggregation can only be changed using a binding. Using setter is not allowed.
+			 * @private
+			 */
+			OnlyChangeableViaBinding: "OnlyChangeableViaBinding",
+
+			/**
+			 * The property or aggregation can only be set on initialisation. Using setter is not allowed.
+			 * @private
+			 */
+			NotChangeableAfterInit: "NotChangeableAfterInit",
+
+			/**
+			 * The property or aggregation can't be filled generically. Property/aggregation specific settings are needed.
+			 * @private
+			 */
+			SetterNeedsSpecificSettings: "SetterNeedsSpecificSettings",
+
+			/**
+			 * The default value retrieved from getter can't be used for setting the value using the corresponding setter.
+			 * @private
+			 */
+			CantSetDefaultValue: "CantSetDefaultValue"
+		},
+		/**
+		 * Marker for available generic Tests
+		 *
+		 * @enum {string}
+		 * @private
+		 */
+		Test: {
+			/**
+			 * Test ControlMemoryLeaks
+			 * @protected
+			 */
+			ControlMemoryLeaks: "ControlMemoryLeaks",
+
+			/**
+			 * Test ControlRenderer
+			 * @protected
+			 */
+			ControlRenderer: "ControlRenderer",
+
+			/**
+			 * Test DuplicateIdCheck
+			 * @protected
+			 */
+			DuplicateIdCheck: "DuplicateIdCheck",
+
+			/**
+			 * Test EnforceSemanticRendering
+			 * @protected
+			 */
+			EnforceSemanticRendering: "EnforceSemanticRendering",
+
+			/**
+			 * Test SettersContextReturn
+			 * @protected
+			 */
+			SettersContextReturn: "SettersContextReturn"
+		},
+
+		/**
+		 * Create the testsuite config
+		 *
+		 * @param  {object} mConfig Map containing test parameters
+		 * @param  {string} mConfig.library The library name
+		 * @param  {object} mConfig.objectCapabilities The opt-out options per control
+		 * @param  {sap.ui.test.generic.GenericTestCollection.ObjectCapabilities} mConfig.objectCapabilities.anyName The controls capability options
+		 * @param  {sap.ui.test.generic.GenericTestCollection.Test[]} mConfig.skipTests List of tests which shouldn't be executed
+		 * @return {object} Returns the testsuite config object
+		 *
+		 * @private
+		 * @ui5-restricted Only for DIST layer libraries
+		 * @since 1.100
+		 */
+		createTestsuiteConfig: function(mConfig) {
+			var oSuiteConfig = {
+				name: "Testsuite for Generic Control Tests for library: " + mConfig.library,
+				defaults: {
+					ui5: {
+						libs: [mConfig.library]
+					},
+					qunit: {
+						reorder: false,
+						version: 2
+					},
+					testConfig: mConfig,
+					module: "test-resources/sap/ui/core/qunit/generic/{name}.qunit"
+				},
+				tests: {
+					ControlMemoryLeaks: {
+						title: "QUnit Page for memory leak detection in UI5 controls"
+					},
+					ControlRenderer: {
+						title: "QUnit Page for Control Renderer Tests"
+					},
+					DuplicateIdCheck: {
+						title: "QUnit Page for duplicate ID issues detection in UI5 controls"
+					},
+					SettersContextReturn: {
+						title: "All setters should return correct context (Reason: https://github.com/SAP/openui5/blob/master/docs/guidelines.md#creating-classes)"
+					},
+					EnforceSemanticRendering: {
+						title: "QUnit Page for Semantic Rendering Coverage"
+					}
+				}
+			};
+
+			// Opt-out from single tests
+			var aSkippedTests = mConfig.skipTests || [];
+			aSkippedTests.forEach(function(sTest) {
+				delete oSuiteConfig.tests[sTest];
+			});
+
+			return oSuiteConfig;
+		}
+	};
+
+	return GenericTestCollection;
+});