Include Roslyn devkit dependencies in C# extension to avoid versioning issues with devkit

Author: dibarbet

.gitignore

@@ -3,6 +3,7 @@ obj
 node_modules
 out
 .roslyn/
+.roslynDevkit/
 .omnisharp/
 .omnisharp-*/
 .vs/

.vscodeignore

@@ -2,6 +2,7 @@
 .logs/**
 .nyc_output/**
 !.roslyn/**
+!.roslynDevkit/**
 !.omnisharp/**
 !.razor/**
 !.razoromnisharp/**

package.json

@@ -37,7 +37,7 @@
     }
   },
   "defaults": {
-    "roslyn": "4.9.0-2.23566.1",
+    "roslyn": "4.9.0-2.23571.2",
     "omniSharp": "1.39.10",
     "razor": "7.0.0-preview.23528.1",
     "razorOmnisharp": "7.0.0-preview.23363.1",

src/lsptoolshost/roslynLanguageServer.ts

@@ -510,7 +510,7 @@ export class RoslynLanguageServer {
                 _channel.appendLine('Activating C# + C# Dev Kit...');
             }
 
-            const csharpDevkitArgs = await this.getCSharpDevkitExportArgs(csharpDevkitExtension);
+            const csharpDevkitArgs = this.getCSharpDevkitExportArgs();
             args = args.concat(csharpDevkitArgs);
 
             await this.setupDevKitEnvironment(env, csharpDevkitExtension);
@@ -756,24 +756,17 @@ export class RoslynLanguageServer {
         );
     }
 
-    private static async getCSharpDevkitExportArgs(
-        csharpDevkitExtension: vscode.Extension<CSharpDevKitExports>
-    ): Promise<string[]> {
-        const exports: CSharpDevKitExports = await csharpDevkitExtension.activate();
-
-        const extensionPaths = languageServerOptions.extensionsPaths || [
-            this.getLanguageServicesDevKitComponentPath(exports),
-        ];
-
+    private static getCSharpDevkitExportArgs(): string[] {
         const args: string[] = [];
 
-        args.push('--sharedDependencies');
-        args.push(exports.components['@microsoft/visualstudio-server-shared']);
-
-        for (const extensionPath of extensionPaths) {
-            args.push('--extension');
-            args.push(extensionPath);
-        }
+        const clientRoot = __dirname;
+        const devkitDepsPath = path.join(
+            clientRoot,
+            '..',
+            '.roslynDevkit',
+            'Microsoft.VisualStudio.LanguageServices.DevKit.dll'
+        );
+        args.push('--extension', devkitDepsPath);
 
         args.push('--sessionId', getSessionId());
         return args;
@@ -805,13 +798,6 @@ export class RoslynLanguageServer {
         await exports.setupTelemetryEnvironmentAsync(env);
     }
 
-    private static getLanguageServicesDevKitComponentPath(csharpDevKitExports: CSharpDevKitExports): string {
-        return path.join(
-            csharpDevKitExports.components['@microsoft/visualstudio-languageservices-devkit'],
-            'Microsoft.VisualStudio.LanguageServices.DevKit.dll'
-        );
-    }
-
     private static GetTraceLevel(logLevel: string): Trace {
         switch (logLevel) {
             case 'Trace':

tasks/offlinePackagingTasks.ts

@@ -23,6 +23,7 @@ import {
     languageServerDirectory,
     nugetTempPath,
     rootPath,
+    devkitDependenciesDirectory,
 } from '../tasks/projectPaths';
 import { getPackageJSON } from '../tasks/packageJson';
 import { createPackageAsync } from '../tasks/vsceTasks';
@@ -122,27 +123,46 @@ gulp.task(
         for (const p of platformSpecificPackages) {
             await acquireRoslyn(packageJSON, p.platformInfo, true);
         }
+
+        // Also pull in the Roslyn devkit dependencies nuget package.
+        await acquireRoslynDevkit(packageJSON, true);
     }, 'installDependencies')
 );
 
 // Install Tasks
 async function installRoslyn(packageJSON: any, platformInfo?: PlatformInformation) {
+    // Install the Roslyn language server bits.
     const { packagePath, serverPlatform } = await acquireRoslyn(packageJSON, platformInfo, false);
+    await installNuGetPackage(
+        packagePath,
+        path.join('content', 'LanguageServer', serverPlatform),
+        languageServerDirectory
+    );
+
+    // Install Roslyn Devkit dependencies.
+    const roslynDevkitPackagePath = await acquireRoslynDevkit(packageJSON, false);
+    await installNuGetPackage(roslynDevkitPackagePath, 'content', devkitDependenciesDirectory);
+}
 
-    // Get the directory containing the server executable for the current platform.
-    const serverExecutableDirectory = path.join(packagePath, 'content', 'LanguageServer', serverPlatform);
-    if (!fs.existsSync(serverExecutableDirectory)) {
-        throw new Error(`Failed to find server executable directory at ${serverExecutableDirectory}`);
+async function installNuGetPackage(pathToPackage: string, contentPath: string, outputPath: string) {
+    // Get the directory containing the content.
+    const contentDirectory = path.join(pathToPackage, contentPath);
+    if (!fs.existsSync(contentDirectory)) {
+        throw new Error(`Failed to find NuGet package content at ${contentDirectory}`);
     }
 
-    console.log(`Extracting Roslyn executables from ${serverExecutableDirectory}`);
+    const numFilesToCopy = fs.readdirSync(contentDirectory).length;
+
+    console.log(`Extracting content from ${contentDirectory}`);
 
     // Copy the files to the language server directory.
-    fs.mkdirSync(languageServerDirectory);
-    fsextra.copySync(serverExecutableDirectory, languageServerDirectory);
-    const languageServerDll = path.join(languageServerDirectory, 'Microsoft.CodeAnalysis.LanguageServer.dll');
-    if (!fs.existsSync(languageServerDll)) {
-        throw new Error(`Failed to copy server executable`);
+    fs.mkdirSync(outputPath);
+    fsextra.copySync(contentDirectory, outputPath);
+    const numCopiedFiles = fs.readdirSync(outputPath).length;
+
+    // Not expected to ever happen, just a simple sanity check.
+    if (numFilesToCopy !== numCopiedFiles) {
+        throw new Error('Failed to copy all files from NuGet package');
     }
 }
 
@@ -173,6 +193,16 @@ async function acquireRoslyn(
     return { packagePath, serverPlatform };
 }
 
+async function acquireRoslynDevkit(packageJSON: any, interactive: boolean): Promise<string> {
+    const roslynVersion = packageJSON.defaults.roslyn;
+    const packagePath = await acquireNugetPackage(
+        `Microsoft.VisualStudio.LanguageServices.Devkit`,
+        roslynVersion,
+        interactive
+    );
+    return packagePath;
+}
+
 async function installRazor(packageJSON: any, platformInfo: PlatformInformation) {
     if (platformInfo === undefined) {
         const platformNeutral = new PlatformInformation('neutral', 'neutral');
@@ -297,7 +327,14 @@ async function doPackageOffline(vsixPlatform: VSIXPlatformInfo | undefined) {
 }
 
 async function cleanAsync() {
-    await del(['install.*', '.omnisharp*', '.debugger', '.razor', languageServerDirectory]);
+    await del([
+        'install.*',
+        '.omnisharp*',
+        '.debugger',
+        '.razor',
+        languageServerDirectory,
+        devkitDependenciesDirectory,
+    ]);
 }
 
 async function buildVsix(

tasks/projectPaths.ts

@@ -15,6 +15,7 @@ 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 codeExtensionPath = commandLineOptions.codeExtensionPath || rootPath;