@sapui5/sap.fe.core 1.102.3 → 1.102.5

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

@@ -1,19 +1,19 @@
 import Log from "sap/base/Log";
-import AppComponent from "sap/fe/core/AppComponent";
+import type AppComponent from "sap/fe/core/AppComponent";
+import DataQueryWatcher from "sap/fe/core/controllerextensions/pageReady/DataQueryWatcher";
 import TemplatedViewServiceFactory from "sap/fe/core/services/TemplatedViewServiceFactory";
-import Event from "sap/ui/base/Event";
+import type Event from "sap/ui/base/Event";
 import EventProvider from "sap/ui/base/EventProvider";
-import ManagedObject from "sap/ui/base/ManagedObject";
+import type ManagedObject from "sap/ui/base/ManagedObject";
 import Component from "sap/ui/core/Component";
 import Core from "sap/ui/core/Core";
 import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
 import OverrideExecution from "sap/ui/core/mvc/OverrideExecution";
-import View from "sap/ui/core/mvc/View";
-import Context from "sap/ui/model/Context";
-import { CoreEx } from "types/extension_types";
+import type View from "sap/ui/core/mvc/View";
+import type Context from "sap/ui/model/odata/v4/Context";
+import type { CoreEx } from "types/extension_types";
 import CommonUtils from "../CommonUtils";
 import { defineUI5Class, extensible, finalExtension, methodOverride, privateExtension, publicExtension } from "../helpers/ClassSupport";
