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.

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

Allow multiple Source Link assemblies to be loaded from different locations #1034

Merged
merged 1 commit into from
May 23, 2023
Merged
Changes from all commits
Commits
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
29 changes: 11 additions & 18 deletions src/Microsoft.Build.Tasks.Git/RepositoryTask.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@ namespace Microsoft.Build.Tasks.Git
{
public abstract class RepositoryTask : Task
{
// Include the assembly version in the key to avoid conflicts with other SourceLink versions.
private static readonly string s_cacheKeyPrefix = $"3AE29AB7-AE6B-48BA-9851-98A15ED51C94:{typeof(RepositoryTask).Assembly.GetName().Version}:";

/// <summary>
/// Sets the scope of git repository configuration. By default (no scope specified) configuration is read from environment variables
/// and system and global user git/ssh configuration files.
Expand Down Expand Up @@ -142,38 +139,34 @@ private void ExecuteImpl()
return repository;
}

private string GetCacheKey(string repositoryId)
=> s_cacheKeyPrefix + (string.IsNullOrEmpty(ConfigurationScope) ? "*" : ConfigurationScope) + ":" + repositoryId;
private Tuple<Type, string> GetCacheKey(string repositoryId)
=> new(typeof(RepositoryTask), (string.IsNullOrEmpty(ConfigurationScope) ? "*" : ConfigurationScope) + ":" + repositoryId);

private bool TryGetCachedRepositoryInstance(string cacheKey, bool requireCached, [NotNullWhen(true)]out GitRepository? repository)
private bool TryGetCachedRepositoryInstance(Tuple<Type, string> cacheKey, bool requireCached, [NotNullWhen(true)]out GitRepository? repository)
{
StrongBox<GitRepository?>? entry;
try
{
entry = (StrongBox<GitRepository?>?)BuildEngine4.GetRegisteredTaskObject(cacheKey, RegisteredTaskObjectLifetime.Build);
}
catch (InvalidCastException) // workaround for https://github.com/dotnet/msbuild/issues/8478
{
entry = null;
}

var entry = (StrongBox<GitRepository?>?)BuildEngine4.GetRegisteredTaskObject(cacheKey, RegisteredTaskObjectLifetime.Build);
if (entry != null)
{
Log.LogMessage(MessageImportance.Low, $"SourceLink: Reusing cached git repository information.");
repository = entry.Value;
return repository != null;
}

var message = $"SourceLink: Repository instance not found in cache: '{cacheKey.Item2}'";
if (requireCached)
{
Log.LogError($"SourceLink: Repository instance not found in cache: '{cacheKey.Substring(s_cacheKeyPrefix.Length)}'");
Log.LogError(message);
}
else
{
Log.LogMessage(MessageImportance.Low, message);
}

repository = null;
return false;
}

private void CacheRepositoryInstance(string cacheKey, GitRepository? repository)
private void CacheRepositoryInstance(Tuple<Type, string> cacheKey, GitRepository? repository)
{
BuildEngine4.RegisterTaskObject(
cacheKey,
Expand Down