Fix handling files with non-Ascii characters by sending a TextDocumentIdentifier for dynamic file requests/responses

Author: Andrew Hall

src/lsptoolshost/roslynLanguageServer.ts

@@ -66,6 +66,8 @@ import { getComponentPaths } from './builtInComponents';
 import { OnAutoInsertFeature } from './onAutoInsertFeature';
 import { registerLanguageStatusItems } from './languageStatusBar';
 import { ProjectContextService } from './services/projectContextService';
+import { ProvideDynamicFileResponse } from '../razor/src/dynamicFile/provideDynamicFileResponse';
+import { ProvideDynamicFileParams } from '../razor/src/dynamicFile/provideDynamicFileParams';
 
 let _channel: vscode.OutputChannel;
 let _traceChannel: vscode.OutputChannel;
@@ -730,11 +732,16 @@ export class RoslynLanguageServer {
         };
     }
 
+    private ProvideDyanmicFileInfoType: RequestType<ProvideDynamicFileParams, ProvideDynamicFileResponse, any> =
+        new RequestType(RoslynLanguageServer.provideRazorDynamicFileInfoMethodName);
+
     private registerDynamicFileInfo() {
         // When the Roslyn language server sends a request for Razor dynamic file info, we forward that request along to Razor via
         // a command.
-        this._languageClient.onRequest(RoslynLanguageServer.provideRazorDynamicFileInfoMethodName, async (request) =>
-            vscode.commands.executeCommand(DynamicFileInfoHandler.provideDynamicFileInfoCommand, request)
+        this._languageClient.onRequest<ProvideDynamicFileParams, ProvideDynamicFileResponse, any>(
+            this.ProvideDyanmicFileInfoType,
+            async (request) =>
+                vscode.commands.executeCommand(DynamicFileInfoHandler.provideDynamicFileInfoCommand, request)
         );
         this._languageClient.onNotification(
             RoslynLanguageServer.removeRazorDynamicFileInfoMethodName,

src/lsptoolshost/services/projectContextService.ts

@@ -85,10 +85,10 @@ export class ProjectContextService {
     private async getVirtualCSharpUri(uri: vscode.Uri): Promise<vscode.Uri | undefined> {
         const response = await vscode.commands.executeCommand<ProvideDynamicFileResponse>(
             DynamicFileInfoHandler.provideDynamicFileInfoCommand,
-            new ProvideDynamicFileParams([uri.fsPath])
+            new ProvideDynamicFileParams({ uri: UriConverter.serialize(uri) })
         );
 
-        const responseUri = response.generatedFiles[0];
+        const responseUri = response.csharpDocument?.uri;
         if (!responseUri) {
             return undefined;
         }

src/lsptoolshost/uriConverter.ts

@@ -24,6 +24,6 @@ export class UriConverter {
     }
 
     public static deserialize(value: string): vscode.Uri {
-        return vscode.Uri.parse(value);
+        return vscode.Uri.parse(value, true);
     }
 }

src/razor/src/dynamicFile/dynamicFileInfoHandler.ts

@@ -36,23 +36,21 @@ export class DynamicFileInfoHandler {
     }
 
     // Given Razor document URIs, returns associated generated doc URIs
-    private async provideDynamicFileInfo(request: ProvideDynamicFileParams): Promise<ProvideDynamicFileResponse> {
-        const uris = request.razorFiles;
-        const virtualUris = new Array<DocumentUri | null>();
+    private async provideDynamicFileInfo(
+        request: ProvideDynamicFileParams
+    ): Promise<ProvideDynamicFileResponse | null> {
+        let virtualUri: DocumentUri | null = null;
         try {
-            for (const razorDocumentPath of uris) {
-                const vscodeUri = vscode.Uri.file(razorDocumentPath);
-                const razorDocument = await this.documentManager.getDocument(vscodeUri);
-                if (razorDocument === undefined) {
-                    virtualUris.push(null);
-                    this.logger.logWarning(
-                        `Could not find Razor document ${razorDocumentPath}; adding null as a placeholder in URI array.`
-                    );
-                } else {
-                    // Retrieve generated doc URIs for each Razor URI we are given
-                    const virtualCsharpUri = UriConverter.serialize(razorDocument.csharpDocument.uri);
-                    virtualUris.push(virtualCsharpUri);
-                }
+            const vscodeUri = vscode.Uri.parse(request.razorDocument.uri, true);
+            const razorDocument = await this.documentManager.getDocument(vscodeUri);
+            if (razorDocument === undefined) {
+                this.logger.logWarning(
+                    `Could not find Razor document ${vscodeUri.fsPath}; adding null as a placeholder in URI array.`
+                );
+            } else {
+                // Retrieve generated doc URIs for each Razor URI we are given
+                const virtualCsharpUri = UriConverter.serialize(razorDocument.csharpDocument.uri);
+                virtualUri = virtualCsharpUri;
             }
 
             this.documentManager.roslynActivated = true;
@@ -64,17 +62,18 @@ export class DynamicFileInfoHandler {
             this.logger.logWarning(`${DynamicFileInfoHandler.provideDynamicFileInfoCommand} failed with ${error}`);
         }
 
-        return new ProvideDynamicFileResponse(virtualUris);
+        if (virtualUri) {
+            return new ProvideDynamicFileResponse({ uri: virtualUri });
+        }
+
+        return null;
     }
 
     private async removeDynamicFileInfo(request: RemoveDynamicFileParams) {
         try {
-            const uris = request.razorFiles;
-            for (const razorDocumentPath of uris) {
-                const vscodeUri = vscode.Uri.file(razorDocumentPath);
-                if (this.documentManager.isRazorDocumentOpenInCSharpWorkspace(vscodeUri)) {
-                    this.documentManager.didCloseRazorCSharpDocument(vscodeUri);
-                }
+            const vscodeUri = UriConverter.deserialize(request.csharpDocument.uri);
+            if (this.documentManager.isRazorDocumentOpenInCSharpWorkspace(vscodeUri)) {
+                this.documentManager.didCloseRazorCSharpDocument(vscodeUri);
             }
         } catch (error) {
             this.logger.logWarning(`${DynamicFileInfoHandler.removeDynamicFileInfoCommand} failed with ${error}`);

src/razor/src/dynamicFile/provideDynamicFileParams.ts

@@ -3,8 +3,9 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { DocumentUri } from 'vscode-languageclient/node';
+import { TextDocumentIdentifier } from 'vscode-languageserver-protocol';
 
+// matches https://github.com/dotnet/roslyn/blob/9e91ca6590450e66e0041ee3135bbf044ac0687a/src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/RazorDynamicFileInfoProvider.cs#L22
 export class ProvideDynamicFileParams {
-    constructor(public readonly razorFiles: DocumentUri[]) {}
+    constructor(public readonly razorDocument: TextDocumentIdentifier) {}
 }

src/razor/src/dynamicFile/provideDynamicFileResponse.ts

@@ -3,8 +3,9 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { DocumentUri } from 'vscode-languageclient/node';
+import { TextDocumentIdentifier } from 'vscode-languageclient/node';
 
+// matches https://github.com/dotnet/roslyn/blob/9e91ca6590450e66e0041ee3135bbf044ac0687a/src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/RazorDynamicFileInfoProvider.cs#L28
 export class ProvideDynamicFileResponse {
-    constructor(public readonly generatedFiles: (DocumentUri | null)[]) {}
+    constructor(public readonly csharpDocument: TextDocumentIdentifier | null) {}
 }

src/razor/src/dynamicFile/removeDynamicFileParams.ts

@@ -3,8 +3,9 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { DocumentUri } from 'vscode-languageclient/node';
+import { TextDocumentIdentifier } from 'vscode-languageclient/node';
 
+// matches https://github.com/dotnet/roslyn/blob/9e91ca6590450e66e0041ee3135bbf044ac0687a/src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/RazorDynamicFileInfoProvider.cs#L28
 export class RemoveDynamicFileParams {
-    constructor(public readonly razorFiles: DocumentUri[]) {}
+    constructor(public readonly csharpDocument: TextDocumentIdentifier) {}
 }