@sapui5/sap.fe.core 1.101.1 → 1.102.2

package/src/sap/fe/core/{actions → controllerextensions/editFlow}/draft.ts

@@ -1,10 +1,11 @@
 import ResourceBundle from "sap/base/i18n/ResourceBundle";
 import Log from "sap/base/Log";
-import ActivitySync from "sap/fe/core/actions/collaboration/ActivitySync";
-import messageHandling from "sap/fe/core/actions/messageHandling";
 import AppComponent from "sap/fe/core/AppComponent";
 import CommonUtils from "sap/fe/core/CommonUtils";
-import FELibrary from "sap/fe/core/library";
+import ActivitySync from "sap/fe/core/controllerextensions/collaboration/ActivitySync";
+import messageHandling from "sap/fe/core/controllerextensions/messageHandler/messageHandling";
+import DataLossOrDraftDiscardHandler from "sap/fe/core/controls/DataLossOrDraftDiscard/DataLossOrDraftDiscardHandler";
+import EditState from "sap/fe/core/helpers/EditState";
 import { SideEffectsService } from "sap/fe/core/services/SideEffectsServiceFactory";
 import Button from "sap/m/Button";
 import Dialog from "sap/m/Dialog";
@@ -17,7 +18,6 @@ import ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
 import ResourceModel from "sap/ui/model/resource/ResourceModel";
 import { CoreEx } from "types/extension_types";
 
