Make GetEditsForFileRenameRequestArgs not extend FileRequestArgs

Author: Andy Hanson

src/compiler/utilities.ts

@@ -7494,7 +7494,11 @@ namespace ts {
         }
     }
 
-        // Reserved characters, forces escaping of any non-word (or digit), non-whitespace character.
+    export function startsWithDirectory(path: string, dirPath: string): boolean {
+        return tryRemoveDirectoryPrefix(path, dirPath) !== undefined;
+    }
+
+    // Reserved characters, forces escaping of any non-word (or digit), non-whitespace character.
     // It may be inefficient (we could just match (/[-[\]{}()*+?.,\\^$|#\s]/g), but this is future
     // proof.
     const reservedCharacterPattern = /[^\w\s\/]/g;

src/server/editorServices.ts

@@ -692,17 +692,31 @@ namespace ts.server {
             return this.findExternalProjectByProjectName(projectName) || this.findConfiguredProjectByProjectName(toNormalizedPath(projectName));
         }
 
-        getDefaultProjectForFile(fileName: NormalizedPath, ensureProject: boolean): Project | undefined {
-            let scriptInfo = this.getScriptInfoForNormalizedPath(fileName);
-            if (ensureProject && (!scriptInfo || scriptInfo.isOrphan())) {
-                this.ensureProjectStructuresUptoDate();
-                scriptInfo = this.getScriptInfoForNormalizedPath(fileName);
-                if (!scriptInfo) {
-                    return Errors.ThrowNoProject();
+        getDefaultProjectForFile(fileName: NormalizedPath, ensureProject = false): Project | undefined {
+            const scriptInfo = this.getScriptInfoForNormalizedPath(fileName);
+            return scriptInfo && !scriptInfo.isOrphan() ? scriptInfo.getDefaultProject() : ensureProject ? this.doEnsureDefaultProjectForFile(fileName) : undefined;
+        }
+
+        ensureDefaultProjectForFile(fileName: NormalizedPath): Project {
+            return this.getDefaultProjectForFile(fileName) || this.doEnsureDefaultProjectForFile(fileName);
+        }
+
+        private doEnsureDefaultProjectForFile(fileName: NormalizedPath): Project {
+            this.ensureProjectStructuresUptoDate();
+            const scriptInfo = this.getScriptInfoForNormalizedPath(fileName);
+            return scriptInfo ? scriptInfo.getDefaultProject() : Errors.ThrowNoProject();
+        }
+
+        /* @internal */
+        tryGetSomeFileInDirectory(directoryPath: NormalizedPath): { readonly file: NormalizedPath, readonly project: Project } | undefined {
+            const scriptInfo = forEachEntry(this.filenameToScriptInfo, scriptInfo => {
+                if (startsWithDirectory(scriptInfo.path, directoryPath)) {
+                    return scriptInfo;
                 }
-                return scriptInfo.getDefaultProject();
-            }
-            return scriptInfo && !scriptInfo.isOrphan() ? scriptInfo.getDefaultProject() : undefined;
+            });
+            if (!scriptInfo) return undefined;
+            const file = toNormalizedPath(scriptInfo.path);
+            return { file, project: this.ensureDefaultProjectForFile(file) };
         }
 
         getScriptInfoEnsuringProjectsUptoDate(uncheckedFileName: string) {

src/server/protocol.ts

@@ -625,9 +625,8 @@ namespace ts.server.protocol {
         arguments: GetEditsForFileRenameRequestArgs;
     }
 
-    // Note: The file from FileRequestArgs is just any file in the project.
-    // We will generate code changes for every file in that project, so the choice is arbitrary.
-    export interface GetEditsForFileRenameRequestArgs extends FileRequestArgs {
+    /** Note: Paths may also be directories. */
+    export interface GetEditsForFileRenameRequestArgs {
         readonly oldFilePath: string;
         readonly newFilePath: string;
     }

src/server/session.ts

@@ -1142,15 +1142,27 @@ namespace ts.server {
             return this.getPosition(args, scriptInfo);
         }
 
-        private getFileAndProject(args: protocol.FileRequestArgs): { file: NormalizedPath, project: Project } {
+        private getFileAndProject(args: protocol.FileRequestArgs): FileAndProject {
             return this.getFileAndProjectWorker(args.file, args.projectFileName);
         }
 
+        private getFileAndProjectForFileRename(args: protocol.GetEditsForFileRenameRequestArgs): FileAndProject {
+            const oldFilePath = toNormalizedPath(args.oldFilePath);
+            const oldProject = this.projectService.getDefaultProjectForFile(oldFilePath);
+            if (oldProject) return { file: oldFilePath, project: oldProject };
+
+            const newFilePath = toNormalizedPath(args.newFilePath);
+            const newProject = this.projectService.getDefaultProjectForFile(newFilePath);
+            if (newProject) return { file: newFilePath, project: newProject };
+
+            return Debug.assertDefined(this.projectService.tryGetSomeFileInDirectory(oldFilePath) || this.projectService.tryGetSomeFileInDirectory(newFilePath));
+        }
+
         private getFileAndLanguageServiceForSyntacticOperation(args: protocol.FileRequestArgs) {
             // Since this is syntactic operation, there should always be project for the file
             // we wouldnt have to ensure project but rather throw if we dont get project
             const file = toNormalizedPath(args.file);
-            const project = this.getProject(args.projectFileName) || this.projectService.getDefaultProjectForFile(file, /*ensureProject*/ false);
+            const project = this.getProject(args.projectFileName) || this.projectService.getDefaultProjectForFile(file);
             if (!project) {
                 return Errors.ThrowNoProject();
             }
@@ -1162,7 +1174,7 @@ namespace ts.server {
 
         private getFileAndProjectWorker(uncheckedFileName: string, projectFileName: string | undefined): { file: NormalizedPath, project: Project } {
             const file = toNormalizedPath(uncheckedFileName);
-            const project = this.getProject(projectFileName) || this.projectService.getDefaultProjectForFile(file, /*ensureProject*/ true)!; // TODO: GH#18217
+            const project = this.getProject(projectFileName) || this.projectService.ensureDefaultProjectForFile(file);
             return { file, project };
         }
 
@@ -1454,7 +1466,7 @@ namespace ts.server {
         private createCheckList(fileNames: string[], defaultProject?: Project): PendingErrorCheck[] {
             return mapDefined<string, PendingErrorCheck>(fileNames, uncheckedFileName => {
                 const fileName = toNormalizedPath(uncheckedFileName);
-                const project = defaultProject || this.projectService.getDefaultProjectForFile(fileName, /*ensureProject*/ false);
+                const project = defaultProject || this.projectService.getDefaultProjectForFile(fileName);
                 return project && { fileName, project };
             });
         }
@@ -1731,7 +1743,7 @@ namespace ts.server {
         }
 
         private getEditsForFileRename(args: protocol.GetEditsForFileRenameRequestArgs, simplifiedResult: boolean): ReadonlyArray<protocol.FileCodeEdits> | ReadonlyArray<FileTextChanges> {
-            const { file, project } = this.getFileAndProject(args);
+            const { file, project } = this.getFileAndProjectForFileRename(args);
             const changes = project.getLanguageService().getEditsForFileRename(toNormalizedPath(args.oldFilePath), toNormalizedPath(args.newFilePath), this.getFormatOptions(file), this.getPreferences(file));
             return simplifiedResult ? this.mapTextChangesToCodeEdits(project, changes) : changes;
         }
@@ -1852,7 +1864,7 @@ namespace ts.server {
             const lowPriorityFiles: NormalizedPath[] = [];
             const veryLowPriorityFiles: NormalizedPath[] = [];
             const normalizedFileName = toNormalizedPath(fileName);
-            const project = this.projectService.getDefaultProjectForFile(normalizedFileName, /*ensureProject*/ true)!;
+            const project = this.projectService.ensureDefaultProjectForFile(normalizedFileName);
             for (const fileNameInProject of fileNamesInProject) {
                 if (this.getCanonicalFileName(fileNameInProject) === this.getCanonicalFileName(fileName)) {
                     highPriorityFiles.push(fileNameInProject);
@@ -2295,6 +2307,11 @@ namespace ts.server {
         }
     }
 
+    interface FileAndProject {
+        readonly file: NormalizedPath;
+        readonly project: Project;
+    }
+
     function mapTextChangesToCodeEdits(textChanges: FileTextChanges, sourceFile: SourceFile | undefined): protocol.FileCodeEdits {
         Debug.assert(!!textChanges.isNewFile === !sourceFile);
         if (sourceFile) {

src/testRunner/unittests/tsserverProjectSystem.ts

@@ -3097,7 +3097,7 @@ namespace ts.projectSystem {
             checkProjectRootFiles(project, [file.path]);
             checkProjectActualFiles(project, [file.path, libFile.path]);
 
-            assert.strictEqual(projectService.getDefaultProjectForFile(server.toNormalizedPath(file.path), /*ensureProject*/ true), project);
+            assert.strictEqual(projectService.ensureDefaultProjectForFile(server.toNormalizedPath(file.path)), project);
             const indexOfX = file.content.indexOf("x");
             assert.deepEqual(project.getLanguageService(/*ensureSynchronized*/ true).getQuickInfoAtPosition(file.path, indexOfX), {
                 kind: ScriptElementKind.variableElement,

tests/baselines/reference/api/tsserverlibrary.d.ts

@@ -7252,6 +7252,7 @@ declare namespace ts {
     function containsPath(parent: string, child: string, ignoreCase?: boolean): boolean;
     function containsPath(parent: string, child: string, currentDirectory: string, ignoreCase?: boolean): boolean;
     function tryRemoveDirectoryPrefix(path: string, dirPath: string): string | undefined;
+    function startsWithDirectory(path: string, dirPath: string): boolean;
     function hasExtension(fileName: string): boolean;
     const commonPackageFolders: ReadonlyArray<string>;
     function getRegularExpressionForWildcard(specs: ReadonlyArray<string> | undefined, basePath: string, usage: "files" | "directories" | "exclude"): string | undefined;
@@ -12437,7 +12438,7 @@ declare namespace ts.server.protocol {
         command: CommandTypes.GetEditsForFileRename;
         arguments: GetEditsForFileRenameRequestArgs;
     }
-    interface GetEditsForFileRenameRequestArgs extends FileRequestArgs {
+    interface GetEditsForFileRenameRequestArgs {
         readonly oldFilePath: string;
         readonly newFilePath: string;
     }
@@ -13800,7 +13801,13 @@ declare namespace ts.server {
         private delayUpdateProjectGraphs;
         setCompilerOptionsForInferredProjects(projectCompilerOptions: protocol.ExternalProjectCompilerOptions, projectRootPath?: string): void;
         findProject(projectName: string): Project | undefined;
-        getDefaultProjectForFile(fileName: NormalizedPath, ensureProject: boolean): Project | undefined;
+        getDefaultProjectForFile(fileName: NormalizedPath, ensureProject?: boolean): Project | undefined;
+        ensureDefaultProjectForFile(fileName: NormalizedPath): Project;
+        private doEnsureDefaultProjectForFile;
+        tryGetSomeFileInDirectory(directoryPath: NormalizedPath): {
+            readonly file: NormalizedPath;
+            readonly project: Project;
+        } | undefined;
         getScriptInfoEnsuringProjectsUptoDate(uncheckedFileName: string): ScriptInfo | undefined;
         private ensureProjectStructuresUptoDate;
         getFormatCodeOptions(file: NormalizedPath): FormatCodeSettings;
@@ -13988,6 +13995,7 @@ declare namespace ts.server {
         private getPosition;
         private getPositionInFile;
         private getFileAndProject;
+        private getFileAndProjectForFileRename;
         private getFileAndLanguageServiceForSyntacticOperation;
         private getFileAndProjectWorker;
         private getOutliningSpans;