cargdev/angular
1
0
Fork 0
Code Issues 18 Pull Requests Actions Packages Projects Releases Wiki Activity

fix(ngcc): do not scan import expressions in d.ts files (#37503)

Browse Source 
It is quite common for the TS compiler to have to add synthetic
types to function signatures, where the developer has not
explicitly provided them.  This results in `import(...)` expressions
appearing in typings files.  For example in `@ngrx/data` there is a
class with a getter that has an implicit type:

```ts
export declare class EntityCollectionServiceBase<...> {
  ...
  get store() {
    return this.dispatcher.store;
  }
  ...
}
```

In the d.ts file for this we get:

```ts
get store(): Store<import("@ngrx/data").EntityCache>;
```

Given that this file is within the `@ngrx/data` package already,
this caused ngcc to believe that there was a circular dependency,
causing it to fail to process the package - and in fact crash!

This commit resolves this problem by ignoring `import()` expressions
when scanning typings programs for dependencies. This ability was
only introduced very recently in a 10.0.0 RC release, and so it has
limited benefit given that up till now ngcc has been able to process
libraries effectively without it. Moreover, in the rare case that a
package does have such a dependency, it should get picked up
by the sync ngcc+CLI integration point.

PR Close #37503
This commit is contained in:
Pete Bacon Darwin
2020-06-09 12:34:28 +01:00
committed by atscott
parent cc552dd702
commit ae364864f6
3 changed files with 30 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
packages/compiler-cli/ngcc/test/dependencies/dts_dependency_host_spec.ts
View File

@ -44,6 +44,15 @@ runInEachFileSystem(() => {
expect(dependencies.has(_('/node_modules/lib-1/sub-1'))).toBe(true);
});
it('should ignore synthetic type imports', () => {
const {dependencies, missing, deepImports} = createDependencyInfo();
host.collectDependencies(
_('/external/synthetic-type-imports/index.d.ts'), {dependencies, missing, deepImports});
expect(dependencies.size).toBe(0);
expect(missing.size).toBe(0);
expect(deepImports.size).toBe(0);
});
it('should resolve all the external re-exports of the source file', () => {
const {dependencies, missing, deepImports} = createDependencyInfo();
host.collectDependencies(
@ -165,6 +174,18 @@ runInEachFileSystem(() => {
},
{name: _('/external/imports/package.json'), contents: '{"esm2015": "./index.js"}'},
{name: _('/external/imports/index.metadata.json'), contents: 'MOCK METADATA'},
{
name: _('/external/synthetic-type-imports/index.d.ts'),
contents: `const function foo(): Array<import("lib-1").X>;`
},
{
name: _('/external/synthetic-type-imports/package.json'),
contents: '{"esm2015": "./index.js"}'
},
{
name: _('/external/synthetic-type-imports/index.metadata.json'),
contents: 'MOCK METADATA'
},
{
name: _('/external/re-exports/index.d.ts'),
contents: `export {X} from 'lib-1';\nexport {Y} from 'lib-1/sub-1';`