@sapui5/sap.fe.templates 1.148.3 → 1.150.0

package/src/sap/fe/templates/ObjectPage/ObjectPageController.controller.ts

@@ -30,15 +30,17 @@ import type { InternalModelContext } from "sap/fe/core/helpers/ModelHelper";
 import ModelHelper from "sap/fe/core/helpers/ModelHelper";
 import FELibrary from "sap/fe/core/library";
 import { type WrappedCard } from "sap/fe/core/services/CollaborationManagerServiceFactory";
+import type { TelemetryVariantEvent } from "sap/fe/core/services/TelemetryServiceFactory";
 import type ChartBlock from "sap/fe/macros/Chart";
 import CommonHelper from "sap/fe/macros/CommonHelper";
+import type FormBlock from "sap/fe/macros/Form";
 import type MacroAPI from "sap/fe/macros/MacroAPI";
 import type MultiValueFieldBlock from "sap/fe/macros/MultiValueField";
 import type TableAPI from "sap/fe/macros/Table";
+import VariantManagementBB from "sap/fe/macros/VariantManagement";
 import type EasyFillButton from "sap/fe/macros/ai/EasyFillButton";
 import type SummarizationButton from "sap/fe/macros/ai/SummarizationButton";
 import type SubSection from "sap/fe/macros/controls/section/SubSection";
-import type FormAPI from "sap/fe/macros/form/FormAPI";
 import type MessageButton from "sap/fe/macros/messages/MessageButton";
 import type ShareAPI from "sap/fe/macros/share/ShareAPI";
 import type TableCreationOptions from "sap/fe/macros/table/TableCreationOptions";
@@ -100,7 +102,7 @@ import MessageHandlerOverride from "./overrides/MessageHandler";
 import PaginatorOverride from "./overrides/Paginator";
 import ShareOverrides from "./overrides/Share";
 import ViewStateOverrides from "./overrides/ViewState";
