-
Notifications
You must be signed in to change notification settings - Fork 27
Expand file tree
/
Copy pathProcessEngineController.cs
More file actions
404 lines (355 loc) · 14.4 KB
/
ProcessEngineController.cs
File metadata and controls
404 lines (355 loc) · 14.4 KB
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
// Copyright (c) 2026 Phoenix Contact GmbH & Co. KG
// Licensed under the Apache License, Version 2.0
using System.Threading.Channels;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Moryx.AbstractionLayer.Processes;
using Moryx.AbstractionLayer.Products;
using Moryx.AbstractionLayer.Resources;
using Moryx.AspNetCore;
using Moryx.ControlSystem.Jobs;
using Moryx.ControlSystem.Processes.Endpoints.Extensions;
using Moryx.ControlSystem.Processes.Endpoints.Properties;
using Moryx.ControlSystem.Processes.Endpoints.StreamServices;
using Newtonsoft.Json;
using Newtonsoft.Json.Serialization;
namespace Moryx.ControlSystem.Processes.Endpoints;
/// <summary>
/// Definition of a REST API on the <see cref="IProcessEnging"/> facade.
/// </summary>
[ApiController]
[Route("api/moryx/processes/")]
[Produces("application/json")]
public class ProcessEngineController : ControllerBase
{
private readonly IProcessControl _processControl;
private readonly IProductManagement _productManagement;
private readonly IResourceManagement _resourceManagement;
private readonly IJobManagement _jobManagement;
private static readonly JsonSerializerSettings _serializerSettings = CreateSerializerSettings();
private static JsonSerializerSettings CreateSerializerSettings()
{
var serializerSettings = new JsonSerializerSettings();
serializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
serializerSettings.Converters.Add(new Newtonsoft.Json.Converters.StringEnumConverter());
return serializerSettings;
}
public ProcessEngineController(IProcessControl processControl, IProductManagement productManagement,
IResourceManagement resourceManagement, IJobManagement jobManagement)
{
_processControl = processControl;
_productManagement = productManagement;
_resourceManagement = resourceManagement;
_jobManagement = jobManagement;
}
[HttpGet]
[Route("job")]
[ProducesResponseType(typeof(JobProcessModel[]), StatusCodes.Status200OK)]
[Authorize(Policy = ProcessPermissions.CanView)]
public ActionResult<JobProcessModel[]> GetRunningProcessesOfJob(long jobId, bool allProcesses)
{
try
{
var job = _jobManagement.Get(jobId);
if (allProcesses)
{
return ConvertProcesses(job.AllProcesses);
}
return ConvertProcesses(job.RunningProcesses);
}
catch (Exception)
{
return Array.Empty<JobProcessModel>();
}
}
[HttpGet]
[Route("running")]
[ProducesResponseType(typeof(JobProcessModel[]), StatusCodes.Status200OK)]
[Authorize(Policy = ProcessPermissions.CanView)]
public ActionResult<JobProcessModel[]> GetRunningProcesses()
{
var processes = _processControl.GetRunningProcesses();
if (processes == null)
{
return Array.Empty<JobProcessModel>();
}
return ConvertProcesses(processes);
}
[HttpGet]
[ProducesResponseType(typeof(JobProcessModel[]), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(string), StatusCodes.Status404NotFound)]
[Route("instance/{productInstanceId}")]
[Authorize(Policy = ProcessPermissions.CanView)]
public async Task<ActionResult<JobProcessModel[]>> GetProcesses(long productInstanceId)
{
var productInstance = await _productManagement.LoadInstanceAsync(productInstanceId);
if (productInstance == null)
{
return NotFound($"No product instace corresponding to the Id {productInstanceId} found");
}
var processes = await _processControl.LoadArchivedProcessesAsync(productInstance);
return ConvertProcesses(processes);
}
private JobProcessModel[] ConvertProcesses(IReadOnlyList<Process> processes)
{
var modelList = new List<JobProcessModel>();
foreach (var p in processes)
{
modelList.Add(Converter.ConvertProcess(p, _processControl, _resourceManagement));
}
return modelList.ToArray();
}
[HttpGet]
[ProducesResponseType(typeof(JobProcessModel), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(string), StatusCodes.Status404NotFound)]
[Route("running/{id}")]
[Authorize(Policy = ProcessPermissions.CanView)]
public ActionResult<JobProcessModel> GetProcess(long id)
{
var process = _processControl.GetRunningProcesses(p => p.Id == id).FirstOrDefault();
if (process == null)
{
return NotFound(new MoryxExceptionResponse { Title = Strings.ProcessEngineController_ProcessNotFoundExceptionMessage });
}
return Converter.ConvertProcess(process, _processControl, _resourceManagement);
}
[HttpGet]
[ProducesResponseType(typeof(ProcessActivityModel[]), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(string), StatusCodes.Status404NotFound)]
[Route("running/{id}/activities")]
[Authorize(Policy = ProcessPermissions.CanView)]
public ActionResult<ProcessActivityModel[]> GetActivities(long id)
{
var process = _processControl.GetRunningProcesses(p => p.Id == id).FirstOrDefault();
if (process == null)
{
return NotFound(new MoryxExceptionResponse { Title = Strings.ProcessEngineController_ProcessNotFoundExceptionMessage });
}
var activities = process.GetActivities();
var modelList = new List<ProcessActivityModel>();
foreach (var a in activities)
{
modelList.Add(Converter.ConvertActivity(a, _processControl, _resourceManagement));
}
return modelList.ToArray(); ;
}
[HttpGet]
[ProducesResponseType(typeof(ActivityResourceModel[]), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(string), StatusCodes.Status404NotFound)]
[Route("running/{id}/targets")]
[Authorize(Policy = ProcessPermissions.CanView)]
public ActionResult<ActivityResourceModel[]> GetTargets(long id)
{
var process = _processControl.GetRunningProcesses(p => p.Id == id).FirstOrDefault();
if (process == null)
{
return NotFound(new MoryxExceptionResponse { Title = Strings.ProcessEngineController_ProcessNotFoundExceptionMessage });
}
var targetList = new List<ActivityResourceModel>();
foreach (var t in _processControl.Targets(process))
{
targetList.Add(new ActivityResourceModel { Id = t.Id, Name = t.Name });
}
return targetList.ToArray();
}
[HttpGet]
[ProducesResponseType(typeof(ActivityResourceModel[]), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(MoryxExceptionResponse), StatusCodes.Status404NotFound)]
[Route("running/{id}/targets/{activityId}")]
[Authorize(Policy = ProcessPermissions.CanView)]
public ActionResult<ActivityResourceModel[]> GetTargets(long id, long activityId)
{
var process = _processControl.GetRunningProcesses(p => p.Id == id).FirstOrDefault();
if (process == null)
{
return NotFound(new MoryxExceptionResponse { Title = Strings.ProcessEngineController_ProcessNotFoundExceptionMessage });
}
var activity = process.GetActivities(a => a.Id == activityId).FirstOrDefault();
if (activity == null)
{
return NotFound(new MoryxExceptionResponse { Title = Strings.ProcessEngineController_ActivityNotFoundExceptionMessage });
}
var targetList = new List<ActivityResourceModel>();
foreach (var t in _processControl.Targets(activity))
{
targetList.Add(new ActivityResourceModel { Id = t.Id, Name = t.Name });
}
return targetList.ToArray();
}
[HttpGet]
[Route("stream/processes")]
[ProducesResponseType(typeof(JobProcessModel), StatusCodes.Status200OK)]
public async Task ProcessUpdatesStream(CancellationToken cancellationToken)
{
var response = Response;
response.Headers["Content-Type"] = "text/event-stream";
var serializerSettings = new JsonSerializerSettings();
serializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
serializerSettings.Converters.Add(new Newtonsoft.Json.Converters.StringEnumConverter());
// Define event handling
var processes = Channel.CreateUnbounded<ProcessUpdatedEventArgs>();
var eventHandler = new EventHandler<ProcessUpdatedEventArgs>((_, processEventArgs) =>
{
processes.Writer.TryWrite(processEventArgs);
});
_processControl.ProcessUpdated += eventHandler;
try
{
// Create infinite loop awaiting changes or cancellation
while (!cancellationToken.IsCancellationRequested)
{
// Write processes
var processArgs = await processes.Reader.ReadAsync(cancellationToken);
var processModel = Converter.ConvertProcess(processArgs.Process, _processControl, _resourceManagement);
processModel.State = processArgs.Progress;
var json = JsonConvert.SerializeObject(processModel, _serializerSettings);
await response.WriteAsync($"data: {json}\r\r", cancellationToken);
}
}
catch (OperationCanceledException)
{
}
catch (ChannelClosedException)
{
}
catch (InvalidOperationException)
{
}
finally
{
// Unregister handler from facade
_processControl.ProcessUpdated -= eventHandler;
processes.Writer.TryComplete();
}
await response.CompleteAsync();
}
[HttpGet]
[Route("stream/activities")]
[ProducesResponseType(typeof(ProcessActivityModel), StatusCodes.Status200OK)]
public async Task ActivitiesUpdatesStream(CancellationToken cancellationToken)
{
var response = Response;
response.Headers["Content-Type"] = "text/event-stream";
var activities = Channel.CreateUnbounded<ActivityUpdatedEventArgs>();
// Define event handling
var eventHandler = new EventHandler<ActivityUpdatedEventArgs>((sender, activityEventArgs) =>
{
activities.Writer.TryWrite(activityEventArgs);
});
_processControl.ActivityUpdated += eventHandler;
try
{
// Create infinite loop awaiting changes or cancellation
while (!cancellationToken.IsCancellationRequested)
{
// Write notifications
var activityArgs = await activities.Reader.ReadAsync(cancellationToken);
var activityModel = Converter.ConvertActivity(activityArgs.Activity, _processControl, _resourceManagement);
activityModel.State = activityArgs.Progress.ToString();
var json = JsonConvert.SerializeObject(activityModel, _serializerSettings);
await response.WriteAsync($"data: {json}\r\r", cancellationToken);
}
}
catch (OperationCanceledException)
{
}
catch (ChannelClosedException)
{
}
catch (InvalidOperationException)
{
}
finally
{
// Unregister handler from facade
_processControl.ActivityUpdated -= eventHandler;
activities.Writer.TryComplete();
}
await response.CompleteAsync();
}
#region Process Holder
[HttpGet("holders/groups")]
[ProducesResponseType(typeof(ApiResponse<ProcessHolderGroupModel[]>), StatusCodes.Status200OK)]
public ActionResult<ApiResponse<ProcessHolderGroupModel[]>> GetGroups()
{
return HttpResponse(() =>
{
var allPositions = _resourceManagement.GetResourcesUnsafe<IProcessHolderPosition>(x => true);
var ungrouped = allPositions.GetUngroupedPostions();
var groups = _resourceManagement.GetResourcesUnsafe<IProcessHolderGroup>(x => true);
return new ApiResponse<ProcessHolderGroupModel[]>([.. groups.ToDto(), .. ungrouped.ToDto()]);
});
}
[HttpGet("holders/stream")]
[ProducesResponseType(typeof(ProcessHolderGroupModel), StatusCodes.Status200OK)]
public async Task GroupStream(CancellationToken cancellationToken)
{
var stream = new ProcessHolderGroupStream(_resourceManagement, _serializerSettings);
await stream.Start(HttpContext, cancellationToken);
}
[HttpPost("holders/groups/{id:int}/reset")]
[ProducesResponseType(StatusCodes.Status200OK)]
public ActionResult ResetGroup(long id)
{
return HttpResponse(() =>
{
var group = _resourceManagement.GetResource<IProcessHolderGroup>(x => x.Id == id) ?? throw new KeyNotFoundException($"No ProcessHolderGroup/Resource found with id '{id}'.");
group.Reset();
});
}
[HttpPost("holders/positions/{id:int}/reset")]
[ProducesResponseType(StatusCodes.Status200OK)]
public ActionResult ResetPosition(long id)
{
return HttpResponse(() =>
{
var position = _resourceManagement.GetResource<IProcessHolderPosition>(x => x.Id == id);
if (position == null)
{
throw new KeyNotFoundException($"No ProcessHolderPosition found with id '{id}'.");
}
position.Reset();
});
}
#endregion
private new ActionResult<TResult> HttpResponse<TResult>(Func<TResult> func, Func<TResult, ActionResult<TResult>> onSuccess = null)
{
try
{
var result = func();
if (onSuccess != null)
{
return onSuccess(result);
}
else
{
return Ok(result);
}
}
catch (Exception ex)
{
return MapToResponse(ex);
}
}
private new ActionResult HttpResponse(Action action)
{
try
{
action();
return Ok();
}
catch (Exception ex)
{
return MapToResponse(ex);
}
}
private ObjectResult MapToResponse(Exception ex) => ex switch
{
ResourceNotFoundException _ => NotFound(ex.Message),
ArgumentNullException _ => BadRequest(ex.Message),
ArgumentException _ => BadRequest(ex.Message),
KeyNotFoundException _ => StatusCode(500, ex.Message),
_ => StatusCode(500, ex.Message),
};
}