Merge pull request #106 from DustinCampbell/download-omnisharp

Download and install OmniSharp during extension activation if necessary

Author: DustinCampbell

.gitignore

@@ -1,5 +1,6 @@
 bin
 node_modules
 out
+.omnisharp
 
 *.vsix

gulpfile.js

@@ -5,22 +5,17 @@
 
 'use strict';
 
-const decompress = require('gulp-decompress');
 const del = require('del');
-const fs = require('fs-extra-promise');
 const gulp = require('gulp');
-const path = require('path');
 const tslint = require('gulp-tslint');
-const omnisharpInstall = require('./out/omnisharpInstall');
+const omnisharpDownload = require('./out/omnisharpDownload');
 
 gulp.task('omnisharp:clean', () => {
-	return del('bin');
+	return del('.omnisharp');
 });
 
 gulp.task('omnisharp:fetch', ['omnisharp:clean'], () => {
-	return omnisharpInstall.downloadOmnisharp('v1.6.7.9')
-		.pipe(decompress({strip: 1}))
-		.pipe(gulp.dest('bin'));
+	return omnisharpDownload.downloadOmnisharp();
 });
 
 const allTypeScript = [
@@ -40,46 +35,13 @@ const lintReporter = (output, file, options) => {
 
 gulp.task('tslint', () => {
 	gulp.src(allTypeScript)
-	.pipe(tslint({
-		rulesDirectory: "node_modules/tslint-microsoft-contrib"
-	}))
-	.pipe(tslint.report(lintReporter, {
-		summarizeFailureOutput: false,
-		emitError: false
-	}))
+	    .pipe(tslint({
+            rulesDirectory: "node_modules/tslint-microsoft-contrib"
+        }))
+        .pipe(tslint.report(lintReporter, {
+            summarizeFailureOutput: false,
+            emitError: false
+        }))
 });
 
-gulp.task('omnisharp:fixscripts', ['omnisharp:fetch'], () => {
-
-	var _fixes = Object.create(null);
-	_fixes['./bin/omnisharp.cmd'] = '@"%~dp0packages\\dnx-clr-win-x86.1.0.0-beta4\\bin\\dnx.exe" "%~dp0packages\\OmniSharp\\1.0.0\\root" run %*';
-	_fixes['./bin/omnisharp'] = '#!/bin/bash\n'
-+ 'SOURCE="${BASH_SOURCE[0]}"\n'
-+ 'while [ -h "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink\n'
-+ 'DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"\n'
-+ 'SOURCE="$(readlink "$SOURCE")"\n'
-+ '[[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE" # if $SOURCE was a relative symlink, we need to resolve it relative to the path where the symlink file was located\n'
-+ 'done\n'
-+ 'DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"\n'
-+ 'export SET DNX_APPBASE="$DIR/packages/OmniSharp/1.0.0/root"\n'
-+ 'export PATH=/usr/local/bin:/Library/Frameworks/Mono.framework/Commands:$PATH # this is required for the users of the Homebrew Mono package\n'
-+ 'exec "$DIR/packages/dnx-mono.1.0.0-beta4/bin/dnx" "$DNX_APPBASE" run "$@"\n'
-+ '\n';
-
-	const promises = Object.keys(_fixes).map(key => {
-		return new Promise((resolve, reject) => {
-			fs.writeFile(path.join(__dirname, key), _fixes[key], err => {
-				if (err) {
-					reject(err);
-				}
-                else {
-					resolve();
-				}
-			});
-		});
-	});
-
-	return Promise.all(promises)
-});
-
-gulp.task('omnisharp', ['omnisharp:fixscripts']);
+gulp.task('omnisharp', ['omnisharp:fetch']);

package.json

@@ -15,22 +15,20 @@
   ],
   "main": "./out/omnisharpMain",
   "scripts": {
-    "postinstall": "tsc && gulp omnisharp"
+    "postinstall": "tsc"
   },
   "dependencies": {
+    "decompress": "^3.0.0",
     "del": "^2.0.2",
-    "event-stream": "^3.3.2",
     "fs-extra-promise": "^0.3.1",
     "github-releases": "^0.3.0",
     "run-in-terminal": "*",
     "semver": "*",
     "vscode-extension-telemetry": "0.0.4",
-    "tmp": "0.0.28",
-    "vinyl-fs": "^2.2.1"
+    "tmp": "0.0.28"
   },
   "devDependencies": {
-    "gulp": "^3.8.9",
-    "gulp-decompress": "^1.2.0",
+    "gulp": "^3.9.1",
     "gulp-tslint": "^4.3.0",
     "tslint": "^3.3.0",
     "tslint-microsoft-contrib": "^2.0.0",

src/omnisharpDownload.ts

@@ -0,0 +1,120 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+ 
+'use strict';
+
+import * as fs from 'fs-extra-promise';
+import * as path from 'path';
+import * as tmp from 'tmp';
+
+const Decompress = require('decompress');
+const Github = require('github-releases');
+
+const OmnisharpRepo = 'OmniSharp/omnisharp-roslyn';
+const OmnisharpVersion = 'v1.9-alpha3';
+const DefaultInstallLocation = path.join(__dirname, '../.omnisharp');
+
+tmp.setGracefulCleanup();
+
+function getOmnisharpAssetName(): string {
+    switch (process.platform) {
+        case 'win32':
+            return 'omnisharp-win-x64-dnx451.zip';
+        case 'darwin':
+            return 'omnisharp-osx-x64-dnxcore50.tar.gz';
+        case 'linux':
+            return 'omnisharp-linux-x64-dnxcore50.tar.gz';
+        default:
+            throw new Error(`Unsupported platform: ${process.platform}`);
+    }
+}
+
+export function downloadOmnisharp(): Promise<boolean> {
+    return new Promise<boolean>((resolve, reject) => {
+        console.log(`[OmniSharp]: Installing to ${DefaultInstallLocation}`);
+        
+        const repo = new Github({ repo: OmnisharpRepo, token: null });
+        const assetName = getOmnisharpAssetName();
+        
+        console.log(`[OmniSharp] Looking for ${OmnisharpVersion}, ${assetName}...`);
+        
+        repo.getReleases({ tag_name: OmnisharpVersion }, (err, releases) => {
+            if (err) {
+                return reject(err);
+            }
+            
+            if (!releases.length) {
+                return reject(new Error(`OmniSharp release ${OmnisharpVersion} not found.`));
+            }
+            
+            // Note: there should only be a single release, but use the first one
+            // if there are ever multiple results. Same thing for assets.
+            let foundAsset = null;
+            
+            for (var asset of releases[0].assets) {
+                if (asset.name === assetName) {
+                    foundAsset = asset;
+                    break;
+                }
+            }
+            
+            if (!foundAsset) {
+                return reject(new Error(`OmniSharp release ${OmnisharpVersion} asset, ${assetName} not found.`));
+            }
+            
+            console.log(`[OmniSharp] Found it!`);
+            
+            repo.downloadAsset(foundAsset, (err, inStream) => {
+                if (err) {
+                    return reject(err);
+                }
+                
+                tmp.file((err, tmpPath, fd, cleanupCallback) => {
+                    if (err) {
+                        return reject(err);
+                    }
+                    
+                    console.log(`[OmniSharp] Downloading to ${tmpPath}...`);
+                    
+                    const outStream = fs.createWriteStream(null, { fd: fd });
+                    
+                    outStream.once('error', err => reject(err));
+                    inStream.once('error', err => reject(err));
+                    
+                    outStream.once('finish', () => {
+                        // At this point, the asset has finished downloading.
+                        
+                        console.log(`[OmniSharp] Download complete!`);
+                        
+                        let decompress = new Decompress()
+                            .src(tmpPath)
+                            .dest(DefaultInstallLocation);
+                            
+                        if (path.extname(foundAsset.name).toLowerCase() === '.zip') {
+                            decompress = decompress.use(Decompress.zip());
+                            console.log(`[OmniSharp] Unzipping...`);
+                        }
+                        else {
+                            decompress = decompress.use(Decompress.targz());
+                            console.log(`[OmniSharp] Untaring...`);
+                        }
+
+                        decompress.run((err, files) => {
+                            if (err) {
+                                return reject(err);
+                            }
+                            
+                            console.log(`[OmniSharp] Done! ${files.length} files unpacked.`)
+                            
+                            return resolve(true);
+                        });
+                    });
+                    
+                    inStream.pipe(outStream);
+                });
+            });
+        });
+    });
+}

src/omnisharpInstall.ts

@@ -0,0 +1,69 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+ 
+'use strict';
+
+import * as fs from 'fs-extra-promise';
+import * as path from 'path';
+import * as vscode from 'vscode';
+
+const runFileName = process.platform === 'win32' ? 'run.cmd' : 'run';
+const omnisharpFileName = process.platform === 'win32' ? 'omnisharp.cmd' : 'omnisharp';
+const omnisharpExeFileName = process.platform === 'win32' ? 'omnisharp.exe' : 'omnisharp';
+
+function getLaunchFilePath(filePathOrFolder: string): Promise<string> {
+    return fs.lstatAsync(filePathOrFolder).then(stats => {
+        // If a file path was passed, assume its the launch file.
+        if (stats.isFile()) {
+            return filePathOrFolder;
+        }
+
+        // Otherwise, search the specified folder.
+        let candidate: string;
+        
+        candidate = path.join(filePathOrFolder, runFileName);
+        if (fs.existsSync(candidate)) {
+            return candidate;
+        }
+        
+        candidate = path.join(filePathOrFolder, omnisharpFileName);
+        if (fs.existsSync(candidate)) {
+            return candidate;
+        }
+        
+        candidate = path.join(filePathOrFolder, omnisharpExeFileName);
+        if (fs.existsSync(candidate)) {
+            return candidate;
+        }
+        
+        throw new Error(`Could not fnd launch file in ${filePathOrFolder}. Expected '${runFileName}', '${omnisharpFileName}', '${omnisharpExeFileName}'`);
+    });
+}
+
+function getLaunchPathFromSettings(): Promise<string> {
+    const setting = vscode.workspace.getConfiguration('csharp').get<string>('omnisharp');
+    
+    if (setting) {
+        return getLaunchFilePath(setting)
+            .catch(err => {
+                vscode.window.showWarningMessage(`Invalid "csharp.omnisharp" use setting specified ('${setting}).`);
+                throw err;
+            })
+    }
+    
+    return Promise.reject<string>(new Error('OmniSharp use setting does not exists.'));
+}
+
+function getLaunchPathFromDefaultInstallFolder(): Promise<string> {
+    const installLocation = path.join(__dirname, '../.omnisharp');
+    return getLaunchFilePath(installLocation);
+}
+
+export function getOmnisharpLaunchFilePath(): Promise<string> {
+    // Attempt to find launch file path first from settings, and then from the default install location.
+    
+    return getLaunchPathFromSettings()
+        .catch(getLaunchPathFromDefaultInstallFolder);
+}