@sapui5/sap.fe.core 1.102.0 → 1.103.0

package/src/sap/fe/core/controllerextensions/messageHandler/messageHandling.ts

@@ -7,17 +7,17 @@ import MessageItem from "sap/m/MessageItem";
 import MessageToast from "sap/m/MessageToast";
 import MessageView from "sap/m/MessageView";
 import Text from "sap/m/Text";
-import ManagedObject from "sap/ui/base/ManagedObject";
+import type ManagedObject from "sap/ui/base/ManagedObject";
 import Core from "sap/ui/core/Core";
 import DateFormat from "sap/ui/core/format/DateFormat";
 import IconPool from "sap/ui/core/IconPool";
 import CoreLib from "sap/ui/core/library";
 import Message from "sap/ui/core/message/Message";
-import Control from "sap/ui/mdc/Control";
+import type Control from "sap/ui/mdc/Control";
 import Filter from "sap/ui/model/Filter";
 import FilterOperator from "sap/ui/model/FilterOperator";
 import JSONModel from "sap/ui/model/json/JSONModel";
-import { CoreEx } from "types/extension_types";
+import type { CoreEx } from "types/extension_types";
 
 const MessageType = CoreLib.MessageType;
 let aMessageList: any[] = [];
@@ -35,11 +35,13 @@ export type messageHandlingType = {
 		oContext?: any,
 		bHasEtagMessage?: boolean,
 		bShowBoundTransition?: boolean,
-		errorTargetsInAPM?: boolean
+		showErrorInAPD?: boolean,
+		bShowMessageBox?: boolean,
+		concurrentEditFlag?: boolean
 	) => Promise<any>;
 	removeUnboundTransitionMessages: () => void;
-	removeBoundTransitionMessages: () => void;
-	modifyETagMessagesOnly: (oMessageManager: any, oResourceBundle: any) => boolean;
+	modifyETagMessagesOnly: (oMessageManager: any, oResourceBundle: any, concurrentEditFlag: boolean | undefined) => boolean;
+	removeBoundTransitionMessages: (sPathToBeRemoved?: string) => void;
 	getRetryAfterMessage: (oMessage: any, bMessageDialog?: any) => any;
 	prepareMessageViewForDialog: (oMessageDialogModel: JSONModel, bStrictHandlingFlow: boolean) => any;
 };
