Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

perf(Scope): use remove the need for the extra watch in $watchGroup #8396

Closed
wants to merge 2 commits into from
Closed

perf(Scope): use remove the need for the extra watch in $watchGroup #8396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f151f0
perf(Scope): use remove the need for the extra watch in $watchGroup
IgorMinar Jul 29, 2014
26c4a71
chore(Scope): remove deregisterNotifier feature for $watch
IgorMinar Jul 30, 2014
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
4 changes: 2 additions & 2 deletions src/ng/interpolate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,15 +301,15 @@ function $InterpolateProvider() {
exp: text, //just for compatibility with regular watchers created via $watch
separators: separators,
expressions: expressions,
$$watchDelegate: function (scope, listener, objectEquality, deregisterNotifier) {
$$watchDelegate: function (scope, listener, objectEquality) {
var lastValue;
return scope.$watchGroup(parseFns, function interpolateFnWatcher(values, oldValues) {
var currValue = compute(values);
if (isFunction(listener)) {
listener.call(this, currValue, values !== oldValues ? lastValue : currValue, scope);
}
lastValue = currValue;
}, objectEquality, deregisterNotifier);
}, objectEquality);
}
});
}
Expand Down
8 changes: 4 additions & 4 deletions src/ng/parse.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1031,7 +1031,7 @@ function $ParseProvider() {
}
};

function oneTimeWatch(scope, listener, objectEquality, deregisterNotifier, parsedExpression) {
function oneTimeWatch(scope, listener, objectEquality, parsedExpression) {
var unwatch, lastValue;
return unwatch = scope.$watch(function oneTimeWatch(scope) {
return parsedExpression(scope);
Expand All @@ -1047,10 +1047,10 @@ function $ParseProvider() {
}
});
}
}, objectEquality, deregisterNotifier);
}, objectEquality);
}

function constantWatch(scope, listener, objectEquality, deregisterNotifier, parsedExpression) {
function constantWatch(scope, listener, objectEquality, parsedExpression) {
var unwatch;
return unwatch = scope.$watch(function constantWatch(scope) {
return parsedExpression(scope);
Expand All @@ -1059,7 +1059,7 @@ function $ParseProvider() {
listener.apply(this, arguments);
}
unwatch();
}, objectEquality, deregisterNotifier);
}, objectEquality);
}

