feedback

src/EditorFeatures/CSharp/DocumentationComments/DocumentationCommentCommandHandler.cs

@@ -30,11 +30,10 @@ internal sealed class DocumentationCommentCommandHandler(
     ITextUndoHistoryRegistry undoHistoryRegistry,
     IEditorOperationsFactoryService editorOperationsFactoryService,
     EditorOptionsService editorOptionsService,
-    [Import(AllowDefault = true)] SuggestionServiceBase suggestionServiceBase,
-    IThreadingContext threadingContext,
+    CopilotGenerateDocumentationCommentManager generateDocumentationCommentManager,
     IAsynchronousOperationListenerProvider listenerProvider)
             : AbstractDocumentationCommentCommandHandler(uiThreadOperationExecutor, undoHistoryRegistry,
-                editorOperationsFactoryService, editorOptionsService, suggestionServiceBase, threadingContext, listenerProvider)
+                editorOperationsFactoryService, editorOptionsService, generateDocumentationCommentManager, listenerProvider)
 {
     protected override string ExteriorTriviaText => "///";
 }

src/EditorFeatures/Core/DocumentationComments/AbstractDocumentationCommentCommandHandler.cs

@@ -33,7 +33,7 @@
 
 namespace Microsoft.CodeAnalysis.DocumentationComments;
 
-internal abstract class AbstractDocumentationCommentCommandHandler : SuggestionProviderBase,
+internal abstract class AbstractDocumentationCommentCommandHandler :
     IChainedCommandHandler<TypeCharCommandArgs>,
     ICommandHandler<ReturnKeyCommandArgs>,
     ICommandHandler<InsertCommentCommandArgs>,
@@ -44,23 +44,15 @@ internal abstract class AbstractDocumentationCommentCommandHandler : SuggestionP
     private readonly ITextUndoHistoryRegistry _undoHistoryRegistry;
     private readonly IEditorOperationsFactoryService _editorOperationsFactoryService;
     private readonly EditorOptionsService _editorOptionsService;
-    private readonly SuggestionServiceBase? _suggestionServiceBase;
+    private readonly CopilotGenerateDocumentationCommentManager _generateDocumentationCommentManager;
     private readonly IAsynchronousOperationListener _asyncListener;
 
-    private SuggestionManagerBase? _suggestionManagerBase;
-    private VisualStudio.Threading.IAsyncDisposable? _intellicodeLineCompletionsDisposable;
-
-    internal SuggestionSessionBase? _suggestionSession;
-
-    public readonly IThreadingContext? ThreadingContext;
-
     protected AbstractDocumentationCommentCommandHandler(
         IUIThreadOperationExecutor uiThreadOperationExecutor,
         ITextUndoHistoryRegistry undoHistoryRegistry,
         IEditorOperationsFactoryService editorOperationsFactoryService,
         EditorOptionsService editorOptionsService,
-        SuggestionServiceBase? suggestionServiceBase,
-        IThreadingContext? threadingContext,
+        CopilotGenerateDocumentationCommentManager generateDocumentationCommentManager,
         IAsynchronousOperationListenerProvider listenerProvider)
     {
         Contract.ThrowIfNull(uiThreadOperationExecutor);
@@ -71,9 +63,8 @@ protected AbstractDocumentationCommentCommandHandler(
         _undoHistoryRegistry = undoHistoryRegistry;
         _editorOperationsFactoryService = editorOperationsFactoryService;
         _editorOptionsService = editorOptionsService;
-        _suggestionServiceBase = suggestionServiceBase;
+        _generateDocumentationCommentManager = generateDocumentationCommentManager;
         _asyncListener = listenerProvider.GetListener(FeatureAttribute.GenerateDocumentation);
-        ThreadingContext = threadingContext;
     }
 
     protected abstract string ExteriorTriviaText { get; }
@@ -125,292 +116,25 @@ private bool CompleteComment(
             if (snippet != null)
             {
                 ApplySnippet(snippet, subjectBuffer, textView);
-                /*var oldSnapshot = subjectBuffer.CurrentSnapshot;
-                var oldCaret = textView.Caret.Position.VirtualBufferPosition;*/
+                var oldSnapshot = subjectBuffer.CurrentSnapshot;
+                var oldCaret = textView.Caret.Position.VirtualBufferPosition;
 
                 returnValue = true;
 
-/*                // Only calls into the suggestion manager is available, the shell of the comment still gets inserted regardless.
-                if (_suggestionManagerBase != null && ThreadingContext != null)
-                {
-                    ThreadingContext.ThrowIfNotOnUIThread();
-
-                    var token = _asyncListener.BeginAsyncOperation(nameof(GenerateDocumentationProposalAsync));
-                    _ = GenerateDocumentationProposalAsync(document, snippet, oldSnapshot, oldCaret, cancellationToken).CompletesAsyncOperation(token);
-                }*/
+                var token = _asyncListener.BeginAsyncOperation(nameof(GenerateDocumentationCommentProposalsAsync));
+                _ = GenerateDocumentationCommentProposalsAsync(document, snippet, oldSnapshot, oldCaret, textView, cancellationToken).CompletesAsyncOperation(token);
             }
         }
 
         return returnValue;
     }
 
