@sapui5/sap.fe.core 1.131.0 → 1.133.0

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

@@ -73,6 +73,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 
 	private isConfirmationDialogOpen?: boolean;
 
+	private readonly requestExecutions: Promise<unknown>[] = [];
+
 	constructor() {
 		super();
 	}
@@ -145,6 +147,16 @@ class SideEffectsControllerExtension extends ControllerExtension {
 		return contextForSideEffects || undefined;
 	}
 
+	/**
+	 * Wait For all sideEffects execution to be completed.
+	 *
+	 */
+	@publicExtension()
+	@finalExtension()
+	async waitForSideEffectExecutions(): Promise<void> {
+		await Promise.allSettled(this.requestExecutions);
+	}
+
 	/**
 	 * Gets the SideEffects map for a field
 	 * These SideEffects are
@@ -397,6 +409,25 @@ class SideEffectsControllerExtension extends ControllerExtension {
 		return null;
 	}
 
+	/* Manages the deferred SideEffects which have to be executed when the context of the page changes (saving a document).
+	 *
+	 * @param context The context of the page
+	 * @returns Promise returning true if the SideEffects have been successfully executed
+	 */
+	@publicExtension()
+	@finalExtension()
+	async handlePageChangeContext(context: Context): Promise<void | unknown[]> {
+		await this.waitForSideEffectExecutions();
+		const sideEffectsFieldGroupOnPage = this.getRegisteredSideEffectsForContext(context);
+		return Promise.all(
+			sideEffectsFieldGroupOnPage.map(async (fieldGroupSideEffects) => {
+				return this._requestFieldGroupSideEffects(fieldGroupSideEffects);
+			})
+		).catch((error) => {
+			Log.debug(`Error while processing on page context ${context.getPath()}`, error);
+		});
+	}
+
 	/**
 	 * Request SideEffects on a specific context.
 	 * @param sideEffects SideEffects to be executed
@@ -423,11 +454,11 @@ class SideEffectsControllerExtension extends ControllerExtension {
 					triggerAction: !this._sideEffectsService.isControlSideEffects(sideEffects) ? sideEffects.triggerAction : undefined
 			  };
 		if (triggerAction && !ignoreTriggerActions) {
-			this._sideEffectsService.executeAction(triggerAction, context, groupId);
+			this.requestExecutions.push(this._sideEffectsService.executeAction(triggerAction, context, groupId));
 		}
 
 		if (targets.length) {
-			return this._sideEffectsService
+			const requestTargets = this._sideEffectsService
 				.requestSideEffects(targets, context, groupId)
 				.then(async function async() {
 					return fnTriggerCallbacks(sideEffects.targetEntities?.map((target) => target.$NavigationPropertyPath) || []);
@@ -436,6 +467,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 					this.registerFailedSideEffects([sideEffects], context);
 					throw error;
 				});
+			this.requestExecutions.push(requestTargets);
+			return requestTargets;
 		}
 	}
 
@@ -443,7 +476,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * Requests the SideEffects for a sideEffect event.
 	 *
 	 * The default implementation is to execute the side effect on the page's context, but pages (like the LR) might override this method.
-	 * @param eventName SideEffects event which was triggered
+	 * @param eventName The SideEffects event that is triggered
 	 * @param path The path for which this event was triggered
 	 * @returns Promise on SideEffects request
 	 */
