Use binary search in file system cache (#50163)

* Use binary search in file system cache

Previously, we were linear searching a linear number of times, resulting in too many `toLowerCaseFileName` calls on Windows.

* Use SortedArray types for clarity

* Use insertSorted after making it return a flat

* Drop redundant undefined

* Correct copy-paste error

Author: amcasey

src/compiler/core.ts

@@ -778,19 +778,24 @@ namespace ts {
         return [] as any as SortedArray<T>; // TODO: GH#19873
     }
 
-    export function insertSorted<T>(array: SortedArray<T>, insert: T, compare: Comparer<T>, allowDuplicates?: boolean): void {
+    export function insertSorted<T>(array: SortedArray<T>, insert: T, compare: Comparer<T>, allowDuplicates?: boolean): boolean {
         if (array.length === 0) {
             array.push(insert);
-            return;
+            return true;
         }
 
         const insertIndex = binarySearch(array, insert, identity, compare);
         if (insertIndex < 0) {
             array.splice(~insertIndex, 0, insert);
+            return true;
         }
-        else if (allowDuplicates) {
+
+        if (allowDuplicates) {
             array.splice(insertIndex, 0, insert);
+            return true;
         }
+
+        return false;
     }
 
     export function sortAndDeduplicate<T>(array: readonly string[]): SortedReadonlyArray<string>;

src/compiler/watchUtilities.ts

@@ -34,9 +34,20 @@ namespace ts {
         clearCache(): void;
     }
 
+    type Canonicalized = string & { __canonicalized: void };
+
     interface MutableFileSystemEntries {
         readonly files: string[];
         readonly directories: string[];
+        sortedAndCanonicalizedFiles?: SortedArray<Canonicalized>
+        sortedAndCanonicalizedDirectories?: SortedArray<Canonicalized>
+    }
+
+    interface SortedAndCanonicalizedMutableFileSystemEntries {
+        readonly files: string[];
+        readonly directories: string[];
+        readonly sortedAndCanonicalizedFiles: SortedArray<Canonicalized>
+        readonly sortedAndCanonicalizedDirectories: SortedArray<Canonicalized>
     }
 
     export function createCachedDirectoryStructureHost(host: DirectoryStructureHost, currentDirectory: string, useCaseSensitiveFileNames: boolean): CachedDirectoryStructureHost | undefined {
@@ -45,7 +56,7 @@ namespace ts {
         }
 
         const cachedReadDirectoryResult = new Map<string, MutableFileSystemEntries | false>();
-        const getCanonicalFileName = createGetCanonicalFileName(useCaseSensitiveFileNames);
+        const getCanonicalFileName = createGetCanonicalFileName(useCaseSensitiveFileNames) as ((name: string) => Canonicalized);
         return {
             useCaseSensitiveFileNames,
             fileExists,
@@ -70,7 +81,17 @@ namespace ts {
         }
 
         function getCachedFileSystemEntriesForBaseDir(path: Path) {
-            return getCachedFileSystemEntries(getDirectoryPath(path));
+            const entries = getCachedFileSystemEntries(getDirectoryPath(path));
+            if (!entries) {
+                return entries;
+            }
+
+            // If we're looking for the base directory, we're definitely going to search the entries
+            if (!entries.sortedAndCanonicalizedFiles) {
+                entries.sortedAndCanonicalizedFiles = entries.files.map(getCanonicalFileName).sort() as SortedArray<Canonicalized>;
+                entries.sortedAndCanonicalizedDirectories = entries.directories.map(getCanonicalFileName).sort() as SortedArray<Canonicalized>;
+            }
+            return entries as SortedAndCanonicalizedMutableFileSystemEntries;
         }
 
         function getBaseNameOfFileName(fileName: string) {
@@ -120,23 +141,10 @@ namespace ts {
             }
         }
 
-        function fileNameEqual(name1: string, name2: string) {
-            return getCanonicalFileName(name1) === getCanonicalFileName(name2);
-        }
-
-        function hasEntry(entries: readonly string[], name: string) {
-            return some(entries, file => fileNameEqual(file, name));
-        }
-
-        function updateFileSystemEntry(entries: string[], baseName: string, isValid: boolean) {
-            if (hasEntry(entries, baseName)) {
-                if (!isValid) {
-                    return filterMutate(entries, entry => !fileNameEqual(entry, baseName));
-                }
-            }
-            else if (isValid) {
-                return entries.push(baseName);
-            }
+        function hasEntry(entries: SortedReadonlyArray<Canonicalized>, name: Canonicalized) {
+            // Case-sensitive comparison since already canonicalized
+            const index = binarySearch(entries, name, identity, compareStringsCaseSensitive);
+            return index >= 0;
         }
 
         function writeFile(fileName: string, data: string, writeByteOrderMark?: boolean): void {
@@ -151,7 +159,7 @@ namespace ts {
         function fileExists(fileName: string): boolean {
             const path = toPath(fileName);
             const result = getCachedFileSystemEntriesForBaseDir(path);
-            return result && hasEntry(result.files, getBaseNameOfFileName(fileName)) ||
+            return result && hasEntry(result.sortedAndCanonicalizedFiles, getCanonicalFileName(getBaseNameOfFileName(fileName))) ||
                 host.fileExists(fileName);
         }
 
@@ -163,9 +171,14 @@ namespace ts {
         function createDirectory(dirPath: string) {
             const path = toPath(dirPath);
             const result = getCachedFileSystemEntriesForBaseDir(path);
-            const baseFileName = getBaseNameOfFileName(dirPath);
             if (result) {
-                updateFileSystemEntry(result.directories, baseFileName, /*isValid*/ true);
+                const baseName = getBaseNameOfFileName(dirPath);
+                const canonicalizedBaseName = getCanonicalFileName(baseName);
+                const canonicalizedDirectories = result.sortedAndCanonicalizedDirectories;
+                // Case-sensitive comparison since already canonicalized
+                if (insertSorted(canonicalizedDirectories, canonicalizedBaseName, compareStringsCaseSensitive)) {
+                    result.directories.push(baseName);
+                }
             }
             host.createDirectory!(dirPath);
         }
@@ -242,7 +255,7 @@ namespace ts {
                 fileExists: host.fileExists(fileOrDirectoryPath),
                 directoryExists: host.directoryExists(fileOrDirectoryPath)
             };
-            if (fsQueryResult.directoryExists || hasEntry(parentResult.directories, baseName)) {
+            if (fsQueryResult.directoryExists || hasEntry(parentResult.sortedAndCanonicalizedDirectories, getCanonicalFileName(baseName))) {
                 // Folder added or removed, clear the cache instead of updating the folder and its structure
                 clearCache();
             }
@@ -265,8 +278,24 @@ namespace ts {
             }
         }
 
-        function updateFilesOfFileSystemEntry(parentResult: MutableFileSystemEntries, baseName: string, fileExists: boolean) {
-            updateFileSystemEntry(parentResult.files, baseName, fileExists);
+        function updateFilesOfFileSystemEntry(parentResult: SortedAndCanonicalizedMutableFileSystemEntries, baseName: string, fileExists: boolean): void {
+            const canonicalizedFiles = parentResult.sortedAndCanonicalizedFiles;
+            const canonicalizedBaseName = getCanonicalFileName(baseName);
+            if (fileExists) {
+                // Case-sensitive comparison since already canonicalized
+                if (insertSorted(canonicalizedFiles, canonicalizedBaseName, compareStringsCaseSensitive)) {
+                    parentResult.files.push(baseName);
+                }
+            }
+            else {
+                // Case-sensitive comparison since already canonicalized
+                const sortedIndex = binarySearch(canonicalizedFiles, canonicalizedBaseName, identity, compareStringsCaseSensitive);
+                if (sortedIndex >= 0) {
+                    canonicalizedFiles.splice(sortedIndex, 1);
+                    const unsortedIndex = parentResult.files.findIndex(entry => getCanonicalFileName(entry) === canonicalizedBaseName);
+                    parentResult.files.splice(unsortedIndex, 1);
+                }
+            }
         }
 
         function clearCache() {