feat: change @Injectable() to support tree-shakeable tokens (angular#22005)

This commit bundles 3 important changes, with the goal of enabling tree-shaking
of services which are never injected. Ordinarily, this tree-shaking is prevented
by the existence of a hard dependency on the service by the module in which it
is declared.

Firstly, @Injectable() is modified to accept a 'scope' parameter, which points
to an @NgModule(). This reverses the dependency edge, permitting the module to
not depend on the service which it "provides".

Secondly, the runtime is modified to understand the new relationship created
above. When a module receives a request to inject a token, and cannot find that
token in its list of providers, it will then look at the token for a special
ngInjectableDef field which indicates which module the token is scoped to. If
that module happens to be in the injector, it will behave as if the token
itself was in the injector to begin with.

Thirdly, the compiler is modified to read the @Injectable() metadata and to
generate the special ngInjectableDef field as part of TS compilation, using the
PartialModules system.

Additionally, this commit adds several unit and integration tests of various
flavors to test this change.

PR Close angular#22005

Author: alxhub

integration/_payload-limits.json

@@ -3,15 +3,15 @@
     "master": {
       "uncompressed": {
         "inline": 1447,
-        "main": 154185,
+        "main": 159944,
         "polyfills": 59179
       }
     }
   },
   "hello_world__closure": {
     "master": {
       "uncompressed": {
-        "bundle": 101744
+        "bundle": 105779
       }
     }
   },

integration/injectable-def/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "angular-integration",
+  "version": "0.0.0",
+  "license": "MIT",
+  "dependencies": {
+    "@angular/animations": "file:../../dist/packages-dist/animations",
+    "@angular/common": "file:../../dist/packages-dist/common",
+    "@angular/compiler": "file:../../dist/packages-dist/compiler",
+    "@angular/compiler-cli": "file:../../dist/packages-dist/compiler-cli",
+    "@angular/core": "file:../../dist/packages-dist/core",
+    "@angular/http": "file:../../dist/packages-dist/http",
+    "@angular/platform-browser": "file:../../dist/packages-dist/platform-browser",
+    "@angular/platform-browser-dynamic": "file:../../dist/packages-dist/platform-browser-dynamic",
+    "@angular/platform-server": "file:../../dist/packages-dist/platform-server",
+    "@types/node": "^9.4.0",
+    "rxjs": "file:../../node_modules/rxjs",
+    "typescript": "file:../../node_modules/typescript",
+    "zone.js": "file:../../node_modules/zone.js"
+  },
+  "devDependencies": {
+    "@types/jasmine": "2.5.41",
+    "concurrently": "3.4.0",
+    "lite-server": "2.2.2",
+    "protractor": "file:../../node_modules/protractor"
+  },
+  "scripts": {
+    "test": "./test.sh"
+  }
+}

integration/injectable-def/src/app.ts

@@ -0,0 +1,21 @@
+import {Component, NgModule} from '@angular/core';
+import {BrowserModule} from '@angular/platform-browser';
+import {ServerModule} from '@angular/platform-server';
+import {Lib2Module} from 'lib2_built';
+
+@Component({
+  selector: 'test-app',
+  template: '<test-cmp></test-cmp>',
+})
+export class TestApp {}
+
+@NgModule({
+  declarations: [TestApp],
+  bootstrap: [TestApp],
+  imports: [
+    Lib2Module,
+    BrowserModule.withServerTransition({appId: 'appId'}),
+    ServerModule,
+  ],
+})
+export class AppModule {}

integration/injectable-def/src/lib1.ts

@@ -0,0 +1,10 @@
+import {Injectable, NgModule} from '@angular/core';
+
+@NgModule({})
+export class Lib1Module {}
+
+@Injectable({scope: Lib1Module})
+export class Service {
+  static instance = 0;
+  readonly instance = Service.instance++;
+}

integration/injectable-def/src/lib2.ts

@@ -0,0 +1,23 @@
+import {Component, Injector, NgModule} from '@angular/core';
+import {Lib1Module, Service} from 'lib1_built';
+
+@Component({
+  selector: 'test-cmp',
+  template: '{{instance1}}:{{instance2}}',
+})
+export class TestCmp {
+  instance1: number;
+  instance2: number;
+
+  constructor(service: Service, injector: Injector) {
+    this.instance1 = service.instance;
+    this.instance2 = injector.get(Service).instance;
+  }
+}
+
+@NgModule({
+  declarations: [TestCmp],
+  exports: [TestCmp],
+  imports: [Lib1Module],
+})
+export class Lib2Module {}

integration/injectable-def/src/main.ts

@@ -0,0 +1,21 @@
+import 'zone.js/dist/zone-node';
+
+import {enableProdMode} from '@angular/core';
+import {renderModuleFactory} from '@angular/platform-server';
+import {AppModuleNgFactory} from './app.ngfactory';
+
+enableProdMode();
+renderModuleFactory(AppModuleNgFactory, {
+  document: '<test-app></test-app>',
+  url: '/',
+}).then(html => {
+  if (/>0:0</.test(html)) {
+    process.exit(0);
+  } else {
+    console.error('html was', html);
+    process.exit(1);
+  }
+}).catch(err => {
+  console.error(err);
+  process.exit(2);
+})

integration/injectable-def/src/package-lib1.json

@@ -0,0 +1,7 @@
+{
+  "name": "lib1_built",
+  "version": "0.0.0",
+  "license": "MIT",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts"
+}

integration/injectable-def/src/package-lib2.json

@@ -0,0 +1,7 @@
+{
+  "name": "lib2_built",
+  "version": "0.0.0",
+  "license": "MIT",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts"
+}

