feat(injector): "strict-DI" mode which disables "automatic" function annotation / inferred dependencies by caitp · Pull Request #6719 · angular/angular.js

caitp · 2014-03-17T20:42:05Z

This modifies the injector to prevent automatic annotation (or inferring dependencies based on formal parameter names) from occurring for a given injector.

This behaviour can be enabled when bootstrapping the application by using the attribute
"ng-strict-di" on the root element (the element containing "ng-app"), or alternatively by passing
an object with the property "strictDi" set to "true" in angular.bootstrap, when bootstrapping
manually.

JS example:

    angular.module("name", ["dependencies", "otherdeps"])
      .provider("$willBreak", function() {
        this.$get = function($rootScope) {
        };
      })
      .run(["$willBreak", function($willBreak) {
        // This block will never run because the noMagic flag was set to true,
        // and the $willBreak '$get' function does not have an explicit
        // annotation.
      }]);

    angular.bootstrap(document, ["name"], {
      strictDi: true
    });

HTML:

    <html ng-app="name" ng-strict-di>
      <!-- ... -->
    </html>

This will only affect functions with an arity greater than 0, and without an $inject property.

btford · 2014-03-25T21:52:41Z

I like this a lot.

caitp · 2014-03-31T23:30:30Z

So, per discussion today, we should do this in bootstrap and the ng-app directives instead of making this change in the module definition layer

The problem becomes testing it, since angular-mocks doesn't really "bootstrap" anything, per se.

I think keeping the module API as is (in the patch), but removing the public API from it (no extra param to angular.module()), and then just adjusting angular-mocks and the bootstrap/auto-bootstrap code should be good enough

caitp · 2014-04-01T03:09:02Z

src/Angular.js

@petebacondarwin I'd like to use this in an example, but the docs preprocessor only understands the ng-app attribute and not ng-app-strict (if that does continue to be the correct name).

I was thinking it wouldn't be so bad to change the dgeni-packages template so that if ng-app-strict is present, it will include -strict, but I dunno.

In any case, this makes things kind of awkward.

I am not convinced that controlling this with a directive is the best API. If you are creating an application that is complex enough that you will need this then you are going to be writing a bunch of modules in JavaScript, in which case it is not a big deal to apply the flag to the module. For instance, you could have a method on the module API:

angular.module('myApp', ['ngRoute']) .requireAnnotations() .controller(...) ... .factory(...);

This is also more self-documenting - I doubt that anyone would ever be able to guess what ng-app-strict actually meant, without having to go to the docs.

Any, regarding the examples, we have a nice feature that asks Dgeni not to automatically apply an ng-app to the index.html wrapper that gets generated, which allows us to apply it explicitly inside the example itself. We use this in the Concepts guide: https://github.com/angular/angular.js/blob/master/docs/content/guide/concepts.ngdoc#L35.

In this case the example will look like:

<example ng-app-included="true"> <file name="index.html"> <div ng-app-strict="ngAppStrictDemo"> ... </file> </example>

For instance, you could have a method on the module API:

This was discussed during the meeting, the problem with doing this at the module level is that it technically applies to all modules in the application, even if it's added by a third-party one. Doing this during bootstrapping means that it's in the application's control, regardless of what third party modules are doing.

I do agree that the directive name could (should) be better, but I didn't want to spend too much time thinking about what it should be.

Onto the docs thing (again), ah, I thought the docs processor was preprocessing it to find the attribute, but I guess not. So that should fix that up.

IgorMinar · 2014-04-07T20:08:40Z

can we:

rename this to strictDi and ng-strict-di
add an error page

caitp · 2014-04-07T21:23:16Z

Docs page demo: http://ci.angularjs.org/job/angular.js-caitlin/274/artifact/build/docs/error/$injector/strctdi?p0=BadController

I think it looks okay

btford · 2014-04-07T21:32:06Z

Looks good to me!

petebacondarwin · 2014-04-09T13:04:52Z

docs/content/error/$injector/strctdi.ngdoc

strctdi is a bit vague - I might think strct is to do with structure? Is there a problem with using strictdi?

petebacondarwin · 2014-04-09T13:11:27Z

src/Angular.js

Can we sniff whether getAttribute is available outside this loop?

I think it's less work to just defer to jqLite for this, since jquery/jqlite should have already been chosen by the time this is called. Testing locally it works, so it's probably okay.

IgorMinar · 2014-04-10T21:26:39Z

lgtm. just squash it into a single commit please