-
 @defineUI5Class("sap.fe.core.controllerextensions.PageReady")
 class PageReadyControllerExtension extends ControllerExtension {
 	private _oEventProvider!: EventProvider;
@@ -24,19 +24,17 @@ class PageReadyControllerExtension extends ControllerExtension {
 	private _bAfterBindingAlreadyApplied!: boolean;
 	private _fnContainerDelegate: any;
 	private _nbWaits!: number;
-	private _bSeachTriggered!: boolean;
 	private _bIsPageReady!: boolean;
 	private _bWaitingForRefresh!: boolean;
 	private bShown!: boolean;
 	private bHasContext!: boolean;
-	private bDataReceived: boolean | undefined;
-	private bTablesLoaded: boolean | undefined;
+	private bTablesChartsLoaded?: boolean;
 	private pageReadyTimer: NodeJS.Timeout | undefined;
+	private queryWatcher!: DataQueryWatcher;
 
 	@methodOverride()
 	public onInit() {
 		this._nbWaits = 0;
-		this._bSeachTriggered = false;
 		this._oEventProvider = this._oEventProvider ? this._oEventProvider : new EventProvider();
 		this._oView = (this as any).base.getView();
 		this._oAppComponent = CommonUtils.getAppComponent(this._oView);
@@ -68,6 +66,8 @@ class PageReadyControllerExtension extends ControllerExtension {
 				this
 			);
 		}
+
+		this.queryWatcher = new DataQueryWatcher(this._oEventProvider, this.checkPageReadyDebounced.bind(this));
 	}
 
 	@methodOverride()
@@ -75,7 +75,9 @@ class PageReadyControllerExtension extends ControllerExtension {
 		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
 		// @ts-ignore
 		delete this._oAppComponent;
-		this._oContainer && this._oContainer.removeEventDelegate(this._fnContainerDelegate);
+		if (this._oContainer) {
+			this._oContainer.removeEventDelegate(this._fnContainerDelegate);
+		}
 	}
 
 	@publicExtension()
@@ -99,162 +101,78 @@ class PageReadyControllerExtension extends ControllerExtension {
 		this.checkPageReadyDebounced();
 	}
 
-	@methodOverride("_routing")
-	onAfterBinding(oBindingContext: Context) {
-		if (!this._bAfterBindingAlreadyApplied) {
-			this._bAfterBindingAlreadyApplied = true;
-			let aBoundElements: any[] = [];
-			const aNotBoundMDCTables: any[] = [];
-			let iRequested = 0;
-			let iReceived = 0;
-			const fnRequested = (oEvent: Event) => {
-				(oEvent.getSource() as any).detachDataRequested(fnRequested);
-				iRequested++;
-				this.bDataReceived = false;
-			};
-			const fnReceived = (oEvent: Event) => {
-				switch ((oEvent.getSource() as any).sGroupId) {
-					case "$auto.Workers":
-						this._oEventProvider.fireEvent("workersBatchReceived");
-						break;
-					case "$auto.Heroes":
-						this._oEventProvider.fireEvent("heroesBatchReceived");
-						break;
-					default:
-				}
-				(oEvent.getSource() as any).detachDataReceived(fnReceived);
-				iReceived++;
-				if (iReceived >= iRequested && iRequested !== 0) {
-					iRequested = 0;
-					iReceived = 0;
-					this.bDataReceived = true;
-					this.checkPageReadyDebounced();
-				}
-			};
-			const fnSearch = (oEvent: Event) => {
-				const aMDCTables = aNotBoundMDCTables.filter((oElem) => {
-					if ((oEvent.getSource() as any).sId === oElem.getFilter() && oElem.getVisible()) {
-						return true;
-					}
-					return false;
-				});
-				if (aMDCTables.length > 0) {
-					this._bSeachTriggered = true;
-				}
-				aMDCTables.forEach((oMDCTable: any) => {
-					let oRowBinding = oMDCTable.getRowBinding();
-					const fnAttachDataEvents = () => {
-						oRowBinding.attachDataRequested(fnRequested);
-						oRowBinding.attachDataReceived((oEvent: any) => {
-							fnReceived(oEvent);
-							this._bSeachTriggered = false;
-						});
-						aBoundElements.push(oRowBinding);
-					};
-					if (oRowBinding) {
-						fnAttachDataEvents();
-					} else {
-						oMDCTable.attachEventOnce(
-							"bindingUpdated",
-							null,
-							() => {
-								oRowBinding = oMDCTable.getRowBinding();
-								fnAttachDataEvents();
-							},
-							null
-						);
+	public registerAggregatedControls(mainBindingContext?: Context): Promise<void>[] {
+		if (mainBindingContext) {
+			const mainObjectBinding = mainBindingContext.getBinding();
+			this.queryWatcher.registerBinding(mainObjectBinding);
+		}
+
+		const aPromises: Promise<void>[] = [];
+		const aControls = this.getView().findAggregatedObjects(true);
+
+		aControls.forEach((oElement: any) => {
+			const oObjectBinding = oElement.getObjectBinding();
+			if (oObjectBinding) {
+				// Register on all object binding (mostly used on object pages)
+				this.queryWatcher.registerBinding(oObjectBinding);
+			} else {
+				const aBindingKeys = Object.keys(oElement.mBindingInfos);
+				aBindingKeys.forEach((sPropertyName) => {
+					const oListBinding = oElement.mBindingInfos[sPropertyName].binding;
+
+					if (oListBinding && oListBinding.isA("sap.ui.model.odata.v4.ODataListBinding")) {
+						this.queryWatcher.registerBinding(oListBinding);
 					}
 				});
-			};
-			if (this.isContextExpected() && oBindingContext === undefined) {
-				// Force to mention we are expecting data
-				this.bHasContext = false;
-				return;
-			} else {
-				this.bHasContext = true;
 			}
-
-			this.attachEventOnce(
-				"pageReady",
-				null,
-				() => {
-					aBoundElements.forEach((oElement: any) => {
-						oElement.detachEvent("dataRequested", fnRequested);
-						oElement.detachEvent("dataReceived", fnReceived);
-						oElement.detachEvent("search", fnSearch);
-					});
-					this._bAfterBindingAlreadyApplied = false;
-					aBoundElements = [];
-				},
-				null
-			);
-			if (oBindingContext) {
-				const mainObjectBinding = (oBindingContext as any).getBinding();
-				mainObjectBinding.attachDataRequested(fnRequested);
-				mainObjectBinding.attachDataReceived(fnReceived);
-				aBoundElements.push(mainObjectBinding);
+			// This is dirty but MDCTables and MDCCharts have a weird loading lifecycle
+			if (oElement.isA("sap.ui.mdc.Table") || oElement.isA("sap.ui.mdc.Chart")) {
+				this.bTablesChartsLoaded = false;
+				aPromises.push(this.queryWatcher.registerTableOrChart(oElement));
+			} else if (oElement.isA("sap.fe.core.controls.FilterBar")) {
+				this.queryWatcher.registerFilterBar(oElement);
 			}
+		});
 
-			const aTableInitializedPromises: Promise<any>[] = [];
-			this._oView.findAggregatedObjects(true, (oElement: any) => {
-				const oObjectBinding = oElement.getObjectBinding();
-				if (oObjectBinding) {
-					// Register on all object binding (mostly used on object pages)
-					oObjectBinding.attachDataRequested(fnRequested);
-					oObjectBinding.attachDataReceived(fnReceived);
-					aBoundElements.push(oObjectBinding);
-				} else {
-					const aBindingKeys = Object.keys(oElement.mBindingInfos);
-					if (aBindingKeys.length > 0) {
-						aBindingKeys.forEach((sPropertyName) => {
-							const oListBinding = oElement.mBindingInfos[sPropertyName].binding;
-							// Register on all list binding, good for basic tables, problematic for MDC, see above
-							if (oListBinding && oListBinding.isA("sap.ui.model.odata.v4.ODataListBinding")) {
-								oListBinding.attachDataRequested(fnRequested);
-								oListBinding.attachDataReceived(fnReceived);
-								aBoundElements.push(oListBinding);
-							}
-						});
-					}
-				}
-				// This is dirty but MDC Table has a weird loading lifecycle
-				if (oElement.isA("sap.ui.mdc.Table")) {
-					this.bTablesLoaded = false;
-					// access binding only after table is bound
-					aTableInitializedPromises.push(
-						oElement
-							.initialized()
-							.then(() => {
-								const oRowBinding = oElement.getRowBinding();
-								if (oRowBinding) {
-									oRowBinding.attachDataRequested(fnRequested);
-									oRowBinding.attachDataReceived(fnReceived);
-									aBoundElements.push(oRowBinding);
-								} else {
-									aNotBoundMDCTables.push(oElement);
-								}
-							})
-							.catch(function (oError: Error) {
-								Log.error("Cannot find a bound table", oError as any);
-							})
-					);
-				} else if (oElement.isA("sap.fe.core.controls.FilterBar")) {
-					oElement.attachEvent("search", fnSearch);
-					aBoundElements.push(oElement);
-				}
-			});
-			if (aTableInitializedPromises.length > 0) {
-				Promise.all(aTableInitializedPromises)
-					.then(() => {
-						this.bTablesLoaded = true;
-						this.checkPageReadyDebounced();
-					})
-					.catch((oError) => {
-						Log.info("There was an error with one or multiple table", oError);
-						this.bTablesLoaded = true;
-						this.checkPageReadyDebounced();
-					});
-			}
+		return aPromises;
+	}
+
+	@methodOverride("_routing")
+	onAfterBinding(oBindingContext: Context) {
+		if (this._bAfterBindingAlreadyApplied) {
+			return;
+		}
+		this._bAfterBindingAlreadyApplied = true;
+
+		if (this.isContextExpected() && oBindingContext === undefined) {
+			// Force to mention we are expecting data
+			this.bHasContext = false;
+			return;
+		} else {
+			this.bHasContext = true;
+		}
+
+		this.attachEventOnce(
+			"pageReady",
+			null,
+			() => {
+				this._bAfterBindingAlreadyApplied = false;
+				this.queryWatcher.reset();
+			},
+			null
+		);
+
+		const aTableChartInitializedPromises = this.registerAggregatedControls(oBindingContext);
+
+		if (aTableChartInitializedPromises.length > 0) {
+			Promise.all(aTableChartInitializedPromises)
+				.finally(() => {
+					this.bTablesChartsLoaded = true;
+					this.checkPageReadyDebounced();
+				})
+				.catch((oError) => {
+					Log.info("There was an error with one or multiple tables or charts", oError);
+				});
 		}
 	}
 
@@ -361,13 +279,13 @@ class PageReadyControllerExtension extends ControllerExtension {
 
 		if (
 			this.bShown &&
-			this.bDataReceived !== false &&
-			this.bTablesLoaded !== false &&
+			this.queryWatcher.isDataReceived() !== false &&
+			this.bTablesChartsLoaded !== false &&
 			(!this.isContextExpected() || this.bHasContext) // Either no context is expected or there is one
 		) {
-			if (this.bDataReceived === true && !bFromNav && !this._bWaitingForRefresh && Core.getUIDirty()) {
+			if (this.queryWatcher.isDataReceived() === true && !bFromNav && !this._bWaitingForRefresh && Core.getUIDirty()) {
 				// If we requested data we get notified as soon as the data arrived, so before the next rendering tick
-				this.bDataReceived = undefined;
+				this.queryWatcher.resetDataReceived();
 				this._bWaitingForRefresh = true;
 				(Core as CoreEx).attachEvent("UIUpdated", fnUIUpdated);
 				setTimeout(checkUIUpdated, 500);
@@ -375,7 +293,7 @@ class PageReadyControllerExtension extends ControllerExtension {
 				(!this._bWaitingForRefresh && Core.getUIDirty()) ||
 				this._nbWaits !== 0 ||
 				TemplatedViewServiceFactory.getNumberOfViewsInCreationState() > 0 ||
-				this._bSeachTriggered
+				this.queryWatcher.isSearchPending()
 			) {
 				this._bWaitingForRefresh = true;
 				(Core as CoreEx).attachEvent("UIUpdated", fnUIUpdated);