Don't open closed documents (#7826)

package.json

@@ -37,9 +37,9 @@
     }
   },
   "defaults": {
-    "roslyn": "4.13.0-3.24604.4",
+    "roslyn": "4.13.0-3.24605.12",
     "omniSharp": "1.39.11",
-    "razor": "9.0.0-preview.24569.4",
+    "razor": "9.0.0-preview.24605.1",
     "razorOmnisharp": "7.0.0-preview.23363.1",
     "xamlTools": "17.13.35606.23"
   },

src/lsptoolshost/roslynLanguageServer.ts

@@ -78,6 +78,7 @@ import {
 import { registerSourceGeneratedFilesContentProvider } from './sourceGeneratedFilesContentProvider';
 import { registerMiscellaneousFileNotifier } from './miscellaneousFileNotifier';
 import { TelemetryEventNames } from '../shared/telemetryEventNames';
+import { RazorDynamicFileChangedParams } from '../razor/src/dynamicFile/dynamicFileUpdatedParams';
 
 let _channel: vscode.LogOutputChannel;
 let _traceChannel: vscode.OutputChannel;
@@ -789,6 +790,11 @@ export class RoslynLanguageServer {
             async (notification) =>
                 vscode.commands.executeCommand(DynamicFileInfoHandler.removeDynamicFileInfoCommand, notification)
         );
+        vscode.commands.registerCommand(
+            DynamicFileInfoHandler.dynamicFileUpdatedCommand,
+            async (notification: RazorDynamicFileChangedParams) =>
+                this.sendNotification<RazorDynamicFileChangedParams>('razor/dynamicFileInfoChanged', notification)
+        );
     }
 
     // eslint-disable-next-line @typescript-eslint/promise-function-async

src/razor/src/csharp/csharpProjectedDocument.ts

