RenderJS: prepares communication with parent gadget only if communication channel is ready

It removes communication timeout with parent iFrame and solve the issue of timeout in case of a high load due to heavy JS processing
/reviewed-on !2

renderjs.js

@@ -1020,7 +1020,11 @@
       notifyDeclareMethod,
       gadget_ready = false,
       iframe_top_gadget,
-      last_acquisition_gadget;
+      last_acquisition_gadget,
+      declare_method_list_waiting = [],
+      gadget_failed = false,
+      gadget_error,
+      connection_ready = false;
 
     // Create the gadget class for the current url
     if (gadget_model_dict.hasOwnProperty(url)) {
@@ -1079,28 +1083,45 @@
         setAqParent(root_gadget, last_acquisition_gadget);
 
       } else {
-        // Create the communication channel
-        embedded_channel = Channel.build({
-          window: window.parent,
-          origin: "*",
-          scope: "renderJS"
-        });
         // Create the root gadget instance and put it in the loading stack
         tmp_constructor = RenderJSEmbeddedGadget;
         tmp_constructor.__ready_list = RenderJSGadget.__ready_list.slice();
         tmp_constructor.__service_list = RenderJSGadget.__service_list.slice();
         tmp_constructor.prototype.__path = url;
         root_gadget = new RenderJSEmbeddedGadget();
+        setAqParent(root_gadget, last_acquisition_gadget);
 
-
-        // Notify parent about gadget instanciation
-        notifyReady = function () {
-          if ((declare_method_count === 0) && (gadget_ready === true)) {
-            embedded_channel.notify({method: "ready"});
-          }
+        // Create the communication channel
+        embedded_channel = Channel.build({
+          window: window.parent,
+          origin: "*",
+          scope: "renderJS",
+          onReady: function () {
+            var k;
+            iframe_top_gadget = false;
+            //Default: Define __aq_parent to inform parent window
+            root_gadget.__aq_parent =
+              tmp_constructor.prototype.__aq_parent = function (method_name,
+                argument_list, time_out) {
+                return new RSVP.Promise(function (resolve, reject) {
+                  embedded_channel.call({
+                    method: "acquire",
+                    params: [
+                      method_name,
+                      argument_list
+                    ],
+                    success: function (s) {
+                      resolve(s);
+                    },
+                    error: function (e) {
+                      reject(e);
+                    },
+                    timeout: time_out
+                  });
+                });
               };
 
-        // Inform parent gadget about declareMethod calls here.
+            // Channel is ready, so now declare Function
             notifyDeclareMethod = function (name) {
               declare_method_count += 1;
               embedded_channel.call({
@@ -1115,6 +1136,56 @@
                 }
               });
             };
+            for (k = 0; k < declare_method_list_waiting.length; k += 1) {
+              notifyDeclareMethod(declare_method_list_waiting[k]);
+            }
+            declare_method_list_waiting = [];
+            // If Gadget Failed Notify Parent
+            if (gadget_failed) {
+              embedded_channel.notify({
+                method: "failed",
+                params: gadget_error
+              });
+              return;
+            }
+            // Get Top URL
+            return tmp_constructor.prototype.__aq_parent('getTopURL', [])
+              .then(function (topURL) {
+                var base = document.createElement('base');
+                base.href = topURL;
+                base.target = "_top";
+                document.head.appendChild(base);
+                connection_ready = true;
+                notifyReady();
+                //the channel is ok
+                //so bind calls to renderJS method on the instance
+                embedded_channel.bind("methodCall", function (trans, v) {
+                  root_gadget[v[0]].apply(root_gadget, v[1])
+                    .then(function (g) {
+                      trans.complete(g);
+                    }).fail(function (e) {
+                      trans.error(e.toString());
+                    });
+                  trans.delayReturn(true);
+                });
+              })
+              .fail(function (error) {
+                throw error;
+              });
+          }
+        });
+
+        // Notify parent about gadget instanciation
+        notifyReady = function () {
+          if ((declare_method_count === 0) && (gadget_ready === true)) {
+            embedded_channel.notify({method: "ready"});
+          }
+        };
+
+        // Inform parent gadget about declareMethod calls here.
+        notifyDeclareMethod = function (name) {
+          declare_method_list_waiting.push(name);
+        };
 
         notifyDeclareMethod("getInterfaceList");
         notifyDeclareMethod("getRequiredCSSList");
@@ -1139,26 +1210,7 @@
         tmp_constructor.allowPublicAcquisition =
           RenderJSGadget.allowPublicAcquisition;
 
-        //Default: Define __aq_parent to inform parent window
-        tmp_constructor.prototype.__aq_parent = function (method_name,
-          argument_list, time_out) {
-          return new RSVP.Promise(function (resolve, reject) {
-            embedded_channel.call({
-              method: "acquire",
-              params: [
-                method_name,
-                argument_list
-              ],
-              success: function (s) {
-                resolve(s);
-              },
-              error: function (e) {
-                reject(e);
-              },
-              timeout: time_out
-            });
-          });
-        };
+        iframe_top_gadget = true;
       }
 
       tmp_constructor.prototype.__acquired_method_dict = {};
@@ -1283,45 +1335,6 @@
           return root_gadget;
         }
 
-        if (window.top !== window.self) {
-          //checking channel should be done before sub gadget's declaration
-          //__ready_list:
-          //0: clearGadgetInternalParameters
-          //1: loadSubGadgetDOMDeclaration
-          //.....
-          tmp_constructor.__ready_list.splice(1, 0, function () {
-            return root_gadget.__aq_parent('getTopURL', [], 100)
-              .then(function (topURL) {
-                var base = document.createElement('base');
-                base.href = topURL;
-                base.target = "_top";
-                document.head.appendChild(base);
-                //the channel is ok
-                //so bind calls to renderJS method on the instance
-                embedded_channel.bind("methodCall", function (trans, v) {
-                  root_gadget[v[0]].apply(root_gadget, v[1])
-                    .then(function (g) {
-                      trans.complete(g);
-                    }).fail(function (e) {
-                      trans.error(e.toString());
-                    });
-                  trans.delayReturn(true);
-                });
-              })
-              .fail(function (error) {
-                if (error === "timeout_error") {
-                  //the channel fail
-                  //we consider current gadget is parent gadget
-                  //redifine last acquisition gadget
-                  iframe_top_gadget = true;
-                  setAqParent(root_gadget, last_acquisition_gadget);
-                } else {
-                  throw error;
-                }
-              });
-          });
-        }
-
         tmp_constructor.ready(function (g) {
           return startService(g);
         });
@@ -1346,11 +1359,15 @@
       loading_gadget_promise
         .then(function () {
           gadget_ready = true;
+          if (connection_ready) {
             notifyReady();
+          }
         })
         .fail(function (e) {
           //top gadget in iframe
           if (iframe_top_gadget) {
+            gadget_failed = true;
+            gadget_error = e.toString();
             letsCrash(e);
           } else {
             embedded_channel.notify({method: "failed", params: e.toString()});

test/embedded_heavy.html

+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+      "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+    <title>Embedded page for renderJS test</title>
+    <meta name="viewport" content="width=device-width, height=device-height"/>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <script src="../node_modules/rsvp/dist/rsvp-2.0.4.js" type="text/javascript"></script>
+    <script src="../dist/renderjs-latest.js" type="text/javascript"></script>
+    <script src="./embedded_heavy.js" type="text/javascript"></script>
+  </head>
+  <body>
+  </body>
+</html>