Add cohost option to Razor (#8189)

Author: davidwengier

package.json

@@ -1536,6 +1536,11 @@
             "type": "boolean",
             "default": true,
             "description": "%configuration.razor.languageServer.useNewFormattingEngine%"
+          },
+          "razor.languageServer.cohostingEnabled": {
+            "type": "boolean",
+            "default": false,
+            "description": "%configuration.razor.languageServer.cohostingEnabled%"
           }
         }
       },
@@ -5596,4 +5601,4 @@
       }
     }
   }
-}
+}

package.nls.json

@@ -131,6 +131,7 @@
   "configuration.razor.languageServer.forceRuntimeCodeGeneration": "(EXPERIMENTAL) Enable combined design time/runtime code generation for Razor files",
   "configuration.razor.languageServer.suppressLspErrorToasts": "Suppresses error toasts from showing up if the server encounters a recoverable error.",
   "configuration.razor.languageServer.useNewFormattingEngine": "Use the new Razor formatting engine.",
+  "configuration.razor.languageServer.cohostingEnabled": "(EXPERIMENTAL) Enable Razor cohosting.",
   "debuggers.coreclr.configurationSnippets.label.console-local": ".NET: Launch Executable file (Console)",
   "debuggers.coreclr.configurationSnippets.label.web-local": ".NET: Launch Executable file (Web)",
   "debuggers.coreclr.configurationSnippets.label.attach-local": ".NET: Attach to a .NET process",

src/lsptoolshost/server/roslynLanguageServer.ts

@@ -617,15 +617,23 @@ export class RoslynLanguageServer {
                 ? path.join(context.extension.extensionPath, '.razor')
                 : razorOptions.razorServerPath;
 
-        args.push('--razorSourceGenerator', path.join(razorPath, 'Microsoft.CodeAnalysis.Razor.Compiler.dll'));
+        let razorComponentPath = '';
+        getComponentPaths('razorExtension', languageServerOptions).forEach((extPath) => {
+            additionalExtensionPaths.push(extPath);
+            razorComponentPath = path.dirname(extPath);
+        });
+
+        // If cohosting is enabled we get the source generator from the razor component path
+        const razorSourceGeneratorPath = razorOptions.cohostingEnabled ? razorComponentPath : razorPath;
 
         args.push(
-            '--razorDesignTimePath',
-            path.join(razorPath, 'Targets', 'Microsoft.NET.Sdk.Razor.DesignTime.targets')
+            '--razorSourceGenerator',
+            path.join(razorSourceGeneratorPath, 'Microsoft.CodeAnalysis.Razor.Compiler.dll')
         );
 
-        getComponentPaths('razorExtension', languageServerOptions).forEach((path) =>
-            additionalExtensionPaths.push(path)
+        args.push(
+            '--razorDesignTimePath',
+            path.join(razorPath, 'Targets', 'Microsoft.NET.Sdk.Razor.DesignTime.targets')
         );
 
         // Get the brokered service pipe name from C# Dev Kit (if installed).

src/razor/src/document/razorDocumentManager.ts

@@ -33,7 +33,7 @@ export class RazorDocumentManager implements IRazorDocumentManager {
     public razorDocumentGenerationInitialized = false;
 
     constructor(
-        private readonly serverClient: RazorLanguageServerClient,
+        private readonly serverClient: RazorLanguageServerClient | undefined,
         private readonly logger: RazorLogger,
         private readonly telemetryReporter: TelemetryReporter,
         private readonly platformInfo: PlatformInformation
@@ -128,13 +128,16 @@ export class RazorDocumentManager implements IRazorDocumentManager {
 
             this.closeDocument(document.uri);
         });
-        this.serverClient.onNotification('razor/updateCSharpBuffer', async (updateBufferRequest) =>
-            this.updateCSharpBuffer(updateBufferRequest)
-        );
 
-        this.serverClient.onNotification('razor/updateHtmlBuffer', async (updateBufferRequest) =>
-            this.updateHtmlBuffer(updateBufferRequest)
-        );
+        if (this.serverClient !== undefined) {
+            this.serverClient.onNotification('razor/updateCSharpBuffer', async (updateBufferRequest) =>
+                this.updateCSharpBuffer(updateBufferRequest)
+            );
+
+            this.serverClient.onNotification('razor/updateHtmlBuffer', async (updateBufferRequest) =>
+                this.updateHtmlBuffer(updateBufferRequest)
+            );
+        }
 
         return vscode.Disposable.from(watcher, didCreateRegistration, didOpenRegistration, didCloseRegistration);
     }
@@ -163,6 +166,10 @@ export class RazorDocumentManager implements IRazorDocumentManager {
     }
 
     public async ensureRazorInitialized() {
+        if (this.serverClient === undefined) {
+            return;
+        }
+
         // Kick off the generation of all Razor documents so that components are
         // discovered correctly. We need to do this even if a Razor file isn't
         // open yet to handle the scenario where the user opens a C# file before

src/razor/src/extension.ts

@@ -78,6 +78,13 @@ export async function activate(
             logger
         );
 
+        if (razorOptions.cohostingEnabled) {
+            // TODO: We still need a document manager for Html, so need to do _some_ of the below, just not sure what yet,
+            // and it needs to be able to take a roslynLanguageServerClient instead of a razorLanguageServerClient I guess.
+
+            return;
+        }
+
         const hostExecutableResolver = new DotnetRuntimeExtensionResolver(
             platformInfo,
             () => razorOptions.serverPath,

src/razor/src/razorLanguageServerOptions.ts

@@ -13,4 +13,5 @@ export interface RazorLanguageServerOptions {
     forceRuntimeCodeGeneration: boolean;
     suppressErrorToasts: boolean;
     useNewFormattingEngine: boolean;
+    cohostingEnabled: boolean;
 }

src/razor/src/razorLanguageServerOptionsResolver.ts

@@ -37,6 +37,7 @@ export function resolveRazorLanguageServerOptions(
 
     const suppressErrorToasts = serverConfig.get<boolean>('suppressLspErrorToasts');
     const useNewFormattingEngine = serverConfig.get<boolean>('useNewFormattingEngine');
+    const cohostingEnabled = serverConfig.get<boolean>('cohostingEnabled');
 
     return {
         serverPath: languageServerExecutablePath,
@@ -46,6 +47,7 @@ export function resolveRazorLanguageServerOptions(
         forceRuntimeCodeGeneration,
         suppressErrorToasts,
         useNewFormattingEngine,
+        cohostingEnabled,
     } as RazorLanguageServerOptions;
 }
 

src/shared/options.ts

@@ -88,6 +88,7 @@ export interface RazorOptions {
     readonly razorDevMode: boolean;
     readonly razorPluginPath: string;
     readonly razorServerPath: string;
+    readonly cohostingEnabled: boolean;
 }
 
 class CommonOptionsImpl implements CommonOptions {
@@ -430,6 +431,9 @@ class RazorOptionsImpl implements RazorOptions {
     public get razorServerPath() {
         return readOption<string>('razor.languageServer.directory', '');
     }
+    public get cohostingEnabled() {
+        return readOption<boolean>('razor.languageServer.cohostingEnabled', false);
+    }
 }
 
 export const commonOptions: CommonOptions = new CommonOptionsImpl();