fix(compiler-cli): remove the concept of an errored trait (#39923)
Previously, if a trait's analysis step resulted in diagnostics, the trait would be considered "errored" and no further operations, including register, would be performed. Effectively, this meant that the compiler would pretend the class in question was actually undecorated. However, this behavior is problematic for several reasons: 1. It leads to inaccurate diagnostics being reported downstream. For example, if a component is put into the error state, for example due to a template error, the NgModule which declares the component would produce a diagnostic claiming that the declaration is neither a directive nor a pipe. This happened because the compiler wouldn't register() the component trait, so the component would not be recorded as actually being a directive. 2. It can cause incorrect behavior on incremental builds. This bug is more complex, but the general issue is that if the compiler fails to associate a component and its module, then incremental builds will not correctly re-analyze the module when the component's template changes. Failing to register the component as such is one link in the larger chain of issues that result in these kinds of issues. 3. It lumps together diagnostics produced during analysis and resolve steps. This is not causing issues currently as the dependency graph ensures the right classes are re-analyzed when needed, instead of showing stale diagnostics. However, the dependency graph was not intended to serve this role, and could potentially be optimized in ways that would break this functionality. This commit removes the concept of an "errored" trait entirely from the trait system. Instead, analyzed and resolved traits have corresponding (and separate) diagnostics, in addition to potentially `null` analysis results. Analysis (but not resolution) diagnostics are carried forward during incremental build operations. Compilation (emit) is only performed when a trait reaches the resolved state with no diagnostics. This change is functionally different than before as the `register` step is now performed even in the presence of analysis errors, as long as analysis results are also produced. This fixes problem 1 above, and is part of the larger solution to problem 2. PR Close #39923
This commit is contained in:
Alex Rickabaugh
Misko Hevery
parent
76ae87406f
commit
6d42954327
|
|
@ -32,9 +32,14 @@ export class DefaultMigrationHost implements MigrationHost {
|
|||
const migratedTraits = this.compiler.injectSyntheticDecorator(clazz, decorator, flags);
|
||||
|
||||
for (const trait of migratedTraits) {
|
||||
if (trait.state === TraitState.ERRORED) {
|
||||
trait.diagnostics =
|
||||
trait.diagnostics.map(diag => createMigrationDiagnostic(diag, clazz, decorator));
|
||||
if ((trait.state === TraitState.Analyzed || trait.state === TraitState.Resolved) &&
|
||||
trait.analysisDiagnostics !== null) {
|
||||
trait.analysisDiagnostics = trait.analysisDiagnostics.map(
|
||||
diag => createMigrationDiagnostic(diag, clazz, decorator));
|
||||
}
|
||||
if (trait.state === TraitState.Resolved && trait.resolveDiagnostics !== null) {
|
||||
trait.resolveDiagnostics =
|
||||
trait.resolveDiagnostics.map(diag => createMigrationDiagnostic(diag, clazz, decorator));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -79,7 +79,7 @@ runInEachFileSystem(() => {
|
|||
handler.analyze.and.callFake((decl: DeclarationNode, dec: Decorator) => {
|
||||
logs.push(`analyze: ${(decl as any).name.text}@${dec.name}`);
|
||||
return {
|
||||
analysis: {decoratorName: dec.name},
|
||||
analysis: !options.analyzeError ? {decoratorName: dec.name} : undefined,
|
||||
diagnostics: options.analyzeError ? [makeDiagnostic(9999, decl, 'analyze diagnostic')] :
|
||||
undefined
|
||||
};
|
||||
|
|
@ -407,7 +407,7 @@ runInEachFileSystem(() => {
|
|||
`,
|
||||
},
|
||||
],
|
||||
{analyzeError: true, resolveError: true});
|
||||
{analyzeError: true, resolveError: false});
|
||||
analyzer.analyzeProgram();
|
||||
expect(diagnosticLogs.length).toEqual(1);
|
||||
expect(diagnosticLogs[0]).toEqual(jasmine.objectContaining({code: -999999}));
|
||||
|
|
|
|||
|
|
@ -14,13 +14,14 @@ import {runInEachFileSystem} from '../../../src/ngtsc/file_system/testing';
|
|||
import {MockLogger} from '../../../src/ngtsc/logging/testing';
|
||||
import {ClassDeclaration, Decorator, isNamedClassDeclaration} from '../../../src/ngtsc/reflection';
|
||||
import {getDeclaration, loadTestFiles} from '../../../src/ngtsc/testing';
|
||||
import {AnalysisOutput, CompileResult, DecoratorHandler, DetectResult, HandlerPrecedence, TraitState} from '../../../src/ngtsc/transform';
|
||||
import {AnalysisOutput, CompileResult, DecoratorHandler, DetectResult, HandlerPrecedence} from '../../../src/ngtsc/transform';
|
||||
import {DefaultMigrationHost} from '../../src/analysis/migration_host';
|
||||
import {NgccTraitCompiler} from '../../src/analysis/ngcc_trait_compiler';
|
||||
import {Esm2015ReflectionHost} from '../../src/host/esm2015_host';
|
||||
import {createComponentDecorator} from '../../src/migrations/utils';
|
||||
import {EntryPointBundle} from '../../src/packages/entry_point_bundle';
|
||||
import {makeTestEntryPointBundle} from '../helpers/utils';
|
||||
import {getTraitDiagnostics} from '../host/util';
|
||||
|
||||
runInEachFileSystem(() => {
|
||||
describe('DefaultMigrationHost', () => {
|
||||
|
|
@ -78,12 +79,13 @@ runInEachFileSystem(() => {
|
|||
|
||||
const record = compiler.recordFor(mockClazz)!;
|
||||
const migratedTrait = record.traits[0];
|
||||
if (migratedTrait.state !== TraitState.ERRORED) {
|
||||
const diagnostics = getTraitDiagnostics(migratedTrait);
|
||||
if (diagnostics === null) {
|
||||
return fail('Expected migrated class trait to be in an error state');
|
||||
}
|
||||
|
||||
expect(migratedTrait.diagnostics.length).toBe(1);
|
||||
expect(ts.flattenDiagnosticMessageText(migratedTrait.diagnostics[0].messageText, '\n'))
|
||||
expect(diagnostics.length).toBe(1);
|
||||
expect(ts.flattenDiagnosticMessageText(diagnostics[0].messageText, '\n'))
|
||||
.toEqual(
|
||||
`test diagnostic\n` +
|
||||
` Occurs for @Component decorator inserted by an automatic migration\n` +
|
||||
|
|
|
|||
|
|
@ -18,6 +18,7 @@ import {Esm2015ReflectionHost} from '../../src/host/esm2015_host';
|
|||
import {createComponentDecorator} from '../../src/migrations/utils';
|
||||
import {EntryPointBundle} from '../../src/packages/entry_point_bundle';
|
||||
import {makeTestEntryPointBundle} from '../helpers/utils';
|
||||
import {getTraitDiagnostics} from '../host/util';
|
||||
|
||||
runInEachFileSystem(() => {
|
||||
describe('NgccTraitCompiler', () => {
|
||||
|
|
@ -233,12 +234,13 @@ runInEachFileSystem(() => {
|
|||
|
||||
const record = compiler.recordFor(mockClazz)!;
|
||||
const migratedTrait = record.traits[0];
|
||||
if (migratedTrait.state !== TraitState.ERRORED) {
|
||||
const diagnostics = getTraitDiagnostics(migratedTrait);
|
||||
if (diagnostics === null) {
|
||||
return fail('Expected migrated class trait to be in an error state');
|
||||
}
|
||||
|
||||
expect(migratedTrait.diagnostics.length).toBe(1);
|
||||
expect(migratedTrait.diagnostics[0].messageText).toEqual(`test diagnostic`);
|
||||
expect(diagnostics.length).toBe(1);
|
||||
expect(diagnostics[0].messageText).toEqual(`test diagnostic`);
|
||||
});
|
||||
});
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
* 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 {Trait, TraitState} from '@angular/compiler-cli/src/ngtsc/transform';
|
||||
import * as ts from 'typescript';
|
||||
import {CtorParameter, TypeValueReferenceKind} from '../../../src/ngtsc/reflection';
|
||||
|
||||
|
|
@ -48,3 +49,17 @@ export function expectTypeValueReferencesForParameters(
|
|||
}
|
||||
});
|
||||
}
|
||||
|
||||
export function getTraitDiagnostics(trait: Trait<unknown, unknown, unknown>): ts.Diagnostic[]|null {
|
||||
if (trait.state === TraitState.Analyzed) {
|
||||
return trait.analysisDiagnostics;
|
||||
} else if (trait.state === TraitState.Resolved) {
|
||||
const diags = [
|
||||
...(trait.analysisDiagnostics ?? []),
|
||||
...(trait.resolveDiagnostics ?? []),
|
||||
];
|
||||
return diags.length > 0 ? diags : null;
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -10,5 +10,5 @@ export * from './src/api';
|
|||
export {aliasTransformFactory} from './src/alias';
|
||||
export {ClassRecord, TraitCompiler} from './src/compilation';
|
||||
export {declarationTransformFactory, DtsTransformRegistry, IvyDeclarationDtsTransform, ReturnTypeTransform} from './src/declaration';
|
||||
export {AnalyzedTrait, ErroredTrait, PendingTrait, ResolvedTrait, SkippedTrait, Trait, TraitState} from './src/trait';
|
||||
export {AnalyzedTrait, PendingTrait, ResolvedTrait, SkippedTrait, Trait, TraitState} from './src/trait';
|
||||
export {ivyTransformFactory} from './src/transform';
|
||||
|
|
|
|||
|
|
@ -181,15 +181,13 @@ export class TraitCompiler implements ProgramTypeCheckAdapter {
|
|||
const handler = this.handlersByName.get(priorTrait.handler.name)!;
|
||||
let trait: Trait<unknown, unknown, unknown> = Trait.pending(handler, priorTrait.detected);
|
||||
|
||||
if (priorTrait.state === TraitState.ANALYZED || priorTrait.state === TraitState.RESOLVED) {
|
||||
trait = trait.toAnalyzed(priorTrait.analysis);
|
||||
if (trait.handler.register !== undefined) {
|
||||
if (priorTrait.state === TraitState.Analyzed || priorTrait.state === TraitState.Resolved) {
|
||||
trait = trait.toAnalyzed(priorTrait.analysis, priorTrait.analysisDiagnostics);
|
||||
if (trait.analysis !== null && trait.handler.register !== undefined) {
|
||||
trait.handler.register(record.node, trait.analysis);
|
||||
}
|
||||
} else if (priorTrait.state === TraitState.SKIPPED) {
|
||||
} else if (priorTrait.state === TraitState.Skipped) {
|
||||
trait = trait.toSkipped();
|
||||
} else if (priorTrait.state === TraitState.ERRORED) {
|
||||
trait = trait.toErrored(priorTrait.diagnostics);
|
||||
}
|
||||
|
||||
record.traits.push(trait);
|
||||
|
|
@ -314,7 +312,7 @@ export class TraitCompiler implements ProgramTypeCheckAdapter {
|
|||
preanalysis = trait.handler.preanalyze(clazz, trait.detected.metadata) || null;
|
||||
} catch (err) {
|
||||
if (err instanceof FatalDiagnosticError) {
|
||||
trait.toErrored([err.toDiagnostic()]);
|
||||
trait.toAnalyzed(null, [err.toDiagnostic()]);
|
||||
return;
|
||||
} else {
|
||||
throw err;
|
||||
|
|
@ -332,7 +330,7 @@ export class TraitCompiler implements ProgramTypeCheckAdapter {
|
|||
protected analyzeTrait(
|
||||
clazz: ClassDeclaration, trait: Trait<unknown, unknown, unknown>,
|
||||
flags?: HandlerFlags): void {
|
||||
if (trait.state !== TraitState.PENDING) {
|
||||
if (trait.state !== TraitState.Pending) {
|
||||
throw new Error(`Attempt to analyze trait of ${clazz.name.text} in state ${
|
||||
TraitState[trait.state]} (expected DETECTED)`);
|
||||
}
|
||||
|
|
@ -343,26 +341,18 @@ export class TraitCompiler implements ProgramTypeCheckAdapter {
|
|||
result = trait.handler.analyze(clazz, trait.detected.metadata, flags);
|
||||
} catch (err) {
|
||||
if (err instanceof FatalDiagnosticError) {
|
||||
trait = trait.toErrored([err.toDiagnostic()]);
|
||||
trait.toAnalyzed(null, [err.toDiagnostic()]);
|
||||
return;
|
||||
} else {
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
if (result.diagnostics !== undefined) {
|
||||
trait = trait.toErrored(result.diagnostics);
|
||||
} else if (result.analysis !== undefined) {
|
||||
// Analysis was successful. Trigger registration.
|
||||
if (trait.handler.register !== undefined) {
|
||||
if (result.analysis !== undefined && trait.handler.register !== undefined) {
|
||||
trait.handler.register(clazz, result.analysis);
|
||||
}
|
||||
|
||||
// Successfully analyzed and registered.
|
||||
trait = trait.toAnalyzed(result.analysis);
|
||||
} else {
|
||||
trait = trait.toSkipped();
|
||||
}
|
||||
trait = trait.toAnalyzed(result.analysis ?? null, result.diagnostics ?? null);
|
||||
}
|
||||
|
||||
resolve(): void {
|
||||
|
|
@ -372,19 +362,23 @@ export class TraitCompiler implements ProgramTypeCheckAdapter {
|
|||
for (let trait of record.traits) {
|
||||
const handler = trait.handler;
|
||||
switch (trait.state) {
|
||||
case TraitState.SKIPPED:
|
||||
case TraitState.ERRORED:
|
||||
case TraitState.Skipped:
|
||||
continue;
|
||||
case TraitState.PENDING:
|
||||
case TraitState.Pending:
|
||||
throw new Error(`Resolving a trait that hasn't been analyzed: ${clazz.name.text} / ${
|
||||
Object.getPrototypeOf(trait.handler).constructor.name}`);
|
||||
case TraitState.RESOLVED:
|
||||
case TraitState.Resolved:
|
||||
throw new Error(`Resolving an already resolved trait`);
|
||||
}
|
||||
|
||||
if (trait.analysis === null) {
|
||||
// No analysis results, cannot further process this trait.
|
||||
continue;
|
||||
}
|
||||
|
||||
if (handler.resolve === undefined) {
|
||||
// No resolution of this trait needed - it's considered successful by default.
|
||||
trait = trait.toResolved(null);
|
||||
trait = trait.toResolved(null, null);
|
||||
continue;
|
||||
}
|
||||
|
||||
|
|
@ -393,22 +387,14 @@ export class TraitCompiler implements ProgramTypeCheckAdapter {
|
|||
result = handler.resolve(clazz, trait.analysis as Readonly<unknown>);
|
||||
} catch (err) {
|
||||
if (err instanceof FatalDiagnosticError) {
|
||||
trait = trait.toErrored([err.toDiagnostic()]);
|
||||
trait = trait.toResolved(null, [err.toDiagnostic()]);
|
||||
continue;
|
||||
} else {
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
if (result.diagnostics !== undefined && result.diagnostics.length > 0) {
|
||||
trait = trait.toErrored(result.diagnostics);
|
||||
} else {
|
||||
if (result.data !== undefined) {
|
||||
trait = trait.toResolved(result.data);
|
||||
} else {
|
||||
trait = trait.toResolved(null);
|
||||
}
|
||||
}
|
||||
trait = trait.toResolved(result.data ?? null, result.diagnostics ?? null);
|
||||
|
||||
if (result.reexports !== undefined) {
|
||||
const fileName = clazz.getSourceFile().fileName;
|
||||
|
|
@ -436,21 +422,23 @@ export class TraitCompiler implements ProgramTypeCheckAdapter {
|
|||
for (const clazz of this.fileToClasses.get(sf)!) {
|
||||
const record = this.classes.get(clazz)!;
|
||||
for (const trait of record.traits) {
|
||||
if (trait.state !== TraitState.RESOLVED) {
|
||||
if (trait.state !== TraitState.Resolved) {
|
||||
continue;
|
||||
} else if (trait.handler.typeCheck === undefined) {
|
||||
continue;
|
||||
}
|
||||
if (trait.resolution !== null) {
|
||||
trait.handler.typeCheck(ctx, clazz, trait.analysis, trait.resolution);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
index(ctx: IndexingContext): void {
|
||||
for (const clazz of this.classes.keys()) {
|
||||
const record = this.classes.get(clazz)!;
|
||||
for (const trait of record.traits) {
|
||||
if (trait.state !== TraitState.RESOLVED) {
|
||||
if (trait.state !== TraitState.Resolved) {
|
||||
// Skip traits that haven't been resolved successfully.
|
||||
continue;
|
||||
} else if (trait.handler.index === undefined) {
|
||||
|
|
@ -458,10 +446,12 @@ export class TraitCompiler implements ProgramTypeCheckAdapter {
|
|||
continue;
|
||||
}
|
||||
|
||||
if (trait.resolution !== null) {
|
||||
trait.handler.index(ctx, clazz, trait.analysis, trait.resolution);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
compile(clazz: DeclarationNode, constantPool: ConstantPool): CompileResult[]|null {
|
||||
const original = ts.getOriginalNode(clazz) as typeof clazz;
|
||||
|
|
@ -475,19 +465,26 @@ export class TraitCompiler implements ProgramTypeCheckAdapter {
|
|||
let res: CompileResult[] = [];
|
||||
|
||||
for (const trait of record.traits) {
|
||||
if (trait.state !== TraitState.RESOLVED) {
|
||||
if (trait.state !== TraitState.Resolved || trait.analysisDiagnostics !== null ||
|
||||
trait.resolveDiagnostics !== null) {
|
||||
// Cannot compile a trait that is not resolved, or had any errors in its declaration.
|
||||
continue;
|
||||
}
|
||||
|
||||
const compileSpan = this.perf.start('compileClass', original);
|
||||
|
||||
|
||||
// `trait.resolution` is non-null asserted here because TypeScript does not recognize that
|
||||
// `Readonly<unknown>` is nullable (as `unknown` itself is nullable) due to the way that
|
||||
// `Readonly` works.
|
||||
|
||||
let compileRes: CompileResult|CompileResult[];
|
||||
if (this.compilationMode === CompilationMode.PARTIAL &&
|
||||
trait.handler.compilePartial !== undefined) {
|
||||
compileRes = trait.handler.compilePartial(clazz, trait.analysis, trait.resolution);
|
||||
compileRes = trait.handler.compilePartial(clazz, trait.analysis, trait.resolution!);
|
||||
} else {
|
||||
compileRes =
|
||||
trait.handler.compileFull(clazz, trait.analysis, trait.resolution, constantPool);
|
||||
trait.handler.compileFull(clazz, trait.analysis, trait.resolution!, constantPool);
|
||||
}
|
||||
|
||||
const compileMatchRes = compileRes;
|
||||
|
|
@ -522,7 +519,7 @@ export class TraitCompiler implements ProgramTypeCheckAdapter {
|
|||
const decorators: ts.Decorator[] = [];
|
||||
|
||||
for (const trait of record.traits) {
|
||||
if (trait.state !== TraitState.RESOLVED) {
|
||||
if (trait.state !== TraitState.Resolved) {
|
||||
continue;
|
||||
}
|
||||
|
||||
|
|
@ -542,8 +539,12 @@ export class TraitCompiler implements ProgramTypeCheckAdapter {
|
|||
diagnostics.push(...record.metaDiagnostics);
|
||||
}
|
||||
for (const trait of record.traits) {
|
||||
if (trait.state === TraitState.ERRORED) {
|
||||
diagnostics.push(...trait.diagnostics);
|
||||
if ((trait.state === TraitState.Analyzed || trait.state === TraitState.Resolved) &&
|
||||
trait.analysisDiagnostics !== null) {
|
||||
diagnostics.push(...trait.analysisDiagnostics);
|
||||
}
|
||||
if (trait.state === TraitState.Resolved && trait.resolveDiagnostics !== null) {
|
||||
diagnostics.push(...trait.resolveDiagnostics);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -13,28 +13,22 @@ export enum TraitState {
|
|||
/**
|
||||
* Pending traits are freshly created and have never been analyzed.
|
||||
*/
|
||||
PENDING = 0x01,
|
||||
Pending,
|
||||
|
||||
/**
|
||||
* Analyzed traits have successfully been analyzed, but are pending resolution.
|
||||
*/
|
||||
ANALYZED = 0x02,
|
||||
Analyzed,
|
||||
|
||||
/**
|
||||
* Resolved traits have successfully been analyzed and resolved and are ready for compilation.
|
||||
*/
|
||||
RESOLVED = 0x04,
|
||||
|
||||
/**
|
||||
* Errored traits have failed either analysis or resolution and as a result contain diagnostics
|
||||
* describing the failure(s).
|
||||
*/
|
||||
ERRORED = 0x08,
|
||||
Resolved,
|
||||
|
||||
/**
|
||||
* Skipped traits are no longer considered for compilation.
|
||||
*/
|
||||
SKIPPED = 0x10,
|
||||
Skipped,
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -50,8 +44,8 @@ export enum TraitState {
|
|||
* This not only simplifies the implementation, but ensures traits are monomorphic objects as
|
||||
* they're all just "views" in the type system of the same object (which never changes shape).
|
||||
*/
|
||||
export type Trait<D, A, R> = PendingTrait<D, A, R>|SkippedTrait<D, A, R>|AnalyzedTrait<D, A, R>|
|
||||
ResolvedTrait<D, A, R>|ErroredTrait<D, A, R>;
|
||||
export type Trait<D, A, R> =
|
||||
PendingTrait<D, A, R>|SkippedTrait<D, A, R>|AnalyzedTrait<D, A, R>|ResolvedTrait<D, A, R>;
|
||||
|
||||
/**
|
||||
* The value side of `Trait` exposes a helper to create a `Trait` in a pending state (by delegating
|
||||
|
|
@ -93,19 +87,13 @@ export interface TraitBase<D, A, R> {
|
|||
* Pending traits have yet to be analyzed in any way.
|
||||
*/
|
||||
export interface PendingTrait<D, A, R> extends TraitBase<D, A, R> {
|
||||
state: TraitState.PENDING;
|
||||
state: TraitState.Pending;
|
||||
|
||||
/**
|
||||
* This pending trait has been successfully analyzed, and should transition to the "analyzed"
|
||||
* state.
|
||||
*/
|
||||
toAnalyzed(analysis: A): AnalyzedTrait<D, A, R>;
|
||||
|
||||
/**
|
||||
* This trait failed analysis, and should transition to the "errored" state with the resulting
|
||||
* diagnostics.
|
||||
*/
|
||||
toErrored(errors: ts.Diagnostic[]): ErroredTrait<D, A, R>;
|
||||
toAnalyzed(analysis: A|null, diagnostics: ts.Diagnostic[]|null): AnalyzedTrait<D, A, R>;
|
||||
|
||||
/**
|
||||
* During analysis it was determined that this trait is not eligible for compilation after all,
|
||||
|
|
@ -114,22 +102,6 @@ export interface PendingTrait<D, A, R> extends TraitBase<D, A, R> {
|
|||
toSkipped(): SkippedTrait<D, A, R>;
|
||||
}
|
||||
|
||||
/**
|
||||
* A trait in the "errored" state.
|
||||
*
|
||||
* Errored traits contain `ts.Diagnostic`s indicating any problem(s) with the class.
|
||||
*
|
||||
* This is a terminal state.
|
||||
*/
|
||||
export interface ErroredTrait<D, A, R> extends TraitBase<D, A, R> {
|
||||
state: TraitState.ERRORED;
|
||||
|
||||
/**
|
||||
* Diagnostics which were produced while attempting to analyze the trait.
|
||||
*/
|
||||
diagnostics: ts.Diagnostic[];
|
||||
}
|
||||
|
||||
/**
|
||||
* A trait in the "skipped" state.
|
||||
*
|
||||
|
|
@ -138,20 +110,7 @@ export interface ErroredTrait<D, A, R> extends TraitBase<D, A, R> {
|
|||
* This is a terminal state.
|
||||
*/
|
||||
export interface SkippedTrait<D, A, R> extends TraitBase<D, A, R> {
|
||||
state: TraitState.SKIPPED;
|
||||
}
|
||||
|
||||
/**
|
||||
* The part of the `Trait` interface for any trait which has been successfully analyzed.
|
||||
*
|
||||
* Mainly, this is used to share the comment on the `analysis` field.
|
||||
*/
|
||||
export interface TraitWithAnalysis<A> {
|
||||
/**
|
||||
* The results returned by a successful analysis of the given class/`DecoratorHandler`
|
||||
* combination.
|
||||
*/
|
||||
analysis: Readonly<A>;
|
||||
state: TraitState.Skipped;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -159,20 +118,25 @@ export interface TraitWithAnalysis<A> {
|
|||
*
|
||||
* Analyzed traits have analysis results available, and are eligible for resolution.
|
||||
*/
|
||||
export interface AnalyzedTrait<D, A, R> extends TraitBase<D, A, R>, TraitWithAnalysis<A> {
|
||||
state: TraitState.ANALYZED;
|
||||
export interface AnalyzedTrait<D, A, R> extends TraitBase<D, A, R> {
|
||||
state: TraitState.Analyzed;
|
||||
|
||||
/**
|
||||
* Analysis results of the given trait (if able to be produced), or `null` if analysis failed
|
||||
* completely.
|
||||
*/
|
||||
analysis: Readonly<A>|null;
|
||||
|
||||
/**
|
||||
* Any diagnostics that resulted from analysis, or `null` if none.
|
||||
*/
|
||||
analysisDiagnostics: ts.Diagnostic[]|null;
|
||||
|
||||
/**
|
||||
* This analyzed trait has been successfully resolved, and should be transitioned to the
|
||||
* "resolved" state.
|
||||
*/
|
||||
toResolved(resolution: R): ResolvedTrait<D, A, R>;
|
||||
|
||||
/**
|
||||
* This trait failed resolution, and should transition to the "errored" state with the resulting
|
||||
* diagnostics.
|
||||
*/
|
||||
toErrored(errors: ts.Diagnostic[]): ErroredTrait<D, A, R>;
|
||||
toResolved(resolution: R|null, diagnostics: ts.Diagnostic[]|null): ResolvedTrait<D, A, R>;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -183,14 +147,29 @@ export interface AnalyzedTrait<D, A, R> extends TraitBase<D, A, R>, TraitWithAna
|
|||
*
|
||||
* This is a terminal state.
|
||||
*/
|
||||
export interface ResolvedTrait<D, A, R> extends TraitBase<D, A, R>, TraitWithAnalysis<A> {
|
||||
state: TraitState.RESOLVED;
|
||||
export interface ResolvedTrait<D, A, R> extends TraitBase<D, A, R> {
|
||||
state: TraitState.Resolved;
|
||||
|
||||
/**
|
||||
* Resolved traits must have produced valid analysis results.
|
||||
*/
|
||||
analysis: Readonly<A>;
|
||||
|
||||
/**
|
||||
* Analysis may have still resulted in diagnostics.
|
||||
*/
|
||||
analysisDiagnostics: ts.Diagnostic[]|null;
|
||||
|
||||
/**
|
||||
* Diagnostics resulting from resolution are tracked separately from
|
||||
*/
|
||||
resolveDiagnostics: ts.Diagnostic[]|null;
|
||||
|
||||
/**
|
||||
* The results returned by a successful resolution of the given class/`DecoratorHandler`
|
||||
* combination.
|
||||
*/
|
||||
resolution: Readonly<R>;
|
||||
resolution: Readonly<R>|null;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -198,48 +177,44 @@ export interface ResolvedTrait<D, A, R> extends TraitBase<D, A, R>, TraitWithAna
|
|||
* `TraitState`s.
|
||||
*/
|
||||
class TraitImpl<D, A, R> {
|
||||
state: TraitState = TraitState.PENDING;
|
||||
state: TraitState = TraitState.Pending;
|
||||
handler: DecoratorHandler<D, A, R>;
|
||||
detected: DetectResult<D>;
|
||||
analysis: Readonly<A>|null = null;
|
||||
resolution: Readonly<R>|null = null;
|
||||
diagnostics: ts.Diagnostic[]|null = null;
|
||||
analysisDiagnostics: ts.Diagnostic[]|null = null;
|
||||
resolveDiagnostics: ts.Diagnostic[]|null = null;
|
||||
|
||||
constructor(handler: DecoratorHandler<D, A, R>, detected: DetectResult<D>) {
|
||||
this.handler = handler;
|
||||
this.detected = detected;
|
||||
}
|
||||
|
||||
toAnalyzed(analysis: A): AnalyzedTrait<D, A, R> {
|
||||
toAnalyzed(analysis: A|null, diagnostics: ts.Diagnostic[]|null): AnalyzedTrait<D, A, R> {
|
||||
// Only pending traits can be analyzed.
|
||||
this.assertTransitionLegal(TraitState.PENDING, TraitState.ANALYZED);
|
||||
this.assertTransitionLegal(TraitState.Pending, TraitState.Analyzed);
|
||||
this.analysis = analysis;
|
||||
this.state = TraitState.ANALYZED;
|
||||
this.analysisDiagnostics = diagnostics;
|
||||
this.state = TraitState.Analyzed;
|
||||
return this as AnalyzedTrait<D, A, R>;
|
||||
}
|
||||
|
||||
toErrored(diagnostics: ts.Diagnostic[]): ErroredTrait<D, A, R> {
|
||||
// Pending traits (during analysis) or analyzed traits (during resolution) can produce
|
||||
// diagnostics and enter an errored state.
|
||||
this.assertTransitionLegal(TraitState.PENDING | TraitState.ANALYZED, TraitState.RESOLVED);
|
||||
this.diagnostics = diagnostics;
|
||||
this.analysis = null;
|
||||
this.state = TraitState.ERRORED;
|
||||
return this as ErroredTrait<D, A, R>;
|
||||
}
|
||||
|
||||
toResolved(resolution: R): ResolvedTrait<D, A, R> {
|
||||
toResolved(resolution: R|null, diagnostics: ts.Diagnostic[]|null): ResolvedTrait<D, A, R> {
|
||||
// Only analyzed traits can be resolved.
|
||||
this.assertTransitionLegal(TraitState.ANALYZED, TraitState.RESOLVED);
|
||||
this.assertTransitionLegal(TraitState.Analyzed, TraitState.Resolved);
|
||||
if (this.analysis === null) {
|
||||
throw new Error(`Cannot transition an Analyzed trait with a null analysis to Resolved`);
|
||||
}
|
||||
this.resolution = resolution;
|
||||
this.state = TraitState.RESOLVED;
|
||||
this.state = TraitState.Resolved;
|
||||
this.resolveDiagnostics = diagnostics;
|
||||
return this as ResolvedTrait<D, A, R>;
|
||||
}
|
||||
|
||||
toSkipped(): SkippedTrait<D, A, R> {
|
||||
// Only pending traits can be skipped.
|
||||
this.assertTransitionLegal(TraitState.PENDING, TraitState.SKIPPED);
|
||||
this.state = TraitState.SKIPPED;
|
||||
this.assertTransitionLegal(TraitState.Pending, TraitState.Skipped);
|
||||
this.state = TraitState.Skipped;
|
||||
return this as SkippedTrait<D, A, R>;
|
||||
}
|
||||
|
||||
|
|
@ -252,7 +227,7 @@ class TraitImpl<D, A, R> {
|
|||
* transitions to take place. Hence, this assertion provides a little extra runtime protection.
|
||||
*/
|
||||
private assertTransitionLegal(allowedState: TraitState, transitionTo: TraitState): void {
|
||||
if (!(this.state & allowedState)) {
|
||||
if (!(this.state === allowedState)) {
|
||||
throw new Error(`Assertion failure: cannot transition from ${TraitState[this.state]} to ${
|
||||
TraitState[transitionTo]}.`);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -364,6 +364,30 @@ runInEachFileSystem(os => {
|
|||
expect(jsContents).toContain('Hello World');
|
||||
});
|
||||
|
||||
it('should not report that broken components in modules are not components', () => {
|
||||
env.write('test.ts', `
|
||||
import {Component, NgModule} from '@angular/core';
|
||||
|
||||
@Component({
|
||||
selector: 'broken-cmp',
|
||||
template: '{{ broken = "true" }}', // assignment not legal in this context
|
||||
})
|
||||
export class BrokenCmp {}
|
||||
|
||||
@NgModule({
|
||||
declarations: [BrokenCmp],
|
||||
})
|
||||
export class Module {
|
||||
broken = "false";
|
||||
}
|
||||
`);
|
||||
|
||||
const diags = env.driveDiagnostics();
|
||||
if (diags.some(diag => diag.code === ngErrorCode(ErrorCode.NGMODULE_INVALID_DECLARATION))) {
|
||||
fail('Should not produce a diagnostic that BrokenCmp is not a component');
|
||||
}
|
||||
});
|
||||
|
||||
// This test triggers the Tsickle compiler which asserts that the file-paths
|
||||
// are valid for the real OS. When on non-Windows systems it doesn't like paths
|
||||
// that start with `C:`.
|
||||
|
|
|
|||
Loading…
Reference in New Issue