Allow option overrides for components and export function to get component paths from extension

Author: dibarbet

package.json

@@ -42,7 +42,7 @@
     "razor": "7.0.0-preview.24178.4",
     "razorOmnisharp": "7.0.0-preview.23363.1",
     "razorTelemetry": "7.0.0-preview.24178.4",
-    "xamlDesignTools": "17.11.34810.23"
+    "xamlDesignTools": "17.11.34811.206"
   },
   "main": "./dist/extension",
   "l10n": "./l10n",
@@ -1622,6 +1622,21 @@
             "scope": "machine-overridable",
             "description": "%configuration.dotnet.server.path%"
           },
+          "dotnet.server.componentPaths": {
+            "type": "object",
+            "description": "%configuration.dotnet.server.componentPaths%",
+            "properties": {
+              "roslynDevKit": {
+                "description": "%configuration.dotnet.server.componentPaths.roslynDevKit%",
+                "type": "string"
+              },
+              "xamlDesignTools": {
+                "description": "%configuration.dotnet.server.componentPaths.xamlDesignTools%",
+                "type": "string"
+              }
+            },
+            "default": {}
+          },
           "dotnet.server.startTimeout": {
             "type": "number",
             "scope": "machine-overridable",

package.nls.json

@@ -26,6 +26,9 @@
   "configuration.dotnet.defaultSolution.description": "The path of the default solution to be opened in the workspace, or set to 'disable' to skip it. (Previously `omnisharp.defaultLaunchSolution`)",
   "configuration.dotnet.dotnetPath": "Specifies the path to a dotnet installation directory to use instead of the default system one. This only influences the dotnet installation to use for hosting the language server itself. Example: \"/home/username/mycustomdotnetdirectory\".",
   "configuration.dotnet.server.path": "Specifies the absolute path to the server (LSP or O#) executable. When left empty the version pinned to the C# Extension is used. (Previously `omnisharp.path`)",
+  "configuration.dotnet.server.componentPaths": "Allows overriding the folder path for built in components of the language server (for example, override the .roslynDevKit path in the extension directory to use locally built components)",
+  "configuration.dotnet.server.componentPaths.roslynDevKit": "Overrides the folder path for the .roslynDevKit component of the language server",
+  "configuration.dotnet.server.componentPaths.xamlDesignTools": "Overrides the folder path for the .xamlDesignTools component of the language server",
   "configuration.dotnet.server.startTimeout": "Specifies a timeout (in ms) for the client to successfully start and connect to the language server.",
   "configuration.dotnet.server.waitForDebugger": "Passes the --debug flag when launching the server to allow a debugger to be attached. (Previously `omnisharp.waitForDebugger`)",
   "configuration.dotnet.server.trace": "Sets the logging level for the language server",

src/csharpExtensionExports.ts

@@ -25,6 +25,7 @@ export interface CSharpExtensionExports {
     profferBrokeredServices: (container: GlobalBrokeredServiceContainer) => void;
     determineBrowserType: () => Promise<string | undefined>;
     experimental: CSharpExtensionExperimentalExports;
+    getComponentFolder: (componentName: string) => string;
 }
 
 export interface CSharpExtensionExperimentalExports {

src/lsptoolshost/builtInComponents.ts

@@ -0,0 +1,59 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as fs from 'fs';
+import * as path from 'path';
+import { LanguageServerOptions } from '../shared/options';
+
+interface ComponentInfo {
+    defaultFolderName: string;
+    optionName: string;
+    componentDllPaths: string[];
+}
+
+export const componentInfo: { [key: string]: ComponentInfo } = {
+    roslynDevKit: {
+        defaultFolderName: '.roslynDevKit',
+        optionName: 'roslynDevKit',
+        componentDllPaths: ['Microsoft.VisualStudio.LanguageServices.DevKit.dll'],
+    },
+    xamlDesignTools: {
+        defaultFolderName: '.xamlDesignTools',
+        optionName: 'xamlDesignTools',
+        componentDllPaths: [
+            path.join('lib', 'netstandard2.0', 'Microsoft.VisualStudio.DesignTools.CodeAnalysis.dll'),
+            path.join('lib', 'netstandard2.0', 'Microsoft.VisualStudio.DesignTools.CodeAnalysis.Diagnostics.dll'),
+        ],
+    },
+};
+
+export function getComponentPaths(componentName: string, options: LanguageServerOptions): string[] {
+    const component = componentInfo[componentName];
+    const baseFolder = getComponentFolderPath(component, options);
+    const paths = component.componentDllPaths.map((dllPath) => path.join(baseFolder, dllPath));
+    for (const dllPath of paths) {
+        if (!fs.existsSync(dllPath)) {
+            throw new Error(`Component DLL not found: ${dllPath}`);
+        }
+    }
+
+    return paths;
+}
+
+export function getComponentFolder(componentName: string, options: LanguageServerOptions): string {
+    const component = componentInfo[componentName];
+    return getComponentFolderPath(component, options);
+}
+
+function getComponentFolderPath(component: ComponentInfo, options: LanguageServerOptions): string {
+    if (options.componentPaths) {
+        const optionValue = options.componentPaths[component.optionName];
+        if (optionValue) {
+            return optionValue;
+        }
+    }
+
+    return path.join(__dirname, '..', component.defaultFolderName);
+}

src/lsptoolshost/roslynLanguageServer.ts

@@ -62,6 +62,7 @@ import { IDisposable } from '../disposable';
 import { registerNestedCodeActionCommands } from './nestedCodeAction';
 import { registerRestoreCommands } from './restore';
 import { BuildDiagnosticsService } from './buildDiagnosticsService';
+import { getComponentPaths } from './builtInComponents';
 
 let _channel: vscode.OutputChannel;
 let _traceChannel: vscode.OutputChannel;
@@ -809,24 +810,19 @@ export class RoslynLanguageServer {
     private static getCSharpDevKitExportArgs(additionalExtensionPaths: string[]): string[] {
         const args: string[] = [];
 
-        const clientRoot = __dirname;
-        const devKitDepsPath = path.join(
-            clientRoot,
-            '..',
-            '.roslynDevKit',
-            'Microsoft.VisualStudio.LanguageServices.DevKit.dll'
-        );
-        args.push('--devKitDependencyPath', devKitDepsPath);
+        const devKitDepsPath = getComponentPaths('roslynDevKit', languageServerOptions);
+        if (devKitDepsPath.length > 1) {
+            throw new Error('Expected only one devkit deps path');
+        }
+
+        args.push('--devKitDependencyPath', devKitDepsPath[0]);
 
         args.push('--sessionId', getSessionId());
 
         // Also include the Xaml Dev Kit extensions
-        const xamlBasePath = path.join(clientRoot, '..', '.xamlDesignTools', 'lib', 'netstandard2.0');
-        additionalExtensionPaths.push(path.join(xamlBasePath, 'Microsoft.VisualStudio.DesignTools.CodeAnalysis.dll'));
-        additionalExtensionPaths.push(
-            path.join(xamlBasePath, 'Microsoft.VisualStudio.DesignTools.CodeAnalysis.Diagnostics.dll')
+        getComponentPaths('xamlDesignTools', languageServerOptions).forEach((path) =>
+            additionalExtensionPaths.push(path)
         );
-
         return args;
     }
 

src/main.ts

@@ -56,9 +56,10 @@ import { RoslynLanguageServerEvents } from './lsptoolshost/languageServerEvents'
 import { ServerStateChange } from './lsptoolshost/serverStateChange';
 import { SolutionSnapshotProvider } from './lsptoolshost/services/solutionSnapshotProvider';
 import { RazorTelemetryDownloader } from './razor/razorTelemetryDownloader';
-import { commonOptions, omnisharpOptions, razorOptions } from './shared/options';
+import { commonOptions, languageServerOptions, omnisharpOptions, razorOptions } from './shared/options';
 import { BuildResultDiagnostics } from './lsptoolshost/services/buildResultReporterService';
 import { debugSessionTracker } from './coreclrDebug/provisionalDebugSessionTracker';
+import { getComponentFolder } from './lsptoolshost/builtInComponents';
 
 export async function activate(
     context: vscode.ExtensionContext
@@ -367,6 +368,9 @@ export async function activate(
                 sendServerRequest: async (t, p, ct) => await languageServerExport.sendRequest(t, p, ct),
                 languageServerEvents: roslynLanguageServerEvents,
             },
+            getComponentFolder: (componentName) => {
+                return getComponentFolder(componentName, languageServerOptions);
+            },
         };
     } else {
         return {

src/shared/options.ts

@@ -77,6 +77,7 @@ export interface LanguageServerOptions {
     readonly crashDumpPath: string | undefined;
     readonly analyzerDiagnosticScope: string;
     readonly compilerDiagnosticScope: string;
+    readonly componentPaths: { [key: string]: string } | null;
 }
 
 export interface RazorOptions {
@@ -397,6 +398,9 @@ class LanguageServerOptionsImpl implements LanguageServerOptions {
     public get compilerDiagnosticScope() {
         return readOption<string>('dotnet.backgroundAnalysis.compilerDiagnosticsScope', 'openFiles');
     }
+    public get componentPaths() {
+        return readOption<{ [key: string]: string }>('dotnet.server.componentPaths', {});
+    }
 }
 
 class RazorOptionsImpl implements RazorOptions {

tasks/projectPaths.ts

@@ -5,6 +5,7 @@
 
 import * as path from 'path';
 import { commandLineOptions } from './commandLineArguments';
+import { componentInfo } from '../src/lsptoolshost/builtInComponents';
 
 export const rootPath = path.resolve(__dirname, '..');
 
@@ -15,8 +16,8 @@ export const jestPath = path.join(nodeModulesPath, 'jest', 'bin', 'jest');
 export const packedVsixOutputRoot = commandLineOptions.outputFolder || path.join(rootPath, 'vsix');
 export const nugetTempPath = path.join(rootPath, 'out', '.nuget');
 export const languageServerDirectory = path.join(rootPath, '.roslyn');
-export const devKitDependenciesDirectory = path.join(rootPath, '.roslynDevKit');
-export const xamlDesignToolsDirectory = path.join(rootPath, '.xamlDesignTools');
+export const devKitDependenciesDirectory = path.join(rootPath, componentInfo.roslynDevKit.defaultFolderName);
+export const xamlDesignToolsDirectory = path.join(rootPath, componentInfo.xamlDesignTools.defaultFolderName);
 
 export const codeExtensionPath = commandLineOptions.codeExtensionPath || rootPath;