@sapui5/sap.fe.core 1.136.11 → 1.136.13

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

@@ -70,7 +70,7 @@ import type { MetaModelEntityType } from "types/metamodel_types";
 import ActionRuntime from "../ActionRuntime";
 import { ConfirmRecommendationDialog, RecommendationDialogDecision } from "../controls/Recommendations/ConfirmRecommendationDialog";
 import { CreationMode, type BaseManifestSettings } from "../converters/ManifestSettings";
-import { isFulfilled } from "../helpers/TypeGuards";
+import { isFulfilled, isRejected } from "../helpers/TypeGuards";
 import draftDataLossPopup from "./editFlow/draftDataLossPopup";
 import type { OperationResult } from "./editFlow/operations/ODataOperation";
 import NavigationReason from "./routing/NavigationReason";
@@ -103,6 +103,7 @@ type InternalCreateParameters = {
 	skipSideEffects?: boolean;
 	selectedContexts?: ODataV4Context[];
 	creationDialogFields?: string[];
+	requestAtLeast?: string[];
 };
 
 /**
@@ -298,14 +299,24 @@ class EditFlow extends BaseControllerExtension {
 		ignoreTransientContexts = false
 	): boolean {
 		if (parentContext) {
-			const listBindingRelativePath = ModelHelper.getRelativeMetaPathForListBinding(parentContext, listBinding);
-			if ((ignoreTransientContexts || !CommonUtils.hasTransientContext(listBinding)) && listBindingRelativePath) {
+			const listBindingRelativePathToPage = ModelHelper.getRelativeMetaPathForListBinding(parentContext, listBinding);
+			const listBindingRelativePath = ModelHelper.getRelativeMetaPathForListBinding(listBinding.getContext(), listBinding);
+			if (ignoreTransientContexts || !CommonUtils.hasTransientContext(listBinding)) {
 				// if there are transient contexts (and we don't ignore this check), 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);
+				if (listBindingRelativePath) {
+					this.getAppComponent()
+						.getSideEffectsService()
+						.requestSideEffectsForNavigationProperty(listBindingRelativePath, listBinding.getContext());
+				}
+				// if we are triggering side effects for a multivaluefield within a table, listBindingRelativePathToPage is different to listBindingRelativePath
+				// so we also ensure page side effects are triggered if need be
+				if (listBindingRelativePathToPage && listBindingRelativePathToPage !== listBindingRelativePath) {
+					this.getAppComponent()
+						.getSideEffectsService()
+						.requestSideEffectsForNavigationProperty(listBindingRelativePathToPage, parentContext);
+				}
 
 				return true;
 			}
@@ -525,6 +536,7 @@ class EditFlow extends BaseControllerExtension {
 	 * @param mInParameters.selectedContexts The contexts that are selected in the table initiating the creation. Used in case of a TreeTable to determine the parent context of the created document
 	 * @param mInParameters.singleDraftForCreate When enabled, an extra request checks if any drafts exist that were never saved. If unsaved drafts are found, the newest one is opened. If no unsaved drafts are found, a new entity is created
 	 * @param mInParameters.creationDialogFields Defines the list of properties that are displayed in the creation dialog when the creation mode is set to 'CreationDialog'.<br/>The value is a comma-separated list of property names
+	 * @param mInParameters.requestAtLeast PRIVATE - Defines the list of properties that should be requested when creating the new document to avoid additional requests later on.<br/>The value is an array of property names
 	 * @returns Promise resolves once the object has been created
 	 * @public
 	 * @since 1.90.0
@@ -549,6 +561,7 @@ class EditFlow extends BaseControllerExtension {
 			selectedContexts?: ODataV4Context[];
 			singleDraftForCreate?: boolean;
 			creationDialogFields?: string[];
+			requestAtLeast?: string[];
 		}
 	): Promise<void> {
 		let oDataListBinding!: ODataListBinding;
@@ -657,13 +670,17 @@ class EditFlow extends BaseControllerExtension {
 			case CreationMode.External:
 				return this.createExternalDocument(vListBinding, parameters.outbound);
 			case CreationMode.Deferred:
-				return this.createDeferredDocument(oDataListBinding, parentContext, parameters.data);
+				return this.createDeferredDocument(
+					{ parentContext, data: parameters.data, requestAtLeast: parameters.requestAtLeast },
+					oDataListBinding
+				);
 			case CreationMode.CreationRow:
 				return parameters.creationRow
 					? this.createCreateRowDocument({
 							creationRow: parameters.creationRow,
 							skipSideEffects: parameters.skipSideEffects,
-							createAtEnd: parameters.createAtEnd
+							createAtEnd: parameters.createAtEnd,
+							requestAtLeast: parameters.requestAtLeast
 					  })
 					: undefined;
 			case CreationMode.Inline:
@@ -674,7 +691,8 @@ class EditFlow extends BaseControllerExtension {
 						createAtEnd: parameters.createAtEnd,
 						skipSideEffects: parameters.skipSideEffects,
 						parentContext,
-						data: parameters.data
+						data: parameters.data,
+						requestAtLeast: parameters.requestAtLeast
 					},
 					oDataListBinding
 				);
@@ -690,7 +708,8 @@ class EditFlow extends BaseControllerExtension {
 							skipSideEffects: parameters.skipSideEffects,
 							parentContext,
 							data: parameters.data,
-							creationDialogFields: parameters.creationDialogFields
+							creationDialogFields: parameters.creationDialogFields,
+							requestAtLeast: parameters.requestAtLeast
 						},
 						oDataListBinding
 					);
@@ -718,6 +737,7 @@ class EditFlow extends BaseControllerExtension {
 						bFromDeferred: parameters.bFromDeferred,
 						skipSideEffects: parameters.skipSideEffects,
 						createAction: parameters.createAction,
+						requestAtLeast: parameters.requestAtLeast,
 						parentContext
 					},
 					oDataListBinding
@@ -728,16 +748,30 @@ class EditFlow extends BaseControllerExtension {
 	}
 
 	/**
-	 *Executes the mandatory configuration after the document has been created.
+	 * Executes the mandatory configuration after the document has been created.
 	 * @param prerequisite Promise of the document creation and the following navigation
 	 * @param listBinding ODataListBinding where the document is created
 	 * @returns Promise resolves once the configuration is done
 	 */