@@ -451,7 +484,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	@publicExtension()
 	@extensible(OverrideExecution.Instead)
 	async requestSideEffectsForEvent(eventName: string, path: string): Promise<undefined> {
-		if (this.isDataPathRelevant(path)) {
+		if (this.isDataPathRelevant(path, eventName)) {
 			// use the default implementation from the SideEffects Service
 			const context = this._findRelevantContext(path, this.getView().getBindingContext() as Context);
 			if (context) {
@@ -461,11 +494,12 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	}
 
 	/**
-	 * Checks if a given data path is shown/relevant on the page.
+	 * Checks whether a specific data path is visible on the page.
 	 * @param path The path to be checked
+	 * @param _eventName SideEffects event which was triggered
 	 * @returns True if the data path is shown on the UI
 	 */
-	isDataPathRelevant(path: string): boolean {
+	isDataPathRelevant(path: string, _eventName: string): boolean {
 		const context = this.getView().getBindingContext() as Context;
 
 		if (this._contextIsRelevant(path, context)) {
@@ -758,6 +792,24 @@ class SideEffectsControllerExtension extends ControllerExtension {
 		return sideEffects;
 	}
 
+	/**
+	 * Gets the registered SideEffects into the queue for a context and its children.
+	 * @param context The context
+	 * @returns Array of registered SideEffects and their promise
+	 */
+	@publicExtension()
+	@finalExtension()
+	getRegisteredSideEffectsForContext(context: Context): FieldGroupSideEffectType[] {
+		const sideEffects = [];
+		for (const registryIndex of Object.keys(this._registeredFieldGroupMap)) {
+			if (this._registeredFieldGroupMap)
+				if (registryIndex.includes(`_${context.getPath()}`)) {
+					sideEffects.push(this._registeredFieldGroupMap[registryIndex]);
+				}
+		}
+		return sideEffects;
+	}
+
 	/**
 	 * Gets a status index.
 	 * @param fieldGroupId The field group id

package/src/sap/fe/core/controllerextensions/Telemetry.js

@@ -13,19 +13,18 @@ sap.ui.define(["sap/fe/base/ClassSupport", "sap/fe/core/controllerextensions/Bas
   function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
   function _applyDecoratedDescriptor(i, e, r, n, l) { var a = {}; return Object.keys(n).forEach(function (i) { a[i] = n[i]; }), a.enumerable = !!a.enumerable, a.configurable = !!a.configurable, ("value" in a || a.initializer) && (a.writable = !0), a = r.slice().reverse().reduce(function (r, n) { return n(i, e, r) || r; }, a), l && void 0 !== a.initializer && (a.value = a.initializer ? a.initializer.call(l) : void 0, a.initializer = void 0), void 0 === a.initializer ? (Object.defineProperty(i, e, a), null) : a; }
   let Telemetry = (_dec = defineUI5Class("sap.fe.core.controllerextensions.Telemetry"), _dec2 = publicExtension(), _dec(_class = (_class2 = /*#__PURE__*/function (_BaseControllerExtens) {
-    _inheritsLoose(Telemetry, _BaseControllerExtens);
     function Telemetry() {
       return _BaseControllerExtens.apply(this, arguments) || this;
     }
     _exports = Telemetry;
+    _inheritsLoose(Telemetry, _BaseControllerExtens);
     var _proto = Telemetry.prototype;
     _proto.storeAction = function storeAction(actionDefinition) {
-      var _this$base$getView;
-      this.base.getAppComponent().getTelemetryService().storeAction(actionDefinition, ((_this$base$getView = this.base.getView()) === null || _this$base$getView === void 0 ? void 0 : _this$base$getView.getViewData()).converterType);
+      this.base.getAppComponent().getTelemetryService().storeAction(actionDefinition, (this.base.getView()?.getViewData()).converterType);
     };
     return Telemetry;
-  }(BaseControllerExtension), (_applyDecoratedDescriptor(_class2.prototype, "storeAction", [_dec2], Object.getOwnPropertyDescriptor(_class2.prototype, "storeAction"), _class2.prototype)), _class2)) || _class);
+  }(BaseControllerExtension), _applyDecoratedDescriptor(_class2.prototype, "storeAction", [_dec2], Object.getOwnPropertyDescriptor(_class2.prototype, "storeAction"), _class2.prototype), _class2)) || _class);
   _exports = Telemetry;
   return _exports;
 }, false);
