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 #22005
201 lines
6.6 KiB
TypeScript
201 lines
6.6 KiB
TypeScript
/**
|
|
* @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 {resolveForwardRef} from '../di/forward_ref';
|
|
import {InjectFlags, Injector, setCurrentInjector} from '../di/injector';
|
|
import {NgModuleRef} from '../linker/ng_module_factory';
|
|
import {stringify} from '../util';
|
|
|
|
import {DepDef, DepFlags, InjectableDef, NgModuleData, NgModuleDefinition, NgModuleProviderDef, NodeFlags} from './types';
|
|
import {splitDepsDsl, tokenKey} from './util';
|
|
|
|
const UNDEFINED_VALUE = new Object();
|
|
|
|
const InjectorRefTokenKey = tokenKey(Injector);
|
|
const NgModuleRefTokenKey = tokenKey(NgModuleRef);
|
|
|
|
export function injectableDef(scope: any, factory: () => any): InjectableDef {
|
|
return {
|
|
scope, factory,
|
|
};
|
|
}
|
|
|
|
export function moduleProvideDef(
|
|
flags: NodeFlags, token: any, value: any,
|
|
deps: ([DepFlags, any] | any)[]): NgModuleProviderDef {
|
|
// Need to resolve forwardRefs as e.g. for `useValue` we
|
|
// lowered the expression and then stopped evaluating it,
|
|
// i.e. also didn't unwrap it.
|
|
value = resolveForwardRef(value);
|
|
const depDefs = splitDepsDsl(deps, stringify(token));
|
|
return {
|
|
// will bet set by the module definition
|
|
index: -1,
|
|
deps: depDefs, flags, token, value
|
|
};
|
|
}
|
|
|
|
export function moduleDef(providers: NgModuleProviderDef[]): NgModuleDefinition {
|
|
const providersByKey: {[key: string]: NgModuleProviderDef} = {};
|
|
const modules = [];
|
|
for (let i = 0; i < providers.length; i++) {
|
|
const provider = providers[i];
|
|
if (provider.flags & NodeFlags.TypeNgModule) {
|
|
modules.push(provider.token);
|
|
}
|
|
provider.index = i;
|
|
providersByKey[tokenKey(provider.token)] = provider;
|
|
}
|
|
return {
|
|
// Will be filled later...
|
|
factory: null,
|
|
providersByKey,
|
|
providers,
|
|
modules,
|
|
};
|
|
}
|
|
|
|
export function initNgModule(data: NgModuleData) {
|
|
const def = data._def;
|
|
const providers = data._providers = new Array(def.providers.length);
|
|
for (let i = 0; i < def.providers.length; i++) {
|
|
const provDef = def.providers[i];
|
|
if (!(provDef.flags & NodeFlags.LazyProvider)) {
|
|
providers[i] = _createProviderInstance(data, provDef);
|
|
}
|
|
}
|
|
}
|
|
|
|
export function resolveNgModuleDep(
|
|
data: NgModuleData, depDef: DepDef, notFoundValue: any = Injector.THROW_IF_NOT_FOUND): any {
|
|
if (depDef.flags & DepFlags.Value) {
|
|
return depDef.token;
|
|
}
|
|
if (depDef.flags & DepFlags.Optional) {
|
|
notFoundValue = null;
|
|
}
|
|
if (depDef.flags & DepFlags.SkipSelf) {
|
|
return data._parent.get(depDef.token, notFoundValue);
|
|
}
|
|
const tokenKey = depDef.tokenKey;
|
|
switch (tokenKey) {
|
|
case InjectorRefTokenKey:
|
|
case NgModuleRefTokenKey:
|
|
return data;
|
|
}
|
|
const providerDef = data._def.providersByKey[tokenKey];
|
|
if (providerDef) {
|
|
let providerInstance = data._providers[providerDef.index];
|
|
if (providerInstance === undefined) {
|
|
providerInstance = data._providers[providerDef.index] =
|
|
_createProviderInstance(data, providerDef);
|
|
}
|
|
return providerInstance === UNDEFINED_VALUE ? undefined : providerInstance;
|
|
} else if (depDef.token.ngInjectableDef && targetsModule(data, depDef.token.ngInjectableDef)) {
|
|
const injectableDef = depDef.token.ngInjectableDef as InjectableDef;
|
|
const key = tokenKey;
|
|
const index = data._providers.length;
|
|
data._def.providersByKey[depDef.tokenKey] = {
|
|
flags: NodeFlags.TypeFactoryProvider | NodeFlags.LazyProvider,
|
|
value: injectableDef.factory,
|
|
deps: [], index,
|
|
token: depDef.token,
|
|
};
|
|
const former = setCurrentInjector(data);
|
|
try {
|
|
data._providers[index] = UNDEFINED_VALUE;
|
|
return (
|
|
data._providers[index] =
|
|
_createProviderInstance(data, data._def.providersByKey[depDef.tokenKey]));
|
|
} finally {
|
|
setCurrentInjector(former);
|
|
}
|
|
}
|
|
return data._parent.get(depDef.token, notFoundValue);
|
|
}
|
|
|
|
function targetsModule(ngModule: NgModuleData, def: InjectableDef): boolean {
|
|
return def.scope != null && ngModule._def.modules.indexOf(def.scope) > -1;
|
|
}
|
|
|
|
function _createProviderInstance(ngModule: NgModuleData, providerDef: NgModuleProviderDef): any {
|
|
let injectable: any;
|
|
switch (providerDef.flags & NodeFlags.Types) {
|
|
case NodeFlags.TypeClassProvider:
|
|
injectable = _createClass(ngModule, providerDef.value, providerDef.deps);
|
|
break;
|
|
case NodeFlags.TypeFactoryProvider:
|
|
injectable = _callFactory(ngModule, providerDef.value, providerDef.deps);
|
|
break;
|
|
case NodeFlags.TypeUseExistingProvider:
|
|
injectable = resolveNgModuleDep(ngModule, providerDef.deps[0]);
|
|
break;
|
|
case NodeFlags.TypeValueProvider:
|
|
injectable = providerDef.value;
|
|
break;
|
|
}
|
|
return injectable === undefined ? UNDEFINED_VALUE : injectable;
|
|
}
|
|
|
|
function _createClass(ngModule: NgModuleData, ctor: any, deps: DepDef[]): any {
|
|
const len = deps.length;
|
|
switch (len) {
|
|
case 0:
|
|
return new ctor();
|
|
case 1:
|
|
return new ctor(resolveNgModuleDep(ngModule, deps[0]));
|
|
case 2:
|
|
return new ctor(resolveNgModuleDep(ngModule, deps[0]), resolveNgModuleDep(ngModule, deps[1]));
|
|
case 3:
|
|
return new ctor(
|
|
resolveNgModuleDep(ngModule, deps[0]), resolveNgModuleDep(ngModule, deps[1]),
|
|
resolveNgModuleDep(ngModule, deps[2]));
|
|
default:
|
|
const depValues = new Array(len);
|
|
for (let i = 0; i < len; i++) {
|
|
depValues[i] = resolveNgModuleDep(ngModule, deps[i]);
|
|
}
|
|
return new ctor(...depValues);
|
|
}
|
|
}
|
|
|
|
function _callFactory(ngModule: NgModuleData, factory: any, deps: DepDef[]): any {
|
|
const len = deps.length;
|
|
switch (len) {
|
|
case 0:
|
|
return factory();
|
|
case 1:
|
|
return factory(resolveNgModuleDep(ngModule, deps[0]));
|
|
case 2:
|
|
return factory(resolveNgModuleDep(ngModule, deps[0]), resolveNgModuleDep(ngModule, deps[1]));
|
|
case 3:
|
|
return factory(
|
|
resolveNgModuleDep(ngModule, deps[0]), resolveNgModuleDep(ngModule, deps[1]),
|
|
resolveNgModuleDep(ngModule, deps[2]));
|
|
default:
|
|
const depValues = Array(len);
|
|
for (let i = 0; i < len; i++) {
|
|
depValues[i] = resolveNgModuleDep(ngModule, deps[i]);
|
|
}
|
|
return factory(...depValues);
|
|
}
|
|
}
|
|
|
|
export function callNgModuleLifecycle(ngModule: NgModuleData, lifecycles: NodeFlags) {
|
|
const def = ngModule._def;
|
|
for (let i = 0; i < def.providers.length; i++) {
|
|
const provDef = def.providers[i];
|
|
if (provDef.flags & NodeFlags.OnDestroy) {
|
|
const instance = ngModule._providers[i];
|
|
if (instance && instance !== UNDEFINED_VALUE) {
|
|
instance.ngOnDestroy();
|
|
}
|
|
}
|
|
}
|
|
}
|