Skip to content

Commit 27ff1b8

Browse files
demianovademianova
committed
docs: port diagrams to PlantUML
Fix #1363
1 parent fcbfc64 commit 27ff1b8

10 files changed

+112
-44
lines changed

‎docs/diagrams/create-import-request.png

-31.5 KB
Loading

‎docs/diagrams/create-import-request.txt

+20-6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
@startuml
2+
13
title Series import flow: stage 1 (create import request)
24

35
participant Browser
@@ -7,16 +9,28 @@ participant EventPublisher
79

810
note over Browser,SeriesImportController: request import series form
911
opt GET /series/import/request
10-
Browser->+SeriesImportController:
11-
SeriesImportController->-Browser: RequestSeriesImportForm
12+
Browser->SeriesImportController:
13+
activate SeriesImportController
14+
SeriesImportController->Browser: RequestSeriesImportForm
15+
deactivate SeriesImportController
1216
end
1317

1418
note over Browser,SeriesImportController: submit request for importing a series
1519
opt POST /series/import/request
16-
Browser->+SeriesImportController: RequestSeriesImportForm
17-
SeriesImportController->+SeriesImportService: RequestSeriesImportForm
18-
SeriesImportService->-SeriesImportController: requestId
20+
21+
Browser->SeriesImportController: RequestSeriesImportForm
22+
activate SeriesImportController
23+
24+
SeriesImportController->SeriesImportService: RequestSeriesImportForm
25+
activate SeriesImportService
26+
SeriesImportService->SeriesImportController: requestId
27+
deactivate SeriesImportService
1928
note right of SeriesImportService: Unprocessed
2029
SeriesImportController->EventPublisher: ImportRequestCreated
21-
SeriesImportController->-Browser: redirect to /series/import/request/{id}
30+
31+
SeriesImportController->Browser: redirect to /series/import/request/{id}
32+
deactivate SeriesImportController
33+
2234
end
35+
36+
@enduml

‎docs/diagrams/download-page.png

-39.4 KB
Loading

‎docs/diagrams/download-page.txt

+16-6
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,30 @@
1+
@startuml
2+
13
title Series import flow: stage 2 (download page)
24

35
participant ImportRequestCreatedEventListener
46
participant DownloaderService
57
participant SeriesImportService
68
participant EventPublisher
79

8-
ImportRequestCreatedEventListener->+DownloaderService: url
9-
DownloaderService->-ImportRequestCreatedEventListener:
10+
ImportRequestCreatedEventListener->DownloaderService: url
11+
activate DownloaderService
12+
DownloaderService->ImportRequestCreatedEventListener:
13+
deactivate DownloaderService
1014
alt
11-
ImportRequestCreatedEventListener->+SeriesImportService: content of downloaded page
15+
ImportRequestCreatedEventListener->SeriesImportService: content of downloaded page
16+
activate SeriesImportService
1217
SeriesImportService->SeriesImportService:
13-
SeriesImportService->-ImportRequestCreatedEventListener:
18+
SeriesImportService->ImportRequestCreatedEventListener:
1419
note right of SeriesImportService: Unprocessed -> DownloadingSucceeded
20+
deactivate SeriesImportService
1521
ImportRequestCreatedEventListener->EventPublisher: DownloadingSucceeded
1622
else
17-
ImportRequestCreatedEventListener->+SeriesImportService:
18-
SeriesImportService->-ImportRequestCreatedEventListener:
23+
ImportRequestCreatedEventListener->SeriesImportService:
24+
activate SeriesImportService
25+
SeriesImportService->ImportRequestCreatedEventListener:
1926
note right of SeriesImportService: Unprocessed -> DownloadingFailed
27+
deactivate SeriesImportService
2028
end
29+
30+
@enduml

‎docs/diagrams/import-series.png

-53.3 KB
Loading

‎docs/diagrams/import-series.txt

+40-18
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
@startuml
2+
13
title Series import flow: stage 4 (import a series)
24

