refactor(@angular-devkit/build-angular): use plugin for file replacement

Author: clydin

packages/angular_devkit/build_angular/src/angular-cli-files/models/build-options.ts

@@ -10,7 +10,12 @@
 
 // tslint:disable-next-line:no-implicit-dependencies
 import * as ts from 'typescript';
-import { AssetPatternObject, Budget, ExtraEntryPoint } from '../../browser/schema';
+import {
+  AssetPatternObject,
+  Budget,
+  CurrentFileReplacement,
+  ExtraEntryPoint,
+} from '../../browser/schema';
 
 export interface BuildOptions {
   optimization: boolean;
@@ -58,6 +63,7 @@ export interface BuildOptions {
   stylePreprocessorOptions?: { includePaths: string[] };
   lazyModules: string[];
   platform?: 'browser' | 'server';
+  fileReplacements: CurrentFileReplacement[];
 }
 
 export interface WebpackTestOptions extends BuildOptions {

packages/angular_devkit/build_angular/src/angular-cli-files/models/webpack-configs/typescript.ts

@@ -7,7 +7,7 @@
  */
 // tslint:disable
 // TODO: cleanup this file, it's copied as is from Angular CLI.
-import { tags, virtualFs } from '@angular-devkit/core';
+import { virtualFs } from '@angular-devkit/core';
 import { Stats } from 'fs';
 import * as path from 'path';
 import {
@@ -62,6 +62,13 @@ function _createAotPlugin(
     }
   }
 
+  const hostReplacementPaths: { [replace: string]: string } = {};
+  if (buildOptions.fileReplacements) {
+    for (const replacement of buildOptions.fileReplacements) {
+      hostReplacementPaths[replacement.replace] = replacement.with;
+    }
+  }
+
   const pluginOptions: AngularCompilerPluginOptions = {
     mainPath: useMain ? path.join(root, buildOptions.main) : undefined,
     ...i18nFileAndFormat,
@@ -70,6 +77,7 @@ function _createAotPlugin(
     missingTranslation: buildOptions.i18nMissingTranslation,
     sourceMap: buildOptions.sourceMap,
     additionalLazyModules,
+    hostReplacementPaths,
     nameLazyFiles: buildOptions.namedChunks,
     forkTypeChecker: buildOptions.forkTypeChecker,
     contextElementDependencyConstructor: require('webpack/lib/dependencies/ContextElementDependency'),

packages/angular_devkit/build_angular/src/browser/index.ts

@@ -34,7 +34,7 @@ import {
   statsToString,
   statsWarningsToString,
 } from '../angular-cli-files/utilities/stats';
-import { addFileReplacements, normalizeAssetPatterns } from '../utils';
+import { normalizeAssetPatterns, normalizeFileReplacements } from '../utils';
 import { AssetPatternObject, BrowserBuilderSchema, CurrentFileReplacement } from './schema';
 const webpackMerge = require('webpack-merge');
 
@@ -64,7 +64,8 @@ export class BrowserBuilder implements Builder<BrowserBuilderSchema> {
       concatMap(() => options.deleteOutputPath
         ? this._deleteOutputDir(root, normalize(options.outputPath), this.context.host)
         : of(null)),
-      concatMap(() => addFileReplacements(root, host, options.fileReplacements)),
+      concatMap(() => normalizeFileReplacements(options.fileReplacements, host, root)),
+      tap(fileReplacements => options.fileReplacements = fileReplacements),
       concatMap(() => normalizeAssetPatterns(
         options.assets, host, root, projectRoot, builderConfig.sourceRoot)),
       // Replace the assets in options with the normalized version.

packages/angular_devkit/build_angular/src/dev-server/index.ts

@@ -25,7 +25,7 @@ import * as WebpackDevServer from 'webpack-dev-server';
 import { checkPort } from '../angular-cli-files/utilities/check-port';
 import { BrowserBuilder, NormalizedBrowserBuilderSchema, getBrowserLoggingCb } from '../browser/';
 import { BrowserBuilderSchema } from '../browser/schema';
-import { addFileReplacements, normalizeAssetPatterns } from '../utils';
+import { normalizeAssetPatterns, normalizeFileReplacements } from '../utils';
 const opn = require('opn');
 
 
@@ -78,7 +78,8 @@ export class DevServerBuilder implements Builder<DevServerBuilderOptions> {
       tap((port) => options.port = port),
       concatMap(() => this._getBrowserOptions(options)),
       tap((opts) => browserOptions = opts),
-      concatMap(() => addFileReplacements(root, host, browserOptions.fileReplacements)),
+      concatMap(() => normalizeFileReplacements(browserOptions.fileReplacements, host, root)),
+      tap(fileReplacements => browserOptions.fileReplacements = fileReplacements),
       concatMap(() => normalizeAssetPatterns(
         browserOptions.assets, host, root, projectRoot, builderConfig.sourceRoot)),
       // Replace the assets in options with the normalized version.

packages/angular_devkit/build_angular/src/karma/index.ts

@@ -27,7 +27,7 @@ import {
 import { readTsconfig } from '../angular-cli-files/utilities/read-tsconfig';
 import { requireProjectModule } from '../angular-cli-files/utilities/require-project-module';
 import { AssetPatternObject, CurrentFileReplacement } from '../browser/schema';
-import { addFileReplacements, normalizeAssetPatterns } from '../utils';
+import { normalizeAssetPatterns, normalizeFileReplacements } from '../utils';
 import { KarmaBuilderSchema } from './schema';
 const webpackMerge = require('webpack-merge');
 
@@ -47,7 +47,8 @@ export class KarmaBuilder implements Builder<KarmaBuilderSchema> {
     const host = new virtualFs.AliasHost(this.context.host as virtualFs.Host<fs.Stats>);
 
     return of(null).pipe(
-      concatMap(() => addFileReplacements(root, host, options.fileReplacements)),
+      concatMap(() => normalizeFileReplacements(options.fileReplacements, host, root)),
+      tap(fileReplacements => options.fileReplacements = fileReplacements),
       concatMap(() => normalizeAssetPatterns(
         options.assets, host, root, projectRoot, builderConfig.sourceRoot)),
       // Replace the assets in options with the normalized version.

packages/angular_devkit/build_angular/src/server/index.ts

@@ -16,7 +16,7 @@ import { WebpackBuilder } from '@angular-devkit/build-webpack';
 import { Path, getSystemPath, normalize, resolve, virtualFs } from '@angular-devkit/core';
 import { Stats } from 'fs';
 import { Observable, concat, of } from 'rxjs';
-import { concatMap, last } from 'rxjs/operators';
+import { concatMap, last, tap } from 'rxjs/operators';
 import * as ts from 'typescript'; // tslint:disable-line:no-implicit-dependencies
 import { WebpackConfigOptions } from '../angular-cli-files/models/build-options';
 import {
@@ -30,7 +30,7 @@ import {
 import { readTsconfig } from '../angular-cli-files/utilities/read-tsconfig';
 import { requireProjectModule } from '../angular-cli-files/utilities/require-project-module';
 import { getBrowserLoggingCb } from '../browser';
-import { addFileReplacements } from '../utils';
+import { normalizeFileReplacements } from '../utils';
 import { BuildWebpackServerSchema } from './schema';
 const webpackMerge = require('webpack-merge');
 
@@ -51,7 +51,8 @@ export class ServerBuilder implements Builder<BuildWebpackServerSchema> {
       concatMap(() => options.deleteOutputPath
         ? this._deleteOutputDir(root, normalize(options.outputPath), this.context.host)
         : of(null)),
-      concatMap(() => addFileReplacements(root, host, options.fileReplacements)),
+        concatMap(() => normalizeFileReplacements(options.fileReplacements, host, root)),
+        tap(fileReplacements => options.fileReplacements = fileReplacements),
       concatMap(() => {
         const webpackConfig = this.buildWebpackConfig(root, projectRoot, host, options);
 

packages/angular_devkit/build_angular/src/utils/add-file-replacements.ts

@@ -6,9 +6,16 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import { BaseException, Path, join, normalize, virtualFs } from '@angular-devkit/core';
-import { Observable, forkJoin, of } from 'rxjs';
-import { map, tap } from 'rxjs/operators';
+import {
+  BaseException,
+  Path,
+  getSystemPath,
+  join,
+  normalize,
+  virtualFs,
+} from '@angular-devkit/core';
+import { Observable, from, of } from 'rxjs';
+import { concat, concatMap, ignoreElements, map, mergeMap, tap, toArray } from 'rxjs/operators';
 import {
   CurrentFileReplacement,
   DeprecatedFileReplacment,
@@ -22,53 +29,64 @@ export class MissingFileReplacementException extends BaseException {
   }
 }
 
-// Note: This method changes the file replacements in place.
-export function addFileReplacements(
-  root: Path,
-  host: virtualFs.AliasHost,
-  fileReplacements: FileReplacement[],
-): Observable<null> {
+export interface NormalizedFileReplacement {
+  replace: Path;
+  with: Path;
+}
 
+export function normalizeFileReplacements(
+  fileReplacements: FileReplacement[],
+  host: virtualFs.Host,
+  root: Path,
+): Observable<NormalizedFileReplacement[]> {
   if (fileReplacements.length === 0) {
-    return of(null);
-  }
-
-  // Normalize the legacy format into the current one.
-  for (const fileReplacement of fileReplacements) {
-    const currentFormat = fileReplacement as CurrentFileReplacement;
-    const maybeOldFormat = fileReplacement as DeprecatedFileReplacment;
-
-    if (maybeOldFormat.src && maybeOldFormat.replaceWith) {
-      currentFormat.replace = maybeOldFormat.src;
-      currentFormat.with = maybeOldFormat.replaceWith;
-    }
+    return of([]);
   }
 
-  const normalizedFileReplacements = fileReplacements as CurrentFileReplacement[];
-
   // Ensure all the replacements exist.
-  const errorOnFalse = (path: string) => tap((exists: boolean) => {
+  const errorOnFalse = (path: Path) => tap((exists: boolean) => {
     if (!exists) {
-      throw new MissingFileReplacementException(path);
+      throw new MissingFileReplacementException(getSystemPath(path));
     }
   });
 
-  const existObservables = normalizedFileReplacements
-    .map(replacement => [
-      host.exists(join(root, replacement.replace)).pipe(errorOnFalse(replacement.replace)),
-      host.exists(join(root, replacement.with)).pipe(errorOnFalse(replacement.with)),
-    ])
-    .reduce((prev, curr) => prev.concat(curr), []);
-
-  return forkJoin(existObservables).pipe(
-    tap(() => {
-      normalizedFileReplacements.forEach(replacement => {
-        host.aliases.set(
-          join(root, normalize(replacement.replace)),
-          join(root, normalize(replacement.with)),
-        );
-      });
+  return from(fileReplacements).pipe(
+    map(replacement => normalizeFileReplacement(replacement, root)),
+    concatMap(normalized => {
+      return from([normalized.replace, normalized.with]).pipe(
+        mergeMap(path => host.exists(path).pipe(errorOnFalse(path))),
+        ignoreElements(),
+        concat(of(normalized)),
+      );
     }),
-    map(() => null),
+    toArray(),
   );
 }
+
+function normalizeFileReplacement(
+  fileReplacement: FileReplacement,
+  root?: Path,
+): NormalizedFileReplacement {
+  const currentFormat = fileReplacement as CurrentFileReplacement;
+  const maybeOldFormat = fileReplacement as DeprecatedFileReplacment;
+
+  let replacePath: Path;
+  let withPath: Path;
+  if (maybeOldFormat.src && maybeOldFormat.replaceWith) {
+    replacePath = normalize(maybeOldFormat.src);
+    withPath = normalize(maybeOldFormat.replaceWith);
+  } else {
+    replacePath = normalize(currentFormat.replace);
+    withPath = normalize(currentFormat.with);
+  }
+
+  // TODO: For 7.x should this only happen if not absolute?
+  if (root) {
+    replacePath = join(root, replacePath);
+  }
+  if (root) {
+    withPath = join(root, withPath);
+  }
+
+  return { replace: replacePath, with: withPath };
+}