-
+const { VariantType } = VariantManagementBB;
 export type BindingParams = {
 	redirectedToNonDraft?: string | undefined;
 	reason?: NavigationReason;
@@ -656,6 +658,10 @@ class ObjectPageController extends PageController {
 					// SubSection's contents binding is disabled.
 					blocks.forEach((block) => {
 						if (block.isA<SubSectionBlock>("sap.fe.templates.ObjectPage.controls.SubSectionBlock")) {
+							// Set binding context to null on both the block and its content
+							// to support both: subsections with UI.Hidden annotation (content needs to be cleared)
+							// and customer controller extensions that set binding context on the block level
+							block.setBindingContext(undefined);
 							block.content.setBindingContext?.(null);
 						} else {
 							block.setBindingContext(null);
@@ -671,7 +677,7 @@ class ObjectPageController extends PageController {
 	_getFirstEmptyMandatoryFieldFromSubSection(aSubSections: ObjectPageSubSection[]): InputBase | undefined {
 		if (aSubSections.length === 0) return undefined;
 		for (const subSection of aSubSections) {
-			const aBlocks = subSection.getBlocks() as (Form | FormAPI)[];
+			const aBlocks = subSection.getBlocks() as (Form | FormBlock)[];
 
 			if (aBlocks) {
 				for (const blockControl of aBlocks) {
@@ -682,8 +688,8 @@ class ObjectPageController extends PageController {
 							aFormContainers = blockControl.getFormContainers();
 						} else if (blockControl.getContent && blockControl.getContent()?.isA<Form>("sap.ui.layout.form.Form")) {
 							aFormContainers = (blockControl.getContent() as Form).getFormContainers();
-						} else if (blockControl?.getContent?.()?.isA<FormAPI>("sap.fe.macros.form.FormAPI")) {
-							aFormContainers = ((blockControl.getContent() as FormAPI).getContent() as Form).getFormContainers();
+						} else if (blockControl?.getContent?.()?.isA<FormBlock>("sap.fe.macros.Form")) {
+							aFormContainers = ((blockControl.getContent() as FormBlock).getContent() as Form).getFormContainers();
 						}
 						if (aFormContainers) {
 							for (const formContainer of aFormContainers) {
@@ -822,6 +828,10 @@ class ObjectPageController extends PageController {
 		const blocks = oSubSection.getBlocks();
 		blocks.forEach((block) => {
 			if (block.isA<SubSectionBlock>("sap.fe.templates.ObjectPage.controls.SubSectionBlock")) {
+				// Set binding context to undefined on both the block and its content
+				// to support both: subsections with UI.Hidden annotation (content needs to be cleared)
+				// and customer controller extensions that set binding context on the block level
+				block.setBindingContext(undefined);
 				block.content.setBindingContext?.(undefined);
 			} else {
 				block.setBindingContext(undefined);
@@ -831,59 +841,6 @@ class ObjectPageController extends PageController {
 		oSubSection.getActions().forEach((actions) => actions.setBindingContext(undefined));
 	}
 
-	_onBackNavigationInDraft(oContext: ODataV4Context): void {
-		this.messageHandler.removeTransitionMessages();
-
-		// Function to navigate back, or display the launchpad if we're on the first page of the history
-		const navBack = (): void => {
-			// Use the new Navigation API if it's available in the browser, to check if we can go back in history.
-			const canGoBack = (window as { navigation?: { canGoBack?: boolean } }).navigation?.canGoBack;
-			if (canGoBack === true) {
-				history.back();
-			} else if (canGoBack === false) {
-				this._routing.navigateBackFromContext(oContext);
-			} else {
-				// Fallback in case the browser doesn't support the Navigation API
-				const currentURL = document.URL;
-				history.back();
-				// In case there is no previous page in the history, history.back does nothing.
-				// In this case, we need to use navigateBackFromContext, that will display the home page
-				setTimeout(() => {
-					if (document.URL === currentURL) {
-						this._routing.navigateBackFromContext(oContext);
-					}
-				}, 500);
-			}
-		};
-
-		if (this.getAppComponent().getRouterProxy().checkIfBackHasSameContext()) {
-			// Back nav will keep the same context --> no need to display the dialog
-			history.back();
-		} else if (!this.getView().getBindingContext()) {
-			// This object page doesn't have a binding context, but still handles the shell back navigation --> pform the nav back and remove the navback handler as it makes no sense any longer
-			this.getAppComponent()
-				.getShellServices()
-				.setBackNavigation(undefined)
-				.then(navBack)
-				.catch((e) => {
-					Log.warning("Error while setting back navigation", e);
-				});
-		} else {
-			const hiddenDraftEnabled = (this.getAppComponent()?.getEnvironmentCapabilities()?.getCapabilities()?.HiddenDraft as HiddenDraft)
-				?.enabled;
-			draft.processDataLossOrDraftDiscardConfirmation(
-				navBack,
-				Function.prototype,
-				oContext,
-				this,
-				true,
-				draft.NavigationType.BackNavigation,
-				undefined,
-				hiddenDraftEnabled ? true : undefined
-			);
-		}
-	}
-
 	// eslint-disable-next-line @typescript-eslint/no-unused-vars
 	_onAfterBinding(inputBindingContext: ODataV4Context | undefined, mParameters: BindingParams | undefined): void {
 		const view = this.getView();
@@ -1081,6 +1038,13 @@ class ObjectPageController extends PageController {
 				if (!targetControlId) {
 					return;
 				}
+				// Reset stale flag so ViewState.apply() is not blocked when the OP is re-activated
+				// via shell keep-alive (cross-app re-entry) without _onBeforeBinding firing.
+				// Intentional ordering: reset to false here before pollForSectionStability (below) sets it back
+				// to true, so any concurrent ViewState.apply() triggered on re-entry is unblocked immediately.
+				if (xAppStateTargetControlId) {
+					this.skipViewStateSectionRestore = false;
+				}
 
 				// Wait for visibility bindings  (needed for lazy loading scenarios)
 				try {
@@ -1130,22 +1094,22 @@ class ObjectPageController extends PageController {
 			return;
 		}
 
-		// Poll to detect UX rules reset only on new entity binding.
-		// _adjustSelectedSectionByUXRules() only runs when ObjectPageLayout re-initializes with a new entity.
-		if (this.isNewBindingContext) {
-			pollForSectionStability({
-				getSelectedSection: () => oObjectPage.getSelectedSection(),
-				targetSectionId,
-				onResetDetected: navigateToTarget
+		// Poll to detect UX rules reset. The guard on isNewBindingContext was removed because
+		// _adjustSelectedSectionByUXRules() can also reset the section on cross-app re-entry to
+		// the same entity (shell keep-alive). Polling is lightweight (max 10 × 50 ms) and safe to
+		// run unconditionally whenever we need to hold a target section.
+		pollForSectionStability({
+			getSelectedSection: () => oObjectPage.getSelectedSection(),
+			targetSectionId,
+			onResetDetected: navigateToTarget
+		})
+			.then(() => {
+				this.skipViewStateSectionRestore = true;
+				return; // Required by linter rule promise/always-return
 			})
-				.then(() => {
-					this.skipViewStateSectionRestore = true;
-					return; // Required by linter rule promise/always-return
-				})
-				.catch(() => {
-					// Required by linter rule promise/catch-or-return - polling failures are non-critical
-				});
-		}
+			.catch(() => {
+				// Required by linter rule promise/catch-or-return - polling failures are non-critical
+			});
 	}
 
 	/**
@@ -1163,9 +1127,48 @@ class ObjectPageController extends PageController {
 	}
 
 	/**
-	 * Performs navigation to the target section and then updates the app state.
-	 * @param targetControlId The local ID of the target section or subsection.
+	 * Tracks telemetry when a new variant is saved.
+	 * @param event The save event.
+	 */
+	private async trackVariantSavedTelemetry(event: UI5Event<Record<string, unknown>>): Promise<void> {
+		if (event.getParameter("overwrite")) {
+			return;
+		}
+		if (!event.getSource().isA("sap.fe.macros.Table")) {
+			return;
+		}
+		if (!(await this.getAppComponent()?.getTelemetryService()?.isEnabled())) {
+			return;
+		}
+		const tableAPI = event.getSource() as unknown as TableAPI;
+		this.fireTelemetry(tableAPI?.getContent?.()?.getVariant?.()?.getVariants?.()?.length ?? 0, VariantType.OBJECT_PAGE_TABLE);
+	}
+
+	/**
+	 * Tracks telemetry when variants are managed (e.g. deleted).
+	 * @param event The manage event.
 	 */
+	private async trackVariantManagedTelemetry(event: UI5Event<Record<string, unknown>>): Promise<void> {
+		const deletedCount: number = ((event.getParameter("deleted") as string[] | undefined) ?? []).length;
+		if (deletedCount === 0) {
+			return;
+		}
+		if (!(await this.getAppComponent()?.getTelemetryService()?.isEnabled())) {
+			return;
+		}
+		this.fireTelemetry(deletedCount, VariantType.OBJECT_PAGE_TABLE);
+	}
+
+	/**
+	 * Stores a FE.Variant telemetry event.
+	 * @param countVariants Number of variants affected by the action.
+	 * @param variantType The variant type discriminator.
+	 */
+	private fireTelemetry(countVariants: number, variantType: TelemetryVariantEvent["parameters"]["variantType"]): void {
+		const telemetryEvent: TelemetryVariantEvent = { type: "FE.Variant", parameters: { countVariants, variantType } };
+		this.getAppComponent()?.getTelemetryService()?.storeAction(telemetryEvent);
+	}
+
 	private navigateWithConfirmation(targetControlId: string): void {
 		// Set targetSubSection BEFORE navigation for app state saving.
 		// scrollToSection() doesn't fire the navigate event, so onNavigateChange won't be called.
@@ -1321,12 +1324,13 @@ class ObjectPageController extends PageController {
 		const oView = this.getView();
 		const oInternalModelContext = oView.getBindingContext("internal") as InternalModelContext;
 		const oBindingContext = oView.getBindingContext();
-		//Show popup while navigating back from object page in case of draft
+		// Show popup while navigating back from object page in case of draft (incl. hidden draft).
+		// Sticky's shell back is registered centrally from EditFlow.registerEditLifecycleCallbacks.
 		if (oBindingContext) {
-			const bIsStickyMode = ModelHelper.isStickySessionSupported(oBindingContext.getModel().getMetaModel());
-			if (!bIsStickyMode) {
+			const isDraftSupported = ModelHelper.isDraftSupported(oBindingContext.getModel().getMetaModel(), oBindingContext.getPath());
+			if (isDraftSupported) {
 				const oAppComponent = CommonUtils.getAppComponent(oView);
-				await oAppComponent.getShellServices().setBackNavigation(() => this._onBackNavigationInDraft(oBindingContext));
+				await oAppComponent.getShellServices().setBackNavigation(() => this.editFlow.onBackNavigationInDraft(oBindingContext));
 			}
 		}
 		// do not request recommendations action if we are in Display mode
@@ -2445,11 +2449,15 @@ class ObjectPageController extends PageController {
 		onVariantSelected: function (this: ObjectPageController): void {
 			this.getExtensionAPI().updateAppState();
 		},
-		onVariantSaved: function (this: ObjectPageController): void {
+		onVariantSaved: function (this: ObjectPageController, event: UI5Event<Record<string, unknown>>): void {
 			//TODO: Should remove this setTimeOut once Variant Management provides an api to fetch the current variant key on save
 			setTimeout(() => {
 				this.getExtensionAPI().updateAppState();
 			}, 2000);
+			this.trackVariantSavedTelemetry(event);
+		},
+		onVariantManaged: function (this: ObjectPageController, event: UI5Event<Record<string, unknown>>): void {
+			this.trackVariantManagedTelemetry(event);
 		},
 		navigateToSubSection: function (oController: ObjectPageController, vDetailConfig: string | object): void {
 			const oDetailConfig = typeof vDetailConfig === "string" ? JSON.parse(vDetailConfig) : vDetailConfig;