-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
SdkResolverService.cs
483 lines (415 loc) · 22.2 KB
/
SdkResolverService.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
using Microsoft.Build.BackEnd.Logging;
using Microsoft.Build.Construction;
using Microsoft.Build.Evaluation;
using Microsoft.Build.Framework;
using Microsoft.Build.Shared;
using System;
using System.IO;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Reflection;
using Microsoft.Build.Eventing;
using System.Linq;
using System.Text.RegularExpressions;
#nullable disable
namespace Microsoft.Build.BackEnd.SdkResolution
{
/// <summary>
/// The main implementation of <see cref="ISdkResolverService"/> which resolves SDKs. This class is the central location for all SDK resolution and is used
/// directly by the main node and non-build evaluations and is used indirectly by the out-of-proc node when it sends requests to the main node.
/// </summary>
internal class SdkResolverService : ISdkResolverService
{
/// <summary>
/// Stores the singleton instance for a particular process.
/// </summary>
private static readonly Lazy<SdkResolverService> InstanceLazy = new Lazy<SdkResolverService>(() => new SdkResolverService(), isThreadSafe: true);
/// <summary>
/// A lock object used for this class.
/// </summary>
private readonly object _lockObject = new object();
/// <summary>
/// Stores resolver state by build submission ID.
/// </summary>
private readonly ConcurrentDictionary<int, ConcurrentDictionary<SdkResolver, object>> _resolverStateBySubmission = new ConcurrentDictionary<int, ConcurrentDictionary<SdkResolver, object>>();
/// <summary>
/// Stores the list of SDK resolvers which were loaded.
/// </summary>
/// <remarks>
/// Need it for supporting the ChangeWave less than <see cref="ChangeWaves.Wave17_4"/>. Remove when move out Wave17_4.
/// </remarks>
private IList<SdkResolver> _resolversList;
/// <summary>
/// Stores the loaded SDK resolvers, mapped to the manifest from which they came.
/// </summary>
private Dictionary<SdkResolverManifest, IList<SdkResolver>> _manifestToResolvers;
/// <summary>
/// Stores the list of manifests of specific SDK resolvers which could be loaded.
/// </summary>
private IList<SdkResolverManifest> _specificResolversManifestsRegistry;
/// <summary>
/// Stores the list of manifests of general SDK resolvers which could be loaded.
/// </summary>
private IList<SdkResolverManifest> _generalResolversManifestsRegistry;
/// <summary>
/// Stores an <see cref="SdkResolverLoader"/> which can load registered SDK resolvers.
/// </summary>
private SdkResolverLoader _sdkResolverLoader = new SdkResolverLoader();
public SdkResolverService()
{
}
/// <summary>
/// Gets the current instance of <see cref="SdkResolverService"/> for this process.
/// </summary>
public static SdkResolverService Instance => InstanceLazy.Value;
/// <inheritdoc cref="ISdkResolverService.SendPacket"/>
public Action<INodePacket> SendPacket { get; }
/// <summary>
/// Determines if the <see cref="SdkReference"/> is the same as the specified version. If the <paramref name="sdk"/> object has <code>null</code> for the version,
/// this method will always return true since <code>null</code> can match any version.
/// </summary>
/// <param name="sdk">An <see cref="SdkReference"/> object.</param>
/// <param name="version">The version to compare.</param>
/// <returns><code>true</code> if the specified SDK reference has the same version as the specified result, otherwise <code>false</code>.</returns>
public static bool IsReferenceSameVersion(SdkReference sdk, string version)
{
// If the reference has a null version, it matches any result
if (String.IsNullOrEmpty(sdk.Version))
{
return true;
}
return String.Equals(sdk.Version, version, StringComparison.OrdinalIgnoreCase);
}
/// <inheritdoc cref="ISdkResolverService.ClearCache"/>
public virtual void ClearCache(int submissionId)
{
_resolverStateBySubmission.TryRemove(submissionId, out _);
}
public virtual void ClearCaches()
{
_resolverStateBySubmission.Clear();
}
/// <inheritdoc cref="ISdkResolverService.ResolveSdk"/>
public virtual SdkResult ResolveSdk(int submissionId, SdkReference sdk, LoggingContext loggingContext, ElementLocation sdkReferenceLocation, string solutionPath, string projectPath, bool interactive, bool isRunningInVisualStudio)
{
if (ChangeWaves.AreFeaturesEnabled(ChangeWaves.Wave17_4))
{
return ResolveSdkUsingResolversWithPatternsFirst(submissionId, sdk, loggingContext, sdkReferenceLocation, solutionPath, projectPath, interactive, isRunningInVisualStudio);
}
else
{
return ResolveSdkUsingAllResolvers(submissionId, sdk, loggingContext, sdkReferenceLocation, solutionPath, projectPath, interactive, isRunningInVisualStudio);
}
}
/// <remarks>
/// Resolves the sdk in two passes. First pass consists of all specific resolvers (i.e. resolvers with pattern), which match the sdk name.
/// The resolvers are ordered by the priority in first pass and are tried until one of them succeeds.
/// If the first pass is unsuccessful, on the second pass all the general resolvers (i.e. resolvers without pattern), ordered by their priority, are tried one after one.
/// After that, if the second pass is unsuccessful, sdk resolution is unsuccessful.
/// </remarks>
private SdkResult ResolveSdkUsingResolversWithPatternsFirst(int submissionId, SdkReference sdk, LoggingContext loggingContext, ElementLocation sdkReferenceLocation, string solutionPath, string projectPath, bool interactive, bool isRunningInVisualStudio)
{
if (_specificResolversManifestsRegistry == null || _generalResolversManifestsRegistry == null)
{
RegisterResolversManifests(loggingContext, sdkReferenceLocation);
}
// Pick up the matching specific resolvers from the list of resolvers.
List<SdkResolverManifest> matchingResolversManifests = new();
foreach (SdkResolverManifest manifest in _specificResolversManifestsRegistry)
{
try
{
if (manifest.ResolvableSdkRegex.IsMatch(sdk.Name))
{
matchingResolversManifests.Add(manifest);
}
}
catch (RegexMatchTimeoutException ex)
{
ErrorUtilities.ThrowInternalError("Timeout exceeded matching sdk \"{0}\" to <ResolvableSdkPattern> from sdk resolver manifest {1}.", ex, sdk.Name, manifest.DisplayName);
}
}
List<SdkResolver> resolvers;
SdkResult sdkResult;
if (matchingResolversManifests.Count != 0)
{
// First pass.
resolvers = GetResolvers(matchingResolversManifests, loggingContext, sdkReferenceLocation);
if (TryResolveSdkUsingSpecifiedResolvers(
resolvers,
submissionId,
sdk,
loggingContext,
sdkReferenceLocation,
solutionPath,
projectPath,
interactive,
isRunningInVisualStudio,
out sdkResult))
{
return sdkResult;
}
}
// Second pass: fallback to general resolvers.
resolvers = GetResolvers(
_generalResolversManifestsRegistry,
loggingContext,
sdkReferenceLocation).ToList();
if (TryResolveSdkUsingSpecifiedResolvers(
resolvers,
submissionId,
sdk,
loggingContext,
sdkReferenceLocation,
solutionPath,
projectPath,
interactive,
isRunningInVisualStudio,
out sdkResult))
{
return sdkResult;
}
// No resolvers resolved the sdk.
return new SdkResult(sdk, null, null);
}
private List<SdkResolver> GetResolvers(IList<SdkResolverManifest> resolversManifests, LoggingContext loggingContext, ElementLocation sdkReferenceLocation)
{
// Create a sorted by priority list of resolvers. Load them if needed.
List<SdkResolver> resolvers = new List<SdkResolver>();
foreach (var resolverManifest in resolversManifests)
{
if (!_manifestToResolvers.TryGetValue(resolverManifest, out IList<SdkResolver> newResolvers))
{
lock (_lockObject)
{
if (!_manifestToResolvers.TryGetValue(resolverManifest, out newResolvers))
{
// Loading of the needed resolvers.
MSBuildEventSource.Log.SdkResolverServiceLoadResolversStart();
newResolvers = _sdkResolverLoader.LoadResolversFromManifest(resolverManifest, loggingContext, sdkReferenceLocation);
_manifestToResolvers[resolverManifest] = newResolvers;
MSBuildEventSource.Log.SdkResolverServiceLoadResolversStop(resolverManifest.DisplayName, newResolvers.Count);
}
}
}
resolvers.AddRange(newResolvers);
}
resolvers.Sort((l, r) => l.Priority.CompareTo(r.Priority));
return resolvers;
}
private SdkResult ResolveSdkUsingAllResolvers(int submissionId, SdkReference sdk, LoggingContext loggingContext, ElementLocation sdkReferenceLocation, string solutionPath, string projectPath, bool interactive, bool isRunningInVisualStudio)
{
// Lazy initialize all SDK resolvers
if (_resolversList == null)
{
Initialize(loggingContext, sdkReferenceLocation);
}
TryResolveSdkUsingSpecifiedResolvers(
_resolversList,
submissionId,
sdk,
loggingContext,
sdkReferenceLocation,
solutionPath,
projectPath,
interactive,
isRunningInVisualStudio,
out SdkResult sdkResult);
return sdkResult;
}
private bool TryResolveSdkUsingSpecifiedResolvers(IList<SdkResolver> resolvers, int submissionId, SdkReference sdk, LoggingContext loggingContext, ElementLocation sdkReferenceLocation, string solutionPath, string projectPath, bool interactive, bool isRunningInVisualStudio, out SdkResult sdkResult)
{
List<SdkResult> results = new List<SdkResult>();
// Loop through resolvers which have already been sorted by priority, returning the first result that was successful
SdkLogger buildEngineLogger = new SdkLogger(loggingContext);
loggingContext.LogComment(MessageImportance.Low, "SdkResolving", sdk.ToString());
foreach (SdkResolver sdkResolver in resolvers)
{
SdkResolverContext context = new SdkResolverContext(buildEngineLogger, projectPath, solutionPath, ProjectCollection.Version, interactive, isRunningInVisualStudio)
{
State = GetResolverState(submissionId, sdkResolver)
};
SdkResultFactory resultFactory = new SdkResultFactory(sdk);
SdkResult result;
try
{
MSBuildEventSource.Log.SdkResolverResolveSdkStart();
result = (SdkResult)sdkResolver.Resolve(sdk, context, resultFactory);
MSBuildEventSource.Log.SdkResolverResolveSdkStop(sdkResolver.Name, sdk.Name, solutionPath, projectPath, result?.Path, result?.Success ?? false);
}
catch (Exception e) when ((e is FileNotFoundException || e is FileLoadException) && sdkResolver.GetType().GetTypeInfo().Name.Equals("NuGetSdkResolver", StringComparison.Ordinal))
{
// Since we explicitly add the NuGetSdkResolver, we special case this. The NuGetSdkResolver has special logic
// to load NuGet assemblies at runtime which could fail if the user is not running installed MSBuild. Rather
// than give them a generic error, we want to give a more specific message. This exception cannot be caught by
// the resolver itself because it is usually thrown before the class is loaded
// The NuGet-based SDK resolver failed to run because NuGet assemblies could not be located. Check your installation of MSBuild or set the environment variable "{0}" to the folder that contains the required NuGet assemblies. {1}
throw new SdkResolverException("CouldNotRunNuGetSdkResolver", sdkResolver, sdk, e, MSBuildConstants.NuGetAssemblyPathEnvironmentVariableName, e.ToString());
}
catch (Exception e)
{
// The SDK resolver "{0}" failed while attempting to resolve the SDK "{1}": {2}
throw new SdkResolverException("SDKResolverFailed", sdkResolver, sdk, e, sdkResolver.Name, sdk.ToString(), e.ToString());
}
SetResolverState(submissionId, sdkResolver, context.State);
if (result == null)
{
continue;
}
if (result.Success)
{
LogWarnings(loggingContext, sdkReferenceLocation, result);
if (!IsReferenceSameVersion(sdk, result.Version))
{
// MSB4241: The SDK reference "{0}" version "{1}" was resolved to version "{2}" instead. You could be using a different version than expected if you do not update the referenced version to match.
loggingContext.LogWarning(null, new BuildEventFileInfo(sdkReferenceLocation), "SdkResultVersionDifferentThanReference", sdk.Name, sdk.Version, result.Version);
}
// Associate the element location of the resolved SDK reference
result.ElementLocation = sdkReferenceLocation;
sdkResult = result;
return true;
}
results.Add(result);
}
foreach (SdkResult result in results)
{
LogWarnings(loggingContext, sdkReferenceLocation, result);
if (result.Errors != null)
{
foreach (string error in result.Errors)
{
loggingContext.LogErrorFromText(subcategoryResourceName: null, errorCode: null, helpKeyword: null, file: new BuildEventFileInfo(sdkReferenceLocation), message: error);
}
}
}
sdkResult = new SdkResult(sdk, null, null);
return false;
}
/// <summary>
/// Used for unit tests only. This is currently only called through reflection in Microsoft.Build.Engine.UnitTests.TransientSdkResolution.CallResetForTests
/// </summary>
/// <param name="resolverLoader">An <see cref="SdkResolverLoader"/> to use for loading SDK resolvers.</param>
/// <param name="resolvers">Explicit set of SdkResolvers to use for all SDK resolution.</param>
internal void InitializeForTests(SdkResolverLoader resolverLoader = null, IList<SdkResolver> resolvers = null)
{
if (resolverLoader != null)
{
_sdkResolverLoader = resolverLoader;
}
_specificResolversManifestsRegistry = null;
_generalResolversManifestsRegistry = null;
_manifestToResolvers = null;
_resolversList = null;
if (resolvers != null)
{
if (ChangeWaves.AreFeaturesEnabled(ChangeWaves.Wave17_4))
{
_specificResolversManifestsRegistry = new List<SdkResolverManifest>();
_generalResolversManifestsRegistry = new List<SdkResolverManifest>();
_manifestToResolvers = new Dictionary<SdkResolverManifest, IList<SdkResolver>>();
SdkResolverManifest sdkResolverManifest = new SdkResolverManifest(DisplayName: "TestResolversManifest", Path: null, ResolvableSdkRegex: null);
_generalResolversManifestsRegistry.Add(sdkResolverManifest);
_manifestToResolvers[sdkResolverManifest] = resolvers;
}
else
{
_resolversList = resolvers;
}
}
}
private static void LogWarnings(LoggingContext loggingContext, ElementLocation location, SdkResult result)
{
if (result.Warnings == null)
{
return;
}
foreach (string warning in result.Warnings)
{
loggingContext.LogWarningFromText(null, null, null, new BuildEventFileInfo(location), warning);
}
}
private object GetResolverState(int submissionId, SdkResolver resolver)
{
// Do not fetch state for resolution requests that are not associated with a valid build submission ID
if (submissionId != BuildEventContext.InvalidSubmissionId)
{
ConcurrentDictionary<SdkResolver, object> resolverState;
if (_resolverStateBySubmission.TryGetValue(submissionId, out resolverState))
{
object state;
if (resolverState.TryGetValue(resolver, out state))
{
return state;
}
}
}
return null;
}
private void Initialize(LoggingContext loggingContext, ElementLocation location)
{
lock (_lockObject)
{
if (_resolversList != null)
{
return;
}
MSBuildEventSource.Log.SdkResolverServiceInitializeStart();
_resolversList = _sdkResolverLoader.LoadAllResolvers(loggingContext, location);
MSBuildEventSource.Log.SdkResolverServiceInitializeStop(_resolversList.Count);
}
}
private void RegisterResolversManifests(LoggingContext loggingContext, ElementLocation location)
{
lock (_lockObject)
{
if (_specificResolversManifestsRegistry != null && _generalResolversManifestsRegistry != null)
{
return;
}
MSBuildEventSource.Log.SdkResolverServiceFindResolversManifestsStart();
var allResolversManifests = _sdkResolverLoader.GetResolversManifests(loggingContext, location);
_manifestToResolvers = new Dictionary<SdkResolverManifest, IList<SdkResolver>>();
// Load and add the manifest for the default resolvers, located directly in this dll.
IList<SdkResolver> defaultResolvers = _sdkResolverLoader.GetDefaultResolvers(loggingContext, location);
if (defaultResolvers.Count > 0)
{
MSBuildEventSource.Log.SdkResolverServiceLoadResolversStart();
SdkResolverManifest sdkDefaultResolversManifest = new SdkResolverManifest(DisplayName: "DefaultResolversManifest", Path: null, ResolvableSdkRegex: null);
allResolversManifests.Add(sdkDefaultResolversManifest);
_manifestToResolvers[sdkDefaultResolversManifest] = defaultResolvers;
MSBuildEventSource.Log.SdkResolverServiceLoadResolversStop(sdkDefaultResolversManifest.DisplayName, defaultResolvers.Count);
}
MSBuildEventSource.Log.SdkResolverServiceFindResolversManifestsStop(allResolversManifests.Count);
// Break the list of all resolvers manifests into two parts: manifests with specific and general resolvers.
_specificResolversManifestsRegistry = new List<SdkResolverManifest>();
_generalResolversManifestsRegistry = new List<SdkResolverManifest>();
foreach (SdkResolverManifest manifest in allResolversManifests)
{
if (manifest.ResolvableSdkRegex == null)
{
_generalResolversManifestsRegistry.Add(manifest);
}
else
{
_specificResolversManifestsRegistry.Add(manifest);
}
}
}
}
private void SetResolverState(int submissionId, SdkResolver resolver, object state)
{
// Do not set state for resolution requests that are not associated with a valid build submission ID
if (submissionId != BuildEventContext.InvalidSubmissionId)
{
ConcurrentDictionary<SdkResolver, object> resolverState = _resolverStateBySubmission.GetOrAdd(
submissionId,
_ => new ConcurrentDictionary<SdkResolver, object>(
NativeMethodsShared.GetLogicalCoreCount(),
ChangeWaves.AreFeaturesEnabled(ChangeWaves.Wave17_4) ? _specificResolversManifestsRegistry.Count + _generalResolversManifestsRegistry.Count : _resolversList.Count));
resolverState.AddOrUpdate(resolver, state, (sdkResolver, obj) => state);
}
}
}
}