@openui5/sap.ui.core 1.120.5 → 1.120.6

package/test/sap/ui/core/demokit/tutorial/odatav4/05/ui5.yaml

@@ -4,7 +4,7 @@ metadata:
 type: application
 framework:
   name: OpenUI5
-  version: "1.120.5" #MainVersion#
+  version: "1.120.6" #MainVersion#
   libraries:
     - name: sap.m
     - name: sap.f

package/test/sap/ui/core/demokit/tutorial/odatav4/06/ui5.yaml

@@ -4,7 +4,7 @@ metadata:
 type: application
 framework:
   name: OpenUI5
-  version: "1.120.5" #MainVersion#
+  version: "1.120.6" #MainVersion#
   libraries:
     - name: sap.m
     - name: sap.f

package/test/sap/ui/core/demokit/tutorial/odatav4/07/ui5.yaml

@@ -4,7 +4,7 @@ metadata:
 type: application
 framework:
   name: OpenUI5
-  version: "1.120.5" #MainVersion#
+  version: "1.120.6" #MainVersion#
   libraries:
     - name: sap.m
     - name: sap.f

package/test/sap/ui/core/demokit/tutorial/odatav4/08/ui5.yaml

@@ -4,7 +4,7 @@ metadata:
 type: application
 framework:
   name: OpenUI5
-  version: "1.120.5" #MainVersion#
+  version: "1.120.6" #MainVersion#
   libraries:
     - name: sap.m
     - name: sap.f

package/test/sap/ui/core/demokit/tutorial/odatav4/09/ui5.yaml

@@ -4,7 +4,7 @@ metadata:
 type: application
 framework:
   name: OpenUI5
-  version: "1.120.5" #MainVersion#
+  version: "1.120.6" #MainVersion#
   libraries:
     - name: sap.m
     - name: sap.f

package/test/sap/ui/core/demokit/tutorial/odatav4/10/ui5.yaml

@@ -4,7 +4,7 @@ metadata:
 type: application
 framework:
   name: OpenUI5
-  version: "1.120.5" #MainVersion#
+  version: "1.120.6" #MainVersion#
   libraries:
     - name: sap.m
     - name: sap.f

package/test/sap/ui/core/demokit/tutorial/odatav4/11/ui5.yaml

@@ -4,7 +4,7 @@ metadata:
 type: application
 framework:
   name: OpenUI5
-  version: "1.120.5" #MainVersion#
+  version: "1.120.6" #MainVersion#
   libraries:
     - name: sap.m
     - name: sap.f

package/test/sap/ui/core/demokit/tutorial/troubleshooting/01/ui5.yaml

@@ -4,7 +4,7 @@ metadata:
 type: application
 framework:
   name: OpenUI5
-  version: "1.120.5" #MainVersion#
+  version: "1.120.6" #MainVersion#
   libraries:
     - name: sap.m
     - name: sap.ui.layout

package/test/sap/ui/core/qunit/odata/v2/ODataModel.integration.qunit.js

@@ -21981,4 +21981,114 @@ ToProduct/ToSupplier/BusinessPartnerID\'}}">\
 
 		return this.createView(assert, sView, oModel);
 	});
