| | | 1 | | using Elsa.Authorization; |
| | | 2 | | using Bpmn.Interchange; |
| | | 3 | | using Bpmn.Semantics; |
| | | 4 | | using Elsa.Abstractions; |
| | | 5 | | using Elsa.Bpmn.Interchange.Exceptions; |
| | | 6 | | using Elsa.Bpmn.Interchange.Services; |
| | | 7 | | using JetBrains.Annotations; |
| | | 8 | | using Microsoft.AspNetCore.Http; |
| | | 9 | | |
| | | 10 | | namespace Elsa.Bpmn.Interchange.Endpoints.Bpmn.Import; |
| | | 11 | | |
| | | 12 | | /// <summary> |
| | | 13 | | /// Reads a <c>.bpmn</c> document and persists it as a workflow definition whose root is the <see cref="Elsa.Bpmn.Activi |
| | | 14 | | /// scope <c>BpmnWorkBinder</c> builds for it. |
| | | 15 | | /// </summary> |
| | | 16 | | /// <remarks> |
| | | 17 | | /// A thin wrapper over <see cref="BpmnInterchangeDocumentService.ImportAsync"/>. Its remarks explain why capability |
| | | 18 | | /// refusal is surfaced here rather than left to first execution, and why nothing beyond the source XML is persisted |
| | | 19 | | /// alongside the bound activity graph. |
| | | 20 | | /// </remarks> |
| | | 21 | | [UsedImplicitly] |
| | 14 | 22 | | internal sealed class Import(BpmnInterchangeDocumentService documentService) : ElsaEndpoint<Request> |
| | | 23 | | { |
| | | 24 | | /// <inheritdoc /> |
| | | 25 | | public override void Configure() |
| | | 26 | | { |
| | 11 | 27 | | Post("bpmn/import"); |
| | 11 | 28 | | AllowFileUploads(); |
| | 11 | 29 | | RequirePermission(Elsa.Bpmn.Interchange.Permissions.BpmnPermissions.Definitions, CoreVerbs.Write); |
| | 11 | 30 | | } |
| | | 31 | | |
| | | 32 | | /// <inheritdoc /> |
| | | 33 | | public override async Task HandleAsync(Request request, CancellationToken cancellationToken) |
| | | 34 | | { |
| | 3 | 35 | | if (Files.Count != 1) |
| | | 36 | | { |
| | 0 | 37 | | AddError("Upload exactly one .bpmn file."); |
| | 0 | 38 | | await Send.ErrorsAsync(StatusCodes.Status400BadRequest, cancellationToken); |
| | 0 | 39 | | return; |
| | | 40 | | } |
| | | 41 | | |
| | 3 | 42 | | var xml = await BpmnUploadedFileReader.ReadTextAsync(Files[0], cancellationToken); |
| | | 43 | | |
| | | 44 | | BpmnDocumentImportResult result; |
| | | 45 | | |
| | | 46 | | try |
| | | 47 | | { |
| | 3 | 48 | | result = await documentService.ImportAsync(xml, request.DefinitionId, request.Name, request.ProcessId, cance |
| | 2 | 49 | | } |
| | 0 | 50 | | catch (BpmnInterchangeException exception) |
| | | 51 | | { |
| | 0 | 52 | | AddError(exception.Message); |
| | 0 | 53 | | await Send.ErrorsAsync(StatusCodes.Status400BadRequest, cancellationToken); |
| | 0 | 54 | | return; |
| | | 55 | | } |
| | 1 | 56 | | catch (BpmnBindingException exception) |
| | | 57 | | { |
| | 1 | 58 | | AddError(exception.Message); |
| | 1 | 59 | | await Send.ErrorsAsync(StatusCodes.Status422UnprocessableEntity, cancellationToken); |
| | 1 | 60 | | return; |
| | | 61 | | } |
| | 0 | 62 | | catch (BpmnCapabilityException exception) |
| | | 63 | | { |
| | 0 | 64 | | AddCapabilityErrors(exception); |
| | 0 | 65 | | await Send.ErrorsAsync(StatusCodes.Status422UnprocessableEntity, cancellationToken); |
| | 0 | 66 | | return; |
| | | 67 | | } |
| | | 68 | | |
| | 2 | 69 | | if (!result.ImportResult.Succeeded) |
| | | 70 | | { |
| | 0 | 71 | | foreach (var validationError in result.ImportResult.ValidationErrors) |
| | 0 | 72 | | AddError(validationError.Message); |
| | | 73 | | |
| | 0 | 74 | | await Send.ErrorsAsync(StatusCodes.Status400BadRequest, cancellationToken); |
| | 0 | 75 | | return; |
| | | 76 | | } |
| | | 77 | | |
| | 2 | 78 | | var definition = result.ImportResult.WorkflowDefinition; |
| | | 79 | | |
| | 2 | 80 | | await Send.OkAsync(new Response |
| | 2 | 81 | | { |
| | 2 | 82 | | Id = definition.Id, |
| | 2 | 83 | | DefinitionId = definition.DefinitionId, |
| | 2 | 84 | | Version = definition.Version, |
| | 2 | 85 | | Analysis = BpmnImportAnalysisModel.From(result.Analysis) |
| | 2 | 86 | | }, cancellationToken); |
| | 3 | 87 | | } |
| | | 88 | | |
| | | 89 | | /// <remarks> |
| | | 90 | | /// <see cref="BpmnCapabilityException"/> carries <see cref="BpmnCapabilityException.DrivingElementIds"/> as a |
| | | 91 | | /// single flat list, already unioned across every missing capability — it does not say which element drove which |
| | | 92 | | /// capability (unlike <c>BpmnCapabilityRequirements.DrivingElementIds</c>, which is per-capability, but that type |
| | | 93 | | /// is gone by the time this catch clause sees the exception). Attributing the full, unioned list to each |
| | | 94 | | /// capability individually would put elements next to a capability they may have nothing to do with, so this |
| | | 95 | | /// reports the missing capabilities together with the combined element list once, rather than repeating it. |
| | | 96 | | /// </remarks> |
| | | 97 | | private void AddCapabilityErrors(BpmnCapabilityException exception) |
| | | 98 | | { |
| | 0 | 99 | | var missingCapabilities = string.Join(", ", BpmnInterchangeDocumentService.IndividualCapabilities.Where(capabili |
| | 0 | 100 | | var elementIds = string.Join(", ", exception.DrivingElementIds); |
| | | 101 | | |
| | 0 | 102 | | AddError( |
| | 0 | 103 | | $"This deployment does not declare the following BPMN host capabilities the document requires: {missingCapab |
| | 0 | 104 | | + $"Offending elements (combined across all missing capabilities above, not attributable to any one of them) |
| | 0 | 105 | | } |
| | | 106 | | } |