@sapui5/sap.ushell 1.124.3 → 1.126.0

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

@@ -14,22 +14,26 @@
  *
  * This is *not* an application facing service, but for Shell Internal usage.
  *
- * @version 1.124.3
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/base/Log",
     "sap/base/util/deepExtend",
     "sap/base/util/ObjectPath",
-    "sap/ui/thirdparty/jquery"
+    "sap/ui/thirdparty/jquery",
+    "sap/ushell/Container",
+    "sap/ushell/utils"
 ], function (
     Log,
     deepExtend,
     ObjectPath,
-    jQuery
+    jQuery,
+    Container,
+    ushellUtils
 ) {
     "use strict";
 
-    var aValidProperties = [
+    const aValidProperties = [
         "value", // the single value
         "extendedValue", // the extended value
         "noEdit", // boolean, indicates the property should be hidden from editor
@@ -67,9 +71,9 @@ sap.ui.define([
     }
 
     UserDefaultParameterPersistence.prototype._cleanseValue = function (oValue) {
-        var oResult = deepExtend({}, oValue);
+        const oResult = deepExtend({}, oValue);
 
-        for (var a in oResult) {
+        for (const a in oResult) {
             if (oResult.hasOwnProperty(a) && aValidProperties.indexOf(a) < 0) {
                 delete oResult[a];
             }
@@ -86,13 +90,13 @@ sap.ui.define([
      * @since 1.81.0
      * @private
      */
-    UserDefaultParameterPersistence.prototype._getSystemContextPromise = function (oSystemContext) {
+    UserDefaultParameterPersistence.prototype._getSystemContextPromise = async function (oSystemContext) {
         if (!oSystemContext) {
             Log.warning("UserDefaultParameterPersistence: The systemContext was not provided, using defaultSystemContext as fallback");
-            return sap.ushell.Container.getServiceAsync("ClientSideTargetResolution")
-                .then(function (oCSTR) {
-                    return oCSTR.getSystemContext();
-                });
+
+            const ClientSideTargetResolution = await Container.getServiceAsync("ClientSideTargetResolution");
+
+            return ClientSideTargetResolution.getSystemContext();
         }
         return Promise.resolve(oSystemContext);
     };
@@ -110,30 +114,32 @@ sap.ui.define([
      * @private
      */
     UserDefaultParameterPersistence.prototype.loadParameterValue = function (sParameterName, oSystemContext) {
-        var oDeferred = new jQuery.Deferred();
+        const oDeferred = new jQuery.Deferred();
 
-        this._getSystemContextPromise(oSystemContext).then(function (oSystemContext) {
-            var sValue = ObjectPath.get([oSystemContext.id, sParameterName], this._oData);
+        this._getSystemContextPromise(oSystemContext)
+            .then(async (oSystemContext) => {
+                const sValue = ObjectPath.get([oSystemContext.id, sParameterName], this._oData);
 
-            if (sValue !== undefined) {
-                oDeferred.resolve(sValue);
-            } else {
-                this._oAdapter.loadParameterValue(sParameterName, oSystemContext)
-                    .done(function (oValue) {
-                        var oCleansedValue = this._cleanseValue(oValue);
+                if (sValue !== undefined) {
+                    return sValue;
+                }
 
-                        ObjectPath.set([oSystemContext.id, sParameterName], oCleansedValue, this._oData);
+                return ushellUtils.promisify(this._oAdapter.loadParameterValue(sParameterName, oSystemContext)).then((oValue) => {
+                    const oCleansedValue = this._cleanseValue(oValue);
 
-                        Log.debug(
-                            "[UserDefaults] Fetched \"" + sParameterName + "\" for SystemContext=" + oSystemContext.id + " from Persistence",
-                            JSON.stringify(oCleansedValue, null, 2)
-                        );
+                    ObjectPath.set([oSystemContext.id, sParameterName], oCleansedValue, this._oData);
 
-                        oDeferred.resolve(oCleansedValue);
-                    }.bind(this))
-                    .fail(oDeferred.reject.bind(this));
-            }
-        }.bind(this));
+                    Log.debug(`[UserDefaults] Fetched "${ sParameterName }" for SystemContext=${ oSystemContext.id } from Persistence`, JSON.stringify(oCleansedValue, null, 2));
+
+                    return oCleansedValue;
+                });
+            })
+            .then((oValue) => {
+                oDeferred.resolve(oValue);
+            })
+            .catch((sError) => {
+                oDeferred.reject(sError);
+            });
 
         return oDeferred.promise();
     };
@@ -151,37 +157,34 @@ sap.ui.define([
      * @public
      */
     UserDefaultParameterPersistence.prototype.saveParameterValue = function (sParameterName, oValueObject, oSystemContext) {
-        var oDeferred = new jQuery.Deferred();
-        var oCleansedValueObject;
-
-        this._getSystemContextPromise(oSystemContext).then(function (oSystemContext) {
-            if (!oValueObject) {
-                return this.deleteParameter(sParameterName, oSystemContext)
-                    .done(oDeferred.resolve)
-                    .fail(oDeferred.reject);
-            }
+        const oDeferred = new jQuery.Deferred();
+        let oCleansedValueObject;
 
-            oCleansedValueObject = this._cleanseValue(oValueObject);
+        this._getSystemContextPromise(oSystemContext)
+            .then((oSystemContext) => {
+                if (!oValueObject) {
+                    return ushellUtils.promisify(this.deleteParameter(sParameterName, oSystemContext));
+                }
 
-            if (oValueObject && oValueObject.noStore === true) {
-                Log.debug(
-                    "[UserDefaults] Skipped Save \"" + sParameterName + "\" for SystemContext=" + oSystemContext.id,
-                    "noStore=true"
-                );
+                oCleansedValueObject = this._cleanseValue(oValueObject);
 
-                return oDeferred.resolve();
-            }
+                if (oValueObject && oValueObject.noStore === true) {
+                    Log.debug(`[UserDefaults] Skipped Save "${ sParameterName }" for SystemContext=${ oSystemContext.id}`, "noStore=true");
+
+                    return;
+                }
 
-            Log.debug(
-                "[UserDefaults] Saving \"" + sParameterName + "\" for SystemContext=" + oSystemContext.id + " to Persistence",
-                JSON.stringify(oCleansedValueObject, null, 2)
-            );
+                Log.debug(`[UserDefaults] Saving "${ sParameterName }" for SystemContext=${ oSystemContext.id } to Persistence`, JSON.stringify(oCleansedValueObject, null, 2));
 
-            ObjectPath.set([oSystemContext.id, sParameterName], oCleansedValueObject, this._oData);
-            return this._oAdapter.saveParameterValue(sParameterName, oCleansedValueObject, oSystemContext)
-                .done(oDeferred.resolve)
-                .fail(oDeferred.reject);
-        }.bind(this));
+                ObjectPath.set([oSystemContext.id, sParameterName], oCleansedValueObject, this._oData);
+                return ushellUtils.promisify(this._oAdapter.saveParameterValue(sParameterName, oCleansedValueObject, oSystemContext));
+            })
+            .then((oValue) => {
+                oDeferred.resolve(oValue);
+            })
+            .catch((sError) => {
+                oDeferred.reject(sError);
+            });
 
         return oDeferred.promise();
     };
@@ -198,18 +201,23 @@ sap.ui.define([
      * @public
      */
     UserDefaultParameterPersistence.prototype.deleteParameter = function (sParameterName, oSystemContext) {
-        var oDeferred = new jQuery.Deferred();
-
-        this._getSystemContextPromise(oSystemContext).then(function (oSystemContext) {
-            if (this._oData[oSystemContext.id]) {
-                Log.debug("[UserDefaults] Deleting \"" + sParameterName + "\" for SystemContext=" + oSystemContext.id + " from Persistence");
-
-                delete this._oData[oSystemContext.id][sParameterName];
-            }
-            return this._oAdapter.deleteParameter(sParameterName, oSystemContext)
-                .done(oDeferred.resolve)
-                .fail(oDeferred.reject);
-        }.bind(this));
+        const oDeferred = new jQuery.Deferred();
+
+        this._getSystemContextPromise(oSystemContext)
+            .then((oSystemContext) => {
+                if (this._oData[oSystemContext.id]) {
+                    Log.debug(`[UserDefaults] Deleting "${ sParameterName }" for SystemContext=${ oSystemContext.id } from Persistence`);
+
+                    delete this._oData[oSystemContext.id][sParameterName];
+                }
+                return ushellUtils.promisify(this._oAdapter.deleteParameter(sParameterName, oSystemContext));
+            })
+            .then((oValue) => {
+                oDeferred.resolve(oValue);
+            })
+            .catch((sError) => {
+                oDeferred.reject(sError);
+            });
 
         return oDeferred.promise();
     };
@@ -224,16 +232,19 @@ sap.ui.define([
      * @private
      */
     UserDefaultParameterPersistence.prototype.getStoredParameterNames = function (oSystemContext) {
-        var oDeferred = new jQuery.Deferred();
-
-        this._getSystemContextPromise(oSystemContext).then(function (oSystemContext) {
-            this._oAdapter.getStoredParameterNames(oSystemContext)
-                .done(function (aRes) {
-                    aRes.sort();
-                    oDeferred.resolve(aRes);
-                })
-                .fail(oDeferred.reject.bind(oDeferred));
-        }.bind(this));
+        const oDeferred = new jQuery.Deferred();
+
+        this._getSystemContextPromise(oSystemContext)
+            .then((oSystemContext) => {
+                return ushellUtils.promisify(this._oAdapter.getStoredParameterNames(oSystemContext));
+            })
+            .then((aRes) => {
+                aRes.sort();
+                oDeferred.resolve(aRes);
+            })
+            .catch((sError) => {
+                oDeferred.reject(sError);
+            });
 
         return oDeferred.promise();
     };