Skip to content

Commit f60b983

Browse files
jakubch1Jakub Chocholowicz
jakubch1
and
Jakub Chocholowicz
authored
Add possibility to send telemetry events by data collectors (#4622)
* Edge1 * Edge2 risky way * Send back events * Fixes * More * More * More * Fix all tests * More tests * More * More tests * Extend more * Extend more --------- Co-authored-by: Jakub Chocholowicz <[email protected]>
1 parent 6719005 commit f60b983

File tree

36 files changed

+1738
-123
lines changed

36 files changed

+1738
-123
lines changed

‎src/Microsoft.TestPlatform.Common/DataCollection/DataCollectionManager.cs‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,11 @@ internal class DataCollectionManager : IDataCollectionManager
5353
/// </summary>
5454
private readonly TestPlatformDataCollectionEvents _events;
5555

56+
/// <summary>
57+
/// Telemetry reporter
58+
/// </summary>
59+
private readonly ITelemetryReporter _telemetryReporter;
60+
5661
/// <summary>
5762
/// Specifies whether the object is disposed or not.
5863
/// </summary>
@@ -74,7 +79,7 @@ internal class DataCollectionManager : IDataCollectionManager
7479
/// <param name="messageSink">
7580
/// The message Sink.
7681
/// </param>
77-
internal DataCollectionManager(IMessageSink messageSink, IRequestData requestData) : this(new DataCollectionAttachmentManager(), messageSink, new DataCollectionTelemetryManager(requestData))
82+
internal DataCollectionManager(IMessageSink messageSink, IRequestData requestData, ITelemetryReporter telemetryReporter) : this(new DataCollectionAttachmentManager(), messageSink, new DataCollectionTelemetryManager(requestData), telemetryReporter)
7883
{
7984
}
8085

@@ -90,14 +95,15 @@ internal class DataCollectionManager : IDataCollectionManager
9095
/// <remarks>
9196
/// The constructor is not public because the factory method should be used to get instances of this class.
9297
/// </remarks>
93-
protected DataCollectionManager(IDataCollectionAttachmentManager datacollectionAttachmentManager, IMessageSink messageSink, IDataCollectionTelemetryManager dataCollectionTelemetryManager)
98+
protected DataCollectionManager(IDataCollectionAttachmentManager datacollectionAttachmentManager, IMessageSink messageSink, IDataCollectionTelemetryManager dataCollectionTelemetryManager, ITelemetryReporter telemetryReporter)
9499
{
95100
_attachmentManager = datacollectionAttachmentManager;
96101
_messageSink = messageSink;
97102
_events = new TestPlatformDataCollectionEvents();
98103
_dataCollectorExtensionManager = null;
99104
RunDataCollectors = new Dictionary<Type, DataCollectorInformation>();
100105
_dataCollectionTelemetryManager = dataCollectionTelemetryManager;
106+
_telemetryReporter = telemetryReporter;
101107
}
102108

103109
/// <summary>
@@ -133,13 +139,13 @@ private DataCollectorExtensionManager DataCollectorExtensionManager
133139
/// <returns>
134140
/// The <see cref="DataCollectionManager"/>.
135141
/// </returns>
136-
public static DataCollectionManager Create(IMessageSink messageSink, IRequestData requestData)
142+
public static DataCollectionManager Create(IMessageSink messageSink, IRequestData requestData, ITelemetryReporter telemetryReporter)
137143
{
138144
if (Instance == null)
139145
{
140146
lock (SyncObject)
141147
{
142-
Instance ??= new DataCollectionManager(messageSink, requestData);
148+
Instance ??= new DataCollectionManager(messageSink, requestData, telemetryReporter);
143149
}
144150
}
145151

@@ -528,7 +534,7 @@ private void LoadAndInitialize(DataCollectorSettings dataCollectorSettings, stri
528534

529535
try
530536
{
531-
dataCollectorInfo.InitializeDataCollector();
537+
dataCollectorInfo.InitializeDataCollector(_telemetryReporter);
532538
TPDebug.Assert(dataCollectorConfig is not null, "dataCollectorConfig is null");
533539
lock (RunDataCollectors)
534540
{

‎src/Microsoft.TestPlatform.Common/DataCollection/DataCollectorInformation.cs‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,11 +110,16 @@ public IEnumerable<KeyValuePair<string, string>>? TestExecutionEnvironmentVariab
110110
/// <summary>
111111
/// Initializes datacollectors.
112112
/// </summary>
113-
internal void InitializeDataCollector()
113+
internal void InitializeDataCollector(ITelemetryReporter telemetryReporter)
114114
{
115115
UpdateConfigurationElement();
116116

117117
DataCollector.Initialize(ConfigurationElement, Events, DataCollectionSink, Logger, EnvironmentContext);
118+
119+
if (DataCollector is ITelemetryInitializer telemetryInitializer)
120+
{
121+
telemetryInitializer.Initialize(telemetryReporter);
122+
}
118123
}
119124

120125
private void UpdateConfigurationElement()

‎src/Microsoft.TestPlatform.CommunicationUtilities/DataCollectionRequestHandler.cs‎

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -55,28 +55,6 @@ internal class DataCollectionRequestHandler : IDataCollectionRequestHandler, IDi
5555
/// </summary>
5656
private readonly CancellationTokenSource _cancellationTokenSource;
5757

58-
/// <summary>
59-
/// Initializes a new instance of the <see cref="DataCollectionRequestHandler"/> class.
60-
/// </summary>
61-
/// <param name="messageSink">
62-
/// The message sink.
63-
/// </param>
64-
/// <param name="requestData">
65-
/// The request data.
66-
/// </param>
67-
protected DataCollectionRequestHandler(IMessageSink messageSink, IRequestData requestData)
68-
: this(
69-
new SocketCommunicationManager(),
70-
messageSink,
71-
DataCollectionManager.Create(messageSink, requestData),
72-
new DataCollectionTestCaseEventHandler(messageSink),
73-
JsonDataSerializer.Instance,
74-
new FileHelper(),
75-
requestData)
76-
{
77-
_messageSink = messageSink;
78-
}
79-
8058
/// <summary>
8159
/// Initializes a new instance of the <see cref="DataCollectionRequestHandler"/> class.
8260
/// </summary>
@@ -159,11 +137,12 @@ public static DataCollectionRequestHandler Create(
159137
if (Instance == null)
160138
{
161139
var requestData = new RequestData();
140+
var telemetryReporter = new TelemetryReporter(requestData, communicationManager, JsonDataSerializer.Instance);
162141

163142
Instance = new DataCollectionRequestHandler(
164143
communicationManager,
165144
messageSink,
166-
DataCollectionManager.Create(messageSink, requestData),
145+
DataCollectionManager.Create(messageSink, requestData, telemetryReporter),
167146
new DataCollectionTestCaseEventHandler(messageSink),
168147
JsonDataSerializer.Instance,
169148
new FileHelper(),

‎src/Microsoft.TestPlatform.CommunicationUtilities/DataCollectionRequestSender.cs‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,10 @@ public void SendTestHostLaunched(TestHostLaunchedPayload testHostLaunchedPayload
116116

117117
while (!isDataCollectionStarted)
118118
{
119-
var message = _communicationManager.ReceiveMessage();
119+
var rawMessage = _communicationManager.ReceiveRawMessage();
120+
TPDebug.Assert(rawMessage is not null, "rawMessage is null");
121+
122+
var message = !rawMessage.IsNullOrEmpty() ? _dataSerializer.DeserializeMessage(rawMessage) : null;
120123
TPDebug.Assert(message is not null, "message is null");
121124

122125
EqtTrace.Verbose("DataCollectionRequestSender.SendBeforeTestRunStartAndGetResult: Received message: {0}", message);
@@ -132,6 +135,10 @@ public void SendTestHostLaunched(TestHostLaunchedPayload testHostLaunchedPayload
132135
isDataCollectionStarted = true;
133136
result = _dataSerializer.DeserializePayload<BeforeTestRunStartResult>(message);
134137
}
138+
else if (message.MessageType == MessageType.TelemetryEventMessage)
139+
{
140+
runEventsHandler?.HandleRawMessage(rawMessage);
141+
}
135142
}
136143

137144
return result;
@@ -151,7 +158,10 @@ public void SendTestHostLaunched(TestHostLaunchedPayload testHostLaunchedPayload
151158
// Currently each of the operations are not separate tasks since they should not each take much time. This is just a notification.
152159
while (!isDataCollectionComplete && !isCancelled)
153160
{
154-
var message = _communicationManager.ReceiveMessage();
161+
var rawMessage = _communicationManager.ReceiveRawMessage();
162+
TPDebug.Assert(rawMessage is not null, "rawMessage is null");
163+
164+
var message = !rawMessage.IsNullOrEmpty() ? _dataSerializer.DeserializeMessage(rawMessage) : null;
155165
TPDebug.Assert(message is not null, "message is null");
156166

157167
EqtTrace.Verbose("DataCollectionRequestSender.SendAfterTestRunStartAndGetResult: Received message: {0}", message);
@@ -167,6 +177,10 @@ public void SendTestHostLaunched(TestHostLaunchedPayload testHostLaunchedPayload
167177
result = _dataSerializer.DeserializePayload<AfterTestRunEndResult>(message);
168178
isDataCollectionComplete = true;
169179
}
180+
else if (message.MessageType == MessageType.TelemetryEventMessage)
181+
{
182+
runEventsHandler?.HandleRawMessage(rawMessage);
183+
}
170184
}
171185

172186
return result;

‎src/Microsoft.TestPlatform.CommunicationUtilities/Messages/MessageType.cs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,4 +281,8 @@ public static class MessageType
281281
[ProtocolVersion(Version7, typeof(EditorAttachDebuggerPayload))]
282282
public const string EditorAttachDebugger2 = "TestExecution.EditorAttachDebugger2";
283283

284+
/// <summary>
285+
/// Telemetry event.
286+
/// </summary>
287+
public const string TelemetryEventMessage = "TestPlatform.TelemetryEvent";
284288
}

‎src/Microsoft.TestPlatform.CommunicationUtilities/PublicAPI/PublicAPI.Unshipped.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
#nullable enable
2+
const Microsoft.VisualStudio.TestPlatform.CommunicationUtilities.ObjectModel.MessageType.TelemetryEventMessage = "TestPlatform.TelemetryEvent" -> string!

‎src/Microsoft.TestPlatform.CommunicationUtilities/TelemetryReporter.cs‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
3+
4+
using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities.Interfaces;
5+
using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities.ObjectModel;
6+
using Microsoft.VisualStudio.TestPlatform.ObjectModel;
7+
using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;
8+
9+
namespace Microsoft.VisualStudio.TestPlatform.CommunicationUtilities;
10+
11+
internal class TelemetryReporter : ITelemetryReporter
12+
{
13+
private readonly IRequestData _requestData;
14+
private readonly ICommunicationManager _communicationManager;
15+
private readonly IDataSerializer _dataSerializer;
16+
17+
public TelemetryReporter(IRequestData requestData, ICommunicationManager communicationManager, IDataSerializer dataSerializer)
18+
{
19+
_requestData = requestData;
20+
_communicationManager = communicationManager;
21+
_dataSerializer = dataSerializer;
22+
}
23+
24+
public void Report(TelemetryEvent telemetryEvent)
25+
{
26+
if (_requestData.IsTelemetryOptedIn)
27+
{
28+
string message = _dataSerializer.SerializePayload(MessageType.TelemetryEventMessage, telemetryEvent);
29+
_communicationManager.SendRawMessage(message);
30+
}
31+
}
32+
}

‎src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyExecutionManagerWithDataCollection.cs‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,17 @@ public override int StartTestRun(TestRunCriteria testRunCriteria, IInternalTestR
141141
DataCollectionRunEventsHandler.Messages.Clear();
142142
}
143143

144+
// Push all raw messages
145+
if (DataCollectionRunEventsHandler.RawMessages.Count > 0)
146+
{
147+
foreach (var message in DataCollectionRunEventsHandler.RawMessages)
148+
{
149+
currentEventHandler.HandleRawMessage(message);
150+
}
151+
152+
DataCollectionRunEventsHandler.RawMessages.Clear();
153+
}
154+
144155
return base.StartTestRun(testRunCriteria, currentEventHandler);
145156
}
146157

@@ -190,7 +201,7 @@ public override TestProcessStartInfo UpdateTestProcessStartInfo(TestProcessStart
190201
}
191202

192203
/// <summary>
193-
/// Handles Log events and stores them in list. Messages in the list will be logged after test execution begins.
204+
/// Handles Log and raw messages and stores them in list. Messages in the list will be logged after test execution begins.
194205
/// </summary>
195206
internal class DataCollectionRunEventsHandler : ITestMessageEventHandler
196207
{
@@ -200,13 +211,19 @@ internal class DataCollectionRunEventsHandler : ITestMessageEventHandler
200211
public DataCollectionRunEventsHandler()
201212
{
202213
Messages = new List<Tuple<TestMessageLevel, string?>>();
214+
RawMessages = new List<string>();
203215
}
204216

205217
/// <summary>
206218
/// Gets the cached messages.
207219
/// </summary>
208220
public List<Tuple<TestMessageLevel, string?>> Messages { get; private set; }
209221

222+
/// <summary>
223+
/// Gets the cached raw messages.
224+
/// </summary>
225+
public List<string> RawMessages { get; private set; }
226+
210227
/// <inheritdoc />
211228
public void HandleLogMessage(TestMessageLevel level, string? message)
212229
{
@@ -216,6 +233,6 @@ public void HandleLogMessage(TestMessageLevel level, string? message)
216233
/// <inheritdoc />
217234
public void HandleRawMessage(string rawMessage)
218235
{
219-
throw new NotImplementedException();
236+
RawMessages.Add(rawMessage);
220237
}
221238
}

‎src/Microsoft.TestPlatform.CrossPlatEngine/Client/ProxyOperationManagerWithDataCollection.cs‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,17 @@ public override bool SetupChannel(
120120
DataCollectionRunEventsHandler.Messages.Clear();
121121
}
122122

123+
// Push all raw messages
124+
if (DataCollectionRunEventsHandler.RawMessages.Count > 0)
125+
{
126+
foreach (var message in DataCollectionRunEventsHandler.RawMessages)
127+
{
128+
eventHandler.HandleRawMessage(message);
129+
}
130+
131+
DataCollectionRunEventsHandler.RawMessages.Clear();
132+
}
133+
123134
return base.SetupChannel(sources, runSettings);
124135
}
125136

‎src/Microsoft.TestPlatform.ObjectModel/Client/Interfaces/IInternalTestRunEventsHandler.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
namespace Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;
99

1010
/// <summary>
11-
/// Interface contract for handling internal test run events during run. This interface should have methods similar to <see cref="ITestRunEventsHandler"/> <see cref="ITestRunEventsHandler2"/> <see cref="ITestRunEventsHandler3"/>,
11+
/// Interface contract for handling internal test run events during run. This interface should have methods similar to <see cref="ITestRunEventsHandler"/> <see cref="ITestRunEventsHandler2"/>,
1212
/// but only the newest (most broad) version of each method, so that we only operate on the latest interface in the internals, and adapt on the edges.
1313
/// </summary>
1414
public interface IInternalTestRunEventsHandler : ITestMessageEventHandler

0 commit comments

Comments
 (0)