Merge pull request #347 from typed-ember/typechecking

[v2] Reintroduce typechecking

Author: dfreeman

package.json

@@ -37,6 +37,7 @@
   "dependencies": {
     "@babel/plugin-proposal-class-properties": "^7.1.0",
     "@babel/plugin-transform-typescript": "^7.1.0",
+    "ansi-to-html": "^0.6.6",
     "broccoli-funnel": "^2.0.1",
     "broccoli-merge-trees": "^2.0.0",
     "broccoli-plugin": "^1.2.1",
@@ -51,6 +52,7 @@
     "resolve": "^1.5.0",
     "rsvp": "^4.8.1",
     "semver": "^5.5.1",
+    "stagehand": "^1.0.0",
     "symlink-or-copy": "^1.1.8",
     "walk-sync": "^0.3.2"
   },
@@ -60,8 +62,10 @@
     "@types/core-object": "^3.0.0",
     "@types/ember": "2.8.13",
     "@types/ember-qunit": "^3.0.1",
+    "@types/express": "^4.16.0",
     "@types/node": "^9.6.5",
     "@types/qunit": "^2.0.31",
+    "@types/resolve": "^0.0.8",
     "@types/semver": "^5.5.0",
     "broccoli-asset-rev": "^2.7.0",
     "co": "^4.6.0",
@@ -73,7 +77,7 @@
     "ember-cli-eslint": "^4.2.3",
     "ember-cli-htmlbars": "^3.0.0",
     "ember-cli-htmlbars-inline-precompile": "^1.0.3",
-    "ember-cli-inject-live-reload": "^1.8.2",
+    "ember-cli-inject-live-reload": "^2.0.1",
     "ember-cli-release": "^0.2.9",
     "ember-cli-sri": "^2.1.1",
     "ember-cli-typescript-blueprints": "^1.0.0",
@@ -91,6 +95,7 @@
     "eslint-plugin-ember": "^5.2.0",
     "eslint-plugin-node": "^7.0.1",
     "esprima": "^4.0.0",
+    "got": "^9.2.2",
     "in-repo-a": "link:tests/dummy/lib/in-repo-a",
     "in-repo-b": "link:tests/dummy/lib/in-repo-b",
     "loader.js": "^4.7.0",
@@ -112,6 +117,7 @@
   "ember-addon": {
     "configPath": "tests/dummy/config",
     "before": [
+      "broccoli-watcher",
       "ember-cli-babel"
     ]
   },

ts/addon.ts

@@ -1,7 +1,12 @@
 import semver from 'semver';
+import { Remote } from 'stagehand';
+import { connect } from 'stagehand/lib/adapters/child-process';
 import { hasPlugin, addPlugin, AddPluginOptions } from 'ember-cli-babel-plugin-helpers';
 import Addon from 'ember-cli/lib/models/addon';
 import { addon } from './lib/utilities/ember-cli-entities';
