perf: fine tune schematics to only commit changes (#1925)

Author: timdeschryver

modules/data/schematics-core/index.ts

@@ -33,6 +33,7 @@ export {
   ReplaceChange,
   createReplaceChange,
   createChangeRecorder,
+  commitChanges,
 } from './utility/change';
 
 export { AppConfig, getWorkspace, getWorkspacePath } from './utility/config';

modules/data/schematics-core/utility/ast-utils.ts

@@ -687,7 +687,7 @@ export function replaceImport(
     })
     .filter(({ hit }) => hit)
     .map(({ specifier, text }) =>
-      createReplaceChange(sourceFile, path, specifier!, text!, importToBe)
+      createReplaceChange(sourceFile, specifier!, text!, importToBe)
     );
 
   return changes;

modules/data/schematics-core/utility/change.ts

@@ -136,12 +136,16 @@ export class ReplaceChange implements Change {
 
 export function createReplaceChange(
   sourceFile: ts.SourceFile,
-  path: Path,
   node: ts.Node,
   oldText: string,
   newText: string
 ): ReplaceChange {
-  return new ReplaceChange(path, node.getStart(sourceFile), oldText, newText);
+  return new ReplaceChange(
+    sourceFile.fileName,
+    node.getStart(sourceFile),
+    oldText,
+    newText
+  );
 }
 
 export function createChangeRecorder(
@@ -162,3 +166,13 @@ export function createChangeRecorder(
   }
   return recorder;
 }
+
+export function commitChanges(tree: Tree, path: string, changes: Change[]) {
+  if (changes.length === 0) {
+    return false;
+  }
+
+  const recorder = createChangeRecorder(tree, path, changes);
+  tree.commitUpdate(recorder);
+  return true;
+}

modules/data/schematics-core/utility/visit-utils.ts

@@ -1,5 +1,5 @@
 import * as ts from 'typescript';
-import { Tree } from '@angular-devkit/schematics';
+import { Tree, DirEntry } from '@angular-devkit/schematics';
 
 export function visitTSSourceFiles<Result = void>(
   tree: Tree,
@@ -10,24 +10,35 @@ export function visitTSSourceFiles<Result = void>(
   ) => Result | undefined
 ): Result | undefined {
   let result: Result | undefined = undefined;
+  for (const sourceFile of visit(tree.root)) {
+    result = visitor(sourceFile, tree, result);
+  }
 
-  tree.visit(path => {
-    if (!path.endsWith('.ts')) {
-      return;
-    }
-
-    const sourceFile = ts.createSourceFile(
-      path,
-      tree.read(path)!.toString(),
-      ts.ScriptTarget.Latest
-    );
+  return result;
+}
 
-    if (sourceFile.isDeclarationFile) {
-      return;
+function* visit(directory: DirEntry): IterableIterator<ts.SourceFile> {
+  for (const path of directory.subfiles) {
+    if (path.endsWith('.ts') && !path.endsWith('.d.ts')) {
+      const entry = directory.file(path);
+      if (entry) {
+        const content = entry.content;
+        const source = ts.createSourceFile(
+          entry.path,
+          content.toString().replace(/^\uFEFF/, ''),
+          ts.ScriptTarget.Latest,
+          true
+        );
+        yield source;
+      }
     }
+  }
 
-    result = visitor(sourceFile, tree, result);
-  });
+  for (const path of directory.subdirs) {
+    if (path === 'node_modules') {
+      continue;
+    }
 
-  return result;
+    yield* visit(directory.dir(path));
+  }
 }

modules/data/schematics/ng-add/index.ts

@@ -22,7 +22,6 @@ import {
   createChangeRecorder,
 } from '@ngrx/data/schematics-core';
 import { Schema as EntityDataOptions } from './schema';
-import { Path } from '@angular-devkit/core';
 
 function addNgRxDataToPackageJson() {
   return (host: Tree, context: SchematicContext) => {
@@ -133,9 +132,9 @@ function renameNgrxDataModule(options: EntityDataOptions) {
       }
 
       const changes = [
-        ...findNgrxDataImports(sourceFile, path, ngrxDataImports),
-        ...findNgrxDataImportDeclarations(sourceFile, path, ngrxDataImports),
-        ...findNgrxDataReplacements(sourceFile, path),
+        ...findNgrxDataImports(sourceFile, ngrxDataImports),
+        ...findNgrxDataImportDeclarations(sourceFile, ngrxDataImports),
+        ...findNgrxDataReplacements(sourceFile),
       ];
 
       if (changes.length === 0) {
@@ -150,13 +149,11 @@ function renameNgrxDataModule(options: EntityDataOptions) {
 
 function findNgrxDataImports(
   sourceFile: ts.SourceFile,
-  path: Path,
   imports: ts.ImportDeclaration[]
 ) {
   const changes = imports.map(specifier =>
     createReplaceChange(
       sourceFile,
-      path,
       specifier.moduleSpecifier,
       "'ngrx-data'",
       "'@ngrx/data'"
@@ -168,7 +165,6 @@ function findNgrxDataImports(
 
 function findNgrxDataImportDeclarations(
   sourceFile: ts.SourceFile,
-  path: Path,
   imports: ts.ImportDeclaration[]
 ) {
   const changes = imports
@@ -198,7 +194,6 @@ function findNgrxDataImportDeclarations(
     .map(({ specifier, text }) =>
       createReplaceChange(
         sourceFile,
-        path,
         specifier!,
         text!,
         (renames as any)[text!]
@@ -208,7 +203,7 @@ function findNgrxDataImportDeclarations(
   return changes;
 }
 
-function findNgrxDataReplacements(sourceFile: ts.SourceFile, path: Path) {
+function findNgrxDataReplacements(sourceFile: ts.SourceFile) {
   const renameKeys = Object.keys(renames);
   let changes: ReplaceChange[] = [];
   ts.forEachChild(sourceFile, node => find(node, changes));
@@ -252,7 +247,6 @@ function findNgrxDataReplacements(sourceFile: ts.SourceFile, path: Path) {
       changes.push(
         createReplaceChange(
           sourceFile,
-          path,
           change.node,
           change.text,
           (renames as any)[change.text]

modules/data/tsconfig-build.json

@@ -11,6 +11,7 @@
     "noEmitOnError": false,
     "noImplicitAny": true,
     "noImplicitReturns": true,
+    "downlevelIteration": true,
     "outDir": "../../dist/packages/data",
     "paths": {
       "@ngrx/store": ["../../dist/packages/store"],

modules/effects/schematics-core/index.ts

@@ -33,6 +33,7 @@ export {
   ReplaceChange,
   createReplaceChange,
   createChangeRecorder,
+  commitChanges,
 } from './utility/change';
 
 export { AppConfig, getWorkspace, getWorkspacePath } from './utility/config';

modules/effects/schematics-core/utility/ast-utils.ts

@@ -687,7 +687,7 @@ export function replaceImport(
     })
     .filter(({ hit }) => hit)
     .map(({ specifier, text }) =>
-      createReplaceChange(sourceFile, path, specifier!, text!, importToBe)
+      createReplaceChange(sourceFile, specifier!, text!, importToBe)
     );
 
   return changes;

modules/effects/schematics-core/utility/change.ts

@@ -136,12 +136,16 @@ export class ReplaceChange implements Change {
 
 export function createReplaceChange(
   sourceFile: ts.SourceFile,
-  path: Path,
   node: ts.Node,
   oldText: string,
   newText: string
 ): ReplaceChange {
-  return new ReplaceChange(path, node.getStart(sourceFile), oldText, newText);
+  return new ReplaceChange(
+    sourceFile.fileName,
+    node.getStart(sourceFile),
+    oldText,
+    newText
+  );
 }
 
 export function createChangeRecorder(
@@ -162,3 +166,13 @@ export function createChangeRecorder(
   }
   return recorder;
 }
+
+export function commitChanges(tree: Tree, path: string, changes: Change[]) {
+  if (changes.length === 0) {
+    return false;
+  }
+
+  const recorder = createChangeRecorder(tree, path, changes);
+  tree.commitUpdate(recorder);
+  return true;
+}

modules/effects/schematics-core/utility/visit-utils.ts

@@ -1,5 +1,5 @@
 import * as ts from 'typescript';
-import { Tree } from '@angular-devkit/schematics';
+import { Tree, DirEntry } from '@angular-devkit/schematics';
 
 export function visitTSSourceFiles<Result = void>(
   tree: Tree,
@@ -10,24 +10,35 @@ export function visitTSSourceFiles<Result = void>(
   ) => Result | undefined
 ): Result | undefined {
   let result: Result | undefined = undefined;
+  for (const sourceFile of visit(tree.root)) {
+    result = visitor(sourceFile, tree, result);
+  }
 
-  tree.visit(path => {
-    if (!path.endsWith('.ts')) {
-      return;
-    }
-
-    const sourceFile = ts.createSourceFile(
-      path,
-      tree.read(path)!.toString(),
-      ts.ScriptTarget.Latest
-    );
+  return result;
+}
 
-    if (sourceFile.isDeclarationFile) {
-      return;
+function* visit(directory: DirEntry): IterableIterator<ts.SourceFile> {
+  for (const path of directory.subfiles) {
+    if (path.endsWith('.ts') && !path.endsWith('.d.ts')) {
+      const entry = directory.file(path);
+      if (entry) {
+        const content = entry.content;
+        const source = ts.createSourceFile(
+          entry.path,
+          content.toString().replace(/^\uFEFF/, ''),
+          ts.ScriptTarget.Latest,
+          true
+        );
+        yield source;
+      }
     }
+  }
 
-    result = visitor(sourceFile, tree, result);
-  });
+  for (const path of directory.subdirs) {
+    if (path === 'node_modules') {
+      continue;
+    }
 
-  return result;
+    yield* visit(directory.dir(path));
+  }
 }