last feedback

src/EditorFeatures/Core/DocumentationComments/CopilotGenerateDocumentationCommentProvider.cs

@@ -70,22 +70,15 @@ public async Task GenerateDocumentationProposalAsync(DocumentationCommentSnippet
             var intelliCodeLineCompletionsDisposable = await _suggestionManager.DisableProviderAsync(SuggestionServiceNames.IntelliCodeLineCompletions, cancellationToken).ConfigureAwait(false);
 
             var suggestion = new DocumentationCommentSuggestion(this, _suggestionManager, intelliCodeLineCompletionsDisposable);
-            var suggestionSessionStarted = await suggestion.StartSuggestionSessionAsync(cancellationToken).ConfigureAwait(false);
-            if (!suggestionSessionStarted)
+            Func<CancellationToken, Task<ProposalBase?>> generateProposal = async (cancellationToken) =>
             {
-                return;
-            }
-
-            var proposalEdits = await GetProposedEditsAsync(snippetProposal, _copilotService, oldSnapshot, snippet.IndentText, cancellationToken).ConfigureAwait(false);
+                var proposalEdits = await GetProposedEditsAsync(
+                    snippetProposal, _copilotService, oldSnapshot, snippet.IndentText, cancellationToken).ConfigureAwait(false);
 
-            var proposal = Proposal.TryCreateProposal(description: null, proposalEdits, oldCaret, flags: ProposalFlags.ShowCommitHighlight);
-            if (proposal is null)
-            {
-                await suggestion.DismissSuggestionSessionAsync(cancellationToken).ConfigureAwait(false);
-                return;
-            }
+                return Proposal.TryCreateProposal(description: null, proposalEdits, oldCaret, flags: ProposalFlags.ShowCommitHighlight);
+            };
 
-            await suggestion.TryDisplayDocumentationSuggestionAsync(proposal, cancellationToken).ConfigureAwait(false);
+            await suggestion.StartSuggestionSessionWithProposalAsync(generateProposal, cancellationToken).ConfigureAwait(false);
         }
 
         /// <summary>

src/EditorFeatures/Core/DocumentationComments/DocumentationCommentSuggestion.cs

@@ -38,7 +38,7 @@ public override async Task OnAcceptedAsync(SuggestionSessionBase session, Propos
             var threadingContext = providerInstance.ThreadingContext;
 
             await threadingContext.JoinableTaskFactory.SwitchToMainThreadAsync(cancel);
-            await DisposeAsync().ConfigureAwait(false);
+            await DisposeIntelliCodeCompletionsDisposableAsync().ConfigureAwait(false);
             Logger.Log(FunctionId.Copilot_Generate_Documentation_Accepted, logLevel: LogLevel.Information);
         }
 
@@ -66,14 +66,33 @@ public override Task OnProposalUpdatedAsync(SuggestionSessionBase session, Propo
             return Task.CompletedTask;
         }
 
+        public async Task StartSuggestionSessionWithProposalAsync(
+            Func<CancellationToken, Task<ProposalBase?>> generateProposal, CancellationToken cancellationToken)
+        {
+            var sessionStarted = await StartSuggestionSessionAsync(cancellationToken).ConfigureAwait(false);
+            if (!sessionStarted)
+            {
+                return;
+            }
+
+            var proposal = await generateProposal(cancellationToken).ConfigureAwait(false);
+            if (proposal is null)
+            {
+                await DismissSuggestionSessionAsync(cancellationToken).ConfigureAwait(false);
+                return;
+            }
+
+            await TryDisplayDocumentationSuggestionAsync(proposal, cancellationToken).ConfigureAwait(false);
+        }
+
         /// <summary>
         /// Starts the Suggestion Session. The TryDisplaySuggestion call doesn't display any grey text, but starts the session such that we have the
         /// exclusive right to display grey text later.
         /// </summary>
         /// <returns>If true, user will see the thinking state as long as the Suggestion Session is active and replace with grey text if a call to DisplayProposal succeeds.
         /// If unable to retrieve the session, the caller should bail out.
         /// </returns>
-        public async Task<bool> StartSuggestionSessionAsync(CancellationToken cancellationToken)
+        private async Task<bool> StartSuggestionSessionAsync(CancellationToken cancellationToken)
         {
             _suggestionSession = await RunWithEnqueueActionAsync(
                 "StartWork",
@@ -82,13 +101,17 @@ public async Task<bool> StartSuggestionSessionAsync(CancellationToken cancellati
 
             if (_suggestionSession is null)
             {
-                await DisposeAsync().ConfigureAwait(false);
+                await DisposeIntelliCodeCompletionsDisposableAsync().ConfigureAwait(false);
                 return false;
             }
 
             return true;
         }
 
+        /// <summary>
+        /// This is where we actually try to display the grey-text from the proposal
+        /// we created.
+        /// </summary>
         public async Task TryDisplayDocumentationSuggestionAsync(ProposalBase proposal, CancellationToken cancellationToken)
         {
             try
@@ -112,10 +135,12 @@ await RunWithEnqueueActionAsync<bool>(
 
         /// <summary>
         /// Dismisses the session if the proposal we generated was invalid.
+        /// Needs to dispose of the IntelliCodeCompletionsDisposable so we no longer have exclusive right to
+        /// display any grey text.
         /// </summary>
-        public async Task DismissSuggestionSessionAsync(CancellationToken cancellationToken)
+        private async Task DismissSuggestionSessionAsync(CancellationToken cancellationToken)
         {
-            await DisposeAsync().ConfigureAwait(false);
+            await DisposeIntelliCodeCompletionsDisposableAsync().ConfigureAwait(false);
             await RunWithEnqueueActionAsync<bool>(
                 "DismissSuggestionSession",
                 async () =>
@@ -141,7 +166,6 @@ private async Task<T> RunWithEnqueueActionAsync<T>(string description, Func<Task
             await providerInstance.ThreadingContext.JoinableTaskFactory.SwitchToMainThreadAsync(cancellationToken);
             SuggestionManager.EnqueueAction(description, async () =>
             {
-                var task = action();
                 try
                 {
                     var result = await action().ConfigureAwait(false);
@@ -168,14 +192,14 @@ private async Task ClearSuggestionAsync(ReasonForDismiss reason, CancellationTok
             }
 
             _suggestionSession = null;
-            await DisposeAsync().ConfigureAwait(false);
+            await DisposeIntelliCodeCompletionsDisposableAsync().ConfigureAwait(false);
         }
 
         /// <summary>
         /// The IntelliCodeLineCompletionDisposable needs to be disposed any time we exit the SuggestionSession so that
         /// line completions can be shown again.
         /// </summary>
-        private async Task DisposeAsync()
+        private async Task DisposeIntelliCodeCompletionsDisposableAsync()
         {
             if (IntelliCodeLineCompletionsDisposable != null)
             {