Closed $modal reference kept in memory but not in DOM? (>=0.9.0 only)

[gregtzar]

It looks as though a reference to a closed $modal is being kept in memory, even when the modal is removed from the DOM. This happens when I use $rootScope.$on() in the modal's controller.. I'm not sure if it happens without it.

I can reproduce in >=0.9.0 but not <=0.8.0 with latest Chrome browser.

Plunkr: http://plnkr.co/edit/ahB5ScVghWr1ZRcvPWlz

1. Open console
2. Click the Launch button to launch overlay
3. Click the Close button in overlay to close it
4. Click the CloseAll button to send a message to any open overlays (there are none)
5. See uncaught exception from ui.bootstrap
6. Swap out the 0.9.0 script tag for 0.8.0 and run the procedure again.. no uncaught exception

Update: On second thought it looks as though the problem might be with the $on listener not being cleaned up.

[gregtzar]

Note also that if you launch/close the modal multiple times, and then click on CloseAll, multiple exceptions are generated (one for every modal).

[gregtzar]

Here is the exception:
TypeError: Cannot read property 'value' of undefined
at Object.$modalStack.close (http://angular-ui.github.io/bootstrap/ui-bootstrap-tpls-0.9.0.js:1554:59)
at Object.modalInstance.close (http://angular-ui.github.io/bootstrap/ui-bootstrap-tpls-0.9.0.js:1615:29)
at Scope.$scope.$close (http://run.plnkr.co/4b5bIuxXXOMsVQrE/script.js:28:20)
at http://run.plnkr.co/4b5bIuxXXOMsVQrE/script.js:32:12
at Scope.$emit (http://code.angularjs.org/1.2.10/angular.js:12154:33)
at Scope.$scope.closeAll (http://run.plnkr.co/4b5bIuxXXOMsVQrE/script.js:19:16)
at http://code.angularjs.org/1.2.10/angular.js:10185:21
at http://code.angularjs.org/1.2.10/angular.js:17835:17
at Scope.$eval (http://code.angularjs.org/1.2.10/angular.js:11936:28)
at Scope.$apply (http://code.angularjs.org/1.2.10/angular.js:12036:23)

[chrisirhc]

The CloseAll listeners aren't being cleaned up because you're adding them to the $rootScope. Listeners added to the $rootScope will never be removed unless you remove them manually. What you probably wanted to do is to listen on the $scope of the modal for the CloseAll event.
http://plnkr.co/edit/RENEj0jPaugsZGzGOmRK?p=preview

Also note that you can use $modalStack.dismissAll as of 0.10 .

[chrisirhc]

Just re-looked into this and found the problem in your code. Please re-open if this issue isn't resolved.

[gregtzar]

@chrisirhc Yep what you said about having the listener on $rootScope makes sense. I was using $rootScope rather than $scope for performance reasons, so that I can $emit down the tree (which in the case of $rootScope ends at $rootScope) rather than $broadcast up it. But I could always clean up these listeners myself. Is there a way to override or extend the close or destroy method triggered by $modalStack.dismissAll? I need different modals to respond differently to the 'close all' request.

Still I wonder why it is these listeners seem to be automatically cleaned up in <=0.8.0 but not in >=0.9.0. Perhaps it is actually a bug in <=0.8.0 where they should not be getting cleaned up but somehow they are.