-const ProgrammingModel = FELibrary.ProgrammingModel;
 export type SiblingInformation = {
 	targetContext: Context;
 	pathMapping: { oldPath: string; newPath: string }[];
@@ -79,6 +79,11 @@ const draftOperations = {
 	DISCARD: "DiscardAction",
 	PREPARE: "PreparationAction"
 };
+/* Enum for navigation types */
+enum NavigationType {
+	BackNavigation = "BackNavigation",
+	ForwardNavigation = "ForwardNavigation"
+}
 /**
  * Static functions for the draft programming model
  *
@@ -143,8 +148,14 @@ function executeDraftEditAction(oContext: any, bPreserveChanges: boolean) {
 		const sGroupId = "direct";
 		const localI18nRef = (Core as CoreEx).getLibraryResourceBundle("sap.fe.core");
 		const sActionName = localI18nRef.getText("C_COMMON_OBJECT_PAGE_EDIT");
+		//If the context is coming from a list binding we pass the flag true to replace the context by the active one
 		const oEditPromise = oOperation
-			.execute(sGroupId, undefined, CommonUtils.fnOnStrictHandlingFailed.bind(draft, sGroupId, sActionName, oContext.getModel()))
+			.execute(
+				sGroupId,
+				undefined,
+				CommonUtils.fnOnStrictHandlingFailed.bind(draft, sGroupId, sActionName, oContext.getModel()),
+				oContext.getBinding().isA("sap.ui.model.odata.v4.ODataListBinding")
+			)
 			.then(function (oDraftDocumentContext: any) {
 				return oDraftDocumentContext;
 			});
@@ -181,7 +192,8 @@ function executeDraftActivationAction(oContext: any, oAppComponent: AppComponent
 			.execute(
 				sGroupId,
 				bIgnoreEtag,
-				sGroupId ? CommonUtils.fnOnStrictHandlingFailed.bind(draft, sGroupId, sActionName, oContext.getModel()) : undefined
+				sGroupId ? CommonUtils.fnOnStrictHandlingFailed.bind(draft, sGroupId, sActionName, oContext.getModel()) : undefined,
+				oContext.getBinding().isA("sap.ui.model.odata.v4.ODataListBinding")
 			) //3rd parameter<------
 			.then(function (oActiveDocumentContext: any) {
 				return oActiveDocumentContext;
@@ -274,25 +286,30 @@ function requestMessages(oContext: any, oSideEffectsService: SideEffectsService)
 	return Promise.resolve();
 }
 /**
- * Executes discard of a draft function using HTTP Post.
+ * Executes the discard of a draft function using HTTP POST.
  *
  * @function
  * @param {sap.ui.model.odata.v4.Context} oContext Context for which the action should be performed
+ * @param {boolean} bEnableStrictHandling
  * @returns {Promise.<sap.ui.model.odata.v4.Context>} Resolve function returns the context of the operation
  * @private
  * @ui5-restricted
  */
-function executeDraftDiscardAction(oContext: any): Promise<boolean> {
+function executeDraftDiscardAction(oContext: any, bEnableStrictHandling?: boolean): Promise<boolean> {
 	if (!oContext.getProperty("IsActiveEntity")) {
-		const oDiscardOperation = createOperation(oContext, draftOperations.DISCARD);
+		const oDiscardOperation = draft.createOperation(oContext, draftOperations.DISCARD);
 		const localI18nRef = (Core as CoreEx).getLibraryResourceBundle("sap.fe.core");
 		const sGroupId = "direct";
 		const sActionName = localI18nRef.getText("C_TRANSACTION_HELPER_DRAFT_DISCARD_BUTTON");
-		const oDiscardPromise = oDiscardOperation.execute(
-			sGroupId,
-			undefined,
-			CommonUtils.fnOnStrictHandlingFailed.bind(draft, sGroupId, sActionName, oContext.getModel())
-		);
+		// as the discard action doesnt' send the active version in the response we do not use the replace in cache
+		const oDiscardPromise = !bEnableStrictHandling
+			? oDiscardOperation.execute(sGroupId)
+			: oDiscardOperation.execute(
+					sGroupId,
+					undefined,
+					CommonUtils.fnOnStrictHandlingFailed.bind(draft, sGroupId, sActionName, oContext.getModel()),
+					false
+			  );
 		oContext.getModel().submitBatch(sGroupId);
 		return oDiscardPromise;
 	} else {
@@ -301,11 +318,11 @@ function executeDraftDiscardAction(oContext: any): Promise<boolean> {
 }
 
 /**
- * This methods creates a sibling context for a sub-object page, and calculates a sibling path for
- * all intermediates paths between the OP and the sub-OP.
+ * This method creates a sibling context for a subobject page and calculates a sibling path for all intermediate paths
+ * between the object page and the subobject page.
  *
  * @param {object} rootCurrentContext The context for the root of the draft
- * @param {object} rightmostCurrentContext The context of the sub-object
+ * @param {object} rightmostCurrentContext The context of the subobject page
  * @returns {Promise} returns the siblingInformation object
  */
 async function computeSiblingInformation(
@@ -516,8 +533,9 @@ async function createDraftFromActiveDocument(
 		} catch (oResponse: any) {
 			//Only call back if error 409
 			if (bRunPreserveChangesFlow && oResponse.status === 409) {
+				messageHandling.removeBoundTransitionMessages();
+				messageHandling.removeUnboundTransitionMessages();
 				if (ActivitySync.isCollaborationEnabled(mParameters.oView)) {
-					messageHandling.removeUnboundTransitionMessages();
 					const siblingInfo = await draft.computeSiblingInformation(oContext, oContext);
 					const siblingContext = (mParameters.oView.getController() as any)._routing._createBindingContext(
 						siblingInfo?.targetContext.getPath(),
@@ -531,7 +549,9 @@ async function createDraftFromActiveDocument(
 					);
 				}
 			} else {
-				throw new Error(oResponse);
+				if (!(oResponse && oResponse.canceled)) {
+					throw new Error(oResponse);
+				}
 			}
 		}
 		if (openingSiblingContext) {
@@ -630,11 +650,12 @@ function activateDocument(
  * @memberof sap.fe.core.actions.draft
  * @static
  * @param {sap.ui.model.odata.v4.Context} oContext Context of the document to be discarded
+ * @param {boolean} bEnableStrictHandling
  * @private
  * @returns {Promise}
  * @ui5-restricted
  */
-function deleteDraft(oContext: any): Promise<boolean> {
+function deleteDraft(oContext: any, bEnableStrictHandling?: boolean): Promise<boolean> {
 	const sDiscardAction = getActionName(oContext, draftOperations.DISCARD),
 		bIsActiveEntity = oContext.getObject().IsActiveEntity;
 
@@ -655,15 +676,151 @@ function deleteDraft(oContext: any): Promise<boolean> {
 		}
 	} else {
 		//Use Discard Post Action if it is a draft entity and discard action exists
-		return executeDraftDiscardAction(oContext);
+		return executeDraftDiscardAction(oContext, bEnableStrictHandling);
+	}
+}
+
+/**
+ * @param fnProcessFunction
+ * @param fnCancelFunction
+ * @param oContext
+ * @param oController
+ * @param bSkipBindingToView
+ * @param navigationType
+ */
+function processDataLossOrDraftDiscardConfirmation(
+	fnProcessFunction: any,
+	fnCancelFunction: any,
+	oContext: any,
+	oController: any,
+	bSkipBindingToView?: boolean,
+	navigationType: NavigationType = NavigationType.BackNavigation
+) {
+	const oModel = oContext.getModel();
+	const draftDataContext = oModel.bindContext(oContext.getPath() + "/DraftAdministrativeData").getBoundContext();
+
+	const collaborationConnected = ActivitySync.isConnected(oController.getView());
+	const processFunctionForDrafts = !collaborationConnected
+		? fnProcessFunction
+		: function (...args: any[]) {
+				ActivitySync.disconnect(oController.getView());
+				fnProcessFunction.apply(null, ...args);
+		  };
+
+	if (
+		oContext &&
+		oContext.getObject() &&
+		(!oContext.getObject().DraftAdministrativeData || oContext.getObject().IsActiveEntity === true)
+	) {
+		fnProcessFunction();
+	} else {
+		draftDataContext
+			.requestObject()
+			.then(function (draftAdminData: any) {
+				if (draftAdminData) {
+					if (oController.getAppComponent().getRootViewController().isFclEnabled()) {
+						// 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
+						// for FCL.
+						if (!(draftAdminData.CreationDateTime === draftAdminData.LastChangeDateTime)) {
+							DataLossOrDraftDiscardHandler.performAfterDiscardorKeepDraft(
+								processFunctionForDrafts,
+								fnCancelFunction,
+								oController,
+								bSkipBindingToView
+							);
+						} else {
+							processFunctionForDrafts();
+						}
+					} else {
+						if (!oContext.getObject().HasActiveEntity) {
+							// 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
+							if (EditState.isEditStateDirty()) {
+								// In this case data is being newly created and then we always want to
+								// show the dataloss dialog on navigation
+								DataLossOrDraftDiscardHandler.performAfterDiscardorKeepDraft(
+									processFunctionForDrafts,
+									fnCancelFunction,
+									oController,
+									bSkipBindingToView
+								);
+							} else {
+								// We are editing a draft which has been created earlier but never saved to active
+								// version and since the edit state is not dirty, there have been no user changes
+								// so in this case we want to silently navigate and do nothing
+								processFunctionForDrafts();
+							}
+						} else {
+							// We are editing a draft for an existing active entity
+							if (draftAdminData.CreationDateTime === draftAdminData.LastChangeDateTime) {
+								// 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 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 = {
+										skipDiscardPopover: true
+									};
+									oController.editFlow
+										.cancelDocument(oContext, mParameters)
+										.then(() => {
+											processFunctionForDrafts();
+										})
+										.catch((error: any) => {
+											Log.error("Error while canceling the document", error);
+										});
+								} else {
+									// In case of a forward navigation we silently keep the draft and only
+									// execute the followup function.
+									processFunctionForDrafts();
+								}
+							} else {
+								// 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
+								if (EditState.isEditStateDirty()) {
+									// Changes have been made in the current editing session so we want
+									// to show the dataloss dialog and let the user decide
+									DataLossOrDraftDiscardHandler.performAfterDiscardorKeepDraft(
+										processFunctionForDrafts,
+										fnCancelFunction,
+										oController,
+										bSkipBindingToView
+									);
+								} 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
+									processFunctionForDrafts();
+								}
+							}
+						}
+					}
+				} else {
+					fnProcessFunction();
+				}
+			})
+			.catch(function (oError: any) {
+				Log.error("Cannot retrieve draftDataContext information", oError);
+			});
 	}
 }
+
 const draft = {
 	createDraftFromActiveDocument: createDraftFromActiveDocument,
 	activateDocument: activateDocument,
 	deleteDraft: deleteDraft,
 	executeDraftEditAction: executeDraftEditAction,
-	computeSiblingInformation: computeSiblingInformation
+	computeSiblingInformation: computeSiblingInformation,
+	processDataLossOrDraftDiscardConfirmation: processDataLossOrDraftDiscardConfirmation,
+	createOperation: createOperation,
+	executeDraftDiscardAction: executeDraftDiscardAction,
+	NavigationType: NavigationType
 };
 
 export default draft;