@sapui5/sap.ushell 1.143.3 → 1.144.0

package/src/main/js/sap/ushell/services/PersonalizationV2/PendingOperations.js

@@ -0,0 +1,210 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/base/Log"
+], (
+    Log
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.services.PersonalizationV2.PendingOperations
+     * @namespace
+     * @description Manages pending operations for personalization service.
+     * All operations for the same container are queued and executed in order.
+     * Each operation can be invoked immediately or canceled and be followed by
+     * a new operation.
+     *
+     * Once the 'run' callback is done it is removed from the queue.
+     * When cancel or runImmediately is called before end it only awaits the cancel or
+     * runImmediately result before starting the next operation.
+     *
+     * @since 1.144.0
+     * @private
+     */
+    class PendingOperations {
+        /**
+         * A promise chain to ensure operations for the same container are executed in order.
+         */
+        #mOperationPromiseChain = new Map();
+
+        /**
+         * A map of pending operations, keyed by container ID.
+         * @type {Map<string, sap.ushell.services.PersonalizationV2.Operation>}
+         */
+        #mCurrentOperation = new Map();
+
+        /**
+         * Runs the current operation for the given container immediately.
+         * @param {string} sContainerKey The personalization container key.
+         * @returns {Promise} Resolves when the operation is done running immediately.
+         *
+         * @since 1.144.0
+         * @private
+         */
+        async #runCurrentOperationImmediately (sContainerKey) {
+            const oOperation = this.#mCurrentOperation.get(sContainerKey);
+            if (!oOperation) {
+                return;
+            }
+
+            this.#mCurrentOperation.delete(sContainerKey);
+
+            try {
+                await oOperation.runImmediately();
+            } catch (oError) {
+                Log.error(`Failed to run current operation immediately for container ${sContainerKey}`, oError, "sap.ushell.services.PersonalizationV2");
+            }
+        }
+
+        /**
+         * Cancels the current operation for the given container.
+         * @param {string} sContainerKey The personalization container key.
+         * @returns {Promise} Resolves when the operation is canceled.
+         *
+         * @since 1.144.0
+         * @private
+         */
+        async #cancelCurrentOperation (sContainerKey) {
+            const oOperation = this.#mCurrentOperation.get(sContainerKey);
+            if (!oOperation) {
+                return;
+            }
+
+            Log.warning(`Cancelling pending operation for container ${sContainerKey}`, null, "sap.ushell.services.PersonalizationV2");
+
+            this.#mCurrentOperation.delete(sContainerKey);
+
+            try {
+                await oOperation.cancel();
+            } catch (oError) {
+                Log.error(`Failed to cancel pending operation for container ${sContainerKey}`, oError, "sap.ushell.services.PersonalizationV2");
+            }
+        }
+
+        /**
+         * Stores and runs the given operation for the specified container.
+         * @param {string} sContainerKey The personalization container key.
+         * @param {sap.ushell.services.PersonalizationV2.Operation} oOperation The operation to store and run.
+         *
+         * @since 1.144.0
+         * @private
+         */
+        #storeAndRunOperation (sContainerKey, oOperation) {
+            // store the new operation for next operation
+            this.#mCurrentOperation.set(sContainerKey, oOperation);
+
+            try {
+                oOperation.run();
+                // do not return here the result as this would block the promise chain
+            } catch (oError) {
+                Log.error(`Failed to run operation for container ${sContainerKey}`, oError, "sap.ushell.services.PersonalizationV2");
+            }
+        }
+
+        /**
+         * Runs the given callback as the next promise in the promise chain.
+         * Awaits the previous state of the promise chain before executing the callback.
+         * @param {string} sContainerKey The personalization container key.
+         * @param {function (): Promise} fnAsyncCallback The async callback to run.
+         * @returns {Promise} Resolves with the new state of the promise chain
+         *
+         * @since 1.144.0
+         * @private
+         */
+        #runAsNextPromiseInTheChain (sContainerKey, fnAsyncCallback) {
+            if (!this.#mOperationPromiseChain.has(sContainerKey)) {
+                this.#mOperationPromiseChain.set(sContainerKey, Promise.resolve());
+            }
+
+            const pNewPromise = this.#mOperationPromiseChain.get(sContainerKey).then(fnAsyncCallback);
+
+            this.#mOperationPromiseChain.set(sContainerKey, pNewPromise);
+
+            return pNewPromise;
+        }
+
+        /**
+         * Cancels the current operation and sets the new operation for the given container.
+         * @param {string} sContainerKey The personalization container key.
+         * @param {sap.ushell.services.PersonalizationV2.Operation} oOperation The function call to run
+         * @returns {Promise} Resolves with the new state of the promise chain.
+         * And additionally awaits the actual result.
+         *
+         * @since 1.144.0
+         * @private
+         */
+        async cancelCurrentOperationAndSetNext (sContainerKey, oOperation) {
+            return this.#runAsNextPromiseInTheChain(sContainerKey, async () => {
+                await this.#cancelCurrentOperation(sContainerKey);
+
+                this.#storeAndRunOperation(sContainerKey, oOperation);
+                // do not return here the result as this would block the promise chain
+            }).then(() => {
+                return oOperation.awaitResult();
+            });
+        }
+
+        /**
+         * Cancels the current operation
+         * @param {string} sContainerKey The personalization container key.
+         * @returns {Promise} Resolves with the new state of the promise chain.
+         * Resolves with the new state of the promise chain.
+         *
+         * @since 1.144.0
+         * @private
+         */
+        async cancelCurrentOperation (sContainerKey) {
+            return this.#runAsNextPromiseInTheChain(sContainerKey, async () => {
+                await this.#cancelCurrentOperation(sContainerKey);
+            });
+        }
+
+        /**
+         * Runs the current operation immediately and sets the new operation for the given container.
+         * @param {string} sContainerKey The personalization container key.
+         * @param {sap.ushell.services.PersonalizationV2.Operation} oOperation The function call to run
+         * @returns {Promise}
+         * And additionally awaits the actual result.
+         *
+         * @since 1.144.0
+         * @private
+         */
+        async runCurrentOperationImmediatelyAndSetNext (sContainerKey, oOperation) {
+            return this.#runAsNextPromiseInTheChain(sContainerKey, async () => {
+                await this.#runCurrentOperationImmediately(sContainerKey);
+
+                this.#storeAndRunOperation(sContainerKey, oOperation);
+                // do not return here the result as this would block the promise chain
+            }).then(() => {
+                return oOperation.awaitResult();
+            });
+        }
+
+        /**
+         * Runs the current operation immediately.
+         * @param {string} sContainerKey The personalization container key.
+         * @returns {Promise} Resolves with the new state of the promise chain.
+         *
+         * @since 1.144.0
+         * @private
+         */
+        async runCurrentOperationImmediately (sContainerKey) {
+            return this.#runAsNextPromiseInTheChain(sContainerKey, async () => {
+                await this.#runCurrentOperationImmediately(sContainerKey);
+            });
+        }
+
+        /**
+         * Awaits all pending operations for all containers.
+         *
+         * @since 1.144.0
+         * @private
+         */
+        async awaitAllOperations () {
+            await Promise.allSettled(this.#mOperationPromiseChain.values());
+        }
+    }
+
+    return new PendingOperations();
+});

