-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
ProjectLoggingContext.cs
274 lines (247 loc) · 11.2 KB
/
ProjectLoggingContext.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
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
using System;
using System.Collections.Generic;
using Microsoft.Build.Framework;
using Microsoft.Build.Execution;
using System.Collections;
using Microsoft.Build.Shared;
using TaskItem = Microsoft.Build.Execution.ProjectItemInstance.TaskItem;
using Microsoft.Build.Collections;
using Microsoft.Build.Utilities;
namespace Microsoft.Build.BackEnd.Logging
{
/// <summary>
/// A logging context for a project.
/// </summary>
internal class ProjectLoggingContext : BuildLoggingContext
{
/// <summary>
/// The project's full path
/// </summary>
private string _projectFullPath;
/// <summary>
/// The parent node logging context this context was derived from.
/// </summary>
private NodeLoggingContext _nodeLoggingContext;
/// <summary>
/// Constructs a project logging context.
/// </summary>
internal ProjectLoggingContext(NodeLoggingContext nodeLoggingContext, BuildRequestEntry requestEntry, BuildEventContext parentBuildEventContext)
: this
(
nodeLoggingContext,
requestEntry.Request.SubmissionId,
requestEntry.Request.ConfigurationId,
requestEntry.RequestConfiguration.ProjectFullPath,
requestEntry.Request.Targets,
requestEntry.RequestConfiguration.ToolsVersion,
requestEntry.RequestConfiguration.Project.PropertiesToBuildWith,
requestEntry.RequestConfiguration.Project.ItemsToBuildWith,
parentBuildEventContext,
requestEntry.RequestConfiguration.Project.EvaluationId
)
{
}
/// <summary>
/// Constructs a project logging context.
/// </summary>
internal ProjectLoggingContext(NodeLoggingContext nodeLoggingContext, BuildRequest request, string projectFullPath, string toolsVersion, BuildEventContext parentBuildEventContext, int evaluationId = BuildEventContext.InvalidEvaluationId)
: this
(
nodeLoggingContext,
request.SubmissionId,
request.ConfigurationId,
projectFullPath,
request.Targets,
toolsVersion,
null,
null,
parentBuildEventContext,
evaluationId
)
{
}
/// <summary>
/// Constructs a project logging contexts.
/// </summary>
private ProjectLoggingContext(NodeLoggingContext nodeLoggingContext, int submissionId, int configurationId, string projectFullPath, List<string> targets, string toolsVersion, PropertyDictionary<ProjectPropertyInstance> projectProperties, ItemDictionary<ProjectItemInstance> projectItems, BuildEventContext parentBuildEventContext, int evaluationId = BuildEventContext.InvalidEvaluationId)
: base(nodeLoggingContext)
{
_nodeLoggingContext = nodeLoggingContext;
_projectFullPath = projectFullPath;
ProjectPropertyInstanceEnumeratorProxy properties = null;
ProjectItemInstanceEnumeratorProxy items = null;
IEnumerable<ProjectPropertyInstance> projectPropertiesEnumerator = projectProperties == null ? Array.Empty<ProjectPropertyInstance>() : null;
IEnumerable<ProjectItemInstance> projectItemsEnumerator = projectItems == null ? Array.Empty<ProjectItemInstance>() : null;
string[] propertiesToSerialize = LoggingService.PropertiesToSerialize;
// If we are only logging critical events lets not pass back the items or properties
if (!LoggingService.OnlyLogCriticalEvents &&
!LoggingService.IncludeEvaluationPropertiesAndItems &&
(!LoggingService.RunningOnRemoteNode || LoggingService.SerializeAllProperties))
{
if (projectProperties != null)
{
projectPropertiesEnumerator = projectProperties.GetCopyOnReadEnumerable();
}
if (projectItems != null)
{
projectItemsEnumerator = projectItems.GetCopyOnReadEnumerable();
}
properties = new ProjectPropertyInstanceEnumeratorProxy(projectPropertiesEnumerator);
items = new ProjectItemInstanceEnumeratorProxy(projectItemsEnumerator);
}
if (projectProperties != null &&
!LoggingService.IncludeEvaluationPropertiesAndItems &&
propertiesToSerialize?.Length > 0 &&
!LoggingService.SerializeAllProperties)
{
PropertyDictionary<ProjectPropertyInstance> projectPropertiesToSerialize = new PropertyDictionary<ProjectPropertyInstance>();
foreach (string propertyToGet in propertiesToSerialize)
{
ProjectPropertyInstance instance = projectProperties[propertyToGet];
{
if (instance != null)
{
projectPropertiesToSerialize.Set(instance);
}
}
}
properties = new ProjectPropertyInstanceEnumeratorProxy(projectPropertiesToSerialize);
}
this.BuildEventContext = LoggingService.LogProjectStarted
(
nodeLoggingContext.BuildEventContext,
submissionId,
configurationId,
parentBuildEventContext,
projectFullPath,
String.Join(";", targets),
properties,
items,
evaluationId);
LoggingService.LogComment(this.BuildEventContext, MessageImportance.Low, "ToolsVersionInEffectForBuild", toolsVersion);
this.IsValid = true;
}
/// <summary>
/// Retrieves the node logging context.
/// </summary>
internal NodeLoggingContext NodeLoggingContext
{
get
{
return _nodeLoggingContext;
}
}
/// <summary>
/// Log that the project has finished
/// </summary>
/// <param name="success">Did the build succeede or not</param>
internal void LogProjectFinished(bool success)
{
ErrorUtilities.VerifyThrow(this.IsValid, "invalid");
LoggingService.LogProjectFinished(BuildEventContext, _projectFullPath, success);
this.IsValid = false;
}
/// <summary>
/// Log that a target has started
/// </summary>
internal TargetLoggingContext LogTargetBatchStarted(string projectFullPath, ProjectTargetInstance target, string parentTargetName, TargetBuiltReason buildReason)
{
ErrorUtilities.VerifyThrow(this.IsValid, "invalid");
return new TargetLoggingContext(this, projectFullPath, target, parentTargetName, buildReason);
}
/// <summary>
/// An enumerable wrapper for items that clones items as they are requested,
/// so that writes have no effect on the items.
/// </summary>
/// <remarks>
/// This class is designed to be passed to loggers.
/// The expense of copying items is only incurred if and when
/// a logger chooses to enumerate over it.
/// The type of the items enumerated over is imposed by backwards compatibility for ProjectStartedEvent.
/// </remarks>
private class ProjectItemInstanceEnumeratorProxy : IEnumerable<DictionaryEntry>
{
/// <summary>
/// Enumerable that this proxies
/// </summary>
private IEnumerable<ProjectItemInstance> _backingItems;
/// <summary>
/// Constructor
/// </summary>
/// <param name="backingItems">Enumerator this class should proxy</param>
internal ProjectItemInstanceEnumeratorProxy(IEnumerable<ProjectItemInstance> backingItems)
{
_backingItems = backingItems;
}
/// <summary>
/// Returns an enumerator that provides copies of the items
/// in the backing store.
/// Each dictionary entry has key of the item type and value of an ITaskItem.
/// Type of the enumerator is imposed by backwards compatibility for ProjectStartedEvent.
/// </summary>
public IEnumerator<DictionaryEntry> GetEnumerator()
{
foreach (ProjectItemInstance item in _backingItems)
{
yield return new DictionaryEntry(item.ItemType, new TaskItem(item));
}
}
/// <summary>
/// Returns an enumerator that provides copies of the items
/// in the backing store.
/// </summary>
IEnumerator IEnumerable.GetEnumerator()
{
return (IEnumerator)GetEnumerator();
}
}
/// <summary>
/// An enumerable wrapper for properties that clones properties as they are requested,
/// so that writes have no effect on the properties.
/// </summary>
/// <remarks>
/// This class is designed to be passed to loggers.
/// The expense of copying items is only incurred if and when
/// a logger chooses to enumerate over it.
/// The type of the items enumerated over is imposed by backwards compatibility for ProjectStartedEvent.
/// </remarks>
private class ProjectPropertyInstanceEnumeratorProxy : IEnumerable<DictionaryEntry>
{
/// <summary>
/// Enumerable that this proxies
/// </summary>
private IEnumerable<ProjectPropertyInstance> _backingProperties;
/// <summary>
/// Constructor
/// </summary>
/// <param name="backingProperties">Enumerator this class should proxy</param>
internal ProjectPropertyInstanceEnumeratorProxy(IEnumerable<ProjectPropertyInstance> backingProperties)
{
_backingProperties = backingProperties;
}
/// <summary>
/// Returns an enumerator that provides copies of the properties
/// in the backing store.
/// Each DictionaryEntry has key of the property name and value of the property value.
/// Type of the enumerator is imposed by backwards compatibility for ProjectStartedEvent.
/// </summary>
public IEnumerator<DictionaryEntry> GetEnumerator()
{
foreach (ProjectPropertyInstance property in _backingProperties)
{
yield return new DictionaryEntry(property.Name, property.EvaluatedValue);
}
}
/// <summary>
/// Returns an enumerator that provides copies of the properties
/// in the backing store.
/// </summary>
IEnumerator IEnumerable.GetEnumerator()
{
return (IEnumerator)GetEnumerator();
}
}
}
}