Added code to clean up the temp directory that pyright creates when d…

…etermining whether the file system is case sensitive. This addresses #4142.
microsoft · Nov 5, 2022 · c5d1cfc · c5d1cfc
1 parent 5334197
commit c5d1cfc
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 5 deletions.
diff --git a/packages/pyright-internal/src/common/fileSystem.ts b/packages/pyright-internal/src/common/fileSystem.ts
@@ -53,6 +53,7 @@ export interface TmpfileOptions {
 export interface FileSystem {
     existsSync(path: string): boolean;
     mkdirSync(path: string, options?: MkDirOptions): void;
+    rmdirSync(path: string): void;
     chdir(path: string): void;
     readdirEntriesSync(path: string): fs.Dirent[];
     readdirSync(path: string): string[];

diff --git a/packages/pyright-internal/src/common/pathUtils.ts b/packages/pyright-internal/src/common/pathUtils.ts
@@ -940,15 +940,18 @@ export function isFileSystemCaseSensitive(fs: FileSystem) {
 }
 
 export function isFileSystemCaseSensitiveInternal(fs: FileSystem) {
-    let filePath: string | undefined = undefined;
+    let filePath: string | undefined;
+    let tempDirPath: string | undefined;
+
     try {
         // Make unique file name.
         let name: string;
         let mangledFilePath: string;
         do {
             name = `${randomBytesHex(21)}-a`;
-            filePath = path.join(fs.tmpdir(), name);
-            mangledFilePath = path.join(fs.tmpdir(), name.toUpperCase());
+            tempDirPath = fs.tmpdir();
+            filePath = path.join(tempDirPath, name);
+            mangledFilePath = path.join(tempDirPath, name.toUpperCase());
         } while (fs.existsSync(filePath) || fs.existsSync(mangledFilePath));
 
         fs.writeFileSync(filePath, '', 'utf8');
@@ -959,8 +962,21 @@ export function isFileSystemCaseSensitiveInternal(fs: FileSystem) {
         return false;
     } finally {
         if (filePath) {
-            // remove temp file created
-            fs.unlinkSync(filePath);
+            try {
+                // Remove temp file.
+                fs.unlinkSync(filePath);
+            } catch (e: any) {
+                // Ignore exception.
+            }
+        }
+
+        if (tempDirPath) {
+            try {
+                // Remove temp directory.
+                fs.rmdirSync(tempDirPath);
+            } catch (e: any) {
+                // Ignore exception.
+            }
         }
     }
 }

diff --git a/packages/pyright-internal/src/common/realFileSystem.ts b/packages/pyright-internal/src/common/realFileSystem.ts
@@ -222,6 +222,10 @@ class RealFileSystem implements FileSystem {
         yarnFS.mkdirSync(path, options);
     }
 
+    rmdirSync(path: string) {
+        yarnFS.rmdirSync(path);
+    }
+
     chdir(path: string) {
         process.chdir(path);
     }

diff --git a/packages/pyright-internal/src/pyrightFileSystem.ts b/packages/pyright-internal/src/pyrightFileSystem.ts
@@ -69,6 +69,10 @@ export class PyrightFileSystem
         this._realFS.mkdirSync(path, options);
     }
 
+    override rmdirSync(path: string): void {
+        this._realFS.rmdirSync(path);
+    }
+
     override chdir(path: string): void {
         this._realFS.chdir(path);
     }

diff --git a/packages/pyright-internal/src/readonlyAugmentedFileSystem.ts b/packages/pyright-internal/src/readonlyAugmentedFileSystem.ts
@@ -46,6 +46,10 @@ export class ReadOnlyAugmentedFileSystem implements FileSystem {
         throw new Error('Operation is not allowed.');
     }
 
+    rmdirSync(path: string): void {
+        throw new Error('Operation is not allowed.');
+    }
+
     chdir(path: string): void {
         throw new Error('Operation is not allowed.');
     }