Skip to content

Commit bfd4264

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

10 files changed

+90
-44
lines changed

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

-31.5 KB
Loading

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

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,26 @@ participant EventPublisher
77

88
note over Browser,SeriesImportController: request import series form
99
opt GET /series/import/request
10-
Browser->+SeriesImportController:
11-
SeriesImportController->-Browser: RequestSeriesImportForm
10+
Browser->SeriesImportController:
11+
activate SeriesImportController
12+
SeriesImportController->Browser: RequestSeriesImportForm
13+
deactivate SeriesImportController
1214
end
1315

1416
note over Browser,SeriesImportController: submit request for importing a series
1517
opt POST /series/import/request
16-
Browser->+SeriesImportController: RequestSeriesImportForm
17-
SeriesImportController->+SeriesImportService: RequestSeriesImportForm
18-
SeriesImportService->-SeriesImportController: requestId
18+
19+
Browser->SeriesImportController: RequestSeriesImportForm
20+
activate SeriesImportController
21+
22+
SeriesImportController->SeriesImportService: RequestSeriesImportForm
23+
activate SeriesImportService
24+
SeriesImportService->SeriesImportController: requestId
25+
deactivate SeriesImportService
1926
note right of SeriesImportService: Unprocessed
2027
SeriesImportController->EventPublisher: ImportRequestCreated
21-
SeriesImportController->-Browser: redirect to /series/import/request/{id}
28+
29+
SeriesImportController->Browser: redirect to /series/import/request/{id}
30+
deactivate SeriesImportController
31+
2232
end

‎docs/diagrams/download-page.png

-39.6 KB
Loading

‎docs/diagrams/download-page.txt

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,20 @@ participant DownloaderService
55
participant SeriesImportService
66
participant EventPublisher
77

8-
ImportRequestCreatedEventListener->+DownloaderService: url
9-
DownloaderService->-ImportRequestCreatedEventListener:
8+
ImportRequestCreatedEventListener->DownloaderService: url
9+
DownloaderService->ImportRequestCreatedEventListener:
1010
alt
11-
ImportRequestCreatedEventListener->+SeriesImportService: content of downloaded page
11+
ImportRequestCreatedEventListener->SeriesImportService: content of downloaded page
12+
activate SeriesImportService
1213
SeriesImportService->SeriesImportService:
13-
SeriesImportService->-ImportRequestCreatedEventListener:
14+
SeriesImportService->ImportRequestCreatedEventListener:
1415
note right of SeriesImportService: Unprocessed -> DownloadingSucceeded
16+
deactivate SeriesImportService
1517
ImportRequestCreatedEventListener->EventPublisher: DownloadingSucceeded
1618
else
17-
ImportRequestCreatedEventListener->+SeriesImportService:
18-
SeriesImportService->-ImportRequestCreatedEventListener:
19+
ImportRequestCreatedEventListener->SeriesImportService:
20+
activate SeriesImportService
21+
SeriesImportService->ImportRequestCreatedEventListener:
1922
note right of SeriesImportService: Unprocessed -> DownloadingFailed
23+
deactivate SeriesImportService
2024
end

‎docs/diagrams/import-series.png

-53.3 KB
Loading

‎docs/diagrams/import-series.txt

Lines changed: 36 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,33 +9,51 @@ participant ParticipantService
99

1010
note over Browser,SeriesImportController: show info about import request
1111
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"
12+
Browser->SeriesImportController:
13+
activate SeriesImportController
14+
SeriesImportController->SeriesImportService: requestId
15+
activate SeriesImportService
16+
SeriesImportService->SeriesImportController: ImportRequestDto
17+
deactivate SeriesImportService
18+
SeriesImportController->SeriesImportService: requestId
19+
activate SeriesImportService
20+
SeriesImportService->SeriesImportController: SeriesParsedDataDto
21+
deactivate SeriesImportService
22+
SeriesImportController->SeriesSalesImportService: requestId
23+
activate SeriesSalesImportService
24+
SeriesSalesImportService->SeriesImportController: SeriesSaleParsedDataDto
25+
deactivate SeriesSalesImportService
26+
SeriesImportController->Browser: ImportRequestDto\nImportSeriesForm\nImportSellerForm\nImportSeriesSalesForm
27+
deactivate SeriesImportController
2028
end
2129