35
participant Browser
@@ -9,33 +11,53 @@ participant ParticipantService
911

1012
note over Browser,SeriesImportController: show info about import request
1113
opt GET /series/import/request/{id}
12-
Browser->+SeriesImportController:
13-
SeriesImportController->+SeriesImportService: requestId
14-
SeriesImportService->-SeriesImportController: ImportRequestDto
15-
SeriesImportController->+SeriesImportService: requestId
16-
SeriesImportService->-SeriesImportController: SeriesParsedDataDto
17-
SeriesImportController->+SeriesSalesImportService: requestId
18-
SeriesSalesImportService->-SeriesImportController: SeriesSaleParsedDataDto
19-
SeriesImportController->-Browser: "ImportRequestDto\nImportSeriesForm\nImportSellerForm\nImportSeriesSalesForm"
14+
Browser->SeriesImportController:
15+
activate SeriesImportController
16+
SeriesImportController->SeriesImportService: requestId
17+
activate SeriesImportService
18+
SeriesImportService->SeriesImportController: ImportRequestDto
19+
deactivate SeriesImportService
20+
SeriesImportController->SeriesImportService: requestId
21+
activate SeriesImportService
22+
SeriesImportService->SeriesImportController: SeriesParsedDataDto
23+
deactivate SeriesImportService
24+
SeriesImportController->SeriesSalesImportService: requestId
25+
activate SeriesSalesImportService
26+
SeriesSalesImportService->SeriesImportController: SeriesSaleParsedDataDto
27+
deactivate SeriesSalesImportService
28+
SeriesImportController->Browser: ImportRequestDto\nImportSeriesForm\nImportSellerForm\nImportSeriesSalesForm
29+
deactivate SeriesImportController
2030
end
2131

2232
note over Browser,SeriesImportController: import a series
2333
opt POST /series/import/request/{id}
24-
Browser->+SeriesImportController: ImportSeriesForm
25-
SeriesImportController->+SeriesImportService: "AddSeriesDto\nAddParticipantDto\nAddSeriesSalesDto"
34+
Browser->SeriesImportController: ImportSeriesForm
35+
activate SeriesImportController
36+
SeriesImportController->SeriesImportService: AddSeriesDto\nAddParticipantDto\nAddSeriesSalesDto
37+
activate SeriesImportService
2638
opt Create a series
27-
SeriesImportService->+SeriesService: AddSeriesDto
28-
SeriesService->-SeriesImportService: seriesId
39+
SeriesImportService->SeriesService: AddSeriesDto
40+
activate SeriesService
41+
SeriesService->SeriesImportService: seriesId
42+
deactivate SeriesService
2943
end
3044
opt Create a seller (optional)
31-
SeriesImportService-->+ParticipantService: AddParticipantDto
32-
ParticipantService-->-SeriesImportService: sellerId
45+
SeriesImportService-->ParticipantService: AddParticipantDto
46+
activate ParticipantService
47+
ParticipantService-->SeriesImportService: sellerId
48+
deactivate ParticipantService
3349
end
3450
opt Create a series sale (optional)
35-
SeriesImportService-->+SeriesSalesImportService: AddSeriesSalesDto
36-
SeriesSalesImportService-->-SeriesImportService:
51+
SeriesImportService-->SeriesSalesImportService: AddSeriesSalesDto
52+
activate SeriesSalesImportService
53+
SeriesSalesImportService-->SeriesImportService:
54+
deactivate SeriesSalesImportService
3755
end
38-
SeriesImportService->-SeriesImportController: seriesId
56+
SeriesImportService->SeriesImportController: seriesId
57+
deactivate SeriesImportService
3958
note right of SeriesImportService: ParsingSucceeded -> ImportSucceeded
40-
SeriesImportController->-Browser: redirect to /series/{id}
59+
SeriesImportController->Browser: redirect to /series/{id}
60+
deactivate SeriesImportController
4161
end
62+
63+
@enduml

