fix(@ngtools/webpack): check for compiler-cli on plugin constructor

Fix #7904

Author: filipesilva

packages/@ngtools/webpack/src/angular_compiler_plugin.ts

@@ -1,10 +1,8 @@
-// @ignoreDep @angular/compiler-cli
 import * as fs from 'fs';
 import { fork, ChildProcess } from 'child_process';
 import * as path from 'path';
 import * as ts from 'typescript';
 
-const { __NGTOOLS_PRIVATE_API_2, VERSION } = require('@angular/compiler-cli');
 const ContextElementDependency = require('webpack/lib/dependencies/ContextElementDependency');
 const NodeWatchFileSystem = require('webpack/lib/node/NodeWatchFileSystem');
 const treeKill = require('tree-kill');
@@ -29,6 +27,9 @@ import { time, timeEnd } from './benchmark';
 import { InitMessage, UpdateMessage } from './type_checker';
 import { gatherDiagnostics, hasErrors } from './gather_diagnostics';
 import {
+  CompilerCliIsSupported,
+  __NGTOOLS_PRIVATE_API_2,
+  VERSION,
   DEFAULT_ERROR_CODE,
   UNKNOWN_ERROR_CODE,
   SOURCE,
@@ -41,7 +42,7 @@ import {
   createCompilerHost,
   formatDiagnostics,
   EmitFlags,
-} from './ngtools_api2';
+} from './ngtools_api';
 
 
 /**
@@ -106,6 +107,7 @@ export class AngularCompilerPlugin implements Tapable {
   private _typeCheckerProcess: ChildProcess;
 
   constructor(options: AngularCompilerPluginOptions) {
+    CompilerCliIsSupported();
     this._options = Object.assign({}, options);
     this._setupOptions(this._options);
   }
@@ -121,7 +123,7 @@ export class AngularCompilerPlugin implements Tapable {
   }
 
   static isSupported() {
-    return parseInt(VERSION.major) >= 5;
+    return VERSION && parseInt(VERSION.major) >= 5;
   }
 
   private _setupOptions(options: AngularCompilerPluginOptions) {

packages/@ngtools/webpack/src/extract_i18n_plugin.ts

@@ -1,10 +1,8 @@
-// @ignoreDep @angular/compiler-cli
 import * as ts from 'typescript';
 import * as path from 'path';
 import * as fs from 'fs';
 
-const {__NGTOOLS_PRIVATE_API_2, VERSION} = require('@angular/compiler-cli');
-
+import {__NGTOOLS_PRIVATE_API_2, VERSION} from './ngtools_api';
 import {Tapable} from './webpack';
 import {WebpackResourceLoader} from './resource_loader';
 

packages/@ngtools/webpack/src/gather_diagnostics.ts

@@ -1,7 +1,7 @@
 import * as ts from 'typescript';
 
 import { time, timeEnd } from './benchmark';
-import { Program, Diagnostics } from './ngtools_api2';
+import { Program, Diagnostics } from './ngtools_api';
 
 
 export class CancellationToken implements ts.CancellationToken {

packages/@ngtools/webpack/src/index.ts

@@ -1,32 +1,3 @@
-// @ignoreDep @angular/compiler-cli
-import * as path from 'path';
-
-let version;
-
-// Check that Angular is available.
-try {
-  version = require('@angular/compiler-cli').VERSION;
-} catch (e) {
-  throw new Error('The "@angular/compiler-cli" package was not properly installed. Error: ' + e);
-}
-
-// Check that Angular is also not part of this module's node_modules (it should be the project's).
-const compilerCliPath = require.resolve('@angular/compiler-cli');
-if (compilerCliPath.startsWith(path.dirname(__dirname))) {
-  throw new Error('The @ngtools/webpack plugin now relies on the project @angular/compiler-cli. '
-                + 'Please clean your node_modules and reinstall.');
-}
-
-// Throw if we're neither 2.3.1 or more, nor 4.x.y, nor 5.x.y.
-if (!(   version.major == '5'
-      || version.major == '4'
-      || (version.major == '2'
-          && (   version.minor == '4'
-              || version.minor == '3' && version.patch == '1')))) {
-  throw new Error('Version of @angular/compiler-cli needs to be 2.3.1 or greater. '
-                + `Current version is "${version.full}".`);
-}
-
 export * from './plugin';
 export * from './angular_compiler_plugin';
 export * from './extract_i18n_plugin';

packages/@ngtools/webpack/src/ngtools_api2.ts renamed to packages/@ngtools/webpack/src/ngtools_api.ts

@@ -1,7 +1,10 @@
+// @ignoreDep @angular/compiler-cli
 /**
  * This is a copy of types in @compiler-cli/src/ngtools_api.d.ts file,
- * together with a safe import to support cases where Angular versions is below 5.
+ * together with safe imports for private apis for cases where @angular/compiler-cli isn't
+ * available or is below version 5.
  */
