Feature/autocomp options (#63)

* Enable IntelliSense settings * Fix up some bugs in the IntelliSense settings. * Code cleans for PR * Fix a couple exceptions that are breaks query execute and intellisense. * Add useLowerCase flag and settings tests
2026-02-05 17:24:59 -05:00 · 2016-09-25 12:53:28 -07:00
parent 27e092d370
commit 806220c4b5
8 changed files with 341 additions and 128 deletions
--- a/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/LanguageService.cs
+++ b/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/LanguageService.cs
@@ -185,19 +185,27 @@ namespace Microsoft.SqlTools.ServiceLayer.LanguageServices
            TextDocumentPosition textDocumentPosition,
            RequestContext<CompletionItem[]> requestContext)
        {
-            // get the current list of completion items and return to client 
-            var scriptFile = WorkspaceService<SqlToolsSettings>.Instance.Workspace.GetFile(
-                textDocumentPosition.TextDocument.Uri);
+            // check if Intellisense suggestions are enabled
+            if (!WorkspaceService<SqlToolsSettings>.Instance.CurrentSettings.IsSuggestionsEnabled)
+            {
+                await Task.FromResult(true);
+            }
+            else
+            {
+                // get the current list of completion items and return to client 
+                var scriptFile = WorkspaceService<SqlToolsSettings>.Instance.Workspace.GetFile(
+                    textDocumentPosition.TextDocument.Uri);

-            ConnectionInfo connInfo;
-            ConnectionService.Instance.TryFindConnection(
-                scriptFile.ClientFilePath, 
-                out connInfo);
+                ConnectionInfo connInfo;
+                ConnectionService.Instance.TryFindConnection(
+                    scriptFile.ClientFilePath, 
+                    out connInfo);

-            var completionItems = Instance.GetCompletionItems(
-                textDocumentPosition, scriptFile, connInfo);
+                var completionItems = Instance.GetCompletionItems(
+                    textDocumentPosition, scriptFile, connInfo);

-            await requestContext.SendResult(completionItems); 
+                await requestContext.SendResult(completionItems); 
+            }
        }

        /// <summary>
