@qooxdoo/framework 7.8.0 → 7.9.0

package/source/class/qx/core/Environment.js

@@ -891,6 +891,7 @@ qx.Bootstrap.define("qx.core.Environment", {
       "qx.dynlocale": true,
       "qx.dyntheme": true,
       "qx.blankpage": "qx/static/blank.html",
+      "qx.data.marshal.Json.breakOnNonPojos": false,
       "qx.debug.databinding": false,
       "qx.debug.dispose": false,
       "qx.debug.startupTimings": false,

package/source/class/qx/data/marshal/Json.js

@@ -37,6 +37,10 @@ qx.Class.define("qx.data.marshal.Json", {
   },
 
   statics: {
+    /**
+     * Set to true when a warning has been shown that we are using the deprecated behaviour of trying to marshall non-POJO objects into Qooxdoo objects.
+     */
+    __shownNotBreakingOnNonPojosWarning: false,
     $$instance: null,
 
     /**
@@ -76,6 +80,25 @@ qx.Class.define("qx.data.marshal.Json", {
         Object.keys(data).sort().join('"') +
         (includeBubbleEvents === true ? "♥" : "")
       );
+    },
+
+    /**
+     * If the environment setting "qx.data.marshal.Json.breakOnNonPojos" is not set,
+     * it means we are using the old behaviour of marshalling non-POJO objects.
+     * A warning is shown if it hasn't been shown already.
+     */
+    checkIfWarnAboutNotBreakingOnNonPojos() {
+      if (
+        !qx.core.Environment.get("qx.data.marshal.Json.breakOnNonPojos") &&
+        !this.__shownNotBreakingOnNonPojosWarning
+      ) {
+        console.warn(
+          `Using deprecated behaviour of not breaking on non-POJOs when marshalling.
+          Please set the environment setting "qx.data.marshal.Json.breakOnNonPojos" to enable the new behaviour.
+          The old behaviour will be removed in the next major release of Qooxdoo.`
+        );
+        this.__shownNotBreakingOnNonPojosWarning = true;
+      }
     }
   },
 
@@ -170,12 +193,26 @@ qx.Class.define("qx.data.marshal.Json", {
      * @param depth {Number} The depth of the data relative to the data's root.
      */
     __toClass(data, includeBubbleEvents, parentProperty, depth) {
+      const breakOnNonPojos = qx.core.Environment.get(
+        "qx.data.marshal.Json.breakOnNonPojos"
+      );
+      this.constructor.checkIfWarnAboutNotBreakingOnNonPojos();
+
       // break on all primitive json types and qooxdoo objects
-      if (
-        !qx.lang.Type.isObject(data) ||
-        !!data.$$isString || // check for localized strings
-        data instanceof qx.core.Object
-      ) {
+      let shouldBreak;
+      if (breakOnNonPojos) {
+        shouldBreak =
+          !qx.lang.Type.isPojo(data) ||
+          !!data.$$isString || // check for localized strings
+          data instanceof qx.core.Object;
+      } else {
+        shouldBreak =
+          !qx.lang.Type.isObject(data) ||
+          !!data.$$isString || // check for localized strings
+          data instanceof qx.core.Object;
+      }
+
+      if (shouldBreak) {
         // check for arrays
         if (data instanceof Array || qx.Bootstrap.getClass(data) == "Array") {
           for (var i = 0; i < data.length; i++) {
@@ -405,15 +442,31 @@ qx.Class.define("qx.data.marshal.Json", {
      * @return {qx.core.Object} The created model object.
      */
     __toModel(data, includeBubbleEvents, parentProperty, depth) {
+      const breakOnNonPojos = qx.core.Environment.get(
+        "qx.data.marshal.Json.breakOnNonPojos"
+      );
+      this.constructor.checkIfWarnAboutNotBreakingOnNonPojos();
+
       var isObject = qx.lang.Type.isObject(data);
+      var isPojo = qx.lang.Type.isPojo(data);
+
       var isArray =
         data instanceof Array || qx.Bootstrap.getClass(data) == "Array";
 
-      if (
-        (!isObject && !isArray) ||
-        !!data.$$isString || // check for localized strings
-        data instanceof qx.core.Object
-      ) {
+      let shouldBreak;
+      if (breakOnNonPojos) {
+        shouldBreak =
+          (!isPojo && !isArray) ||
+          !!data.$$isString || // check for localized strings
+          data instanceof qx.core.Object;
+      } else {
+        shouldBreak =
+          (!isObject && !isArray) ||
+          !!data.$$isString || // check for localized strings
+          data instanceof qx.core.Object;
+      }
+
+      if (shouldBreak) {
         return data;
 
         // ignore rules
@@ -451,7 +504,7 @@ qx.Class.define("qx.data.marshal.Json", {
           );
         }
         return array;
-      } else if (isObject) {
+      } else if (breakOnNonPojos ? isPojo : isObject) {
         // create an instance for the object
         var hash = this.__jsonToBestHash(data, includeBubbleEvents);
         var model = this.__createInstance(hash, data, parentProperty, depth);

package/source/class/qx/lang/Type.js

@@ -52,15 +52,48 @@ qx.Bootstrap.define("qx.lang.Type", {
     isArray: qx.Bootstrap.isArray,
 
     /**
-     * Whether the value is an object. Note that built-in types like Window are
-     * not reported to be objects.
      *
+     * Whether the value is an POJO (ie {})
+     * or an object which is created from a ES6-style class or prototypical-inheritance-based class;
+     * if you need to determine whether something is a POJO and not created from a class, use isPojo instead
+     *
+     * Note that built-in types like Window are not deemed to be objects.
      * @signature function(value)
-     * @param value {var} Value to check.
+     * @param {*} value value to check.
      * @return {Boolean} Whether the value is an object.
      */
     isObject: qx.Bootstrap.isObject,
 
+    /**
+     * Whether the value is strictly a POJO.
+     * Its prototype chain must not contain any constructors which are not the Object constructor i.e. traditional prototype-based classes or ES6 classes.
+     *
+     * @param {*} value
+     * @returns {Boolean} Whether the value is strictly a POJO.
+     */
+    isPojo(value) {
+      if (qx.Bootstrap.getClass(value) != "Object") {
+        return false;
+      }
+
+      let prototype = Object.getPrototypeOf(value);
+      while (true) {
+        if (prototype === Object.prototype) {
+          return true;
+        }
+
+        if (
+          prototype.constructor &&
+          prototype.constructor !== Object.prototype.constructor
+        ) {
+          return false;
+        }
+
+        //loop tail
+        prototype = Object.getPrototypeOf(prototype);
+      }
+    },
+
     /**
      * Whether the value is a function.
      *