From 3acf394d052f9ac6fe151cb9b64703735f79ed72 Mon Sep 17 00:00:00 2001
From: cahrens <christina@edx.org>
Date: Mon, 16 Jun 2014 16:31:46 -0400
Subject: [PATCH] Wait for scripts defined in common xmodule code to execute.

STUD-1792
---
 cms/templates/container.html                  | 19 ++++++------
 cms/templates/edit-tabs.html                  | 20 +++++++------
 cms/templates/unit.html                       | 30 ++++++++++---------
 .../pipeline_js/templates/xmodule.js          | 13 ++++++--
 4 files changed, 47 insertions(+), 35 deletions(-)

diff --git a/cms/templates/container.html b/cms/templates/container.html
index 0062d91628..4ae77e6601 100644
--- a/cms/templates/container.html
+++ b/cms/templates/container.html
@@ -32,19 +32,18 @@ main_xblock_info = {
 <script type='text/javascript'>
     require(["domReady!", "jquery", "js/models/xblock_info", "js/views/pages/container",
         "js/collections/component_template", "xmodule", "coffee/src/main", "xblock/cms.runtime.v1"],
-            function(doc, $, XBlockInfo, ContainerPage, ComponentTemplates) {
-                var view, mainXBlockInfo;
-
+            function(doc, $, XBlockInfo, ContainerPage, ComponentTemplates, xmoduleLoader) {
                 var templates = new ComponentTemplates(${component_templates | n}, {parse: true});
+                var mainXBlockInfo = new XBlockInfo(${json.dumps(main_xblock_info) | n});
 
-                mainXBlockInfo = new XBlockInfo(${json.dumps(main_xblock_info) | n});
-
-                view = new ContainerPage({
-                    el: $('#content'),
-                    model: mainXBlockInfo,
-                    templates: templates
+                xmoduleLoader.done(function () {
+                    var view = new ContainerPage({
+                        el: $('#content'),
+                        model: mainXBlockInfo,
+                        templates: templates
+                    });
+                    view.render();
                 });
-                view.render();
             });
 </script>
 
diff --git a/cms/templates/edit-tabs.html b/cms/templates/edit-tabs.html
index 1c5adf846c..bc1a4294ae 100644
--- a/cms/templates/edit-tabs.html
+++ b/cms/templates/edit-tabs.html
@@ -21,16 +21,18 @@
 <script type='text/javascript'>
     require(["js/models/explicit_url", "coffee/src/views/tabs",
         "xmodule", "coffee/src/main", "xblock/cms.runtime.v1"],
-            function (TabsModel, TabsEditView) {
-                var model = new TabsModel({
-                    id: "${context_course.location}",
-                    explicit_url: "${reverse('contentstore.views.tabs_handler', kwargs={'course_key_string': context_course.id})}"
-                });
+            function (TabsModel, TabsEditView, xmoduleLoader) {
+                xmoduleLoader.done(function () {
+                    var model = new TabsModel({
+                        id: "${context_course.location}",
+                        explicit_url: "${reverse('contentstore.views.tabs_handler', kwargs={'course_key_string': context_course.id})}"
+                    });
 
-                new TabsEditView({
-                    el: $('.tab-list'),
-                    model: model,
-                    mast: $('.wrapper-mast')
+                    new TabsEditView({
+                        el: $('.tab-list'),
+                        model: model,
+                        mast: $('.wrapper-mast')
+                    });
                 });
             });
   </script>
diff --git a/cms/templates/unit.html b/cms/templates/unit.html
index 4ed9e5ba2a..f28075a1ca 100644
--- a/cms/templates/unit.html
+++ b/cms/templates/unit.html
@@ -21,25 +21,27 @@ from django.utils.translation import ugettext as _
 <%block name="jsextra">
   <script type='text/javascript'>
 require(["domReady!", "jquery", "js/models/module_info", "coffee/src/views/unit", "js/collections/component_template",
-    "jquery.ui", "xmodule", "coffee/src/main", "xblock/cms.runtime.v1"],
-    function(doc, $, ModuleModel, UnitEditView, ComponentTemplates) {
+    "xmodule", "jquery.ui", "coffee/src/main", "xblock/cms.runtime.v1"],
+    function(doc, $, ModuleModel, UnitEditView, ComponentTemplates, xmoduleLoader) {
   window.unit_location_analytics = '${unit_usage_key}';
 
   var templates = new ComponentTemplates(${component_templates | n}, {parse: true});
 
-  new UnitEditView({
-    el: $('.main-wrapper'),
-    view: 'unit',
-    model: new ModuleModel({
-      id: '${unit_usage_key}',
-      state: '${unit_state}'
-    }),
-    templates: templates
-  });
+  xmoduleLoader.done(function () {
+      new UnitEditView({
+        el: $('.main-wrapper'),
+        view: 'unit',
+        model: new ModuleModel({
+          id: '${unit_usage_key}',
+          state: '${unit_state}'
+        }),
+        templates: templates
+      });
 
-  $('.new-component-template').each(function(){
-      $emptyEditor = $(this).find('.empty');
-      $(this).prepend($emptyEditor);
+      $('.new-component-template').each(function(){
+          $emptyEditor = $(this).find('.empty');
+          $(this).prepend($emptyEditor);
+      });
   });
 });
   </script>
diff --git a/common/djangoapps/pipeline_js/templates/xmodule.js b/common/djangoapps/pipeline_js/templates/xmodule.js
index 4dedffd04a..4004342145 100644
--- a/common/djangoapps/pipeline_js/templates/xmodule.js
+++ b/common/djangoapps/pipeline_js/templates/xmodule.js
@@ -21,8 +21,17 @@ define(["jquery", "underscore", "mathjax", "codemirror", "tinymce",
 
     var urls = ${urls};
     var head = $("head");
-    $.each(urls, function(i, url) {
+    var deferred = $.Deferred();
+    var numResources = urls.length;
+    $.each(urls, function (i, url) {
         head.append($("<script/>", {src: url}));
+        // Wait for all the scripts to execute.
+        require([url], function () {
+            if (i === numResources - 1) {
+               deferred.resolve();
+            }
+        });
     });
-    return window.XModule;
+
+    return deferred.promise();
 });