-
Notifications
You must be signed in to change notification settings - Fork 689
/
PluginFactory.cs
459 lines (390 loc) · 17.7 KB
/
PluginFactory.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
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
using System.IO;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
namespace NuGet.Protocol.Plugins
{
/// <summary>
/// A plugin factory.
/// </summary>
public sealed class PluginFactory : IPluginFactory
{
private bool _isDisposed;
private readonly IPluginLogger _logger;
private readonly TimeSpan _pluginIdleTimeout;
private readonly ConcurrentDictionary<string, Lazy<Task<IPlugin>>> _plugins;
/// <summary>
/// Instantiates a new <see cref="PluginFactory" /> class.
/// </summary>
/// <param name="pluginIdleTimeout">The plugin idle timeout.</param>
/// <exception cref="ArgumentOutOfRangeException">Thrown if <paramref name="pluginIdleTimeout" />
/// is less than <see cref="Timeout.InfiniteTimeSpan" />.</exception>
public PluginFactory(TimeSpan pluginIdleTimeout)
{
if (pluginIdleTimeout < Timeout.InfiniteTimeSpan)
{
throw new ArgumentOutOfRangeException(
nameof(pluginIdleTimeout),
pluginIdleTimeout,
Strings.Plugin_IdleTimeoutMustBeGreaterThanOrEqualToInfiniteTimeSpan);
}
_logger = PluginLogger.DefaultInstance;
_pluginIdleTimeout = pluginIdleTimeout;
_plugins = new ConcurrentDictionary<string, Lazy<Task<IPlugin>>>();
}
/// <summary>
/// Disposes of this instance.
/// </summary>
public void Dispose()
{
if (_isDisposed)
{
return;
}
foreach (var entry in _plugins)
{
var lazyTask = entry.Value;
if (lazyTask.IsValueCreated && lazyTask.Value.Status == TaskStatus.RanToCompletion)
{
var plugin = lazyTask.Value.Result;
plugin.Dispose();
}
}
_logger.Dispose();
GC.SuppressFinalize(this);
_isDisposed = true;
}
/// <summary>
/// Asynchronously gets an existing plugin instance or creates a new instance and connects to it.
/// </summary>
/// <param name="filePath">The file path of the plugin.</param>
/// <param name="arguments">Command-line arguments to be supplied to the plugin.</param>
/// <param name="requestHandlers">Request handlers.</param>
/// <param name="options">Connection options.</param>
/// <param name="sessionCancellationToken">A cancellation token for the plugin's lifetime.</param>
/// <returns>A task that represents the asynchronous operation.
/// The task result (<see cref="Task{TResult}.Result" />) returns a <see cref="Plugin" />
/// instance.</returns>
/// <exception cref="ArgumentException">Thrown if <paramref name="filePath" />
/// is either <c>null</c> or empty.</exception>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="arguments" />
/// is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="requestHandlers" />
/// is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="options" />
/// is <c>null</c>.</exception>
/// <exception cref="OperationCanceledException">Thrown if <paramref name="sessionCancellationToken" />
/// is cancelled.</exception>
/// <exception cref="ObjectDisposedException">Thrown if this object is disposed.</exception>
/// <exception cref="ProtocolException">Thrown if a plugin protocol error occurs.</exception>
/// <exception cref="PluginException">Thrown for a plugin failure during creation.</exception>
/// <remarks>This is intended to be called by NuGet client tools.</remarks>
public async Task<IPlugin> GetOrCreateAsync(
string filePath,
IEnumerable<string> arguments,
IRequestHandlers requestHandlers,
ConnectionOptions options,
CancellationToken sessionCancellationToken)
{
if (_isDisposed)
{
throw new ObjectDisposedException(nameof(PluginFactory));
}
if (string.IsNullOrEmpty(filePath))
{
throw new ArgumentException(Strings.ArgumentCannotBeNullOrEmpty, nameof(filePath));
}
if (arguments == null)
{
throw new ArgumentNullException(nameof(arguments));
}
if (requestHandlers == null)
{
throw new ArgumentNullException(nameof(requestHandlers));
}
if (options == null)
{
throw new ArgumentNullException(nameof(options));
}
sessionCancellationToken.ThrowIfCancellationRequested();
var lazyTask = _plugins.GetOrAdd(
filePath,
(path) => new Lazy<Task<IPlugin>>(
() => CreatePluginAsync(filePath, arguments, requestHandlers, options, sessionCancellationToken)));
await lazyTask.Value;
// Manage plugin lifetime by its idleness. Thus, don't allow callers to prematurely dispose of a plugin.
return new NoOpDisposePlugin(lazyTask.Value.Result);
}
private async Task<IPlugin> CreatePluginAsync(
string filePath,
IEnumerable<string> arguments,
IRequestHandlers requestHandlers,
ConnectionOptions options,
CancellationToken sessionCancellationToken)
{
var args = string.Join(" ", arguments);
#if IS_DESKTOP
var startInfo = new ProcessStartInfo(filePath)
{
Arguments = args,
UseShellExecute = false,
RedirectStandardError = false,
RedirectStandardInput = true,
RedirectStandardOutput = true,
StandardOutputEncoding = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false),
WindowStyle = ProcessWindowStyle.Hidden,
};
#else
var startInfo = new ProcessStartInfo
{
FileName = Environment.GetEnvironmentVariable("DOTNET_HOST_PATH") ??
(NuGet.Common.RuntimeEnvironmentHelper.IsWindows ?
"dotnet.exe" :
"dotnet"),
Arguments = $"\"{filePath}\" " + args,
UseShellExecute = false,
RedirectStandardError = false,
RedirectStandardInput = true,
RedirectStandardOutput = true,
StandardOutputEncoding = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false),
WindowStyle = ProcessWindowStyle.Hidden,
};
#endif
var pluginProcess = new PluginProcess(startInfo);
string pluginId = Plugin.CreateNewId();
using (var combinedCancellationTokenSource = CancellationTokenSource.CreateLinkedTokenSource(sessionCancellationToken))
{
// Process ID is unavailable until we start the process; however, we want to wire up this event before
// attempting to start the process in case the process immediately exits.
EventHandler<IPluginProcess> onExited = null;
Connection connection = null;
onExited = (object eventSender, IPluginProcess exitedProcess) =>
{
exitedProcess.Exited -= onExited;
OnPluginProcessExited(exitedProcess, pluginId);
if (connection?.State == ConnectionState.Handshaking)
{
combinedCancellationTokenSource.Cancel();
}
};
pluginProcess.Exited += onExited;
var stopwatch = Stopwatch.StartNew();
pluginProcess.Start();
if (_logger.IsEnabled)
{
WriteCommonLogMessages(_logger);
}
var sender = new Sender(pluginProcess.StandardInput);
var receiver = new StandardOutputReceiver(pluginProcess);
var processingHandler = new InboundRequestProcessingHandler(new HashSet<MessageMethod> { MessageMethod.Handshake, MessageMethod.Log });
var messageDispatcher = new MessageDispatcher(requestHandlers, new RequestIdGenerator(), processingHandler, _logger);
connection = new Connection(messageDispatcher, sender, receiver, options, _logger);
var plugin = new Plugin(
filePath,
connection,
pluginProcess,
isOwnProcess: false,
idleTimeout: _pluginIdleTimeout,
id: pluginId);
if (_logger.IsEnabled)
{
_logger.Write(new PluginInstanceLogMessage(_logger.Now, plugin.Id, PluginState.Started, pluginProcess.Id));
}
try
{
// Wire up handlers before calling ConnectAsync(...).
plugin.Faulted += OnPluginFaulted;
plugin.Idle += OnPluginIdle;
await connection.ConnectAsync(combinedCancellationTokenSource.Token);
// It's critical that this be registered after ConnectAsync(...).
// If it's registered before, stuff could be disposed, which would lead to unexpected exceptions.
// If the plugin process exited before this event is registered, an exception should be caught below.
plugin.Exited += OnPluginExited;
}
catch (ProtocolException ex)
{
plugin.Dispose();
throw new ProtocolException(
string.Format(CultureInfo.CurrentCulture, Strings.Plugin_Exception, plugin.Name, ex.Message));
}
catch (TaskCanceledException ex)
{
stopwatch.Stop();
plugin.Dispose();
throw new PluginException(
string.Format(
CultureInfo.CurrentCulture,
Strings.Plugin_FailedOnCreation,
plugin.Name,
stopwatch.Elapsed.TotalSeconds,
pluginProcess.ExitCode),
ex);
}
catch (Exception)
{
plugin.Dispose();
throw;
}
return plugin;
}
}
/// <summary>
/// Asynchronously creates a plugin instance and connects to it.
/// </summary>
/// <param name="requestHandlers">Request handlers.</param>
/// <param name="options">Connection options.</param>
/// <param name="sessionCancellationToken">A cancellation token for the plugin's lifetime.</param>
/// <returns>A task that represents the asynchronous operation.
/// The task result (<see cref="Task{TResult}.Result" />) returns a <see cref="Plugin" />
/// instance.</returns>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="requestHandlers" />
/// is either <c>null</c> or empty.</exception>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="options" />
/// is either <c>null</c> or empty.</exception>
/// <exception cref="OperationCanceledException">Thrown if <paramref name="sessionCancellationToken" />
/// is cancelled.</exception>
/// <remarks>This is intended to be called by a plugin.</remarks>
public static async Task<IPlugin> CreateFromCurrentProcessAsync(
IRequestHandlers requestHandlers,
ConnectionOptions options,
CancellationToken sessionCancellationToken)
{
if (requestHandlers == null)
{
throw new ArgumentNullException(nameof(requestHandlers));
}
if (options == null)
{
throw new ArgumentNullException(nameof(options));
}
sessionCancellationToken.ThrowIfCancellationRequested();
var encoding = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
var standardInput = new StreamReader(Console.OpenStandardInput(), encoding);
var standardOutput = new StreamWriter(Console.OpenStandardOutput(), encoding);
var sender = new Sender(standardOutput);
var receiver = new StandardInputReceiver(standardInput);
var logger = PluginLogger.DefaultInstance;
if (logger.IsEnabled)
{
WriteCommonLogMessages(logger);
}
var messageDispatcher = new MessageDispatcher(requestHandlers, new RequestIdGenerator(), new InboundRequestProcessingHandler(), logger);
var connection = new Connection(messageDispatcher, sender, receiver, options, logger);
var pluginProcess = new PluginProcess();
// Wire up handlers before calling ConnectAsync(...).
var plugin = new Plugin(
pluginProcess.FilePath,
connection,
pluginProcess,
isOwnProcess: true,
idleTimeout: Timeout.InfiniteTimeSpan);
requestHandlers.TryAdd(MessageMethod.Close, new CloseRequestHandler(plugin));
requestHandlers.TryAdd(MessageMethod.MonitorNuGetProcessExit, new MonitorNuGetProcessExitRequestHandler(plugin));
try
{
await connection.ConnectAsync(sessionCancellationToken);
}
catch (Exception)
{
plugin.Dispose();
throw;
}
return plugin;
}
private void Dispose(IPlugin plugin)
{
if (_logger.IsEnabled)
{
_logger.Write(new PluginInstanceLogMessage(_logger.Now, plugin.Id, PluginState.Disposing));
}
UnregisterEventHandlers(plugin as Plugin);
Lazy<Task<IPlugin>> lazyTask;
if (_plugins.TryRemove(plugin.FilePath, out lazyTask))
{
if (lazyTask.IsValueCreated && lazyTask.Value.Status == TaskStatus.RanToCompletion)
{
using (var pluginSingleton = lazyTask.Value.Result)
{
SendCloseRequest(pluginSingleton);
}
}
}
plugin.Dispose();
if (_logger.IsEnabled)
{
_logger.Write(new PluginInstanceLogMessage(_logger.Now, plugin.Id, PluginState.Disposed));
}
}
private void OnPluginFaulted(object sender, FaultedPluginEventArgs e)
{
var message = string.Format(
CultureInfo.CurrentCulture,
Strings.Plugin_Fault,
e.Plugin.Name,
e.Exception.ToString());
Console.WriteLine(message);
Dispose(e.Plugin);
}
private void OnPluginExited(object sender, PluginEventArgs e)
{
Dispose(e.Plugin);
}
private void OnPluginIdle(object sender, PluginEventArgs e)
{
if (_logger.IsEnabled)
{
_logger.Write(new PluginInstanceLogMessage(_logger.Now, e.Plugin.Id, PluginState.Idle));
}
Dispose(e.Plugin);
}
// This is more reliable than OnPluginExited as this even handler is wired up before the process
// has even started, while OnPluginExited is wired up after.
private void OnPluginProcessExited(IPluginProcess pluginProcess, string pluginId)
{
if (_logger.IsEnabled)
{
_logger.Write(new PluginInstanceLogMessage(_logger.Now, pluginId, PluginState.Exited, pluginProcess.Id));
}
}
private static void SendCloseRequest(IPlugin plugin)
{
var message = plugin.Connection.MessageDispatcher.CreateMessage(
MessageType.Request,
MessageMethod.Close);
using (var cancellationTokenSource = new CancellationTokenSource(PluginConstants.CloseTimeout))
{
try
{
plugin.Connection.SendAsync(message, cancellationTokenSource.Token).Wait();
}
catch (Exception)
{
}
}
}
private void UnregisterEventHandlers(Plugin plugin)
{
if (plugin != null)
{
plugin.Exited -= OnPluginExited;
plugin.Faulted -= OnPluginFaulted;
plugin.Idle -= OnPluginIdle;
}
}
private static void WriteCommonLogMessages(IPluginLogger logger)
{
logger.Write(new AssemblyLogMessage(logger.Now));
logger.Write(new MachineLogMessage(logger.Now));
logger.Write(new EnvironmentVariablesLogMessage(logger.Now));
logger.Write(new ProcessLogMessage(logger.Now));
logger.Write(new ThreadPoolLogMessage(logger.Now));
}
}
}