Add checksum and encoding information to publish data

Author: Andrew Hall

src/razor/src/csharp/csharpProjectedDocument.ts

@@ -20,6 +20,9 @@ export class CSharpProjectedDocument implements IProjectedDocument {
     private ProvisionalDotPosition: Position | undefined;
     private hostDocumentVersion: number | null = null;
     private updates: Update[] | null = null;
+    private _checksum: Uint8Array = new Uint8Array();
+    private _checksumAlgorithm: number = 0;
+    private _encodingCodePage: number | null = null;
 
     public constructor(public readonly uri: vscode.Uri) {
         this.path = getUriPath(uri);
@@ -33,33 +36,55 @@ export class CSharpProjectedDocument implements IProjectedDocument {
         return this.content.length;
     }
 
+    public get checksum(): Uint8Array {
+        return this._checksum;
+    }
+
+    public get checksumAlgorithm(): number {
+        return this._checksumAlgorithm;
+    }
+
+    public get encodingCodePage(): number | null {
+        return this._encodingCodePage;
+    }
+
     public clear() {
         this.setContent('');
     }
 
-    public update(edits: ServerTextChange[], hostDocumentVersion: number) {
-        this.removeProvisionalDot();
-
-        // Apply any stored edits if needed
-        if (this.updates) {
-            for (const update of this.updates) {
-                this.updateContent(update.changes);
+    public update(
+        hostDocumentIsOpen: boolean,
+        edits: ServerTextChange[],
+        hostDocumentVersion: number,
+        checksum: Uint8Array,
+        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.updates = null;
+            this.updateContent(edits);
+        } else {
+            if (this.updates) {
+                this.updates = this.updates.concat(new Update(edits));
+            } else {
+                this.updates = [new Update(edits)];
+            }
         }
 
+        this._checksum = checksum;
+        this._checksumAlgorithm = checksumAlgorithm;
+        this._encodingCodePage = encodingCodePage;
         this.hostDocumentVersion = hostDocumentVersion;
-        this.updateContent(edits);
-    }
-
-    public storeEdits(edits: ServerTextChange[], hostDocumentVersion: number) {
-        this.hostDocumentVersion = hostDocumentVersion;
-        if (this.updates) {
-            this.updates = this.updates.concat(new Update(edits));
-        } else {
-            this.updates = [new Update(edits)];
-        }
     }
 
     public getAndApplyEdits() {

src/razor/src/document/razorDocumentManager.ts

@@ -258,17 +258,14 @@ export class RazorDocumentManager implements IRazorDocumentManager {
                 csharpProjectedDocument.clear();
             }
 
-            if (document.isOpen) {
-                // Make sure the document is open, because updating will cause a didChange event to fire.
-                await vscode.workspace.openTextDocument(document.csharpDocument.uri);
-
-                csharpProjectedDocument.update(updateBufferRequest.changes, updateBufferRequest.hostDocumentVersion);
-            } else {
-                csharpProjectedDocument.storeEdits(
-                    updateBufferRequest.changes,
-                    updateBufferRequest.hostDocumentVersion
-                );
-            }
+            csharpProjectedDocument.update(
+                document.isOpen,
+                updateBufferRequest.changes,
+                updateBufferRequest.hostDocumentVersion,
+                updateBufferRequest.checksum,
+                updateBufferRequest.checksumAlgorithm,
+                updateBufferRequest.encodingCodePage
+            );
 
             this.notifyDocumentChange(document, RazorDocumentChangeKind.csharpChanged);
         } else {
@@ -311,7 +308,13 @@ export class RazorDocumentManager implements IRazorDocumentManager {
                 htmlProjectedDocument.clear();
             }
 
-            htmlProjectedDocument.update(updateBufferRequest.changes, updateBufferRequest.hostDocumentVersion);
+            htmlProjectedDocument.update(
+                updateBufferRequest.changes,
+                updateBufferRequest.hostDocumentVersion,
+                updateBufferRequest.checksum,
+                updateBufferRequest.checksumAlgorithm,
+                updateBufferRequest.encodingCodePage
+            );
 
             this.notifyDocumentChange(document, RazorDocumentChangeKind.htmlChanged);
         } else {

src/razor/src/dynamicFile/dynamicFileInfoHandler.ts

@@ -75,14 +75,26 @@ export class DynamicFileInfoHandler {
             if (this.documentManager.isRazorDocumentOpenInCSharpWorkspace(vscodeUri)) {
                 // Open documents have didOpen/didChange to update the csharp buffer. Razor
                 // does not send edits and instead lets vscode handle them.
-                return new ProvideDynamicFileResponse({ uri: virtualCsharpUri }, null);
+                return new ProvideDynamicFileResponse(
+                    { uri: virtualCsharpUri },
+                    null,
+                    razorDocument.csharpDocument.checksum,
+                    razorDocument.csharpDocument.checksumAlgorithm,
+                    razorDocument.csharpDocument.encodingCodePage
+                );
             } else {
                 // Closed documents provide edits since the last time they were requested since
                 // there is no open buffer in vscode corresponding to the csharp content.
                 const csharpDocument = razorDocument.csharpDocument as CSharpProjectedDocument;
                 const edits = csharpDocument.getAndApplyEdits();
 
-                return new ProvideDynamicFileResponse({ uri: virtualCsharpUri }, edits ?? null);
+                return new ProvideDynamicFileResponse(
+                    { uri: virtualCsharpUri },
+                    edits ?? null,
+                    razorDocument.csharpDocument.checksum,
+                    razorDocument.csharpDocument.checksumAlgorithm,
+                    razorDocument.csharpDocument.encodingCodePage
+                );
             }
         } catch (error) {
             this.logger.logWarning(`${DynamicFileInfoHandler.provideDynamicFileInfoCommand} failed with ${error}`);

src/razor/src/dynamicFile/provideDynamicFileResponse.ts

@@ -10,6 +10,9 @@ import { ServerTextChange } from '../rpc/serverTextChange';
 export class ProvideDynamicFileResponse {
     constructor(
         public readonly csharpDocument: TextDocumentIdentifier | null,
-        public readonly edits: ServerTextChange[] | null
+        public readonly edits: ServerTextChange[] | null,
+        public readonly checksum: Uint8Array,
+        public readonly checksumAlgorithm: number,
+        public readonly encodingCodePage: number | null
     ) {}
 }

src/razor/src/html/htmlProjectedDocument.ts

@@ -12,6 +12,9 @@ export class HtmlProjectedDocument implements IProjectedDocument {
     public readonly path: string;
     private content = '';
     private hostDocumentVersion: number | null = null;
+    private _checksum: Uint8Array = new Uint8Array();
+    private _checksumAlgorithm: number = 0;
+    private _encodingCodePage: number | null = null;
 
     public constructor(public readonly uri: vscode.Uri) {
         this.path = getUriPath(uri);
@@ -29,7 +32,13 @@ export class HtmlProjectedDocument implements IProjectedDocument {
         this.setContent('');
     }
 
-    public update(edits: ServerTextChange[], hostDocumentVersion: number) {
+    public update(
+        edits: ServerTextChange[],
+        hostDocumentVersion: number,
+        checksum: Uint8Array,
+        checksumAlgorithm: number,
+        encodingCodePage: number | null
+    ) {
         this.hostDocumentVersion = hostDocumentVersion;
 
         if (edits.length === 0) {
@@ -43,12 +52,27 @@ export class HtmlProjectedDocument implements IProjectedDocument {
         }
 
         this.setContent(content);
+        this._checksum = checksum;
+        this._checksumAlgorithm = checksumAlgorithm;
+        this._encodingCodePage = encodingCodePage;
     }
 
     public getContent() {
         return this.content;
     }
 
+    public get checksum(): Uint8Array {
+        return this._checksum;
+    }
+
+    public get checksumAlgorithm(): number {
+        return this._checksumAlgorithm;
+    }
+
+    public get encodingCodePage(): number | null {
+        return this._encodingCodePage;
+    }
+
     private getEditedContent(newText: string, start: number, end: number, content: string) {
         const before = content.substr(0, start);
         const after = content.substr(end);

src/razor/src/projection/IProjectedDocument.ts

@@ -11,4 +11,7 @@ export interface IProjectedDocument {
     readonly hostDocumentSyncVersion: number | null;
     readonly length: number;
     getContent(): string;
+    checksum: Uint8Array;
+    checksumAlgorithm: number;
+    encodingCodePage: number | null;
 }

src/razor/src/rpc/updateBufferRequest.ts

@@ -10,6 +10,9 @@ export class UpdateBufferRequest {
         public readonly hostDocumentVersion: number,
         public readonly hostDocumentFilePath: string,
         public readonly changes: ServerTextChange[],
-        public readonly previousWasEmpty: boolean
+        public readonly previousWasEmpty: boolean,
+        public readonly checksum: Uint8Array,
+        public readonly checksumAlgorithm: number,
+        public readonly encodingCodePage: number | null
     ) {}
 }