Merge pull request #880 from wjk/configurable-timeout

Add a setting to configure the server load timeout

Author: DustinCampbell

package.json

@@ -259,6 +259,11 @@
           "type": "boolean",
           "default": true,
           "description": "Specifies whether the OmniSharp server will be automatically started or not. If false, OmniSharp can be started with the 'Restart OmniSharp' command"
+        },
+        "omnisharp.projectLoadTimeout": {
+          "type": "number",
+          "default": 60,
+          "description": "The time Visual Studio Code will wait for the OmniSharp server to start. Time is expressed in seconds."
         }
       }
     },

src/omnisharp/options.ts

@@ -10,7 +10,8 @@ export class Options {
         public path?: string,
         public useMono?: boolean,
         public loggingLevel?: string,
-        public autoStart?: boolean) { }
+        public autoStart?: boolean,
+        public projectLoadTimeout?: number) { }
 
     public static Read(): Options {
         // Extra effort is taken below to ensure that legacy versions of options
@@ -33,6 +34,8 @@ export class Options {
         const loggingLevel = omnisharpConfig.get<string>('loggingLevel');
         const autoStart = omnisharpConfig.get<boolean>('autoStart', true);
 
-        return new Options(path, useMono, loggingLevel, autoStart);
+        const projectLoadTimeout = omnisharpConfig.get<number>('projectLoadTimeout', 60);
+
+        return new Options(path, useMono, loggingLevel, autoStart, projectLoadTimeout);
     }
 }

src/omnisharp/server.ts

@@ -82,6 +82,7 @@ export abstract class OmnisharpServer {
 
     protected _serverProcess: ChildProcess;
     protected _extraArgs: string[];
+    protected _options: Options;
 
     constructor(reporter: TelemetryReporter) {
         this._extraArgs = [];
@@ -240,9 +241,9 @@ export abstract class OmnisharpServer {
             '--encoding', 'utf-8'
         ];
 
-        const options = Options.Read();
+        this._options = Options.Read();
 
-        if (options.loggingLevel === 'verbose') {
+        if (this._options.loggingLevel === 'verbose') {
             args.push('-v');
         }
 
@@ -498,7 +499,6 @@ namespace WireProtocol {
 export class StdioOmnisharpServer extends OmnisharpServer {
 
     private static _seqPool = 1;
-    private static StartupTimeout = 1000 * 60;
 
     private _rl: ReadLine;
     private _activeRequest: { [seq: number]: { onSuccess: Function; onError: Function; } } = Object.create(null);
@@ -534,14 +534,17 @@ export class StdioOmnisharpServer extends OmnisharpServer {
         const p = new Promise<void>((resolve, reject) => {
             let listener: vscode.Disposable;
 
+            // Convert the timeout from the seconds to milliseconds, which is required by setTimeout().
+            const timeoutDuration = this._options.projectLoadTimeout * 1000
+
             // timeout logic
             const handle = setTimeout(() => {
                 if (listener) {
                     listener.dispose();
                 }
 
-                reject(new Error('Failed to start OmniSharp'));
-            }, StdioOmnisharpServer.StartupTimeout);
+                reject(new Error("OmniSharp server load timed out. Use the 'omnisharp.projectLoadTimeout' setting to override the default delay (one minute)."));
+            }, timeoutDuration);
 
             // handle started-event
             listener = this.onOmnisharpStart(() => {