@qooxdoo/framework 7.0.0-beta.2 → 7.0.0-beta.6

package/source/class/qx/io/exception/Exception.js

@@ -0,0 +1,38 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2020 Christian Boulanger
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * Christian Boulanger (cboulanger)
+
+************************************************************************ */
+
+/**
+ * A generic class for representing exceptions that occur during io operations.
+ */
+qx.Class.define("qx.io.exception.Exception",
+{
+  extend : qx.type.BaseError,
+
+  /**
+   * Constructor
+   * @param message {String}
+   * @param code {Number}
+   * @param data {*|null}
+   */
+  construct: function(message, code, data) {
+    this.base(arguments, "", message);
+    this.code = code;
+    this.data = data;
+    this.name = this.classname;
+  }
+});

package/source/class/qx/{tool/compiler/Version.js → io/exception/Protocol.js}

@@ -4,17 +4,23 @@
 
    http://qooxdoo.org
 
+   Copyright:
+     2020 Christian Boulanger
+
    License:
      MIT: https://opensource.org/licenses/MIT
      See the LICENSE file in the project's top-level directory for details.
 
+   Authors:
+     * Christian Boulanger (cboulanger)
+
 ************************************************************************ */
+
 /**
- * NOTE: This is automatically generated by bootstrap-compiler.js
-*/
-qx.Class.define("qx.tool.compiler.Version", {
-  extend: qx.core.Object,
-  statics: {
-    VERSION: "7.0.0-beta.2"
-  }
+ * A class for representing errors that occurred on server and are handled
+ * according to the service protocol (JSON-RPC, GraphQL, etc.)
+ */
+qx.Class.define("qx.io.exception.Protocol",
+{
+  extend : qx.io.exception.Exception
 });

package/source/class/qx/io/exception/Transport.js

@@ -0,0 +1,39 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2020 Christian Boulanger
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * Christian Boulanger (cboulanger)
+
+************************************************************************ */
+
+/**
+ *  A class for representing errors that occurred during the request transport.
+ *  In the context of HTTP requests, the error code is the HTTP error code.
+ */
+qx.Class.define("qx.io.exception.Transport",
+{
+  extend : qx.io.exception.Exception,
+  statics: {
+    TIMEOUT          : 1,
+    ABORTED          : 2,
+    NO_DATA          : 3,
+    INVALID_MSG_DATA : 4,
+    CANCELLED        : 5,
+    INVALID_URI      : 6,
+    FAILED           : 7,
+    INVALID_ID       : 8, // JSON-RPC
+    INVALID_JSON     : 9, // JSON-RPC
+    DUPLICATE_ID     : 10, // JSON-RPC
+    UNKNOWN_ID       : 11 // JSON-RPC
+  }
+});

package/source/class/qx/io/exception/__init__.js

@@ -0,0 +1,4 @@
+/**
+ * This namespace contains exceptions that can be used by the various
+ * communication protocols in the `qx.io` namespace
+ */

package/source/class/qx/io/graphql/Client.js

@@ -0,0 +1,112 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+      2020 Christian Boulanger
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * Christian Boulanger (cboulanger)
+
+************************************************************************ */
+
+/**
+ * This class provides a simple GraphQl client (https://graphql.org/).
+ * For transport, it is based on internally on the fetch API
+ * (https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch)
+ * which, if needed, must be directly configured via the `init` parameter of the
+ * constructor, until a more generalized qx.io API has been developed.
+ * @experimental The API might change. Feedback is appreciated.
+ */
+qx.Class.define("qx.io.graphql.Client", {
+
+  extend: qx.io.transport.AbstractClient,
+
+  statics: {
+    registerTransport : qx.io.transport.AbstractClient.registerTransport
+  },
+
+  events: {
+    /**
+     * Event fired when a request results in an error. Event data is an instance of
+     * {@link qx.io.exception.Transport}, {@link qx.io.exception.Protocol},
+     * or {@link qx.io.exception.Cancel}.
+     */
+    "error" : "qx.event.type.Data"
+  },
+
+  /**
+   * @param {qx.io.transport.ITransport|String} transportOrUri
+   *    Transport object, which must implement {@link qx.io.transport.ITransport}
+   *    or a string URI, which will trigger auto-detection of transport, as long as an
+   *    appropriate transport has been registered with the static `registerTransport()` function.
+   */
+  construct: function (transportOrUri) {
+    this.base(arguments);
+    this.selectTransport(transportOrUri);
+  },
+
+  members: {
+
+    /**
+     * Send the given GraphQl query. See https://graphql.org/learn/queries/
+     *
+     * @param {qx.io.graphql.protocol.Request} request The GraphQl request object.
+     * @return {qx.Promise} Promise that resolves with the data
+     */
+    async send(request) {
+      let transport = this.getTransport();
+      return new qx.Promise((resolve, reject) => {
+        transport.addListenerOnce("message", evt => {
+          try{
+            if (qx.core.Environment.get("qx.io.graphql.debug")) {
+              this.debug( "<<< Received: " + evt.getData());
+            }
+            let responseData = qx.lang.Json.parse(evt.getData());
+            let graphQlResponse = new qx.io.graphql.protocol.Response(responseData);
+            if (graphQlResponse.getErrors()) {
+              return reject(this._handleErrors(graphQlResponse));
+            }
+            return resolve(graphQlResponse.getData());
+          } catch (e) {
+            this.error(e);
+            return reject(new qx.io.exception.Transport(e.message));
+          }
+        });
+        if (qx.core.Environment.get("qx.io.graphql.debug")) {
+          this.debug(">>>> Sending " + request.toString());
+        }
+        transport.send(request.toString()).catch(reject);
+      });
+    },
+
+    /**
+     * Handle the errors reported by the GraphQL endpoint. The response
+     * can contain several errors, but we can only throw one of them.
+     * However, we can fire an event for each error, which might be useful
+     * if they are to be logged. The errors that are thrown or fired as
+     * event data contain the original response object in the `data` property
+     *
+     * @param {qx.io.graphql.protocol.Response} response The response object
+     * @return {qx.io.exception.Protocol}
+     */
+    _handleErrors(response) {
+      let errors = response.getErrors();
+      errors.forEach(error => {
+        let exception = new qx.io.exception.Protocol(error.message, null, response.toObject());
+        this.fireDataEvent("error", exception);
+      });
+      return new qx.io.exception.Protocol(errors[0].message, null, response.toObject());
+    }
+  },
+
+  environment: {
+    "qx.io.graphql.debug" : false
+  }
+});

package/source/class/qx/io/graphql/__init__.js

@@ -0,0 +1,9 @@
+/**
+ * This namespace provides a simple GraphQL client.
+ *
+ * Not implemented:
+ * - batched requests (https://www.apollographql.com/blog/batching-client-graphql-queries-a685f5bcd41b/)
+ * - subscriptions (http://spec.graphql.org/draft/#sec-Subscription)
+ *
+ * @experimental The API might change. Feedback is appreciated.
+ */

package/source/class/qx/io/graphql/protocol/Message.js

@@ -0,0 +1,65 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+      2020 Christian Boulanger
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * Christian Boulanger (cboulanger)
+
+************************************************************************ */
+
+/**
+ * Abstract parent class for GraphQL messages and responses
+ * @experimental The API might change. Feedback is appreciated.
+ */
+qx.Class.define("qx.io.graphql.protocol.Message", {
+  extend: qx.core.Object,
+
+  /**
+   * Constructor
+   * @param {Object} data
+   */
+  construct: function(data) {
+    this.base(arguments);
+    qx.core.Assert.assertObject(data);
+    this.set(data);
+  },
+
+  members : {
+    /**
+     * Return the message data in a spec-conformant native object
+     */
+    toNormalizedObject() {
+      let data = this.toObject();
+      if (!data.errors) {
+        delete data.errors;
+      }
+      return data;
+    },
+
+    /**
+     * Serialize to a spec-conformant JSON string
+     * @return {String}
+     */
+    toString() {
+      return qx.lang.Json.stringify(this.toNormalizedObject());
+    },
+
+    /**
+     * Serialize to a native javascript object. If you need a normalized object
+     * that conforms to the spec, use {@link #toNormalizedObject}
+     * @return {Object}
+     */
+    toObject() {
+      return qx.util.Serializer.toNativeObject(this);
+    }
+  }
+});

package/source/class/qx/io/graphql/protocol/Request.js

@@ -0,0 +1,95 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+      2020 Christian Boulanger
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * Christian Boulanger (cboulanger)
+
+************************************************************************ */
+
+/**
+ * An Object modelling a GraphQL request based on the GraphQL language
+ * (see http://spec.graphql.org/draft/#sec-Language) usually sent as JSON via
+ * a HTTP request (https://graphql.org/learn/serving-over-http)
+ * @experimental The API might change. Feedback is appreciated.
+ */
+qx.Class.define("qx.io.graphql.protocol.Request",{
+  extend: qx.io.graphql.protocol.Message,
+  properties: {
+
+    /**
+     * An optional field that only needs to be provided if multiple operations are present in the query
+     */
+    operationName: {
+      check:"String",
+      nullable: true,
+      event: "changeOperationName"
+    },
+
+    /**
+     * The query as a string which will be parsed and executed on the server
+     */
+    query : {
+      check: "String",
+      nullable: false,
+      init: "",
+      event: "changeQuery"
+    },
+
+    /**
+     * A qooxdoo object that maps variable names to variable values
+     */
+    variables : {
+      check: "qx.core.Object",
+      nullable: true,
+      event: "changeVariables",
+      transform: "_transformVariables",
+      validate: "_validateVariables"
+    }
+  },
+
+  members: {
+    // overriden
+    toString() {
+      return qx.lang.Json.stringify(this.toObject(), this._jsonReplacer);
+    },
+
+    _jsonReplacer: function(key, value) {
+      if (key === "variables" || key === "operationName") {
+        return value !== null ? value : undefined;
+      }
+      // everything else is returned as it is
+      return value;
+    },
+
+
+    /**
+     * Transforms the variables object to a qooxdoo model. Called automaticaly
+     * when the variables property is set.
+     */
+    _transformVariables: function(val) {
+      let model = null;
+      if (![null, undefined].includes(val)) {
+        model = qx.data.marshal.Json.createModel(val);
+      }
+      return model;
+    },
+
+    _validateVariables: function(val) {
+      if (!qx.lang.Type.isObject(val) && (val !== null)) {
+        throw new qx.core.ValidationError(
+          "Validation Error: " + val + " is not an object or null."
+        );
+      }
+    }
+  }
+});

package/source/class/qx/io/graphql/protocol/Response.js

@@ -0,0 +1,61 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+      2020 Christian Boulanger
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * Christian Boulanger (cboulanger)
+
+************************************************************************ */
+
+/**
+ * An Object modelling a GraphQL response (see http://spec.graphql.org/draft/#sec-Response-Format)
+ * @experimental The API might change. Feedback is appreciated.
+ */
+qx.Class.define("qx.io.graphql.protocol.Response",{
+  extend: qx.io.graphql.protocol.Message,
+
+  properties: {
+
+    /**
+     * "The data entry in the response will be the result of the execution
+     * of the requested operation. If the operation was a query, this
+     * output will be an object of the schema’s query root type; if the
+     * operation was a mutation, this output will be an object of the
+     * schema’s mutation root type. If an error was encountered before
+     * execution begins, the data entry should not be present in the result.
+     * If an error was encountered during the execution that prevented
+     * a valid response, the data entry in the response should be null"
+     */
+    data : {
+      check: "Object",
+      nullable: true,
+      init: null
+    },
+
+    /**
+     * "The errors entry in the response is a non‐empty list of errors,
+     * where each error is a map. If no errors were encountered during
+     * the requested operation, the errors entry should not be present in
+     * the result. If the data entry in the response is not present, the
+     * errors entry in the response must not be empty. It must contain
+     * at least one error. The errors it contains should indicate why no
+     * data was able to be returned. If the data entry in the response is
+     * present (including if it is the value null), the errors entry in the
+     * response may contain any errors that occurred during execution. If
+     * errors occurred during execution, it should contain those errors."
+     */
+    errors : {
+      check: value => qx.lang.Type.isArray(value) && value.length && value.every(item => Boolean(item.message)),
+      nullable: true
+    }
+  }
+});

package/source/class/qx/io/graphql/protocol/__init__.js

@@ -0,0 +1,6 @@
+/**
+ * This namespace contains objects implementing message objects that model
+ * the GraphQL specification (http://spec.graphql.org/draft/)
+ *
+ * @experimental The API might change. Feedback is appreciated.
+ */