Angular-cli: No NgModule metadata found for 'AppModule' with webpack AngularCompilerPlugin

[mscottnelson]

Versions

Angular CLI: 1.6.3
Node: 8.9.1
OS: darwin x64
Angular: 5.1.3
... animations, common, compiler, compiler-cli, core, forms
... http, language-service, platform-browser
... platform-browser-dynamic, platform-server, router

@angular/cli: 1.6.3
@angular-devkit/build-optimizer: 0.0.36
@angular-devkit/core: 0.0.22
@angular-devkit/schematics: 0.0.42
@ngtools/json-schema: 1.1.0
@ngtools/webpack: 1.9.3
@schematics/angular: 0.1.11
@schematics/schematics: 0.0.11
typescript: 2.4.2
webpack: 3.10.0

Repro steps

We have a set of apps that depend on a common core of node_modules and other assets. Our file structure is roughly organized as follows:

└───app1
│   │   package.json
│   │   tsconfig.json
│   │   ...
│   └───src
│   └───node_modules
└───app2
│   │   package.json
│   │   tsconfig.json
│   │   ...
│   └───src
│   └───node_modules
└───commons
│   │   package.json
│   │   tsconfig.base.json
│   │   ...
│   └───assets
│   └───node_modules
│   └───angular-commons
│       │   tsconfig.json
│       │   CommonModule.ts
│       │   lib.ts
│       │   ...

Where all shared node_modules and other assets live in commons, and only node_modules unique to a given app live in its own directory. We are in the process of adopting Webpack for the many benefits it brings, not the least of which is the AngularCompilerPlugin. I can get our build to work as expected as long as the submodules are child directories of the build directory
and the build directory houses all the common node_modules (eg Angular). While this is a possible solution, our prefered solution allows us to maintain our current directory structure. Unfortunately, this is where I am running into issues.

As soon as the child directories leave the root of the build directory, I am running into issues with the AngularCompiler. In my current setup, I receive the following message from a webpack build: ERROR in Error: No NgModule metadata found for 'AppModule'. This suggests to me that the AngularCompiler is not successfully finding the NgModule decorator, as Webpack appears to otherwise successfully walk the tree of the application. I have tried to point it at the correct location to find the NgModule using both the mainPath option and the entryModule options. This has led me to closely inspect the configuration options of AngularCompilerPlugin as well as the specific pathing behavior of TypeScript in both "moduleResolution": "node" and "moduleResolution": "classic" and to experiment with a number of different configurations and directory structures. In every case, the only working structure appeared to be making the root build folder the root folder for @angular and our apps as well. It's worth noting here that difficulties specifying where Angular should look for its pathing / dependencies were the same thing that drove us away from using the Angular compiler, which I understand wraps Webpack.

I attempted to reproduce this behavior in a standalone repo, and ran into a different set of issues that may be related. The repo shares some similarities with our project. In this case, however, the build fails at app.module.ngfactory, unable to find @angular/common. In order to remove pathing ambiguities with TypeScript module resolution, I used relative imports directly to the appropriate node_modules. I suspect that the pathing issues in this example repo are related to the ones we are seeing in our project, even though they manifest differently. Any help in resolving this issue would be much appreciated.

• git clone --recursive -j8 https://github.com/mscottnelson/ngWebpackCompile.git
• cd ngWebpackCompile/commons
• npm install
• npm run watch:app1

Observed behavior

ERROR in Error: No NgModule metadata found for 'AppModule'.
    at NgModuleResolver.resolve (/Users/me/project/commons/node_modules/@angular/compiler/bundles/compiler.umd.js:20276:23)
    at CompileMetadataResolver.getNgModuleMetadata (/Users/me/project/commons/node_modules/@angular/compiler/bundles/compiler.umd.js:15229:60)
    at visitLazyRoute (/Users/me/project/commons/node_modules/@angular/compiler/bundles/compiler.umd.js:31090:104)
    at AotCompiler.listLazyRoutes (/Users/me/project/commons/node_modules/@angular/compiler/bundles/compiler.umd.js:31058:20)
    at AngularCompilerProgram.listLazyRoutes (/Users/me/project/commons/node_modules/@angular/compiler-cli/src/transformers/program.js:156:30)
    at Function.NgTools_InternalApi_NG_2.listLazyRoutes (/Users/me/project/commons/node_modules/@angular/compiler-cli/src/ngtools_api.js:44:36)
    at AngularCompilerPlugin._getLazyRoutesFromNgtools (/Users/me/project/commons/node_modules/@ngtools/webpack/src/angular_compiler_plugin.js:248:66)
    at Promise.resolve.then.then (/Users/me/project/commons/node_modules/@ngtools/webpack/src/angular_compiler_plugin.js:562:50)
    at <anonymous>
    at process._tickCallback (internal/process/next_tick.js:188:7)
    at Function.Module.runMain (module.js:678:11)
    at startup (bootstrap_node.js:187:16)
    at bootstrap_node.js:608:3

