Skip to content

Commit a8fff93

Browse files
committed
Rename ReactUpdates.setImmediate to 'asap'
Per facebook#1554 (comment). Test Plan: jest
1 parent 35764c5 commit a8fff93

File tree

5 files changed

+35
-35
lines changed

5 files changed

+35
-35
lines changed

src/browser/ui/dom/components/ReactDOMInput.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,10 +125,10 @@ var ReactDOMInput = ReactCompositeComponent.createClass({
125125
if (onChange) {
126126
returnValue = onChange.call(this, event);
127127
}
128-
// Here we use setImmediate to wait until all updates have propagated, which
128+
// Here we use asap to wait until all updates have propagated, which
129129
// is important when using controlled components within layers:
130130
// https://github.com/facebook/react/issues/1698
131-
ReactUpdates.setImmediate(forceUpdateIfMounted, this);
131+
ReactUpdates.asap(forceUpdateIfMounted, this);
132132

133133
var name = this.props.name;
134134
if (this.props.type === 'radio' && name != null) {
@@ -169,7 +169,7 @@ var ReactDOMInput = ReactCompositeComponent.createClass({
169169
// If this is a controlled radio button group, forcing the input that
170170
// was previously checked to update will cause it to be come re-checked
171171
// as appropriate.
172-
ReactUpdates.setImmediate(forceUpdateIfMounted, otherInstance);
172+
ReactUpdates.asap(forceUpdateIfMounted, otherInstance);
173173
}
174174
}
175175

src/browser/ui/dom/components/ReactDOMSelect.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ var ReactDOMSelect = ReactCompositeComponent.createClass({
180180
}
181181

182182
this._pendingValue = selectedValue;
183-
ReactUpdates.setImmediate(updateWithPendingValueIfMounted, this);
183+
ReactUpdates.asap(updateWithPendingValueIfMounted, this);
184184
return returnValue;
185185
}
186186

src/browser/ui/dom/components/ReactDOMTextarea.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ var ReactDOMTextarea = ReactCompositeComponent.createClass({
135135
if (onChange) {
136136
returnValue = onChange.call(this, event);
137137
}
138-
ReactUpdates.setImmediate(forceUpdateIfMounted, this);
138+
ReactUpdates.asap(forceUpdateIfMounted, this);
139139
return returnValue;
140140
}
141141

src/core/ReactUpdates.js

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ var mixInto = require('mixInto');
2929
var warning = require('warning');
3030

3131
var dirtyComponents = [];
32-
var setImmediateCallbackQueue = CallbackQueue.getPooled();
33-
var setImmediateEnqueued = false;
32+
var asapCallbackQueue = CallbackQueue.getPooled();
33+
var asapEnqueued = false;
3434

3535
var batchingStrategy = null;
3636

@@ -172,18 +172,18 @@ var flushBatchedUpdates = ReactPerf.measure(
172172
// ReactUpdatesFlushTransaction's wrappers will clear the dirtyComponents
173173
// array and perform any updates enqueued by mount-ready handlers (i.e.,
174174
// componentDidUpdate) but we need to check here too in order to catch
175-
// updates enqueued by setState callbacks and setImmediate calls.
176-
while (dirtyComponents.length || setImmediateEnqueued) {
175+
// updates enqueued by setState callbacks and asap calls.
176+
while (dirtyComponents.length || asapEnqueued) {
177177
if (dirtyComponents.length) {
178178
var transaction = ReactUpdatesFlushTransaction.getPooled();
179179
transaction.perform(runBatchedUpdates, null, transaction);
180180
ReactUpdatesFlushTransaction.release(transaction);
181181
}
182182

183-
if (setImmediateEnqueued) {
184-
setImmediateEnqueued = false;
185-
var queue = setImmediateCallbackQueue;
186-
setImmediateCallbackQueue = CallbackQueue.getPooled();
183+
if (asapEnqueued) {
184+
asapEnqueued = false;
185+
var queue = asapCallbackQueue;
186+
asapCallbackQueue = CallbackQueue.getPooled();
187187
queue.notifyAll();
188188
CallbackQueue.release(queue);
189189
}
@@ -237,14 +237,14 @@ function enqueueUpdate(component, callback) {
237237
* Enqueue a callback to be run at the end of the current batching cycle. Throws
238238
* if no updates are currently being performed.
239239
*/
240-
function setImmediate(callback, context) {
240+
function asap(callback, context) {
241241
invariant(
242242
batchingStrategy.isBatchingUpdates,
243-
'ReactUpdates.setImmediate: Can\'t enqueue an immediate callback in a ' +
244-
'context where updates are not being batched.'
243+
'ReactUpdates.asap: Can\'t enqueue an asap callback in a context where' +
244+
'updates are not being batched.'
245245
);
246-
setImmediateCallbackQueue.enqueue(callback, context);
247-
setImmediateEnqueued = true;
246+
asapCallbackQueue.enqueue(callback, context);
247+
asapEnqueued = true;
248248
}
249249

250250
var ReactUpdatesInjection = {
@@ -286,7 +286,7 @@ var ReactUpdates = {
286286
enqueueUpdate: enqueueUpdate,
287287
flushBatchedUpdates: flushBatchedUpdates,
288288
injection: ReactUpdatesInjection,
289-
setImmediate: setImmediate
289+
asap: asap
290290
};
291291

292292
module.exports = ReactUpdates;

src/core/__tests__/ReactUpdates-test.js

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -749,18 +749,18 @@ describe('ReactUpdates', function() {
749749
expect(callbackCount).toBe(1);
750750
});
751751

752-
it('calls setImmediate callbacks properly', function() {
752+
it('calls asap callbacks properly', function() {
753753
var callbackCount = 0;
754754
var A = React.createClass({
755755
render: function() {
756756
return <div />;
757757
},
758758
componentDidUpdate: function() {
759759
var component = this;
760-
ReactUpdates.setImmediate(function() {
760+
ReactUpdates.asap(function() {
761761
expect(this).toBe(component);
762762
callbackCount++;
763-
ReactUpdates.setImmediate(function() {
763+
ReactUpdates.asap(function() {
764764
callbackCount++;
765765
});
766766
expect(callbackCount).toBe(1);
@@ -775,7 +775,7 @@ describe('ReactUpdates', function() {
775775
expect(callbackCount).toBe(2);
776776
});
777777

778-
it('calls setImmediate callbacks with queued updates', function() {
778+
it('calls asap callbacks with queued updates', function() {
779779
var log = [];
780780
var A = React.createClass({
781781
getInitialState: () => ({updates: 0}),
@@ -785,18 +785,18 @@ describe('ReactUpdates', function() {
785785
},
786786
componentDidUpdate: function() {
787787
if (this.state.updates === 1) {
788-
ReactUpdates.setImmediate(function() {
788+
ReactUpdates.asap(function() {
789789
this.setState({updates: 2}, function() {
790-
ReactUpdates.setImmediate(function() {
791-
log.push('setImmediate-1.2');
790+
ReactUpdates.asap(function() {
791+
log.push('asap-1.2');
792792
});
793793
log.push('setState-cb');
794794
});
795-
log.push('setImmediate-1.1');
795+
log.push('asap-1.1');
796796
}, this);
797797
} else if (this.state.updates === 2) {
798-
ReactUpdates.setImmediate(function() {
799-
log.push('setImmediate-2');
798+
ReactUpdates.asap(function() {
799+
log.push('asap-2');
800800
});
801801
}
802802
log.push('didUpdate-' + this.state.updates);
@@ -811,16 +811,16 @@ describe('ReactUpdates', function() {
811811
// We do the first update...
812812
'render-1',
813813
'didUpdate-1',
814-
// ...which calls a setImmediate and enqueues a second update...
815-
'setImmediate-1.1',
816-
// ...which runs and enqueues the setImmediate-2 log in its didUpdate...
814+
// ...which calls asap and enqueues a second update...
815+
'asap-1.1',
816+
// ...which runs and enqueues the asap-2 log in its didUpdate...
817817
'render-2',
818818
'didUpdate-2',
819819
// ...and runs the setState callback, which enqueues the log for
820-
// setImmediate-1.2.
820+
// asap-1.2.
821821
'setState-cb',
822-
'setImmediate-2',
823-
'setImmediate-1.2'
822+
'asap-2',
823+
'asap-1.2'
824824
]);
825825
});
826826
});

0 commit comments

Comments
 (0)