-    /*private async Task GenerateDocumentationProposalAsync(Document document, DocumentationCommentSnippet snippet,
-        ITextSnapshot oldSnapshot, VirtualSnapshotPoint oldCaret, CancellationToken cancellationToken)
-    {
-        await Task.Yield().ConfigureAwait(false);
-
-        // Bailing out if copilot is not available or the option is not enabled.
-        if (document.GetRequiredLanguageService<ICopilotCodeAnalysisService>() is not { } copilotService ||
-                await copilotService.IsAvailableAsync(cancellationToken).ConfigureAwait(false) is false)
-        {
-            return;
-        }
-
-        if (document.GetLanguageService<ICopilotOptionsService>() is not { } copilotOptionService ||
-            !await copilotOptionService.IsGenerateDocumentationCommentOptionEnabledAsync().ConfigureAwait(false))
-        {
-            return;
-        }
-
-        var snippetProposal = GetSnippetProposal(snippet.SnippetText, snippet.MemberNode, snippet.Position, snippet.CaretOffset);
-
-        if (snippetProposal is null)
-        {
-            return;
-        }
-
-        // Do not do IntelliCode line completions if we're about to generate a documentation comment
-        // so that won't have interfering grey text.
-        _intellicodeLineCompletionsDisposable = await _suggestionManagerBase!.DisableProviderAsync(SuggestionServiceNames.IntelliCodeLineCompletions, cancellationToken).ConfigureAwait(false);
-
-        var proposalEdits = await GetProposedEditsAsync(snippetProposal, copilotService, oldSnapshot, snippet.IndentText, cancellationToken).ConfigureAwait(false);
-
-        var proposal = Proposal.TryCreateProposal(null, proposalEdits, oldCaret, flags: ProposalFlags.SingleTabToAccept);
-
-        if (proposal is null)
-        {
-            return;
-        }
-
-        var suggestion = new DocumentationCommentSuggestion(this, proposal);
-
-        var session = this._suggestionSession = await (_suggestionManagerBase.TryDisplaySuggestionAsync(suggestion, cancellationToken)).ConfigureAwait(false);
-
-        if (session != null)
-        {
-            await TryDisplaySuggestionAsync(session, suggestion, cancellationToken).ConfigureAwait(false);
-        }
-    }*/
-
-   /* /// <summary>
-    /// Traverses the documentation comment shell and retrieves the pieces that are needed to generate the documentation comment.
-    /// </summary>
-    private static DocumentationCommentProposal? GetSnippetProposal(string? comments, SyntaxNode? memberNode, int? position, int caret)
-    {
-        if (comments is null)
-        {
-            return null;
-        }
-
-        if (memberNode is null)
-        {
-            return null;
-        }
-
-        if (position is null)
-        {
-            return null;
-        }
-
-        var startIndex = position.Value;
-        var proposedEdits = new List<DocumentationCommentProposedEdit>();
-        var index = 0;
-
-        var summaryStartTag = comments.IndexOf("<summary>", index, StringComparison.Ordinal);
-        var summaryEndTag = comments.IndexOf("</summary>", index, StringComparison.Ordinal);
-        if (summaryEndTag != -1 && summaryStartTag != -1)
-        {
-            proposedEdits.Add(new DocumentationCommentProposedEdit(new TextSpan(caret + startIndex, 0), null, DocumentationCommentTagType.Summary));
-        }
-
-        while (true)
-        {
-            var paramEndTag = comments.IndexOf("</param>", index, StringComparison.Ordinal);
-            var paramStartTag = comments.IndexOf("<param name=\"", index, StringComparison.Ordinal);
-
-            if (paramStartTag == -1 || paramEndTag == -1)
-            {
-                break;
-            }
-
-            var paramNameStart = paramStartTag + "<param name=\"".Length;
-            var paramNameEnd = comments.IndexOf("\">", paramNameStart, StringComparison.Ordinal);
-            if (paramNameEnd != -1)
-            {
-                var parameterName = comments.Substring(paramNameStart, paramNameEnd - paramNameStart);
-                proposedEdits.Add(new DocumentationCommentProposedEdit(new TextSpan(paramEndTag + startIndex, 0), parameterName, DocumentationCommentTagType.Param));
-            }
-
-            index = paramEndTag + "</param>".Length;
-        }
-
-        var returnsEndTag = comments.IndexOf("</returns>", index, StringComparison.Ordinal);
-        if (returnsEndTag != -1)
-        {
-            proposedEdits.Add(new DocumentationCommentProposedEdit(new TextSpan(returnsEndTag + startIndex, 0), null, DocumentationCommentTagType.Returns));
-        }
-
-        while (true)
-        {
-            var exceptionEndTag = comments.IndexOf("</exception>", index, StringComparison.Ordinal);
-            var exceptionStartTag = comments.IndexOf("<exception cref=\"", index, StringComparison.Ordinal);
-
-            if (exceptionEndTag == -1 || exceptionStartTag == -1)
-            {
-                break;
-            }
-
-            var exceptionNameStart = exceptionStartTag + "<exception cref=\"".Length;
-            var exceptionNameEnd = comments.IndexOf("\">", exceptionNameStart, StringComparison.Ordinal);
-            if (exceptionNameEnd != -1)
-            {
-                var exceptionName = comments.Substring(exceptionNameStart, exceptionNameEnd - exceptionNameStart);
-                proposedEdits.Add(new DocumentationCommentProposedEdit(new TextSpan(exceptionEndTag + startIndex, 0), exceptionName, DocumentationCommentTagType.Exception));
-            }
-
-            index = exceptionEndTag + "</exception>".Length;
-        }
-
-        return new DocumentationCommentProposal(memberNode.ToFullString(), proposedEdits.ToImmutableArray());
-    }
-
-    /// <summary>
-    /// Calls into the copilot service to get the pieces for the documentation comment.
-    /// </summary>
-    private static async Task<IReadOnlyList<ProposedEdit>> GetProposedEditsAsync(
-        DocumentationCommentProposal proposal, ICopilotCodeAnalysisService copilotService,
-        ITextSnapshot oldSnapshot, string? indentText, CancellationToken cancellationToken)
-    {
-        var list = new List<ProposedEdit>();
-        var (copilotText, isQuotaExceeded) = await copilotService.GetDocumentationCommentAsync(proposal, cancellationToken).ConfigureAwait(false);
-
-        // Quietly fail if the quota has been exceeded.
-        if (isQuotaExceeded)
-        {
-            return list;
-        }
-
-        // The response from Copilot is structured like a JSON object, so make sure it is being returned appropriately.
-        if (copilotText is null || copilotText.AsSpan().Trim() is "{}" or "{ }" or "")
-        {
-            return list;
-        }
-
-        // If the response can't be properly converted, something went wrong and bail out.
-        Dictionary<string, string>? props;
-        try
-        {
-            props = JsonConvert.DeserializeObject<Dictionary<string, string>>(copilotText);
-        }
-        catch (Exception)
-        {
-            return list;
-        }
-
-        if (props is null)
-        {
-            return list;
-        }
-
-        foreach (var edit in proposal.ProposedEdits)
-        {
-            string? copilotStatement = null;
-            var textSpan = edit.SpanToReplace;
-
-            if (edit.TagType == DocumentationCommentTagType.Summary && props.TryGetValue(DocumentationCommentTagType.Summary.ToString(), out var summary) && !string.IsNullOrEmpty(summary))
-            {
-                copilotStatement = summary;
-            }
-            else if (edit.TagType == DocumentationCommentTagType.Param && props.TryGetValue(edit.SymbolName!, out var param) && !string.IsNullOrEmpty(param))
-            {
-                copilotStatement = param;
-            }
-            else if (edit.TagType == DocumentationCommentTagType.Returns && props.TryGetValue(DocumentationCommentTagType.Returns.ToString(), out var returns) && !string.IsNullOrEmpty(returns))
-            {
-                copilotStatement = returns;
-            }
-            else if (edit.TagType == DocumentationCommentTagType.Exception && props.TryGetValue(edit.SymbolName!, out var exception) && !string.IsNullOrEmpty(exception))
-            {
-                copilotStatement = exception;
-            }
-
-            var proposedEdit = new ProposedEdit(new SnapshotSpan(oldSnapshot, textSpan.Start, textSpan.Length),
-                AddNewLinesToCopilotText(copilotStatement!, indentText, characterLimit: 120));
-            list.Add(proposedEdit);
-        }
-
-        return list;
-
-        static string AddNewLinesToCopilotText(string copilotText, string? indentText, int characterLimit)
-        {
-            var builder = new StringBuilder();
-            var words = copilotText.Split(' ');
-            var currentLineLength = 0;
-            characterLimit -= (indentText!.Length + "/// ".Length);
-            foreach (var word in words)
-            {
-                if (currentLineLength + word.Length >= characterLimit)
-                {
-                    builder.AppendLine();
-                    builder.Append(indentText);
-                    builder.Append("/// ");
-                    currentLineLength = 0;
-                }
-
-                if (currentLineLength > 0)
-                {
-                    builder.Append(' ');
-                    currentLineLength++;
-                }
-
-                builder.Append(word);
-                currentLineLength += word.Length;
-            }
-
-            return builder.ToString();
-        }
-    }
-
-    private async Task<bool> TryDisplaySuggestionAsync(SuggestionSessionBase session, DocumentationCommentSuggestion suggestion, CancellationToken cancellationToken)
-    {
-        if (ThreadingContext is null)
-        {
-            return false;
-        }
-
-        try
-        {
-            await ThreadingContext.JoinableTaskFactory.SwitchToMainThreadAsync(cancellationToken);
-            await session.DisplayProposalAsync(suggestion.Proposal, cancellationToken).ConfigureAwait(false);
-            return true;
-        }
-        catch (OperationCanceledException)
-        {
-        }
-
-        return false;
-    }
-
-    public async Task ClearSuggestionAsync(ReasonForDismiss reason, CancellationToken cancellationToken)
+    private async Task GenerateDocumentationCommentProposalsAsync(Document document, DocumentationCommentSnippet snippet, ITextSnapshot snapshot, VirtualSnapshotPoint caret, ITextView textView, CancellationToken cancellationToken)
     {
-        if (_suggestionSession != null)
-        {
-            await _suggestionSession.DismissAsync(reason, cancellationToken).ConfigureAwait(false);
-        }
-
-        _suggestionSession = null;
-        await DisposeAsync().ConfigureAwait(false);
+        var generateDocumentationCommentProvider = await _generateDocumentationCommentManager.CreateProviderAsync(textView, cancellationToken).ConfigureAwait(false);
+        await generateDocumentationCommentProvider.GenerateDocumentationProposalAsync(document, snippet, snapshot, caret, cancellationToken).ConfigureAwait(false);
     }
 
-    public async Task DisposeAsync()
-    {
-        if (_intellicodeLineCompletionsDisposable != null)
-        {
-            await _intellicodeLineCompletionsDisposable.DisposeAsync().ConfigureAwait(false);
-            _intellicodeLineCompletionsDisposable = null;
-        }
-    }*/
-
     public CommandState GetCommandState(TypeCharCommandArgs args, Func<CommandState> nextHandler)
         => nextHandler();
 
@@ -426,14 +150,6 @@ public void ExecuteCommand(TypeCharCommandArgs args, Action nextHandler, Command
         if (args.SubjectBuffer.IsInLspEditorContext())
             return;
 
-        /*ThreadingContext?.JoinableTaskFactory.Run(async () =>
-            {
-                if (_suggestionServiceBase is not null)
-                {
-                    _suggestionManagerBase = await _suggestionServiceBase.TryRegisterProviderAsync(this, args.TextView, "AmbientAIDocumentationComments", context.OperationContext.UserCancellationToken).ConfigureAwait(false);
-                }
-            });*/
-
         CompleteComment(args.SubjectBuffer, args.TextView, InsertOnCharacterTyped, CancellationToken.None);
     }