Merge pull request #1 from typed-ember/middleware-options-fork

mrloop · web-flow · commit 7decf1b2a378 · 2020-07-03T16:50:51.000+01:00
test: suggested updates for testing if typecheck middleware is installed
diff --git a/test-fixtures/skeleton-app/config/environment.js b/test-fixtures/skeleton-app/config/environment.js
@@ -4,6 +4,7 @@
 module.exports = function(environment) {
   return {
     environment,
-    modulePrefix: 'skeleton-app'
+    modulePrefix: 'skeleton-app',
+    rootURL: '/'
   };
 };
diff --git a/test-fixtures/skeleton-app/package.json b/test-fixtures/skeleton-app/package.json
@@ -5,6 +5,7 @@
     "ember-cli-htmlbars": "*",
     "ember-cli-babel": "*",
     "ember-source": "*",
+    "ember-qunit": "*",
     "loader.js": "*",
     "typescript": "*"
   },
diff --git a/test-fixtures/skeleton-app/testem.js b/test-fixtures/skeleton-app/testem.js
@@ -0,0 +1,23 @@
+'use strict';
+
+module.exports = {
+  test_page: 'tests/index.html?hidepassed',
+  disable_watching: true,
+  launch_in_ci: ['Chrome'],
+  launch_in_dev: ['Chrome'],
+  browser_start_timeout: 120,
+  browser_args: {
+    Chrome: {
+      ci: [
+        // --no-sandbox is needed when running Chrome inside a container
+        process.env.CI ? '--no-sandbox' : null,
+        '--headless',
+        '--disable-dev-shm-usage',
+        '--disable-software-rasterizer',
+        '--mute-audio',
+        '--remote-debugging-port=0',
+        '--window-size=1440,900'
+      ].filter(Boolean)
+    }
+  }
+};
diff --git a/test-fixtures/skeleton-app/tests/index.html b/test-fixtures/skeleton-app/tests/index.html
@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <title>Dummy Tests</title>
+    <meta name="description" content="">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    {{content-for "head"}}
+    {{content-for "test-head"}}
+
+    <link rel="stylesheet" href="{{rootURL}}assets/vendor.css">
+    <link rel="stylesheet" href="{{rootURL}}assets/skeleton-app.css">
+    <link rel="stylesheet" href="{{rootURL}}assets/test-support.css">
+
+    {{content-for "head-footer"}}
+    {{content-for "test-head-footer"}}
+  </head>
+  <body>
+    {{content-for "body"}}
+    {{content-for "test-body"}}
+
+    <script src="/testem.js" integrity=""></script>
+    <script src="{{rootURL}}assets/vendor.js"></script>
+    <script src="{{rootURL}}assets/test-support.js"></script>
+    <script src="{{rootURL}}assets/skeleton-app.js"></script>
+    <script src="{{rootURL}}assets/tests.js"></script>
+
+    {{content-for "body-footer"}}
+    {{content-for "test-body-footer"}}
+  </body>
+</html>
diff --git a/test-fixtures/skeleton-app/tests/test-helper.ts b/test-fixtures/skeleton-app/tests/test-helper.ts
@@ -0,0 +1,3 @@
+import { start } from 'ember-qunit';
+
+start();
diff --git a/ts/addon.ts b/ts/addon.ts
@@ -10,6 +10,9 @@ import TypecheckMiddleware from './lib/typechecking/middleware';
 import { Application } from 'express';
 import walkSync from 'walk-sync';
 import fs from 'fs-extra';
+import logger from 'debug';
+
+const debug = logger('ember-cli-typescript:addon');
 
 export const ADDON_NAME = 'ember-cli-typescript';
 
