gracefully handle error thrown from the service (#249)

* gracefully handle error thrown from the service

* add integration test

* requested changes

Author: phryneas

CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.0.4
+
+* [gracefully handle error thrown from the service](https://github.com/Realytics/fork-ts-checker-webpack-plugin/pull/249)
+
 ## v1.0.3
 
 * [use worker-rpc library for inter-process communication](https://github.com/Realytics/fork-ts-checker-webpack-plugin/pull/231)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fork-ts-checker-webpack-plugin",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Runs typescript type checker and linter on separate process.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

src/NormalizedMessage.ts

@@ -9,6 +9,7 @@ interface NormalizedMessageJson {
   file?: string;
   line?: number;
   character?: number;
+  stack?: string;
 }
 
 export class NormalizedMessage {
@@ -19,13 +20,16 @@ export class NormalizedMessage {
   public static readonly SEVERITY_ERROR: Severity = 'error';
   public static readonly SEVERITY_WARNING: Severity = 'warning';
 
+  public static readonly ERROR_CODE_INTERNAL = 'INTERNAL_ERROR';
+
   public readonly type: ErrorType;
   public readonly code: string | number;
   public readonly severity: Severity;
   public readonly content: string;
   public readonly file?: string;
   public readonly line?: number;
   public readonly character?: number;
+  public readonly stack?: string;
 
   constructor(data: NormalizedMessageJson) {
     this.type = data.type;
@@ -35,6 +39,7 @@ export class NormalizedMessage {
     this.file = data.file;
     this.line = data.line;
     this.character = data.character;
+    this.stack = data.stack;
   }
 
   public static createFromJSON(json: NormalizedMessageJson) {
@@ -73,6 +78,10 @@ export class NormalizedMessage {
         messageA.content,
         messageB.content
       ) ||
+      NormalizedMessage.compareOptionalStrings(
+        messageA.stack,
+        messageB.stack
+      ) ||
       0 /* EqualTo */
     );
   }
@@ -149,7 +158,8 @@ export class NormalizedMessage {
       content: this.content,
       file: this.file,
       line: this.line,
-      character: this.character
+      character: this.character,
+      stack: this.stack
     } as NormalizedMessageJson;
   }
 

src/NormalizedMessageFactories.ts

@@ -58,3 +58,18 @@ export const makeCreateNormalizedMessageFromRuleFailure = () => {
   };
   return createNormalizedMessageFromRuleFailure;
 };
+
+export const makeCreateNormalizedMessageFromInternalError = () => {
+  const createNormalizedMessageFromInternalError = (error: any) => {
+    return new NormalizedMessage({
+      type: NormalizedMessage.TYPE_DIAGNOSTIC,
+      severity: NormalizedMessage.SEVERITY_ERROR,
+      code: NormalizedMessage.ERROR_CODE_INTERNAL,
+      content:
+        typeof error.message === 'string' ? error.message : error.toString(),
+      stack: typeof error.stack === 'string' ? error.stack : undefined,
+      file: '[internal]'
+    });
+  };
+  return createNormalizedMessageFromInternalError;
+};

src/formatter/codeframeFormatter.ts

@@ -22,6 +22,16 @@ export function createCodeframeFormatter(options: any) {
       : colors.bold.red;
     const positionColor = colors.dim;
 
+    if (message.code === NormalizedMessage.ERROR_CODE_INTERNAL) {
+      return (
+        messageColor(`INTERNAL ${message.severity.toUpperCase()}: `) +
+        message.content +
+        (message.stack
+          ? os.EOL + 'stack trace:' + os.EOL + colors.gray(message.stack)
+          : '')
+      );
+    }
+
     const file = message.file;
     const source =
       file && FsHelper.existsSync(file) && fs.readFileSync(file, 'utf-8');

src/formatter/defaultFormatter.ts

@@ -19,6 +19,16 @@ export function createDefaultFormatter() {
     const fileAndNumberColor = colors.bold.cyan;
     const codeColor = colors.grey;
 
+    if (message.code === NormalizedMessage.ERROR_CODE_INTERNAL) {
+      return (
+        messageColor(`INTERNAL ${message.severity.toUpperCase()}: `) +
+        message.content +
+        (message.stack
+          ? os.EOL + 'stack trace:' + os.EOL + colors.gray(message.stack)
+          : '')
+      );
+    }
+
     return [
       messageColor(`${message.severity.toUpperCase()} in `) +
         fileAndNumberColor(

src/index.ts

@@ -130,6 +130,9 @@ class ForkTsCheckerWebpackPlugin {
   private measureTime: boolean;
   private performance: any;
   private startAt: number = 0;
+
+  private nodeArgs: string[] = [];
+
   constructor(options?: Partial<Options>) {
     options = options || ({} as Options);
     this.options = { ...options };
@@ -573,10 +576,10 @@ class ForkTsCheckerWebpackPlugin {
       ),
       [],
       {
-        execArgv:
-          this.workersNumber > 1
-            ? []
-            : ['--max-old-space-size=' + this.memoryLimit],
+        execArgv: (this.workersNumber > 1
+          ? []
+          : ['--max-old-space-size=' + this.memoryLimit]
+        ).concat(this.nodeArgs),
         env: {
           ...process.env,
           TYPESCRIPT_PATH: this.typescriptPath,

src/service.ts

@@ -8,7 +8,8 @@ import { IncrementalCheckerInterface } from './IncrementalCheckerInterface';
 import { ApiIncrementalChecker } from './ApiIncrementalChecker';
 import {
   makeCreateNormalizedMessageFromDiagnostic,
-  makeCreateNormalizedMessageFromRuleFailure
+  makeCreateNormalizedMessageFromRuleFailure,
+  makeCreateNormalizedMessageFromInternalError
 } from './NormalizedMessageFactories';
 import { RpcProvider } from 'worker-rpc';
 import { RunPayload, RunResult, RUN } from './RpcTypes';
@@ -30,6 +31,7 @@ export const createNormalizedMessageFromDiagnostic = makeCreateNormalizedMessage
   typescript
 );
 export const createNormalizedMessageFromRuleFailure = makeCreateNormalizedMessageFromRuleFailure();
+export const createNormalizedMessageFromInternalError = makeCreateNormalizedMessageFromInternalError();
 
 const checker: IncrementalCheckerInterface =
   process.env.USE_INCREMENTAL_API === 'true'
@@ -64,9 +66,9 @@ async function run(cancellationToken: CancellationToken) {
   let diagnostics: NormalizedMessage[] = [];
   let lints: NormalizedMessage[] = [];
 
-  checker.nextIteration();
-
   try {
+    checker.nextIteration();
+
     diagnostics = await checker.getDiagnostics(cancellationToken);
     if (checker.hasLinter()) {
       lints = checker.getLints(cancellationToken);
@@ -76,7 +78,7 @@ async function run(cancellationToken: CancellationToken) {
       return undefined;
     }
 
-    throw error;
+    diagnostics.push(createNormalizedMessageFromInternalError(error));
   }
 
   if (cancellationToken.isCancellationRequested()) {

test/integration/index.spec.js

@@ -381,6 +381,7 @@ function makeCommonTests(useTypescriptIncrementalApi) {
 
 describe('[INTEGRATION] specific tests for useTypescriptIncrementalApi: false', function() {
   this.timeout(60000);
+  var plugin;
 
   function createCompiler(
     options,
@@ -390,6 +391,7 @@ describe('[INTEGRATION] specific tests for useTypescriptIncrementalApi: false',
     options = options || {};
     options.useTypescriptIncrementalApi = false;
     var compiler = helpers.createCompiler(options, happyPackMode, entryPoint);
+    plugin = compiler.plugin;
     return compiler.webpack;
   }
 
@@ -458,4 +460,18 @@ describe('[INTEGRATION] specific tests for useTypescriptIncrementalApi: false',
       callback();
     });
   });
+
+  it('should handle errors within the IncrementalChecker gracefully as diagnostic', callback => {
+    var compiler = createCompiler();
+    plugin.nodeArgs = [
+      `--require`,
+      `${path.resolve(__dirname, './mocks/IncrementalCheckerWithError.js')}`
+    ];
+
+    compiler.run(function(error, stats) {
+      expect(stats.compilation.errors.length).to.equal(1);
+      expect(stats.compilation.errors[0].message).to.include("I'm an error!");
+      callback();
+    });
+  });
 });

test/integration/mocks/IncrementalCheckerWithError.js

@@ -0,0 +1,9 @@
+const mock = require('mock-require');
+
+mock('../../../lib/IncrementalChecker', {
+  IncrementalChecker: class {
+    nextIteration() {
+      throw new Error("I'm an error!");
+    }
+  }
+});