This repository has been archived by the owner on Jan 18, 2022. It is now read-only.
/
RedirectedProcess.cs
432 lines (369 loc) · 13.5 KB
/
RedirectedProcess.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
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Improbable.Gdk.Tools.MiniJSON;
using Debug = UnityEngine.Debug;
namespace Improbable.Gdk.Tools
{
public class RedirectedProcessResult
{
public int ExitCode;
public List<string> Stdout;
public List<string> Stderr;
}
[Flags]
public enum OutputRedirectBehaviour
{
/// <summary>
/// <para>No redirected output, only custom outputProcessors are used</para>
/// </summary>
None = 0,
/// <summary>
/// <para>Standard output is immediately redirected to Debug.Log</para>
/// </summary>
RedirectStdOut = 1,
/// <summary>
/// <para>Error output is immediately redirected to Debug.LogError</para>
/// </summary>
RedirectStdErr = 2,
/// <summary>
/// <para>All output is accumulated and then redirected to Debug.Log after the process has finished</para>
/// </summary>
RedirectAccumulatedOutput = 4,
/// <summary>
/// <para>If set will process contained `spatial` output and extract it's messages from JSON</para>
/// </summary>
ProcessSpatialOutput = 8,
}
/// <summary>
/// Runs a windowless process.
/// </summary>
public class RedirectedProcess
{
private string command = string.Empty;
private string[] arguments;
private string workingDirectory;
private readonly List<Action<string>> outputProcessors = new List<Action<string>>();
private readonly List<Action<string>> errorProcessors = new List<Action<string>>();
private OutputRedirectBehaviour outputRedirectBehaviour =
OutputRedirectBehaviour.ProcessSpatialOutput |
OutputRedirectBehaviour.RedirectAccumulatedOutput;
/// <summary>
/// Creates the redirected process for the command.
/// </summary>
/// <param name="command">The filename to run.</param>
public static RedirectedProcess Command(string command)
{
var redirectedProcess = new RedirectedProcess { command = command };
return redirectedProcess;
}
public static RedirectedProcess Spatial(params string[] args)
{
var config = GdkToolsConfiguration.GetOrCreateInstance();
if (!string.IsNullOrEmpty(config.EnvironmentPlatform))
{
args = args
.Append($"--environment={config.EnvironmentPlatform}")
.ToArray();
}
return Command(Tools.Common.SpatialBinary)
.WithArgs(args);
}
/// <summary>
/// Adds arguments to process command call.
/// </summary>
/// <param name="arguments">Parameters that will be passed to the command.</param>
public RedirectedProcess WithArgs(params string[] arguments)
{
this.arguments = this.arguments?.Concat(arguments).ToArray() ?? arguments;
return this;
}
/// <summary>
/// Sets which directory run the process in.
/// </summary>
/// <param name="directory">Working directory of the process.</param>
public RedirectedProcess InDirectory(string directory)
{
workingDirectory = directory;
return this;
}
/// <summary>
/// Adds custom processing for regular output of process.
/// </summary>
/// <remarks>
/// The <see cref="outputProcessor"/> callback will be ran on a different thread to the one which
/// registered it.
/// </remarks>
/// <param name="outputProcessor">Processing action for regular output.</param>
public RedirectedProcess AddOutputProcessing(Action<string> outputProcessor)
{
outputProcessors.Add(outputProcessor);
return this;
}
/// <summary>
/// Adds custom processing for error output of process.
/// </summary>
/// <remarks>
/// The <see cref="errorProcessor"/> callback will be ran on a different thread to the one which
/// registered it.
/// </remarks>
/// <param name="errorProcessor">Processing action for error output.</param>
public RedirectedProcess AddErrorProcessing(Action<string> errorProcessor)
{
errorProcessors.Add(errorProcessor);
return this;
}
/// <summary>
/// Adds custom processing for error output of process.
/// </summary>
/// <param name="redirectBehaviour">Options for redirecting process output to Debug.Log().</param>
public RedirectedProcess RedirectOutputOptions(OutputRedirectBehaviour redirectBehaviour)
{
outputRedirectBehaviour = redirectBehaviour;
return this;
}
/// <summary>
/// Runs the redirected process and waits for it to return.
/// </summary>
public RedirectedProcessResult Run()
{
var processStandardOutput = new List<string>();
var processStandardError = new List<string>();
AddOutputProcessing(output =>
{
lock (processStandardOutput)
{
processStandardOutput.Add(output);
}
});
AddErrorProcessing(error =>
{
lock (processStandardError)
{
processStandardError.Add(error);
}
});
var (process, outputLog) = SetupProcess();
using (process)
{
Start(process);
process.WaitForExit();
var trimmedOutput = outputLog?.ToString().TrimStart();
var result = new RedirectedProcessResult
{
ExitCode = process.ExitCode,
Stdout = processStandardOutput,
Stderr = processStandardError
};
if (string.IsNullOrEmpty(trimmedOutput))
{
return result;
}
if (process.ExitCode == 0)
{
Debug.Log(trimmedOutput);
}
else
{
Debug.LogError(trimmedOutput);
}
return result;
}
}
/// <summary>
/// Runs the redirected process and returns a task which can be waited on.
/// </summary>
/// <param name="token">A cancellation token which can be used for cancelling the underlying process. Default is <see cref="CancellationToken.None"/>.</param>
/// <returns>A task which would return the exit code and output.</returns>
public Task<RedirectedProcessResult> RunAsync(CancellationToken token = default)
{
var processStandardOutput = new List<string>();
var processStandardError = new List<string>();
AddOutputProcessing(output =>
{
lock (processStandardOutput)
{
processStandardOutput.Add(output);
}
});
AddErrorProcessing(error =>
{
lock (processStandardOutput)
{
processStandardError.Add(error);
}
});
var (process, outputLog) = SetupProcess();
var taskCompletionSource = new TaskCompletionSource<RedirectedProcessResult>(TaskCreationOptions.RunContinuationsAsynchronously);
// Register a handler to process the output when it exits.
process.Exited += (sender, args) =>
{
var result = new RedirectedProcessResult
{
ExitCode = process.ExitCode,
Stdout = processStandardOutput,
Stderr = processStandardError
};
taskCompletionSource.SetResult(result);
var trimmedOutput = outputLog?.ToString().TrimStart();
if (string.IsNullOrEmpty(trimmedOutput))
{
process.Dispose();
return;
}
if (process.ExitCode == 0)
{
Debug.Log(trimmedOutput);
}
else
{
Debug.LogError(trimmedOutput);
}
process.Dispose();
};
Start(process);
// Register a handler for when a cancel is requested, we kill the process.
token.Register(() =>
{
if (process.HasExited)
{
return;
}
process.Kill();
});
return taskCompletionSource.Task;
}
private (Process, StringBuilder) SetupProcess()
{
var info = new ProcessStartInfo(command, string.Join(" ", arguments))
{
CreateNoWindow = true,
RedirectStandardError = true,
RedirectStandardOutput = true,
UseShellExecute = false
};
if (!string.IsNullOrEmpty(workingDirectory))
{
info.WorkingDirectory = workingDirectory;
}
var process = new Process
{
StartInfo = info
};
StringBuilder outputLog = null;
if ((outputRedirectBehaviour & OutputRedirectBehaviour.RedirectAccumulatedOutput) !=
OutputRedirectBehaviour.None)
{
outputLog = new StringBuilder();
}
process.OutputDataReceived += (sender, args) =>
{
var outputString = args.Data;
if (string.IsNullOrEmpty(outputString))
{
return;
}
if ((outputRedirectBehaviour & OutputRedirectBehaviour.ProcessSpatialOutput) !=
OutputRedirectBehaviour.None)
{
outputString = ProcessSpatialOutput(outputString);
}
if ((outputRedirectBehaviour & OutputRedirectBehaviour.RedirectStdOut) !=
OutputRedirectBehaviour.None)
{
Debug.Log(outputString);
}
if (outputLog != null)
{
lock (outputLog)
{
outputLog.AppendLine(ProcessSpatialOutput(outputString));
}
}
foreach (var outputProcessor in outputProcessors)
{
try
{
outputProcessor.Invoke(outputString);
}
catch (Exception e)
{
Debug.LogException(e);
}
}
};
process.ErrorDataReceived += (sender, args) =>
{
var errorString = args.Data;
if (string.IsNullOrEmpty(errorString))
{
return;
}
if ((outputRedirectBehaviour & OutputRedirectBehaviour.ProcessSpatialOutput) !=
OutputRedirectBehaviour.None)
{
errorString = ProcessSpatialOutput(errorString);
}
if ((outputRedirectBehaviour & OutputRedirectBehaviour.RedirectStdErr) !=
OutputRedirectBehaviour.None)
{
Debug.LogError(errorString);
}
if (outputLog != null)
{
lock (outputLog)
{
outputLog.AppendLine(ProcessSpatialOutput(errorString));
}
}
foreach (var errorProcessor in errorProcessors)
{
try
{
errorProcessor.Invoke(errorString);
}
catch (Exception e)
{
Debug.LogException(e);
}
}
};
process.EnableRaisingEvents = true;
return (process, outputLog);
}
private static void Start(Process process)
{
if (!process.Start())
{
throw new Exception(
$"Failed to run {process.StartInfo.FileName} {process.StartInfo.Arguments}");
}
process.BeginOutputReadLine();
process.BeginErrorReadLine();
}
private static string ProcessSpatialOutput(string argsData)
{
if (!argsData.StartsWith("{") || !argsData.EndsWith("}"))
{
return argsData;
}
try
{
var logEvent = Json.Deserialize(argsData);
if (logEvent.TryGetValue("msg", out var message))
{
return (string) message;
}
}
catch
{
return argsData;
}
return argsData;
}
}
}