‎docs/diagrams/parse-page-failed.png

-19.4 KB
Loading

‎docs/diagrams/parse-page-failed.txt

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1+
@startuml
2+
13
title Series import flow: stage 3a (handle error of parsing page)
24

35
participant ParsingFailedEventListener
46
participant SeriesImportService
57

6-
ParsingFailedEventListener->+SeriesImportService:
7-
SeriesImportService->-ParsingFailedEventListener:
8+
ParsingFailedEventListener->SeriesImportService:
9+
activate SeriesImportService
10+
SeriesImportService->ParsingFailedEventListener:
11+
deactivate SeriesImportService
812
note right of SeriesImportService: DownloadingSucceeded -> ParsingFailed
13+
14+
@enduml

‎docs/diagrams/parse-page.png

-78 KB
Loading

‎docs/diagrams/parse-page.txt

+28-12
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
@startuml
2+
13
title Series import flow: stage 3 (parse page)
24

35
participant DownloadingSucceededEventListener
@@ -8,25 +10,39 @@ participant ExtractorService
810
participant SeriesSalesImportService
911
participant EventPublisher
1012

11-
DownloadingSucceededEventListener->+SiteParserService: page URL
12-
SiteParserService->-DownloadingSucceededEventListener: site parser
13-
DownloadingSucceededEventListener->+SeriesImportService: requestId
14-
SeriesImportService->-DownloadingSucceededEventListener: content of downloaded page
15-
DownloadingSucceededEventListener->+SiteParser: content of downloaded page
16-
SiteParser->-DownloadingSucceededEventListener: SeriesInfo
17-
DownloadingSucceededEventListener->+ExtractorService: RawParsedDataDto
18-
ExtractorService->-DownloadingSucceededEventListener: SeriesExtractedInfo
13+
DownloadingSucceededEventListener->SiteParserService: page URL
14+
activate SiteParserService
15+
SiteParserService->DownloadingSucceededEventListener: site parser
16+
deactivate SiteParserService
17+
DownloadingSucceededEventListener->SeriesImportService: requestId
18+
activate SeriesImportService
19+
SeriesImportService->DownloadingSucceededEventListener: content of downloaded page
20+
deactivate SeriesImportService
21+
DownloadingSucceededEventListener->SiteParser: content of downloaded page
22+
activate SiteParser
23+
SiteParser->DownloadingSucceededEventListener: SeriesInfo
24+
deactivate SiteParser
25+
DownloadingSucceededEventListener->ExtractorService: RawParsedDataDto
26+
activate ExtractorService
27+
ExtractorService->DownloadingSucceededEventListener: SeriesExtractedInfo
28+
deactivate ExtractorService
1929
alt
20-
DownloadingSucceededEventListener->+SeriesImportService: SeriesExtractedInfo
30+
DownloadingSucceededEventListener->SeriesImportService: SeriesExtractedInfo
31+
activate SeriesImportService
2132
alt
22-
SeriesImportService-->+SeriesSalesImportService: SeriesSalesParsedDataDbDto
23-
SeriesSalesImportService-->-SeriesImportService:
33+
SeriesImportService-->SeriesSalesImportService: SeriesSalesParsedDataDbDto
34+
activate SeriesSalesImportService
35+
SeriesSalesImportService-->SeriesImportService:
36+
deactivate SeriesSalesImportService
2437
SeriesImportService->SeriesImportService:
2538
note right of SeriesImportService: DownloadingSucceeded -> ParsingSucceeded
2639
else
2740
SeriesImportService->EventPublisher: ParsingFailed
2841
end
29-
SeriesImportService->-DownloadingSucceededEventListener:
42+
SeriesImportService->DownloadingSucceededEventListener:
43+
deactivate SeriesImportService
3044
else
3145
DownloadingSucceededEventListener->EventPublisher: ParsingFailed
3246
end
47+
48+
@enduml

0 commit comments

Comments
 (0)