From 863b9bc0744365fd93ae184b5451a6bb9ba6f4e5 Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Mon, 29 Dec 2014 14:14:13 -0500 Subject: [PATCH 01/18] Deferred: [tests] Standard promise interoperability Specific spec and old jQuery compatibility assertions Ref https://github.com/jquery/jquery/pull/1821#issuecomment-67047762 --- test/unit/deferred.js | 55 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/test/unit/deferred.js b/test/unit/deferred.js index 40f9362196..0e617ff18b 100644 --- a/test/unit/deferred.js +++ b/test/unit/deferred.js @@ -314,6 +314,61 @@ test( "jQuery.Deferred.then - context", function() { }); }); +asyncTest( "jQuery.Deferred.then - spec compatibility", function() { + + expect( 1 ); + + var defer = jQuery.Deferred().done(function() { + setTimeout( start ); + throw new Error(); + }); + + defer.then(function() { + ok( true, "errors in .done callbacks don't stop .then handlers" ); + }); + + try { + defer.resolve(); + } catch ( _ ) {} +}); + +asyncTest( "jQuery.Deferred - 1.x/2.x compatibility", function() { + + expect( 7 ); + + var context = { id: "callback context" }, + thenable = jQuery.Deferred().resolve( "thenable fulfillment value" ).promise(); + + jQuery.Deferred().resolve( 1, 2 ).then(function() { + deepEqual( [].slice.call( arguments ), [ 1, 2 ], + ".then fulfillment callbacks receive all resolution values" ); + }); + jQuery.Deferred().reject( 1, 2 ).then( null, function() { + deepEqual( [].slice.call( arguments ), [ 1, 2 ], + ".then rejection callbacks receive all rejection values" ); + }); + jQuery.Deferred().notify( 1, 2 ).then( null, null, function() { + deepEqual( [].slice.call( arguments ), [ 1, 2 ], + ".then progress callbacks receive all progress values" ); + }); + + jQuery.Deferred().resolveWith( context ).then(function() { + deepEqual( this, context, ".then fulfillment callbacks receive context" ); + }); + jQuery.Deferred().rejectWith( context ).then( null, function() { + deepEqual( this, context, ".then rejection callbacks receive context" ); + }); + jQuery.Deferred().notifyWith( context ).then( null, null, function() { + deepEqual( this, context, ".then progress callbacks receive context" ); + }); + + jQuery.Deferred().resolve( thenable ).done(function( value ) { + strictEqual( value, thenable, ".done doesn't unwrap thenables" ); + }); + + setTimeout( start ); +}); + test( "jQuery.when", function() { expect( 37 ); From d9d3657b0deea4ab5b6b3531647ed1f1581bc6e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Go=C5=82e=CC=A8biowski?= Date: Thu, 11 Sep 2014 15:18:34 -0500 Subject: [PATCH 02/18] Deferred: Run the Promises/A+ test suite To run tests, invoke `grunt default promises-aplus-tests`. Conflicts: Gruntfile.js package.json src/ajax.js --- Gruntfile.js | 15 ++++++++++++++- package.json | 2 ++ promises-aplus-adapter.js | 21 +++++++++++++++++++++ 3 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 promises-aplus-adapter.js diff --git a/Gruntfile.js b/Gruntfile.js index 705e093d84..10410a3e48 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -10,6 +10,7 @@ module.exports = function( grunt ) { } var gzip = require( "gzip-js" ), + spawn = require( "child_process" ).spawn, srcHintOptions = readOptionalJSON( "src/.jshintrc" ); // The concatenated file won't pass onevar @@ -168,12 +169,24 @@ module.exports = function( grunt ) { }); }); + grunt.registerTask( "promises-aplus-tests", function() { + var done = this.async(); + spawn( "node", [ + "./node_modules/.bin/promises-aplus-tests", + "./promises-aplus-adapter.js" + ], { + stdio: "inherit" + }).on( "close", function( code ) { + done( code === 0 ); + }); + }); + // Short list as a high frequency watch task grunt.registerTask( "dev", [ "build:*:*", "lint" ] ); grunt.registerTask( "test_fast", [ "node_smoke_test" ] ); - grunt.registerTask( "test", [ "default", "test_fast" ] ); + grunt.registerTask( "test", [ "default", "test_fast", "promises-aplus-tests" ] ); grunt.registerTask( "default", [ "jsonlint", "dev", "uglify", "dist:*", "compare_size" ] ); }; diff --git a/package.json b/package.json index 278251e072..d4d8c25f7c 100644 --- a/package.json +++ b/package.json @@ -46,6 +46,8 @@ "jsdom": "1.5.0", "load-grunt-tasks": "1.0.0", "npm": "2.1.12", + "promises-aplus-tests": "2.1.0", + "q": "1.1.2", "qunitjs": "1.16.0", "requirejs": "2.1.15", "sinon": "1.12.2", diff --git a/promises-aplus-adapter.js b/promises-aplus-adapter.js new file mode 100644 index 0000000000..f390d11e12 --- /dev/null +++ b/promises-aplus-adapter.js @@ -0,0 +1,21 @@ +"use strict"; + +require( "jsdom" ).env( "", function (errors, window) { + if (errors) { + console.error(errors); + return; + } + var jQuery = require( "./" )( window ); + + exports.deferred = function () { + var deferred = jQuery.Deferred(); + + return { + get promise() { + return deferred.promise(); + }, + resolve: deferred.resolve.bind(deferred), + reject: deferred.reject.bind(deferred) + }; + }; +}); From f986cab07fa6052366b16a8d8556c1d388b3d97f Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Mon, 5 Jan 2015 04:46:51 -0500 Subject: [PATCH 03/18] Deferred: [code] Errors in .done callbacks don't stop .then handlers raw gz Sizes 249270 73674 dist/jquery.js 84800 29540 dist/jquery.min.js raw gz Compared to master @ 66e1b6b8d49812239b5712d65922ff94c60f7b02 +2345 +455 dist/jquery.js +607 +145 dist/jquery.min.js --- src/deferred.js | 124 +++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 106 insertions(+), 18 deletions(-) diff --git a/src/deferred.js b/src/deferred.js index 939b58f37e..91dcb611b3 100644 --- a/src/deferred.js +++ b/src/deferred.js @@ -4,14 +4,24 @@ define([ "./callbacks" ], function( jQuery, slice ) { +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + jQuery.extend({ Deferred: function( func ) { var tuples = [ - // action, add listener, listener list, final state - [ "resolve", "done", jQuery.Callbacks("once memory"), "resolved" ], - [ "reject", "fail", jQuery.Callbacks("once memory"), "rejected" ], - [ "notify", "progress", jQuery.Callbacks("memory") ] + // action, add listener, callbacks, .then handlers, final state + [ "resolve", "done", jQuery.Callbacks("once memory"), + jQuery.Callbacks("once memory"), "resolved" ], + [ "reject", "fail", jQuery.Callbacks("once memory"), + jQuery.Callbacks("once memory"), "rejected" ], + [ "notify", "progress", jQuery.Callbacks("memory"), + jQuery.Callbacks("memory") ] ], state = "pending", promise = { @@ -22,12 +32,16 @@ jQuery.extend({ deferred.done( arguments ).fail( arguments ); return this; }, - then: function( /* fnDone, fnFail, fnProgress */ ) { + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { var fns = arguments; + return jQuery.Deferred(function( newDefer ) { jQuery.each( tuples, function( i, tuple ) { var fn = jQuery.isFunction( fns[ i ] ) && fns[ i ]; - // deferred[ done | fail | progress ] for forwarding actions to newDefer + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + // deferred.progress(function() { bind to newDefer or newDefer.notify }) deferred[ tuple[1] ](function() { var returned = fn && fn.apply( this, arguments ); if ( returned && jQuery.isFunction( returned.promise ) ) { @@ -46,6 +60,62 @@ jQuery.extend({ fns = null; }).promise(); }, + then: function( onFulfilled, onRejected, onProgress ) { + function resolve( deferred, handler ) { + return function() { + var that = this, + args = arguments; + setTimeout(function() { + var returned; + try { + returned = handler.apply( that, args ); + if ( returned && jQuery.isFunction( returned.then ) ) { + returned.then( + resolve( deferred, Identity ), + resolve( deferred, Thrower ), + deferred.notify + ); + } else { + deferred.resolve( returned ); + } + } catch ( e ) { + deferred.reject( e ); + } + }); + }; + } + + return jQuery.Deferred(function( newDefer ) { + // fulfilled_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( newDefer, jQuery.isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( newDefer, jQuery.isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + + // progress_handlers.add( ... ) + tuples[ 2 ][ 3 ].add(function() { + var that = this, + args = arguments; + setTimeout(function() { + if ( jQuery.isFunction( onProgress ) ) { + args = [ onProgress.apply( that, args ) ]; + that = newDefer.promise(); + } + newDefer.notifyWith( that, args ); + }); + }); + }).promise(); + }, // Get a promise for this deferred // If obj is provided, the promise aspect is added to the object promise: function( obj ) { @@ -54,32 +124,50 @@ jQuery.extend({ }, deferred = {}; - // Keep pipe for back-compat - promise.pipe = promise.then; - // Add list-specific methods jQuery.each( tuples, function( i, tuple ) { var list = tuple[ 2 ], - stateString = tuple[ 3 ]; + stateString = tuple[ 4 ]; - // promise[ done | fail | progress ] = list.add + // promise.done = list.add + // promise.fail = list.add + // promise.progress = list.add promise[ tuple[1] ] = list.add; // Handle state if ( stateString ) { - list.add(function() { - // state = [ resolved | rejected ] - state = stateString; - - // [ reject_list | resolve_list ].disable; progress_list.lock - }, tuples[ i ^ 1 ][ 2 ].disable, tuples[ 2 ][ 2 ].lock ); + list.add( + function() { + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ i ^ 1 ][ 2 ].disable, + + // progress_callbacks.lock + tuples[ 2 ][ 2 ].lock + ); } - // deferred[ resolve | reject | notify ] + // fulfilled_handlers.fire + // rejected_handlers.fire + // progress_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + // deferred.notify = function() { deferred.notifyWith(...) } deferred[ tuple[0] ] = function() { deferred[ tuple[0] + "With" ]( this === deferred ? promise : this, arguments ); return this; }; + + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + // deferred.notifyWith = list.fireWith deferred[ tuple[0] + "With" ] = list.fireWith; }); From ec2ee7970cf2809d45b611193f4680e75185a65e Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Mon, 5 Jan 2015 04:52:53 -0500 Subject: [PATCH 04/18] Deferred: Update tests for asynchronicity and spec compliance Non-thenable return from a rejection handler fulfills instead of rejects. Deferreds cannot resolve from progress handlers. --- test/unit/deferred.js | 274 +++++++++++++++++++++++++++++++++--------- 1 file changed, 215 insertions(+), 59 deletions(-) diff --git a/test/unit/deferred.js b/test/unit/deferred.js index 0e617ff18b..16d67eda94 100644 --- a/test/unit/deferred.js +++ b/test/unit/deferred.js @@ -14,7 +14,7 @@ jQuery.each( [ "", " - new operator" ], function( _, withNew ) { var defer = createDeferred(); - strictEqual( defer.pipe, defer.then, "pipe is an alias of then" ); + ok( defer.pipe, "defer.pipe exists" ); createDeferred().resolve().done(function() { ok( true, "Success on resolve" ); @@ -93,15 +93,16 @@ test( "jQuery.Deferred - chainability", function() { }); }); -test( "jQuery.Deferred.then - filtering (done)", function() { +test( "jQuery.Deferred.then - filtering (done)", function( assert ) { - expect( 4 ); + assert.expect( 4 ); var value1, value2, value3, defer = jQuery.Deferred(), piped = defer.then(function( a, b ) { return a * b; - }); + }), + done = jQuery.map( new Array( 3 ), function() { return assert.async(); } ); piped.done(function( result ) { value3 = result; @@ -112,32 +113,35 @@ test( "jQuery.Deferred.then - filtering (done)", function() { value2 = b; }); - defer.resolve( 2, 3 ); - - strictEqual( value1, 2, "first resolve value ok" ); - strictEqual( value2, 3, "second resolve value ok" ); - strictEqual( value3, 6, "result of filter ok" ); + defer.resolve( 2, 3 ).then(function() { + assert.strictEqual( value1, 2, "first resolve value ok" ); + assert.strictEqual( value2, 3, "second resolve value ok" ); + assert.strictEqual( value3, 6, "result of filter ok" ); + done.pop().call(); + }); jQuery.Deferred().reject().then(function() { - ok( false, "then should not be called on reject" ); - }); + assert.ok( false, "then should not be called on reject" ); + }).then( null, done.pop() ); jQuery.Deferred().resolve().then( jQuery.noop ).done(function( value ) { - strictEqual( value, undefined, "then done callback can return undefined/null" ); + assert.strictEqual( value, undefined, "then done callback can return undefined/null" ); + done.pop().call(); }); }); -test( "jQuery.Deferred.then - filtering (fail)", function() { +test( "jQuery.Deferred.then - filtering (fail)", function( assert ) { - expect( 4 ); + assert.expect( 4 ); var value1, value2, value3, defer = jQuery.Deferred(), piped = defer.then( null, function( a, b ) { return a * b; - }); + }), + done = jQuery.map( new Array( 3 ), function() { return assert.async(); } ); - piped.fail(function( result ) { + piped.done(function( result ) { value3 = result; }); @@ -146,30 +150,70 @@ test( "jQuery.Deferred.then - filtering (fail)", function() { value2 = b; }); - defer.reject( 2, 3 ); - - strictEqual( value1, 2, "first reject value ok" ); - strictEqual( value2, 3, "second reject value ok" ); - strictEqual( value3, 6, "result of filter ok" ); + defer.reject( 2, 3 ).then( null, function() { + assert.strictEqual( value1, 2, "first reject value ok" ); + assert.strictEqual( value2, 3, "second reject value ok" ); + assert.strictEqual( value3, 6, "result of filter ok" ); + done.pop().call(); + }); jQuery.Deferred().resolve().then( null, function() { - ok( false, "then should not be called on resolve" ); + assert.ok( false, "then should not be called on resolve" ); + }).then( done.pop() ); + + jQuery.Deferred().reject().then( null, jQuery.noop ).done(function( value ) { + assert.strictEqual( value, undefined, "then fail callback can return undefined/null" ); + done.pop().call(); }); +}); + +test( "[DIVERGENT] jQuery.Deferred.pipe - filtering (fail)", function( assert ) { + + assert.expect( 4 ); + + var value1, value2, value3, + defer = jQuery.Deferred(), + piped = defer.pipe( null, function( a, b ) { + return a * b; + }), + done = jQuery.map( new Array( 3 ), function() { return assert.async(); } ); - jQuery.Deferred().reject().then( null, jQuery.noop ).fail(function( value ) { - strictEqual( value, undefined, "then fail callback can return undefined/null" ); + piped.fail(function( result ) { + value3 = result; + }); + + defer.fail(function( a, b ) { + value1 = a; + value2 = b; + }); + + defer.reject( 2, 3 ).pipe( null, function() { + assert.strictEqual( value1, 2, "first reject value ok" ); + assert.strictEqual( value2, 3, "second reject value ok" ); + assert.strictEqual( value3, 6, "result of filter ok" ); + done.pop().call(); + }); + + jQuery.Deferred().resolve().pipe( null, function() { + assert.ok( false, "then should not be called on resolve" ); + }).then( done.pop() ); + + jQuery.Deferred().reject().pipe( null, jQuery.noop ).fail(function( value ) { + assert.strictEqual( value, undefined, "then fail callback can return undefined/null" ); + done.pop().call(); }); }); -test( "jQuery.Deferred.then - filtering (progress)", function() { +test( "jQuery.Deferred.then - filtering (progress)", function( assert ) { - expect( 3 ); + assert.expect( 3 ); var value1, value2, value3, defer = jQuery.Deferred(), piped = defer.then( null, null, function( a, b ) { return a * b; - }); + }), + done = assert.async(); piped.progress(function( result ) { value3 = result; @@ -180,16 +224,17 @@ test( "jQuery.Deferred.then - filtering (progress)", function() { value2 = b; }); - defer.notify( 2, 3 ); - - strictEqual( value1, 2, "first progress value ok" ); - strictEqual( value2, 3, "second progress value ok" ); - strictEqual( value3, 6, "result of filter ok" ); + defer.notify( 2, 3 ).then( null, null, function() { + assert.strictEqual( value1, 2, "first progress value ok" ); + assert.strictEqual( value2, 3, "second progress value ok" ); + assert.strictEqual( value3, 6, "result of filter ok" ); + done(); + }); }); -test( "jQuery.Deferred.then - deferred (done)", function() { +test( "jQuery.Deferred.then - deferred (done)", function( assert ) { - expect( 3 ); + assert.expect( 3 ); var value1, value2, value3, defer = jQuery.Deferred(), @@ -197,7 +242,8 @@ test( "jQuery.Deferred.then - deferred (done)", function() { return jQuery.Deferred(function( defer ) { defer.reject( a * b ); }); - }); + }), + done = assert.async(); piped.fail(function( result ) { value3 = result; @@ -210,14 +256,17 @@ test( "jQuery.Deferred.then - deferred (done)", function() { defer.resolve( 2, 3 ); - strictEqual( value1, 2, "first resolve value ok" ); - strictEqual( value2, 3, "second resolve value ok" ); - strictEqual( value3, 6, "result of filter ok" ); + piped.fail(function() { + assert.strictEqual( value1, 2, "first resolve value ok" ); + assert.strictEqual( value2, 3, "second resolve value ok" ); + assert.strictEqual( value3, 6, "result of filter ok" ); + done(); + }); }); -test( "jQuery.Deferred.then - deferred (fail)", function() { +test( "jQuery.Deferred.then - deferred (fail)", function( assert ) { - expect( 3 ); + assert.expect( 3 ); var value1, value2, value3, defer = jQuery.Deferred(), @@ -225,7 +274,8 @@ test( "jQuery.Deferred.then - deferred (fail)", function() { return jQuery.Deferred(function( defer ) { defer.resolve( a * b ); }); - }); + }), + done = assert.async(); piped.done(function( result ) { value3 = result; @@ -238,14 +288,17 @@ test( "jQuery.Deferred.then - deferred (fail)", function() { defer.reject( 2, 3 ); - strictEqual( value1, 2, "first reject value ok" ); - strictEqual( value2, 3, "second reject value ok" ); - strictEqual( value3, 6, "result of filter ok" ); + piped.done(function() { + assert.strictEqual( value1, 2, "first reject value ok" ); + assert.strictEqual( value2, 3, "second reject value ok" ); + assert.strictEqual( value3, 6, "result of filter ok" ); + done(); + }); }); -test( "jQuery.Deferred.then - deferred (progress)", function() { +test( "jQuery.Deferred.then - deferred (progress)", function( assert ) { - expect( 3 ); + assert.expect( 3 ); var value1, value2, value3, defer = jQuery.Deferred(), @@ -253,7 +306,48 @@ test( "jQuery.Deferred.then - deferred (progress)", function() { return jQuery.Deferred(function( defer ) { defer.resolve( a * b ); }); + }), + done = assert.async(); + + piped.progress(function( result ) { + return jQuery.Deferred().resolve().then(function() { + return result; + }).then(function( result ) { + value3 = result; }); + }); + + defer.progress(function( a, b ) { + value1 = a; + value2 = b; + }); + + defer.notify( 2, 3 ); + + piped.then( null, null, function( result ) { + return jQuery.Deferred().resolve().then(function() { + return result; + }).then(function() { + assert.strictEqual( value1, 2, "first progress value ok" ); + assert.strictEqual( value2, 3, "second progress value ok" ); + assert.strictEqual( value3, 6, "result of filter ok" ); + done(); + }); + }); +}); + +test( "[DIVERGENT] jQuery.Deferred.pipe - deferred (progress)", function( assert ) { + + assert.expect( 3 ); + + var value1, value2, value3, + defer = jQuery.Deferred(), + piped = defer.pipe( null, null, function( a, b ) { + return jQuery.Deferred(function( defer ) { + defer.resolve( a * b ); + }); + }), + done = assert.async(); piped.done(function( result ) { value3 = result; @@ -266,29 +360,36 @@ test( "jQuery.Deferred.then - deferred (progress)", function() { defer.notify( 2, 3 ); - strictEqual( value1, 2, "first progress value ok" ); - strictEqual( value2, 3, "second progress value ok" ); - strictEqual( value3, 6, "result of filter ok" ); + piped.done(function() { + assert.strictEqual( value1, 2, "first progress value ok" ); + assert.strictEqual( value2, 3, "second progress value ok" ); + assert.strictEqual( value3, 6, "result of filter ok" ); + done(); + }); }); -test( "jQuery.Deferred.then - context", function() { +test( "jQuery.Deferred.then - context", function( assert ) { - expect( 7 ); + assert.expect( 7 ); var defer, piped, defer2, piped2, - context = {}; + context = {}, + done = jQuery.map( new Array( 4 ), function() { return assert.async(); } ); jQuery.Deferred().resolveWith( context, [ 2 ] ).then(function( value ) { return value * 3; }).done(function( value ) { - strictEqual( this, context, "custom context correctly propagated" ); - strictEqual( value, 6, "proper value received" ); + assert.notStrictEqual( this, context, "custom context not propagated through .then" ); + assert.strictEqual( value, 6, "proper value received" ); + done.pop().call(); }); jQuery.Deferred().resolve().then(function() { return jQuery.Deferred().resolveWith(context); }).done(function() { - strictEqual( this, context, "custom context of returned deferred correctly propagated" ); + assert.strictEqual( this, context, + "custom context of returned deferred correctly propagated" ); + done.pop().call(); }); defer = jQuery.Deferred(); @@ -299,8 +400,10 @@ test( "jQuery.Deferred.then - context", function() { defer.resolve( 2 ); piped.done(function( value ) { - strictEqual( this, piped, "default context gets updated to latest promise in the chain" ); - strictEqual( value, 6, "proper value received" ); + assert.strictEqual( this, piped, + "default context gets updated to latest promise in the chain" ); + assert.strictEqual( value, 6, "proper value received" ); + done.pop().call(); }); defer2 = jQuery.Deferred(); @@ -309,8 +412,61 @@ test( "jQuery.Deferred.then - context", function() { defer2.resolve( 2 ); piped2.done(function( value ) { - strictEqual( this, piped2, "default context gets updated to latest promise in the chain (without passing function)" ); - strictEqual( value, 2, "proper value received (without passing function)" ); + assert.strictEqual( this, piped2, + "default context updated to latest promise in the chain (without passing function)" ); + assert.strictEqual( value, 2, "proper value received (without passing function)" ); + done.pop().call(); + }); +}); + +test( "[DIVERGENT] jQuery.Deferred.pipe - context", function( assert ) { + + assert.expect( 7 ); + + var defer, piped, defer2, piped2, + context = {}, + done = jQuery.map( new Array( 4 ), function() { return assert.async(); } ); + + jQuery.Deferred().resolveWith( context, [ 2 ] ).pipe(function( value ) { + return value * 3; + }).done(function( value ) { + assert.strictEqual( this, context, "[DIVERGENT] custom context correctly propagated" ); + assert.strictEqual( value, 6, "proper value received" ); + done.pop().call(); + }); + + jQuery.Deferred().resolve().pipe(function() { + return jQuery.Deferred().resolveWith(context); + }).done(function() { + assert.strictEqual( this, context, + "custom context of returned deferred correctly propagated" ); + done.pop().call(); + }); + + defer = jQuery.Deferred(); + piped = defer.pipe(function( value ) { + return value * 3; + }); + + defer.resolve( 2 ); + + piped.done(function( value ) { + assert.strictEqual( this, piped, + "default context gets updated to latest promise in the chain" ); + assert.strictEqual( value, 6, "proper value received" ); + done.pop().call(); + }); + + defer2 = jQuery.Deferred(); + piped2 = defer2.pipe(); + + defer2.resolve( 2 ); + + piped2.done(function( value ) { + assert.strictEqual( this, piped2, + "default context updated to latest promise in the chain (without passing function)" ); + assert.strictEqual( value, 2, "proper value received (without passing function)" ); + done.pop().call(); }); }); From b21e76f912c70a184a81472ebc1a124eebf7ac29 Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Mon, 5 Jan 2015 23:56:09 -0500 Subject: [PATCH 05/18] Deferred: Pass explicitly-set context to .then callbacks Passes all jQuery QUnit tests. raw gz Sizes 249550 73734 dist/jquery.js 84891 29568 dist/jquery.min.js raw gz Compared to master @ 66e1b6b8d49812239b5712d65922ff94c60f7b02 +2625 +515 dist/jquery.js +698 +173 dist/jquery.min.js raw gz Compared to last run +280 +59 dist/jquery.js +91 +28 dist/jquery.min.js --- src/deferred.js | 10 ++++++++-- test/unit/deferred.js | 2 +- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/src/deferred.js b/src/deferred.js index 91dcb611b3..d76b12d6d5 100644 --- a/src/deferred.js +++ b/src/deferred.js @@ -63,7 +63,7 @@ jQuery.extend({ then: function( onFulfilled, onRejected, onProgress ) { function resolve( deferred, handler ) { return function() { - var that = this, + var that = this === promise ? undefined : this, args = arguments; setTimeout(function() { var returned; @@ -75,11 +75,17 @@ jQuery.extend({ resolve( deferred, Thrower ), deferred.notify ); + } else if ( Identity === handler ) { + deferred.resolveWith( that || deferred.promise(), args ); } else { deferred.resolve( returned ); } } catch ( e ) { - deferred.reject( e ); + if ( Thrower === handler ) { + deferred.rejectWith( that || deferred.promise(), args ); + } else { + deferred.reject( e ); + } } }); }; diff --git a/test/unit/deferred.js b/test/unit/deferred.js index 16d67eda94..f5b2af3e32 100644 --- a/test/unit/deferred.js +++ b/test/unit/deferred.js @@ -385,7 +385,7 @@ test( "jQuery.Deferred.then - context", function( assert ) { }); jQuery.Deferred().resolve().then(function() { - return jQuery.Deferred().resolveWith(context); + return jQuery.Deferred().resolveWith( context ); }).done(function() { assert.strictEqual( this, context, "custom context of returned deferred correctly propagated" ); From f7e36bfe574562fb9a0c0ab6f9619d3070c281d2 Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Tue, 6 Jan 2015 00:14:08 -0500 Subject: [PATCH 06/18] Deferred: Pass Promises/A+ section 2.3.1 Reject promise self-resolution loops. raw gz Sizes 249741 73808 dist/jquery.js 84930 29583 dist/jquery.min.js raw gz Compared to master @ 66e1b6b8d49812239b5712d65922ff94c60f7b02 +2816 +589 dist/jquery.js +737 +188 dist/jquery.min.js raw gz Compared to last run +191 +74 dist/jquery.js +39 +15 dist/jquery.min.js --- src/deferred.js | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/deferred.js b/src/deferred.js index d76b12d6d5..799080fe75 100644 --- a/src/deferred.js +++ b/src/deferred.js @@ -69,6 +69,13 @@ jQuery.extend({ var returned; try { returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError(); + } + if ( returned && jQuery.isFunction( returned.then ) ) { returned.then( resolve( deferred, Identity ), From 02fbbe281ce42e6068440b2f9690dd4ccf1d18d3 Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Tue, 6 Jan 2015 00:43:17 -0500 Subject: [PATCH 07/18] Deferred: Pass Promises/A+ section 2.3.3.1 Retrieve `then` only once per fulfillment value. raw gz Sizes 249976 73882 dist/jquery.js 84938 29589 dist/jquery.min.js raw gz Compared to master @ 66e1b6b8d49812239b5712d65922ff94c60f7b02 +3051 +663 dist/jquery.js +745 +194 dist/jquery.min.js raw gz Compared to last run +235 +74 dist/jquery.js +8 +6 dist/jquery.min.js --- src/deferred.js | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/deferred.js b/src/deferred.js index 799080fe75..01c31319e6 100644 --- a/src/deferred.js +++ b/src/deferred.js @@ -66,7 +66,7 @@ jQuery.extend({ var that = this === promise ? undefined : this, args = arguments; setTimeout(function() { - var returned; + var returned, then; try { returned = handler.apply( that, args ); @@ -76,8 +76,15 @@ jQuery.extend({ throw new TypeError(); } - if ( returned && jQuery.isFunction( returned.then ) ) { - returned.then( + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && returned.then; + + if ( jQuery.isFunction( then ) ) { + then.call( + returned, resolve( deferred, Identity ), resolve( deferred, Thrower ), deferred.notify From ba97c51435773a39ac55c54903d4dc1c23e9c2d3 Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Tue, 6 Jan 2015 01:16:15 -0500 Subject: [PATCH 08/18] Deferred: Pass Promises/A+ section 2.3.3.3.1 (resolve-then-throw case) Skip setTimeout for re-resolution so synchronous errors don't interrupt it. raw gz Sizes 250371 73993 dist/jquery.js 84968 29606 dist/jquery.min.js raw gz Compared to master @ 66e1b6b8d49812239b5712d65922ff94c60f7b02 +3446 +774 dist/jquery.js +775 +211 dist/jquery.min.js raw gz Compared to last run +395 +111 dist/jquery.js +30 +17 dist/jquery.min.js --- src/deferred.js | 83 ++++++++++++++++++++++++++++--------------------- 1 file changed, 48 insertions(+), 35 deletions(-) diff --git a/src/deferred.js b/src/deferred.js index 01c31319e6..202549c326 100644 --- a/src/deferred.js +++ b/src/deferred.js @@ -61,47 +61,60 @@ jQuery.extend({ }).promise(); }, then: function( onFulfilled, onRejected, onProgress ) { - function resolve( deferred, handler ) { + var maxDepth = 0; + function resolve( deferred, handler, depth ) { return function() { var that = this === promise ? undefined : this, - args = arguments; - setTimeout(function() { - var returned, then; - try { - returned = handler.apply( that, args ); + args = arguments, + fn = function() { + var returned, then; + try { + returned = handler.apply( that, args ); - // Support: Promises/A+ section 2.3.1 - // https://promisesaplus.com/#point-48 - if ( returned === deferred.promise() ) { - throw new TypeError(); - } + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError(); + } - // Support: Promises/A+ sections 2.3.3.1, 3.5 - // https://promisesaplus.com/#point-54 - // https://promisesaplus.com/#point-75 - // Retrieve `then` only once - then = returned && returned.then; + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && returned.then; - if ( jQuery.isFunction( then ) ) { - then.call( - returned, - resolve( deferred, Identity ), - resolve( deferred, Thrower ), - deferred.notify - ); - } else if ( Identity === handler ) { - deferred.resolveWith( that || deferred.promise(), args ); - } else { - deferred.resolve( returned ); - } - } catch ( e ) { - if ( Thrower === handler ) { - deferred.rejectWith( that || deferred.promise(), args ); - } else { - deferred.reject( e ); + if ( jQuery.isFunction( then ) ) { + maxDepth++; + then.call( + returned, + resolve( deferred, Identity, maxDepth ), + resolve( deferred, Thrower, maxDepth ), + deferred.notify + ); + } else if ( Identity === handler ) { + deferred.resolveWith( that || deferred.promise(), + args ); + } else { + deferred.resolve( returned ); + } + } catch ( e ) { + if ( Thrower === handler ) { + deferred.rejectWith( that || deferred.promise(), args ); + } else { + deferred.reject( e ); + } } - } - }); + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + fn(); + } else { + setTimeout( fn ); + } }; } From 85f32ddf2ac945d851aad23c5bc3e24f53e738f1 Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Tue, 6 Jan 2015 01:30:08 -0500 Subject: [PATCH 09/18] Deferred: Pass Promises/A+ section 2.3.3.3.3 Ignore double-resolution attempts. raw gz Sizes 250582 74046 dist/jquery.js 84978 29614 dist/jquery.min.js raw gz Compared to master @ 66e1b6b8d49812239b5712d65922ff94c60f7b02 +3657 +827 dist/jquery.js +785 +219 dist/jquery.min.js raw gz Compared to last run +211 +53 dist/jquery.js +10 +8 dist/jquery.min.js --- src/deferred.js | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/deferred.js b/src/deferred.js index 202549c326..01cccd122f 100644 --- a/src/deferred.js +++ b/src/deferred.js @@ -68,6 +68,14 @@ jQuery.extend({ args = arguments, fn = function() { var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + try { returned = handler.apply( that, args ); From 747421d38c9ffebd7a3ba214da9db2341e33c22c Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Tue, 6 Jan 2015 02:24:21 -0500 Subject: [PATCH 10/18] Deferred: Pass Promises/A+ section 2.3.3.3.4.1 Ignore post-resolution exceptions. raw gz Sizes 250862 74103 dist/jquery.js 84992 29621 dist/jquery.min.js raw gz Compared to master @ 66e1b6b8d49812239b5712d65922ff94c60f7b02 +3937 +884 dist/jquery.js +799 +226 dist/jquery.min.js raw gz Compared to last run +280 +57 dist/jquery.js +14 +7 dist/jquery.min.js --- src/deferred.js | 33 +++++++++++++++++++++++---------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/src/deferred.js b/src/deferred.js index 01cccd122f..a2b8442894 100644 --- a/src/deferred.js +++ b/src/deferred.js @@ -106,10 +106,17 @@ jQuery.extend({ deferred.resolve( returned ); } } catch ( e ) { - if ( Thrower === handler ) { - deferred.rejectWith( that || deferred.promise(), args ); - } else { - deferred.reject( e ); + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + if ( Thrower === handler ) { + deferred.rejectWith( that || deferred.promise(), + args ); + } else { + deferred.reject( e ); + } } } }; @@ -129,17 +136,23 @@ jQuery.extend({ return jQuery.Deferred(function( newDefer ) { // fulfilled_handlers.add( ... ) tuples[ 0 ][ 3 ].add( - resolve( newDefer, jQuery.isFunction( onFulfilled ) ? - onFulfilled : - Identity + resolve( + newDefer, + jQuery.isFunction( onFulfilled ) ? + onFulfilled : + Identity, + 0 ) ); // rejected_handlers.add( ... ) tuples[ 1 ][ 3 ].add( - resolve( newDefer, jQuery.isFunction( onRejected ) ? - onRejected : - Thrower + resolve( + newDefer, + jQuery.isFunction( onRejected ) ? + onRejected : + Thrower, + 0 ) ); From 79276be78e47701cdfbd51df7d90bbf8eab085f2 Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Tue, 6 Jan 2015 02:31:15 -0500 Subject: [PATCH 11/18] Deferred: Pass Promises/A+ section 2.3.4 Only check objects and functions for thenability. raw gz Sizes 251129 74152 dist/jquery.js 85036 29630 dist/jquery.min.js raw gz Compared to master @ 66e1b6b8d49812239b5712d65922ff94c60f7b02 +4204 +933 dist/jquery.js +843 +235 dist/jquery.min.js raw gz Compared to last run +267 +49 dist/jquery.js +44 +9 dist/jquery.min.js --- src/deferred.js | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/deferred.js b/src/deferred.js index a2b8442894..885b28e650 100644 --- a/src/deferred.js +++ b/src/deferred.js @@ -89,7 +89,14 @@ jQuery.extend({ // https://promisesaplus.com/#point-54 // https://promisesaplus.com/#point-75 // Retrieve `then` only once - then = returned && returned.then; + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; if ( jQuery.isFunction( then ) ) { maxDepth++; From 0da2b1a285dd3baea7a6298bcd8342f33b11f768 Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Mon, 12 Jan 2015 18:35:01 -0500 Subject: [PATCH 12/18] Deferred: Properly handle thenable/progress interactions Unwrap thenables for progress handlers Await fulfillment (ONLY) from thenables returned by progress handlers * Ignore progress * Throw rejections raw gz Sizes 252116 74390 dist/jquery.js 85040 29641 dist/jquery.min.js raw gz Compared to master @ 66e1b6b8d49812239b5712d65922ff94c60f7b02 +5191 +1171 dist/jquery.js +847 +246 dist/jquery.min.js raw gz Compared to last run +987 +239 dist/jquery.js +4 +11 dist/jquery.min.js --- src/deferred.js | 146 ++++++++++++++++++++++++++---------------- test/unit/deferred.js | 62 ++++++++++++++---- 2 files changed, 141 insertions(+), 67 deletions(-) diff --git a/src/deferred.js b/src/deferred.js index 885b28e650..89f207dd33 100644 --- a/src/deferred.js +++ b/src/deferred.js @@ -62,11 +62,11 @@ jQuery.extend({ }, then: function( onFulfilled, onRejected, onProgress ) { var maxDepth = 0; - function resolve( deferred, handler, depth ) { + function resolve( depth, deferred, handler, special ) { return function() { var that = this === promise ? undefined : this, args = arguments, - fn = function() { + mightThrow = function() { var returned, then; // Support: Promises/A+ section 2.3.3.3.3 @@ -76,66 +76,101 @@ jQuery.extend({ return; } - try { - returned = handler.apply( that, args ); + returned = handler.apply( that, args ); - // Support: Promises/A+ section 2.3.1 - // https://promisesaplus.com/#point-48 - if ( returned === deferred.promise() ) { - throw new TypeError(); - } + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError(); + } - // Support: Promises/A+ sections 2.3.3.1, 3.5 - // https://promisesaplus.com/#point-54 - // https://promisesaplus.com/#point-75 - // Retrieve `then` only once - then = returned && + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( jQuery.isFunction( then ) ) { + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); - // Support: Promises/A+ section 2.3.4 - // https://promisesaplus.com/#point-64 - // Only check objects and functions for thenability - ( typeof returned === "object" || - typeof returned === "function" ) && - returned.then; + // Normal processors (resolve) also hook into progress + } else { - if ( jQuery.isFunction( then ) ) { + // ...and disregard older resolution values maxDepth++; + then.call( returned, - resolve( deferred, Identity, maxDepth ), - resolve( deferred, Thrower, maxDepth ), - deferred.notify + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notify ) ); - } else if ( Identity === handler ) { - deferred.resolveWith( that || deferred.promise(), - args ); - } else { - deferred.resolve( returned ); } - } catch ( e ) { - // Support: Promises/A+ section 2.3.3.3.4.1 - // https://promisesaplus.com/#point-61 - // Ignore post-resolution exceptions - if ( depth + 1 >= maxDepth ) { - if ( Thrower === handler ) { + // Handle all other returned values + } else { + // Only substitue handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( + that || deferred.promise(), args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + // Only substitue handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + deferred.rejectWith( that || deferred.promise(), args ); - } else { - deferred.reject( e ); } } - } - }; + }; // Support: Promises/A+ section 2.3.3.3.1 // https://promisesaplus.com/#point-57 // Re-resolve promises immediately to dodge false rejection from // subsequent errors if ( depth ) { - fn(); + process(); } else { - setTimeout( fn ); + setTimeout( process ); } }; } @@ -144,37 +179,36 @@ jQuery.extend({ // fulfilled_handlers.add( ... ) tuples[ 0 ][ 3 ].add( resolve( + 0, newDefer, jQuery.isFunction( onFulfilled ) ? onFulfilled : - Identity, - 0 + Identity ) ); // rejected_handlers.add( ... ) tuples[ 1 ][ 3 ].add( resolve( + 0, newDefer, jQuery.isFunction( onRejected ) ? onRejected : - Thrower, - 0 + Thrower ) ); // progress_handlers.add( ... ) - tuples[ 2 ][ 3 ].add(function() { - var that = this, - args = arguments; - setTimeout(function() { - if ( jQuery.isFunction( onProgress ) ) { - args = [ onProgress.apply( that, args ) ]; - that = newDefer.promise(); - } - newDefer.notifyWith( that, args ); - }); - }); + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + jQuery.isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); }).promise(); }, // Get a promise for this deferred diff --git a/test/unit/deferred.js b/test/unit/deferred.js index f5b2af3e32..ad82bf8c9f 100644 --- a/test/unit/deferred.js +++ b/test/unit/deferred.js @@ -488,41 +488,81 @@ asyncTest( "jQuery.Deferred.then - spec compatibility", function() { } catch ( _ ) {} }); -asyncTest( "jQuery.Deferred - 1.x/2.x compatibility", function() { +test( "jQuery.Deferred - 1.x/2.x compatibility", function( assert ) { - expect( 7 ); + expect( 8 ); var context = { id: "callback context" }, - thenable = jQuery.Deferred().resolve( "thenable fulfillment value" ).promise(); + thenable = jQuery.Deferred().resolve( "thenable fulfillment" ).promise(), + done = jQuery.map( new Array( 8 ), function() { return assert.async(); } ); + + thenable.unwrapped = false; jQuery.Deferred().resolve( 1, 2 ).then(function() { - deepEqual( [].slice.call( arguments ), [ 1, 2 ], + assert.deepEqual( [].slice.call( arguments ), [ 1, 2 ], ".then fulfillment callbacks receive all resolution values" ); + done.pop().call(); }); jQuery.Deferred().reject( 1, 2 ).then( null, function() { - deepEqual( [].slice.call( arguments ), [ 1, 2 ], + assert.deepEqual( [].slice.call( arguments ), [ 1, 2 ], ".then rejection callbacks receive all rejection values" ); + done.pop().call(); }); jQuery.Deferred().notify( 1, 2 ).then( null, null, function() { - deepEqual( [].slice.call( arguments ), [ 1, 2 ], + assert.deepEqual( [].slice.call( arguments ), [ 1, 2 ], ".then progress callbacks receive all progress values" ); + done.pop().call(); }); jQuery.Deferred().resolveWith( context ).then(function() { - deepEqual( this, context, ".then fulfillment callbacks receive context" ); + assert.deepEqual( this, context, ".then fulfillment callbacks receive context" ); + done.pop().call(); }); jQuery.Deferred().rejectWith( context ).then( null, function() { - deepEqual( this, context, ".then rejection callbacks receive context" ); + assert.deepEqual( this, context, ".then rejection callbacks receive context" ); + done.pop().call(); }); jQuery.Deferred().notifyWith( context ).then( null, null, function() { - deepEqual( this, context, ".then progress callbacks receive context" ); + assert.deepEqual( this, context, ".then progress callbacks receive context" ); + done.pop().call(); }); jQuery.Deferred().resolve( thenable ).done(function( value ) { - strictEqual( value, thenable, ".done doesn't unwrap thenables" ); + assert.strictEqual( value, thenable, ".done doesn't unwrap thenables" ); + done.pop().call(); }); - setTimeout( start ); + jQuery.Deferred().notify( thenable ).then().then( null, null, function( value ) { + assert.strictEqual( value, "thenable fulfillment", + ".then implicit progress callbacks unwrap thenables" ); + done.pop().call(); + }); +}); + +test( "jQuery.Deferred.then - progress and thenables", function( assert ) { + + expect( 2 ); + + var trigger = jQuery.Deferred().notify(), + expectedProgress = [ "baz", "baz" ], + done = jQuery.map( new Array( 2 ), function() { return assert.async(); } ), + failer = function( evt ) { + return function() { + ok( false, "no unexpected " + evt ); + }; + }; + + trigger.then( null, null, function() { + var notifier = jQuery.Deferred().notify( "foo" ); + setTimeout(function() { + notifier.notify( "bar" ).resolve( "baz" ); + }); + return notifier; + }).then( failer( "fulfill" ), failer( "reject" ), function( v ) { + assert.strictEqual( v, expectedProgress.shift(), "expected progress value" ); + done.pop().call(); + }); + trigger.notify(); }); test( "jQuery.when", function() { From 43e71b3e6158a074298d6be51c95d5ef69160256 Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Wed, 14 Jan 2015 23:57:27 -0500 Subject: [PATCH 13/18] Deferred: Standards-compliant jQuery.when tests (partially cherry picked from commit b677541bc4a6d48f96fc7d1351ce6d72c5055bdc) (partially cherry picked from commit 02204a9dfc96f6c5840f90e67dd79d5495cf7d86) Conflicts: test/unit/deferred.js package.json --- Gruntfile.js | 2 + external/npo/npo.js | 5 ++ external/requirejs/require.js | 4 +- package.json | 3 +- test/index.html | 1 + test/unit/deferred.js | 99 ++++++++++++++++++++++++++++++++--- 6 files changed, 104 insertions(+), 10 deletions(-) create mode 100644 external/npo/npo.js diff --git a/Gruntfile.js b/Gruntfile.js index 10410a3e48..8dd1e969af 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -56,6 +56,8 @@ module.exports = function( grunt ) { "sizzle/dist": "sizzle/dist", "sizzle/LICENSE.txt": "sizzle/LICENSE.txt", + "npo/npo.js": "native-promise-only/npo.js", + "qunit/qunit.js": "qunitjs/qunit/qunit.js", "qunit/qunit.css": "qunitjs/qunit/qunit.css", "qunit/LICENSE.txt": "qunitjs/LICENSE.txt", diff --git a/external/npo/npo.js b/external/npo/npo.js new file mode 100644 index 0000000000..bd070846c5 --- /dev/null +++ b/external/npo/npo.js @@ -0,0 +1,5 @@ +/*! Native Promise Only + v0.7.6-a (c) Kyle Simpson + MIT License: http://getify.mit-license.org +*/ +!function(t,n,e){n[t]=n[t]||e(),"undefined"!=typeof module&&module.exports?module.exports=n[t]:"function"==typeof define&&define.amd&&define(function(){return n[t]})}("Promise","undefined"!=typeof global?global:this,function(){"use strict";function t(t,n){l.add(t,n),h||(h=y(l.drain))}function n(t){var n,e=typeof t;return null==t||"object"!=e&&"function"!=e||(n=t.then),"function"==typeof n?n:!1}function e(){for(var t=0;t0&&t(e,a))}catch(s){i.call(u||new f(a),s)}}}function i(n){var o=this;o.triggered||(o.triggered=!0,o.def&&(o=o.def),o.msg=n,o.state=2,o.chain.length>0&&t(e,o))}function c(t,n,e,o){for(var r=0;r + diff --git a/test/unit/deferred.js b/test/unit/deferred.js index ad82bf8c9f..b0a1995a58 100644 --- a/test/unit/deferred.js +++ b/test/unit/deferred.js @@ -627,7 +627,7 @@ test( "jQuery.when", function() { test( "jQuery.when - joined", function() { - expect( 119 ); + expect( 195 ); var deferreds = { value: 1, @@ -635,22 +635,35 @@ test( "jQuery.when - joined", function() { error: jQuery.Deferred().reject( 0 ), futureSuccess: jQuery.Deferred().notify( true ), futureError: jQuery.Deferred().notify( true ), + futureStdSuccess: Promise.resolve( 1 ), + futureStdError: Promise.reject( 0 ), notify: jQuery.Deferred().notify( true ) }, willSucceed = { value: true, success: true, - futureSuccess: true + futureSuccess: true, + futureStdSuccess: true }, willError = { error: true, - futureError: true + futureError: true, + futureStdError: true }, willNotify = { futureSuccess: true, futureError: true, notify: true - }; + }, + counter = 49; + + stop(); + + function restart() { + if ( !--counter ) { + start(); + } + } jQuery.each( deferreds, function( id1, defer1 ) { jQuery.each( deferreds, function( id2, defer2 ) { @@ -660,8 +673,10 @@ test( "jQuery.when - joined", function() { expected = shouldResolve ? [ 1, 1 ] : [ 0, undefined ], expectedNotify = shouldNotify && [ willNotify[ id1 ], willNotify[ id2 ] ], code = id1 + "/" + id2, - context1 = defer1 && jQuery.isFunction( defer1.promise ) ? defer1.promise() : undefined, - context2 = defer2 && jQuery.isFunction( defer2.promise ) ? defer2.promise() : undefined; + context1 = defer1 && jQuery.isFunction( defer1.promise ) ? defer1.promise() : + ( defer1.then ? window : undefined ), + context2 = defer2 && jQuery.isFunction( defer2.promise ) ? defer2.promise() : + ( defer2.then ? window : undefined ); jQuery.when( defer1, defer2 ).done(function( a, b ) { if ( shouldResolve ) { @@ -681,7 +696,7 @@ test( "jQuery.when - joined", function() { deepEqual( [ a, b ], expectedNotify, code + " => progress" ); strictEqual( this[ 0 ], expectedNotify[ 0 ] ? context1 : undefined, code + " => first context OK" ); strictEqual( this[ 1 ], expectedNotify[ 1 ] ? context2 : undefined, code + " => second context OK" ); - }); + }).always( restart ); }); }); deferreds.futureSuccess.resolve( 1 ); @@ -707,5 +722,75 @@ test( "jQuery.when - resolved", function() { }).fail(function() { ok( false, "Error on resolve" ); }); +}); + +test( "jQuery.when - filtering", function() { + + expect( 2 ); + + function double( x ) { + return 2 * x; + } + + stop(); + + jQuery.when( + jQuery.Deferred().resolve( 3 ).then( double ), + jQuery.Deferred().reject( 5 ).then( null, double ) + ).done(function( six, ten ) { + strictEqual( six, 6, "resolved value doubled" ); + strictEqual( ten, 10, "rejected value doubled" ); + start(); + }); +}); + +test( "jQuery.when - exceptions", function() { + + expect( 2 ); + + function woops() { + throw "exception thrown"; + } + + stop(); + + jQuery.Deferred().resolve().then( woops ).fail(function( doneException ) { + strictEqual( doneException, "exception thrown", "throwing in done handler" ); + jQuery.Deferred().reject().then( null, woops ).fail(function( failException ) { + strictEqual( failException, "exception thrown", "throwing in fail handler" ); + start(); + }); + }); +}); + +test( "jQuery.when - chaining", function() { + + expect( 4 ); + + var defer = jQuery.Deferred(); + + function chain() { + return defer; + } + + function chainStandard() { + return Promise.resolve( "std deferred" ); + } + + stop(); + + jQuery.when( + jQuery.Deferred().resolve( 3 ).then( chain ), + jQuery.Deferred().reject( 5 ).then( null, chain ), + jQuery.Deferred().resolve( 3 ).then( chainStandard ), + jQuery.Deferred().reject( 5 ).then( null, chainStandard ) + ).done(function( v1, v2, s1, s2 ) { + strictEqual( v1, "other deferred", "chaining in done handler" ); + strictEqual( v2, "other deferred", "chaining in fail handler" ); + strictEqual( s1, "std deferred", "chaining thenable in done handler" ); + strictEqual( s2, "std deferred", "chaining thenable in fail handler" ); + start(); + }); + defer.resolve( "other deferred" ); }); From d838eb4eef599d5988c6b9adbbea74fa69092b84 Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Sun, 18 Jan 2015 14:39:45 -0500 Subject: [PATCH 14/18] Tests: Clean up jQuery.when tests --- test/unit/deferred.js | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/test/unit/deferred.js b/test/unit/deferred.js index b0a1995a58..d7b6ce13df 100644 --- a/test/unit/deferred.js +++ b/test/unit/deferred.js @@ -630,30 +630,30 @@ test( "jQuery.when - joined", function() { expect( 195 ); var deferreds = { - value: 1, - success: jQuery.Deferred().resolve( 1 ), - error: jQuery.Deferred().reject( 0 ), - futureSuccess: jQuery.Deferred().notify( true ), - futureError: jQuery.Deferred().notify( true ), - futureStdSuccess: Promise.resolve( 1 ), - futureStdError: Promise.reject( 0 ), - notify: jQuery.Deferred().notify( true ) + rawValue: 1, + fulfilled: jQuery.Deferred().resolve( 1 ), + rejected: jQuery.Deferred().reject( 0 ), + notified: jQuery.Deferred().notify( true ), + eventuallyFulfilled: jQuery.Deferred().notify( true ), + eventuallyRejected: jQuery.Deferred().notify( true ), + fulfilledStandardPromise: Promise.resolve( 1 ), + rejectedStandardPromise: Promise.reject( 0 ) }, willSucceed = { - value: true, - success: true, - futureSuccess: true, - futureStdSuccess: true + rawValue: true, + fulfilled: true, + eventuallyFulfilled: true, + fulfilledStandardPromise: true }, willError = { - error: true, - futureError: true, - futureStdError: true + rejected: true, + eventuallyRejected: true, + rejectedStandardPromise: true }, willNotify = { - futureSuccess: true, - futureError: true, - notify: true + notified: true, + eventuallyFulfilled: true, + eventuallyRejected: true }, counter = 49; @@ -672,7 +672,7 @@ test( "jQuery.when - joined", function() { shouldNotify = willNotify[ id1 ] || willNotify[ id2 ], expected = shouldResolve ? [ 1, 1 ] : [ 0, undefined ], expectedNotify = shouldNotify && [ willNotify[ id1 ], willNotify[ id2 ] ], - code = id1 + "/" + id2, + code = "jQuery.when( " + id1 + ", " + id2 + " )", context1 = defer1 && jQuery.isFunction( defer1.promise ) ? defer1.promise() : ( defer1.then ? window : undefined ), context2 = defer2 && jQuery.isFunction( defer2.promise ) ? defer2.promise() : @@ -699,8 +699,8 @@ test( "jQuery.when - joined", function() { }).always( restart ); }); }); - deferreds.futureSuccess.resolve( 1 ); - deferreds.futureError.reject( 0 ); + deferreds.eventuallyFulfilled.resolve( 1 ); + deferreds.eventuallyRejected.reject( 0 ); }); test( "jQuery.when - resolved", function() { From faf1adfeccd60ce684c383d96a1fb892a6dccfcb Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Sun, 18 Jan 2015 15:01:43 -0500 Subject: [PATCH 15/18] Deferred: Rename jQuery.when variable for clarity --- src/deferred.js | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/deferred.js b/src/deferred.js index 89f207dd33..0a32d1e1d8 100644 --- a/src/deferred.js +++ b/src/deferred.js @@ -290,7 +290,7 @@ jQuery.extend({ // the master Deferred. // If resolveValues consist of only a single Deferred, just use that. - deferred = remaining === 1 ? subordinate : jQuery.Deferred(), + master = remaining === 1 ? subordinate : jQuery.Deferred(), // Update function for both resolve and progress values updateFunc = function( i, contexts, values ) { @@ -298,13 +298,12 @@ jQuery.extend({ contexts[ i ] = this; values[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; if ( values === progressValues ) { - deferred.notifyWith( contexts, values ); + master.notifyWith( contexts, values ); } else if ( !( --remaining ) ) { - deferred.resolveWith( contexts, values ); + master.resolveWith( contexts, values ); } }; }, - progressValues, progressContexts, resolveContexts; // Add listeners to Deferred subordinates; treat others as resolved @@ -314,10 +313,11 @@ jQuery.extend({ resolveContexts = new Array( length ); for ( ; i < length; i++ ) { if ( resolveValues[ i ] && jQuery.isFunction( resolveValues[ i ].promise ) ) { + resolveValues[ i ].promise() .progress( updateFunc( i, progressContexts, progressValues ) ) .done( updateFunc( i, resolveContexts, resolveValues ) ) - .fail( deferred.reject ); + .fail( master.reject ); } else { --remaining; } @@ -326,10 +326,10 @@ jQuery.extend({ // If we're not waiting on anything, resolve the master if ( !remaining ) { - deferred.resolveWith( resolveContexts, resolveValues ); + master.resolveWith( resolveContexts, resolveValues ); } - return deferred.promise(); + return master.promise(); } }); From 447cf3d1fc28faf4819d4d4d6e786d81f727d140 Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Sun, 18 Jan 2015 15:12:44 -0500 Subject: [PATCH 16/18] Deferred: Accept standard Promises in jQuery.when Unfortunately, jQuery.when still prefers .promise methods over .then to satisfy contextual resolution unit tests. raw gz Sizes 252424 74450 dist/jquery.js 85114 29662 dist/jquery.min.js raw gz Compared to master @ 66e1b6b8d49812239b5712d65922ff94c60f7b02 +5499 +1231 dist/jquery.js +921 +267 dist/jquery.min.js raw gz Compared to last run +308 +61 dist/jquery.js +74 +21 dist/jquery.min.js --- src/deferred.js | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/src/deferred.js b/src/deferred.js index 0a32d1e1d8..c28dcfe480 100644 --- a/src/deferred.js +++ b/src/deferred.js @@ -280,7 +280,8 @@ jQuery.extend({ // Deferred helper when: function( subordinate /* , ..., subordinateN */ ) { - var i = 0, + var method, + i = 0, resolveValues = slice.call( arguments ), length = resolveValues.length, @@ -312,12 +313,22 @@ jQuery.extend({ progressContexts = new Array( length ); resolveContexts = new Array( length ); for ( ; i < length; i++ ) { - if ( resolveValues[ i ] && jQuery.isFunction( resolveValues[ i ].promise ) ) { + if ( resolveValues[ i ] && + jQuery.isFunction( (method = resolveValues[ i ].promise) ) ) { - resolveValues[ i ].promise() + method.call( resolveValues[ i ] ) .progress( updateFunc( i, progressContexts, progressValues ) ) .done( updateFunc( i, resolveContexts, resolveValues ) ) .fail( master.reject ); + } else if ( resolveValues[ i ] && + jQuery.isFunction( (method = resolveValues[ i ].then) ) ) { + + method.call( + resolveValues[ i ], + updateFunc( i, resolveContexts, resolveValues ), + master.reject, + updateFunc( i, progressContexts, progressValues ) + ); } else { --remaining; } From 694374cf01bf1cf4ca99395dd2192590f0647598 Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Wed, 25 Feb 2015 12:21:15 -0500 Subject: [PATCH 17/18] Deferred: Clarify backcompat and error text --- src/deferred.js | 2 +- test/unit/deferred.js | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/deferred.js b/src/deferred.js index c28dcfe480..2522c693e3 100644 --- a/src/deferred.js +++ b/src/deferred.js @@ -81,7 +81,7 @@ jQuery.extend({ // Support: Promises/A+ section 2.3.1 // https://promisesaplus.com/#point-48 if ( returned === deferred.promise() ) { - throw new TypeError(); + throw new TypeError( "Thenable self-resolution" ); } // Support: Promises/A+ sections 2.3.3.1, 3.5 diff --git a/test/unit/deferred.js b/test/unit/deferred.js index d7b6ce13df..7fe71fa4b7 100644 --- a/test/unit/deferred.js +++ b/test/unit/deferred.js @@ -167,7 +167,7 @@ test( "jQuery.Deferred.then - filtering (fail)", function( assert ) { }); }); -test( "[DIVERGENT] jQuery.Deferred.pipe - filtering (fail)", function( assert ) { +test( "[PIPE ONLY] jQuery.Deferred.pipe - filtering (fail)", function( assert ) { assert.expect( 4 ); @@ -336,7 +336,7 @@ test( "jQuery.Deferred.then - deferred (progress)", function( assert ) { }); }); -test( "[DIVERGENT] jQuery.Deferred.pipe - deferred (progress)", function( assert ) { +test( "[PIPE ONLY] jQuery.Deferred.pipe - deferred (progress)", function( assert ) { assert.expect( 3 ); @@ -419,7 +419,7 @@ test( "jQuery.Deferred.then - context", function( assert ) { }); }); -test( "[DIVERGENT] jQuery.Deferred.pipe - context", function( assert ) { +test( "[PIPE ONLY] jQuery.Deferred.pipe - context", function( assert ) { assert.expect( 7 ); @@ -430,7 +430,7 @@ test( "[DIVERGENT] jQuery.Deferred.pipe - context", function( assert ) { jQuery.Deferred().resolveWith( context, [ 2 ] ).pipe(function( value ) { return value * 3; }).done(function( value ) { - assert.strictEqual( this, context, "[DIVERGENT] custom context correctly propagated" ); + assert.strictEqual( this, context, "[PIPE ONLY] custom context correctly propagated" ); assert.strictEqual( value, 6, "proper value received" ); done.pop().call(); }); From 3b4d845754684170903ebf75ced79e463a2032fe Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Fri, 20 Mar 2015 00:33:39 -0400 Subject: [PATCH 18/18] Deferred: Test that pipe is a function --- test/unit/deferred.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/unit/deferred.js b/test/unit/deferred.js index 7fe71fa4b7..a115a0009d 100644 --- a/test/unit/deferred.js +++ b/test/unit/deferred.js @@ -14,7 +14,7 @@ jQuery.each( [ "", " - new operator" ], function( _, withNew ) { var defer = createDeferred(); - ok( defer.pipe, "defer.pipe exists" ); + ok( jQuery.isFunction( defer.pipe ), "defer.pipe is a function" ); createDeferred().resolve().done(function() { ok( true, "Success on resolve" );