2230
note over Browser,SeriesImportController: import a series
2331
opt POST /series/import/request/{id}
24-
Browser->+SeriesImportController: ImportSeriesForm
25-
SeriesImportController->+SeriesImportService: "AddSeriesDto\nAddParticipantDto\nAddSeriesSalesDto"
32+
Browser->SeriesImportController: ImportSeriesForm
33+
activate SeriesImportController
34+
SeriesImportController->SeriesImportService: AddSeriesDto\nAddParticipantDto\nAddSeriesSalesDto
35+
activate SeriesImportService
2636
opt Create a series
27-
SeriesImportService->+SeriesService: AddSeriesDto
28-
SeriesService->-SeriesImportService: seriesId
37+
SeriesImportService->SeriesService: AddSeriesDto
38+
activate SeriesService
39+
SeriesService->SeriesImportService: seriesId
40+
deactivate SeriesService
2941
end
3042
opt Create a seller (optional)
31-
SeriesImportService-->+ParticipantService: AddParticipantDto
32-
ParticipantService-->-SeriesImportService: sellerId
43+
SeriesImportService-->ParticipantService: AddParticipantDto
44+
activate ParticipantService
45+
ParticipantService-->SeriesImportService: sellerId
46+
deactivate ParticipantService
3347
end
3448
opt Create a series sale (optional)
35-
SeriesImportService-->+SeriesSalesImportService: AddSeriesSalesDto
36-
SeriesSalesImportService-->-SeriesImportService:
49+
SeriesImportService-->SeriesSalesImportService: AddSeriesSalesDto
50+
activate SeriesSalesImportService
51+
SeriesSalesImportService-->SeriesImportService:
52+
deactivate SeriesSalesImportService
3753
end
38-
SeriesImportService->-SeriesImportController: seriesId
54+
SeriesImportService->SeriesImportController: seriesId
55+
deactivate SeriesImportService
3956
note right of SeriesImportService: ParsingSucceeded -> ImportSucceeded
40-
SeriesImportController->-Browser: redirect to /series/{id}
57+
SeriesImportController->Browser: redirect to /series/{id}
58+
deactivate SeriesImportController
4159
end

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

-19.4 KB
Loading

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title Series import flow: stage 3a (handle error of parsing page)
33
participant ParsingFailedEventListener
44
participant SeriesImportService
55

6-
ParsingFailedEventListener->+SeriesImportService:
7-
SeriesImportService->-ParsingFailedEventListener:
6+
ParsingFailedEventListener->SeriesImportService:
7+
activate SeriesImportService
8+
SeriesImportService->ParsingFailedEventListener:
9+
deactivate SeriesImportService
810
note right of SeriesImportService: DownloadingSucceeded -> ParsingFailed

‎docs/diagrams/parse-page.png

-78 KB
Loading

‎docs/diagrams/parse-page.txt

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,37 @@ participant ExtractorService
88
participant SeriesSalesImportService
99
participant EventPublisher
1010

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
11+
DownloadingSucceededEventListener->SiteParserService: page URL
12+
activate SiteParserService
13+
SiteParserService->DownloadingSucceededEventListener: site parser
14+
deactivate SiteParserService
15+
DownloadingSucceededEventListener->SeriesImportService: requestId
16+
activate SeriesImportService
17+
SeriesImportService->DownloadingSucceededEventListener: content of downloaded page
18+
deactivate SeriesImportService
19+
DownloadingSucceededEventListener->SiteParser: content of downloaded page
20+
activate SiteParser
21+
SiteParser->DownloadingSucceededEventListener: SeriesInfo
22+
deactivate SiteParser
23+
DownloadingSucceededEventListener->ExtractorService: RawParsedDataDto
24+
activate ExtractorService
25+
ExtractorService->DownloadingSucceededEventListener: SeriesExtractedInfo
26+
deactivate ExtractorService
1927
alt
20-
DownloadingSucceededEventListener->+SeriesImportService: SeriesExtractedInfo
28+
DownloadingSucceededEventListener->SeriesImportService: SeriesExtractedInfo
29+
activate SeriesImportService
2130
alt
22-
SeriesImportService-->+SeriesSalesImportService: SeriesSalesParsedDataDbDto
23-
SeriesSalesImportService-->-SeriesImportService:
31+
SeriesImportService-->SeriesSalesImportService: SeriesSalesParsedDataDbDto
32+
activate SeriesSalesImportService
33+
SeriesSalesImportService-->SeriesImportService:
34+
deactivate SeriesSalesImportService
2435
SeriesImportService->SeriesImportService:
2536
note right of SeriesImportService: DownloadingSucceeded -> ParsingSucceeded
2637
else
2738
SeriesImportService->EventPublisher: ParsingFailed
2839
end
29-
SeriesImportService->-DownloadingSucceededEventListener:
40+
SeriesImportService->DownloadingSucceededEventListener:
41+
deactivate SeriesImportService
3042
else
3143
DownloadingSucceededEventListener->EventPublisher: ParsingFailed
3244
end

0 commit comments

Comments
 (0)