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

Some minor renames/cleanup before an upcoming large refactoring #74743

Merged
merged 1 commit into from
Aug 13, 2024
Merged

Some minor renames/cleanup before an upcoming large refactoring #74743

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
27 changes: 15 additions & 12 deletions src/Workspaces/Core/Portable/Workspace/ProjectSystem/ProjectSystemProject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -607,10 +607,11 @@ await _projectSystemProjectFactory.ApplyBatchChangeToWorkspaceMaybeAsync(useAsyn
else
{
// TODO: find a cleaner way to fetch this
var metadataReference = _projectSystemProjectFactory.Workspace.CurrentSolution.GetRequiredProject(Id).MetadataReferences.Cast<PortableExecutableReference>()
.Single(m => m.FilePath == path && m.Properties == properties);
var metadataReference = _projectSystemProjectFactory.Workspace.CurrentSolution.GetRequiredProject(Id).MetadataReferences
.Cast<PortableExecutableReference>()
.Single(m => m.FilePath == path && m.Properties == properties);

projectUpdateState = projectUpdateState.WithIncrementalReferenceRemoved(metadataReference);
projectUpdateState = projectUpdateState.WithIncrementalMetadataReferenceRemoved(metadataReference);
Copy link
Member Author

Choose a reason for hiding this comment

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

upcoming code is going to deal with AnalyzerReferences as well as MetadataReferences. SO wanting the names to be clear ahead of that PR to cut down on churn.


solutionChanges.UpdateSolutionForProjectAction(
Id,
Expand All @@ -634,15 +635,16 @@ await _projectSystemProjectFactory.ApplyBatchChangeToWorkspaceMaybeAsync(useAsyn
}
else
{
var metadataReference = CreateReference_NoLock(path, properties, _projectSystemProjectFactory.SolutionServices);
projectUpdateState = projectUpdateState.WithIncrementalReferenceAdded(metadataReference);
var metadataReference = CreateMetadataReference_NoLock(path, properties, _projectSystemProjectFactory.SolutionServices);
projectUpdateState = projectUpdateState.WithIncrementalMetadataReferenceAdded(metadataReference);
}
}

solutionChanges.UpdateSolutionForProjectAction(
Id,
solutionChanges.Solution.AddProjectReferences(Id, projectReferencesCreated)
.AddMetadataReferences(Id, projectUpdateState.AddedReferences));
solutionChanges.Solution
.AddProjectReferences(Id, projectReferencesCreated)
.AddMetadataReferences(Id, projectUpdateState.AddedMetadataReferences));
}

// Project reference adding...
Expand Down Expand Up @@ -1118,8 +1120,8 @@ public void AddMetadataReference(string fullPath, MetadataReferenceProperties pr
}
else
{
var metadataReference = CreateReference_NoLock(fullPath, properties, _projectSystemProjectFactory.SolutionServices);
projectUpdateState = projectUpdateState.WithIncrementalReferenceAdded(metadataReference);
var metadataReference = CreateMetadataReference_NoLock(fullPath, properties, _projectSystemProjectFactory.SolutionServices);
projectUpdateState = projectUpdateState.WithIncrementalMetadataReferenceAdded(metadataReference);
w.OnMetadataReferenceAdded(Id, metadataReference);
}

