Jforrester has submitted this change and it was merged. ( 
https://gerrit.wikimedia.org/r/352183 )

Change subject: Fix mmv.bootstrap qunit tests
......................................................................


Fix mmv.bootstrap qunit tests

This heavily relied on deferreds getting resolved synchroneously,
which (for .then) is no longer the case with jQuery 3.
There's also a difference in how chained .then's get resolved.

These tests did not wait for the deferreds to get resolved async,
so that had to change. Worse even: some functionality was tested
by assuming a handler would not be called (= the test in that
handler would not be called), which didn't make the test run,
because we never even waited for it to be called.

The changes in here are basically:
* make mmv.bootstrap.js correctly use .then instead of .done & fail
* let mmw.bootstrap.test.js tests wait for unresolved async promises
* check call counts instead of running tests inside of callbacks
* limit use of fake timer to the 1 test that needs it (it interferes
  with async, which otherwise don't get resolved)

Bug: T164473
Change-Id: I3ca4f786890ad1646f71fe336afdb61e5c3b01c7
---
M resources/mmv/mmv.bootstrap.js
M tests/qunit/mmv/mmv.bootstrap.test.js
M tests/qunit/mmv/mmv.testhelpers.js
3 files changed, 229 insertions(+), 122 deletions(-)

Approvals:
  Jforrester: Verified; Looks good to me, approved



diff --git a/resources/mmv/mmv.bootstrap.js b/resources/mmv/mmv.bootstrap.js
index 4da5a9c..10d9e81 100644
--- a/resources/mmv/mmv.bootstrap.js
+++ b/resources/mmv/mmv.bootstrap.js
@@ -112,20 +112,26 @@
                        deferred.reject( error.message );
                } );
 
