528 lines
21 KiB
TypeScript
528 lines
21 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 {CompileDiDependencyMetadata, CompileDirectiveMetadata, CompileNgModuleMetadata, CompileProviderMetadata, CompileQueryMetadata, CompileTokenMetadata, CompileTypeMetadata} from './compile_metadata';
|
|
import {isBlank, isPresent} from './facade/lang';
|
|
import {Identifiers, resolveIdentifierToken} from './identifiers';
|
|
import {ParseError, ParseSourceSpan} from './parse_util';
|
|
import {AttrAst, DirectiveAst, ProviderAst, ProviderAstType, ReferenceAst} from './template_parser/template_ast';
|
|
|
|
export class ProviderError extends ParseError {
|
|
constructor(message: string, span: ParseSourceSpan) { super(span, message); }
|
|
}
|
|
|
|
export class ProviderViewContext {
|
|
/**
|
|
* @internal
|
|
*/
|
|
viewQueries: Map<any, CompileQueryMetadata[]>;
|
|
/**
|
|
* @internal
|
|
*/
|
|
viewProviders: Map<any, boolean>;
|
|
errors: ProviderError[] = [];
|
|
|
|
constructor(public component: CompileDirectiveMetadata, public sourceSpan: ParseSourceSpan) {
|
|
this.viewQueries = _getViewQueries(component);
|
|
this.viewProviders = new Map<any, boolean>();
|
|
_normalizeProviders(component.viewProviders, sourceSpan, this.errors).forEach((provider) => {
|
|
if (isBlank(this.viewProviders.get(provider.token.reference))) {
|
|
this.viewProviders.set(provider.token.reference, true);
|
|
}
|
|
});
|
|
}
|
|
}
|
|
|
|
export class ProviderElementContext {
|
|
private _contentQueries: Map<any, CompileQueryMetadata[]>;
|
|
|
|
private _transformedProviders = new Map<any, ProviderAst>();
|
|
private _seenProviders = new Map<any, boolean>();
|
|
private _allProviders: Map<any, ProviderAst>;
|
|
private _attrs: {[key: string]: string};
|
|
private _hasViewContainer: boolean = false;
|
|
|
|
constructor(
|
|
public viewContext: ProviderViewContext, private _parent: ProviderElementContext,
|
|
private _isViewRoot: boolean, private _directiveAsts: DirectiveAst[], attrs: AttrAst[],
|
|
refs: ReferenceAst[], private _sourceSpan: ParseSourceSpan) {
|
|
this._attrs = {};
|
|
attrs.forEach((attrAst) => this._attrs[attrAst.name] = attrAst.value);
|
|
var directivesMeta = _directiveAsts.map(directiveAst => directiveAst.directive);
|
|
this._allProviders =
|
|
_resolveProvidersFromDirectives(directivesMeta, _sourceSpan, viewContext.errors);
|
|
this._contentQueries = _getContentQueries(directivesMeta);
|
|
var queriedTokens = new Map<any, boolean>();
|
|
Array.from(this._allProviders.values()).forEach((provider) => {
|
|
this._addQueryReadsTo(provider.token, queriedTokens);
|
|
});
|
|
refs.forEach((refAst) => {
|
|
this._addQueryReadsTo(new CompileTokenMetadata({value: refAst.name}), queriedTokens);
|
|
});
|
|
if (isPresent(
|
|
queriedTokens.get(resolveIdentifierToken(Identifiers.ViewContainerRef).reference))) {
|
|
this._hasViewContainer = true;
|
|
}
|
|
|
|
// create the providers that we know are eager first
|
|
Array.from(this._allProviders.values()).forEach((provider) => {
|
|
const eager = provider.eager || isPresent(queriedTokens.get(provider.token.reference));
|
|
if (eager) {
|
|
this._getOrCreateLocalProvider(provider.providerType, provider.token, true);
|
|
}
|
|
});
|
|
}
|
|
|
|
afterElement() {
|
|
// collect lazy providers
|
|
Array.from(this._allProviders.values()).forEach((provider) => {
|
|
this._getOrCreateLocalProvider(provider.providerType, provider.token, false);
|
|
});
|
|
}
|
|
|
|
get transformProviders(): ProviderAst[] {
|
|
return Array.from(this._transformedProviders.values());
|
|
}
|
|
|
|
get transformedDirectiveAsts(): DirectiveAst[] {
|
|
var sortedProviderTypes = this.transformProviders.map(provider => provider.token.identifier);
|
|
var sortedDirectives = this._directiveAsts.slice();
|
|
sortedDirectives.sort(
|
|
(dir1, dir2) => sortedProviderTypes.indexOf(dir1.directive.type) -
|
|
sortedProviderTypes.indexOf(dir2.directive.type));
|
|
return sortedDirectives;
|
|
}
|
|
|
|
get transformedHasViewContainer(): boolean { return this._hasViewContainer; }
|
|
|
|
private _addQueryReadsTo(token: CompileTokenMetadata, queryReadTokens: Map<any, boolean>) {
|
|
this._getQueriesFor(token).forEach((query) => {
|
|
const queryReadToken = query.read || token;
|
|
if (isBlank(queryReadTokens.get(queryReadToken.reference))) {
|
|
queryReadTokens.set(queryReadToken.reference, true);
|
|
}
|
|
});
|
|
}
|
|
|
|
private _getQueriesFor(token: CompileTokenMetadata): CompileQueryMetadata[] {
|
|
var result: CompileQueryMetadata[] = [];
|
|
var currentEl: ProviderElementContext = this;
|
|
var distance = 0;
|
|
var queries: CompileQueryMetadata[];
|
|
while (currentEl !== null) {
|
|
queries = currentEl._contentQueries.get(token.reference);
|
|
if (isPresent(queries)) {
|
|
result.push(...queries.filter((query) => query.descendants || distance <= 1));
|
|
}
|
|
if (currentEl._directiveAsts.length > 0) {
|
|
distance++;
|
|
}
|
|
currentEl = currentEl._parent;
|
|
}
|
|
queries = this.viewContext.viewQueries.get(token.reference);
|
|
if (isPresent(queries)) {
|
|
result.push(...queries);
|
|
}
|
|
return result;
|
|
}
|
|
|
|
|
|
private _getOrCreateLocalProvider(
|
|
requestingProviderType: ProviderAstType, token: CompileTokenMetadata,
|
|
eager: boolean): ProviderAst {
|
|
var resolvedProvider = this._allProviders.get(token.reference);
|
|
if (!resolvedProvider || ((requestingProviderType === ProviderAstType.Directive ||
|
|
requestingProviderType === ProviderAstType.PublicService) &&
|
|
resolvedProvider.providerType === ProviderAstType.PrivateService) ||
|
|
((requestingProviderType === ProviderAstType.PrivateService ||
|
|
requestingProviderType === ProviderAstType.PublicService) &&
|
|
resolvedProvider.providerType === ProviderAstType.Builtin)) {
|
|
return null;
|
|
}
|
|
var transformedProviderAst = this._transformedProviders.get(token.reference);
|
|
if (isPresent(transformedProviderAst)) {
|
|
return transformedProviderAst;
|
|
}
|
|
if (isPresent(this._seenProviders.get(token.reference))) {
|
|
this.viewContext.errors.push(new ProviderError(
|
|
`Cannot instantiate cyclic dependency! ${token.name}`, this._sourceSpan));
|
|
return null;
|
|
}
|
|
this._seenProviders.set(token.reference, true);
|
|
var transformedProviders = resolvedProvider.providers.map((provider) => {
|
|
var transformedUseValue = provider.useValue;
|
|
var transformedUseExisting = provider.useExisting;
|
|
var transformedDeps: CompileDiDependencyMetadata[];
|
|
if (isPresent(provider.useExisting)) {
|
|
var existingDiDep = this._getDependency(
|
|
resolvedProvider.providerType,
|
|
new CompileDiDependencyMetadata({token: provider.useExisting}), eager);
|
|
if (isPresent(existingDiDep.token)) {
|
|
transformedUseExisting = existingDiDep.token;
|
|
} else {
|
|
transformedUseExisting = null;
|
|
transformedUseValue = existingDiDep.value;
|
|
}
|
|
} else if (isPresent(provider.useFactory)) {
|
|
var deps = provider.deps || provider.useFactory.diDeps;
|
|
transformedDeps =
|
|
deps.map((dep) => this._getDependency(resolvedProvider.providerType, dep, eager));
|
|
} else if (isPresent(provider.useClass)) {
|
|
var deps = provider.deps || provider.useClass.diDeps;
|
|
transformedDeps =
|
|
deps.map((dep) => this._getDependency(resolvedProvider.providerType, dep, eager));
|
|
}
|
|
return _transformProvider(provider, {
|
|
useExisting: transformedUseExisting,
|
|
useValue: transformedUseValue,
|
|
deps: transformedDeps
|
|
});
|
|
});
|
|
transformedProviderAst =
|
|
_transformProviderAst(resolvedProvider, {eager: eager, providers: transformedProviders});
|
|
this._transformedProviders.set(token.reference, transformedProviderAst);
|
|
return transformedProviderAst;
|
|
}
|
|
|
|
private _getLocalDependency(
|
|
requestingProviderType: ProviderAstType, dep: CompileDiDependencyMetadata,
|
|
eager: boolean = null): CompileDiDependencyMetadata {
|
|
if (dep.isAttribute) {
|
|
var attrValue = this._attrs[dep.token.value];
|
|
return new CompileDiDependencyMetadata(
|
|
{isValue: true, value: attrValue == null ? null : attrValue});
|
|
}
|
|
|
|
if (isPresent(dep.token)) {
|
|
// access builtints
|
|
if ((requestingProviderType === ProviderAstType.Directive ||
|
|
requestingProviderType === ProviderAstType.Component)) {
|
|
if (dep.token.reference === resolveIdentifierToken(Identifiers.Renderer).reference ||
|
|
dep.token.reference === resolveIdentifierToken(Identifiers.ElementRef).reference ||
|
|
dep.token.reference ===
|
|
resolveIdentifierToken(Identifiers.ChangeDetectorRef).reference ||
|
|
dep.token.reference === resolveIdentifierToken(Identifiers.TemplateRef).reference) {
|
|
return dep;
|
|
}
|
|
if (dep.token.reference ===
|
|
resolveIdentifierToken(Identifiers.ViewContainerRef).reference) {
|
|
this._hasViewContainer = true;
|
|
}
|
|
}
|
|
// access the injector
|
|
if (dep.token.reference === resolveIdentifierToken(Identifiers.Injector).reference) {
|
|
return dep;
|
|
}
|
|
// access providers
|
|
if (isPresent(this._getOrCreateLocalProvider(requestingProviderType, dep.token, eager))) {
|
|
return dep;
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
private _getDependency(
|
|
requestingProviderType: ProviderAstType, dep: CompileDiDependencyMetadata,
|
|
eager: boolean = null): CompileDiDependencyMetadata {
|
|
var currElement: ProviderElementContext = this;
|
|
var currEager: boolean = eager;
|
|
var result: CompileDiDependencyMetadata = null;
|
|
if (!dep.isSkipSelf) {
|
|
result = this._getLocalDependency(requestingProviderType, dep, eager);
|
|
}
|
|
if (dep.isSelf) {
|
|
if (!result && dep.isOptional) {
|
|
result = new CompileDiDependencyMetadata({isValue: true, value: null});
|
|
}
|
|
} else {
|
|
// check parent elements
|
|
while (!result && isPresent(currElement._parent)) {
|
|
var prevElement = currElement;
|
|
currElement = currElement._parent;
|
|
if (prevElement._isViewRoot) {
|
|
currEager = false;
|
|
}
|
|
result = currElement._getLocalDependency(ProviderAstType.PublicService, dep, currEager);
|
|
}
|
|
// check @Host restriction
|
|
if (!result) {
|
|
if (!dep.isHost || this.viewContext.component.type.isHost ||
|
|
this.viewContext.component.type.reference === dep.token.reference ||
|
|
isPresent(this.viewContext.viewProviders.get(dep.token.reference))) {
|
|
result = dep;
|
|
} else {
|
|
result = dep.isOptional ?
|
|
result = new CompileDiDependencyMetadata({isValue: true, value: null}) :
|
|
null;
|
|
}
|
|
}
|
|
}
|
|
if (!result) {
|
|
this.viewContext.errors.push(
|
|
new ProviderError(`No provider for ${dep.token.name}`, this._sourceSpan));
|
|
}
|
|
return result;
|
|
}
|
|
}
|
|
|
|
|
|
export class NgModuleProviderAnalyzer {
|
|
private _transformedProviders = new Map<any, ProviderAst>();
|
|
private _seenProviders = new Map<any, boolean>();
|
|
private _allProviders: Map<any, ProviderAst>;
|
|
private _errors: ProviderError[] = [];
|
|
|
|
constructor(
|
|
ngModule: CompileNgModuleMetadata, extraProviders: CompileProviderMetadata[],
|
|
sourceSpan: ParseSourceSpan) {
|
|
this._allProviders = new Map<any, ProviderAst>();
|
|
const ngModuleTypes = ngModule.transitiveModule.modules.map((moduleMeta) => moduleMeta.type);
|
|
ngModuleTypes.forEach((ngModuleType: CompileTypeMetadata) => {
|
|
const ngModuleProvider = new CompileProviderMetadata(
|
|
{token: new CompileTokenMetadata({identifier: ngModuleType}), useClass: ngModuleType});
|
|
_resolveProviders(
|
|
[ngModuleProvider], ProviderAstType.PublicService, true, sourceSpan, this._errors,
|
|
this._allProviders);
|
|
});
|
|
_resolveProviders(
|
|
_normalizeProviders(
|
|
ngModule.transitiveModule.providers.concat(extraProviders), sourceSpan, this._errors),
|
|
ProviderAstType.PublicService, false, sourceSpan, this._errors, this._allProviders);
|
|
}
|
|
|
|
parse(): ProviderAst[] {
|
|
Array.from(this._allProviders.values()).forEach((provider) => {
|
|
this._getOrCreateLocalProvider(provider.token, provider.eager);
|
|
});
|
|
if (this._errors.length > 0) {
|
|
const errorString = this._errors.join('\n');
|
|
throw new Error(`Provider parse errors:\n${errorString}`);
|
|
}
|
|
return Array.from(this._transformedProviders.values());
|
|
}
|
|
|
|
private _getOrCreateLocalProvider(token: CompileTokenMetadata, eager: boolean): ProviderAst {
|
|
var resolvedProvider = this._allProviders.get(token.reference);
|
|
if (!resolvedProvider) {
|
|
return null;
|
|
}
|
|
var transformedProviderAst = this._transformedProviders.get(token.reference);
|
|
if (isPresent(transformedProviderAst)) {
|
|
return transformedProviderAst;
|
|
}
|
|
if (isPresent(this._seenProviders.get(token.reference))) {
|
|
this._errors.push(new ProviderError(
|
|
`Cannot instantiate cyclic dependency! ${token.name}`, resolvedProvider.sourceSpan));
|
|
return null;
|
|
}
|
|
this._seenProviders.set(token.reference, true);
|
|
var transformedProviders = resolvedProvider.providers.map((provider) => {
|
|
var transformedUseValue = provider.useValue;
|
|
var transformedUseExisting = provider.useExisting;
|
|
var transformedDeps: CompileDiDependencyMetadata[];
|
|
if (isPresent(provider.useExisting)) {
|
|
var existingDiDep = this._getDependency(
|
|
new CompileDiDependencyMetadata({token: provider.useExisting}), eager,
|
|
resolvedProvider.sourceSpan);
|
|
if (isPresent(existingDiDep.token)) {
|
|
transformedUseExisting = existingDiDep.token;
|
|
} else {
|
|
transformedUseExisting = null;
|
|
transformedUseValue = existingDiDep.value;
|
|
}
|
|
} else if (isPresent(provider.useFactory)) {
|
|
var deps = provider.deps || provider.useFactory.diDeps;
|
|
transformedDeps =
|
|
deps.map((dep) => this._getDependency(dep, eager, resolvedProvider.sourceSpan));
|
|
} else if (isPresent(provider.useClass)) {
|
|
var deps = provider.deps || provider.useClass.diDeps;
|
|
transformedDeps =
|
|
deps.map((dep) => this._getDependency(dep, eager, resolvedProvider.sourceSpan));
|
|
}
|
|
return _transformProvider(provider, {
|
|
useExisting: transformedUseExisting,
|
|
useValue: transformedUseValue,
|
|
deps: transformedDeps
|
|
});
|
|
});
|
|
transformedProviderAst =
|
|
_transformProviderAst(resolvedProvider, {eager: eager, providers: transformedProviders});
|
|
this._transformedProviders.set(token.reference, transformedProviderAst);
|
|
return transformedProviderAst;
|
|
}
|
|
|
|
private _getDependency(
|
|
dep: CompileDiDependencyMetadata, eager: boolean = null,
|
|
requestorSourceSpan: ParseSourceSpan): CompileDiDependencyMetadata {
|
|
var foundLocal = false;
|
|
if (!dep.isSkipSelf && isPresent(dep.token)) {
|
|
// access the injector
|
|
if (dep.token.reference === resolveIdentifierToken(Identifiers.Injector).reference ||
|
|
dep.token.reference ===
|
|
resolveIdentifierToken(Identifiers.ComponentFactoryResolver).reference) {
|
|
foundLocal = true;
|
|
// access providers
|
|
} else if (isPresent(this._getOrCreateLocalProvider(dep.token, eager))) {
|
|
foundLocal = true;
|
|
}
|
|
}
|
|
var result: CompileDiDependencyMetadata = dep;
|
|
if (dep.isSelf && !foundLocal) {
|
|
if (dep.isOptional) {
|
|
result = new CompileDiDependencyMetadata({isValue: true, value: null});
|
|
} else {
|
|
this._errors.push(
|
|
new ProviderError(`No provider for ${dep.token.name}`, requestorSourceSpan));
|
|
}
|
|
}
|
|
return result;
|
|
}
|
|
}
|
|
|
|
function _transformProvider(
|
|
provider: CompileProviderMetadata,
|
|
{useExisting, useValue, deps}:
|
|
{useExisting: CompileTokenMetadata, useValue: any, deps: CompileDiDependencyMetadata[]}) {
|
|
return new CompileProviderMetadata({
|
|
token: provider.token,
|
|
useClass: provider.useClass,
|
|
useExisting: useExisting,
|
|
useFactory: provider.useFactory,
|
|
useValue: useValue,
|
|
deps: deps,
|
|
multi: provider.multi
|
|
});
|
|
}
|
|
|
|
function _transformProviderAst(
|
|
provider: ProviderAst,
|
|
{eager, providers}: {eager: boolean, providers: CompileProviderMetadata[]}): ProviderAst {
|
|
return new ProviderAst(
|
|
provider.token, provider.multiProvider, provider.eager || eager, providers,
|
|
provider.providerType, provider.lifecycleHooks, provider.sourceSpan);
|
|
}
|
|
|
|
function _normalizeProviders(
|
|
providers: Array<CompileProviderMetadata|CompileTypeMetadata|any[]>,
|
|
sourceSpan: ParseSourceSpan, targetErrors: ParseError[],
|
|
targetProviders: CompileProviderMetadata[] = null): CompileProviderMetadata[] {
|
|
if (!targetProviders) {
|
|
targetProviders = [];
|
|
}
|
|
if (isPresent(providers)) {
|
|
providers.forEach((provider) => {
|
|
if (Array.isArray(provider)) {
|
|
_normalizeProviders(<any[]>provider, sourceSpan, targetErrors, targetProviders);
|
|
} else {
|
|
let normalizeProvider: CompileProviderMetadata;
|
|
if (provider instanceof CompileProviderMetadata) {
|
|
normalizeProvider = provider;
|
|
} else if (provider instanceof CompileTypeMetadata) {
|
|
normalizeProvider = new CompileProviderMetadata(
|
|
{token: new CompileTokenMetadata({identifier: provider}), useClass: provider});
|
|
} else {
|
|
targetErrors.push(new ProviderError(`Unknown provider type ${provider}`, sourceSpan));
|
|
}
|
|
if (isPresent(normalizeProvider)) {
|
|
targetProviders.push(normalizeProvider);
|
|
}
|
|
}
|
|
});
|
|
}
|
|
return targetProviders;
|
|
}
|
|
|
|
|
|
function _resolveProvidersFromDirectives(
|
|
directives: CompileDirectiveMetadata[], sourceSpan: ParseSourceSpan,
|
|
targetErrors: ParseError[]): Map<any, ProviderAst> {
|
|
var providersByToken = new Map<any, ProviderAst>();
|
|
directives.forEach((directive) => {
|
|
var dirProvider = new CompileProviderMetadata(
|
|
{token: new CompileTokenMetadata({identifier: directive.type}), useClass: directive.type});
|
|
_resolveProviders(
|
|
[dirProvider],
|
|
directive.isComponent ? ProviderAstType.Component : ProviderAstType.Directive, true,
|
|
sourceSpan, targetErrors, providersByToken);
|
|
});
|
|
|
|
// Note: directives need to be able to overwrite providers of a component!
|
|
var directivesWithComponentFirst =
|
|
directives.filter(dir => dir.isComponent).concat(directives.filter(dir => !dir.isComponent));
|
|
directivesWithComponentFirst.forEach((directive) => {
|
|
_resolveProviders(
|
|
_normalizeProviders(directive.providers, sourceSpan, targetErrors),
|
|
ProviderAstType.PublicService, false, sourceSpan, targetErrors, providersByToken);
|
|
_resolveProviders(
|
|
_normalizeProviders(directive.viewProviders, sourceSpan, targetErrors),
|
|
ProviderAstType.PrivateService, false, sourceSpan, targetErrors, providersByToken);
|
|
});
|
|
return providersByToken;
|
|
}
|
|
|
|
function _resolveProviders(
|
|
providers: CompileProviderMetadata[], providerType: ProviderAstType, eager: boolean,
|
|
sourceSpan: ParseSourceSpan, targetErrors: ParseError[],
|
|
targetProvidersByToken: Map<any, ProviderAst>) {
|
|
providers.forEach((provider) => {
|
|
var resolvedProvider = targetProvidersByToken.get(provider.token.reference);
|
|
if (isPresent(resolvedProvider) && resolvedProvider.multiProvider !== provider.multi) {
|
|
targetErrors.push(new ProviderError(
|
|
`Mixing multi and non multi provider is not possible for token ${resolvedProvider.token.name}`,
|
|
sourceSpan));
|
|
}
|
|
if (!resolvedProvider) {
|
|
const lifecycleHooks =
|
|
provider.token.identifier && provider.token.identifier instanceof CompileTypeMetadata ?
|
|
provider.token.identifier.lifecycleHooks :
|
|
[];
|
|
resolvedProvider = new ProviderAst(
|
|
provider.token, provider.multi, eager || lifecycleHooks.length > 0, [provider],
|
|
providerType, lifecycleHooks, sourceSpan);
|
|
targetProvidersByToken.set(provider.token.reference, resolvedProvider);
|
|
} else {
|
|
if (!provider.multi) {
|
|
resolvedProvider.providers.length = 0;
|
|
}
|
|
resolvedProvider.providers.push(provider);
|
|
}
|
|
});
|
|
}
|
|
|
|
|
|
function _getViewQueries(component: CompileDirectiveMetadata): Map<any, CompileQueryMetadata[]> {
|
|
var viewQueries = new Map<any, CompileQueryMetadata[]>();
|
|
if (isPresent(component.viewQueries)) {
|
|
component.viewQueries.forEach((query) => _addQueryToTokenMap(viewQueries, query));
|
|
}
|
|
return viewQueries;
|
|
}
|
|
|
|
function _getContentQueries(directives: CompileDirectiveMetadata[]):
|
|
Map<any, CompileQueryMetadata[]> {
|
|
var contentQueries = new Map<any, CompileQueryMetadata[]>();
|
|
directives.forEach(directive => {
|
|
if (isPresent(directive.queries)) {
|
|
directive.queries.forEach((query) => _addQueryToTokenMap(contentQueries, query));
|
|
}
|
|
});
|
|
return contentQueries;
|
|
}
|
|
|
|
function _addQueryToTokenMap(map: Map<any, CompileQueryMetadata[]>, query: CompileQueryMetadata) {
|
|
query.selectors.forEach((token: CompileTokenMetadata) => {
|
|
var entry = map.get(token.reference);
|
|
if (!entry) {
|
|
entry = [];
|
|
map.set(token.reference, entry);
|
|
}
|
|
entry.push(query);
|
|
});
|
|
}
|