Skip to content

Improve perf of accessing configured values in tree, particularly during solution load #9686

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

Merged
drewnoakes merged 5 commits into from
Jun 24, 2025
Merged

Improve perf of accessing configured values in tree, particularly during solution load #9686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
447efab
Improve perf of accessing configured value
drewnoakes Jun 23, 2025
8ec603a
Use primary constructor
drewnoakes Jun 23, 2025
ddba0f9
Use concrete type
drewnoakes Jun 23, 2025
c80c4cf
Document use of property import
drewnoakes Jun 23, 2025
dfdc9d7
Apply similar optimisation to ImportTreeProvider
drewnoakes Jun 23, 2025
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
36 changes: 19 additions & 17 deletions ...lStudio.ProjectSystem.Managed/ProjectSystem/Tree/Dependencies/DependenciesTreeProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,14 @@ internal sealed partial class DependenciesTreeProvider : ProjectTreeProviderBase
private readonly OrderPrecedenceImportCollection<IProjectTreeActionHandler> _removalActionHandlers;

private readonly DependenciesSnapshotProvider _dependenciesSnapshotProvider;
private readonly IActiveConfiguredValue<IConfiguredProjectExports> _activeConfiguredProjectExports;
private readonly CancellationSeries _treeUpdateCancellationSeries;
private readonly IProjectAccessor _projectAccessor;
private readonly ITaskDelayScheduler _debounce;
private readonly TaskDelayScheduler _debounce;

// NOTE we use a property import here as importing this via the constructor creates a loop between
// DependenciesTreeProvider and DependenciesTreeBuilder. A property import allows MEF to break that
// circular dependency.
[Import]
private DependenciesTreeBuilder TreeBuilder { get; set; } = null!;

