fix(compiler-cli): ensure casing of logical paths is preserved (#44798)

JoostK · thePunderWoman · commit 4a5ad1793f91 · 2022-02-02T00:04:38.000Z
The logical filesystem would store a cached result based on the canonical path, where the cached value contains the physical path that was originally provided. This meant that other physical paths with an identical canonical path would use a cached result derived from another physical path. This inconsistency is not known to result in actual issues but is primarily being made as a performance improvement, as using the provided physical paths as cache key avoids the need to canonicalize the path if its result is already cached. PR Close #44798
diff --git a/packages/compiler-cli/src/ngtsc/file_system/src/logical.ts b/packages/compiler-cli/src/ngtsc/file_system/src/logical.ts
@@ -83,9 +83,9 @@ export class LogicalFileSystem {
    * of the TS project's root directories.
    */
   logicalPathOfFile(physicalFile: AbsoluteFsPath): LogicalProjectPath|null {
-    const canonicalFilePath =
-        this.compilerHost.getCanonicalFileName(physicalFile) as AbsoluteFsPath;
-    if (!this.cache.has(canonicalFilePath)) {
+    if (!this.cache.has(physicalFile)) {
+      const canonicalFilePath =
+          this.compilerHost.getCanonicalFileName(physicalFile) as AbsoluteFsPath;
       let logicalFile: LogicalProjectPath|null = null;
       for (let i = 0; i < this.rootDirs.length; i++) {
         const rootDir = this.rootDirs[i];
@@ -102,9 +102,9 @@ export class LogicalFileSystem {
           }
         }
       }
-      this.cache.set(canonicalFilePath, logicalFile);
+      this.cache.set(physicalFile, logicalFile);
     }
-    return this.cache.get(canonicalFilePath)!;
+    return this.cache.get(physicalFile)!;
   }
 
   private createLogicalProjectPath(file: AbsoluteFsPath, rootDir: AbsoluteFsPath):
diff --git a/packages/compiler-cli/src/ngtsc/file_system/test/logical_spec.ts b/packages/compiler-cli/src/ngtsc/file_system/test/logical_spec.ts
@@ -57,6 +57,8 @@ runInEachFileSystem(() => {
         const fs = new LogicalFileSystem([_('/Test')], host);
         expect(fs.logicalPathOfFile(_('/Test/foo/Foo.ts')))
             .toEqual('/foo/Foo' as LogicalProjectPath);
+        expect(fs.logicalPathOfFile(_('/Test/foo/foo.ts')))
+            .toEqual('/foo/foo' as LogicalProjectPath);
         expect(fs.logicalPathOfFile(_('/Test/bar/bAR.ts')))
             .toEqual('/bar/bAR' as LogicalProjectPath);
       });

Original file line number	Diff line number	Diff line change
`@@ -83,9 +83,9 @@ export class LogicalFileSystem {`
`83`	`83`	`* of the TS project's root directories.`
`84`	`84`	`*/`
`85`	`85`	`logicalPathOfFile(physicalFile: AbsoluteFsPath): LogicalProjectPath\|null {`
`86`		`- const canonicalFilePath =`
`87`		`- this.compilerHost.getCanonicalFileName(physicalFile) as AbsoluteFsPath;`
`88`		`- if (!this.cache.has(canonicalFilePath)) {`
	`86`	`+ if (!this.cache.has(physicalFile)) {`
	`87`	`+ const canonicalFilePath =`
	`88`	`+ this.compilerHost.getCanonicalFileName(physicalFile) as AbsoluteFsPath;`
`89`	`89`	`let logicalFile: LogicalProjectPath\|null = null;`
`90`	`90`	`for (let i = 0; i < this.rootDirs.length; i++) {`
`91`	`91`	`const rootDir = this.rootDirs[i];`
`@@ -102,9 +102,9 @@ export class LogicalFileSystem {`
`102`	`102`	`}`
`103`	`103`	`}`
`104`	`104`	`}`
`105`		`- this.cache.set(canonicalFilePath, logicalFile);`
	`105`	`+ this.cache.set(physicalFile, logicalFile);`
`106`	`106`	`}`
`107`		`- return this.cache.get(canonicalFilePath)!;`
	`107`	`+ return this.cache.get(physicalFile)!;`
`108`	`108`	`}`
`109`	`109`
`110`	`110`	`private createLogicalProjectPath(file: AbsoluteFsPath, rootDir: AbsoluteFsPath):`