Desired behavior

Allow the AngularCompiler to be configured to compile apps that are in a directory other than the directory where the angular compiler and its dependencies are installed.

Mention any other details that might be useful

I can successfully build and run the applications using a directory structure like the one below:

└───commons
│   │   package.json
│   │   tsconfig.base.json
│   │   ...
│   └───assets
│   └───node_modules
│   └───angular-commons
│       │   tsconfig.json
│       │   CommonModule.ts
│       │   lib.ts
│       │   ...
│   └───app1
│   │   │   package.json
│   │   │   tsconfig.json
│   │   │   ...
│   │   └───src
│   │   └───node_modules
│   └───app2
│   │   │   package.json
│   │   │   tsconfig.json
│   │   │   ...
│   │   └───src
│   │   └───node_modules

[mscottnelson]

After banging my head against this repeatedly for days, I convinced my team to rearrange our project to have our commons folder as a git submodule of the other applications, each with their own node_modules dependencies instead of sharing those resources across applications. No problem, I think that might be conceptually better anyway. With that new configuration, AoT seemed to function properly. Alas, it was not to last.

In the course of trying a variety of different things, my versions have shifted to:

"@angular-devkit/core": "0.0.26",
"@angular-devkit/schematics": "0.0.49",
"@angular/cli": "1.6.4",

It's worth noting, perhaps, that I am specifying @angular-devkit/core and @angular-devkit/schematics because they are otherwise not installed. 0.0.28 and 0.0.51 are the declared correct peerDependencies for angular/cli, but those are not available via npm install (????).

After testing against various builds and being pleased with the results, for my own reasons, I temporarily turned AoT off with the { skipCodeGeneration: true} plugin option. Imagine my surprise when I turned it back on and suddenly NgModule was once again not found.

I can hardly believe the 'fix' that brought me back to a working state. This behavior is consistent. If main.ts is written this way:

const platform = platformBrowserDynamic();
platform.bootstrapModule(AppModule);

then NgModule is not found at run-time. However, if it is written this way:

platformBrowserDynamic().bootstrapModule(AppModule);

then all is fine.

[FlicGibbs]

Far out! Thanks - that saved me 🥇

[about-code]

Just stumbled upon the same issue when upgrading from @ngtools/webpack 1.9.8 and Angular 5.2.4 to @ngtools/webpack 1.10.1 and Angular 5.2.7. I can reproduce and confirm @mscottnelson.

@filipesilva I've tried for minutes to find a good reason why breaking JavaScript language semantics could be a feature. But I just don't find any. To me it really appears to be a bug in the Angular compiler.

[kolesnik]

+1

[csrssrinivas]

I finally resolved this issue. Resolution below. :-)

Update the Angular CLI version to latest – as of today it’s 1.7.4

How to check the version of @angular/cli

• ng --version

Go to the folder and type the following commands to update CLI.

• npm remove @angular/cli
• npm install —save-dev @angular/cli@latest

Make sure that the Webpack version is 3.11.0
How to check the version of Webpack

• npm list webpack

How to update webpack

• npm remove webpack
• npm install [email protected]

[filipesilva]

Is this still an issue? If so, can someone provide us a reproduction repository using recent versions of Angular and CLI that we can clone and investigate?

[about-code]

Could no longer reproduce it with

• @angular/compiler: 7.1.1
• @ngtools/webpack 7.1.0

[alan-agius4]

Closing as it seems that this issue has been solved.

Please update to the most recent Angular CLI version.

If the problem persists after upgrading, please open a new issue, provide a simple repository reproducing the problem, and describe the difference between the expected and current behavior.

[angular-automatic-lock-bot[bot]]

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{_This action has been performed automatically by a bot._}