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

Avoid cyclic references during incremental project update #58720

Merged
merged 1 commit into from
Jan 14, 2022
Merged

Avoid cyclic references during incremental project update #58720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 48 additions & 0 deletions src/VisualStudio/Core/Test.Next/Services/ServiceHubServicesTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,54 @@ await solution.State.GetChecksumAsync(CancellationToken.None),
await remoteWorkspace.CurrentSolution.State.GetChecksumAsync(CancellationToken.None));
}

[Fact]
[WorkItem(52578, "https://github.com/dotnet/roslyn/issues/52578")]
public async Task TestIncrementalUpdateHandlesReferenceReversal()
{
using var workspace = CreateWorkspace();

using var client = await InProcRemoteHostClient.GetTestClientAsync(workspace).ConfigureAwait(false);
var remoteWorkspace = client.GetRemoteWorkspace();

var solution = workspace.CurrentSolution;
solution = AddProject(solution, LanguageNames.CSharp, documents: Array.Empty<string>(), additionalDocuments: Array.Empty<string>(), p2pReferences: Array.Empty<ProjectId>());
var projectId1 = solution.ProjectIds.Single();
solution = AddProject(solution, LanguageNames.CSharp, documents: Array.Empty<string>(), additionalDocuments: Array.Empty<string>(), p2pReferences: Array.Empty<ProjectId>());
var projectId2 = solution.ProjectIds.Where(id => id != projectId1).Single();

var project1ToProject2 = new ProjectReference(projectId2);
var project2ToProject1 = new ProjectReference(projectId1);

// Start with projectId1 -> projectId2
solution = solution.AddProjectReference(projectId1, project1ToProject2);

// verify initial setup
await UpdatePrimaryWorkspace(client, solution);
await VerifyAssetStorageAsync(client, solution, includeProjectCones: false);

Assert.Equal(
await solution.State.GetChecksumAsync(CancellationToken.None),
await remoteWorkspace.CurrentSolution.State.GetChecksumAsync(CancellationToken.None));

// reverse project references and incrementally update
solution = solution.RemoveProjectReference(projectId1, project1ToProject2);
solution = solution.AddProjectReference(projectId2, project2ToProject1);
await UpdatePrimaryWorkspace(client, solution);

Assert.Equal(
await solution.State.GetChecksumAsync(CancellationToken.None),
await remoteWorkspace.CurrentSolution.State.GetChecksumAsync(CancellationToken.None));

// reverse project references again and incrementally update
solution = solution.RemoveProjectReference(projectId2, project2ToProject1);
solution = solution.AddProjectReference(projectId1, project1ToProject2);
await UpdatePrimaryWorkspace(client, solution);

Assert.Equal(
await solution.State.GetChecksumAsync(CancellationToken.None),
await remoteWorkspace.CurrentSolution.State.GetChecksumAsync(CancellationToken.None));
}

[Fact]
public void TestRemoteWorkspaceCircularReferences()
{
Expand Down
23 changes: 19 additions & 4 deletions src/Workspaces/Remote/ServiceHub/Host/RemoteWorkspace.SolutionCreator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,17 +150,19 @@ private async Task<Solution> UpdateProjectsAsync(Solution solution, HashSet<Chec
}
}

// changed project
// remove all project references from projects that changed. this ensures exceptions will not occur for
// cyclic references during an incremental update.
foreach (var (projectId, newProjectChecksums) in newMap)
{
if (!oldMap.TryGetValue(projectId, out var oldProjectChecksums))
{
continue;
}

Contract.ThrowIfTrue(oldProjectChecksums.Checksum == newProjectChecksums.Checksum);

solution = await UpdateProjectAsync(solution.GetProject(projectId)!, oldProjectChecksums, newProjectChecksums).ConfigureAwait(false);
if (oldProjectChecksums.ProjectReferences.Checksum != newProjectChecksums.ProjectReferences.Checksum)
{
solution = solution.WithProjectReferences(projectId, SpecializedCollections.EmptyEnumerable<ProjectReference>());
}
}

// removed project
Expand All @@ -173,6 +175,19 @@ private async Task<Solution> UpdateProjectsAsync(Solution solution, HashSet<Chec
}
}

// changed project
foreach (var (projectId, newProjectChecksums) in newMap)
{
if (!oldMap.TryGetValue(projectId, out var oldProjectChecksums))
{
continue;
}

Contract.ThrowIfTrue(oldProjectChecksums.Checksum == newProjectChecksums.Checksum);

solution = await UpdateProjectAsync(solution.GetProject(projectId)!, oldProjectChecksums, newProjectChecksums).ConfigureAwait(false);
}

return solution;
}

Expand Down