Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Address layering of navigation action in code actions #59856

Merged
merged 4 commits into from
Mar 2, 2022
Merged

Address layering of navigation action in code actions #59856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
283ba6d
Address layering of navigation action in code actions
CyrusNajmabadi Mar 1, 2022
4dcfd49
Fix formatting warning
CyrusNajmabadi Mar 2, 2022
eb56fe2
Simplify
CyrusNajmabadi Mar 2, 2022
05c2090
Merge remote-tracking branch 'upstream/release/dev17.3' into codeActi…
CyrusNajmabadi Mar 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 23 additions & 15 deletions src/EditorFeatures/Core/Implementation/CodeActions/CodeActionEditHandlerService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,7 @@ public async Task<bool> ApplyAsync(
{
// Come back to the UI thread after processing the operations so we can commit the transaction
applied = await ProcessOperationsAsync(
workspace, operations, progressTracker,
cancellationToken).ConfigureAwait(true);
workspace, operations, progressTracker, cancellationToken).ConfigureAwait(true);
}
catch (Exception ex) when (FatalError.ReportAndPropagateUnlessCanceled(ex, cancellationToken))
{
Expand All @@ -185,7 +184,7 @@ public async Task<bool> ApplyAsync(

var updatedSolution = operations.OfType<ApplyChangesOperation>().FirstOrDefault()?.ChangedSolution ?? oldSolution;
await TryNavigateToLocationOrStartRenameSessionAsync(
workspace, oldSolution, updatedSolution, cancellationToken).ConfigureAwait(false);
workspace, operations, oldSolution, updatedSolution, cancellationToken).ConfigureAwait(false);
return applied;
}

Expand Down Expand Up @@ -289,41 +288,50 @@ private async Task<bool> ProcessOperationsAsync(
return applied;
}

private async Task TryNavigateToLocationOrStartRenameSessionAsync(Workspace workspace, Solution oldSolution, Solution newSolution, CancellationToken cancellationToken)
private async Task TryNavigateToLocationOrStartRenameSessionAsync(
Workspace workspace,
ImmutableArray<CodeActionOperation> operations,
Solution oldSolution,
Solution newSolution,
CancellationToken cancellationToken)
{
var navigationOperation = operations.OfType<DocumentNavigationOperation>().FirstOrDefault();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider SingleOrDefault, since if we have more than one I'm suspicious about what happened there.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well SingleOrDefault throws... and that worries me about somethign potentially throwing now taht just had wonky behavior before.

if (navigationOperation != null && workspace.CanOpenDocuments)
{
var navigationService = workspace.Services.GetRequiredService<IDocumentNavigationService>();
await navigationService.TryNavigateToPositionAsync(
workspace, navigationOperation.DocumentId, navigationOperation.Position, cancellationToken).ConfigureAwait(false);
return;
}

var changedDocuments = newSolution.GetChangedDocuments(oldSolution);
foreach (var documentId in changedDocuments)
{
var document = newSolution.GetRequiredDocument(documentId);
if (!document.SupportsSyntaxTree)
{
continue;
}

var root = await document.GetRequiredSyntaxRootAsync(cancellationToken).ConfigureAwait(false);

var navigationTokenOpt = root.GetAnnotatedTokens(NavigationAnnotation.Kind)
.FirstOrNull();
if (navigationTokenOpt.HasValue)
var navigationToken = root.GetAnnotatedTokens(NavigationAnnotation.Kind).FirstOrNull();
if (navigationToken.HasValue)
{
var navigationService = workspace.Services.GetRequiredService<IDocumentNavigationService>();
await navigationService.TryNavigateToPositionAsync(
workspace, documentId, navigationTokenOpt.Value.SpanStart, cancellationToken).ConfigureAwait(false);
workspace, documentId, navigationToken.Value.SpanStart, cancellationToken).ConfigureAwait(false);
return;
}

var renameTokenOpt = root.GetAnnotatedTokens(RenameAnnotation.Kind)
.FirstOrNull();

if (renameTokenOpt.HasValue)
var renameToken = root.GetAnnotatedTokens(RenameAnnotation.Kind).FirstOrNull();
if (renameToken.HasValue)
{
// It's possible that the workspace's current solution is not the same as
// newSolution. This can happen if the workspace host performs other edits
// during ApplyChanges, such as in the Venus scenario where indentation and
// formatting can happen. To work around this, we create a SyntaxPath to the
// rename token in the newSolution and resolve it to the current solution.

var pathToRenameToken = new SyntaxPath(renameTokenOpt.Value);
var pathToRenameToken = new SyntaxPath(renameToken.Value);
var latestDocument = workspace.CurrentSolution.GetDocument(documentId);
if (latestDocument != null)
{
Expand Down
21 changes: 5 additions & 16 deletions ...re/Portable/Common/NavigationOperation.cs → ...ble/Common/DocumentNavigationOperation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,8 @@
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

#nullable disable

using System;
using System.Threading;
using Microsoft.CodeAnalysis.Navigation;
using Microsoft.CodeAnalysis.Shared.Utilities;

namespace Microsoft.CodeAnalysis.CodeActions
{
Expand All @@ -21,25 +17,18 @@ namespace Microsoft.CodeAnalysis.CodeActions
/// </summary>
public class DocumentNavigationOperation : CodeActionOperation
{
private readonly DocumentId _documentId;
private readonly int _position;
internal DocumentId DocumentId { get; }
internal int Position { get; }

public DocumentNavigationOperation(DocumentId documentId, int position = 0)
{
_documentId = documentId ?? throw new ArgumentNullException(nameof(documentId));
_position = position;
DocumentId = documentId ?? throw new ArgumentNullException(nameof(documentId));
Position = position;
}

public override void Apply(Workspace workspace, CancellationToken cancellationToken)
{
CyrusNajmabadi marked this conversation as resolved.
Show resolved Hide resolved
if (workspace.CanOpenDocuments)
{
var navigationService = workspace.Services.GetService<IDocumentNavigationService>();
var threadingService = workspace.Services.GetService<IWorkspaceThreadingServiceProvider>();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you delete IWorkspaceThreadingServiceProvider or did something else still use it too?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unfortunately, unit testing and TS are still using it in exactly 2 locations.


threadingService.Service.Run(
() => navigationService.TryNavigateToPositionAsync(workspace, _documentId, _position, cancellationToken));
}
// Intentionally empty. Handling of this operation is special cased in CodeActionEditHandlerService.cs
}
}
}