Expand Down Expand Up @@ -1193,9 +1195,10 @@ public void RemoveMetadataReference(string fullPath, MetadataReferenceProperties
else
{
// TODO: find a cleaner way to fetch this
var metadataReference = w.CurrentSolution.GetRequiredProject(Id).MetadataReferences.Cast<PortableExecutableReference>()
.Single(m => m.FilePath == fullPath && m.Properties == properties);
projectUpdateState = projectUpdateState.WithIncrementalReferenceRemoved(metadataReference);
var metadataReference = w.CurrentSolution.GetRequiredProject(Id).MetadataReferences
.Cast<PortableExecutableReference>()
.Single(m => m.FilePath == fullPath && m.Properties == properties);
projectUpdateState = projectUpdateState.WithIncrementalMetadataReferenceRemoved(metadataReference);
w.OnMetadataReferenceRemoved(Id, metadataReference);
}

Expand Down
20 changes: 10 additions & 10 deletions ...s/Core/Portable/Workspace/ProjectSystem/ProjectSystemProjectFactory.ProjectUpdateState.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ internal sealed partial class ProjectSystemProjectFactory
/// <param name="ProjectReferenceInfos">
/// Global state containing output paths and converted project reference information for each project.
/// </param>
/// <param name="RemovedReferences">
/// <param name="RemovedMetadataReferences">
/// Incremental state containing references removed in the current update.
/// </param>
/// <param name="AddedReferences">
/// <param name="AddedMetadataReferences">
/// Incremental state containing references added in the current update.
/// </param>
public sealed record class ProjectUpdateState(
ImmutableDictionary<string, ImmutableArray<ProjectId>> ProjectsByOutputPath,
ImmutableDictionary<ProjectId, ProjectReferenceInformation> ProjectReferenceInfos,
ImmutableArray<PortableExecutableReference> RemovedReferences,
ImmutableArray<PortableExecutableReference> AddedReferences)
ImmutableArray<PortableExecutableReference> RemovedMetadataReferences,
ImmutableArray<PortableExecutableReference> AddedMetadataReferences)
{
public static ProjectUpdateState Empty = new(
ImmutableDictionary<string, ImmutableArray<ProjectId>>.Empty.WithComparers(StringComparer.OrdinalIgnoreCase),
Expand Down Expand Up @@ -104,19 +104,19 @@ static ImmutableDictionary<string, ImmutableArray<ProjectId>> RemoveProject(stri
}
}

public ProjectUpdateState WithIncrementalReferenceRemoved(PortableExecutableReference reference)
public ProjectUpdateState WithIncrementalMetadataReferenceRemoved(PortableExecutableReference reference)
{
return this with
{
RemovedReferences = RemovedReferences.Add(reference)
RemovedMetadataReferences = RemovedMetadataReferences.Add(reference)
};
}

public ProjectUpdateState WithIncrementalReferenceAdded(PortableExecutableReference reference)
public ProjectUpdateState WithIncrementalMetadataReferenceAdded(PortableExecutableReference reference)
{
return this with
{
AddedReferences = AddedReferences.Add(reference)
AddedMetadataReferences = AddedMetadataReferences.Add(reference)
};
}

Expand All @@ -127,8 +127,8 @@ public ProjectUpdateState ClearIncrementalState()
{
return this with
{
RemovedReferences = [],
AddedReferences = []
RemovedMetadataReferences = [],
AddedMetadataReferences = []
};
}
}
Expand Down
67 changes: 23 additions & 44 deletions src/Workspaces/Core/Portable/Workspace/ProjectSystem/ProjectSystemProjectFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,37 +400,17 @@ internal void ApplyProjectUpdateState(ProjectUpdateState projectUpdateState)
{
Contract.ThrowIfFalse(_gate.CurrentCount == 0);

UpdateReferenceFileWatchers(projectUpdateState.RemovedReferences, projectUpdateState.AddedReferences);
// Now that we've removed the references from the sln, we can stop watching them.
foreach (var reference in projectUpdateState.RemovedMetadataReferences)
FileWatchedReferenceFactory.StopWatchingReference(reference);

// Now that we've added the references to the sln, we can start watching them.
foreach (var reference in projectUpdateState.AddedMetadataReferences)
FileWatchedReferenceFactory.StartWatchingReference(reference, reference.FilePath!);

// Clear the state from the this update in preparation for the next.
projectUpdateState = projectUpdateState.ClearIncrementalState();
_projectUpdateState = projectUpdateState;
return;

void UpdateReferenceFileWatchers(
ImmutableArray<PortableExecutableReference> removedReferences,
ImmutableArray<PortableExecutableReference> addedReferences)
{
// Remove file watchers for any references we're no longer watching.
if (removedReferences.Count() > 0)
{
// Now that we've removed the references from the sln, we can stop watching them.
foreach (var reference in removedReferences)
{
FileWatchedReferenceFactory.StopWatchingReference(reference);
}
}

// Add file watchers for any references we are now watching.
if (addedReferences.Count() > 0)
{
// Now that we've added the references to the sln, we can start watching them.
foreach (var reference in addedReferences)
{
FileWatchedReferenceFactory.StartWatchingReference(reference, reference.FilePath!);
}
}
}
}

