ngcc: re-export private NgModule declarations #26906
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| /** | ||
| * @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 {ReferencesRegistry} from '../../../ngtsc/annotations'; | ||
| import {Declaration, ReflectionHost} from '../../../ngtsc/host'; | ||
| import {Reference, ResolvedReference} from '../../../ngtsc/metadata'; | ||
| import {hasNameIdentifier} from '../utils'; | ||
|
|
||
| /** | ||
| * This is a place for DecoratorHandlers to register references that they | ||
| * find in their analysis of the code. | ||
| * | ||
| * This registry is used to ensure that these references are publicly exported | ||
| * from libraries that are compiled by ngcc. | ||
| */ | ||
| export class NgccReferencesRegistry implements ReferencesRegistry { | ||
| private map = new Map<ts.Identifier, Declaration>(); | ||
|
|
||
| constructor(private host: ReflectionHost) {} | ||
|
|
||
| /** | ||
| * Register one or more references in the registry. | ||
| * Only `ResolveReference` references are stored. Other types are ignored. | ||
| * @param references A collection of references to register. | ||
| */ | ||
| add(...references: Reference<ts.Declaration>[]): void { | ||
| references.forEach(ref => { | ||
| // Only store resolved references. We are not interested in literals. | ||
| if (ref instanceof ResolvedReference && hasNameIdentifier(ref.node)) { | ||
| const declaration = this.host.getDeclarationOfIdentifier(ref.node.name); | ||
| if (declaration && hasNameIdentifier(declaration.node)) { | ||
| this.map.set(declaration.node.name, declaration); | ||
| } | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Create and return a mapping for the registered resolved references. | ||
| * @returns A map of reference identifiers to reference declarations. | ||
| */ | ||
| getDeclarationMap(): Map<ts.Identifier, Declaration> { return this.map; } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /** | ||
| * @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 {ReferencesRegistry} from '../../../ngtsc/annotations'; | ||
| import {Declaration} from '../../../ngtsc/host'; | ||
| import {NgccReflectionHost} from '../host/ngcc_host'; | ||
| import {hasNameIdentifier, isDefined} from '../utils'; | ||
|
|
||
| export interface ExportInfo { | ||
| identifier: string; | ||
| from: string; | ||
| dtsFrom: string|null; | ||
| } | ||
| export type PrivateDeclarationsAnalyses = ExportInfo[]; | ||
|
|
||
| /** | ||
| * This class will analyze a program to find all the declared classes | ||
| * (i.e. on an NgModule) that are not publicly exported via an entry-point. | ||
| */ | ||
| export class PrivateDeclarationsAnalyzer { | ||
| constructor(private host: NgccReflectionHost, private referencesRegistry: ReferencesRegistry) {} | ||
|
|
||
| analyzeProgram(program: ts.Program): PrivateDeclarationsAnalyses { | ||
| const rootFiles = this.getRootFiles(program); | ||
| return this.getPrivateDeclarations(rootFiles, this.referencesRegistry.getDeclarationMap()); | ||
| } | ||
|
|
||
| private getRootFiles(program: ts.Program): ts.SourceFile[] { | ||
| return program.getRootFileNames().map(f => program.getSourceFile(f)).filter(isDefined); | ||
| } | ||
|
|
||
| private getPrivateDeclarations( | ||
| rootFiles: ts.SourceFile[], | ||
| declarations: Map<ts.Identifier, Declaration>): PrivateDeclarationsAnalyses { | ||
| const privateDeclarations: Map<ts.Identifier, Declaration> = new Map(declarations); | ||
| rootFiles.forEach(f => { | ||
| const exports = this.host.getExportsOfModule(f); | ||
| if (exports) { | ||
| exports.forEach((declaration, exportedName) => { | ||
| if (hasNameIdentifier(declaration.node) && declaration.node.name.text === exportedName) { | ||
| privateDeclarations.delete(declaration.node.name); | ||
| } | ||
| }); | ||
| } | ||
| }); | ||
| return Array.from(privateDeclarations.keys()).map(id => { | ||
| const from = id.getSourceFile().fileName; | ||
| const declaration = privateDeclarations.get(id) !; | ||
| const dtsDeclaration = this.host.getDtsDeclarationOfClass(declaration.node); | ||
| const dtsFrom = dtsDeclaration && dtsDeclaration.getSourceFile().fileName; | ||
| return {identifier: id.text, from, dtsFrom}; | ||
| }); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, being less strict here resolves an issue for me as well 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great! I think I am done with refactoring this. Ready for a proper review.