@sapui5/sap.fe.core 1.113.0 → 1.115.0

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

@@ -5,7 +5,7 @@ import CommonUtils from "sap/fe/core/CommonUtils";
 import BusyLocker from "sap/fe/core/controllerextensions/BusyLocker";
 import ActivitySync from "sap/fe/core/controllerextensions/collaboration/ActivitySync";
 import { Activity, shareObject } from "sap/fe/core/controllerextensions/collaboration/CollaborationCommon";
-import type { SiblingInformation } from "sap/fe/core/controllerextensions/editFlow/draft";
+import type { RootContextInfo, SiblingInformation } from "sap/fe/core/controllerextensions/editFlow/draft";
 import draft from "sap/fe/core/controllerextensions/editFlow/draft";
 import sticky from "sap/fe/core/controllerextensions/editFlow/sticky";
 import TransactionHelper from "sap/fe/core/controllerextensions/editFlow/TransactionHelper";
@@ -40,6 +40,7 @@ import type Binding from "sap/ui/model/Binding";
 import type JSONModel from "sap/ui/model/json/JSONModel";
 import type Model from "sap/ui/model/Model";
 import type Context from "sap/ui/model/odata/v4/Context";
+import ODataV4Context from "sap/ui/model/odata/v4/Context";
 import ODataListBinding from "sap/ui/model/odata/v4/ODataListBinding";
 import type ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
 import type ODataModel from "sap/ui/model/odata/v4/ODataModel";