@@ -47,13 +50,19 @@ export default addon({
 
   serverMiddleware({ app, options }) {
     if (!options || !options.path) {
+      debug('Installing typecheck server middleware');
       this._addTypecheckMiddleware(app);
+    } else {
+      debug('Skipping typecheck server middleware');
     }
   },
 
   testemMiddleware(app, options) {
     if (!options || !options.path) {
+      debug('Installing typecheck testem middleware');
       this._addTypecheckMiddleware(app);
+    } else {
+      debug('Skipping typecheck testem middleware');
     }
   },
 
diff --git a/ts/tests/acceptance/build-test.ts b/ts/tests/acceptance/build-test.ts
@@ -69,50 +69,30 @@ describe('Acceptance: build', function () {
     );
   });
 
-  it("doesn't launch type checking when --path used", async () => {
+  it("doesn't launch type checking for `ember serve` when --path is used", async () => {
     await app.build();
+
     let server = app.serve({
       args: ['--path', 'dist'],
-      env: { DEBUG: 'ember-cli-typescript|express:*' },
+      env: { DEBUG: 'ember-cli-typescript:addon' },
     });
-    let result = await server.raceForOutputs([
-      'ember-cli-typescript:typecheck-worker',
-      'Serving on',
-    ]);
-    expect(result).to.include('Serving on');
-  });
 
-  it('does launch type checking when --path not used', async () => {
-    await app.build();
-    let server = app.serve({ env: { DEBUG: 'ember-cli-typescript|express:*' } });
-    let result = await server.raceForOutputs([
-      'ember-cli-typescript:typecheck-worker',
-      'Serving on',
-    ]);
-    expect(result).to.include('ember-cli-typescript:typecheck-worker');
+    let result = await server.waitForOutput('Serving on');
+
+    expect(result).to.include('ember-cli-typescript:addon Skipping typecheck server middleware');
   });
 
-  it("doesn't launch type checking when --path used for tests", async () => {
-    await app.build();
-    let test = app.test({
+  it("doesn't launch type checking for `ember test` when --path is used", async () => {
+    await app.build({ args: ['--environment', 'test'] });
+
+    let result = await app.test({
       args: ['--path', 'dist'],
-      env: { DEBUG: 'ember-cli-typescript|express:*' },
+      env: { DEBUG: 'ember-cli-typescript:addon' },
     });
-    let result = await test.raceForOutputs([
-      'ember-cli-typescript:typecheck-worker',
-      'express:application',
-    ]);
-    expect(result).to.include('express:application');
-  });
 
-  it('does launch type checking when --path not used for tests', async () => {
-    await app.build();
-    let test = app.test({ env: { DEBUG: 'ember-cli-typescript|express:*' } });
-    let result = await test.raceForOutputs([
-      'ember-cli-typescript:typecheck-worker',
-      'express:application',
-    ]);
-    expect(result).to.include('ember-cli-typescript:typecheck-worker');
+    expect(result.all).to.include(
+      'ember-cli-typescript:addon Skipping typecheck testem middleware'
+    );
   });
 
   it('fails the build when noEmitOnError is set and an error is emitted', async () => {
diff --git a/ts/tests/helpers/skeleton-app.ts b/ts/tests/helpers/skeleton-app.ts
@@ -15,14 +15,13 @@ const getEmberPort = (() => {
 
 interface EmberCliOptions {
   args?: string[];
-  env?: any;
+  env?: Record<string, string>;
 }
 
 export default class SkeletonApp {
   port = getEmberPort();
   watched: WatchedEmberProcess | null = null;
-  watchedTest: WatchedEmberProcess | null = null;
-  cleanupTempDir = () => rimraf(this.root, (error) => console.error(error));
+  cleanupTempDir = () => rimraf(this.root, (error) => error && console.error(error));
   root = path.join(process.cwd(), `test-skeleton-app-${Math.random().toString(36).slice(2)}`);
 
   constructor() {
@@ -31,26 +30,22 @@ export default class SkeletonApp {
     process.on('beforeExit', this.cleanupTempDir);
   }
 
-  build() {
-    return this._ember({ args: ['build'] });
+  build({ args = [], env }: EmberCliOptions = {}) {
+    return this._ember({ args: ['build', ...args], env });
   }
 
-  serve(options: EmberCliOptions = { args: [], env: {} }) {
+  test({ args = [], env }: EmberCliOptions = {}) {
+    return this._ember({ args: ['test', '--test-port', `${this.port}`, ...args], env });
+  }
+
+  serve({ args = [], env }: EmberCliOptions = {}) {
     if (this.watched) {
       throw new Error('Already serving');
     }
-    options.args = options.args || [];
-    options.args = ['serve', '--port', `${this.port}`, ...options.args];
-    return (this.watched = new WatchedEmberProcess(this._ember(options), this.port));
-  }
 
-  test(options: EmberCliOptions = { args: [], env: {} }) {
-    if (this.watchedTest) {
-      throw new Error('Already testing');
-    }
-    options.args = options.args || [];
-    options.args = ['test', ...options.args];
-    return (this.watchedTest = new WatchedEmberProcess(this._ember(options)));
+    let childProcess = this._ember({ args: ['serve', '--port', `${this.port}`, ...args], env });
+
+    return (this.watched = new WatchedEmberProcess(childProcess, this.port));
   }
 
   updatePackageJSON(callback: (arg: any) => any) {
@@ -77,21 +72,19 @@ export default class SkeletonApp {
     if (this.watched) {
       this.watched.kill();
     }
-    if (this.watchedTest) {
-      this.watchedTest.kill();
-    }
+
     this.cleanupTempDir();
     process.off('beforeExit', this.cleanupTempDir);
   }
 
-  _ember(options: EmberCliOptions) {
+  _ember({ args, env }: EmberCliOptions) {
     let ember = require.resolve('ember-cli/bin/ember');
-    return execa.node(ember, options.args, { cwd: this.root, all: true, env: options.env });
+    return execa.node(ember, args, { cwd: this.root, all: true, env });
   }
 }
 
 class WatchedEmberProcess extends EventEmitter {
-  constructor(protected ember: execa.ExecaChildProcess, protected port?: number) {
+  constructor(protected ember: execa.ExecaChildProcess, protected port: number) {
     super();
     this.ember.stdout?.on('data', (data) => {
       let output = data.toString();
@@ -115,10 +108,6 @@ class WatchedEmberProcess extends EventEmitter {
     return got(`http://localhost:${this.port}${path}`);
   }
 
-  raceForOutputs(targets: string[]) {
-    return Promise.race(targets.map((target) => this.waitForOutput(target)));
-  }
-
   waitForOutput(target: string) {
     return new Promise((resolve) => {
       let output = '';

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { start } from 'ember-qunit';`
	`2`	`+`
	`3`	`+start();`