Fixed a bug where structureboard tried to preload markup with legacy …

…renderer
django-cms · jrief · Apr 24, 2018 · Apr 25, 2018 · May 2, 2018 · May 9, 2018
commit f04a878ea4c8acdd3610b36d8f24cb7e635c45e7
diff --git a/CHANGELOG.txt b/CHANGELOG.txt
@@ -6,6 +6,8 @@
   regardless of the toolbar status (draft / live). This only affected custom
   urls from an apphook.
 * Removed extra quotation mark from the sideframe button template
+* Fixed a bug where structureboard tried to preload markup when using legacy
+  renderer
 
 
 === 3.5.2 (2018-04-11) ===

diff --git a/cms/static/cms/js/dist/3.5.2/bundle.toolbar.min.js b/cms/static/cms/js/dist/3.5.2/bundle.toolbar.min.js
diff --git a/cms/static/cms/js/modules/cms.structureboard.js b/cms/static/cms/js/modules/cms.structureboard.js
@@ -156,6 +156,9 @@ class StructureBoard {
     }
 
     _preloadOppositeMode() {
+        if (CMS.config.settings.legacy_mode) {
+            return;
+        }
         const WAIT_BEFORE_PRELOADING = 2000;
 
         $(Helpers._getWindow()).one('load', () => {

diff --git a/cms/static/cms/js/modules/preload-images.js b/cms/static/cms/js/modules/preload-images.js
@@ -1,3 +1,4 @@
+// istanbul ignore next
 /**
  * preload
  *

diff --git a/cms/tests/frontend/unit/cms.structureboard.test.js b/cms/tests/frontend/unit/cms.structureboard.test.js
@@ -216,6 +216,13 @@ describe('CMS.StructureBoard', function() {
 
             expect(board.ui.toolbarModeSwitcher.find('.cms-btn')).toHaveClass('cms-btn-disabled');
         });
+
+        it('sets loaded content and structure flags if it is a legacy renderer', () => {
+            CMS.config.settings.legacy_mode = true;
+            board = new CMS.Struct
10000
ureBoard();
+            expect(board._loadedStructure).toEqual(true);
+            expect(board._loadedContent).toEqual(true);
+        });
     });
 
     describe('.show()', function() {
@@ -2539,6 +2546,36 @@ describe('CMS.StructureBoard', function() {
                 StructureBoard.__ResetDependency__('Helpers');
             });
         });
+
+        it('does not preload the opposite mode (legacy renderer)', () => {
+            const div = document.createElement('div');
+            const _getWindow = jasmine.createSpy().and.returnValue(div);
+
+            StructureBoard.__Rewire__('Helpers', {
+                _getWindow
+            });
+
+            const board = new StructureBoard();
+
+            spyOn(board, '_requestMode');
+
+            jasmine.clock().install();
+
+            CMS.config.settings.legacy_mode = true;
+            board._loadedContent = true;
+            board._loadedStructure = true;
+
+            board._preloadOppositeMode();
+            expect(board._requestMode).not.toHaveBeenCalled();
+            $(div).trigger('load');
+            expect(board._requestMode).not.toHaveBeenCalled();
+            jasmine.clock().tick(2001);
+            expect(board._requestMode).not.toHaveBeenCalled();
+
+            jasmine.clock().uninstall();
+
+            StructureBoard.__ResetDependency__('Helpers');
+        });
     });
 
     describe('actualizePluginCollapseStatus', () => {

diff --git a/cms/tests/frontend/unit/index.js b/cms/tests/frontend/unit/index.js
@@ -23,6 +23,7 @@ if (files[0] === '*') {
     require('./cms.modal.test');
     require('./shortcuts.test');
     require('./keyboard.test');
+    require('./preload-images.test');
     // FIXME this has to be last because it messes with the url
     require('./cms.structureboard.test'); // missing some tests
 } else {

diff --git a/cms/tests/frontend/unit/preload-images.test.js b/cms/tests/frontend/unit/preload-images.test.js
@@ -0,0 +1,61 @@
+'use strict';
+const preloadImagesFromMarkup = require('../../../static/cms/js/modules/preload-images').default;
+
+describe('preloadImagesFromMarkup', () => {
+    let preload;
+
+    beforeEach(() => {
+        preload = jasmine.createSpy();
+        preloadImagesFromMarkup.__Rewire__('preload', preload);
+    });
+
+    afterEach(() => {
+        preloadImagesFromMarkup.__ResetDependency__('preload');
+    });
+
+    const tests = [
+        {
+            input: 'no img',
+            expected: []
+        },
+        {
+            input: '<img src="whatever">',
+            expected: ['whatever']
+        },
+        {
+            input: "<img src='whatever'>",
+            expected: ['whatever']
+        },
+        {
+            input: `<img
+            src="whatever"
+            class="x" other attributes />`,
+            expected: ['whatever']
+        },
+        {
+            input: `
+            <img src="/static/img1.png">
+            <img src="/static/img2.png">
+            `,
+            expected: [
+                '/static/img1.png',
+                '/static/img2.png'
+            ]
+        },
+            {
+            input: '<IMG CLASS="WUT" src="/static/img1.jpg?2" />',
+            expected: [
+                '/static/img1.jpg?2'
+            ]
+        }
+    ];
+
+    tests.forEach((test, i) => {
+        it(`preloads images from markup ${i}`, () => {
+            preloadImagesFromMarkup(test.input);
+
+            expect(preload).toHaveBeenCalledTimes(test.expected.length);
+            test.expected.forEach(ex => expect(preload).toHaveBeenCalledWith(ex));
+        });
+    });
+});