Expand All @@ -68,11 +72,13 @@ public DependenciesTreeProvider(
IProjectThreadingService threadingService,
IUnconfiguredProjectTasksService tasksService,
IProjectAccessor projectAccessor,
DependenciesSnapshotProvider dependenciesSnapshotProvider)
DependenciesSnapshotProvider dependenciesSnapshotProvider,
IActiveConfiguredValue<IConfiguredProjectExports> activeConfiguredProjectExports)
: base(threadingService, unconfiguredProject)
{
_dependenciesSnapshotProvider = dependenciesSnapshotProvider;
_projectAccessor = projectAccessor;
_activeConfiguredProjectExports = activeConfiguredProjectExports;

_removalActionHandlers = new OrderPrecedenceImportCollection<IProjectTreeActionHandler>(
ImportOrderPrecedenceComparer.PreferenceOrder.PreferredComesFirst,
Expand Down Expand Up @@ -377,7 +383,7 @@ await _projectAccessor.OpenProjectForWriteAsync(ActiveConfiguredProject, project

protected override ConfiguredProjectExports GetActiveConfiguredProjectExports(ConfiguredProject newActiveConfiguredProject)
{
return GetActiveConfiguredProjectExports<MyConfiguredProjectExports>(newActiveConfiguredProject);
return (ConfiguredProjectExports)_activeConfiguredProjectExports.Value;
}

#region ITreeConstruction
Expand Down Expand Up @@ -479,29 +485,25 @@ IProjectItemTree2 IProjectTreeOperations.NewTree(string caption, IProjectPropert
/// <summary>
/// Describes services collected from the active configured project.
/// </summary>
[Export]
private sealed class MyConfiguredProjectExports : ConfiguredProjectExports
[Export(typeof(IConfiguredProjectExports))]
[method: ImportingConstructor]
private sealed class MyConfiguredProjectExports(ConfiguredProject configuredProject)
: ConfiguredProjectExports(configuredProject),
IConfiguredProjectExports
{
[ImportingConstructor]
public MyConfiguredProjectExports(ConfiguredProject configuredProject)
: base(configuredProject)
{
}
}

/// <summary>
/// A private implementation of <see cref="IProjectTreeActionHandlerContext"/> for use with
/// <see cref="IProjectTreeActionHandler"/> exports.
/// </summary>
private sealed class ProjectDependencyTreeRemovalActionHandlerContext : IProjectTreeActionHandlerContext
private sealed class ProjectDependencyTreeRemovalActionHandlerContext(IProjectTreeProvider treeProvider) : IProjectTreeActionHandlerContext
{
public IProjectTreeProvider TreeProvider { get; }
public IProjectTreeProvider TreeProvider { get; } = treeProvider;

public IProjectTreeActionHandler SuccessorHandlerDelegator => throw new NotImplementedException();

public ProjectDependencyTreeRemovalActionHandlerContext(IProjectTreeProvider treeProvider)
{
TreeProvider = treeProvider;
}
}

// NOTE this interface is needed to work around accessiblity issues when making MyConfiguredProjectExports non-private
Copy link
Member

@adamint adamint Jun 23, 2025

Choose a reason for hiding this comment

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

could you be more specific in this comment?

Copy link
Member Author

@drewnoakes drewnoakes Jun 24, 2025

Choose a reason for hiding this comment

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

Honestly this one had me stumped. The compiler claimed there was a visibility issue (CS0060), and the issue couldn't be suppressed. Something to do with the base type being protected internal yet in a different assembly, maybe. I was confused enough to even view (and edit) the docs for that diagnostic. So, I don't have much more context to add here. If you remove the interface and try to export the concrete type, you'll see the issue.

internal interface IConfiguredProjectExports { }
}
24 changes: 13 additions & 11 deletions ...isualStudio.ProjectSystem.Managed/ProjectSystem/Tree/ProjectImports/ImportTreeProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ internal sealed class ImportTreeProvider : ProjectTreeProviderBase, IProjectTree
private readonly UnconfiguredProject _project;
private readonly IActiveConfiguredProjectSubscriptionService _projectSubscriptionService;
private readonly IUnconfiguredProjectTasksService _unconfiguredProjectTasksService;
private readonly IActiveConfiguredValue<IConfiguredProjectExports> _activeConfiguredProjectExports;

private DisposableBag? _subscriptions;
private bool _showAllFiles;
Expand All @@ -54,12 +55,14 @@ internal ImportTreeProvider(
IProjectThreadingService threadingService,
UnconfiguredProject project,
IActiveConfiguredProjectSubscriptionService projectSubscriptionService,
IUnconfiguredProjectTasksService unconfiguredProjectTasksService)
IUnconfiguredProjectTasksService unconfiguredProjectTasksService,
IActiveConfiguredValue<IConfiguredProjectExports> activeConfiguredProjectExports)
: base(threadingService, project, useDisplayOrdering: true)
{
_project = project;
_projectSubscriptionService = projectSubscriptionService;
_unconfiguredProjectTasksService = unconfiguredProjectTasksService;
_activeConfiguredProjectExports = activeConfiguredProjectExports;
}

public override string? GetPath(IProjectTree node)
Expand Down Expand Up @@ -346,9 +349,7 @@ void TearDownTree()

protected override ConfiguredProjectExports GetActiveConfiguredProjectExports(ConfiguredProject newActiveConfiguredProject)
{
Requires.NotNull(newActiveConfiguredProject);

return GetActiveConfiguredProjectExports<MyConfiguredProjectExports>(newActiveConfiguredProject);
return (ConfiguredProjectExports)_activeConfiguredProjectExports.Value;
}

protected override void Dispose(bool disposing)
Expand All @@ -361,13 +362,14 @@ protected override void Dispose(bool disposing)
base.Dispose(disposing);
}

[Export]
private sealed class MyConfiguredProjectExports : ConfiguredProjectExports
[Export(typeof(IConfiguredProjectExports))]
[method: ImportingConstructor]
private sealed class MyConfiguredProjectExports(ConfiguredProject configuredProject)
: ConfiguredProjectExports(configuredProject),
IConfiguredProjectExports
{
[ImportingConstructor]
public MyConfiguredProjectExports(ConfiguredProject configuredProject)
: base(configuredProject)
{
}
}

// NOTE this interface is needed to work around accessiblity issues when making MyConfiguredProjectExports non-private
internal interface IConfiguredProjectExports { }
}