-               return deferred.done( function ( viewer ) {
-                       if ( !bs.viewerInitialized ) {
-                               if ( bs.thumbs.length ) {
-                                       viewer.initWithThumbs( bs.thumbs );
-                               }
+               return deferred.promise()
+                       .then(
+                               function ( viewer ) {
+                                       if ( !bs.viewerInitialized ) {
+                                               if ( bs.thumbs.length ) {
+                                                       viewer.initWithThumbs( 
bs.thumbs );
+                                               }
 
-                               bs.viewerInitialized = true;
-                       }
-               } ).fail( function ( message ) {
-                       mw.log.warn( message );
-                       bs.cleanupOverlay();
-                       bs.viewerIsBroken = true;
-                       mw.notify( 'Error loading MediaViewer: ' + message );
-               } );
+                                               bs.viewerInitialized = true;
+                                       }
+                                       return viewer;
+                               },
+                               function ( message ) {
+                                       mw.log.warn( message );
+                                       bs.cleanupOverlay();
+                                       bs.viewerIsBroken = true;
+                                       mw.notify( 'Error loading MediaViewer: 
' + message );
+                                       return $.Deferred().reject( message );
+                               }
+                       );
        };
 
        /**
diff --git a/tests/qunit/mmv/mmv.bootstrap.test.js 
b/tests/qunit/mmv/mmv.bootstrap.test.js
index d8f64da..2821d78 100644
--- a/tests/qunit/mmv/mmv.bootstrap.test.js
+++ b/tests/qunit/mmv/mmv.bootstrap.test.js
@@ -4,7 +4,6 @@
                        mw.config.set( 'wgMediaViewer', true );
                        mw.config.set( 'wgMediaViewerOnClick', true );
                        this.sandbox.stub( mw.user, 'isAnon' ).returns( false );
-                       this.clock = this.sandbox.useFakeTimers();
                }
        } ) );
 
@@ -67,80 +66,93 @@
        }
 
        function hashTest( prefix, bootstrap, assert ) {
-               var hash = prefix + '/foo';
+               var hash = prefix + '/foo',
+                       callCount = 0;
+
+               bootstrap.loadViewer = function () {
+                       callCount++;
+                       return $.Deferred().reject();
+               };
+
+               // Hijack loadViewer, which will return a promise that we'll 
have to
+               // wait for if we want to see these tests through
+               mw.mmv.testHelpers.asyncMethod( bootstrap, 'loadViewer' );
 
                bootstrap.setupEventHandlers();
 
-               bootstrap.loadViewer = function () {
-                       assert.ok( false, 'Viewer should not be loaded' );
-                       return $.Deferred().reject();
-               };
-
+               // invalid hash, should not trigger MMV load
                window.location.hash = 'Foo';
 
-               bootstrap.loadViewer = function () {
-                       QUnit.start();
-                       assert.ok( true, 'Viewer should be loaded' );
+               // actual hash we want to test for, should trigger MMV load
+               // use setTimeout to add new hash change to end of the call 
stack,
+               // ensuring that event handlers for our previous change can 
execute
+               // without us interfering with another immediate change
+               setTimeout( function () {
+                       window.location.hash = hash;
+               } );
+
+               return mw.mmv.testHelpers.waitForAsync().then( function () {
+                       assert.ok( callCount === 1, 'Viewer should be loaded 
once' );
                        bootstrap.cleanupEventHandlers();
                        window.location.hash = '';
-
-                       return $.Deferred().reject();
-               };
-
-               QUnit.stop();
-               window.location.hash = hash;
+               } );
        }
 
        QUnit.test( 'Promise does not hang on ResourceLoader errors', 3, 
function ( assert ) {
                var bootstrap,
-                       errorMessage = 'loading failed';
+                       errorMessage = 'loading failed',
+                       done = assert.async();
 
                this.sandbox.stub( mw.loader, 'using' )
                        .callsArgWith( 2, new Error( errorMessage, [ 'mmv' ] ) )
                        .withArgs( 'mediawiki.notification' ).returns( 
$.Deferred().reject() ); // needed for mw.notify
 
                bootstrap = createBootstrap();
-
-               bootstrap.setupOverlay = function () {
-                       assert.ok( true, 'Overlay was set up' );
-               };
-
-               bootstrap.cleanupOverlay = function () {
-                       assert.ok( true, 'Overlay was cleaned up' );
-               };
-
-               QUnit.stop();
+               this.sandbox.stub( bootstrap, 'setupOverlay' );
+               this.sandbox.stub( bootstrap, 'cleanupOverlay' );
 
                bootstrap.loadViewer( true ).fail( function ( message ) {
+                       assert.ok( bootstrap.setupOverlay.called, 'Overlay was 
set up' );
+                       assert.ok( bootstrap.cleanupOverlay.called, 'Overlay 
was cleaned up' );
                        assert.strictEqual( message, errorMessage, 'promise is 
rejected with the error message when loading fails' );
-                       QUnit.start();
+                       done();
                } );
        } );
 
        QUnit.test( 'Clicks are not captured once the loading fails', 4, 
function ( assert ) {
                var event, returnValue,
-                       bootstrap = new mw.mmv.MultimediaViewerBootstrap();
+                       bootstrap = new mw.mmv.MultimediaViewerBootstrap(),
+                       clock = this.sandbox.useFakeTimers();
 
                this.sandbox.stub( mw.loader, 'using' )
                        .callsArgWith( 2, new Error( 'loading failed', [ 'mmv' 
] ) )
                        .withArgs( 'mediawiki.notification' ).returns( 
$.Deferred().reject() ); // needed for mw.notify
                bootstrap.ensureEventHandlersAreSetUp = $.noop;
 
+               // trigger first click, which will cause MMV to be loaded 
(which we've
+               // set up to fail)
                event = new $.Event( 'click', { button: 0, which: 1 } );
                returnValue = bootstrap.click( {}, event, 'foo' );
+               clock.tick( 10 );
                assert.ok( event.isDefaultPrevented(), 'First click is caught' 
);
                assert.strictEqual( returnValue, false, 'First click is caught' 
);
 
+               // wait until MMW is loaded (or failed to load, in this case) 
before we
+               // trigger another click - which should then not be caught
                event = new $.Event( 'click', { button: 0, which: 1 } );
                returnValue = bootstrap.click( {}, event, 'foo' );
+               clock.tick( 10 );
                assert.ok( !event.isDefaultPrevented(), 'Click after loading 
failure is not caught' );
                assert.notStrictEqual( returnValue, false, 'Click after loading 
failure is not caught' );
+
+               clock.restore();
        } );
 
-       QUnit.test( 'Check viewer invoked when clicking on valid image links', 
10, function ( assert ) {
+       QUnit.test( 'Check viewer invoked when clicking on valid image links', 
14, function ( assert ) {
                // TODO: Is <div class="gallery"><span 
class="image"><img/></span></div> valid ???
                var div, link, link2, link3, link4, link5, bootstrap,
-                       viewer = { initWithThumbs: $.noop };
+                       viewer = { initWithThumbs: $.noop, loadImageByTitle: 
this.sandbox.stub() },
+                       clock = this.sandbox.useFakeTimers();
 
                // Create gallery with valid link image
                div = createGallery();
@@ -166,6 +178,7 @@
 
                // Create a new bootstrap object to trigger the DOM scan, etc.
                bootstrap = createBootstrap( viewer );
+               this.sandbox.stub( bootstrap, 'setupOverlay' );
 
                link4 = $( '.fullMedia .mw-mmv-view-expanded' );
                assert.ok( link4.length, 'Link for viewing expanded file was 
set up.' );
@@ -173,48 +186,55 @@
                link5 = $( '.fullMedia .mw-mmv-view-config' );
                assert.ok( link5.length, 'Link for opening enable/disable 
configuration was set up.' );
 
-               bootstrap.setupOverlay = function () {
-                       assert.ok( true, 'Overlay was set up' );
-               };
-
-               viewer.loadImageByTitle = function () {
-                       assert.ok( true, 'Image loaded' );
-               };
-
                // Click on valid link
                link.trigger( { type: 'click', which: 1 } );
+               clock.tick( 10 );
+               assert.ok( bootstrap.setupOverlay.callCount === 1, 
'setupOverlay was called' );
+               assert.ok( viewer.loadImageByTitle.callCount === 1, 
'loadImageByTitle was called' );
 
                // Click on valid link
                link2.trigger( { type: 'click', which: 1 } );
+               clock.tick( 10 );
+               assert.ok( bootstrap.setupOverlay.callCount === 2, 
'setupOverlay was called' );
+               assert.ok( viewer.loadImageByTitle.callCount === 2, 
'loadImageByTitle was called' );
 
                // Click on valid link
                link4.trigger( { type: 'click', which: 1 } );
+               clock.tick( 10 );
+               assert.ok( bootstrap.setupOverlay.callCount === 3, 
'setupOverlay was called' );
+               assert.ok( viewer.loadImageByTitle.callCount === 3, 
'loadImageByTitle was called' );
 
                // Click on valid link even when preference says not to
                mw.config.set( 'wgMediaViewerOnClick', false );
                link4.trigger( { type: 'click', which: 1 } );
+               clock.tick( 10 );
                mw.config.set( 'wgMediaViewerOnClick', true );
+               assert.ok( bootstrap.setupOverlay.callCount === 4, 
'setupOverlay was called' );
+               assert.ok( viewer.loadImageByTitle.callCount === 4, 
'loadImageByTitle was called' );
 
-               bootstrap.setupOverlay = function () {
-                       assert.ok( false, 'Overlay was not set up' );
-               };
-
-               viewer.loadImageByTitle = function () {
-                       assert.ok( false, 'Image should not be loaded' );
-               };
+               // @todo comment that above clicks should result in call, below 
clicks should not
 
                // Click on non-valid link
                link3.trigger( { type: 'click', which: 1 } );
+               clock.tick( 10 );
+               assert.ok( bootstrap.setupOverlay.callCount === 4, 
'setupOverlay was not called' );
+               assert.ok( viewer.loadImageByTitle.callCount === 4, 
'loadImageByTitle was not called' );
 
                // Click on valid links with preference off
                mw.config.set( 'wgMediaViewerOnClick', false );
                link.trigger( { type: 'click', which: 1 } );
                link2.trigger( { type: 'click', which: 1 } );
+               clock.tick( 10 );
+               assert.ok( bootstrap.setupOverlay.callCount === 4, 
'setupOverlay was not called' );
+               assert.ok( viewer.loadImageByTitle.callCount === 4, 
'loadImageByTitle was not called' );
+
+               clock.restore();
        } );
 
-       QUnit.test( 'Skip images with invalid extensions', 0, function ( assert 
) {
+       QUnit.test( 'Skip images with invalid extensions', 1, function ( assert 
) {
                var div, link,
-                       viewer = { initWithThumbs: $.noop };
+                       viewer = { initWithThumbs: $.noop, loadImageByTitle: 
this.sandbox.stub() },
+                       clock = this.sandbox.useFakeTimers();
 
                // Create gallery with image that has invalid name extension
                div = createGallery( 'thumb.badext' );
@@ -223,70 +243,67 @@
                // Create a new bootstrap object to trigger the DOM scan, etc.
                createBootstrap( viewer );
 
-               viewer.loadImageByTitle = function () {
-                       assert.ok( false, 'Image should not be loaded' );
-               };
-
                // Click on valid link with wrong image extension
                link.trigger( { type: 'click', which: 1 } );
+               clock.tick( 10 );
+
+               assert.ok( !viewer.loadImageByTitle.called, 'Image should not 
be loaded' );
+
+               clock.restore();
        } );
 
-       QUnit.test( 'Accept only left clicks without modifier keys, skip the 
rest', 2, function ( assert ) {
+       QUnit.test( 'Accept only left clicks without modifier keys, skip the 
rest', 6, function ( assert ) {
                var $div, $link, bootstrap,
-                       viewer = { initWithThumbs: $.noop };
+                       viewer = { initWithThumbs: $.noop, loadImageByTitle: 
this.sandbox.stub() },
+                       clock = this.sandbox.useFakeTimers();
 
                // Create gallery with image that has valid name extension
                $div = createGallery();
 
                // Create a new bootstrap object to trigger the DOM scan, etc.
                bootstrap = createBootstrap( viewer );
+               this.sandbox.stub( bootstrap, 'setupOverlay' );
 
                $link = $div.find( 'a.image' );
 
-               bootstrap.setupOverlay = function () {
-                       assert.ok( true, 'Overlay was set up' );
-               };
-
-               viewer.loadImageByTitle = function () {
-                       assert.ok( true, 'Image loaded' );
-               };
-
                // Handle valid left click, it should try to load the image
                $link.trigger( { type: 'click', which: 1 } );
-
-               bootstrap.setupOverlay = function () {
-                       assert.ok( false, 'Overlay was not set up' );
-               };
-
-               viewer.loadImageByTitle = function () {
-                       assert.ok( false, 'Image should not be loaded' );
-               };
+               clock.tick( 10 );
+               assert.ok( bootstrap.setupOverlay.callCount === 1, 'Overlay was 
set up' );
+               assert.ok( viewer.loadImageByTitle.callCount === 1, 'Image was 
loaded' );
 
                // Skip Ctrl-left-click, no image is loaded
                $link.trigger( { type: 'click', which: 1, ctrlKey: true } );
+               clock.tick( 10 );
+               assert.ok( bootstrap.setupOverlay.callCount === 1, 'Overlay was 
not set up' );
+               assert.ok( viewer.loadImageByTitle.callCount === 1, 'Image was 
not loaded' );
 
                // Skip invalid right click, no image is loaded
                $link.trigger( { type: 'click', which: 2 } );
+               clock.tick( 10 );
+               assert.ok( bootstrap.setupOverlay.callCount === 1, 'Overlay was 
not set up' );
+               assert.ok( viewer.loadImageByTitle.callCount === 1, 'Image was 
not loaded' );
+
+               clock.restore();
        } );
 
        QUnit.test( 'Ensure that the correct title is loaded when clicking', 2, 
function ( assert ) {
                var bootstrap,
-                       viewer = { initWithThumbs: $.noop },
+                       viewer = { initWithThumbs: $.noop, loadImageByTitle: 
this.sandbox.stub() },
                        $div = createGallery( 'foo.jpg' ),
-                       $link = $div.find( 'a.image' );
-
-               viewer.loadImageByTitle = function ( loadedTitle ) {
-                       assert.strictEqual( loadedTitle.getPrefixedDb(), 
'File:Foo.jpg', 'Titles are identical' );
-               };
+                       $link = $div.find( 'a.image' ),
+                       clock = this.sandbox.useFakeTimers();
 
                // Create a new bootstrap object to trigger the DOM scan, etc.
                bootstrap = createBootstrap( viewer );
-
-               bootstrap.setupOverlay = function () {
-                       assert.ok( true, 'Overlay was set up' );
-               };
+               this.sandbox.stub( bootstrap, 'setupOverlay' );
 
                $link.trigger( { type: 'click', which: 1 } );
+               clock.tick( 10 );
+               assert.ok( bootstrap.setupOverlay.called, 'Overlay was set up' 
);
+               assert.strictEqual( viewer.loadImageByTitle.firstCall.args[ 0 
].getPrefixedDb(), 'File:Foo.jpg', 'Titles are identical' );
+
+               clock.restore();
        } );
 
        QUnit.test( 'Validate new LightboxImage object has sane constructor 
parameters', 9, function ( assert ) {
@@ -296,13 +313,17 @@
                        viewer = mw.mmv.testHelpers.getMultimediaViewer(),
                        fname = 'valid',
                        imgSrc = '/' + fname + '.jpg/300px-' + fname + '.jpg',
-                       imgRegex = new RegExp( imgSrc + '$' );
+                       imgRegex = new RegExp( imgSrc + '$' ),
+                       clock = this.sandbox.useFakeTimers();
 
                $div = createThumb( imgSrc, 'Blah blah', 'meow' );
                $link = $div.find( 'a.image' );
 
+               // Create a new bootstrap object to trigger the DOM scan, etc.
+               bootstrap = createBootstrap( viewer );
+               this.sandbox.stub( bootstrap, 'setupOverlay' );
+               this.sandbox.stub( viewer, 'createNewImage' );
                viewer.loadImage = $.noop;
-
                viewer.createNewImage = function ( fileLink, filePageLink, 
fileTitle, index, thumb, caption, alt ) {
                        var html = thumb.outerHTML;
 
@@ -316,14 +337,11 @@
                        assert.strictEqual( alt, 'meow', 'The alt text passed 
in is correct' );
                };
 
-               // Create a new bootstrap object to trigger the DOM scan, etc.
-               bootstrap = createBootstrap( viewer );
-
-               bootstrap.setupOverlay = function () {
-                       assert.ok( true, 'Overlay was set up' );
-               };
-
                $link.trigger( { type: 'click', which: 1 } );
+               clock.tick( 10 );
+               assert.ok( bootstrap.setupOverlay.called, 'Overlay was set up' 
);
+
+               clock.reset();
        } );
 
        QUnit.test( 'Only load the viewer on a valid hash (modern browsers)', 
1, function ( assert ) {
@@ -333,7 +351,7 @@
 
                bootstrap = createBootstrap();
 
-               hashTest( '/media', bootstrap, assert );
+               return hashTest( '/media', bootstrap, assert );
        } );
 
        QUnit.test( 'Only load the viewer on a valid hash (old browsers)', 1, 
function ( assert ) {
@@ -344,7 +362,7 @@
                bootstrap = createBootstrap();
                bootstrap.browserHistory = undefined;
 
-               hashTest( '/media', bootstrap, assert );
+               return hashTest( '/media', bootstrap, assert );
        } );
 
        QUnit.test( 'Load the viewer on a legacy hash (modern browsers)', 1, 
function ( assert ) {
@@ -354,7 +372,7 @@
 
                bootstrap = createBootstrap();
 
-               hashTest( 'mediaviewer', bootstrap, assert );
+               return hashTest( 'mediaviewer', bootstrap, assert );
        } );
 
        QUnit.test( 'Load the viewer on a legacy hash (old browsers)', 1, 
function ( assert ) {
@@ -365,7 +383,7 @@
                bootstrap = createBootstrap();
                bootstrap.browserHistory = undefined;
 
-               hashTest( 'mediaviewer', bootstrap, assert );
+               return hashTest( 'mediaviewer', bootstrap, assert );
        } );
 
        QUnit.test( 'Overlay is set up on hash change', 1, function ( assert ) {
@@ -396,48 +414,56 @@
                assert.ok( !bootstrap.setupOverlay.called, 'Overlay is not set 
up' );
        } );
 
-       QUnit.test( 'internalHashChange', 1, function ( assert ) {
+       QUnit.test( 'internalHashChange', 2, function ( assert ) {
                var bootstrap = createBootstrap(),
-                       hash = '#/media/foo';
+                       hash = '#/media/foo',
+                       callCount = 0,
+                       clock = this.sandbox.useFakeTimers();
 
                window.location.hash = '';
 
-               bootstrap.setupEventHandlers();
-
                bootstrap.loadViewer = function () {
-                       assert.ok( false, 'Viewer should not be loaded' );
+                       callCount++;
                        return $.Deferred().reject();
                };
 
-               bootstrap.internalHashChange( { hash: hash } );
+               bootstrap.setupEventHandlers();
 
+               bootstrap.internalHashChange( { hash: hash } );
+               clock.tick( 10 );
+
+               assert.ok( callCount === 0, 'Viewer should not be loaded' );
                assert.strictEqual( window.location.hash, hash, 'Window\'s hash 
has been updated correctly' );
 
                bootstrap.cleanupEventHandlers();
-
                window.location.hash = '';
+               clock.restore();
        } );
 
-       QUnit.test( 'internalHashChange (legacy)', 1, function ( assert ) {
+       QUnit.test( 'internalHashChange (legacy)', 2, function ( assert ) {
                var bootstrap = createBootstrap(),
-                       hash = '#mediaviewer/foo';
+                       hash = '#mediaviewer/foo',
+                       callCount = 0,
+                       clock = this.sandbox.useFakeTimers();
 
                window.location.hash = '';
 
-               bootstrap.setupEventHandlers();
-
                bootstrap.loadViewer = function () {
-                       assert.ok( false, 'Viewer should not be loaded' );
+                       callCount++;
                        return $.Deferred().reject();
                };
 
-               bootstrap.internalHashChange( { hash: hash } );
+               bootstrap.setupEventHandlers();
 
+               bootstrap.internalHashChange( { hash: hash } );
+               clock.tick( 10 );
+
+               assert.ok( callCount === 0, 'Viewer should not be loaded' );
                assert.strictEqual( window.location.hash, hash, 'Window\'s hash 
has been updated correctly' );
 
                bootstrap.cleanupEventHandlers();
-
                window.location.hash = '';
+               clock.restore();
        } );
 
        QUnit.test( 'Restoring article scroll position', 2, function ( assert ) 
{
@@ -470,6 +496,7 @@
 
        QUnit.test( 'Preload JS/CSS dependencies on thumb hover', 2, function ( 
assert ) {
                var $div, bootstrap,
+                       clock = this.sandbox.useFakeTimers(),
                        viewer = { initWithThumbs: $.noop };
 
                // Create gallery with image that has valid name extension
@@ -481,16 +508,18 @@
                this.sandbox.stub( mw.loader, 'load' );
 
                $div.mouseenter();
-               this.clock.tick( bootstrap.hoverWaitDuration - 50 );
+               clock.tick( bootstrap.hoverWaitDuration - 50 );
                $div.mouseleave();
 
                assert.ok( !mw.loader.load.called, 'Dependencies should not be 
preloaded if the thumb is not hovered long enough' );
 
                $div.mouseenter();
-               this.clock.tick( bootstrap.hoverWaitDuration + 50 );
+               clock.tick( bootstrap.hoverWaitDuration + 50 );
                $div.mouseleave();
 
                assert.ok( mw.loader.load.called, 'Dependencies should be 
preloaded if the thumb is hovered long enough' );
+
+               clock.restore();
        } );
 
        QUnit.test( 'isAllowedThumb', 5, function ( assert ) {
diff --git a/tests/qunit/mmv/mmv.testhelpers.js 
b/tests/qunit/mmv/mmv.testhelpers.js
index be38af4..e313752 100644
--- a/tests/qunit/mmv/mmv.testhelpers.js
+++ b/tests/qunit/mmv/mmv.testhelpers.js
@@ -62,5 +62,77 @@
                } );
        };
 
+       MTH.asyncPromises = [];
+
+       /**
+        * Given a method/function that returns a promise, this'll return a 
function
+        * that just wraps the original & returns the original result, but also
+        * executes an assert.async() right before it's called, and resolves 
that
+        * async after that promise has completed.
+        *
+        * Example usage: given a method `bootstrap.openImage` that returns a
+        * promise, just call it like this to wrap this functionality around it:
+        * `bootstrap.openImage = asyncMethod( bootstrap.openImage, bootstrap 
);`
+        *
+        * Now, every time some part of the code calls this function, it'll just
+        * execute as it normally would, but your tests won't finish until these
+        * functions (and any .then tacked on to them) have completed.
+        *
+        * This method will make sure your tests don't end prematurely (before 
the
+        * promises have been resolved), but that's it. If you need to run
+        * additional code after all promises have resolved, you can call the
+        * complementary `waitForAsync`, which will return a promise that 
doesn't
+        * resolve until all of these promises have.
+        *
+        * @param {Object} object
+        * @param {string} method
+        * @param {QUnit.assert} [assert]
+        * @return {Function}
+        */
+       MTH.asyncMethod = function ( object, method, assert ) {
+               return function () {
+                       // apply arguments to original promise
+                       var promise = object[ method ].apply( object, arguments 
),
+                               done;
+
+                       this.asyncPromises.push( promise );
+
+                       if ( assert ) {
+                               done = assert.async();
+                               // use setTimeout to ensure `done` is not the 
first callback handler
+                               // to execute (possibly ending the test's wait 
right before
+                               // the result of the promise is executed)
+                               setTimeout( promise.then.bind( null, done, done 
) );
+                       }
+
+                       return promise;
+               }.bind( this );
+       };
+
+       /**
+        * Returns a promise that will not resolve until all of the promises 
that
+        * were created in functions upon which `asyncMethod` was called have
+        * resolved.
+        *
+        * @return {$.Promise}
+        */
+       MTH.waitForAsync = function () {
+               var deferred = $.Deferred();
+
+               // it's possible that, before this function call, some code was 
executed
+               // that triggers async code that will eventually end up 
`asyncPromises`
+               // in order to give that code a chance to run, we'll add 
another promise
+               // to the array, that will only resolve at the end of the 
current call
+               // stack (using setTimeout)
+               this.asyncPromises.push( deferred.promise() );
+               setTimeout( deferred.resolve );
+
+               return QUnit.whenPromisesComplete.apply( null, 
this.asyncPromises ).then(
+                       function () {
+                               this.asyncPromises = [];
+                       }.bind( this )
+               );
+       };
+
        mw.mmv.testHelpers = MTH;
 }( mediaWiki, jQuery ) );

-- 
To view, visit https://gerrit.wikimedia.org/r/352183
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I3ca4f786890ad1646f71fe336afdb61e5c3b01c7
Gerrit-PatchSet: 7
Gerrit-Project: mediawiki/extensions/MultimediaViewer
Gerrit-Branch: master
Gerrit-Owner: Matthias Mullie <mmul...@wikimedia.org>
Gerrit-Reviewer: Jforrester <jforres...@wikimedia.org>
Gerrit-Reviewer: Krinkle <krinklem...@gmail.com>
Gerrit-Reviewer: Matthias Mullie <mmul...@wikimedia.org>
Gerrit-Reviewer: jenkins-bot <>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to