@@ -19,6 +19,10 @@ export class CSharpProjectedDocument implements IProjectedDocument {
     private resolveProvisionalEditAt: number | undefined;
     private ProvisionalDotPosition: Position | undefined;
     private hostDocumentVersion: number | null = null;
+    private updates: CSharpDocumentUpdate[] | null = null;
+    private _checksum: string = '';
+    private _checksumAlgorithm: number = 1; // Default to Sha1
+    private _encodingCodePage: number | null = null;
 
     public constructor(public readonly uri: vscode.Uri) {
         this.path = getUriPath(uri);
@@ -36,22 +40,78 @@ export class CSharpProjectedDocument implements IProjectedDocument {
         this.setContent('');
     }
 
-    public update(edits: ServerTextChange[], hostDocumentVersion: number) {
-        this.removeProvisionalDot();
+    public get checksum(): string {
+        return this._checksum;
+    }
 
-        this.hostDocumentVersion = hostDocumentVersion;
+    public get checksumAlgorithm(): number {
+        return this._checksumAlgorithm;
+    }
 
-        if (edits.length === 0) {
-            return;
+    public get encodingCodePage(): number | null {
+        return this._encodingCodePage;
+    }
+
+    public update(
+        hostDocumentIsOpen: boolean,
+        edits: ServerTextChange[],
+        hostDocumentVersion: number,
+        checksum: string,
+        checksumAlgorithm: number,
+        encodingCodePage: number | null
+    ) {
+        if (hostDocumentIsOpen) {
+            this.removeProvisionalDot();
+
+            // Apply any stored edits if needed
+            if (this.updates) {
+                for (const update of this.updates) {
+                    this.updateContent(update.changes);
+                }
+
+                this.updates = null;
+            }
+
+            this.updateContent(edits);
+            this._checksum = checksum;
+            this._checksumAlgorithm = checksumAlgorithm;
+            this._encodingCodePage = encodingCodePage;
+        } else {
+            const update = new CSharpDocumentUpdate(edits, checksum, checksumAlgorithm, encodingCodePage);
+
+            if (this.updates) {
+                this.updates = this.updates.concat(update);
+            } else {
+                this.updates = [update];
+            }
         }
 
-        let content = this.content;
-        for (const edit of edits.reverse()) {
-            // TODO: Use a better data structure to represent the content, string concatenation is slow.
-            content = this.getEditedContent(edit.newText, edit.span.start, edit.span.start + edit.span.length, content);
+        this.hostDocumentVersion = hostDocumentVersion;
+    }
+
+    public applyEdits(): ApplyEditsResponse {
+        const updates = this.updates;
+        this.updates = null;
+
+        const originalChecksum = this._checksum;
+        const originalChecksumAlgorithm = this._checksumAlgorithm;
+        const originalEncodingCodePage = this._encodingCodePage;
+
+        if (updates) {
+            for (const update of updates) {
+                this.updateContent(update.changes);
+                this._checksum = update.checksum;
+                this._checksumAlgorithm = update.checksumAlgorithm;
+                this._encodingCodePage = update.encodingCodePage;
+            }
         }
 
-        this.setContent(content);
+        return {
+            edits: updates,
+            originalChecksum: originalChecksum,
+            originalChecksumAlgorithm: originalChecksumAlgorithm,
+            originalEncodingCodePage: originalEncodingCodePage,
+        };
     }
 
     public getContent() {
@@ -140,8 +200,8 @@ export class CSharpProjectedDocument implements IProjectedDocument {
     }
 
     private getEditedContent(newText: string, start: number, end: number, content: string) {
-        const before = content.substr(0, start);
-        const after = content.substr(end);
+        const before = content.substring(0, start);
+        const after = content.substring(end);
         content = `${before}${newText}${after}`;
 
         return content;
@@ -150,4 +210,34 @@ export class CSharpProjectedDocument implements IProjectedDocument {
     private setContent(content: string) {
         this.content = content;
     }
+
+    private updateContent(edits: ServerTextChange[]) {
+        if (edits.length === 0) {
+            return;
+        }
+
+        let content = this.content;
+        for (const edit of edits.reverse()) {
+            // TODO: Use a better data structure to represent the content, string concatenation is slow.
+            content = this.getEditedContent(edit.newText, edit.span.start, edit.span.start + edit.span.length, content);
+        }
+
+        this.setContent(content);
+    }
+}
+
+export class CSharpDocumentUpdate {
+    constructor(
+        public readonly changes: ServerTextChange[],
+        public readonly checksum: string,
+        public readonly checksumAlgorithm: number,
+        public readonly encodingCodePage: number | null
+    ) {}
+}
+
+export interface ApplyEditsResponse {
+    edits: CSharpDocumentUpdate[] | null;
+    originalChecksum: string;
+    originalChecksumAlgorithm: number;
+    originalEncodingCodePage: number | null;
 }

src/razor/src/document/IRazorDocument.ts

@@ -11,4 +11,5 @@ export interface IRazorDocument {
     readonly uri: vscode.Uri;
     readonly csharpDocument: IProjectedDocument;
     readonly htmlDocument: IProjectedDocument;
+    readonly isOpen: boolean;
 }

src/razor/src/document/razorDocument.ts

@@ -0,0 +1,32 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as vscode from 'vscode';
+import { CSharpProjectedDocument } from '../csharp/csharpProjectedDocument';
+import { HtmlProjectedDocument } from '../html/htmlProjectedDocument';
+import { getUriPath } from '../uriPaths';
+import { IRazorDocument } from './IRazorDocument';
+
+export class RazorDocument implements IRazorDocument {
+    public readonly path: string;
+
+    constructor(
+        readonly uri: vscode.Uri,
+        readonly csharpDocument: CSharpProjectedDocument,
+        readonly htmlDocument: HtmlProjectedDocument
+    ) {
+        this.path = getUriPath(uri);
+    }
+
+    public get isOpen(): boolean {
+        for (const textDocument of vscode.workspace.textDocuments) {
+            if (textDocument.uri.fsPath == this.uri.fsPath) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

src/razor/src/document/razorDocumentFactory.ts

@@ -11,18 +11,12 @@ import { HtmlProjectedDocumentContentProvider } from '../html/htmlProjectedDocum
 import { virtualCSharpSuffix, virtualHtmlSuffix } from '../razorConventions';
 import { getUriPath } from '../uriPaths';
 import { IRazorDocument } from './IRazorDocument';
+import { RazorDocument } from './razorDocument';
 
-export function createDocument(uri: vscode.Uri) {
+export function createDocument(uri: vscode.Uri): IRazorDocument {
     const csharpDocument = createProjectedCSharpDocument(uri);
     const htmlDocument = createProjectedHtmlDocument(uri);
-    const path = getUriPath(uri);
-
-    const document: IRazorDocument = {
-        uri,
-        path,
-        csharpDocument,
-        htmlDocument,
-    };
+    const document = new RazorDocument(uri, csharpDocument, htmlDocument);
 
     return document;
 }

src/razor/src/document/razorDocumentManager.ts

@@ -50,21 +50,12 @@ export class RazorDocumentManager implements IRazorDocumentManager {
         return Object.values(this.razorDocuments);
     }
 
-    public async getDocument(uri: vscode.Uri) {
+    public async getDocument(uri: vscode.Uri): Promise<IRazorDocument> {
         const document = this._getDocument(uri);
-
-        // VS Code closes virtual documents after some timeout if they are not open in the IDE. Since our generated C# and Html
-        // documents are never open in the IDE, we need to ensure that VS Code considers them open so that requests against them
-        // succeed. Without this, even a simple diagnostics request will fail in Roslyn if the user just opens a .razor document
-        // and leaves it open past the timeout.
-        if (this.razorDocumentGenerationInitialized) {
-            await this.ensureDocumentAndProjectedDocumentsOpen(document);
-        }
-
         return document;
     }
 
-    public async getActiveDocument() {
+    public async getActiveDocument(): Promise<IRazorDocument | null> {
         if (!vscode.window.activeTextEditor) {
             return null;
         }
@@ -147,7 +138,7 @@ export class RazorDocumentManager implements IRazorDocumentManager {
         return vscode.Disposable.from(watcher, didCreateRegistration, didOpenRegistration, didCloseRegistration);
     }
 
-    private _getDocument(uri: vscode.Uri) {
+    private _getDocument(uri: vscode.Uri): IRazorDocument {
         const path = getUriPath(uri);
         let document = this.findDocument(path);
 
@@ -159,7 +150,7 @@ export class RazorDocumentManager implements IRazorDocumentManager {
             document = this.addDocument(uri);
         }
 
-        return document;
+        return document!;
     }
 
     private async openDocument(uri: vscode.Uri) {
@@ -182,10 +173,6 @@ export class RazorDocumentManager implements IRazorDocumentManager {
             await vscode.commands.executeCommand(razorInitializeCommand, pipeName);
             await this.serverClient.connectNamedPipe(pipeName);
 
-            for (const document of this.documents) {
-                await this.ensureDocumentAndProjectedDocumentsOpen(document);
-            }
-
             this.onRazorInitializedEmitter.fire();
         }
     }
@@ -205,7 +192,7 @@ export class RazorDocumentManager implements IRazorDocumentManager {
         this.notifyDocumentChange(document, RazorDocumentChangeKind.closed);
     }
 
-    private addDocument(uri: vscode.Uri) {
+    private addDocument(uri: vscode.Uri): IRazorDocument {
         const path = getUriPath(uri);
         let document = this.findDocument(path);
         if (document) {
@@ -261,10 +248,6 @@ export class RazorDocumentManager implements IRazorDocumentManager {
         ) {
             // We allow re-setting of the updated content from the same doc sync version in the case
             // of project or file import changes.
-
-            // Make sure the document is open, because updating will cause a didChange event to fire.
-            await vscode.workspace.openTextDocument(document.csharpDocument.uri);
-
             const csharpProjectedDocument = projectedDocument as CSharpProjectedDocument;
 
             // If the language server is telling us that the previous document was empty, then we should clear
@@ -275,7 +258,14 @@ export class RazorDocumentManager implements IRazorDocumentManager {
                 csharpProjectedDocument.clear();
             }
 
-            csharpProjectedDocument.update(updateBufferRequest.changes, updateBufferRequest.hostDocumentVersion);
+            csharpProjectedDocument.update(
+                document.isOpen,
+                updateBufferRequest.changes,
+                updateBufferRequest.hostDocumentVersion,
+                updateBufferRequest.checksum,
+                updateBufferRequest.checksumAlgorithm,
+                updateBufferRequest.encodingCodePage
+            );
 
             this.notifyDocumentChange(document, RazorDocumentChangeKind.csharpChanged);
         } else {
@@ -342,22 +332,4 @@ export class RazorDocumentManager implements IRazorDocumentManager {
 
         this.onChangeEmitter.fire(args);
     }
-
-    private async ensureDocumentAndProjectedDocumentsOpen(document: IRazorDocument) {
-        // vscode.workspace.openTextDocument may send a textDocument/didOpen
-        // request to the C# language server. We need to keep track of
-        // this to make sure we don't send a duplicate request later on.
-        const razorUri = vscode.Uri.file(document.path);
-        if (!this.isRazorDocumentOpenInCSharpWorkspace(razorUri)) {
-            this.didOpenRazorCSharpDocument(razorUri);
-
-            // Need to tell the Razor server that the document is open, or it won't generate C# code
-            // for it, and our projected document will always be empty, until the user manually
-            // opens the razor file.
-            await vscode.workspace.openTextDocument(razorUri);
-        }
-
-        await vscode.workspace.openTextDocument(document.csharpDocument.uri);
-        await vscode.workspace.openTextDocument(document.htmlDocument.uri);
-    }
 }