…annotation This modifies the injector to prevent automatic annotation from occurring for a given injector. This behaviour can be enabled when bootstrapping the application by using the attribute "ng-strict-di" on the root element (the element containing "ng-app"), or alternatively by passing an object with the property "strictDi" set to "true" in angular.bootstrap, when bootstrapping manually. JS example: angular.module("name", ["dependencies", "otherdeps"]) .provider("$willBreak", function() { this.$get = function($rootScope) { }; }) .run(["$willBreak", function($willBreak) { // This block will never run because the noMagic flag was set to true, // and the $willBreak '$get' function does not have an explicit // annotation. }]); angular.bootstrap(document, ["name"], { strictDi: true }); HTML: <html ng-app="name" ng-strict-di>  </html> This will only affect functions with an arity greater than 0, and without an $inject property. Closes angular#6719 Closes angular#6717 Closes angular#4504 Closes angular#6069 Closes angular#3611

btford · 2014-04-10T22:00:46Z

🎊

…annotation This modifies the injector to prevent automatic annotation from occurring for a given injector. This behaviour can be enabled when bootstrapping the application by using the attribute "ng-strict-di" on the root element (the element containing "ng-app"), or alternatively by passing an object with the property "strictDi" set to "true" in angular.bootstrap, when bootstrapping manually. JS example: angular.module("name", ["dependencies", "otherdeps"]) .provider("$willBreak", function() { this.$get = function($rootScope) { }; }) .run(["$willBreak", function($willBreak) { // This block will never run because the noMagic flag was set to true, // and the $willBreak '$get' function does not have an explicit // annotation. }]); angular.bootstrap(document, ["name"], { strictDi: true }); HTML: <html ng-app="name" ng-strict-di>  </html> This will only affect functions with an arity greater than 0, and without an $inject property. Closes angular#6719 Closes angular#6717 Closes angular#4504 Closes angular#6069 Closes angular#3611

…annotation This modifies the injector to prevent automatic annotation from occurring for a given injector. This behaviour can be enabled when bootstrapping the application by using the attribute "ng-strict-di" on the root element (the element containing "ng-app"), or alternatively by passing an object with the property "strictDi" set to "true" in angular.bootstrap, when bootstrapping manually. JS example: angular.module("name", ["dependencies", "otherdeps"]) .provider("$willBreak", function() { this.$get = function($rootScope) { }; }) .run(["$willBreak", function($willBreak) { // This block will never run because the noMagic flag was set to true, // and the $willBreak '$get' function does not have an explicit // annotation. }]); angular.bootstrap(document, ["name"], { strictDi: true }); HTML: <html ng-app="name" ng-strict-di>  </html> This will only affect functions with an arity greater than 0, and without an $inject property. Closes #6719 Closes #6717 Closes #4504 Closes #6069 Closes #3611

caitp added component: misc core and removed component: misc core labels Mar 17, 2014

btford added frequency: high labels Mar 17, 2014

btford added this to the 1.3.0 milestone Mar 17, 2014

auser self-assigned this Mar 17, 2014

caitp added cla: yes and removed cla: no labels Mar 18, 2014

tbosch assigned btford and unassigned auser Mar 31, 2014

tbosch modified the milestones: 1.3.0-beta.5, 1.3.0 Mar 31, 2014

caitp reviewed Apr 1, 2014
View reviewed changes

jeffbcross modified the milestones: 1.3.0-beta.6, 1.3.0-beta.5 Apr 3, 2014

btford mentioned this pull request Apr 7, 2014

Use "strict DI mode" btford/ngmin#88

Closed

petebacondarwin reviewed Apr 9, 2014
View reviewed changes

caitp mentioned this pull request Apr 10, 2014

ngMock $TimeoutDecorator needs to declare dependencies #6069

Closed

caitp closed this in 4b1695e Apr 10, 2014

caitp changed the title ~~feat(injector): optionally disable automatic function annotation~~ feat(injector): "strict-DI" mode which disables "automatic" function annotation / inferred dependencies Apr 10, 2014

Conversation

caitp commented Mar 17, 2014

Uh oh!

btford commented Mar 25, 2014

Uh oh!

caitp commented Mar 31, 2014

Uh oh!

caitp Apr 1, 2014

Choose a reason for hiding this comment

Uh oh!

petebacondarwin Apr 1, 2014

Choose a reason for hiding this comment

Uh oh!

caitp Apr 1, 2014

Choose a reason for hiding this comment

Uh oh!

IgorMinar commented Apr 7, 2014

Uh oh!

caitp commented Apr 7, 2014

Uh oh!

btford commented Apr 7, 2014

Uh oh!

petebacondarwin Apr 9, 2014

Choose a reason for hiding this comment

Uh oh!

petebacondarwin Apr 9, 2014

Choose a reason for hiding this comment

Uh oh!

caitp Apr 10, 2014

Choose a reason for hiding this comment

Uh oh!

IgorMinar commented Apr 10, 2014

Uh oh!

btford commented Apr 10, 2014

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants