@sapui5/sap.fe.core 1.124.0 → 1.124.2

package/src/sap/fe/core/controllerextensions/editFlow/draftDataLossPopup.ts

@@ -1,6 +1,7 @@
 import Log from "sap/base/Log";
 import type PageController from "sap/fe/core/PageController";
 import EditState from "sap/fe/core/helpers/EditState";
+import ModelHelper from "sap/fe/core/helpers/ModelHelper";
 import type ObjectPageControllerController from "sap/fe/templates/ObjectPage/ObjectPageController.controller";
 import type ODataV4Context from "sap/ui/model/odata/v4/Context";
 import DraftDataLossDialogBlock from "../../controls/DataLossOrDraftDiscard/DraftDataLossDialog.block";
@@ -12,7 +13,7 @@ enum NavigationType {
 	ForwardNavigation = "ForwardNavigation"
 }
 
-/* Enum types for the dataloss dialog options */
+/* Enum types for the data loss dialog options */
 enum DraftDataLossOptions {
 	Save = "draftDataLossOptionSave",
 	Keep = "draftDataLossOptionKeep",
@@ -24,7 +25,7 @@ type DraftAdministrativeData = {
 	LastChangeDateTime: Date;
 };
 
-/*Create the dataloss dialog*/
+/*Create the data loss dialog*/
 const dataLossDialog = new DraftDataLossDialogBlock({});
 
 /**
@@ -34,20 +35,21 @@ const dataLossDialog = new DraftDataLossDialogBlock({});
  * @returns Boolean value with true or false to silently keep the draft
  */
 function silentlyKeepDraftOnForwardNavigation(pageController: PageController): boolean {
-	let rbSilentlyKeep = false;
+	let rbSilentlyKeep;
 	const oManifest = pageController.getAppComponent().getManifestEntry("sap.fe");
 	rbSilentlyKeep = oManifest?.app?.silentlyKeepDraftOnForwardNavigation || false;
 	return rbSilentlyKeep;
 }
 
 /**
- * Logic to process the fcl mode.
+ * Logic to process the FCL mode.
  *
  * @param draftAdminData Admin data
  * @param fnCancelFunction The cancel function
  * @param oController The current controller referenced
- * @param processFunctionForDrafts The functon to process the handler
+ * @param processFunctionForDrafts The function to process the handler
  * @param bSkipBindingToView The optional parameter to skip the binding to the view
+ * @param context The context to be used for the draft operation
  * @returns Nothing
  */
 async function processFclMode(
@@ -55,7 +57,8 @@ async function processFclMode(
 	fnCancelFunction: Function,
 	oController: PageController,
 	processFunctionForDrafts: Function,
-	bSkipBindingToView?: boolean
+	bSkipBindingToView?: boolean,
+	context?: ODataV4Context
 ): Promise<void> {
 	// The application is running in FCL mode so in this case we fall back to
 	// the old logic since the dirty state handling is not properly working
@@ -69,7 +72,8 @@ async function processFclMode(
 					processFunctionForDrafts,
 					fnCancelFunction,
 					oController,
-					bSkipBindingToView
+					bSkipBindingToView,
+					context
 				)
 			);
 	} else {
@@ -83,10 +87,11 @@ async function processFclMode(
  * @param draftAdminData Admin data
  * @param fnCancelFunction The cancel function
  * @param oController The current controller referenced
- * @param processFunctionForDrafts The functon to process the handler
+ * @param processFunctionForDrafts The function to process the handler
  * @param navigationType The navigation type for which the function should be called
  * @param bSilentlyKeepDraftOnForwardNavigation The parameter to determine whether to skip the popup appearance in forward case
  * @param bSkipBindingToView The optional parameter to skip the binding to the view
+ * @param context The context to be used for the draft operations
  * @returns Nothing
  */
 async function processNoActiveEntityMode(
@@ -96,9 +101,10 @@ async function processNoActiveEntityMode(
 	processFunctionForDrafts: Function,
 	navigationType: NavigationType,
 	bSilentlyKeepDraftOnForwardNavigation: boolean,
-	bSkipBindingToView?: boolean
+	bSkipBindingToView?: boolean,
+	context?: ODataV4Context
 ): Promise<void> {
-	// There is no active entity so we are editing either newly created data or
+	// There is no active entity so, we are editing either newly created data or
 	// a draft which has never been saved to active version
 	// Since we want to react differently in the two situations, we have to check the
 	// dirty state
@@ -108,7 +114,7 @@ async function processNoActiveEntityMode(
 			// navigation we can silently discard the draft again
 			// eslint-disable-next-line promise/no-nesting
 			try {
-				await draftDataLossPopup.discardDraft(oController, bSkipBindingToView);
+				await draftDataLossPopup.discardDraft(oController, bSkipBindingToView, context);
 				processFunctionForDrafts();
 			} catch (error: unknown) {
 				Log.error("Error while canceling the document", error as string);
@@ -119,7 +125,7 @@ async function processNoActiveEntityMode(
 			processFunctionForDrafts();
 		} else {
 			// In this case data is being changed or a forward navigation is triggered
-			// and we always want to show the dataloss dialog on navigation
+			// and, we always want to show the data loss dialog on navigation
 			return dataLossDialog
 				.open(oController)
 				.then((selectedKey) =>
@@ -128,7 +134,8 @@ async function processNoActiveEntityMode(
 						processFunctionForDrafts,
 						fnCancelFunction,
 						oController,
-						bSkipBindingToView
+						bSkipBindingToView,
+						context
 					)
 				);
 		}
@@ -145,7 +152,7 @@ async function processNoActiveEntityMode(
  *
  * @param oController The current controller referenced.
  * @param oContext The context of the current call
- * @param processFunctionForDrafts The functon to process the handler
+ * @param processFunctionForDrafts The function to process the handler
  * @param navigationType The navigation type for which the function should be called
  */
 async function processEditingDraftForExistingEntity(
@@ -158,8 +165,8 @@ async function processEditingDraftForExistingEntity(
 	// The CreationDateTime and LastChangeDateTime are equal, so this draft was
 	// never saved before, hence we're currently editing a newly created draft for
 	// an existing active entity for the first time.
-	// Also there have so far been no changes made to the draft and in this
-	// case we want to silently navigate and delete the draftin case of a back
+	// Also, there have so far been no changes made to the draft and in this
+	// case we want to silently navigate and delete the draft in case of a back
 	// navigation but in case of a forward navigation we want to silently keep it!
 	if (navigationType === NavigationType.BackNavigation) {
 		const mParameters = {
@@ -180,14 +187,15 @@ async function processEditingDraftForExistingEntity(
 }
 
 /**
- * Logic to process the edit state dirty.
+ * Logic to process the context when the edit state is in dirty mode.
  *
  * @param oController The current controller referenced.
  * @param fnCancelFunction The cancel function
- * @param processFunctionForDrafts The functon to process the handler
+ * @param processFunctionForDrafts The function to process the handler
  * @param navigationType The navigation type for which the function should be called
  * @param bSilentlyKeepDraftOnForwardNavigation The parameter to determine whether to skip the popup appearance in forward case
  * @param bSkipBindingToView The optional parameter to skip the binding to the view.
+ * @param context The context to be used for the draft operations
  * @returns Nothing
  */
 async function processEditStateDirty(
@@ -196,7 +204,8 @@ async function processEditStateDirty(
 	processFunctionForDrafts: Function,
 	navigationType: NavigationType,
 	bSilentlyKeepDraftOnForwardNavigation: boolean,
-	bSkipBindingToView?: boolean
+	bSkipBindingToView?: boolean,
+	context?: ODataV4Context
 ): Promise<void> {
 	if (navigationType === NavigationType.ForwardNavigation && bSilentlyKeepDraftOnForwardNavigation) {
 		// In case we have a "forward navigation" and an additional parameter set in the manifest
@@ -206,8 +215,8 @@ async function processEditStateDirty(
 		// The CreationDateTime and LastChangeDateTime are NOT equal, so we are currently editing
 		// an existing draft and need to distinguish depending on if any changes
 		// have been made in the current editing session or not
-		// Changes have been made in the current editing session so we want
-		// to show the dataloss dialog and let the user decide
+		// Changes have been made in the current editing session, so we want
+		// to show the data loss dialog and let the user decide
 		return dataLossDialog
 			.open(oController)
 			.then((selectedKey) =>
@@ -216,7 +225,8 @@ async function processEditStateDirty(
 					processFunctionForDrafts,
 					fnCancelFunction,
 					oController,
-					bSkipBindingToView
+					bSkipBindingToView,
+					context
 				)
 			);
 	}
@@ -226,7 +236,7 @@ async function processEditStateDirty(
  * Logic to process the admin data.
  *
  * @param draftAdminData Admin data
- * @param fnProcessFunction The functon to process the handler
+ * @param fnProcessFunction The function to process the handler
  * @param fnCancelFunction The cancel function
  * @param oContext The context of the current call
  * @param oController The current controller referenced
@@ -255,7 +265,7 @@ async function processDraftAdminData(
 
 	if (draftAdminData) {
 		if (oController.getAppComponent().getRootViewController().isFclEnabled()) {
-			await processFclMode(draftAdminData, fnCancelFunction, oController, processFunctionForDrafts, bSkipBindingToView);
+			await processFclMode(draftAdminData, fnCancelFunction, oController, processFunctionForDrafts, bSkipBindingToView, oContext);
 		} else if (!oContext.getObject().HasActiveEntity) {
 			processNoActiveEntityMode(
 				draftAdminData,
@@ -280,7 +290,7 @@ async function processDraftAdminData(
 		} else {
 			// The user started editing the existing draft but did not make any changes
 			// in the current editing session, so in this case we do not want
-			// to show the dataloss dialog but just keep the draft
+			// to show the data loss dialog but just keep the draft
 			processFunctionForDrafts();
 		}
 	} else {
@@ -314,15 +324,20 @@ async function processDataLossOrDraftDiscardConfirmation(
 	const isDraftRoot = contextPath ? !!oMetaModel.getObject(`${contextPath}@com.sap.vocabularies.Common.v1.DraftRoot`) : false;
 	const oUIModel = oView.getModel("ui");
 	const bIsEditable = oUIModel.getProperty("/isEditable");
-	const draftDataContext = oModel.bindContext(`${oContext.getPath()}/DraftAdministrativeData`).getBoundContext();
+	const originalContext = oContext;
+	let draftRootPath = oContext.getPath();
+	if (!isDraftRoot) {
+		draftRootPath = ModelHelper.getDraftRootPath(oContext) ?? draftRootPath;
+	}
+	oContext = oModel.bindContext(draftRootPath, undefined, { $expand: "DraftAdministrativeData" }).getBoundContext();
 
 	// Shouldn't display data loss popover on shell back navigation from sub-object pages
 	// or when object page is in display mode, or when the object is deleted
-	if (oContext.isDeleted() || (!isDraftRoot && navigationType === NavigationType.BackNavigation) || !bIsEditable) {
+	if (originalContext.isDeleted() || (!isDraftRoot && navigationType === NavigationType.BackNavigation) || !bIsEditable) {
 		fnProcessFunction();
 	} else {
 		try {
-			const draftAdminData = await draftDataContext.requestObject();
+			const draftAdminData = await oContext.requestObject("DraftAdministrativeData");
 			await processDraftAdminData(
 				draftAdminData,
 				fnProcessFunction,
@@ -344,11 +359,13 @@ async function processDataLossOrDraftDiscardConfirmation(
  * from EditFlow is called.
  *
  * @param controller Controller of the current view
+ * @param context The context to be used for the draft operations
  * @returns A promise resolved if the save was successful
  */
-async function saveDocument(controller: PageController): Promise<unknown> {
-	const context = controller.getView().getBindingContext();
-	if (controller.isA<ObjectPageControllerController>("sap.fe.templates.ObjectPage.ObjectPageController")) {
+async function saveDocument(controller: PageController, context?: ODataV4Context): Promise<unknown> {
+	const hasInitialContext = context !== undefined;
+	context = context ?? controller.getView().getBindingContext();
+	if (!hasInitialContext && controller.isA<ObjectPageControllerController>("sap.fe.templates.ObjectPage.ObjectPageController")) {
 		return controller._saveDocument();
 	} else {
 		return controller.editFlow.saveDocument(context, {});
@@ -360,10 +377,15 @@ async function saveDocument(controller: PageController): Promise<unknown> {
  *
  * @param controller Controller of the current view
  * @param skipBindingToView The parameter to skip the binding to the view
+ * @param context The context to be used for the draft operations
  * @returns A promise resolved if cancelDocument was successful
  */
-async function discardDraft(controller: PageController, skipBindingToView: boolean | undefined): Promise<unknown> {
-	const context = controller.getView().getBindingContext();
+async function discardDraft(
+	controller: PageController,
+	skipBindingToView: boolean | undefined,
+	context?: ODataV4Context
+): Promise<unknown> {
+	context = context ?? controller.getView().getBindingContext();
 	const params = {
 		skipBackNavigation: true,
 		skipDiscardPopover: true,
@@ -373,25 +395,27 @@ async function discardDraft(controller: PageController, skipBindingToView: boole
 }
 
 /**
- * Executes the follow-up functions after an option was selected in the dataloss dialog.
+ * Executes the follow-up functions after an option was selected in the data loss dialog.
  *
- * @param selectedKey The key of the selected option from the dataloss dialog
+ * @param selectedKey The key of the selected option from the data loss dialog
  * @param processFunctionForDrafts The function to process the handler
  * @param fnCancelFunction The function to process the handler
  * @param controller Controller of the current view
  * @param skipBindingToView The parameter to skip the binding to the view
+ * @param context The context to be used for the binding
  */
 function handleDialogSelection(
 	selectedKey: string,
 	processFunctionForDrafts: Function,
 	fnCancelFunction: Function,
 	controller: PageController,
-	skipBindingToView: boolean | undefined
+	skipBindingToView: boolean | undefined,
+	context?: ODataV4Context
 ): void {
 	switch (selectedKey) {
 		case DraftDataLossOptions.Save:
 			draftDataLossPopup
-				.saveDocument(controller)
+				.saveDocument(controller, context)
 				.then((context?) => processFunctionForDrafts(context))
 				.catch(function (error: string | undefined) {
 					if (error === RecommendationDialogDecision.Continue) {
@@ -407,7 +431,7 @@ function handleDialogSelection(
 			break;
 		case DraftDataLossOptions.Discard:
 			draftDataLossPopup
-				.discardDraft(controller, skipBindingToView)
+				.discardDraft(controller, skipBindingToView, context)
 				.then((context?) => processFunctionForDrafts(context))
 				.catch(function (error: string | undefined) {
 					Log.error("Error while discarding draft", error);