-	async postDocumentCreation(prerequisite: Promise<[Context, unknown]>, listBinding: ODataListBinding): Promise<void> {
+	async postDocumentCreation(
+		prerequisite: Promise<[PromiseSettledResult<Context>, PromiseSettledResult<unknown>]>,
+		listBinding: ODataListBinding
+	): Promise<void> {
 		const programmingModel: string = this.getProgrammingModel(listBinding);
 		const model = listBinding.getModel();
-		const params = await prerequisite;
-		const newDocumentContext = params[0];
+		const results = await prerequisite;
+
+		// Check if creation or navigation failed and throw the respective error
+		const creation = results[0];
+		if (isRejected(creation)) {
+			throw creation.reason;
+		}
+		const navigation = results[1];
+		if (isRejected(navigation)) {
+			throw navigation.reason;
+		}
+
+		const newDocumentContext = creation.value;
 		this._setStickySessionInternalProperties(programmingModel, model);
 		await this.base.editFlow.onAfterCreate({ context: newDocumentContext });
 		this.setEditMode(EditMode.Editable); // The createMode flag will be set in computeModelsForEditMode
@@ -785,12 +819,14 @@ class EditFlow extends BaseControllerExtension {
 	 * @param parameters.createAtEnd The new document is created at the end.
 	 * @param parameters.creationRow The creation row
 	 * @param parameters.skipSideEffects The sideEffects are requested
+	 * @param parameters.requestAtLeast Defines the list of properties that should be requested when creating the new document to avoid additional requests later on.
 	 * @returns Promise resolves once the document has been created
 	 */
 	async createCreateRowDocument(parameters: {
 		createAtEnd?: boolean;
 		creationRow: CreationRow;
 		skipSideEffects?: boolean;
+		requestAtLeast?: string[];
 	}): Promise<void> {
 		let creation: Promise<Context>;
 		const appComponent = this.getAppComponent();
@@ -855,7 +891,8 @@ class EditFlow extends BaseControllerExtension {
 					beforeCreateCallBack: this.base.editFlow.onBeforeCreate,
 					skipParameterDialog: appComponent.getStartupMode() === StartupMode.AutoCreate, // In case the application was called with preferredMode=autoCreateWith, we want to skip the action parameter dialog
 					createAtEnd: parameters.createAtEnd,
-					creationMode: CreationMode.CreationRow
+					creationMode: CreationMode.CreationRow,
+					requestAtLeast: parameters.requestAtLeast
 				},
 				appComponent,
 				this._getResourceModel(),
@@ -878,7 +915,7 @@ class EditFlow extends BaseControllerExtension {
 				Log.trace("transient fast creation context deleted");
 			});
 			navigation = creationRowContext.delete("$direct");
-			return await this.postDocumentCreation(Promise.all([creation, navigation]), listBinding);
+			return await this.postDocumentCreation(Promise.allSettled([creation, navigation]), listBinding);
 		} catch (error: unknown) {
 			// Reset busy indicator after a validation error
 			if (BusyLocker.isLocked(this.base.getView().getModel("ui"))) {
@@ -898,6 +935,7 @@ class EditFlow extends BaseControllerExtension {
 	 * @param parameters.parentContext Parent context (for TreeTable)
 	 * @param parameters.data Intial data for creation
 	 * @param parameters.creationDialogFields Fields to be displayed in the creation dialog
+	 * @param parameters.requestAtLeast Defines the list of properties that should be requested when creating the new document to avoid additional requests later on.
 	 * @param listBinding ODataListBinding where the document is created
 	 * @returns Promise resolves once the document has been created
 	 */
@@ -910,6 +948,7 @@ class EditFlow extends BaseControllerExtension {
 			parentContext?: ODataV4Context;
 			data?: object;
 			creationDialogFields?: string[];
+			requestAtLeast?: string[];
 		},
 		listBinding: ODataListBinding
 	): Promise<void> {
@@ -965,7 +1004,8 @@ class EditFlow extends BaseControllerExtension {
 				creationMode: parameters.creationMode,
 				parentContext: parameters.parentContext,
 				data: parameters.data as Record<string, unknown>,
-				creationDialogFields: parameters.creationDialogFields
+				creationDialogFields: parameters.creationDialogFields,
+				requestAtLeast: parameters.requestAtLeast
 			},
 			this.getAppComponent(),
 			this._getResourceModel(),
@@ -976,7 +1016,7 @@ class EditFlow extends BaseControllerExtension {
 		if (!parameters.skipSideEffects) {
 			this.handleSideEffects(listBinding, creation);
 		}
-		return this.postDocumentCreation(Promise.all([creation, this.syncTask(creation)]), listBinding);
+		return this.postDocumentCreation(Promise.allSettled([creation, this.syncTask(creation)]), listBinding);
 	}
 
 	/**
@@ -1093,16 +1133,27 @@ class EditFlow extends BaseControllerExtension {
 
 	/**
 	 * Creates a deferred document.
+	 * @param parameters Contains the following attributes:
+	 * @param parameters.data  Data to save on the new document
+	 * @param parameters.parentContext
+	 * @param parameters.requestAtLeast Defines the list of properties that should be requested when creating the new document to avoid additional requests later on.
 	 * @param listBinding ODataListBinding where the document has to be created
-	 * @param parentContext Optional parent context when creating a node in TreeTable
-	 * @param data
 	 * @returns Promise resolves once the navigation is done
 	 */
-	async createDeferredDocument(listBinding: ODataListBinding, parentContext?: ODataV4Context, data?: object): Promise<void> {
+	async createDeferredDocument(
+		parameters: { data?: object; parentContext?: ODataV4Context; requestAtLeast?: string[] },
+		listBinding: ODataListBinding
+	): Promise<void> {
 		const lockObject = this.getGlobalUIModel();
 		BusyLocker.lock(lockObject);
 		await this.getInternalRouting().navigateForwardToContext(listBinding, {
-			createOnNavigateParameters: { mode: "Deferred", parentContext, listBinding, data },
+			createOnNavigateParameters: {
+				mode: "Deferred",
+				parentContext: parameters.parentContext,
+				listBinding,
+				data: parameters.data,
+				requestAtLeast: parameters.requestAtLeast
+			},
 			editable: true,
 			forceFocus: true
 		});
@@ -1118,6 +1169,7 @@ class EditFlow extends BaseControllerExtension {
 	 * @param parameters.data  Data to save on the new document
 	 * @param parameters.skipSideEffects The sideEffects are requested
 	 * @param parameters.parentContext
+	 * @param parameters.requestAtLeast Defines the list of properties that should be requested when creating the new document to avoid additional requests later on.
 	 * @param listBinding ODataListBinding where the document is created
 	 * @returns Promise resolves once the document has been created
 	 */
@@ -1129,6 +1181,7 @@ class EditFlow extends BaseControllerExtension {
 			data?: Record<string, unknown>;
 			skipSideEffects?: boolean;
 			parentContext?: ODataV4Context;
+			requestAtLeast?: string[];
 		},
 		listBinding: ODataListBinding
 	): Promise<void> {
@@ -1145,7 +1198,8 @@ class EditFlow extends BaseControllerExtension {
 					...{
 						parentControl: this.getView(),
 						beforeCreateCallBack: this.base.editFlow.onBeforeCreate,
-						skipParameterDialog: this.getAppComponent().getStartupMode() === StartupMode.AutoCreate // In case the application was called with preferredMode=autoCreateWith, we want to skip the action parameter dialog
+						skipParameterDialog: this.getAppComponent().getStartupMode() === StartupMode.AutoCreate, // In case the application was called with preferredMode=autoCreateWith, we want to skip the action parameter dialog
+						requestAtLeast: this._isFclEnabled() ? parameters.requestAtLeast : undefined // For fullscreen, we don't need to request extra properties as the table will be refreshed when navigating back with the DirtyState
 					}
 				},
 				this.getAppComponent(),
@@ -1176,31 +1230,47 @@ class EditFlow extends BaseControllerExtension {
 				forceFocus: true
 			});
 		} else {
-			navigation = creation.then(async (newDocumentContext) => {
-				if (!newDocumentContext) {
-					const coreResourceBundle = Library.getResourceBundleFor("sap.fe.core")!;
+			const coreResourceBundle = Library.getResourceBundleFor("sap.fe.core")!;
+			navigation = creation
+				.then(async (newDocumentContext) => {
+					if (!newDocumentContext) {
+						return routingListener.navigateToMessagePage(coreResourceBundle.getText("C_COMMON_SAPFE_DATA_RECEIVED_ERROR"), {
+							title: coreResourceBundle.getText("C_COMMON_SAPFE_ERROR"),
+							description: coreResourceBundle.getText("C_EDITFLOW_SAPFE_CREATION_FAILED_DESCRIPTION")
+						});
+					} else {
+						// In case the Sync creation was triggered for a deferred creation, we don't navigate forward
+						// as we're already on the corresponding ObjectPage
+						const navParameters: RoutingNavigationParameters = {
+							editable: true,
+							forceFocus: true,
+							transient:
+								this.getProgrammingModel(listBinding) == ProgrammingModel.Sticky || parameters.createAction
+									? true
+									: undefined
+						};
+
+						return parameters.bFromDeferred
+							? routingListener.navigateToContext(newDocumentContext, navParameters)
+							: routingListener.navigateForwardToContext(newDocumentContext, navParameters);
+					}
+				})
+				.catch(async (error: unknown) => {
+					if (typeof error === "string" && error === Constants.CancelActionDialog) {
+						// Creation has been cancelled by the user => no error message page
+						throw error;
+					}
+					Log.error("Creation error: ", error as string);
+					// Navigate to error message page in case of an error during creation or navigation
 					return routingListener.navigateToMessagePage(coreResourceBundle.getText("C_COMMON_SAPFE_DATA_RECEIVED_ERROR"), {
 						title: coreResourceBundle.getText("C_COMMON_SAPFE_ERROR"),
-						description: coreResourceBundle.getText("C_EDITFLOW_SAPFE_CREATION_FAILED_DESCRIPTION")
+						description: coreResourceBundle.getText("C_EDITFLOW_SAPFE_CREATION_FAILED_DESCRIPTION"),
+						showMessagePageOnCreateFailure: true
 					});
-				} else {
-					// In case the Sync creation was triggered for a deferred creation, we don't navigate forward
-					// as we're already on the corresponding ObjectPage
-					const navParameters: RoutingNavigationParameters = {
-						editable: true,
-						forceFocus: true,
-						transient:
-							this.getProgrammingModel(listBinding) == ProgrammingModel.Sticky || parameters.createAction ? true : undefined
-					};
-
-					return parameters.bFromDeferred
-						? routingListener.navigateToContext(newDocumentContext, navParameters)
-						: routingListener.navigateForwardToContext(newDocumentContext, navParameters);
-				}
-			});
+				});
 		}
 		try {
-			await this.postDocumentCreation(Promise.all([creation, navigation]), listBinding);
+			await this.postDocumentCreation(Promise.allSettled([creation, navigation]), listBinding);
 		} catch (error: unknown) {
 			// TODO: currently, the only errors handled here are raised as string - should be changed to Error objects
 			// creation has been cancelled by user or failed in backend => in case we have navigated to transient context before, navigate back