+import * as path from 'path';
 import * as ts from 'typescript';
 
 export const DEFAULT_ERROR_CODE = 100;
@@ -102,6 +105,52 @@ export interface FormatDiagnosticsInterface {
   (options: CompilerOptions, diags: Diagnostics): string;
 }
 
+// Manually check for Compiler CLI availability and supported version.
+// This is needed because @ngtools/webpack does not depend directly on @angular/compiler-cli, since
+// it is installed as part of global Angular CLI installs and compiler-cli is not of its
+// dependencies.
+export function CompilerCliIsSupported() {
+  let version;
+
+  // Check that Angular is available.
+  try {
+    version = require('@angular/compiler-cli').VERSION;
+  } catch (e) {
+    throw new Error('The "@angular/compiler-cli" package was not properly installed. Error: ' + e);
+  }
+
+  // Check that Angular is also not part of this module's node_modules (it should be the project's).
+  const compilerCliPath = require.resolve('@angular/compiler-cli');
+  if (compilerCliPath.startsWith(path.dirname(__dirname))) {
+    throw new Error('The @ngtools/webpack plugin now relies on the project @angular/compiler-cli. '
+      + 'Please clean your node_modules and reinstall.');
+  }
+
+  // Throw if we're neither 2.3.1 or more, nor 4.x.y, nor 5.x.y.
+  if (!(version.major == '5'
+    || version.major == '4'
+    || (version.major == '2'
+      && (version.minor == '4'
+        || version.minor == '3' && version.patch == '1')))) {
+    throw new Error('Version of @angular/compiler-cli needs to be 2.3.1 or greater. '
+      + `Current version is "${version.full}".`);
+  }
+}
+
+// These imports do not exist on a global install for Angular CLI, so we cannot use a static ES6
+// import.
+let compilerCli: any = {};
+try {
+  compilerCli = require('@angular/compiler-cli');
+} catch (e) {
+  // Don't throw an error if the private API does not exist.
+  // Instead, the `CompilerCliIsSupported` method should return throw and indicate the
+  // plugin cannot be used.
+}
+
+export const VERSION = compilerCli.VERSION;
+export const __NGTOOLS_PRIVATE_API_2 = compilerCli.__NGTOOLS_PRIVATE_API_2;
+
 // These imports do not exist on Angular versions lower than 5, so we cannot use a static ES6
 // import.
 let ngtools2: any = {};

packages/@ngtools/webpack/src/plugin.ts

@@ -1,13 +1,12 @@
-// @ignoreDep @angular/compiler-cli
 import * as fs from 'fs';
 import * as path from 'path';
 import * as ts from 'typescript';
 import * as SourceMap from 'source-map';
 
-const {__NGTOOLS_PRIVATE_API_2, VERSION} = require('@angular/compiler-cli');
 const ContextElementDependency = require('webpack/lib/dependencies/ContextElementDependency');
 const NodeWatchFileSystem = require('webpack/lib/node/NodeWatchFileSystem');
 
+import {CompilerCliIsSupported, __NGTOOLS_PRIVATE_API_2, VERSION} from './ngtools_api';
 import {WebpackResourceLoader} from './resource_loader';
 import {WebpackCompilerHost} from './compiler_host';
 import {resolveEntryModuleFromMain} from './entry_resolver';
@@ -80,6 +79,7 @@ export class AotPlugin implements Tapable {
   private _firstRun = true;
 
   constructor(options: AotPluginOptions) {
+    CompilerCliIsSupported();
     this._options = Object.assign({}, options);
     this._setupOptions(this._options);
   }

packages/@ngtools/webpack/src/type_checker.ts

@@ -1,4 +1,3 @@
-// @ignoreDep @angular/compiler-cli
 import * as process from 'process';
 import * as ts from 'typescript';
 import * as chalk from 'chalk';
@@ -13,7 +12,7 @@ import {
   createProgram,
   createCompilerHost,
   formatDiagnostics,
-} from './ngtools_api2';
+} from './ngtools_api';
 
 // Force basic color support on terminals with no color support.
 // Chalk typings don't have the correct constructor parameters.