@sapui5/sap.fe.core 1.136.2 → 1.138.0

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

@@ -263,34 +263,25 @@ class EditFlow extends BaseControllerExtension {
 	/**
 	 * Requests the side effects required after deleting an object.
 	 * @param listBinding The list binding the deleted object belongs to
-	 * @param parentContext The context of the parent object of the deleted object
+	 * @param parentContext The context of parent object of the deleted object
 	 */
-	private requestSideEffectsOnDelete(listBinding: ODataListBinding, parentContext: Context | undefined): void {
-		if (parentContext && this.requestSideEffectsForNavigationProperty(listBinding, parentContext)) {
-			const stateMessagesPath = ModelHelper.getMessagesPath(listBinding.getModel().getMetaModel(), parentContext.getPath());
-			// In case of a TreeTable, we need to refresh state messages for the ObjectPage, as some of these messages might be attached
-			// to children of a deleted row which may not have been loaded yet, and therefore the model wouldn't clean up these messages
-			if (stateMessagesPath && this.getTransactionHelper().isListBindingHierarchical(listBinding)) {
-				this.getAppComponent().getSideEffectsService().requestSideEffects([stateMessagesPath], parentContext);
-			}
+	private requestSideEffectsOnDelete(listBinding: ODataListBinding | undefined, parentContext: Context | undefined): void {
+		if (!listBinding || !parentContext || CommonUtils.hasTransientContext(listBinding)) {
+			// 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
+			return;
 		}
-	}
 
-	requestSideEffectsForNavigationProperty(listBinding: ODataListBinding, parentContext: Context | null | undefined): boolean {
-		if (parentContext) {
-			const listBindingRelativePath = ModelHelper.getRelativeMetaPathForListBinding(parentContext, listBinding);
-			if (!CommonUtils.hasTransientContext(listBinding) && listBindingRelativePath) {
-				// 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
-				this.getAppComponent()
-					.getSideEffectsService()
-					.requestSideEffectsForNavigationProperty(listBindingRelativePath, parentContext);
+		const sideEffectService = this.getAppComponent().getSideEffectsService();
+		sideEffectService.requestSideEffectsForNavigationProperty(listBinding.getPath(), parentContext);
 
-				return true;
-			}
+		const stateMessagesPath = ModelHelper.getMessagesPath(listBinding.getModel().getMetaModel(), parentContext.getPath());
+		// In case of a TreeTable, we need to refresh state messages for the ObjectPage, as some of these messages might be attached
+		// to children of a deleted row which may not have been loaded yet, and therefore the model wouldn't clean up these messages
+		if (stateMessagesPath && this.getTransactionHelper().isListBindingHierarchical(listBinding)) {
+			sideEffectService.requestSideEffects([stateMessagesPath], parentContext);
 		}
-		return false;
 	}
 
 	/**
@@ -337,11 +328,15 @@ class EditFlow extends BaseControllerExtension {
 		BusyLocker.lock(lockObject);
 
 		try {
+			const deleted = await this.deleteDocumentTransaction(contextsToDelete, parameters);
+			if (!deleted) {
+				// The delete was cancelled
+				return;
+			}
+
 			if (this.getProgrammingModel(parameters?.selectedContexts?.[0] ?? contextsToDelete[0]) === ProgrammingModel.Sticky) {
 				this.setDocumentModified(true);
 			}
-			await this.deleteDocumentTransaction(contextsToDelete, parameters);
-
 			let result;
 
 			// Multiple object deletion is triggered from a list
@@ -534,7 +529,6 @@ class EditFlow extends BaseControllerExtension {
 	): Promise<void> {
 		let oDataListBinding!: ODataListBinding;
 		let parentContext: ODataV4Context | undefined;
-
 		const dataModel = this.getView().getModel();
 		let selectedProperties: string | undefined;
 		if (dataModel && ModelHelper.isCollaborationDraftSupported(dataModel.getMetaModel())) {
@@ -1062,12 +1056,14 @@ class EditFlow extends BaseControllerExtension {
 
 		await Promise.all([creation, this.syncTask(creation)]);
 		if (savedDocumentContext && parameters.skipSideEffects !== true) {
-			this.requestSideEffectsForNavigationProperty(listBinding, savedDocumentContext);
+			this.getAppComponent()
+				.getSideEffectsService()
+				.requestSideEffectsForNavigationProperty(listBinding.getPath(), savedDocumentContext);
 		}
 	}
 
 	/**
-	 * Creates a deferred document.
+	 * Creates a deffered document.
 	 * @param listBinding ODataListBinding where the document has to be created
 	 * @param parentContext Optional parent context when creating a node in TreeTable
 	 * @param data
@@ -1225,14 +1221,18 @@ class EditFlow extends BaseControllerExtension {
 	 */
 	handleSideEffects = async (listBinding: ODataListBinding, creationPromise: Promise<Context>): Promise<void> => {
 		try {
-			const viewBindingContext = this.getView().getBindingContext() as Context;
+			const viewBindingContext = this.getView().getBindingContext();
 			const newContext = await creationPromise;
 			// transient contexts are reliably removed once oNewContext.created() is resolved
 			await newContext.created();
 			// 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
-			this.requestSideEffectsForNavigationProperty(listBinding, viewBindingContext);
+			if (!CommonUtils.hasTransientContext(listBinding) && viewBindingContext) {
+				this.getAppComponent()
+					.getSideEffectsService()
+					.requestSideEffectsForNavigationProperty(listBinding.getPath(), viewBindingContext as Context);
+			}
 		} catch (error: unknown) {
 			Log.error("Error while creating the document", error as string);
 		}
@@ -1460,11 +1460,15 @@ class EditFlow extends BaseControllerExtension {
 			const activeContexts = createdContexts.filter((newContext) => !newContext.isInactive());
 			await Promise.all(activeContexts.map(async (newContext) => newContext.created()));
 
+			const viewBindingContext = this.getView().getBindingContext();
+
 			// 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 (requestSideEffects) {
-				this.requestSideEffectsForNavigationProperty(listBinding, this.base.getView().getBindingContext());
+			if (requestSideEffects && !CommonUtils.hasTransientContext(targetListBinding)) {
+				this.getAppComponent()
+					.getSideEffectsService()
+					.requestSideEffectsForNavigationProperty(targetListBinding.getPath(), viewBindingContext as Context);
 			}
 
 			if (this.base.collaborativeDraft.isConnected() && activeContexts.length > 0) {
@@ -1609,7 +1613,7 @@ class EditFlow extends BaseControllerExtension {
 	 * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
 	 * @param _mParameters Object containing the parameters passed to onAfterSave
 	 * @param _mParameters.context The context we obtained after saving
-	 * @returns A promise to be returned by the overridden method.
+	 * @returns A promise to be returned by the overridden method. If rejected, any further processing by the framework is stopped.
 	 * @public
 	 * @since 1.116.0
 	 */
@@ -1628,7 +1632,7 @@ class EditFlow extends BaseControllerExtension {
 	 * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
 	 * @param _mParameters Object containing the parameters passed to onAfterCreate
 	 * @param _mParameters.context The newly created context
-	 * @returns A promise to be returned by the overridden method.
+	 * @returns A promise to be returned by the overridden method. If rejected, any further processing by the framework is stopped.
 	 * @public
 	 * @since 1.116.0
 	 */
@@ -1647,7 +1651,7 @@ class EditFlow extends BaseControllerExtension {
 	 * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
 	 * @param _mParameters Object containing the parameters passed to onAfterEdit
 	 * @param _mParameters.context Page context that is going to be edited.
-	 * @returns A promise to be returned by the overridden method.
+	 * @returns A promise to be returned by the overridden method. If rejected, any further processing by the framework is stopped.
 	 * @public
 	 * @since 1.116.0
 	 */
@@ -1666,7 +1670,7 @@ class EditFlow extends BaseControllerExtension {
 	 * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
 	 * @param _mParameters Object containing the parameters passed to onAfterDiscard
 	 * @param _mParameters.context The context obtained after discarding the object, or undefined if we discarded a new object
-	 * @returns A promise to be returned by the overridden method.
+	 * @returns A promise to be returned by the overridden method. If rejected, any further processing by the framework is stopped.
 	 * @public
 	 * @since 1.116.0
 	 */
@@ -1685,7 +1689,7 @@ class EditFlow extends BaseControllerExtension {
 	 * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
 	 * @param _mParameters Object containing the parameters passed to onAfterDelete
 	 * @param _mParameters.contexts An array of contexts that are going to be deleted
-	 * @returns A promise to be returned by the overridden method.
+	 * @returns A promise to be returned by the overridden method. If rejected, any further processing by the framework is stopped.
 	 * @public
 	 * @since 1.116.0
 	 */
@@ -2143,12 +2147,16 @@ class EditFlow extends BaseControllerExtension {
 				};
 			}
 
+			const deleted = await this.deleteDocumentTransaction(oContext, mParameters);
+			if (!deleted) {
+				// The delete was canceled by the user
+				return;
+			}
+
 			if (this.getProgrammingModel(oContext) === ProgrammingModel.Sticky) {
 				this.setDocumentModified(true);
 			}
 
-			await this.deleteDocumentTransaction(oContext, mParameters);
-
 			// Single objet deletion is triggered from an OP header button (not from a list)
 			// --> Mark UI dirty and navigate back to dismiss the OP
 			if (!this._isFclEnabled()) {
@@ -2727,15 +2735,15 @@ class EditFlow extends BaseControllerExtension {
 				let forceDisplayMode = false;
 				const isActiveEntity = await context.requestObject("IsActiveEntity");
 
-				if (isCollaborationDraftSupported && isActiveEntity === false) {
+				if (isCollaborationDraftSupported) {
 					forceDisplayMode = !(await this.base.collaborativeDraft.activateCollaboration(context, isActiveEntity));
 				} else {
 					globalModel.setProperty("/hasCollaborationAuthorization", undefined);
 				}
 				this.fetchCollaborativeDraftUsersPromise = undefined;
-
 				if (isActiveEntity === false && !forceDisplayMode) {
-					// in case the document is draft set it in edit mode
+					// in case the document is draft, set it in edit mode
+					// unless we don't have the authorization for a collaborative user
 					this.setEditMode(EditMode.Editable);
 					const hasActiveEntity = await context.requestObject("HasActiveEntity");
 					this.setEditMode(undefined, !hasActiveEntity);
@@ -2784,6 +2792,7 @@ class EditFlow extends BaseControllerExtension {
 	 * @param parameters.lockedContexts
 	 * @param parameters.draftsWithDeletableActive
 	 * @param parameters.draftsWithNonDeletableActive
+	 * @returns Promise resolves once the deletion is completed
 	 */
 	private async deleteDocumentTransaction(
 		contexts: Context | Context[],
@@ -2804,7 +2813,7 @@ class EditFlow extends BaseControllerExtension {
 			draftsWithDeletableActive?: DraftSiblingPair[];
 			draftsWithNonDeletableActive?: Context[];
 		}
-	): Promise<void> {
+	): Promise<boolean> {
 		if (parameters.selectedContexts) {
 			// as selected contexts may include inactive context we need to compute this parameter again to ensure delete helper works properly
 			parameters.numberOfSelectedContexts = parameters.selectedContexts.length;
@@ -2824,7 +2833,7 @@ class EditFlow extends BaseControllerExtension {
 		}
 
 		await this.syncTask();
-		await transactionHelper.deleteDocument(contexts, parameters, this.getAppComponent(), resourceModel, this.getMessageHandler());
+		return transactionHelper.deleteDocument(contexts, parameters, this.getAppComponent(), resourceModel, this.getMessageHandler());
 	}
 
 	_getResourceModel(): ResourceModel {