+
+	//*********************************************************************************************
+	// Scenario: Custom headers are applied to *all* change requests when the $batch containing them is sent on
+	// ODataModel#submitChangesWithChangeHeaders.
+	// SNOW: CS20230004859105
+	QUnit.test("ODataModel#submitChangesWithChangeHeaders: Custom headers for change requests", function (assert) {
+		var oModel = createSalesOrdersModel({
+				defaultBindingMode : BindingMode.TwoWay,
+				refreshAfterChange : false // suppress GETs on collection after POST to reduce test complexity
+			}),
+			mModelHeaders = {
+				"my-custom0" : "~custom0Global",
+				"my-custom1" : "~custom1Global",
+				"my-custom2" : "~custom2Global"
+			},
+			sView = '\
+<t:Table id="table" rows="{/SalesOrderSet}" visibleRowCount="2">\
+	<Text id="id" text="{SalesOrderID}" />\
+	<Input id="note" value="{Note}" />\
+</t:Table>',
+			that = this;
+
+		this.expectHeadRequest(mModelHeaders)
+			.expectRequest({
+				headers : mModelHeaders,
+				requestUri : "SalesOrderSet?$skip=0&$top=102"
+			}, {
+				results : [{
+					__metadata : { uri : "/SalesOrderSet('1')" },
+					SalesOrderID : "1",
+					Note : "foo"
+				}, {
+					__metadata : { uri : "/SalesOrderSet('2')" },
+					SalesOrderID : "2",
+					Note : "bar"
+				}]
+			})
+			.expectValue("id", ["1", "2"])
+			.expectValue("note", ["foo", "bar"]);
+
+		oModel.setHeaders(mModelHeaders); // set global custom headers
+		return this.createView(assert, sView, oModel).then(function () {
+			that.expectRequest({
+					data : {
+						__metadata : { "uri": "/SalesOrderSet('1')" },
+						Note : "baz"
+					},
+					headers : {
+						"my-custom0" : "~custom0Global",
+						"my-custom1" : "~custom1Global",
+						"my-custom2" : "~custom2Change",
+						"my-custom-change" : "~customChange"
+					},
+					key : "SalesOrderSet('1')",
+					method : "MERGE",
+					requestUri : "SalesOrderSet('1')"
+				}, NO_CONTENT)
+				.expectRequest({
+					created : true,
+					data : {
+						__metadata : { type : "GWSAMPLE_BASIC.SalesOrder" }
+					},
+					headers : {
+						"my-create" : "~create",
+						"my-custom0" : "~custom0Create",
+						"my-custom1" : "~custom1Global",
+						"my-custom2" : "~custom2Change",
+						"my-custom-change" : "~customChange"
+					},
+					method : "POST",
+					requestUri : "SalesOrderSet"
+				}, {
+					data : {
+						__metadata : { uri : "SalesOrderSet('3')" },
+						SalesOrderID : "3"
+					},
+					statusCode : 201
+				})
+				.expectRequest({
+					headers : {
+						"my-remove" : "~remove",
+						"my-custom0" : "~custom0Remove",
+						"my-custom1" : "~custom1Global",
+						"my-custom2" : "~custom2Change",
+						"my-custom-change" : "~customChange"
+					},
+					method : "DELETE",
+					requestUri : "SalesOrderSet('2')"
+				}, NO_CONTENT)
+				.expectValue("id", "", 1)
+				.expectValue("note", ["baz", ""]);
+
+			// code under test: update (via two-way binding), createEntry, remove apply headers from
+			//   global model headers, headers from API calls and submitChangesWithChangeHeaders in expected prio
+			that.oView.byId("table").getRows()[0].getCells()[1].setValue("baz");
+			oModel.createEntry("/SalesOrderSet", {
+				properties : {},
+				headers : {"my-create" : "~create", "my-custom0" : "~custom0Create"}
+			});
+			oModel.remove("/SalesOrderSet('2')", {
+				groupId : "changes", // use same batch group as update and create
+				headers : {"my-remove" : "~remove", "my-custom0" : "~custom0Remove"}
+			});
+			oModel.submitChangesWithChangeHeaders(
+				{changeHeaders : {"my-custom-change" : "~customChange", "my-custom2" : "~custom2Change"}}
+			);
+
+			return that.waitForChanges(assert);
+		});
+	});
 });

package/test/sap/ui/core/qunit/odata/v2/ODataModelNoFakeService.qunit.js