integration/injectable-def/test.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -e -x
+
+NPM_BIN=$(npm bin)
+PATH="$PATH:${NPM_BIN}"
+
+rm -rf node_modules/lib1_built node_modules/lib2_built dist/
+
+ngc -p tsconfig-lib1.json
+cp src/package-lib1.json node_modules/lib1_built/package.json
+
+ngc -p tsconfig-lib2.json
+cp src/package-lib2.json node_modules/lib2_built/package.json
+
+ngc -p tsconfig-app.json
+
+node ./dist/src/main.js

integration/injectable-def/tsconfig-app.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "lib": ["es2015", "dom"],
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "outDir": "dist",
+    "types": ["node"],
+    "rootDir": "."
+  },
+  "files": [
+    "src/app.ts",
+    "src/main.ts"
+  ]
+}

integration/injectable-def/tsconfig-lib1.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "declaration": true,
+    "moduleResolution": "node",
+    "lib": ["es2015", "dom"],
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "outDir": "node_modules/lib1_built",
+    "types": [],
+    "rootDir": "."
+  },
+  "files": [
+    "src/lib1.ts"
+  ],
+  "angularCompilerOptions": {
+    "skipTemplateCodegen": true,
+    "flatModuleOutFile": "index.js",
+    "flatModuleId": "lib1_built"
+  }
+}

integration/injectable-def/tsconfig-lib2.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "declaration": true,
+    "moduleResolution": "node",
+    "lib": ["es2015", "dom"],
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "outDir": "node_modules/lib2_built",
+    "types": [],
+    "rootDir": "."
+  },
+  "files": [
+    "src/lib2.ts"
+  ],
+  "angularCompilerOptions": {
+    "skipTemplateCodegen": true,
+    "flatModuleId": "lib2_built",
+    "flatModuleOutFile": "index.js"
+  }
+}

packages/compiler-cli/integrationtest/bazel/injectable_def/app/BUILD.bazel

@@ -0,0 +1,21 @@
+package(default_visibility = ["//visibility:public"])
+
+load("//tools:defaults.bzl", "ng_module", "ts_library")
+load("@build_bazel_rules_nodejs//:defs.bzl", "jasmine_node_test")
+
+ng_module(
+    name = "app",
+    srcs = glob(
+        [
+            "src/**/*.ts",
+        ],
+    ),
+    module_name = "app_built",
+    deps = [
+        "//packages/compiler-cli/integrationtest/bazel/injectable_def/lib2",
+        "//packages/core",
+        "//packages/platform-browser",
+        "//packages/platform-server",
+        "@rxjs",
+    ],
+)

packages/compiler-cli/integrationtest/bazel/injectable_def/app/src/basic.ts

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+
+import {Component, NgModule} from '@angular/core';
+import {BrowserModule} from '@angular/platform-browser';
+import {ServerModule} from '@angular/platform-server';
+import {Lib2Module} from 'lib2_built/module';
+
+@Component({
+  selector: 'id-app',
+  template: '<lib2-cmp></lib2-cmp>',
+})
+export class AppComponent {
+}
+
+@NgModule({
+  imports: [
+    Lib2Module,
+    BrowserModule.withServerTransition({appId: 'id-app'}),
+    ServerModule,
+  ],
+  declarations: [AppComponent],
+  bootstrap: [AppComponent],
+})
+export class BasicAppModule {
+}

packages/compiler-cli/integrationtest/bazel/injectable_def/app/src/hierarchy.ts

@@ -0,0 +1,44 @@
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+
+import {Component, Injectable, NgModule, Optional, Self} from '@angular/core';
+import {BrowserModule} from '@angular/platform-browser';
+import {ServerModule} from '@angular/platform-server';
+
+@Injectable()
+export class Service {
+}
+
+@Component({
+  selector: 'hierarchy-app',
+  template: '<child-cmp></child-cmp>',
+  providers: [Service],
+})
+export class AppComponent {
+}
+
+@Component({
+  selector: 'child-cmp',
+  template: '{{found}}',
+})
+export class ChildComponent {
+  found: boolean;
+
+  constructor(@Optional() @Self() service: Service|null) { this.found = !!service; }
+}
+
+@NgModule({
+  imports: [
+    BrowserModule.withServerTransition({appId: 'hierarchy-app'}),
+    ServerModule,
+  ],
+  declarations: [AppComponent, ChildComponent],
+  bootstrap: [AppComponent],
+})
+export class HierarchyAppModule {
+}

packages/compiler-cli/integrationtest/bazel/injectable_def/app/src/self.ts

@@ -0,0 +1,41 @@
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+
+import {Component, Injectable, NgModule, Optional, Self} from '@angular/core';
+import {BrowserModule} from '@angular/platform-browser';
+import {ServerModule} from '@angular/platform-server';
+
+@Injectable()
+export class NormalService {
+  constructor(@Optional() @Self() readonly shakeable: ShakeableService|null) {}
+}
+
+@Component({
+  selector: 'self-app',
+  template: '{{found}}',
+})
+export class AppComponent {
+  found: boolean;
+  constructor(service: NormalService) { this.found = !!service.shakeable; }
+}
+
+@NgModule({
+  imports: [
+    BrowserModule.withServerTransition({appId: 'id-app'}),
+    ServerModule,
+  ],
+  declarations: [AppComponent],
+  bootstrap: [AppComponent],
+  providers: [NormalService],
+})
+export class SelfAppModule {
+}
+
+@Injectable({scope: SelfAppModule})
+export class ShakeableService {
+}