@@ -74,41 +76,40 @@ function fnFormatTechnicalDetails() {
 	function getPaths() {
 		const sTD = "technicalDetails"; // name of property in message model data for technical details
 		return [
-			{ "groupName": "", "property": sTD + "/status" },
-			{ "groupName": "", "property": sTD + "/statusText" },
-			{ "groupName": "Application", "property": sTD + "/error/@SAP__common.Application/ComponentId" },
-			{ "groupName": "Application", "property": sTD + "/error/@SAP__common.Application/ServiceId" },
-			{ "groupName": "Application", "property": sTD + "/error/@SAP__common.Application/ServiceRepository" },
-			{ "groupName": "Application", "property": sTD + "/error/@SAP__common.Application/ServiceVersion" },
-			{ "groupName": "ErrorResolution", "property": sTD + "/error/@SAP__common.ErrorResolution/Analysis" },
-			{ "groupName": "ErrorResolution", "property": sTD + "/error/@SAP__common.ErrorResolution/Note" },
-			{ "groupName": "ErrorResolution", "property": sTD + "/error/@SAP__common.ErrorResolution/DetailedNote" },
-			{ "groupName": "ErrorResolution", "property": sTD + "/error/@SAP__common.ExceptionCategory" },
-			{ "groupName": "ErrorResolution", "property": sTD + "/error/@SAP__common.TimeStamp" },
-			{ "groupName": "ErrorResolution", "property": sTD + "/error/@SAP__common.TransactionId" },
-			{ "groupName": "Messages", "property": sTD + "/error/code" },
-			{ "groupName": "Messages", "property": sTD + "/error/message" }
+			{ "groupName": "", "property": `${sTD}/status` },
+			{ "groupName": "", "property": `${sTD}/statusText` },
+			{ "groupName": "Application", "property": `${sTD}/error/@SAP__common.Application/ComponentId` },
+			{ "groupName": "Application", "property": `${sTD}/error/@SAP__common.Application/ServiceId` },
+			{ "groupName": "Application", "property": `${sTD}/error/@SAP__common.Application/ServiceRepository` },
+			{ "groupName": "Application", "property": `${sTD}/error/@SAP__common.Application/ServiceVersion` },
+			{ "groupName": "ErrorResolution", "property": `${sTD}/error/@SAP__common.ErrorResolution/Analysis` },
+			{ "groupName": "ErrorResolution", "property": `${sTD}/error/@SAP__common.ErrorResolution/Note` },
+			{ "groupName": "ErrorResolution", "property": `${sTD}/error/@SAP__common.ErrorResolution/DetailedNote` },
+			{ "groupName": "ErrorResolution", "property": `${sTD}/error/@SAP__common.ExceptionCategory` },
+			{ "groupName": "ErrorResolution", "property": `${sTD}/error/@SAP__common.TimeStamp` },
+			{ "groupName": "ErrorResolution", "property": `${sTD}/error/@SAP__common.TransactionId` },
+			{ "groupName": "Messages", "property": `${sTD}/error/code` },
+			{ "groupName": "Messages", "property": `${sTD}/error/message` }
 		];
 	}
 
 	let sHTML = "Object.keys(" + "${technicalDetails}" + ').length > 0 ? "<h2>Technical Details</h2>" : "" ';
 	getPaths().forEach(function (oProperty: { groupName: string; property: string }) {
-		sHTML = sHTML + insertGroupName(oProperty) + "" + insertDetail(oProperty) + " + ";
+		sHTML = `${sHTML + insertGroupName(oProperty)}${insertDetail(oProperty)} + `;
 	});
 	return sHTML;
 }
 function fnFormatDescription() {
-	const sHTML = "(${" + 'description} ? ("<h2>Description</h2>" + ${' + 'description}) : "")';
-	return sHTML;
+	return "(${" + 'description} ? ("<h2>Description</h2>" + ${' + 'description}) : "")';
 }
 /**
  * Calculates the highest priority message type(Error/Warning/Success/Information) from the available messages.
-
+ *
  * @function
  * @name sap.fe.core.actions.messageHandling.fnGetHighestMessagePriority
  * @memberof sap.fe.core.actions.messageHandling
- * @param {Array} [aMessages] Messages list
- * @returns {string} Highest priority message from the available messages
+ * @param [aMessages] Messages list
+ * @returns Highest priority message from the available messages
  * @private
  * @ui5-restricted
  */
@@ -133,14 +134,19 @@ function fnGetHighestMessagePriority(aMessages: any[]) {
 }
 // function which modify e-Tag messages only.
 // returns : true, if any e-Tag message is modified, otherwise false.