@@ -2905,10 +2905,13 @@ sap.ui.define([
 
 	//*********************************************************************************************
 [false, true].forEach(function (bExpandRequest, i) {
-	QUnit.test("_processRequestQueue: push expandRequest to queue, " + i, function (assert) {
+	var sTitle = "_processRequestQueue: push expandRequest to queue, " + i + ", consider change headers";
+
+	QUnit.test(sTitle, function (assert) {
 		var oRequest = {
 				data : "~data",
-				expandRequest : bExpandRequest ? "~expandRequest" : undefined
+				expandRequest : bExpandRequest ? "~expandRequest" : undefined,
+				headers : "~headers"
 			},
 			oChange = {
 				parts : [{
@@ -2938,6 +2941,7 @@ sap.ui.define([
 
 		this.mock(oModel).expects("_collectChangedEntities")
 			.withExactArgs(sinon.match.same(oRequestGroup), {}, {});
+		this.mock(_Helper).expects("extend").withExactArgs("~headers", "~changeHeaders");
 		this.mock(oModel).expects("getKey").withExactArgs("~data").returns("~key");
 		this.mock(oModel).expects("increaseLaundering").withExactArgs("/~key", "~data");
 		this.mock(oModel).expects("removeInternalMetadata").withExactArgs("~data");
@@ -2955,7 +2959,7 @@ sap.ui.define([
 
 		// code under test
 		ODataModel.prototype._processRequestQueue.call(oModel, mRequests, "~sGroupId", "~fnSuccess",
-			"~fnError");
+			"~fnError", "~changeHeaders");
 	});
 });
 
@@ -7019,7 +7023,7 @@ sap.ui.define([
 		this.mock(oModel.oMetadata).expects("loaded").withExactArgs().returns(oMetadataPromise);
 
 		// code under test
-		ODataModel.prototype.submitChanges.call(oModel);
+		ODataModel.prototype.submitChangesWithChangeHeaders.call(oModel);
 
 		// async, after metadata loaded promise is resolved
 		this.mock(oModel).expects("getContext").withExactArgs("/~sKey").returns(oContext);
@@ -7035,7 +7039,7 @@ sap.ui.define([
 				/*oRequestHandle*/sinon.match.object, oFixture.expectedRefreshAfterChange);
 		this.mock(oModel).expects("_processRequestQueue")
 			.withExactArgs(sinon.match.same(oModel.mDeferredRequests), undefined, undefined,
-				undefined);
+				undefined, undefined);
 
 		return oMetadataPromise.then(function () {
 			assert.strictEqual(oRequest.key, "~sKey");
@@ -7095,7 +7099,7 @@ sap.ui.define([
 		this.mock(oModel.oMetadata).expects("loaded").withExactArgs().returns(oMetadataPromise);
 
 		// code under test
-		ODataModel.prototype.submitChanges.call(oModel, /*mParameters*/undefined);
+		ODataModel.prototype.submitChangesWithChangeHeaders.call(oModel, /*mParameters*/undefined);
 
 		// async, after metadata loaded promise is resolved
 		this.mock(oModel).expects("getContext").withExactArgs("/~sKey").returns(oContext);
@@ -7113,7 +7117,7 @@ sap.ui.define([
 				/*oRequestHandle*/sinon.match.object, "~bRefreshAfterChangeFromModel");
 		this.mock(oModel).expects("_processRequestQueue")
 			.withExactArgs(sinon.match.same(oModel.mDeferredRequests), undefined,
-				sinon.match.func, undefined)
+				sinon.match.func, undefined, undefined)
 			.callsFake(function (mDeferredRequests, sGroupId, fnSuccess0, fnError) {
 				fnSuccess = fnSuccess0;
 			});
@@ -7182,7 +7186,7 @@ sap.ui.define([
 		this.mock(oModel.oMetadata).expects("loaded").withExactArgs().returns(oMetadataPromise);
 
 		// code under test
-		ODataModel.prototype.submitChanges.call(oModel, mParameters);
+		ODataModel.prototype.submitChangesWithChangeHeaders.call(oModel, mParameters);
 
 		// async, after metadata loaded promise is resolved
 		this.mock(oModel).expects("getContext").withExactArgs("/~sKey").returns(oContext);
@@ -7200,7 +7204,7 @@ sap.ui.define([
 				/*oRequestHandle*/sinon.match.object, "~bRefreshAfterChangeFromModel");
 		this.mock(oModel).expects("_processRequestQueue")
 			.withExactArgs(sinon.match.same(oModel.mDeferredRequests), "~groupId",
-				sinon.match.func, undefined)
+				sinon.match.func, undefined, undefined)
 			.callsFake(function (mDeferredRequests, sGroupId, fnSuccess0, fnError) {
 				fnSuccess = fnSuccess0;
 			});
@@ -7239,7 +7243,7 @@ sap.ui.define([
 		this.mock(oModel.oMetadata).expects("loaded").withExactArgs().returns(oMetadataPromise);
 
 		// code under test
-		ODataModel.prototype.submitChanges.call(oModel);
+		ODataModel.prototype.submitChangesWithChangeHeaders.call(oModel);
 
 		// async, after metadata loaded promise is resolved
 		this.mock(oModel).expects("getContext").withExactArgs("/~sKey").returns(oContext);
@@ -7251,12 +7255,95 @@ sap.ui.define([
 				assert.deepEqual(mDeferredRequests, {});
 
 				return oModel.mDeferredRequests === mDeferredRequests;
-			}), undefined, undefined, undefined);
+			}), undefined, undefined, undefined, undefined);
 
 		return oMetadataPromise;
 	});
 });
 
+	//*********************************************************************************************
+	QUnit.test("submitChanges: delegate to submitChangesWithHeaders", function (assert) {
+		var oModel = {
+				submitChangesWithChangeHeaders : function () {}
+			},
+			oModelMock = this.mock(oModel),
+			mParameters = {
+				batchGroupId : "~batchGroupId",
+				changeHeaders : "~changeHeaders",  // only considered in direct call to submitChangesWithChangeHeaders
+				error : "~error",
+				groupId : "~groupId",
+				merge : "~merge",
+				success : "~success",
+				unknown : "~unknown"
+			},
+			mPassedParameters = {
+				batchGroupId : "~batchGroupId",
+				error : "~error",
+				groupId : "~groupId",
+				merge : "~merge",
+				success : "~success"
+			};
+
+		oModelMock.expects("submitChangesWithChangeHeaders").withExactArgs(undefined).returns("~requestHandle");
+
+		// code under test
+		assert.strictEqual(ODataModel.prototype.submitChanges.call(oModel), "~requestHandle");
+
+		oModelMock.expects("submitChangesWithChangeHeaders").withExactArgs(mPassedParameters).returns("~requestHandle");
+
+		// code under test
+		assert.strictEqual(ODataModel.prototype.submitChanges.call(oModel, mParameters), "~requestHandle");
+	});
+
+	//*********************************************************************************************
+	QUnit.test("submitChangesWithHeaders: propagates change headers", function (assert) {
+		var mChangeHeaders = {header : "headerValue"},
+			oMetadataPromise = Promise.resolve(),
+			oModel = {
+				mChangedEntities : {},
+				mDeferredRequests : {},
+				oMetadata : {
+					loaded : function () {}
+				},
+				_isHeaderPrivate : function () {},
+				_processRequestQueue : function () {},
+				getBindings : function () {}
+			};
+
+		this.mock(oModel).expects("_isHeaderPrivate").withExactArgs("header").returns(false);
+		this.mock(oModel).expects("getBindings").withExactArgs().returns([]);
+		this.mock(oModel.oMetadata).expects("loaded").withExactArgs().returns(oMetadataPromise);
+		this.mock(oModel).expects("_processRequestQueue")
+			.withExactArgs(sinon.match.same(oModel.mDeferredRequests), undefined, undefined, undefined,
+				sinon.match.same(mChangeHeaders));
+
+		// code under test
+		ODataModel.prototype.submitChangesWithChangeHeaders.call(oModel, {changeHeaders : mChangeHeaders});
+
+		return oMetadataPromise;
+	});
+
+	//*********************************************************************************************
+	QUnit.test("submitChangesWithHeaders: disallow private headers as change headers", function (assert) {
+		var mChangeHeaders = {
+				notPrivate0 : "n0",
+				private0 : "p0",
+				notPrivate1 : "n1"
+			},
+			oModel = {
+				_isHeaderPrivate : function () {}
+			},
+			oModelMock = this.mock(oModel);
+
+		oModelMock.expects("_isHeaderPrivate").withExactArgs("notPrivate0").returns(false);
+		oModelMock.expects("_isHeaderPrivate").withExactArgs("private0").returns(true);
+
+		// code under test
+		assert.throws(function () {
+			ODataModel.prototype.submitChangesWithChangeHeaders.call(oModel, {changeHeaders : mChangeHeaders});
+		}, new Error("Must not use private header: private0"));
+	});
+
 	//*********************************************************************************************
 	QUnit.test("setProperty: deferred request", function (assert) {
 		var oRequestQueuedPromise,

package/test/sap/ui/core/relnotes/changes-1.120.json

@@ -715,5 +715,15 @@
         "text": " sap.ui.model.analytics.AnalyticalBinding: handle properties of type Edm.time in grouping"
       }
     ]
+  },
+  "1.120.6": {
+    "date": "February 2024",
+    "notes": [
+      {
+        "id": "e6ce2912af430cea8ae775464d9c588f1433704a",
+        "type": "FIX",
+        "text": " sap.ui.model.odata.v2.ODataModel#submitChangesWithHeaders: ensure change requests use custom headers"
+      }
+    ]
   }
 }