Skip to content

Commit aece1dc

Browse files
author
Chris Garrett
committed
[BUGFIX] Rename private runloop functions
We currently export a few private functions from `@ember/runloop` for packages like `@ember/test-helpers`. These functions are not public API, but need to be accessible for these core packages. Previously they were exposed on the private APIs of the global `run`, but now that we're getting rid of the the modules transform these are now exposed directly, so underscoring them should help make users aware that they are not meant for public consumption.
1 parent df149be commit aece1dc

File tree

22 files changed

+109
-109
lines changed

22 files changed

+109
-109
lines changed

‎packages/@ember/-internals/extension-support/lib/data_adapter.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { getOwner } from '@ember/-internals/owner';
2-
import { backburner } from '@ember/runloop';
2+
import { _backburner } from '@ember/runloop';
33
import { get } from '@ember/-internals/metal';
44
import { dasherize } from '@ember/string';
55
import { HAS_NATIVE_SYMBOL } from '@ember/-internals/utils';
@@ -364,10 +364,10 @@ export default EmberObject.extend({
364364
this.recordsWatchers.forEach((watcher) => watcher.revalidate());
365365
};
366366

367-
backburner.on('end', this.flushWatchers);
367+
_backburner.on('end', this.flushWatchers);
368368
}
369369
} else if (this.typeWatchers.size === 0 && this.recordsWatchers.size === 0) {
370-
backburner.off('end', this.flushWatchers);
370+
_backburner.off('end', this.flushWatchers);
371371
this.flushWatchers = null;
372372
}
373373
},
@@ -386,7 +386,7 @@ export default EmberObject.extend({
386386
this.releaseMethods.forEach((fn) => fn());
387387

388388
if (this.flushWatchers) {
389-
backburner.off('end', this.flushWatchers);
389+
_backburner.off('end', this.flushWatchers);
390390
}
391391
},
392392

‎packages/@ember/-internals/glimmer/lib/environment.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { getDebugName } from '@ember/-internals/utils';
55
import { constructStyleDeprecationMessage } from '@ember/-internals/views';
66
import { assert, deprecate, warn } from '@ember/debug';
77
import { DeprecationOptions } from '@ember/debug/lib/deprecate';
8-
import { backburner, schedule } from '@ember/runloop';
8+
import { _backburner, schedule } from '@ember/runloop';
99
import { DEBUG } from '@glimmer/env';
1010
import setGlobalContext from '@glimmer/global-context';
1111
import { EnvironmentDelegate } from '@glimmer/runtime';
@@ -20,7 +20,7 @@ import toBool from './utils/to-bool';
2020

2121
setGlobalContext({
2222
scheduleRevalidate() {
23-
backburner.ensureInstance();
23+
_backburner.ensureInstance();
2424
},
2525

2626
toBool,

‎packages/@ember/-internals/glimmer/lib/renderer.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { ENV } from '@ember/-internals/environment';
22
import { getOwner, Owner } from '@ember/-internals/owner';
33
import { getViewElement, getViewId } from '@ember/-internals/views';
44
import { assert } from '@ember/debug';
5-
import { backburner, getCurrentRunLoop } from '@ember/runloop';
5+
import { _backburner, _getCurrentRunLoop } from '@ember/runloop';
66
import { destroy } from '@glimmer/destroyable';
77
import { DEBUG } from '@glimmer/env';
88
import {
@@ -229,9 +229,9 @@ export function renderSettled() {
229229
renderSettledDeferred = RSVP.defer();
230230
// if there is no current runloop, the promise created above will not have
231231
// a chance to resolve (because its resolved in backburner's "end" event)
232-
if (!getCurrentRunLoop()) {
232+
if (!_getCurrentRunLoop()) {
233233
// ensure a runloop has been kicked off
234-
backburner.schedule('actions', null, K);
234+
_backburner.schedule('actions', null, K);
235235
}
236236
}
237237

@@ -243,7 +243,7 @@ function resolveRenderPromise() {
243243
let resolve = renderSettledDeferred.resolve;
244244
renderSettledDeferred = null;
245245

246-
backburner.join(null, resolve);
246+
_backburner.join(null, resolve);
247247
}
248248
}
249249

@@ -258,15 +258,15 @@ function loopEnd() {
258258
throw new Error('infinite rendering invalidation detected');
259259
}
260260
loops++;
261-
return backburner.join(null, K);
261+
return _backburner.join(null, K);
262262
}
263263
}
264264
loops = 0;
265265
resolveRenderPromise();
266266
}
267267

268-
backburner.on('begin', loopBegin);
269-
backburner.on('end', loopEnd);
268+
_backburner.on('begin', loopBegin);
269+
_backburner.on('end', loopEnd);
270270

271271
interface ViewRegistry {
272272
[viewId: string]: unknown;
@@ -574,7 +574,7 @@ export class Renderer {
574574
}
575575

576576
_scheduleRevalidate(): void {
577-
backburner.scheduleOnce('render', this, this._revalidate);
577+
_backburner.scheduleOnce('render', this, this._revalidate);
578578
}
579579

580580
_isValid(): boolean {

‎packages/@ember/-internals/glimmer/tests/integration/event-dispatcher-test.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { RenderingTestCase, moduleFor, runTask } from 'internal-test-helpers';
22

33
import { Component } from '../utils/helpers';
4-
import { getCurrentRunLoop, run } from '@ember/runloop';
4+
import { _getCurrentRunLoop, run } from '@ember/runloop';
55
import {
66
subscribe as instrumentationSubscribe,
77
reset as instrumentationReset,
@@ -164,7 +164,7 @@ moduleFor(
164164
this.registerComponent('x-foo', {
165165
ComponentClass: Component.extend({
166166
change() {
167-
assert.ok(getCurrentRunLoop(), 'a run loop should have started');
167+
assert.ok(_getCurrentRunLoop(), 'a run loop should have started');
168168
},
169169
}),
170170
template: `<input id="is-done" type="checkbox">`,

‎packages/@ember/-internals/glimmer/tests/integration/helpers/closure-action-test.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import {
44
subscribe as instrumentationSubscribe,
55
unsubscribe as instrumentationUnsubscribe,
66
} from '@ember/instrumentation';
7-
import { getCurrentRunLoop } from '@ember/runloop';
7+
import { _getCurrentRunLoop } from '@ember/runloop';
88
import { set, computed } from '@ember/-internals/metal';
99
import { EMBER_IMPROVED_INSTRUMENTATION } from '@ember/canary-features';
1010

@@ -1019,7 +1019,7 @@ moduleFor(
10191019
let OuterComponent = Component.extend({
10201020
actions: {
10211021
submit() {
1022-
capturedRunLoop = getCurrentRunLoop();
1022+
capturedRunLoop = _getCurrentRunLoop();
10231023
},
10241024
},
10251025
});

‎packages/@ember/-internals/runtime/lib/ext/rsvp.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import * as RSVP from 'rsvp';
2-
import { backburner, _rsvpErrorQueue } from '@ember/runloop';
2+
import { _backburner, _rsvpErrorQueue } from '@ember/runloop';
33
import { getDispatchOverride } from '@ember/-internals/error-handling';
44
import { assert } from '@ember/debug';
55

66
RSVP.configure('async', (callback, promise) => {
7-
backburner.schedule('actions', null, callback, promise);
7+
_backburner.schedule('actions', null, callback, promise);
88
});
99

1010
RSVP.configure('after', (cb) => {
11-
backburner.schedule(_rsvpErrorQueue, null, cb);
11+
_backburner.schedule(_rsvpErrorQueue, null, cb);
1212
});
1313

1414
RSVP.on('error', onerrorDefault);

‎packages/@ember/runloop/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { Backburner, DeferredActionQueues, Timer } from 'backburner.js';
22

3-
export const backburner: Backburner;
3+
export const _backburner: Backburner;
44

55
export const run = Backburner.run;
66
export const schedule = Backburner.schedule;
@@ -9,7 +9,7 @@ export const join = Backburner.join;
99
export const cancel = Backburner.cancel;
1010
export const scheduleOnce = Backburner.scheduleOnce;
1111

12-
export function getCurrentRunLoop(): DeferredActionQueues;
12+
export function _getCurrentRunLoop(): DeferredActionQueues;
1313

1414
export function once(method: Function): Timer;
1515
export function once<T, U extends keyof T>(target: T, method: U, ...args): Timer;

‎packages/@ember/runloop/index.js

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { flushAsyncObservers } from '@ember/-internals/metal';
55
import Backburner from 'backburner';
66

77
let currentRunLoop = null;
8-
export function getCurrentRunLoop() {
8+
export function _getCurrentRunLoop() {
99
return currentRunLoop;
1010
}
1111

@@ -40,7 +40,7 @@ export const _rsvpErrorQueue = `${Math.random()}${Date.now()}`.replace('.', '');
4040
@default ['actions', 'destroy']
4141
@private
4242
*/
43-
export const queues = [
43+
export const _queues = [
4444
'actions',
4545

4646
// used in router transitions to prevent unnecessary loading state entry
@@ -56,7 +56,7 @@ export const queues = [
5656
_rsvpErrorQueue,
5757
];
5858

59-
export const backburner = new Backburner(queues, {
59+
export const _backburner = new Backburner(_queues, {
6060
defaultQueue: 'actions',
6161
onBegin,
6262
onEnd,
@@ -101,7 +101,7 @@ export const backburner = new Backburner(queues, {
101101
@public
102102
*/
103103
export function run() {
104-
return backburner.run(...arguments);
104+
return _backburner.run(...arguments);
105105
}
106106

107107
/**
@@ -149,7 +149,7 @@ export function run() {
149149
@public
150150
*/
151151
export function join() {
152-
return backburner.join(...arguments);
152+
return _backburner.join(...arguments);
153153
}
154154

155155
/**
@@ -259,7 +259,7 @@ export const bind = (...curried) => {
259259
@public
260260
*/
261261
export function begin() {
262-
backburner.begin();
262+
_backburner.begin();
263263
}
264264

265265
/**
@@ -282,7 +282,7 @@ export function begin() {
282282
@public
283283
*/
284284
export function end() {
285-
backburner.end();
285+
_backburner.end();
286286
}
287287

288288
/**
@@ -327,17 +327,17 @@ export function end() {
327327
@public
328328
*/
329329
export function schedule(/* queue, target, method */) {
330-
return backburner.schedule(...arguments);
330+
return _backburner.schedule(...arguments);
331331
}
332332

333333
// Used by global test teardown
334-
export function hasScheduledTimers() {
335-
return backburner.hasTimers();
334+
export function _hasScheduledTimers() {
335+
return _backburner.hasTimers();
336336
}
337337

338338
// Used by global test teardown
339-
export function cancelTimers() {
340-
backburner.cancelTimers();
339+
export function _cancelTimers() {
340+
_backburner.cancelTimers();
341341
}
342342

343343
/**
@@ -371,7 +371,7 @@ export function cancelTimers() {
371371
@public
372372
*/
373373
export function later(/*target, method*/) {
374-
return backburner.later(...arguments);
374+
return _backburner.later(...arguments);
375375
}
376376

377377
/**
@@ -391,7 +391,7 @@ export function later(/*target, method*/) {
391391
*/
392392
export function once(...args) {
393393
args.unshift('actions');
394-
return backburner.scheduleOnce(...args);
394+
return _backburner.scheduleOnce(...args);
395395
}
396396

397397
/**
@@ -467,7 +467,7 @@ export function once(...args) {
467467
@public
468468
*/
469469
export function scheduleOnce(/* queue, target, method*/) {
470-
return backburner.scheduleOnce(...arguments);
470+
return _backburner.scheduleOnce(...arguments);
471471
}
472472

473473
/**
@@ -542,7 +542,7 @@ export function scheduleOnce(/* queue, target, method*/) {
542542
*/
543543
export function next(...args) {
544544
args.push(1);
545-
return backburner.later(...args);
545+
return _backburner.later(...args);
546546
}
547547

548548
/**
@@ -613,7 +613,7 @@ export function next(...args) {
613613
@public
614614
*/
615615
export function cancel(timer) {
616-
return backburner.cancel(timer);
616+
return _backburner.cancel(timer);
617617
}
618618

619619
/**
@@ -691,7 +691,7 @@ export function cancel(timer) {
691691
@public
692692
*/
693693
export function debounce() {
694-
return backburner.debounce(...arguments);
694+
return _backburner.debounce(...arguments);
695695
}
696696

697697
/**
@@ -738,7 +738,7 @@ export function debounce() {
738738
@public
739739
*/
740740
export function throttle() {
741-
return backburner.throttle(...arguments);
741+
return _backburner.throttle(...arguments);
742742
}
743743

744744
export let _deprecatedGlobalGetCurrentRunLoop;
@@ -780,46 +780,46 @@ if (DEBUG) {
780780
}
781781
);
782782

783-
return getCurrentRunLoop();
783+
return _getCurrentRunLoop();
784784
};
785785

786-
defineDeprecatedRunloopFunc('backburner', backburner);
786+
defineDeprecatedRunloopFunc('backburner', _backburner);
787787
defineDeprecatedRunloopFunc('begin', begin);
788788
defineDeprecatedRunloopFunc('bind', bind);
789789
defineDeprecatedRunloopFunc('cancel', cancel);
790790
defineDeprecatedRunloopFunc('debounce', debounce);
791791
defineDeprecatedRunloopFunc('end', end);
792-
defineDeprecatedRunloopFunc('hasScheduledTimers', hasScheduledTimers);
792+
defineDeprecatedRunloopFunc('hasScheduledTimers', _hasScheduledTimers);
793793
defineDeprecatedRunloopFunc('join', join);
794794
defineDeprecatedRunloopFunc('later', later);
795795
defineDeprecatedRunloopFunc('next', next);
796796
defineDeprecatedRunloopFunc('once', once);
797797
defineDeprecatedRunloopFunc('schedule', schedule);
798798
defineDeprecatedRunloopFunc('scheduleOnce', scheduleOnce);
799799
defineDeprecatedRunloopFunc('throttle', throttle);
800-
defineDeprecatedRunloopFunc('cancelTimers', cancelTimers);
800+
defineDeprecatedRunloopFunc('cancelTimers', _cancelTimers);
801801
Object.defineProperty(run, 'currentRunLoop', {
802802
get: _deprecatedGlobalGetCurrentRunLoop,
803803
enumerable: false,
804804
});
805805
} else {
806-
run.backburner = backburner;
806+
run.backburner = _backburner;
807807
run.begin = begin;
808808
run.bind = bind;
809809
run.cancel = cancel;
810810
run.debounce = debounce;
811811
run.end = end;
812-
run.hasScheduledTimers = hasScheduledTimers;
812+
run.hasScheduledTimers = _hasScheduledTimers;
813813
run.join = join;
814814
run.later = later;
815815
run.next = next;
816816
run.once = once;
817817
run.schedule = schedule;
818818
run.scheduleOnce = scheduleOnce;
819819
run.throttle = throttle;
820-
run.cancelTimers = cancelTimers;
820+
run.cancelTimers = _cancelTimers;
821821
Object.defineProperty(run, 'currentRunLoop', {
822-
get: getCurrentRunLoop,
822+
get: _getCurrentRunLoop,
823823
enumerable: false,
824824
});
825825
}

0 commit comments

Comments
 (0)