Add reportGadgetDeclarationError acquired method.

This can be used to catched loading errors from HTML gadget declaration. This will prevent the parent gadget to fail.

Add reportGadgetDeclarationError acquired method.
This can be used to catched loading errors from HTML gadget declaration. This will prevent the parent gadget to fail.
727a1ed8 · Romain Courteaud · 19ec19e9 · 727a1ed8 · 727a1ed8
Commit 727a1ed8 authored Jan 16, 2017 by Romain Courteaud
Show whitespace changes
Inline Side-by-side

Showing with 129 additions and 6 deletions

renderjs.js renderjs.js +24 -6

test/renderjs_test.js test/renderjs_test.js +105 -0

No files found.
--- a/renderjs.js
+++ b/renderjs.js
@@ -426,7 +426,20 @@
      scope,
      url,
      sandbox,
-      i;
+      i,
+      context = this;
+
+    function prepareReportGadgetDeclarationError(scope) {
+      return function (error) {
+        var aq_dict = context.__acquired_method_dict || {},
+          method_name = 'reportGadgetDeclarationError';
+        if (aq_dict.hasOwnProperty(method_name)) {
+          return aq_dict[method_name].apply(context,
+                                            [arguments, scope]);
+        }
+        throw error;
+      };
+    }

    for (i = 0; i < element_list.length; i += 1) {
      element = element_list[i];
@@ -434,11 +447,14 @@
      url = element.getAttribute("data-gadget-url");
      sandbox = element.getAttribute("data-gadget-sandbox");
      if (url !== null) {
-        promise_list.push(this.declareGadget(url, {
+        promise_list.push(
+          context.declareGadget(url, {
            element: element,
            scope: scope || undefined,
            sandbox: sandbox || undefined
-        }));
+          })
+            .push(undefined, prepareReportGadgetDeclarationError(scope))
+        );
      }
    }

@@ -664,6 +680,8 @@
    };
  RenderJSGadget.declareAcquiredMethod("aq_reportServiceError",
                                       "reportServiceError");
+  RenderJSGadget.declareAcquiredMethod("aq_reportGadgetDeclarationError",
+                                       "reportGadgetDeclarationError");

  /////////////////////////////////////////////////////////////////
  // RenderJSGadget.allowPublicAcquisition

--- a/test/renderjs_test.js
+++ b/test/renderjs_test.js
@@ -4327,6 +4327,9 @@
      html_url = 'https://example.org/files/qunittest/test12345.html',
      html_url2 = 'https://example.org/files/qunittest/test12346.html';
    gadget.__sub_gadget_dict = {};
+    gadget.__aq_parent = function (method_name, argument_list) {
+      throw new renderJS.AcquisitionError("Can not handle " + method_name);
+    };

    this.server.respondWith("GET", html_url, [200, {
      "Content-Type": "text/html"
@@ -4349,6 +4352,108 @@
      .always(start);
  });

+  test('can catch if declareGadget with scope in HTML fail', function () {
+    // Subclass RenderJSGadget to not pollute its namespace
+    var ParentKlass = function () {
+      RenderJSGadget.call(this);
+    },
+      gadget,
+      error_context,
+      // catched_error,
+      html_url = 'https://example.org/files/qunittest/test12345.html',
+      html_url2 = 'https://example.org/files/qunittest/test12346.html';
+    ParentKlass.prototype = new RenderJSGadget();
+    ParentKlass.prototype.constructor = ParentKlass;
+    ParentKlass.prototype.__acquired_method_dict = {};
+    ParentKlass.allowPublicAcquisition = RenderJSGadget.allowPublicAcquisition;
+
+    gadget = new ParentKlass();
+    gadget.__sub_gadget_dict = {};
+
+    this.server.respondWith("GET", html_url, [200, {
+      "Content-Type": "text/html"
+    }, "<html><body><div data-foo='bar' " +
+       "data-gadget-scope='foo' data-gadget-url='" + html_url2 +
+       "'></div></body></html>"]);
+    this.server.respondWith("GET", html_url2, [403, {
+      "Content-Type": "text/html"
+    }, "raw html"]);
+
+    stop();
+    expect(5);
+    renderJS.declareGadgetKlass(html_url)
+      .then(function (Klass) {
+        Klass.allowPublicAcquisition('reportGadgetDeclarationError',
+                                     function (argument_list, scope) {
+            var catched_error = argument_list[0];
+            error_context = this;
+            equal(catched_error.status, 403);
+            equal(catched_error.url, html_url2);
+            equal(scope, 'foo');
+          });
+        return gadget.declareGadget(html_url);
+      })
+      .then(function (result) {
+        deepEqual(result, error_context);
+        ok(true, 'Error correctly catched');
+      })
+      .fail(function (e) {
+        ok(false, "Error should have been catched");
+      })
+      .always(start);
+  });
+
+  test('can catch if declareGadget without scope in HTML fail', function () {
+    // Subclass RenderJSGadget to not pollute its namespace
+    var ParentKlass = function () {
+      RenderJSGadget.call(this);
+    },
+      gadget,
+      error_context,
+      // catched_error,
+      html_url = 'https://example.org/files/qunittest/test1234598.html',
+      html_url2 = 'https://example.org/files/qunittest/test1234698.html';
+    ParentKlass.prototype = new RenderJSGadget();
+    ParentKlass.prototype.constructor = ParentKlass;
+    ParentKlass.prototype.__acquired_method_dict = {};
+    ParentKlass.allowPublicAcquisition = RenderJSGadget.allowPublicAcquisition;
+
+    gadget = new ParentKlass();
+    gadget.__sub_gadget_dict = {};
+
+    this.server.respondWith("GET", html_url, [200, {
+      "Content-Type": "text/html"
+    }, "<html><body><div data-foo='bar' " +
+       "data-gadget-url='" + html_url2 +
+       "'></div></body></html>"]);
+    this.server.respondWith("GET", html_url2, [403, {
+      "Content-Type": "text/html"
+    }, "raw html"]);
+
+    stop();
+    expect(5);
+    renderJS.declareGadgetKlass(html_url)
+      .then(function (Klass) {
+        Klass.allowPublicAcquisition('reportGadgetDeclarationError',
+                                     function (argument_list, scope) {
+            var catched_error = argument_list[0];
+            error_context = this;
+            equal(catched_error.status, 403);
+            equal(catched_error.url, html_url2);
+            equal(scope, null);
+          });
+        return gadget.declareGadget(html_url);
+      })
+      .then(function (result) {
+        deepEqual(result, error_context);
+        ok(true, 'Error correctly catched');
+      })
+      .fail(function (e) {
+        ok(false, "Error should have been catched");
+      })
+      .always(start);
+  });
+
  /////////////////////////////////////////////////////////////////
  // RenderJSGadget.declareGadget (iframe)
  /////////////////////////////////////////////////////////////////