-//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6WyJUZWxlbWV0cnkiLCJfZGVjIiwiZGVmaW5lVUk1Q2xhc3MiLCJfZGVjMiIsInB1YmxpY0V4dGVuc2lvbiIsIl9jbGFzcyIsIl9jbGFzczIiLCJfQmFzZUNvbnRyb2xsZXJFeHRlbnMiLCJfaW5oZXJpdHNMb29zZSIsImFwcGx5IiwiYXJndW1lbnRzIiwiX2V4cG9ydHMiLCJfcHJvdG8iLCJwcm90b3R5cGUiLCJzdG9yZUFjdGlvbiIsImFjdGlvbkRlZmluaXRpb24iLCJfdGhpcyRiYXNlJGdldFZpZXciLCJiYXNlIiwiZ2V0QXBwQ29tcG9uZW50IiwiZ2V0VGVsZW1ldHJ5U2VydmljZSIsImdldFZpZXciLCJnZXRWaWV3RGF0YSIsImNvbnZlcnRlclR5cGUiLCJCYXNlQ29udHJvbGxlckV4dGVuc2lvbiIsIl9hcHBseURlY29yYXRlZERlc2NyaXB0b3IiLCJPYmplY3QiLCJnZXRPd25Qcm9wZXJ0eURlc2NyaXB0b3IiXSwic291cmNlUm9vdCI6Ii4iLCJzb3VyY2VzIjpbIlRlbGVtZXRyeS50cyJdLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBkZWZpbmVVSTVDbGFzcywgcHVibGljRXh0ZW5zaW9uIH0gZnJvbSBcInNhcC9mZS9iYXNlL0NsYXNzU3VwcG9ydFwiO1xuaW1wb3J0IHR5cGUgUGFnZUNvbnRyb2xsZXIgZnJvbSBcInNhcC9mZS9jb3JlL1BhZ2VDb250cm9sbGVyXCI7XG5pbXBvcnQgQmFzZUNvbnRyb2xsZXJFeHRlbnNpb24gZnJvbSBcInNhcC9mZS9jb3JlL2NvbnRyb2xsZXJleHRlbnNpb25zL0Jhc2VDb250cm9sbGVyRXh0ZW5zaW9uXCI7XG5pbXBvcnQgdHlwZSB7IFRlbXBsYXRlVHlwZSB9IGZyb20gXCJzYXAvZmUvY29yZS9jb252ZXJ0ZXJzL01hbmlmZXN0U2V0dGluZ3NcIjtcbmltcG9ydCB0eXBlIHsgVGVsZW1ldHJ5RXZlbnRzIH0gZnJvbSBcInNhcC9mZS9jb3JlL3NlcnZpY2VzL1RlbGVtZXRyeVNlcnZpY2VGYWN0b3J5XCI7XG5cbkBkZWZpbmVVSTVDbGFzcyhcInNhcC5mZS5jb3JlLmNvbnRyb2xsZXJleHRlbnNpb25zLlRlbGVtZXRyeVwiKVxuZXhwb3J0IGRlZmF1bHQgY2xhc3MgVGVsZW1ldHJ5IGV4dGVuZHMgQmFzZUNvbnRyb2xsZXJFeHRlbnNpb24ge1xuXHRiYXNlITogUGFnZUNvbnRyb2xsZXI7XG5cblx0QHB1YmxpY0V4dGVuc2lvbigpXG5cdHB1YmxpYyBzdG9yZUFjdGlvbihhY3Rpb25EZWZpbml0aW9uOiBUZWxlbWV0cnlFdmVudHMpOiB2b2lkIHtcblx0XHR0aGlzLmJhc2Vcblx0XHRcdC5nZXRBcHBDb21wb25lbnQoKVxuXHRcdFx0LmdldFRlbGVtZXRyeVNlcnZpY2UoKVxuXHRcdFx0LnN0b3JlQWN0aW9uKGFjdGlvbkRlZmluaXRpb24sICh0aGlzLmJhc2UuZ2V0VmlldygpPy5nZXRWaWV3RGF0YSgpIGFzIHsgY29udmVydGVyVHlwZTogc3RyaW5nIH0pLmNvbnZlcnRlclR5cGUgYXMgVGVtcGxhdGVUeXBlKTtcblx0fVxufVxuIl0sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7OztNQU9xQkEsU0FBUyxJQUFBQyxJQUFBLEdBRDdCQyxjQUFjLENBQUMsNENBQTRDLENBQUMsRUFBQUMsS0FBQSxHQUkzREMsZUFBZSxDQUFDLENBQUMsRUFBQUgsSUFBQSxDQUFBSSxNQUFBLElBQUFDLE9BQUEsMEJBQUFDLHFCQUFBO0lBQUFDLGNBQUEsQ0FBQVIsU0FBQSxFQUFBTyxxQkFBQTtJQUFBLFNBQUFQLFVBQUE7TUFBQSxPQUFBTyxxQkFBQSxDQUFBRSxLQUFBLE9BQUFDLFNBQUE7SUFBQTtJQUFBQyxRQUFBLEdBQUFYLFNBQUE7SUFBQSxJQUFBWSxNQUFBLEdBQUFaLFNBQUEsQ0FBQWEsU0FBQTtJQUFBRCxNQUFBLENBQ1hFLFdBQVcsR0FEbEIsU0FBQUEsWUFDbUJDLGdCQUFpQyxFQUFRO01BQUEsSUFBQUMsa0JBQUE7TUFDM0QsSUFBSSxDQUFDQyxJQUFJLENBQ1BDLGVBQWUsQ0FBQyxDQUFDLENBQ2pCQyxtQkFBbUIsQ0FBQyxDQUFDLENBQ3JCTCxXQUFXLENBQUNDLGdCQUFnQixFQUFFLEVBQUFDLGtCQUFBLEdBQUMsSUFBSSxDQUFDQyxJQUFJLENBQUNHLE9BQU8sQ0FBQyxDQUFDLGNBQUFKLGtCQUFBLHVCQUFuQkEsa0JBQUEsQ0FBcUJLLFdBQVcsQ0FBQyxDQUFDLEVBQStCQyxhQUE2QixDQUFDO0lBQ2pJLENBQUM7SUFBQSxPQUFBdEIsU0FBQTtFQUFBLEVBVHFDdUIsdUJBQXVCLElBQUFDLHlCQUFBLENBQUFsQixPQUFBLENBQUFPLFNBQUEsa0JBQUFWLEtBQUEsR0FBQXNCLE1BQUEsQ0FBQUMsd0JBQUEsQ0FBQXBCLE9BQUEsQ0FBQU8sU0FBQSxrQkFBQVAsT0FBQSxDQUFBTyxTQUFBLElBQUFQLE9BQUEsTUFBQUQsTUFBQTtFQUFBTSxRQUFBLEdBQUFYLFNBQUE7RUFBQSxPQUFBVyxRQUFBO0FBQUEiLCJpZ25vcmVMaXN0IjpbXX0=
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6WyJUZWxlbWV0cnkiLCJfZGVjIiwiZGVmaW5lVUk1Q2xhc3MiLCJfZGVjMiIsInB1YmxpY0V4dGVuc2lvbiIsIl9jbGFzcyIsIl9jbGFzczIiLCJfQmFzZUNvbnRyb2xsZXJFeHRlbnMiLCJhcHBseSIsImFyZ3VtZW50cyIsIl9leHBvcnRzIiwiX2luaGVyaXRzTG9vc2UiLCJfcHJvdG8iLCJwcm90b3R5cGUiLCJzdG9yZUFjdGlvbiIsImFjdGlvbkRlZmluaXRpb24iLCJiYXNlIiwiZ2V0QXBwQ29tcG9uZW50IiwiZ2V0VGVsZW1ldHJ5U2VydmljZSIsImdldFZpZXciLCJnZXRWaWV3RGF0YSIsImNvbnZlcnRlclR5cGUiLCJCYXNlQ29udHJvbGxlckV4dGVuc2lvbiIsIl9hcHBseURlY29yYXRlZERlc2NyaXB0b3IiLCJPYmplY3QiLCJnZXRPd25Qcm9wZXJ0eURlc2NyaXB0b3IiXSwic291cmNlUm9vdCI6Ii4iLCJzb3VyY2VzIjpbIlRlbGVtZXRyeS50cyJdLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBkZWZpbmVVSTVDbGFzcywgcHVibGljRXh0ZW5zaW9uIH0gZnJvbSBcInNhcC9mZS9iYXNlL0NsYXNzU3VwcG9ydFwiO1xuaW1wb3J0IHR5cGUgUGFnZUNvbnRyb2xsZXIgZnJvbSBcInNhcC9mZS9jb3JlL1BhZ2VDb250cm9sbGVyXCI7XG5pbXBvcnQgQmFzZUNvbnRyb2xsZXJFeHRlbnNpb24gZnJvbSBcInNhcC9mZS9jb3JlL2NvbnRyb2xsZXJleHRlbnNpb25zL0Jhc2VDb250cm9sbGVyRXh0ZW5zaW9uXCI7XG5pbXBvcnQgdHlwZSB7IFRlbXBsYXRlVHlwZSB9IGZyb20gXCJzYXAvZmUvY29yZS9jb252ZXJ0ZXJzL01hbmlmZXN0U2V0dGluZ3NcIjtcbmltcG9ydCB0eXBlIHsgVGVsZW1ldHJ5RXZlbnRzIH0gZnJvbSBcInNhcC9mZS9jb3JlL3NlcnZpY2VzL1RlbGVtZXRyeVNlcnZpY2VGYWN0b3J5XCI7XG5cbkBkZWZpbmVVSTVDbGFzcyhcInNhcC5mZS5jb3JlLmNvbnRyb2xsZXJleHRlbnNpb25zLlRlbGVtZXRyeVwiKVxuZXhwb3J0IGRlZmF1bHQgY2xhc3MgVGVsZW1ldHJ5IGV4dGVuZHMgQmFzZUNvbnRyb2xsZXJFeHRlbnNpb24ge1xuXHRiYXNlITogUGFnZUNvbnRyb2xsZXI7XG5cblx0QHB1YmxpY0V4dGVuc2lvbigpXG5cdHB1YmxpYyBzdG9yZUFjdGlvbihhY3Rpb25EZWZpbml0aW9uOiBUZWxlbWV0cnlFdmVudHMpOiB2b2lkIHtcblx0XHR0aGlzLmJhc2Vcblx0XHRcdC5nZXRBcHBDb21wb25lbnQoKVxuXHRcdFx0LmdldFRlbGVtZXRyeVNlcnZpY2UoKVxuXHRcdFx0LnN0b3JlQWN0aW9uKGFjdGlvbkRlZmluaXRpb24sICh0aGlzLmJhc2UuZ2V0VmlldygpPy5nZXRWaWV3RGF0YSgpIGFzIHsgY29udmVydGVyVHlwZTogc3RyaW5nIH0pLmNvbnZlcnRlclR5cGUgYXMgVGVtcGxhdGVUeXBlKTtcblx0fVxufVxuIl0sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7OztNQU9xQkEsU0FBUyxJQUFBQyxJQUFBLEdBRDdCQyxjQUFjLENBQUMsNENBQTRDLENBQUMsRUFBQUMsS0FBQSxHQUkzREMsZUFBZSxDQUFDLENBQUMsRUFBQUgsSUFBQSxDQUFBSSxNQUFBLElBQUFDLE9BQUEsMEJBQUFDLHFCQUFBO0lBQUEsU0FBQVAsVUFBQTtNQUFBLE9BQUFPLHFCQUFBLENBQUFDLEtBQUEsT0FBQUMsU0FBQTtJQUFBO0lBQUFDLFFBQUEsR0FBQVYsU0FBQTtJQUFBVyxjQUFBLENBQUFYLFNBQUEsRUFBQU8scUJBQUE7SUFBQSxJQUFBSyxNQUFBLEdBQUFaLFNBQUEsQ0FBQWEsU0FBQTtJQUFBRCxNQUFBLENBQ1hFLFdBQVcsR0FEbEIsU0FDT0EsV0FBV0EsQ0FBQ0MsZ0JBQWlDLEVBQVE7TUFDM0QsSUFBSSxDQUFDQyxJQUFJLENBQ1BDLGVBQWUsQ0FBQyxDQUFDLENBQ2pCQyxtQkFBbUIsQ0FBQyxDQUFDLENBQ3JCSixXQUFXLENBQUNDLGdCQUFnQixFQUFFLENBQUMsSUFBSSxDQUFDQyxJQUFJLENBQUNHLE9BQU8sQ0FBQyxDQUFDLEVBQUVDLFdBQVcsQ0FBQyxDQUFDLEVBQStCQyxhQUE2QixDQUFDO0lBQ2pJLENBQUM7SUFBQSxPQUFBckIsU0FBQTtFQUFBLEVBVHFDc0IsdUJBQXVCLEdBQUFDLHlCQUFBLENBQUFqQixPQUFBLENBQUFPLFNBQUEsa0JBQUFWLEtBQUEsR0FBQXFCLE1BQUEsQ0FBQUMsd0JBQUEsQ0FBQW5CLE9BQUEsQ0FBQU8sU0FBQSxrQkFBQVAsT0FBQSxDQUFBTyxTQUFBLEdBQUFQLE9BQUEsTUFBQUQsTUFBQTtFQUFBSyxRQUFBLEdBQUFWLFNBQUE7RUFBQSxPQUFBVSxRQUFBO0FBQUEiLCJpZ25vcmVMaXN0IjpbXX0=