@@ -211,8 +219,16 @@ namespace Microsoft.SqlTools.ServiceLayer.LanguageServices
            CompletionItem completionItem,
            RequestContext<CompletionItem> requestContext)
        {
-            completionItem = LanguageService.Instance.ResolveCompletionItem(completionItem);
-            await requestContext.SendResult(completionItem); 
+            // check if Intellisense suggestions are enabled
+            if (!WorkspaceService<SqlToolsSettings>.Instance.CurrentSettings.IsSuggestionsEnabled)
+            {
+                await Task.FromResult(true);
+            }
+            else
+            {
+                completionItem = LanguageService.Instance.ResolveCompletionItem(completionItem);
+                await requestContext.SendResult(completionItem);
+            } 
        }

        private static async Task HandleDefinitionRequest(
@@ -264,7 +280,9 @@ namespace Microsoft.SqlTools.ServiceLayer.LanguageServices
            ScriptFile scriptFile, 
            EventContext eventContext)
        {
-            if (!IsPreviewWindow(scriptFile))
+            // if not in the preview window and diagnostics are enabled the run diagnostics
+            if (!IsPreviewWindow(scriptFile)
+                && WorkspaceService<SqlToolsSettings>.Instance.CurrentSettings.IsDiagnositicsEnabled)
            {
                await RunScriptDiagnostics( 
                    new ScriptFile[] { scriptFile },
@@ -278,13 +296,15 @@ namespace Microsoft.SqlTools.ServiceLayer.LanguageServices
        /// Handles text document change events 
        /// </summary> 
        /// <param name="textChangeParams"></param> 
-        /// <param name="eventContext"></param> 
-        /// <returns></returns> 
+        /// <param name="eventContext"></param>
        public async Task HandleDidChangeTextDocumentNotification(ScriptFile[] changedFiles, EventContext eventContext) 
        { 
-            await this.RunScriptDiagnostics( 
-                changedFiles.ToArray(), 
-                eventContext); 
+            if (WorkspaceService<SqlToolsSettings>.Instance.CurrentSettings.IsDiagnositicsEnabled)
+            {
+                await this.RunScriptDiagnostics( 
+                    changedFiles.ToArray(), 
+                    eventContext); 
+            }

            await Task.FromResult(true); 
        }
@@ -300,13 +320,19 @@ namespace Microsoft.SqlTools.ServiceLayer.LanguageServices
            SqlToolsSettings oldSettings, 
            EventContext eventContext)
        {
+            bool oldEnableIntelliSense = oldSettings.SqlTools.EnableIntellisense;
+            bool? oldEnableDiagnostics = oldSettings.SqlTools.IntelliSense.EnableDiagnostics;
+
+            // Update the settings in the current 
+            CurrentSettings.Update(newSettings);
+
            // If script analysis settings have changed we need to clear & possibly update the current diagnostic records.
-            bool oldScriptAnalysisEnabled = oldSettings.ScriptAnalysis.Enable.HasValue;
-            if ((oldScriptAnalysisEnabled != newSettings.ScriptAnalysis.Enable))
+            if (oldEnableIntelliSense != newSettings.SqlTools.EnableIntellisense
+                || oldEnableDiagnostics != newSettings.SqlTools.IntelliSense.EnableDiagnostics)
            {
                // If the user just turned off script analysis or changed the settings path, send a diagnostics
                // event to clear the analysis markers that they already have.
-                if (!newSettings.ScriptAnalysis.Enable.Value)
+                if (!newSettings.IsDiagnositicsEnabled)
                {
                    ScriptFileMarker[] emptyAnalysisDiagnostics = new ScriptFileMarker[0];

@@ -320,10 +346,6 @@ namespace Microsoft.SqlTools.ServiceLayer.LanguageServices
                    await this.RunScriptDiagnostics(CurrentWorkspace.GetOpenedFiles(), eventContext);
                }
            }
-
-            // Update the settings in the current 
-            CurrentSettings.EnableProfileLoading = newSettings.EnableProfileLoading;
-            CurrentSettings.ScriptAnalysis.Update(newSettings.ScriptAnalysis, CurrentWorkspace.WorkspacePath);
        }
        
        #endregion
@@ -408,40 +430,39 @@ namespace Microsoft.SqlTools.ServiceLayer.LanguageServices
        {
            await Task.Run( () => 
            {
-                if (ShouldEnableAutocomplete())
+                ScriptParseInfo scriptInfo = GetScriptParseInfo(info.OwnerUri, createIfNotExists: true);
+                if (scriptInfo.BuildingMetadataEvent.WaitOne(LanguageService.OnConnectionWaitTimeout))
                {
-                    ScriptParseInfo scriptInfo = GetScriptParseInfo(info.OwnerUri, createIfNotExists: true);
-                    if (scriptInfo.BuildingMetadataEvent.WaitOne(LanguageService.OnConnectionWaitTimeout))
+                    try
                    {
-                        try
-                        {
-                            scriptInfo.BuildingMetadataEvent.Reset();
-                            var sqlConn = info.SqlConnection as ReliableSqlConnection;
-                            if (sqlConn != null)
-                            {
-                                ServerConnection serverConn = new ServerConnection(sqlConn.GetUnderlyingConnection());
-                                scriptInfo.MetadataDisplayInfoProvider = new MetadataDisplayInfoProvider();
-                                scriptInfo.MetadataProvider = SmoMetadataProvider.CreateConnectedProvider(serverConn);
-                                scriptInfo.Binder = BinderProvider.CreateBinder(scriptInfo.MetadataProvider);                           
-                                scriptInfo.ServerConnection = new ServerConnection(sqlConn.GetUnderlyingConnection());
-                                scriptInfo.IsConnected = true;
-                            }
-                        }
-                        catch (Exception)
-                        {
-                            scriptInfo.IsConnected = false;
-                        }
-                        finally
-                        {
-                            // Set Metadata Build event to Signal state.
-                            // (Tell Language Service that I am ready with Metadata Provider Object)
-                            scriptInfo.BuildingMetadataEvent.Set();
-                        }
-                    }
+                        scriptInfo.BuildingMetadataEvent.Reset();

-                    // populate SMO metadata provider with most common info
-                    AutoCompleteHelper.PrepopulateCommonMetadata(info, scriptInfo);
+                        ReliableSqlConnection sqlConn = info.SqlConnection as ReliableSqlConnection;
+                        if (sqlConn != null)
+                        {
+                            ServerConnection serverConn = new ServerConnection(sqlConn.GetUnderlyingConnection());
+                            scriptInfo.MetadataDisplayInfoProvider = new MetadataDisplayInfoProvider();
+                            scriptInfo.MetadataProvider = SmoMetadataProvider.CreateConnectedProvider(serverConn);
+                            scriptInfo.Binder = BinderProvider.CreateBinder(scriptInfo.MetadataProvider);                           
+                            scriptInfo.ServerConnection = serverConn;
+                            scriptInfo.IsConnected = true;
+                        }
+                        
+                    }
+                    catch (Exception)
+                    {
+                        scriptInfo.IsConnected = false;
+                    }
+                    finally
+                    {
+                        // Set Metadata Build event to Signal state.
+                        // (Tell Language Service that I am ready with Metadata Provider Object)
+                        scriptInfo.BuildingMetadataEvent.Set();
+                    }
                }
+
+                // populate SMO metadata provider with most common info
+                AutoCompleteHelper.PrepopulateCommonMetadata(info, scriptInfo);
            });
        }

@@ -469,19 +490,29 @@ namespace Microsoft.SqlTools.ServiceLayer.LanguageServices
        /// <param name="completionItem"></param>
        internal CompletionItem ResolveCompletionItem(CompletionItem completionItem)
        {
-            var scriptParseInfo = LanguageService.Instance.currentCompletionParseInfo;
-            if (scriptParseInfo != null && scriptParseInfo.CurrentSuggestions != null)
+            try
            {
-                foreach (var suggestion in scriptParseInfo.CurrentSuggestions)
+                var scriptParseInfo = LanguageService.Instance.currentCompletionParseInfo;
+                if (scriptParseInfo != null && scriptParseInfo.CurrentSuggestions != null)
                {
-                    if (string.Equals(suggestion.Title, completionItem.Label))
+                    foreach (var suggestion in scriptParseInfo.CurrentSuggestions)
                    {
-                        completionItem.Detail = suggestion.DatabaseQualifiedName;
-                        completionItem.Documentation = suggestion.Description;
-                        break;
+                        if (string.Equals(suggestion.Title, completionItem.Label))
+                        {
+                            completionItem.Detail = suggestion.DatabaseQualifiedName;
+                            completionItem.Documentation = suggestion.Description;
+                            break;
+                        }
                    }
                }
            }
+            catch (Exception ex)
+            {
+                // if any exceptions are raised looking up extended completion metadata 
+                // then just return the original completion item
+                Logger.Write(LogLevel.Error, "Exeception in ResolveCompletionItem " + ex.ToString());
+            }
+
            return completionItem;
        }

@@ -502,6 +533,7 @@ namespace Microsoft.SqlTools.ServiceLayer.LanguageServices
                                textDocumentPosition.Position.Line,
                                textDocumentPosition.Position.Character);
            int endColumn = textDocumentPosition.Position.Character;