+import fork from './lib/utilities/fork';
+import TypecheckWorker from './lib/typechecking/worker';
+import TypecheckMiddleware from './lib/typechecking/middleware';
 
 export default addon({
   name: 'ember-cli-typescript',
@@ -10,6 +15,12 @@ export default addon({
     this._super.included.apply(this, arguments);
     this._checkDevelopment();
     this._checkBabelVersion();
+
+    // If we're a direct dependency of the host app, go ahead and start up the
+    // typecheck worker so we don't wait until the end of the build to check
+    if (this.parent === this.project) {
+      this._getTypecheckWorker();
+    }
   },
 
   includedCommands() {
@@ -25,7 +36,30 @@ export default addon({
     return `${__dirname}/blueprints`;
   },
 
-  setupPreprocessorRegistry(type: string) {
+  serverMiddleware({ app }) {
+    let workerPromise = this._getTypecheckWorker();
+    let middleware = new TypecheckMiddleware(this.project, workerPromise);
+    middleware.register(app);
+  },
+
+  async postBuild() {
+    // This code makes the fundamental assumption that the TS compiler's fs watcher
+    // will notice a file change before the full Broccoli build completes. Otherwise
+    // the `getStatus` call here might report the status of the previous check. In
+    // practice, though, building takes much longer than the time to trigger the
+    // compiler's "hey, a file changed" hook, and once the typecheck has begun, the
+    // `getStatus` call will block until it's complete.
+    let worker = await this._getTypecheckWorker();
+    let { failed } = await worker.getStatus();
+
+    if (failed) {
+      // The actual details of the errors will already have been printed
+      // with nice highlighting and formatting separately.
+      throw new Error('Typechecking failed');
+    }
+  },
+
+  setupPreprocessorRegistry(type) {
     if (type !== 'parent') return;
 
     // Normally this is the sort of logic that would live in `included()`, but
@@ -52,10 +86,11 @@ export default addon({
 
   _checkBabelVersion() {
     let babel = this.parent.addons.find(addon => addon.name === 'ember-cli-babel');
-    if (!babel || !semver.satisfies(babel.pkg.version, '>=7.0.0-alpha.0 <8')) {
-      let version = babel ? `version ${babel.pkg.version}` : `no instance of ember-cli-babel`;
+    let version = babel && babel.pkg.version;
+    if (!babel || !(semver.gte(version!, '7.1.0') && semver.lt(version!, '8.0.0'))) {
+      let versionString = babel ? `version ${babel.pkg.version}` : `no instance of ember-cli-babel`;
       this.ui.writeWarnLine(
-        `ember-cli-typescript requires ember-cli-babel@7, but you have ${version} installed; ` +
+        `ember-cli-typescript requires ember-cli-babel ^7.1.0, but you have ${versionString} installed; ` +
           'your TypeScript files may not be transpiled correctly.'
       );
     }
@@ -95,4 +130,29 @@ export default addon({
       extensions.push('ts');
     }
   },
+
+  _typecheckWorker: undefined as Promise<Remote<TypecheckWorker>> | undefined,
+
+  _getTypecheckWorker() {
+    if (!this._typecheckWorker) {
+      this._typecheckWorker = this._forkTypecheckWorker();
+    }
+
+    return this._typecheckWorker;
+  },
+
+  async _forkTypecheckWorker() {
+    let childProcess = fork(`${__dirname}/lib/typechecking/worker/launch`);
+    let worker = await connect<TypecheckWorker>(childProcess);
+
+    await worker.onTypecheck(status => {
+      for (let error of status.errors) {
+        this.ui.writeLine(error);
+      }
+    });
+
+    await worker.start(this.project.root);
+
+    return worker;
+  },
 });

ts/lib/typechecking/middleware/index.ts

@@ -0,0 +1,39 @@
+import { Remote } from 'stagehand';
+import { Application, Request, Response, NextFunction } from 'express';
+import Project from 'ember-cli/lib/models/project';
+import TypecheckWorker from '../worker';
+import renderErrorPage from './render-error-page';
+
+export const LIVE_RELOAD_PATH = '/ember-cli-live-reload.js';
+
+export default class TypecheckMiddleware {
+  constructor(private project: Project, private workerPromise: Promise<Remote<TypecheckWorker>>) {}
+
+  public register(app: Application): void {
+    app.use((...params) => this.handleRequest(...params));
+  }
+
+  private async handleRequest(request: Request, response: Response, next: NextFunction) {
+    if (!request.accepts('html') || request.path === LIVE_RELOAD_PATH) {
+      next();
+      return;
+    }
+
+    let worker = await this.workerPromise;
+    let { errors, failed } = await worker.getStatus();
+
+    if (failed) {
+      response.type('html');
+      response.end(renderErrorPage(errors, this.environmentInfo()));
+    } else {
+      next();
+    }
+  }
+
+  private environmentInfo(): string {
+    let tsVersion = (this.project.require('typescript/package.json') as any).version;
+    let ectsVersion = require(`${__dirname}/../../../../package`).version;
+
+    return `typescript@${tsVersion}, ember-cli-typescript@${ectsVersion}`;
+  }
+}