feat(hapi-engine): add schematics (#1057)

CaerusKaru · web-flow · commit a4bf3d97b428 · 2018-12-24T23:11:07.000-06:00
* Add schematics for the Hapi engine
diff --git a/.bazelignore b/.bazelignore
@@ -0,0 +1 @@
+node_modules
diff --git a/modules/express-engine/schematics/BUILD.bazel b/modules/express-engine/schematics/BUILD.bazel
@@ -19,7 +19,6 @@ ts_library(
         exclude = [
             "**/*.spec.ts",
             "**/files/**/*",
-            "test-setup/**/*",
         ],
     ),
     module_name = "@nguniversal/express-engine/schematics",
diff --git a/modules/hapi-engine/BUILD.bazel b/modules/hapi-engine/BUILD.bazel
@@ -22,6 +22,7 @@ ng_package(
         ":package.json",
     ],
     entry_point = "modules/hapi-engine/index.js",
+    packages = ["//modules/hapi-engine/schematics:npm_package"],
     readme_md = ":README.md",
     tags = ["release"],
     deps = [
diff --git a/modules/hapi-engine/package.json b/modules/hapi-engine/package.json
@@ -14,6 +14,7 @@
     "@angular/platform-server": "NG_VERSION",
     "hapi": "HAPI_VERSION"
   },
+  "schematics": "./schematics/collection.json",
   "ng-update": {
     "packageGroup": "NG_UPDATE_PACKAGE_GROUP"
   },
diff --git a/modules/hapi-engine/schematics/BUILD.bazel b/modules/hapi-engine/schematics/BUILD.bazel
@@ -0,0 +1,60 @@
+load("//tools:defaults.bzl", "jasmine_node_test", "ng_test_library", "npm_package", "ts_library")
+
+package(default_visibility = ["//visibility:public"])
+
+filegroup(
+    name = "schematics_assets",
+    srcs = glob([
+        "**/files/**/*",
+        "**/*.json",
+    ]) + [
+        "README.md",
+    ],
+)
+
+ts_library(
+    name = "schematics",
+    srcs = glob(
+        ["**/*.ts"],
+        exclude = [
+            "**/*.spec.ts",
+            "**/files/**/*",
+        ],
+    ),
+    module_name = "@nguniversal/hapi-engine/schematics",
+    tsconfig = ":tsconfig.json",
+    deps = [
+        "@ngudeps//@angular-devkit/schematics",
+        "@ngudeps//@schematics/angular",
+        "@ngudeps//@types/jasmine",
+    ],
+)
+
+# This package is intended to be combined into the main @nguniversal/hapi-engine package as a dep.
+npm_package(
+    name = "npm_package",
+    srcs = [":schematics_assets"],
+    deps = [":schematics"],
+)
+
+### Testing rules
+
+jasmine_node_test(
+    name = "unit_tests",
+    srcs = [":schematics_test_sources"],
+    data = [":schematics_assets"],
+)
+
+ng_test_library(
+    name = "schematics_test_sources",
+    srcs = glob(
+        ["**/*.spec.ts"],
+        exclude = ["**/files/**/*"],
+    ),
+    tsconfig = ":tsconfig.json",
+    deps = [
+        ":schematics",
+        "@ngudeps//@angular-devkit/schematics",
+        "@ngudeps//@schematics/angular",
+    ],
+)
diff --git a/modules/hapi-engine/schematics/README.md b/modules/hapi-engine/schematics/README.md
@@ -0,0 +1,13 @@
+# Angular Universal Hapi-Engine Schematics
+A collection of Schematics for Angular Universal Hapi-Engine.
+
+## Collection
+
+### Install
+Adds Angular Universal Hapi Engine and its dependencies and pre-configures the application. 
+
+- Runs the default Angular Universal schematic to add Universal capabilities to an application
+- Adds Hapi-Engine and NgModule-Factory-Loader to `package.json`
+- Adds a sample Hapi server file
+
+Command: `ng add @nguniversal/hapi-engine`
diff --git a/modules/hapi-engine/schematics/collection.json b/modules/hapi-engine/schematics/collection.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "../node_modules/@angular-devkit/schematics/collection-schema.json",
+  "schematics": {
+    "ng-add": {
+      "description": "Adds Angular Universal Hapi Engine to the application without affecting any templates",
+      "factory": "./install",
+      "schema": "./install/schema.json",
+      "aliases": ["hapi-engine-shell"]
+    },
+  }
+}
diff --git a/modules/hapi-engine/schematics/install/files/root/__serverFileName@stripTsExtension__.ts b/modules/hapi-engine/schematics/install/files/root/__serverFileName@stripTsExtension__.ts
@@ -0,0 +1,53 @@
+import 'zone.js/dist/zone-node';
+import {enableProdMode} from '@angular/core';
+// Hapi Engine
+import {ngHapiEngine} from '@nguniversal/hapi-engine';
+// Import module map for lazy loading
+import {provideModuleMap} from '@nguniversal/module-map-ngfactory-loader';
+
+import {Request, Server} from 'hapi';
+import * as Inert from 'inert';
+import {join} from 'path';
+
+// Faster server renders w/ Prod mode (dev mode never needed)
+enableProdMode();
+
+// Hapi server
+const PORT = process.env.PORT || <%= serverPort %>;
+const server = new Server({ port: PORT, host: 'localhost' });
+
+const DIST_FOLDER = join(process.cwd(), 'dist');
+
+// * NOTE :: leave this as require() since this file is built Dynamically from webpack
+const {AppServerModuleNgFactory, LAZY_MODULE_MAP} = require('./<%= clientProject %>-server/main');
+
+server.route({
+  method: 'GET',
+  path: '*',
+  handler: (req: Request) =>
+    ngHapiEngine({
+      bootstrap: AppServerModuleNgFactory,
+      req,
+      providers: [
+        provideModuleMap(LAZY_MODULE_MAP)
+      ]
+    })
+});
+
+(async() => {
+  await server.register(Inert);
+
+  // Client bundles will be statically served from the built/ directory.
+  server.route({
+    method: 'GET',
+    path: '{file*}',
+    handler: {
+      directory: {
+        path: join(DIST_FOLDER, '<%= clientProject %>')
+      }
+    }
+  });
+
+  await server.start();
+  console.log(`Node Hapi server listening on http://localhost:${PORT}`);
+})();
diff --git a/modules/hapi-engine/schematics/install/files/root/__serverFileName@stripTsExtension__.tsconfig.json b/modules/hapi-engine/schematics/install/files/root/__serverFileName@stripTsExtension__.tsconfig.json
@@ -0,0 +1,20 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "outDir": "./dist",
+    "sourceMap": true,
+    "declaration": false,
+    "moduleResolution": "node",
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "target": "es5",
+    "typeRoots": [
+      "node_modules/@types"
+    ],
+    "lib": [
+      "es2017",
+      "dom"
+    ]
+  },
+  "include": ["<%= stripTsExtension(serverFileName) %>.ts"]
+}
diff --git a/modules/hapi-engine/schematics/install/files/root/webpack.server.config.js b/modules/hapi-engine/schematics/install/files/root/webpack.server.config.js
@@ -0,0 +1,47 @@
+// Work around for https://github.com/angular/angular-cli/issues/7200
+
+const path = require('path');
+const webpack = require('webpack');
+
+module.exports = {
+  mode: 'none',
+  entry: {
+    // This is our Hapi server for Dynamic universal
+    server: './<%= stripTsExtension(serverFileName) %>.ts'
+  },
+  target: 'node',
+  resolve: { extensions: ['.ts', '.js'] },
+  optimization: {
+    minimize: false
+  },
+  output: {
+    // Puts the output at the root of the dist folder
+    path: path.join(__dirname, 'dist'),
+    filename: '[name].js'
+  },
+  module: {
+    rules: [
+      { test: /\.ts$/, loader: 'ts-loader' },
+      {
+        // Mark files inside `@angular/core` as using SystemJS style dynamic imports.
+        // Removing this will cause deprecation warnings to appear.
+        test: /(\\|\/)@angular(\\|\/)core(\\|\/).+\.js$/,
+        parser: { system: true },
+      },
+    ]
+  },
+  plugins: [
+    new webpack.ContextReplacementPlugin(
+      // fixes WARNING Critical dependency: the request of a dependency is an expression
+      /(.+)?angular(\\|\/)core(.+)?/,
+      path.join(__dirname, 'src'), // location of your src
+      {} // a map of your routes
+    ),
+    new webpack.ContextReplacementPlugin(
+      // fixes WARNING Critical dependency: the request of a dependency is an expression
+      /(.+)?hapi(\\|\/)(.+)?/,
+      path.join(__dirname, 'src'),
+      {}
+    )
+  ]
+};
diff --git a/modules/hapi-engine/schematics/install/index.spec.ts b/modules/hapi-engine/schematics/install/index.spec.ts
@@ -0,0 +1,95 @@
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+import {SchematicTestRunner} from '@angular-devkit/schematics/testing';
+import {Schema as UniversalOptions} from './schema';
+import {collectionPath, createTestApp} from '../testing/test-app';
+import {Tree} from '@angular-devkit/schematics';
+
+describe('Universal Schematic', () => {
+  const defaultOptions: UniversalOptions = {
+    clientProject: 'bar',
+  };
+
+  let schematicRunner: SchematicTestRunner;
+  let appTree: Tree;
+
+  beforeEach(() => {
+    appTree = createTestApp();
+    schematicRunner = new SchematicTestRunner('schematics', collectionPath);
+  });
+
+  it('should add dependency: @nguniversal/module-map-ngfactory-loader', () => {
+    const tree = schematicRunner.runSchematic('ng-add', defaultOptions, appTree);
+    const filePath = '/package.json';
+    const contents = tree.readContent(filePath);
+    expect(contents).toMatch(/\"@nguniversal\/module-map-ngfactory-loader\": \"/);
+  });
+
+  it('should add dependency: @nguniversal/hapi-engine', () => {
+    const tree = schematicRunner.runSchematic('ng-add', defaultOptions, appTree);
+    const filePath = '/package.json';
+    const contents = tree.readContent(filePath);
+    expect(contents).toMatch(/\"@nguniversal\/hapi-engine\": \"/);
+  });
+
+  it('should add dependency: hapi', () => {
+    const tree = schematicRunner.runSchematic('ng-add', defaultOptions, appTree);
+    const filePath = '/package.json';
+    const contents = tree.readContent(filePath);
+    expect(contents).toMatch(/\"hapi\": \"/);
+  });
+
+  it('should add dependency: ts-loader', () => {
+    const tree = schematicRunner.runSchematic('ng-add', defaultOptions, appTree);
+    const filePath = '/package.json';
+    const contents = tree.readContent(filePath);
+    expect(contents).toMatch(/\"ts-loader\": \"/);
+  });
+
+  it('should add dependency: webpack-cli', () => {
+    const tree = schematicRunner.runSchematic('ng-add', defaultOptions, appTree);
+    const filePath = '/package.json';
+    const contents = tree.readContent(filePath);
+    expect(contents).toMatch(/\"webpack-cli\": \"/);
+  });
+
+  it('should not add dependency: ts-loader when webpack is false', () => {
+    const noWebpack = Object.assign({}, defaultOptions);
+    noWebpack.webpack = false;
+    const tree = schematicRunner.runSchematic('ng-add', noWebpack, appTree);
+    const filePath = '/package.json';
+    const contents = tree.readContent(filePath);
+    expect(contents).not.toContain('ts-loader');
+  });
+
+  it('should not add dependency: webpack-cli when webpack is false', () => {
+    const noWebpack = Object.assign({}, defaultOptions);
+    noWebpack.webpack = false;
+    const tree = schematicRunner.runSchematic('ng-add', noWebpack, appTree);
+    const filePath = '/package.json';
+    const contents = tree.readContent(filePath);
+    expect(contents).not.toContain('webpack-cli');
+  });
+
+  it('should install npm dependencies', () => {
+    schematicRunner.runSchematic('ng-add', defaultOptions, appTree);
+    expect(schematicRunner.tasks.length).toBe(2);
+    expect(schematicRunner.tasks[0].name).toBe('node-package');
+    expect((schematicRunner.tasks[0].options as {command: string}).command).toBe('install');
+  });
+
+  it('should not add Universal files', () => {
+    const noUniversal = Object.assign({}, defaultOptions);
+    noUniversal.skipUniversal = true;
+
+    const tree = schematicRunner.runSchematic('ng-add', noUniversal, appTree);
+    const filePath = '/src/server.main.ts';
+    const contents = tree.readContent(filePath);
+    expect(contents).toMatch('');
+  });
+});
diff --git a/modules/hapi-engine/schematics/install/index.ts b/modules/hapi-engine/schematics/install/index.ts
diff --git a/modules/hapi-engine/schematics/install/schema.json b/modules/hapi-engine/schematics/install/schema.json
diff --git a/modules/hapi-engine/schematics/install/schema.ts b/modules/hapi-engine/schematics/install/schema.ts
diff --git a/modules/hapi-engine/schematics/testing/test-app.ts b/modules/hapi-engine/schematics/testing/test-app.ts
diff --git a/modules/hapi-engine/schematics/tsconfig.json b/modules/hapi-engine/schematics/tsconfig.json