function addInterceptor(parsedExpression, interceptorFn) {
Expand Down
43 changes: 20 additions & 23 deletions src/ng/rootScope.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,15 +322,13 @@ function $RootScopeProvider(){
* - `scope` refers to the current scope
* @param {boolean=} objectEquality Compare for object equality using {@link angular.equals} instead of
* comparing for reference equality.
* @param {function()=} deregisterNotifier Function to call when the deregistration function
* get called.
* @returns {function()} Returns a deregistration function for this listener.
*/
$watch: function(watchExp, listener, objectEquality, deregisterNotifier) {
$watch: function(watchExp, listener, objectEquality) {
var get = compileToFn(watchExp, 'watch');

if (get.$$watchDelegate) {
return get.$$watchDelegate(this, listener, objectEquality, deregisterNotifier, get);
return get.$$watchDelegate(this, listener, objectEquality, get);
}
var scope = this,
array = scope.$$watchers,
Expand Down Expand Up @@ -358,9 +356,6 @@ function $RootScopeProvider(){
return function deregisterWatch() {
arrayRemove(array, watcher);
lastDirtyWatch = null;
if (isFunction(deregisterNotifier)) {
deregisterNotifier();
}
};
},

Expand Down Expand Up @@ -393,9 +388,9 @@ function $RootScopeProvider(){
var oldValues = new Array(watchExpressions.length);
var newValues = new Array(watchExpressions.length);
var deregisterFns = [];
var changeCount = 0;
var self = this;
var masterUnwatch;
var changeReactionScheduled = false;
var firstRun = true;

if (watchExpressions.length === 1) {
// Special case size of one
Expand All @@ -407,29 +402,31 @@ function $RootScopeProvider(){
}

forEach(watchExpressions, function (expr, i) {
var unwatch = self.$watch(expr, function watchGroupSubAction(value, oldValue) {
var unwatchFn = self.$watch(expr, function watchGroupSubAction(value, oldValue) {
newValues[i] = value;
oldValues[i] = oldValue;
changeCount++;
}, false, function watchGroupDeregNotifier() {
arrayRemove(deregisterFns, unwatch);
if (!deregisterFns.length) {
masterUnwatch();
if (!changeReactionScheduled) {
changeReactionScheduled = true;
self.$evalAsync(watchGroupAction);
}
});
deregisterFns.push(unwatchFn);
});

deregisterFns.push(unwatch);
}, this);
function watchGroupAction() {
changeReactionScheduled = false;

masterUnwatch = self.$watch(function watchGroupChangeWatch() {
return changeCount;
}, function watchGroupChangeAction(value, oldValue) {
listener(newValues, (value === oldValue) ? newValues : oldValues, self);
});
if (firstRun) {
firstRun = false;
listener(newValues, newValues, self);
} else {
listener(newValues, oldValues, self);
}
}

return function deregisterWatchGroup() {
while (deregisterFns.length) {
deregisterFns[0]();
deregisterFns.shift()();
}
};
},
Copy link
Contributor Author

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 this used to work. It wouldn't it result in an infinite loop?

Copy link
Contributor

Choose a reason for hiding this comment

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

I was going to ask, because I don't see it splicing the array in the diff (but I might just be missing it).

However, is it really good to reverse the order of deregistration, assuming it's working currently? Should this be shift() instead of pop()?

Copy link
Contributor

Choose a reason for hiding this comment

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

It worked previously because of this: https://github.com/angular/angular.js/blob/master/src/ng/rootScope.js#L358-L364

Copy link
Contributor

Choose a reason for hiding this comment

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

The removing used to happen here. It was confusing.
Since we no longer need to track which watchers are getting deregistered, this is a lot better :-)

I doubt changing pop to shift would actually change much for this.

Copy link
Contributor

Choose a reason for hiding this comment

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

Just be aware that the order is changing here, and we don't really know if that will matter

Copy link
Contributor

Choose a reason for hiding this comment

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

It would change things for deregisterNotifiers in $watch, but I believe this PR should be followed by one that removes deregisterNotifiers completely.
$watchGroup was the only place they were getting used, and we don't have a reason to support them in the future.

This will make the watcherDeregister functions only splice the $$watchers array, so order wouldn't matter

Copy link
Contributor

Choose a reason for hiding this comment

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

I am all for removing deregisterNotifiers

Copy link
Contributor Author

Choose a reason for hiding this comment

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

+1 for removing deregisterNotifiers in a separate commit.

I realized that the order has changed, but didn't think that it could cause problems. I'll make a change to keep the original order.

Expand Down
28 changes: 14 additions & 14 deletions test/ng/compileSpec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2893,21 +2893,21 @@ describe('$compile', function() {

inject(function($rootScope) {
compile('<div other-tpl-dir param1="::foo" param2="bar"></div>');
expect(countWatches($rootScope)).toEqual(7); // 5 -> template watch group, 2 -> '='
expect(countWatches($rootScope)).toEqual(6); // 4 -> template watch group, 2 -> '='
$rootScope.$digest();
expect(element.html()).toBe('1:;2:;3:;4:');
expect(countWatches($rootScope)).toEqual(7);
expect(countWatches($rootScope)).toEqual(6);

$rootScope.foo = 'foo';
$rootScope.$digest();
expect(element.html()).toBe('1:foo;2:;3:foo;4:');
expect(countWatches($rootScope)).toEqual(5);
expect(countWatches($rootScope)).toEqual(4);

$rootScope.foo = 'baz';
$rootScope.bar = 'bar';
$rootScope.$digest();
expect(element.html()).toBe('1:foo;2:bar;3:foo;4:bar');
expect(countWatches($rootScope)).toEqual(4);
expect(countWatches($rootScope)).toEqual(3);

$rootScope.bar = 'baz';
$rootScope.$digest();
Expand All @@ -2927,21 +2927,21 @@ describe('$compile', function() {

inject(function($rootScope) {
compile('<div other-tpl-dir param1="{{::foo}}" param2="{{bar}}"></div>');
expect(countWatches($rootScope)).toEqual(7); // 5 -> template watch group, 2 -> {{ }}
expect(countWatches($rootScope)).toEqual(6); // 4 -> template watch group, 2 -> {{ }}
$rootScope.$digest();
expect(element.html()).toBe('1:;2:;3:;4:');
expect(countWatches($rootScope)).toEqual(5); // (- 2) -> bind-once in template
expect(countWatches($rootScope)).toEqual(4); // (- 2) -> bind-once in template

$rootScope.foo = 'foo';
$rootScope.$digest();
expect(element.html()).toBe('1:foo;2:;3:;4:');
expect(countWatches($rootScope)).toEqual(4);
expect(countWatches($rootScope)).toEqual(3);

$rootScope.foo = 'baz';
$rootScope.bar = 'bar';
$rootScope.$digest();
expect(element.html()).toBe('1:foo;2:bar;3:;4:');
expect(countWatches($rootScope)).toEqual(4);
expect(countWatches($rootScope)).toEqual(3);

$rootScope.bar = 'baz';
$rootScope.$digest();
Expand All @@ -2964,18 +2964,18 @@ describe('$compile', function() {
compile('<div other-tpl-dir param1="::foo" param2="bar"></div>');
$rootScope.$digest();
expect(element.html()).toBe('1:;2:;3:;4:');
expect(countWatches($rootScope)).toEqual(7); // 5 -> template watch group, 2 -> '='
expect(countWatches($rootScope)).toEqual(6); // 4 -> template watch group, 2 -> '='

$rootScope.foo = 'foo';
$rootScope.$digest();
expect(element.html()).toBe('1:foo;2:;3:foo;4:');
expect(countWatches($rootScope)).toEqual(5);
expect(countWatches($rootScope)).toEqual(4);

$rootScope.foo = 'baz';
$rootScope.bar = 'bar';
$rootScope.$digest();
expect(element.html()).toBe('1:foo;2:bar;3:foo;4:bar');
expect(countWatches($rootScope)).toEqual(4);
expect(countWatches($rootScope)).toEqual(3);

$rootScope.bar = 'baz';
$rootScope.$digest();
Expand All @@ -2998,18 +2998,18 @@ describe('$compile', function() {
compile('<div other-tpl-dir param1="{{::foo}}" param2="{{bar}}"></div>');
$rootScope.$digest();
expect(element.html()).toBe('1:;2:;3:;4:');
expect(countWatches($rootScope)).toEqual(5); // (5 - 2) -> template watch group, 2 -> {{ }}
expect(countWatches($rootScope)).toEqual(4); // (4 - 2) -> template watch group, 2 -> {{ }}

$rootScope.foo = 'foo';
$rootScope.$digest();
expect(element.html()).toBe('1:foo;2:;3:;4:');
expect(countWatches($rootScope)).toEqual(4);
expect(countWatches($rootScope)).toEqual(3);

$rootScope.foo = 'baz';
$rootScope.bar = 'bar';
$rootScope.$digest();
expect(element.html()).toBe('1:foo;2:bar;3:;4:');
expect(countWatches($rootScope)).toEqual(4);
expect(countWatches($rootScope)).toEqual(3);

$rootScope.bar = 'baz';
$rootScope.$digest();
Expand Down
4 changes: 2 additions & 2 deletions test/ng/directive/ngBindSpec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,11 @@ describe('ngBind*', function() {
it('should one-time bind the expressions that start with ::', inject(function($rootScope, $compile) {
element = $compile('<div ng-bind-template="{{::hello}} {{::name}}!"></div>')($rootScope);
$rootScope.name = 'Misko';
expect($rootScope.$$watchers.length).toEqual(3);
expect($rootScope.$$watchers.length).toEqual(2);
$rootScope.$digest();
expect(element.hasClass('ng-binding')).toEqual(true);
expect(element.text()).toEqual(' Misko!');
expect($rootScope.$$watchers.length).toEqual(2);
expect($rootScope.$$watchers.length).toEqual(1);
$rootScope.hello = 'Hello';
$rootScope.name = 'Lucas';
$rootScope.$digest();
Expand Down
34 changes: 3 additions & 31 deletions test/ng/rootScopeSpec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,14 +149,14 @@ describe('Scope', function() {

it('should clean up stable watches from $watchGroup', inject(function($rootScope) {
$rootScope.$watchGroup(['::foo', '::bar'], function() {});
expect($rootScope.$$watchers.length).toEqual(3);
expect($rootScope.$$watchers.length).toEqual(2);

$rootScope.$digest();
expect($rootScope.$$watchers.length).toEqual(3);
expect($rootScope.$$watchers.length).toEqual(2);

$rootScope.foo = 'foo';
$rootScope.$digest();
expect($rootScope.$$watchers.length).toEqual(2);
expect($rootScope.$$watchers.length).toEqual(1);

$rootScope.bar = 'bar';
$rootScope.$digest();
Expand Down Expand Up @@ -526,34 +526,6 @@ describe('Scope', function() {
expect(log).toEqual(['watch1', 'watchAction1', 'watch2', 'watchAction2', 'watch3', 'watchAction3',
'watch2', 'watch3']);
}));

describe('deregisterNotifier', function () {
it('should call the deregisterNotifier when the watch is deregistered', inject(
function($rootScope) {
var notifier = jasmine.createSpy('deregisterNotifier');
var listenerRemove = $rootScope.$watch('noop', noop, false, notifier);

expect(notifier).not.toHaveBeenCalled();

listenerRemove();
expect(notifier).toHaveBeenCalledOnce();
}));


it('should call the deregisterNotifier when a one-time expression is stable', inject(
function($rootScope) {
var notifier = jasmine.createSpy('deregisterNotifier');
$rootScope.$watch('::foo', noop, false, notifier);

expect(notifier).not.toHaveBeenCalledOnce();
$rootScope.$digest();
expect(notifier).not.toHaveBeenCalledOnce();

$rootScope.foo = 'foo';
$rootScope.$digest();
expect(notifier).toHaveBeenCalledOnce();
}));
});
});


Expand Down