@sapui5/sap.fe.core 1.136.7 → 1.136.9

package/src/sap/fe/core/controllerextensions/EditFlow.ts

@@ -71,6 +71,7 @@ import ActionRuntime from "../ActionRuntime";
 import { ConfirmRecommendationDialog, RecommendationDialogDecision } from "../controls/Recommendations/ConfirmRecommendationDialog";
 import { CreationMode, type BaseManifestSettings } from "../converters/ManifestSettings";
 import { isFulfilled } from "../helpers/TypeGuards";
+import draftDataLossPopup from "./editFlow/draftDataLossPopup";
 import type { OperationResult } from "./editFlow/operations/ODataOperation";
 import NavigationReason from "./routing/NavigationReason";
 const ProgrammingModel = FELibrary.ProgrammingModel,
@@ -245,6 +246,8 @@ class EditFlow extends BaseControllerExtension {
 						stickyContext = newDocumentContext;
 					}
 					await this.handleStickyOn(stickyContext);
+				} else if (this._hiddenDraft) {
+					await this.handleHiddenDraftEdit(newDocumentContext);
 				}
 				overrideMessageUIDecision = true;
 
@@ -755,6 +758,11 @@ class EditFlow extends BaseControllerExtension {
 			}
 		}
 		if (newDocumentContext) {
+			// Handle hidden draft session for created documents, similar to editDocument
+			if (this._hiddenDraft && programmingModel === ProgrammingModel.Draft) {
+				await this.handleHiddenDraftEdit(newDocumentContext);
+			}
+
 			this.setDocumentModifiedOnCreate(listBinding);
 			if (!this._isFclEnabled()) {
 				EditState.setEditStateDirty();
@@ -1775,7 +1783,7 @@ class EditFlow extends BaseControllerExtension {
 			if (
 				((sProgrammingModel === ProgrammingModel.Sticky || oContext.getProperty("HasActiveEntity")) &&
 					rootViewController.isFclEnabled()) ||
-				this._hiddenDraft
+				(this._hiddenDraft && oContext.getProperty("HasActiveEntity"))
 			) {
 				siblingInfo = await this._computeSiblingInformation(
 					rootContext,
@@ -1808,6 +1816,9 @@ class EditFlow extends BaseControllerExtension {
 				mParameters?.isStandardSave
 			);
 			this._removeStickySessionInternalProperties(sProgrammingModel);
+			if (this._hiddenDraft) {
+				this.handleSessionOff();
+			}
 
 			this._sendActivity(Activity.Activate, activeDocumentContext);
 			this.base.collaborativeDraft.disconnect();
@@ -1958,8 +1969,17 @@ class EditFlow extends BaseControllerExtension {
 
 		try {
 			await this.syncTask();
+			let rootContext: Context;
 			const sProgrammingModel = this.getProgrammingModel(oContext);
-			const rootContext: Context = await this.getRootContext(oContext);
+
+			// Determine the root context based on hidden draft mode and programming model
+			if (this._hiddenDraft && sProgrammingModel === "Draft") {
+				const rootContextPath = ModelHelper.getDraftRootPath(oContext);
+				rootContext = oContext.getPath() === rootContextPath ? oContext : await this.getRootContext(oContext);
+			} else {
+				rootContext = await this.getRootContext(oContext);
+			}
+
 			if (
 				((sProgrammingModel === ProgrammingModel.Sticky || oContext.getProperty("HasActiveEntity")) && this._isFclEnabled()) ||
 				this._hiddenDraft
@@ -1993,6 +2013,9 @@ class EditFlow extends BaseControllerExtension {
 					}
 				});
 			this._removeStickySessionInternalProperties(sProgrammingModel);
+			if (this._hiddenDraft) {
+				this.handleSessionOff();
+			}
 
 			this.setEditMode(EditMode.Display, false);
 			this.setDocumentModified(false);
@@ -3069,26 +3092,77 @@ class EditFlow extends BaseControllerExtension {
 			}
 
 			if (!appComponent.getRouterProxy().hasNavigationGuard()) {
-				const hashTracker = appComponent.getRouterProxy().getHash();
-				const internalModel = this.getInternalModel();
-
-				// Set a guard in the RouterProxy
-				// A timeout is necessary, as with deferred creation the hashChanger is not updated yet with
-				// the new hash, and the guard cannot be found in the managed history of the router proxy
-				setTimeout(function () {
-					appComponent.getRouterProxy().setNavigationGuard(context.getPath().substring(1));
-				}, 0);
-
-				// Setting back navigation on shell service, to get the dicard message box in case of sticky
-				await appComponent.getShellServices().setBackNavigation(this.onBackNavigationInSession.bind(this, context));
-
-				// Attach sticky session callbacks
-				const i18nModel = this.base.getView().getModel("sap.fe.i18n");
-				appComponent.registerStickySessionCallbacks(
-					this.getDirtyStateProvider(appComponent, internalModel, hashTracker),
-					this.getSessionTimeoutFunction(context, i18nModel),
-					this.getRouteMatchedFunction(context, appComponent)
-				);
+				await this.registerCallbacks(context, appComponent);
+			}
+		} catch (error: unknown) {
+			Log.info(error as string);
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * Registers session callbacks for draft handling.
+	 * @param context The context being edited
+	 * @param appComponent The application component
+	 * @param semanticPath Optional semantic path for navigation guard
+	 */
+	private async registerCallbacks(context: Context, appComponent: AppComponent, semanticPath?: string): Promise<void> {
+		const hashTracker = appComponent.getRouterProxy().getHash();
+		const internalModel = this.getInternalModel();
+
+		// Set a guard in the RouterProxy
+		// A timeout is necessary, as with deferred creation the hashChanger is not updated yet with
+		// the new hash, and the guard cannot be found in the managed history of the router proxy
+		setTimeout(function () {
+			appComponent.getRouterProxy().setNavigationGuard(context.getPath().substring(1), semanticPath);
+		}, 0);
+
+		// Setting back navigation on shell service, to get the discard message box in case of sticky
+		await appComponent.getShellServices().setBackNavigation(this.onBackNavigationInSession.bind(this, context));
+
+		// Attach sticky session callbacks
+		const i18nModel = this.base.getView().getModel("sap.fe.i18n");
+		appComponent.registerCallbacks(
+			this.getDirtyStateProvider(appComponent, internalModel, hashTracker),
+			this.getRouteMatchedFunction(context, appComponent),
+			!this._hiddenDraft ? this.getSessionTimeoutFunction(context, i18nModel) : undefined
+		);
+	}
+
+	/**
+	 * Enables hidden draft edit session handling.
+	 * Sets up the necessary session callbacks and navigation guards for hidden draft scenarios.
+	 * @param context The context being edited in the hidden draft session
+	 * @returns Promise resolving to true if session setup succeeds, false otherwise
+	 */
+	private async handleHiddenDraftEdit(context: Context): Promise<boolean> {
+		const appComponent = this.getAppComponent();
+
+		try {
+			if (appComponent === undefined) {
+				throw new Error("undefined AppComponent for function handleHiddenDraftEdit");
+			}
+
+			// Ensure we have the correct context for hidden draft handling
+			let hiddenDraftContext: Context;
+			if (!this._isFclEnabled()) {
+				hiddenDraftContext = context;
+			} else {
+				hiddenDraftContext = context?.getModel().getKeepAliveContext(context.getPath());
+			}
+
+			//Create can be handled from any context, but we need to create the guard only for the create in root Context.
+			if (this.getCreationMode()) {
+				const rootContextPath = ModelHelper.getDraftRootPath(hiddenDraftContext);
+				hiddenDraftContext =
+					hiddenDraftContext.getPath() === rootContextPath ? hiddenDraftContext : await this.getRootContext(hiddenDraftContext);
+			}
+
+			if (!appComponent.getRouterProxy().hasNavigationGuard()) {
+				const semanticPath = SemanticKeyHelper.getSemanticPath(hiddenDraftContext, true)?.substring(1);
+				await this.registerCallbacks(hiddenDraftContext, appComponent, semanticPath);
 			}
 		} catch (error: unknown) {
 			Log.info(error as string);
@@ -3102,7 +3176,7 @@ class EditFlow extends BaseControllerExtension {
 	 * Disables the sticky edit session.
 	 * @returns True in case of success, false otherwise
 	 */
-	private handleStickyOff(): boolean {
+	private handleSessionOff(): boolean {
 		const appComponent = this.getAppComponent();
 		try {
 			if (appComponent === undefined) {
@@ -3115,10 +3189,10 @@ class EditFlow extends BaseControllerExtension {
 				appComponent.getRouterProxy().discardNavigationGuard();
 			}
 
-			if (appComponent.unregisterStickySessionCallbacks) {
+			if (appComponent.unregisterCallbacks) {
 				// If we have exited from the app, CommonUtils.getAppComponent doesn't return a
 				// sap.fe.core.AppComponent, hence the 'if' above
-				appComponent.unregisterStickySessionCallbacks();
+				appComponent.unregisterCallbacks();
 			}
 
 			this.setEditMode(EditMode.Display, false);
@@ -3164,7 +3238,7 @@ class EditFlow extends BaseControllerExtension {
 				let isDirty: boolean;
 				const isSessionOn = internalModel.getProperty("/sessionOn");
 
-				if (!isSessionOn) {
+				if (!isSessionOn && !this._hiddenDraft) {
 					// If the sticky session was terminated before hand.
 					// Example in case of navigating away from application using IBN.
 					return undefined;
@@ -3183,6 +3257,10 @@ class EditFlow extends BaseControllerExtension {
 					// or crossing the guard has already been allowed by the RouterProxy
 					lclHashTracker = targetHash;
 					isDirty = false;
+				} else if (this._hiddenDraft && !this.isDocumentModified()) {
+					// the user attempts to navigate within the hidden draft when the document is not modified
+					isDirty = false;
+					lclHashTracker = targetHash;
 				} else {
 					// the user attempts to navigate within the app, for example back to the list report
 					isDirty = true;
@@ -3230,7 +3308,7 @@ class EditFlow extends BaseControllerExtension {
 						type: "Emphasized",
 						press: (): void => {
 							// remove sticky handling after navigation since session has already been terminated
-							this.handleStickyOff();
+							this.handleSessionOff();
 							this.getInternalRouting().navigateBackFromContext(stickyContext);
 						}
 					}),
@@ -3256,32 +3334,92 @@ class EditFlow extends BaseControllerExtension {
 	 * @param appComponent The app component
 	 * @returns The callback function
 	 */
-	private getRouteMatchedFunction(context: Context, appComponent: AppComponent) {
-		return (): void => {
+	private getRouteMatchedFunction(context: Context, appComponent: AppComponent): () => Promise<void> {
+		const programmingModel = this.getProgrammingModel(context);
+		const model = context.getModel();
+		const contextPath = context.getPath();
+		return async (): Promise<void> => {
 			const currentHash = appComponent.getRouterProxy().getHash();
-			// either current hash is empty so the user left the app or he navigated away from the object
+			// If the current hash is empty or the navigation is outside the guard, discard the session.
 			if (!currentHash || !appComponent.getRouterProxy().checkHashWithGuard(currentHash)) {
-				this.discardStickySession(context);
-				context.getModel().clearSessionContext();
+				if (this._hiddenDraft && programmingModel === ProgrammingModel.Draft) {
+					return this.handleHiddenDraftDiscard(context, model, contextPath);
+				} else {
+					// For sticky session, discard changes and clear session context.
+					await this.discardStickySession(context);
+					context.getModel().clearSessionContext();
+				}
 			}
 		};
 	}
 
+	/**
+	 * Handles the discard process for hidden draft sessions.
+	 * Prepares the context and ensures we have the required properties before discarding.
+	 * @param context The context being edited.
+	 * @param model The OData model instance used for binding the context.
+	 * @param contextPath The path of the context being edited.
+	 * @returns A promise that resolves when the hidden draft session is discarded.
+	 */
+	private async handleHiddenDraftDiscard(context: ODataV4Context, model: ODataModel, contextPath: string): Promise<void> {
+		// Prepare the context for discard operation
+		let discardContext: Context;
+		if (context?.getBinding()) {
+			discardContext = context;
+		} else {
+			discardContext = model.bindContext(contextPath, undefined, {}).getBoundContext();
+		}
+
+		// Request necessary properties before discarding the draft session.
+		await discardContext.requestProperty(["HasActiveEntity", "IsActiveEntity"]);
+		return this.discardHiddenDraftSession(discardContext);
+	}
+
+	/**
+	 * Discards the current context changes and refreshes the context if it is not a creation operation.
+	 * @param context The context to be discarded.
+	 * @param isCreation A boolean indicating if the context is for a creation operation.
+	 */
+	private discardContext(context: Context, isCreation: boolean): void {
+		if (context?.hasPendingChanges()) {
+			context.getBinding().resetChanges();
+		}
+		if (!isCreation) {
+			context.refresh();
+		}
+	}
+
 	/**
 	 * Ends a sticky session by discarding changes.
 	 * @param context The context being edited (root of the sticky session)
 	 */
 	private async discardStickySession(context: Context): Promise<void> {
-		const isCreation = this.getCreationMode(); // Store this value in a variable, as it will be reset in handleStickyOff
-		this.handleStickyOff(); // Remove all callbacks before calling the async method on the server, otherwise they will conflict with RouteProxy.restoreHistory that is called synchronously in the routing service
+		const isCreation = this.getCreationMode();
+		this.handleSessionOff();
 
 		const discardedContext = await sticky.discardDocument(context);
-		if (discardedContext?.hasPendingChanges()) {
-			discardedContext.getBinding().resetChanges();
+		if (discardedContext !== undefined && discardedContext !== null) {
+			this.discardContext(discardedContext, isCreation);
 		}
-		if (!isCreation) {
-			discardedContext?.refresh();
+	}
+
+	/**
+	 * Discards the hidden draft session for the given context.
+	 * @param context The context from which the draft session will be discarded.
+	 * @returns A promise that resolves when the discard operation is complete.
+	 */
+	private async discardHiddenDraftSession(context: Context): Promise<void> {
+		const isCreation = this.getCreationMode();
+		const discardedContext = (await draftDataLossPopup.discardDraft(
+			this.getView().getController() as PageController,
+			undefined,
+			context,
+			true
+		)) as Context;
+		if (discardedContext !== undefined && discardedContext !== null) {
+			this.discardContext(discardedContext, isCreation);
 		}
+		this.handleSessionOff();
 	}
 
 	/**
@@ -3455,7 +3593,7 @@ class EditFlow extends BaseControllerExtension {
 			const internalModel = this.getInternalModel();
 			internalModel.setProperty("/sessionOn", false);
 			internalModel.setProperty("/stickySessionToken", undefined);
-			this.handleStickyOff();
+			this.handleSessionOff();
 		}
 	}