internal void RemoveSolution_NoLock()
Expand Down Expand Up @@ -548,7 +528,7 @@ private static ProjectUpdateState ConvertMetadataReferencesToProjectReferences_N
{
if (string.Equals(reference.FilePath, outputPath, StringComparison.OrdinalIgnoreCase))
{
projectUpdateState = projectUpdateState.WithIncrementalReferenceRemoved(reference);
projectUpdateState = projectUpdateState.WithIncrementalMetadataReferenceRemoved(reference);

var projectReference = new ProjectReference(projectIdToReference, reference.Properties.Aliases, reference.Properties.EmbedInteropTypes);
var newSolution = solutionChanges.Solution.RemoveMetadataReference(projectIdToRetarget, reference)
Expand Down Expand Up @@ -640,14 +620,13 @@ private static ProjectUpdateState ConvertProjectReferencesToMetadataReferences_N
if (string.Equals(convertedReference.path, outputPath, StringComparison.OrdinalIgnoreCase) &&
convertedReference.ProjectReference.ProjectId == projectId)
{
var metadataReference =
CreateReference_NoLock(
convertedReference.path,
new MetadataReferenceProperties(
aliases: convertedReference.ProjectReference.Aliases,
embedInteropTypes: convertedReference.ProjectReference.EmbedInteropTypes),
solutionServices);
projectUpdateState = projectUpdateState.WithIncrementalReferenceAdded(metadataReference);
var metadataReference = CreateMetadataReference_NoLock(
convertedReference.path,
new MetadataReferenceProperties(
aliases: convertedReference.ProjectReference.Aliases,
embedInteropTypes: convertedReference.ProjectReference.EmbedInteropTypes),
solutionServices);
projectUpdateState = projectUpdateState.WithIncrementalMetadataReferenceAdded(metadataReference);

var newSolution = solutionChanges.Solution.RemoveProjectReference(projectIdToRetarget, convertedReference.ProjectReference)
.AddMetadataReference(projectIdToRetarget, metadataReference);
Expand Down Expand Up @@ -797,7 +776,7 @@ public static ProjectUpdateState RemoveProjectOutputPath_NoLock(
/// Gets or creates a PortableExecutableReference instance for the given file path and properties.
/// Calls to this are expected to be serialized by the caller.
/// </summary>
public static PortableExecutableReference CreateReference_NoLock(string fullFilePath, MetadataReferenceProperties properties, SolutionServices solutionServices)
public static PortableExecutableReference CreateMetadataReference_NoLock(string fullFilePath, MetadataReferenceProperties properties, SolutionServices solutionServices)
{
var reference = solutionServices.GetRequiredService<IMetadataService>().GetReference(fullFilePath, properties);
return reference;
Expand All @@ -822,15 +801,14 @@ await ApplyBatchChangeToWorkspaceAsync((solutionChanges, projectUpdateState) =>
{
if (portableExecutableReference.FilePath == fullFilePath)
{
projectUpdateState = projectUpdateState.WithIncrementalReferenceRemoved(portableExecutableReference);
projectUpdateState = projectUpdateState.WithIncrementalMetadataReferenceRemoved(portableExecutableReference);

var newPortableExecutableReference =
CreateReference_NoLock(
portableExecutableReference.FilePath,
portableExecutableReference.Properties,
SolutionServices);
var newPortableExecutableReference = CreateMetadataReference_NoLock(
portableExecutableReference.FilePath,
portableExecutableReference.Properties,
SolutionServices);

projectUpdateState = projectUpdateState.WithIncrementalReferenceAdded(newPortableExecutableReference);
projectUpdateState = projectUpdateState.WithIncrementalMetadataReferenceAdded(newPortableExecutableReference);

var newSolution = solutionChanges.Solution.RemoveMetadataReference(project.Id, portableExecutableReference)
.AddMetadataReference(project.Id, newPortableExecutableReference);
Expand All @@ -839,6 +817,7 @@ await ApplyBatchChangeToWorkspaceAsync((solutionChanges, projectUpdateState) =>
}
}
}

return projectUpdateState;
}, onAfterUpdateAlways: null).ConfigureAwait(false);
}
Expand Down
Loading