package/src/main/js/sap/ushell/services/PersonalizationV2/Personalizer.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/ushell/utils",
     "sap/base/Log"

package/src/main/js/sap/ushell/services/PersonalizationV2/TransientPersonalizer.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
 sap.ui.define([
 ], () => {
     "use strict";

package/src/main/js/sap/ushell/services/PersonalizationV2/Variant.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/ushell/services/PersonalizationV2/utils"
 ], (personalizationUtils) => {

package/src/main/js/sap/ushell/services/PersonalizationV2/VariantSet.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/ushell/utils",
     "sap/ushell/services/PersonalizationV2/constants.private",

package/src/main/js/sap/ushell/services/PersonalizationV2/VariantSetAdapter.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/ushell/services/PersonalizationV2/constants.private",
     "sap/ushell/services/PersonalizationV2/VariantSet"

package/src/main/js/sap/ushell/services/PersonalizationV2/WindowAdapter.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/ui/thirdparty/jquery",
     "sap/ushell/services/PersonalizationV2/WindowAdapterContainer"

package/src/main/js/sap/ushell/services/PersonalizationV2/WindowAdapterContainer.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/ushell/utils",
     "sap/ushell/services/PersonalizationV2/utils",

package/src/main/js/sap/ushell/services/PersonalizationV2/constants.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
 sap.ui.define([
 ], () => {
     "use strict";

package/src/main/js/sap/ushell/services/PersonalizationV2/constants.private.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
 sap.ui.define([
 ], () => {
     "use strict";

package/src/main/js/sap/ushell/services/PersonalizationV2/utils.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/ushell/services/PersonalizationV2/constants",
     "sap/ushell/services/PersonalizationV2/constants.private",
@@ -139,7 +139,7 @@ sap.ui.define([
      */
     async function loadAdapter (oAdapter) {
         if (!oAdapter.lazy) {
-            return ushellUtils.promisify(jQuery.when(oAdapter.instance));
+            return oAdapter.instance;
         }
 
         return ushellUtils.promisify(oAdapter.create.call(null));

package/src/main/js/sap/ushell/services/PersonalizationV2.js

@@ -1,10 +1,10 @@
-// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The Unified Shell's personalization service, which provides generic read and write access to the currently logged on user's
  * personalization settings for the app currently executed in the shell.
  *
- * @version 1.143.3
+ * @version 1.144.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -17,8 +17,10 @@ sap.ui.define([
     "sap/ushell/services/PersonalizationV2/utils",
     "sap/ushell/services/PersonalizationV2/constants",
     "sap/ushell/services/PersonalizationV2/ContextContainer",
+    "sap/ushell/services/PersonalizationV2/Operation",
     "sap/ushell/services/PersonalizationV2/WindowAdapter",
     "sap/ushell/services/PersonalizationV2/TransientPersonalizer", // private
+    "sap/ushell/services/PersonalizationV2/PendingOperations",
     "sap/ushell/services/PersonalizationV2/Personalizer", // private
     "sap/ushell/services/PersonalizationV2/VariantSetAdapter",
     "sap/ushell/services/PersonalizationV2/Variant",
@@ -35,8 +37,10 @@ sap.ui.define([
     personalizationUtils,
     publicConstants,
     ContextContainer,
+    Operation,
     WindowAdapter,
     TransientPersonalizer,
+    PendingOperations,
     Personalizer,
     VariantSetAdapter,
     Variant,
@@ -128,12 +132,8 @@ sap.ui.define([
 
         this._oContainerMap = new ushellUtils.Map();
         // map: sPrefixedContainerKey -> promise object of getPersonalizationContainer
-        this._oPendingOperationsMap = new ushellUtils.Map();
-        // map: sContainerKey -> pending operation (deferred object, potentially extended with _sapTimeoutId, _sapFnSave)
     }
 
-    PersonalizationV2.prototype.SAVE_DEFERRED_DROPPED = "Deferred save dropped (OK) - Data superseded by subsequent save";
-
     // constants for scope of personalization service
     // legacy access to constants
     PersonalizationV2.prototype.constants = publicConstants;
@@ -462,106 +462,27 @@ sap.ui.define([
      * @since 1.120.0
      * @public
      */
-    PersonalizationV2.prototype.deleteContainer = function (sContainerKey, oScope) {
+    PersonalizationV2.prototype.deleteContainer = async function (sContainerKey, oScope) {
         // delete the bag, the adapter container & the container
-        let sPrefixedContainerKey = "";
         oScope = this._adjustScope(oScope);
-        sPrefixedContainerKey = personalizationUtils.addContainerPrefix(sContainerKey);
-        const oDeferred = new jQuery.Deferred();
-
-        const oPrior = this._pendingContainerOperations_cancelAddNext(sContainerKey, null);
-        oPrior.always(() => {
-            this.getContainer(sContainerKey, oScope) // delays to oPrior! registers a new op!
-                .then((/* oContainer */) => {
-                    // install the "latest" deferred
-                    this._pendingContainerOperations_cancelAddNext(sContainerKey, oDeferred); // the getContainer above executed a load --> no flush required
-
-                    const oAdapter = oScope.validity === 0
-                        ? this._oAdapterWindowOnly
-                        : this._oAdapterWithBackendAdapter;
-
-                    personalizationUtils.loadAdapter(oAdapter)
-                        .then((oLoadedAdapter) => {
-                            oLoadedAdapter.delAdapterContainer(sPrefixedContainerKey, oScope)
-                                .fail((oError) => {
-                                    Log.error("Delete failed", oError);
-                                    oDeferred.reject(oError);
-                                })
-                                .done(oDeferred.resolve);
-                        })
-                        .catch((oError) => {
-                            Log.error("Delete failed", oError);
-                            oDeferred.reject(oError);
-                        });
-                })
-                .catch((oError) => {
-                    Log.error("Delete failed", oError);
-                    this._pendingContainerOperations_cancelAddNext(sContainerKey, oDeferred); // reinstall oPrior (!)
-                    oDeferred.reject(oError);
-                });
-        });
-        return ushellUtils.promisify(oDeferred.promise());
-    };
+        const sPrefixedContainerKey = personalizationUtils.addContainerPrefix(sContainerKey);
+        const oAdapterToLoad = personalizationUtils.pickAdapter(oScope, this._oAdapterWindowOnly, this._oAdapterWithBackendAdapter);
 
-    /**
-     * @param {string} sContainerKey the personalization container key.
-     * @param {jQuery.Deferred} [oDeferred] pending deferred.
-     *
-     * @returns {jQuery.Deferred} that resolves after this operation is done.
-     *
-     * @since 1.120.0
-     * @private
-     */
-    PersonalizationV2.prototype._pendingContainerOperations_flushAddNext = function (sContainerKey, oDeferred) {
-        // return old promise, add oDeferred as new, if null, retain old!
-        let oPendingOpDeferred = this._oPendingOperationsMap.get(sContainerKey);
-        if (!oPendingOpDeferred) {
-            oPendingOpDeferred = new jQuery.Deferred();
-            oPendingOpDeferred.resolve();
-        }
-        if (oDeferred !== null) {
-            this._oPendingOperationsMap.put(sContainerKey, oDeferred);
-        }
-        if (!oPendingOpDeferred || oPendingOpDeferred.state() !== "pending") {
-            return oPendingOpDeferred;
-        }
-        clearTimeout(oPendingOpDeferred._sapTimeoutId); // system function!
-        oPendingOpDeferred._sapTimeoutId = undefined;
-        if (typeof oPendingOpDeferred._sapFnSave === "function") {
-            const fnSave = oPendingOpDeferred._sapFnSave;
-            oPendingOpDeferred._sapFnSave = undefined; // function can only be triggered at most one time
-            fnSave();
-        }
-        return oPendingOpDeferred;
-    };
+        try {
+            await this.getContainer(sContainerKey, oScope);
 
-    /**
-     * @param {string} sContainerKey the personalization container key.
-     * @param {jQuery.Deferred} [oDeferred] pending deferred.
-     *
-     * @returns {jQuery.Deferred} that resolves after this operation is done.
-     *
-     * @since 1.120.0
-     * @private
-     */
-    PersonalizationV2.prototype._pendingContainerOperations_cancelAddNext = function (sContainerKey, oDeferred) {
-        let oPendingOpDeferred = this._oPendingOperationsMap.get(sContainerKey);
-        if (!oPendingOpDeferred) {
-            oPendingOpDeferred = new jQuery.Deferred();
-            oPendingOpDeferred.resolve();
-        }
-        if (oDeferred !== null) {
-            this._oPendingOperationsMap.put(sContainerKey, oDeferred);
-        }
-        if (!oPendingOpDeferred || oPendingOpDeferred.state() !== "pending") {
-            return oPendingOpDeferred;
-        }
-        if (oPendingOpDeferred._sapTimeoutId) {
-            clearTimeout(oPendingOpDeferred._sapTimeoutId);
-            oPendingOpDeferred._sapTimeoutId = undefined;
-            oPendingOpDeferred.resolve(PersonalizationV2.prototype.SAVE_DEFERRED_DROPPED);
+            const oOperation = new Operation(async () => {
+                const oAdapter = await personalizationUtils.loadAdapter(oAdapterToLoad);
+
+                await ushellUtils.promisify(oAdapter.delAdapterContainer(sPrefixedContainerKey, oScope));
+            });
+
+            return await PendingOperations.cancelCurrentOperationAndSetNext(sContainerKey, oOperation);
+        } catch (oError) {
+            Log.error("Delete failed", oError);
+
+            throw oError;
         }
-        return oPendingOpDeferred;
     };
 
     /**