-function fnModifyETagMessagesOnly(oMessageManager: any, oResourceBundle: any) {
+function fnModifyETagMessagesOnly(oMessageManager: any, oResourceBundle: any, concurrentEditFlag: boolean | undefined) {
 	const aMessages = oMessageManager.getMessageModel().getObject("/");
 	let bMessagesModified = false;
 	let sEtagMessage = "";
 	aMessages.forEach(function (oMessage: any, i: any) {
 		const oTechnicalDetails = oMessage.getTechnicalDetails();
 		if (oTechnicalDetails && oTechnicalDetails.httpStatus === 412) {
-			sEtagMessage = sEtagMessage || oResourceBundle.getText("C_APP_COMPONENT_SAPFE_ETAG_TECHNICAL_ISSUES");
+			if (oTechnicalDetails.isConcurrentModification && concurrentEditFlag) {
+				sEtagMessage =
+					sEtagMessage || oResourceBundle.getText("C_APP_COMPONENT_SAPFE_ETAG_TECHNICAL_ISSUES_CONCURRENT_MODIFICATION");
+			} else {
+				sEtagMessage = sEtagMessage || oResourceBundle.getText("C_APP_COMPONENT_SAPFE_ETAG_TECHNICAL_ISSUES");
+			}
 			oMessageManager.removeMessages(aMessages[i]);
 			oMessage.setMessage(sEtagMessage);
 			oMessage.target = "";
@@ -179,10 +185,9 @@ function getRetryAfterMessage(oMessage: any, bMessageDialog?: any) {
 			//same year
 			if (bMessageDialog) {
 				//less than 2 min
-				sRetryAfterMessage =
-					oResourceBundle.getText("C_MESSAGE_HANDLING_SAPFE_503_TITLE") +
-					" " +
-					oResourceBundle.getText("C_MESSAGE_HANDLING_SAPFE_503_DESC");
+				sRetryAfterMessage = `${oResourceBundle.getText("C_MESSAGE_HANDLING_SAPFE_503_TITLE")} ${oResourceBundle.getText(
+					"C_MESSAGE_HANDLING_SAPFE_503_DESC"
+				)}`;
 			} else if (dNow.getMonth() !== dRetryAfter.getMonth() || dNow.getDate() !== dRetryAfter.getDate()) {
 				oDateFormat = DateFormat.getDateTimeInstance({
 					pattern: "MMMM dd 'at' hh:mm a"
@@ -268,8 +273,10 @@ function showUnboundMessages(
 	oContext?: any,
 	bHasEtagMessage?: boolean,
 	bShowBoundTransition?: boolean,
-	errorTargetsInAPM?: boolean
-) {
+	showErrorInAPD?: boolean,
+	bShowMessageBox?: boolean,
+	concurrentEditFlag?: boolean
+): Promise<any> {
 	let aUnboundMessages = this.getMessages();
 	const oMessageManager = Core.getMessageManager();
 	let sHighestPriority;
@@ -334,13 +341,9 @@ function showUnboundMessages(
 		});
 	}
 	const oMessageDialogModel = (oMessageView && (oMessageView.getModel() as JSONModel)) || new JSONModel();
-	if (
-		aUnboundMessages.length === 1 &&
-		(aUnboundMessages[0].getCode() === "503" ||
-			(aUnboundMessages[0].getTarget() !== undefined && aUnboundMessages[0].getTarget() !== ""))
-	) {
+	if (aUnboundMessages.length === 1 && (aUnboundMessages[0].getCode() === "503" || bShowMessageBox)) {
 		if (aUnboundMessages[0].getCode() !== "503") {
-			showMessageBox = !errorTargetsInAPM;
+			showMessageBox = !showErrorInAPD;
 		} else {
 			showMessageBox = true;
 		}
@@ -349,14 +352,17 @@ function showUnboundMessages(
 			aCurrentContexts = oListBinding.getCurrentContexts();
 		if (aCurrentContexts && aCurrentContexts.length > 0) {
 			// Don't show dialog incase there are no errors to show
-			showMessageDialog = !errorTargetsInAPM; // if false, show messages in dialog
+			if (oContext && oContext?.getObject()?.IsActiveEntity && !showErrorInAPD) {
+				showMessageDialog = true;
+			} else {
+				showMessageDialog = !showErrorInAPD;
+			} // if false, show messages in dialog
 			// As fitering has already happened here hence
 			// using the message model again for the message dialog view and then filtering on that binding again is unnecessary.
 			// So we create new json model to use for the message dialog view.
 			const aMessages: any[] = [];
-			aCurrentContexts.forEach(function (oContext: any) {
-				let oMessage;
-				oMessage = oContext.getObject();
+			aCurrentContexts.forEach(function (currentContext: any) {
+				const oMessage = currentContext.getObject();
 				aMessages.push(oMessage);
 				aMessageDataList = aMessages;
 			});
@@ -396,13 +402,12 @@ function showUnboundMessages(
 				.getLibraryResourceBundle("sap.fe.core", true)
 				.then(function (oResourceBundle: any) {
 					const bStrictHandlingFlow = false;
-					const bHasEtagMessage = fnModifyETagMessagesOnly(oMessageManager, oResourceBundle);
+					const messageHasETag = fnModifyETagMessagesOnly(oMessageManager, oResourceBundle, concurrentEditFlag);
 					const oMessageObject = prepareMessageViewForDialog(oMessageDialogModel, bStrictHandlingFlow);
 					oDialog =
 						oDialog ||
 						new Dialog({
 							resizable: true,
-							content: oMessageObject.oMessageView,
 							endButton: new Button({
 								press: function () {
 									dialogCloseHandler();
@@ -431,8 +436,9 @@ function showUnboundMessages(
 								aResolveFunctions = [];
 							}
 						});
+					oDialog.addContent(oMessageObject.oMessageView);
 
-					if (bHasEtagMessage) {
+					if (messageHasETag) {
 						sap.ui.require(["sap/m/ButtonType"], function (ButtonType: any) {
 							oDialog.setBeginButton(
 								new Button({
@@ -457,6 +463,7 @@ function showUnboundMessages(
 					(oDialog.getCustomHeader() as any).getContentMiddle()[0].setText(sHighestPriorityText);
 					oMessageView.navigateBack();
 					oDialog.open();
+					resolve(oDialog);
 				})
 				.catch(reject);
 		});
@@ -468,12 +475,12 @@ function showUnboundMessages(
 				let formattedTextString = "<html><body>";
 				const retryAfterMessage = getRetryAfterMessage(oMessage, true);
 				if (retryAfterMessage) {
-					formattedTextString = "<h6>" + retryAfterMessage + "</h6><br>";
+					formattedTextString = `<h6>${retryAfterMessage}</h6><br>`;
 				}
-				if (oMessage.getCode() !== "503") {
-					formattedTextString = formattedTextString + oMessage.additionalText + ": " + oMessage.getMessage() + "</html></body>";
+				if (oMessage.getCode() !== "503" && oMessage.getAdditionalText() !== undefined) {
+					formattedTextString = `${formattedTextString + oMessage.getAdditionalText()}: ${oMessage.getMessage()}</html></body>`;
 				} else {
-					formattedTextString = formattedTextString + oMessage.getMessage() + "</html></body>";
+					formattedTextString = `${formattedTextString + oMessage.getMessage()}</html></body>`;
 				}
 				const formattedText: any = new FormattedText({
 					htmlText: formattedTextString
@@ -512,17 +519,39 @@ function getTranslatedTextForMessageDialog(sHighestPriority: any) {
 function removeUnboundTransitionMessages() {
 	removeTransitionMessages(false);
 }
-function removeBoundTransitionMessages() {
-	removeTransitionMessages(true);
+function removeBoundTransitionMessages(sPathToBeRemoved?: string) {
+	removeTransitionMessages(true, sPathToBeRemoved);
+}
+
+function getMessagesFromMessageModel(oMessageModel: any, sPathToBeRemoved?: string) {
+	if (sPathToBeRemoved === undefined) {
+		return oMessageModel.getObject("/");
+	}
+	const listBinding = oMessageModel.bindList("/");
+	listBinding.filter(
+		new Filter({
+			path: "target",
+			operator: FilterOperator.StartsWith,
+			value1: sPathToBeRemoved
+		})
+	);
+
+	return listBinding.getCurrentContexts().map(function (oContext: any) {
+		return oContext.getObject();
+	});
 }
-function getMessages(bBoundMessages: boolean = false, bTransitionOnly: boolean = false) {
+function getMessages(bBoundMessages: boolean = false, bTransitionOnly: boolean = false, sPathToBeRemoved?: string) {
 	let i;
 	const oMessageManager = (Core as CoreEx as any).getMessageManager(),
 		oMessageModel = oMessageManager.getMessageModel(),
-		aMessages = oMessageModel.getObject("/"),
 		oResourceBundle = (Core as CoreEx).getLibraryResourceBundle("sap.fe.core"),
 		aTransitionMessages = [];
-
+	let aMessages: any[] = [];
+	if (bBoundMessages && bTransitionOnly && sPathToBeRemoved) {
+		aMessages = getMessagesFromMessageModel(oMessageModel, sPathToBeRemoved);
+	} else {
+		aMessages = oMessageModel.getObject("/");
+	}
 	for (i = 0; i < aMessages.length; i++) {
 		if (
 			(!bTransitionOnly || aMessages[i].persistent) &&
@@ -539,14 +568,15 @@ function getMessages(bBoundMessages: boolean = false, bTransitionOnly: boolean =
 			aTransitionMessages[i].message !== "" &&
 			aTransitionMessages[i].message.indexOf(oResourceBundle.getText("C_MESSAGE_HANDLING_SAPFE_503_BACKEND_PREFIX")) === -1
 		) {
-			aTransitionMessages[i].message =
-				"\n" + oResourceBundle.getText("C_MESSAGE_HANDLING_SAPFE_503_BACKEND_PREFIX") + aTransitionMessages[i].message;
+			aTransitionMessages[i].message = `\n${oResourceBundle.getText("C_MESSAGE_HANDLING_SAPFE_503_BACKEND_PREFIX")}${
+				aTransitionMessages[i].message
+			}`;
 		}
 	}
 	return aTransitionMessages;
 }
-function removeTransitionMessages(bBoundMessages: any) {
-	const aMessagesToBeDeleted = getMessages(bBoundMessages, true);
+function removeTransitionMessages(bBoundMessages: any, sPathToBeRemoved?: string) {
+	const aMessagesToBeDeleted = getMessages(bBoundMessages, true, sPathToBeRemoved);
 
 	if (aMessagesToBeDeleted.length > 0) {
 		Core.getMessageManager().removeMessages(aMessagesToBeDeleted);