Skip to content

Deferred: Don't swallow progress of a resolved deferred in then #2210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gibson042 wants to merge 3 commits into from
Closed

Deferred: Don't swallow progress of a resolved deferred in then #2210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec91dd7
Deferred: Don't swallow progress of a resolved deferred in `then`
gibson042 Apr 14, 2015
4d34dcf
Deferred: Handle remaining progress/resolve interactions
gibson042 Apr 14, 2015
dafce9f
Deferred: Update "tuples" explanation
gibson042 Apr 14, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 32 additions & 29 deletions src/deferred.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,14 @@ jQuery.extend({

Deferred: function( func ) {
var tuples = [
// action, add listener, callbacks, .then handlers, final state
// action, add listener, callbacks,
// ... .then handlers, argument index, [final state]
[ "notify", "progress", jQuery.Callbacks("memory"),
Copy link
Member

@dmethvin dmethvin Apr 14, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know how much bigger the code would get if this was an array of props, but it would probably make the logic easier to follow. I can live with it tho.

jQuery.Callbacks("memory"), 2 ],
[ "resolve", "done", jQuery.Callbacks("once memory"),
jQuery.Callbacks("once memory"), "resolved" ],
jQuery.Callbacks("once memory"), 0, "resolved" ],
[ "reject", "fail", jQuery.Callbacks("once memory"),
jQuery.Callbacks("once memory"), "rejected" ],
[ "notify", "progress", jQuery.Callbacks("memory"),
jQuery.Callbacks("memory") ]
jQuery.Callbacks("once memory"), 1, "rejected" ]
],
state = "pending",
promise = {
Expand All @@ -38,17 +39,19 @@ jQuery.extend({

return jQuery.Deferred(function( newDefer ) {
jQuery.each( tuples, function( i, tuple ) {
var fn = jQuery.isFunction( fns[ i ] ) && fns[ i ];
// Map tuples (progress, done, fail) to arguments (done, fail, progress)
var fn = jQuery.isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ];

// deferred.progress(function() { bind to newDefer or newDefer.notify })
// 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 ) ) {
returned.promise()
.progress( newDefer.notify )
.done( newDefer.resolve )
.fail( newDefer.reject )
.progress( newDefer.notify );
.fail( newDefer.reject );
} else {
newDefer[ tuple[ 0 ] + "With" ](
this === promise ? newDefer.promise() : this,
Expand Down Expand Up @@ -176,37 +179,37 @@ jQuery.extend({
}

return jQuery.Deferred(function( newDefer ) {
// fulfilled_handlers.add( ... )
// progress_handlers.add( ... )
tuples[ 0 ][ 3 ].add(
resolve(
0,
newDefer,
jQuery.isFunction( onFulfilled ) ?
onFulfilled :
Identity
jQuery.isFunction( onProgress ) ?
onProgress :
Identity,
newDefer.notifyWith
)
);

// rejected_handlers.add( ... )
// fulfilled_handlers.add( ... )
tuples[ 1 ][ 3 ].add(
resolve(
0,
newDefer,
jQuery.isFunction( onRejected ) ?
onRejected :
Thrower
jQuery.isFunction( onFulfilled ) ?
onFulfilled :
Identity
)
);

// progress_handlers.add( ... )
// rejected_handlers.add( ... )
tuples[ 2 ][ 3 ].add(
resolve(
0,
newDefer,
jQuery.isFunction( onProgress ) ?
onProgress :
Identity,
newDefer.notifyWith
jQuery.isFunction( onRejected ) ?
onRejected :
Thrower
)
);
}).promise();
Expand All @@ -222,11 +225,11 @@ jQuery.extend({
// Add list-specific methods
jQuery.each( tuples, function( i, tuple ) {
var list = tuple[ 2 ],
stateString = tuple[ 4 ];
stateString = tuple[ 5 ];

// promise.progress = list.add
// promise.done = list.add
// promise.fail = list.add
// promise.progress = list.add
promise[ tuple[1] ] = list.add;

// Handle state
Expand All @@ -240,29 +243,29 @@ jQuery.extend({

Copy link
Member

@dmethvin dmethvin Apr 14, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like it was the only use of the xor operator in the whole codebase. I hope you're happy now.

Copy link
Member Author

@gibson042 gibson042 Apr 14, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No regrets. 😈

// rejected_callbacks.disable
// fulfilled_callbacks.disable
tuples[ i ^ 1 ][ 2 ].disable,
tuples[ 3 - i ][ 2 ].disable,

// progress_callbacks.lock
tuples[ 2 ][ 2 ].lock
tuples[ 0 ][ 2 ].lock
);
}

// progress_handlers.fire
// fulfilled_handlers.fire
// rejected_handlers.fire
// progress_handlers.fire
list.add( tuple[ 3 ].fire );

// deferred.notify = function() { deferred.notifyWith(...) }
// 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.notifyWith = list.fireWith
// deferred.resolveWith = list.fireWith
// deferred.rejectWith = list.fireWith
// deferred.notifyWith = list.fireWith
deferred[ tuple[0] + "With" ] = list.fireWith;
});

Expand Down
48 changes: 48 additions & 0 deletions test/unit/deferred.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -565,6 +565,54 @@ test( "jQuery.Deferred.then - progress and thenables", function( assert ) {
trigger.notify();
});

test( "jQuery.Deferred - notify and resolve", function( assert ) {

expect( 7 );

var notifiedResolved = jQuery.Deferred().notify( "foo" )/*xxx .resolve( "bar" )*/,
done = jQuery.map( new Array( 3 ), function() { return assert.async(); } );

notifiedResolved.progress( function( v ) {
assert.strictEqual( v, "foo", "progress value" );
} );

notifiedResolved.pipe().progress( function( v ) {
assert.strictEqual( v, "foo", "piped progress value" );
} );

notifiedResolved.pipe( null, null, function() {
return "baz";
} ).progress( function( v ) {
assert.strictEqual( v, "baz", "replaced piped progress value" );
} );

notifiedResolved.pipe( null, null, function() {
return jQuery.Deferred().notify( "baz" ).resolve( "quux" );
} ).progress( function( v ) {
assert.strictEqual( v, "baz", "deferred replaced piped progress value" );
} );

notifiedResolved.then().progress( function( v ) {
assert.strictEqual( v, "foo", "then'd progress value" );
done.pop().call();
} );

notifiedResolved.then( null, null, function() {
return "baz";
} ).progress( function( v ) {
assert.strictEqual( v, "baz", "replaced then'd progress value" );
done.pop().call();
} );

notifiedResolved.then( null, null, function() {
return jQuery.Deferred().notify( "baz" ).resolve( "quux" );
} ).progress( function( v ) {
// Progress from the surrogate deferred is ignored
assert.strictEqual( v, "quux", "deferred replaced then'd progress value" );
done.pop().call();
} );
});

test( "jQuery.when", function() {

expect( 37 );
Expand Down