+            bool useLowerCaseSuggestions = this.CurrentSettings.SqlTools.IntelliSense.LowerCaseSuggestions.Value;

            this.currentCompletionParseInfo = null;

@@ -510,7 +542,7 @@ namespace Microsoft.SqlTools.ServiceLayer.LanguageServices
            ScriptParseInfo scriptParseInfo = GetScriptParseInfo(textDocumentPosition.TextDocument.Uri);
            if (connInfo == null || scriptParseInfo == null)
            {
-                return AutoCompleteHelper.GetDefaultCompletionItems(startLine, startColumn, endColumn);
+                return AutoCompleteHelper.GetDefaultCompletionItems(startLine, startColumn, endColumn, useLowerCaseSuggestions);
            }

            // reparse and bind the SQL statement if needed
@@ -521,7 +553,7 @@ namespace Microsoft.SqlTools.ServiceLayer.LanguageServices

            if (scriptParseInfo.ParseResult == null)
            {
-                return AutoCompleteHelper.GetDefaultCompletionItems(startLine, startColumn, endColumn);
+                return AutoCompleteHelper.GetDefaultCompletionItems(startLine, startColumn, endColumn, useLowerCaseSuggestions);
            }

            if (scriptParseInfo.IsConnected 
@@ -563,7 +595,7 @@ namespace Microsoft.SqlTools.ServiceLayer.LanguageServices
                }
            }
            
-            return AutoCompleteHelper.GetDefaultCompletionItems(startLine, startColumn, endColumn);
+            return AutoCompleteHelper.GetDefaultCompletionItems(startLine, startColumn, endColumn, useLowerCaseSuggestions);
        }

        #endregion
@@ -614,7 +646,8 @@ namespace Microsoft.SqlTools.ServiceLayer.LanguageServices
        /// <param name="eventContext"></param>
        private Task RunScriptDiagnostics(ScriptFile[] filesToAnalyze, EventContext eventContext)
        {
-            if (!CurrentSettings.ScriptAnalysis.Enable.Value)
+            if (!CurrentSettings.SqlTools.EnableIntellisense
+                || !CurrentSettings.SqlTools.IntelliSense.EnableDiagnostics.Value)
            {
                // If the user has disabled script analysis, skip it entirely
                return Task.FromResult(true);