refactor: simply common add schematic

With this change, we don't export an actual schematic but rather we export a common rule.

This will simply schema changes as we don't have to keep 6 schemas in sync (json and ts)

Author: alan-agius4

modules/common/package.json

@@ -14,7 +14,6 @@
   "ng-update": {
     "packageGroup": "NG_UPDATE_PACKAGE_GROUP"
   },
-  "schematics": "./schematics/collection.json",
   "repository": {
     "type": "git",
     "url": "https://github.com/angular/universal"

modules/common/schematics/install/index.spec.ts renamed to modules/common/schematics/add/index.spec.ts

@@ -10,11 +10,12 @@ import {SchematicTestRunner} from '@angular-devkit/schematics/testing';
 
 import {collectionPath, createTestApp} from '../testing/test-app';
 
-import {Schema as UniversalOptions} from './schema';
+import {addUniversalCommonRule, AddUniversalOptions} from './index';
 
-describe('Universal Schematic', () => {
-  const defaultOptions: UniversalOptions = {
+describe('Add Schematic Rule', () => {
+  const defaultOptions: AddUniversalOptions = {
     clientProject: 'bar',
+    serverFileName: 'server.ts',
   };
 
   let schematicRunner: SchematicTestRunner;
@@ -27,9 +28,8 @@ describe('Universal Schematic', () => {
 
   it('should update angular.json', async () => {
     const tree = await schematicRunner
-      .runSchematicAsync('install', defaultOptions, appTree)
-      .toPromise();
-    const contents = JSON.parse(tree.readContent('angular.json'));
+      .callRule(addUniversalCommonRule(defaultOptions), appTree).toPromise();
+    const contents = JSON.parse(tree.read('angular.json')!.toString());
     const architect = contents.projects.bar.architect;
     expect(architect.build.configurations.production).toBeDefined();
     expect(architect.build.options.outputPath).toBe('dist/bar/browser');
@@ -43,26 +43,24 @@ describe('Universal Schematic', () => {
 
   it(`should update 'tsconfig.server.json' files with main file`, async () => {
     const tree = await schematicRunner
-      .runSchematicAsync('install', defaultOptions, appTree)
-      .toPromise();
+      .callRule(addUniversalCommonRule(defaultOptions), appTree).toPromise();
 
-    const contents = JSON.parse(tree.readContent('/projects/bar/tsconfig.server.json'));
+    const contents = JSON.parse(tree.read('/projects/bar/tsconfig.server.json')!.toString());
     expect(contents.files).toEqual([
       'src/main.server.ts',
       'server.ts',
     ]);
   });
 
   it(`should work when server target already exists`, async () => {
-    let tree = await schematicRunner
+    appTree = await schematicRunner
       .runExternalSchematicAsync('@schematics/angular', 'universal', defaultOptions, appTree)
       .toPromise();
 
-    tree = await schematicRunner
-      .runSchematicAsync('install', defaultOptions, tree)
-      .toPromise();
+    const tree = await schematicRunner
+      .callRule(addUniversalCommonRule(defaultOptions), appTree).toPromise();
 
-    const contents = JSON.parse(tree.readContent('/projects/bar/tsconfig.server.json'));
+    const contents = JSON.parse(tree.read('/projects/bar/tsconfig.server.json')!.toString());
     expect(contents.files).toEqual([
       'src/main.server.ts',
       'server.ts',

modules/common/schematics/install/index.ts renamed to modules/common/schematics/add/index.ts

@@ -18,10 +18,29 @@ import {
   findPropertyInAstObject,
   appendValueInAstArray,
 } from '@schematics/angular/utility/json-utils';
-import {Schema as UniversalOptions} from './schema';
-import {stripTsExtension, getDistPaths, getClientProject} from './utils';
+import {Schema as UniversalOptions} from '@schematics/angular/universal/schema';
+import {stripTsExtension, getDistPaths, getClientProject} from '../utils';
 
-function addScriptsRule(options: UniversalOptions): Rule {
+export interface AddUniversalOptions extends UniversalOptions {
+  serverFileName?: string;
+}
+
+export function addUniversalCommonRule(options: AddUniversalOptions): Rule {
+  return async host => {
+    const clientProject = await getClientProject(host, options.clientProject);
+
+    return chain([
+      clientProject.targets.has('server')
+        ? noop()
+        : externalSchematic('@schematics/angular', 'universal', options),
+      addScriptsRule(options),
+      updateServerTsConfigRule(options),
+      updateConfigFileRule(options),
+    ]);
+  };
+}
+
+function addScriptsRule(options: AddUniversalOptions): Rule {
   return async host => {
     const pkgPath = '/package.json';
     const buffer = host.read(pkgPath);
@@ -41,7 +60,7 @@ function addScriptsRule(options: UniversalOptions): Rule {
   };
 }
 
-function updateConfigFileRule(options: UniversalOptions): Rule {
+function updateConfigFileRule(options: AddUniversalOptions): Rule {
   return host => {
     return updateWorkspace((async workspace => {
       const clientProject = workspace.projects.get(options.clientProject);
@@ -77,7 +96,7 @@ function updateConfigFileRule(options: UniversalOptions): Rule {
   };
 }
 
-function updateServerTsConfigRule(options: UniversalOptions): Rule {
+function updateServerTsConfigRule(options: AddUniversalOptions): Rule {
   return async host => {
     const clientProject = await getClientProject(host, options.clientProject);
     const serverTarget = clientProject.targets.get('server');
@@ -117,18 +136,3 @@ function updateServerTsConfigRule(options: UniversalOptions): Rule {
     }
   };
 }
-
-export default function (options: UniversalOptions): Rule {
-  return async host => {
-    const clientProject = await getClientProject(host, options.clientProject);
-
-    return chain([
-      clientProject.targets.has('server')
-        ? noop()
-        : externalSchematic('@schematics/angular', 'universal', options),
-      addScriptsRule(options),
-      updateServerTsConfigRule(options),
-      updateConfigFileRule(options),
-    ]);
-  };
-}

modules/common/schematics/collection.json

@@ -11,8 +11,7 @@ import {Observable} from 'rxjs';
 import {switchMap} from 'rxjs/operators';
 
 /** Path to the collection file for the NgUniversal schematics */
-export const collectionPath =
-  require.resolve('nguniversal/modules/common/schematics/collection.json');
+export const collectionPath = require.resolve('@schematics/angular/collection.json');
 
 /** Create a base app used for testing. */
 export function createTestApp(appOptions = {}): Observable<UnitTestTree> {

modules/common/schematics/install/schema.json

@@ -0,0 +1,9 @@
+/**
+ * @license
+ * Copyright Google LLC 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
+ */
+
+export * from './utils';

modules/common/schematics/install/schema.ts

@@ -9,7 +9,6 @@ import {strings} from '@angular-devkit/core';
 import {
   apply,
   chain,
-  externalSchematic,
   mergeWith,
   Rule,
   SchematicContext,
@@ -28,7 +27,8 @@ import {
   getClientProject,
   stripTsExtension,
   getDistPaths,
-} from '@nguniversal/common/schematics/install/utils';
+} from '@nguniversal/common/schematics/utils';
+import {addUniversalCommonRule} from '@nguniversal/common/schematics/add';
 
 function addDependencies(options: UniversalOptions): Rule {
   return (host: Tree, context: SchematicContext) => {
@@ -69,14 +69,9 @@ export default function (options: UniversalOptions): Rule {
       move(clientProject.root)
     ]);
 
-    // Under bazel the collection needs to be resolved differently
-    const ngCommonUniversalCollection = process.env.BAZEL_TARGET
-      ? require.resolve('nguniversal/modules/common/schematics/npm_package/collection.json')
-      : '@nguniversal/common';
-
     return chain([
       mergeWith(rootSource),
-      externalSchematic(ngCommonUniversalCollection, 'install', options),
+      addUniversalCommonRule(options),
       addDependencies(options),
     ]);
   };