@@ -104,23 +105,11 @@ class EditFlow extends ControllerExtension {
 		const oViewData = this.getView().getViewData() as BaseManifestSettings;
 		const sProgrammingModel = this.getProgrammingModel(oContext);
 		let oRootContext: Context = oContext;
-		const oView = this.getView();
+		const oView = this.base.getView();
 		try {
 			if ((oViewData?.viewLevel as number) > 1) {
-				if (sProgrammingModel === ProgrammingModel.Draft) {
-					const draftRootPath: string | undefined = ModelHelper.getDraftRootPath(oContext);
-					oRootContext = oView
-						.getModel()
-						.bindContext(draftRootPath as string)
-						.getBoundContext() as Context;
-					await oRootContext.requestObject(draftRootPath);
-				} else if (sProgrammingModel === ProgrammingModel.Sticky) {
-					const sStickyRootPath = ModelHelper.getStickyRootPath(oContext);
-					oRootContext = oView
-						.getModel()
-						.bindContext(sStickyRootPath as string)
-						.getBoundContext() as Context;
-					await oRootContext.requestObject(sStickyRootPath);
+				if (sProgrammingModel === ProgrammingModel.Draft || sProgrammingModel === ProgrammingModel.Sticky) {
+					oRootContext = (await CommonUtils.createRootContext(sProgrammingModel, oView, this.getAppComponent())) as Context;
 				}
 			}
 			await this.base.editFlow.onBeforeEdit({ context: oRootContext });
@@ -149,7 +138,18 @@ class EditFlow extends ControllerExtension {
 							contextToNavigate = siblingInfo.targetContext;
 						}
 					} else if ((oViewData?.viewLevel as number) > 1) {
-						siblingInfo = await this._computeSiblingInformation(oRootContext, oContext, sProgrammingModel, true);
+						const rootSiblingPath = oNewDocumentContext?.getPath();
+						const rootContextInfo = {
+							rootSiblingPath: rootSiblingPath,
+							rootContextNotRequired: true
+						};
+						siblingInfo = await this._computeSiblingInformation(
+							oRootContext,
+							oContext,
+							sProgrammingModel,
+							true,
+							rootContextInfo
+						);
 						contextToNavigate = this._getNavigationTargetForEdit(oContext, oNewDocumentContext, siblingInfo) as Context;
 					}
 					await this._handleNewContext(contextToNavigate, true, false, bDraftNavigation, true);
@@ -178,16 +178,18 @@ class EditFlow extends ControllerExtension {
 	/**
 	 * Deletes several documents.
 	 *
-	 * @param contextsToDelete The contexts of the documents to delete
+	 * @param contextsToDelete The contexts of the documents to be deleted
 	 * @param parameters The parameters
 	 * @returns Promise resolved once the documents are deleted
 	 */
 	async deleteMultipleDocuments(contextsToDelete: Context[], parameters: any) {
 		if (parameters) {
 			parameters.beforeDeleteCallBack = this.base.editFlow.onBeforeDelete;
+			parameters.requestSideEffects = parameters.requestSideEffects !== false;
 		} else {
 			parameters = {
-				beforeDeleteCallBack: this.base.editFlow.onBeforeDelete
+				beforeDeleteCallBack: this.base.editFlow.onBeforeDelete,
+				requestSideEffects: true
 			};
 		}
 		const lockObject = this.getGlobalUIModel();
@@ -225,7 +227,7 @@ class EditFlow extends ControllerExtension {
 				// if there are transient contexts, we must avoid requesting side effects
 				// this is avoid a potential list refresh, there could be a side effect that refreshes the list binding
 				// if list binding is refreshed, transient contexts might be lost
-				if (!CommonUtils.hasTransientContext(listBinding)) {
+				if (parameters.requestSideEffects && !CommonUtils.hasTransientContext(listBinding)) {
 					this.getAppComponent()
 						.getSideEffectsService()
 						.requestSideEffectsForNavigationProperty(listBinding.getPath(), viewBindingContext as Context);
@@ -371,7 +373,7 @@ class EditFlow extends ControllerExtension {
 			// TODO: Call appropriate function (currently using the same as for outbound chevron nav, and without any context - 3rd param)
 			await this.syncTask();
 			const oController = this.getView().getController();
-			const sCreatePath = ModelHelper.getAbsoluteMetaPathForListBinding(this.getView(), vListBinding);
+			const sCreatePath = ModelHelper.getAbsoluteMetaPathForListBinding(this.base.getView(), vListBinding);
 
 			(oController as any).handlers.onChevronPressNavigateOutBound(oController, mParameters.outbound, undefined, sCreatePath);
 
@@ -771,10 +773,11 @@ class EditFlow extends ControllerExtension {
 	 *
 	 * @param listBinding The listBinding used to create the documents
 	 * @param dataForCreate The initial data for the new documents
-	 * @param createAtEnd True if the new contexts need to be crated at the end of the list binding
+	 * @param createAtEnd True if the new contexts need to be created at the end of the list binding
 	 * @param isFromCopyPaste True if the creation has been triggered by a paste action
 	 * @param beforeCreateCallBack Callback to be called before the creation
-	 * @param createAsInactive True if the contexts need to be created inactive
+	 * @param createAsInactive True if the contexts need to be created as inactive
+	 * @param requestSideEffects True by default, false if SideEffects should not be requested
 	 * @returns A Promise with the newly created contexts.
 	 */
 	async createMultipleDocuments(
@@ -783,12 +786,15 @@ class EditFlow extends ControllerExtension {
 		createAtEnd: boolean,
 		isFromCopyPaste: boolean,
 		beforeCreateCallBack?: Function,
-		createAsInactive = false
+		createAsInactive = false,
+		requestSideEffects?: boolean
 	) {
 		const transactionHelper = this.getTransactionHelper();
 		const lockObject = this.getGlobalUIModel();
 		const targetListBinding = listBinding;
 
+		requestSideEffects = requestSideEffects !== false;
+
 		BusyLocker.lock(lockObject);
 
 		try {
@@ -859,7 +865,7 @@ class EditFlow extends ControllerExtension {
 			// if there are transient contexts, we must avoid requesting side effects
 			// this is avoid a potential list refresh, there could be a side effect that refreshes the list binding
 			// if list binding is refreshed, transient contexts might be lost
-			if (!CommonUtils.hasTransientContext(targetListBinding)) {
+			if (requestSideEffects && !CommonUtils.hasTransientContext(targetListBinding)) {
 				this.getAppComponent()
 					.getSideEffectsService()
 					.requestSideEffectsForNavigationProperty(targetListBinding.getPath(), viewBindingContext as Context);
@@ -1018,6 +1024,9 @@ class EditFlow extends ControllerExtension {
 
 		try {
 			await this.syncTask();
+			// in case of saving / activating the bound transition messages shall be removed before the PATCH/POST
+			// is sent to the backend
+			this.getMessageHandler().removeTransitionMessages();
 			await this._submitOpenChanges(oContext);
 			await this._checkForValidationErrors();
 			await this.base.editFlow.onBeforeSave({ context: oContext });
@@ -1157,7 +1166,7 @@ class EditFlow extends ControllerExtension {
 	 */
 	@publicExtension()
 	@finalExtension()
-	async cancelDocument(oContext: Context, mParameters: { control: object; skipDiscardPopover?: boolean }): Promise<any> {
+	async cancelDocument(oContext: Context, mParameters: { control?: object; skipDiscardPopover?: boolean }): Promise<any> {
 		const transactionHelper = this.getTransactionHelper();
 		const mInParameters: any = mParameters;
 		let siblingInfo: SiblingInformation | undefined;
@@ -1189,6 +1198,14 @@ class EditFlow extends ControllerExtension {
 				this.getCreationMode(),
 				this.isDocumentModified()
 			);
+			this._getRootViewController()
+				.getInstancedViews()
+				.forEach((view) => {
+					const context = view.getBindingContext() as ODataV4Context;
+					if (context && context.isKeepAlive()) {
+						context.setKeepAlive(false);
+					}
+				});
 			const bDraftNavigation = true;
 			this._removeStickySessionInternalProperties(sProgrammingModel);
 
@@ -1236,7 +1253,10 @@ class EditFlow extends ControllerExtension {
 					await this._handleNewContext(contextToNavigate, false, false, bDraftNavigation, true);
 				}
 			}
-			this.showDocumentDiscardMessage(isNewDocument);
+			if (sProgrammingModel === ProgrammingModel.Draft) {
+				//show Draft discarded message toast only for draft enabled apps
+				this.showDocumentDiscardMessage(isNewDocument);
+			}
 		} catch (oError) {
 			Log.error("Error while discarding the document", oError as any);
 		}
@@ -1245,7 +1265,7 @@ class EditFlow extends ControllerExtension {
 	/**
 	 * Brings up a message toast when a draft is discarded.
 	 *
-	 * @param isNewDocument This is a Boolean flag that determines whether the document is new or it is an existing document.
+	 * @param isNewDocument This is a Boolean flag that determines whether the document is new or already exists.
 	 */
 	showDocumentDiscardMessage(isNewDocument?: boolean) {
 		const resourceModel = this._getResourceModel();
@@ -1374,13 +1394,15 @@ class EditFlow extends ControllerExtension {
 	 */
 	@publicExtension()
 	@finalExtension()
-	async applyDocument(oContext: object): Promise<void> {
+	async applyDocument(oContext: Context): Promise<void> {
 		const oLockObject = this.getGlobalUIModel();
-		BusyLocker.lock(oLockObject);
 
 		try {
 			await this.syncTask();
-			await this._submitOpenChanges(oContext);
+			if (oContext.getModel().hasPendingChanges("$auto")) {
+				BusyLocker.lock(oLockObject);
+				await this._submitOpenChanges(oContext);
+			}
 			await this._checkForValidationErrors();
 			await this.getMessageHandler().showMessageDialog();
 			await this.getInternalRouting().navigateBackFromContext(oContext);
@@ -1438,7 +1460,7 @@ class EditFlow extends ControllerExtension {
 		let aParts;
 		let sOverloadEntityType;
 		let oCurrentActionCallBacks: any;
-		const oView = this.getView();
+		const oView = this.base.getView();
 
 		let mParameters: any = mInParameters || {};
 		// Due to a mistake the invokeAction in the extensionAPI had a different API than this one.
@@ -1577,7 +1599,7 @@ class EditFlow extends ControllerExtension {
 					vContext = vContext[0].value;
 				}
 				if (vContext && !Array.isArray(vContext)) {
-					const oMetaModel = oView.getModel().getMetaModel() as ODataMetaModel;
+					const oMetaModel = oView.getModel().getMetaModel();
 					const sContextMetaPath = oMetaModel.getMetaPath(vContext.getPath());
 					const _fnValidContexts = (contexts: any, applicableContexts: any) => {
 						return contexts.filter((element: any) => {
@@ -1603,6 +1625,7 @@ class EditFlow extends ControllerExtension {
 					}
 				}
 			}
+			this.base.editFlow.onAfterActionExecution(sActionName);
 			return oResponse;
 		} catch (err: any) {
 			if (oCurrentActionCallBacks) {
@@ -1623,6 +1646,21 @@ class EditFlow extends ControllerExtension {
 		}
 	}
 
+	/**
+	 * Hook which can be overridden after the action execution.
+	 *
+	 * @memberof sap.fe.core.controllerextensions.EditFlow
+	 * @param _actionName Name of the action
+	 * @alias sap.fe.core.controllerextensions.EditFlow#onAfterActionExecution
+	 * @private
+	 * @since 1.114.0
+	 */
+	@publicExtension()
+	@extensible(OverrideExecution.After)
+	async onAfterActionExecution(_actionName: string) {
+		//to be overridden
+	}
+
 	/**
 	 * Secured execution of the given function. Ensures that the function is only executed when certain conditions are fulfilled.
 	 *
@@ -2079,7 +2117,7 @@ class EditFlow extends ControllerExtension {
 				appComponent.getShellServices().registerDirtyStateProvider(this.dirtyStateProviderFunction);
 
 				// handle session timeout
-				const i18nModel = this.getView().getModel("sap.fe.i18n");
+				const i18nModel = this.base.getView().getModel("sap.fe.i18n");
 				this.sessionTimeoutFunction = this.getSessionTimeoutFunction(context, i18nModel);
 				(this.getView().getModel() as any).attachSessionTimeout(this.sessionTimeoutFunction);
 
@@ -2269,10 +2307,7 @@ class EditFlow extends ControllerExtension {
 			// either current hash is empty so the user left the app or he navigated away from the object
 			if (!currentHash || !appComponent.getRouterProxy().checkHashWithGuard(currentHash)) {
 				this.discardStickySession(context);
-				setTimeout(() => {
-					//clear the session context to ensure the LR refreshes the list without a session
-					(context.getModel() as any).clearSessionContext();
-				}, 0);
+				context.getModel().clearSessionContext();
 			}
 		};
 	}
@@ -2287,7 +2322,10 @@ class EditFlow extends ControllerExtension {
 		if (discardedContext?.hasPendingChanges()) {
 			discardedContext.getBinding().resetChanges();
 		}
-		discardedContext?.refresh();
+		if (!this.getCreationMode()) {
+			discardedContext?.refresh();
+		}
+
 		this.handleStickyOff();
 	}
 
@@ -2347,7 +2385,7 @@ class EditFlow extends ControllerExtension {
 		if (!response) {
 			return null;
 		}
-		const currentView = this.getView();
+		const currentView = this.base.getView();
 		const metaModelData = (currentView.getModel().getMetaModel() as any).getData();
 		const actionReturnType =
 			metaModelData && metaModelData[actionName] && metaModelData[actionName][0] && metaModelData[actionName][0].$ReturnType
@@ -2466,7 +2504,7 @@ class EditFlow extends ControllerExtension {
 	 * Method to display a 'discard' popover when exiting a sticky session.
 	 */
 	private onBackNavigationInSession() {
-		const view = this.getView();
+		const view = this.base.getView();
 		const routerProxy = this.getAppComponent().getRouterProxy();
 
 		if (routerProxy.checkIfBackIsOutOfGuard()) {
@@ -2719,13 +2757,15 @@ class EditFlow extends ControllerExtension {
 	 * @param rightmostCurrentContext The context of the subobject
 	 * @param sProgrammingModel The programming model
 	 * @param doNotComputeIfRoot If true, we don't compute siblingInfo if the root and the rightmost contexts are the same
+	 * @param rootContextInfo The root context information of root of the draft
 	 * @returns Returns the siblingInformation object
 	 */
 	async _computeSiblingInformation(
 		rootCurrentContext: Context,
 		rightmostCurrentContext: Context | null | undefined,
 		sProgrammingModel: string,
-		doNotComputeIfRoot: boolean
+		doNotComputeIfRoot: boolean,
+		rootContextInfo?: RootContextInfo
 	): Promise<SiblingInformation | undefined> {
 		rightmostCurrentContext = rightmostCurrentContext ?? rootCurrentContext;
 		if (!rightmostCurrentContext.getPath().startsWith(rootCurrentContext.getPath())) {
@@ -2739,7 +2779,7 @@ class EditFlow extends ControllerExtension {
 
 		const model = rootCurrentContext.getModel();
 		if (sProgrammingModel === ProgrammingModel.Draft) {
-			return draft.computeSiblingInformation(rootCurrentContext, rightmostCurrentContext);
+			return draft.computeSiblingInformation(rootCurrentContext, rightmostCurrentContext, rootContextInfo);
 		} else {
 			// If not in draft mode, we just recreate a context from the path of the rightmost context
 			// No path mapping is needed