fixup! fixup! fix: refactor assets, settings/main, pages/index specs to not call AjaxHelpers inside it()

Author: feanil

cms/static/js/spec/views/assets_spec.js

@@ -11,6 +11,36 @@ function($, sinon, AjaxHelpers, URI, AssetsView, AssetCollection, ViewHelpers) {
         uploadModalTpl = readFixtures('asset-upload-modal.underscore');
 
         beforeEach(function() {
+            // Fake XHR must be installed BEFORE new AssetsView() for two reasons:
+            //
+            // 1. AssetsView.initialize() calls createPagingView() which immediately calls
+            //    pagingView.setPage(1), firing an AJAX request. If real XHR is active at that
+            //    point, the request goes to Karma's server which returns 404. Jasmine 2.x
+            //    schedules beforeEach and it() with setTimeout(0) between them, giving the
+            //    browser event loop a window to process pending async work. The Karma 404
+            //    response fires during that window, triggering AssetsView's error callback
+            //    -> getTableBody() -> DOM creation -> .upload-button becomes visible. Tests
+            //    that check this button is hidden (in loading state) then fail.
+            //
+            // 2. This test suite tests the loading -> loaded state transition. Several tests
+            //    call setup() inside it(), which calls setPage(1) and responds to it, driving
+            //    the view from "loading" to "loaded". That precondition requires the view to
+            //    still be in "loading" state at the start of it(). Responding to the init
+            //    request in beforeEach (to avoid the dangling request) would put the view
+            //    into "loaded" state too early and break those assertions.
+            //
+            // With sinon installed first, the init setPage(1) is captured as requests[0] —
+            // a frozen pending fake request that never gets a response unless explicitly told
+            // to. No response means no callbacks, no DOM mutation, view stays in "loading"
+            // state. We advance currentIndex to 1 so AjaxHelpers treats that request as
+            // already consumed; test-driven setPage() calls start at index 1. The pending
+            // requests[0] is abandoned when xhrFactory.restore() runs in afterEach.
+            xhrFactory = sinon.useFakeXMLHttpRequest();
+            requests = [];
+            requests.currentIndex = 0;
+            requests.restore = function() { xhrFactory.restore(); };
+            xhrFactory.onCreate = function(req) { requests.push(req); };
+
             setFixtures($('<script>', {id: 'asset-library-tpl', type: 'text/template'}).text(assetLibraryTpl));
             appendSetFixtures($('<script>', {id: 'asset-tpl', type: 'text/template'}).text(assetTpl));
             appendSetFixtures(uploadModalTpl);
@@ -30,15 +60,7 @@ function($, sinon, AjaxHelpers, URI, AssetsView, AssetCollection, ViewHelpers) {
                 collection: collection,
                 el: $('#asset_table_body')
             });
-
-            // Install fake XHR after creating assetsView so that the initial setPage(1)
-            // fired by createPagingView() during initialize() is not captured. Tests that
-            // need a specific page state drive it themselves via setPage() + respond.
-            xhrFactory = sinon.useFakeXMLHttpRequest();
-            requests = [];
-            requests.currentIndex = 0;
-            requests.restore = function() { xhrFactory.restore(); };
-            xhrFactory.onCreate = function(req) { requests.push(req); };
+            requests.currentIndex = 1;
         });
 
         afterEach(function() {