31b9492951
A class that is provided as Angular service is required to have an `@Injectable()` decorator so that the compiler generates its injectable definition for the runtime. Applications are automatically migrated using the "missing-injectable" schematic, however libraries built for older version of Angular may not yet satisfy this requirement. This commit ports the "missing-injectable" schematic to a migration that is ran when ngcc is processing a library. This ensures that any service that is provided from an NgModule or Directive/Component will have an `@Injectable()` decorator. PR Close #33362
104 lines
3.9 KiB
TypeScript
104 lines
3.9 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 * as ts from 'typescript';
|
|
|
|
import {ErrorCode, FatalDiagnosticError} from '../../../src/ngtsc/diagnostics';
|
|
import {AbsoluteFsPath} from '../../../src/ngtsc/file_system';
|
|
import {MetadataReader} from '../../../src/ngtsc/metadata';
|
|
import {PartialEvaluator} from '../../../src/ngtsc/partial_evaluator';
|
|
import {ClassDeclaration, Decorator} from '../../../src/ngtsc/reflection';
|
|
import {DecoratorHandler} from '../../../src/ngtsc/transform';
|
|
import {NgccReflectionHost} from '../host/ngcc_host';
|
|
import {MigrationHost} from '../migrations/migration';
|
|
|
|
import {AnalyzedClass, AnalyzedFile} from './types';
|
|
import {analyzeDecorators, isWithinPackage} from './util';
|
|
|
|
/**
|
|
* The standard implementation of `MigrationHost`, which is created by the
|
|
* `DecorationAnalyzer`.
|
|
*/
|
|
export class DefaultMigrationHost implements MigrationHost {
|
|
constructor(
|
|
readonly reflectionHost: NgccReflectionHost, readonly metadata: MetadataReader,
|
|
readonly evaluator: PartialEvaluator, private handlers: DecoratorHandler<any, any>[],
|
|
private entryPointPath: AbsoluteFsPath, private analyzedFiles: AnalyzedFile[]) {}
|
|
|
|
injectSyntheticDecorator(clazz: ClassDeclaration, decorator: Decorator): void {
|
|
const classSymbol = this.reflectionHost.getClassSymbol(clazz) !;
|
|
const newAnalyzedClass = analyzeDecorators(classSymbol, [decorator], this.handlers);
|
|
if (newAnalyzedClass === null) {
|
|
return;
|
|
}
|
|
|
|
const analyzedFile = getOrCreateAnalyzedFile(this.analyzedFiles, clazz.getSourceFile());
|
|
const oldAnalyzedClass = analyzedFile.analyzedClasses.find(c => c.declaration === clazz);
|
|
if (oldAnalyzedClass === undefined) {
|
|
analyzedFile.analyzedClasses.push(newAnalyzedClass);
|
|
} else {
|
|
mergeAnalyzedClasses(oldAnalyzedClass, newAnalyzedClass);
|
|
}
|
|
}
|
|
|
|
getAllDecorators(clazz: ClassDeclaration): Decorator[]|null {
|
|
const sourceFile = clazz.getSourceFile();
|
|
const analyzedFile = this.analyzedFiles.find(file => file.sourceFile === sourceFile);
|
|
if (analyzedFile === undefined) {
|
|
return null;
|
|
}
|
|
|
|
const analyzedClass = analyzedFile.analyzedClasses.find(c => c.declaration === clazz);
|
|
if (analyzedClass === undefined) {
|
|
return null;
|
|
}
|
|
|
|
return analyzedClass.decorators;
|
|
}
|
|
|
|
isInScope(clazz: ClassDeclaration): boolean {
|
|
return isWithinPackage(this.entryPointPath, clazz.getSourceFile());
|
|
}
|
|
}
|
|
|
|
function getOrCreateAnalyzedFile(
|
|
analyzedFiles: AnalyzedFile[], sourceFile: ts.SourceFile): AnalyzedFile {
|
|
const analyzedFile = analyzedFiles.find(file => file.sourceFile === sourceFile);
|
|
if (analyzedFile !== undefined) {
|
|
return analyzedFile;
|
|
} else {
|
|
const newAnalyzedFile: AnalyzedFile = {sourceFile, analyzedClasses: []};
|
|
analyzedFiles.push(newAnalyzedFile);
|
|
return newAnalyzedFile;
|
|
}
|
|
}
|
|
|
|
function mergeAnalyzedClasses(oldClass: AnalyzedClass, newClass: AnalyzedClass) {
|
|
if (newClass.decorators !== null) {
|
|
if (oldClass.decorators === null) {
|
|
oldClass.decorators = newClass.decorators;
|
|
} else {
|
|
for (const newDecorator of newClass.decorators) {
|
|
if (oldClass.decorators.some(d => d.name === newDecorator.name)) {
|
|
throw new FatalDiagnosticError(
|
|
ErrorCode.NGCC_MIGRATION_DECORATOR_INJECTION_ERROR, newClass.declaration,
|
|
`Attempted to inject "${newDecorator.name}" decorator over a pre-existing decorator with the same name on the "${newClass.name}" class.`);
|
|
}
|
|
}
|
|
oldClass.decorators.push(...newClass.decorators);
|
|
}
|
|
}
|
|
|
|
if (newClass.diagnostics !== undefined) {
|
|
if (oldClass.diagnostics === undefined) {
|
|
oldClass.diagnostics = newClass.diagnostics;
|
|
} else {
|
|
oldClass.diagnostics.push(...newClass.diagnostics);
|
|
}
|
|
}
|
|
}
|