Detect manipulation of DOM APIs from controllers to encourage AngularJS best practices
AngularJS provides a framework for separating the implementation of a web application into logical components. This separation of concerns is important for code development, maintenance and especially testing. With modular code, it is easy to implement unit tests.
However, it is not immediately apparent to the learner how an application's logic should be split into these logical components. For example, many applications built without Angular rely on javascript for heavy manipulation of the DOM including dynamically adding and removing elements from the page. Naturally, a programmer beginning to use Angular might want to use similar javascript manipulation in their controllers. As the controllers provide the logic for the views, this could seem to be a correct usage. However, AngularJS allows all such manipulation to occur through Angular directives in the views themselves. In fact, manipulation of DOM APIs from the controller violates the modularity between the controller and view and is against the AngularJS best practices.
To help users recognize the violation of this best practice, controller-training throws errors when DOM APIs are manipulated in Angular controllers.
The implementation of controller-training has two pieces.
-
First, a service patches all relevant DOM APIs in order to throw the error message indicating controller manipulation. This is accomplished by patching the prototypes of
Element,Node, andEventTargetandDocumentwith the function as well as patching the properties of individual elements on the page. -
Second, the service is used to decorate the
$controllerservice of AngularJS. Hence, when a controller is used, the controller-training service is called as well. To handle asynchronous uses of$controller, thezone.jslibrary is used to create a zone for that interaction with the controller.
The sampleApp contained in this repository has examples of controller manipulation that violate best practice and will cause errors if the controllerTrainer module is loaded. The sample also contains correct Angular implementations that do not violate best practices and accomplish the same goals.
Injecting the controllerTrainer module in an application's central module will enable its features if the files are also present.
Copyright 2014 Google, Inc. http://angularjs.org
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.