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

Commit

Permalink
fix(compile): should not leak memory when there are top level empty t…
Browse files Browse the repository at this point in the history
…ext nodes

The change to prevent <span> elements being wrapped around empty text nodes caused these empty text nodes to have scopes and controllers attached, through jqLite.data() calls, which led to memory leaks and errors in IE8.
Now we exclude all but document nodes and elements from having jqLite.data() set both in the compiler and in ng-view.

Fixes: #1968 and #1876
  • Loading branch information
petebacondarwin committed Feb 18, 2013
1 parent 7eafbb9 commit 791804b
Show file tree
Hide file tree
Showing 4 changed files with 75 additions and 4 deletions.
9 changes: 8 additions & 1 deletion src/ng/compile.js
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,14 @@ function $CompileProvider($provide) {
var $linkNode = cloneConnectFn
? JQLitePrototype.clone.call($compileNodes) // IMPORTANT!!!
: $compileNodes;
$linkNode.data('$scope', scope);

// Attach scope only to non-text nodes.
for(var i = 0, ii = $linkNode.length; i<ii; i++) {
var node = $linkNode[i];
if (node.nodeType == 1 /* element */ || node.nodeType == 9 /* document */) {
$linkNode.eq(i).data('$scope', scope);
}
}
safeAddClass($linkNode, 'ng-scope');
if (cloneConnectFn) cloneConnectFn($linkNode, scope);
if (compositeLinkFn) compositeLinkFn(scope, $linkNode, $linkNode);
Expand Down
2 changes: 1 addition & 1 deletion src/ng/directive/ngView.js
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ var ngViewDirective = ['$http', '$templateCache', '$route', '$anchorScroll', '$c
if (current.controller) {
locals.$scope = lastScope;
controller = $controller(current.controller, locals);
element.contents().data('$ngControllerController', controller);
element.children().data('$ngControllerController', controller);
}

link(lastScope);
Expand Down
42 changes: 41 additions & 1 deletion test/ng/compileSpec.js
Original file line number Diff line number Diff line change
Expand Up @@ -116,12 +116,17 @@ describe('$compile', function() {

describe('compile phase', function() {

it('should attach scope to the document node when it is compiled explicitly', inject(function($document){
$compile($document)($rootScope);
expect($document.scope()).toBe($rootScope);
}));

it('should wrap root text nodes in spans', inject(function($compile, $rootScope) {
element = jqLite('<div>A&lt;a&gt;B&lt;/a&gt;C</div>');
var text = element.contents();
expect(text[0].nodeName).toEqual('#text');
text = $compile(text)($rootScope);
expect(lowercase(text[0].nodeName)).toEqual('span');
expect(text[0].nodeName).toEqual('SPAN');
expect(element.find('span').text()).toEqual('A<a>B</a>C');
}));

Expand All @@ -137,6 +142,41 @@ describe('$compile', function() {
expect(spans.text().indexOf('C')).toEqual(0);
});

it('should not leak memory when there are top level empty text nodes', function() {
var calcCacheSize = function() {
var size = 0;
forEach(jqLite.cache, function(item, key) { size++; });
return size;
};

// We compile the contents of element (i.e. not element itself)
// Then delete these contents and check the cache has been reset to zero

// First with only elements at the top level
element = jqLite('<div><div></div></div>');
$compile(element.contents())($rootScope);
element.html('');
expect(calcCacheSize()).toEqual(0);

// Next with non-empty text nodes at the top level
// (in this case the compiler will wrap them in a <span>)
element = jqLite('<div>xxx</div>');
$compile(element.contents())($rootScope);
element.html('');
expect(calcCacheSize()).toEqual(0);

// Next with comment nodes at the top level
element = jqLite('<div><!-- comment --></div>');
$compile(element.contents())($rootScope);
element.html('');
expect(calcCacheSize()).toEqual(0);

// Finally with empty text nodes at the top level
element = jqLite('<div> \n<div></div> </div>');
$compile(element.contents())($rootScope);
element.html('');
expect(calcCacheSize()).toEqual(0);
});

describe('multiple directives per element', function() {
it('should allow multiple directives per element', inject(function($compile, $rootScope, log){
Expand Down
26 changes: 25 additions & 1 deletion test/ng/directive/ngViewSpec.js
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,7 @@ describe('ngView', function() {
$rootScope.$digest();
expect($rootScope.load).toHaveBeenCalledOnce();
});
})
});


it('should set $scope and $controllerController on the view', function() {
Expand Down Expand Up @@ -459,4 +459,28 @@ describe('ngView', function() {
expect(div.controller()).toBe($route.current.scope.ctrl);
});
});

it('should not set $scope or $controllerController on top level text elements in the view', function() {
function MyCtrl($scope) {}

module(function($routeProvider) {
$routeProvider.when('/foo', {templateUrl: 'tpl.html', controller: MyCtrl});
});

inject(function($templateCache, $location, $rootScope, $route) {
$templateCache.put('tpl.html', '<div></div> ');
$location.url('/foo');
$rootScope.$digest();

forEach(element.contents(), function(node) {
if ( node.nodeType == 3 ) {
expect(jqLite(node).scope()).not.toBe($route.current.scope);
expect(jqLite(node).controller()).not.toBeDefined();
} else {
expect(jqLite(node).scope()).toBe($route.current.scope);
expect(jqLite(node).controller()).toBeDefined();
}
});
});
});
});

0 comments on commit 791804b

Please sign in to comment.