compiler_host.ts

/**
 * @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 { Path, getSystemPath, isAbsolute, join, normalize, virtualFs } from '@angular-devkit/core';
import { Stats } from 'fs';
import * as ts from 'typescript';
import { NgccProcessor } from './ngcc_processor';
import { WebpackResourceLoader } from './resource_loader';
import { forwardSlashPath, workaroundResolve } from './utils';

export interface OnErrorFn {
  (message: string): void;
}

const dev = Math.floor(Math.random() * 10000);

export class WebpackCompilerHost implements ts.CompilerHost {
  private _syncHost: virtualFs.SyncDelegateHost;
  private _innerMemoryHost: virtualFs.SimpleMemoryHost;
  private _memoryHost: virtualFs.SyncDelegateHost;
  private _changedFiles = new Set<string>();
  private _readResourceFiles = new Set<string>();
  private _basePath: Path;
  private _resourceLoader?: WebpackResourceLoader;
  private _sourceFileCache = new Map<string, ts.SourceFile>();
  private _virtualFileExtensions = [
    '.js',
    '.js.map',
    '.ngfactory.js',
    '.ngfactory.js.map',
    '.ngsummary.json',
  ];

  private _virtualStyleFileExtensions = [
    '.shim.ngstyle.js',
    '.shim.ngstyle.js.map',
  ];

  constructor(
    private _options: ts.CompilerOptions,
    basePath: string,
    host: virtualFs.Host,
    private readonly cacheSourceFiles: boolean,
    private readonly directTemplateLoading = false,
    private readonly ngccProcessor?: NgccProcessor,
    private readonly moduleResolutionCache?: ts.ModuleResolutionCache,
  ) {
    this._syncHost = new virtualFs.SyncDelegateHost(host);
    this._innerMemoryHost = new virtualFs.SimpleMemoryHost();
    this._memoryHost = new virtualFs.SyncDelegateHost(this._innerMemoryHost);
    this._basePath = normalize(basePath);
  }

  private get virtualFiles(): Path[] {
    return [...((this._memoryHost.delegate as {}) as { _cache: Map<Path, {}> })._cache.keys()];
  }

  reset() {
    this._innerMemoryHost.reset();
    this._changedFiles.clear();
    this._readResourceFiles.clear();
    this._sourceFileCache.clear();
    this._resourceLoader = undefined;
  }

  denormalizePath(path: string) {
    return getSystemPath(normalize(path));
  }

  resolve(path: string): Path {
    const p = normalize(path);
    if (isAbsolute(p)) {
      return p;
    } else {
      return join(this._basePath, p);
    }
  }

  resetChangedFileTracker() {
    this._changedFiles.clear();
  }

  getChangedFilePaths(): string[] {
    return [...this._changedFiles];
  }

  getNgFactoryPaths(): string[] {
    return (
      this.virtualFiles
        .filter(fileName => fileName.endsWith('.ngfactory.js') || fileName.endsWith('.ngstyle.js'))
        // These paths are used by the virtual file system decorator so we must denormalize them.
        .map(path => this.denormalizePath(path))
    );
  }

  invalidate(fileName: string): void {
    const fullPath = this.resolve(fileName);
    this._sourceFileCache.delete(fullPath);

    if (this.ngccProcessor) {
      // Delete the ngcc processor cache using the TS-format file names.
      this.ngccProcessor.invalidate(forwardSlashPath(fileName));
    }

    let exists = false;
    try {
      exists = this._syncHost.isFile(fullPath);
      if (exists) {
        this._changedFiles.add(workaroundResolve(fullPath));
      }
    } catch {}

    // File doesn't exist anymore and is not a factory, so we should delete the related
    // virtual files.
    if (
      !exists &&
      fullPath.endsWith('.ts') &&
      !(fullPath.endsWith('.ngfactory.ts') || fullPath.endsWith('.shim.ngstyle.ts'))
    ) {
      this._virtualFileExtensions.forEach(ext => {
        const virtualFile = (fullPath.slice(0, -3) + ext) as Path;
        if (this._memoryHost.exists(virtualFile)) {
          this._memoryHost.delete(virtualFile);
        }
      });
    }

    if (fullPath.endsWith('.ts')) {
      return;
    }

    // In case resolveJsonModule and allowJs we also need to remove virtual emitted files
    // both if they exists or not.
    if (
      (fullPath.endsWith('.js') || fullPath.endsWith('.json')) &&
      !/(\.(ngfactory|ngstyle)\.js|ngsummary\.json)$/.test(fullPath)
    ) {
      if (this._memoryHost.exists(fullPath)) {
        this._memoryHost.delete(fullPath);
      }

      return;
    }

    if (!exists) {
      // At this point we're only looking at resource files (html/css/scss/etc).
      // If the original was deleted, we should delete the virtual files too.
      // If the original wasn't deleted we should leave them to be overwritten, because webpack
      // might begin the loading process before our plugin has re-emitted them.
      for (const ext of this._virtualStyleFileExtensions) {
        const virtualFile = (fullPath + ext) as Path;
        if (this._memoryHost.exists(virtualFile)) {
          this._memoryHost.delete(virtualFile);
        }
      }
    }
  }

  fileExists(fileName: string, delegate = true): boolean {
    const p = this.resolve(fileName);

    if (this._memoryHost.isFile(p)) {
      return true;
    }

    if (!delegate) {
      return false;
    }

    let exists = false;
    try {
      exists = this._syncHost.isFile(p);
    } catch {}

    return exists;
  }

  readFile(fileName: string): string | undefined {
    const filePath = this.resolve(fileName);

    try {
      let content: ArrayBuffer;
      if (this._memoryHost.isFile(filePath)) {
        content = this._memoryHost.read(filePath);
      } else {
        content = this._syncHost.read(filePath);
      }

      // strip BOM
      return virtualFs.fileBufferToString(content).replace(/^\uFEFF/, '');
    } catch {
      return undefined;
    }
  }

  readFileBuffer(fileName: string): Buffer {
    const filePath = this.resolve(fileName);

    if (this._memoryHost.isFile(filePath)) {
      return Buffer.from(this._memoryHost.read(filePath));
    } else {
      const content = this._syncHost.read(filePath);

      return Buffer.from(content);
    }
  }

  private _makeStats(stats: virtualFs.Stats<Partial<Stats>>): Stats {
    return {
      isFile: () => stats.isFile(),
      isDirectory: () => stats.isDirectory(),
      isBlockDevice: () => (stats.isBlockDevice && stats.isBlockDevice()) || false,
      isCharacterDevice: () => (stats.isCharacterDevice && stats.isCharacterDevice()) || false,
      isFIFO: () => (stats.isFIFO && stats.isFIFO()) || false,
      isSymbolicLink: () => (stats.isSymbolicLink && stats.isSymbolicLink()) || false,
      isSocket: () => (stats.isSocket && stats.isSocket()) || false,
      dev: stats.dev === undefined ? dev : stats.dev,
      ino: stats.ino === undefined ? Math.floor(Math.random() * 100000) : stats.ino,
      mode: stats.mode === undefined ? parseInt('777', 8) : stats.mode,
      nlink: stats.nlink === undefined ? 1 : stats.nlink,
      uid: stats.uid || 0,
      gid: stats.gid || 0,
      rdev: stats.rdev || 0,
      size: stats.size,
      blksize: stats.blksize === undefined ? 512 : stats.blksize,
      blocks: stats.blocks === undefined ? Math.ceil(stats.size / 512) : stats.blocks,
      atime: stats.atime,
      atimeMs: stats.atime.getTime(),
      mtime: stats.mtime,
      mtimeMs: stats.mtime.getTime(),
      ctime: stats.ctime,
      ctimeMs: stats.ctime.getTime(),
      birthtime: stats.birthtime,
      birthtimeMs: stats.birthtime.getTime(),
    };
  }

  stat(path: string): Stats | null {
    const p = this.resolve(path);

    let stats: virtualFs.Stats<Partial<Stats>> | Stats | null = null;
    try {
      stats = this._memoryHost.stat(p) || this._syncHost.stat(p);
    } catch {}

    if (!stats) {
      return null;
    }

    if (stats instanceof Stats) {
      return stats;
    }

    return this._makeStats(stats);
  }

  directoryExists(directoryName: string): boolean {
    const p = this.resolve(directoryName);

    try {
      return this._memoryHost.isDirectory(p) || this._syncHost.isDirectory(p);
    } catch {
      return false;
    }
  }

  getDirectories(path: string): string[] {
    const p = this.resolve(path);

    let delegated: string[];
    try {
      delegated = this._syncHost.list(p).filter(x => {
        try {
          return this._syncHost.isDirectory(join(p, x));
        } catch {
          return false;
        }
      });
    } catch {
      delegated = [];
    }

    let memory: string[];
    try {
      memory = this._memoryHost.list(p).filter(x => {
        try {
          return this._memoryHost.isDirectory(join(p, x));
        } catch {
          return false;
        }
      });
    } catch {
      memory = [];
    }

    return [...new Set([...delegated, ...memory])];
  }

  getSourceFile(fileName: string, languageVersion: ts.ScriptTarget, onError?: OnErrorFn) {
    const p = this.resolve(fileName);

    try {
      const cached = this._sourceFileCache.get(p);
      if (cached) {
        return cached;
      }

      const content = this.readFile(fileName);
      if (content !== undefined) {
        const sf = ts.createSourceFile(workaroundResolve(fileName), content, languageVersion, true);

        if (this.cacheSourceFiles) {
          this._sourceFileCache.set(p, sf);
        }

        return sf;
      }
    } catch (e) {
      if (onError) {
        onError(e.message);
      }
    }

    return undefined;
  }

  getDefaultLibFileName(options: ts.CompilerOptions) {
    return ts.createCompilerHost(options).getDefaultLibFileName(options);
  }

  // This is due to typescript CompilerHost interface being weird on writeFile. This shuts down
  // typings in WebStorm.
  get writeFile() {
    return (
      fileName: string,
      data: string,
      _writeByteOrderMark: boolean,
      onError?: (message: string) => void,
      _sourceFiles?: ReadonlyArray<ts.SourceFile>,
    ): void => {
      const p = this.resolve(fileName);

      try {
        this._memoryHost.write(p, virtualFs.stringToFileBuffer(data));
      } catch (e) {
        if (onError) {
          onError(e.message);
        }
      }
    };
  }

  getCurrentDirectory(): string {
    return workaroundResolve(this._basePath);
  }

  getCanonicalFileName(fileName: string): string {
    const path = workaroundResolve(this.resolve(fileName));

    return this.useCaseSensitiveFileNames() ? path : path.toLowerCase();
  }

  useCaseSensitiveFileNames(): boolean {
    return !process.platform.startsWith('win32');
  }

  getNewLine(): string {
    return '\n';
  }

  setResourceLoader(resourceLoader: WebpackResourceLoader) {
    this._resourceLoader = resourceLoader;
  }

  readResource(fileName: string) {
    // These paths are meant to be used by the loader so we must denormalize them
    const denormalizedFileName = workaroundResolve(fileName);
    this._readResourceFiles.add(denormalizedFileName);

    if (this.directTemplateLoading && (fileName.endsWith('.html') || fileName.endsWith('.svg'))) {
      return this.readFile(fileName);
    }

    if (this._resourceLoader) {
      return this._resourceLoader.get(denormalizedFileName);
    } else {
      return this.readFile(fileName);
    }
  }

  getModifiedResourceFiles(): Set<string> {
    const modifiedFiles = new Set<string>();

    for (const changedFile of this._changedFiles) {
      const denormalizedFileName = workaroundResolve(changedFile);
      if (this._readResourceFiles.has(denormalizedFileName)) {
        modifiedFiles.add(denormalizedFileName);
      }

      if (!this._resourceLoader) {
        continue;
      }
      for (const resourcePath of this._resourceLoader.getAffectedResources(denormalizedFileName)) {
        modifiedFiles.add(resourcePath);
      }
    }

    return modifiedFiles;
  }

  trace(message: string) {
    // tslint:disable-next-line: no-console
    console.log(message);
  }

  resolveModuleNames(
    moduleNames: string[],
    containingFile: string,
  ): (ts.ResolvedModule | undefined)[] {
    return moduleNames.map(moduleName => {
      const { resolvedModule } = ts.resolveModuleName(
        moduleName,
        workaroundResolve(containingFile),
        this._options,
        this,
        this.moduleResolutionCache,
      );

      if (this._options.enableIvy && resolvedModule && this.ngccProcessor) {
        this.ngccProcessor.processModule(moduleName, resolvedModule);
      }

      return resolvedModule;
    });
  }

  resolveTypeReferenceDirectives(
    typeReferenceDirectiveNames: string[],
    containingFile: string,
    redirectedReference?: ts.ResolvedProjectReference,
  ): (ts.ResolvedTypeReferenceDirective | undefined)[] {
    return typeReferenceDirectiveNames.map(moduleName => {
      const { resolvedTypeReferenceDirective } = ts.resolveTypeReferenceDirective(
        moduleName,
        workaroundResolve(containingFile),
        this._options,
        this,
        redirectedReference,
      );

      if (this._options.enableIvy && resolvedTypeReferenceDirective && this.ngccProcessor) {
        this.ngccProcessor.processModule(moduleName, resolvedTypeReferenceDirective);
      }

      return resolvedTypeReferenceDirective;
    });
  }
}