Skip to content

docs: port diagrams to PlantUML #1379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/diagrams/create-import-request.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 20 additions & 6 deletions docs/diagrams/create-import-request.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
@startuml

title Series import flow: stage 1 (create import request)

participant Browser
Expand All @@ -7,16 +9,28 @@ participant EventPublisher

note over Browser,SeriesImportController: request import series form
opt GET /series/import/request
Browser->+SeriesImportController:
SeriesImportController->-Browser: RequestSeriesImportForm
Browser->SeriesImportController:
activate SeriesImportController
SeriesImportController->Browser: RequestSeriesImportForm
deactivate SeriesImportController
end

note over Browser,SeriesImportController: submit request for importing a series
opt POST /series/import/request
Browser->+SeriesImportController: RequestSeriesImportForm
SeriesImportController->+SeriesImportService: RequestSeriesImportForm
SeriesImportService->-SeriesImportController: requestId

Browser->SeriesImportController: RequestSeriesImportForm
activate SeriesImportController

SeriesImportController->SeriesImportService: RequestSeriesImportForm
activate SeriesImportService
SeriesImportService->SeriesImportController: requestId
deactivate SeriesImportService
note right of SeriesImportService: Unprocessed
SeriesImportController->EventPublisher: ImportRequestCreated
SeriesImportController->-Browser: redirect to /series/import/request/{id}

SeriesImportController->Browser: redirect to /series/import/request/{id}
deactivate SeriesImportController

end

@enduml
Binary file modified docs/diagrams/download-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 16 additions & 6 deletions docs/diagrams/download-page.txt
Original file line number Diff line number Diff line change
@@ -1,20 +1,30 @@
@startuml

title Series import flow: stage 2 (download page)

participant ImportRequestCreatedEventListener
participant DownloaderService
participant SeriesImportService
participant EventPublisher

ImportRequestCreatedEventListener->+DownloaderService: url
DownloaderService->-ImportRequestCreatedEventListener:
ImportRequestCreatedEventListener->DownloaderService: url
activate DownloaderService
DownloaderService->ImportRequestCreatedEventListener:
deactivate DownloaderService
alt
ImportRequestCreatedEventListener->+SeriesImportService: content of downloaded page
ImportRequestCreatedEventListener->SeriesImportService: content of downloaded page
activate SeriesImportService
SeriesImportService->SeriesImportService:
SeriesImportService->-ImportRequestCreatedEventListener:
SeriesImportService->ImportRequestCreatedEventListener:
note right of SeriesImportService: Unprocessed -> DownloadingSucceeded
deactivate SeriesImportService
ImportRequestCreatedEventListener->EventPublisher: DownloadingSucceeded
else
ImportRequestCreatedEventListener->+SeriesImportService:
SeriesImportService->-ImportRequestCreatedEventListener:
ImportRequestCreatedEventListener->SeriesImportService:
activate SeriesImportService
SeriesImportService->ImportRequestCreatedEventListener:
note right of SeriesImportService: Unprocessed -> DownloadingFailed
deactivate SeriesImportService
end

@enduml
Binary file modified docs/diagrams/import-series.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
58 changes: 40 additions & 18 deletions docs/diagrams/import-series.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
@startuml

title Series import flow: stage 4 (import a series)

participant Browser
Expand All @@ -9,33 +11,53 @@ participant ParticipantService

note over Browser,SeriesImportController: show info about import request
opt GET /series/import/request/{id}
Browser->+SeriesImportController:
SeriesImportController->+SeriesImportService: requestId
SeriesImportService->-SeriesImportController: ImportRequestDto
SeriesImportController->+SeriesImportService: requestId
SeriesImportService->-SeriesImportController: SeriesParsedDataDto
SeriesImportController->+SeriesSalesImportService: requestId
SeriesSalesImportService->-SeriesImportController: SeriesSaleParsedDataDto
SeriesImportController->-Browser: "ImportRequestDto\nImportSeriesForm\nImportSellerForm\nImportSeriesSalesForm"
Browser->SeriesImportController:
activate SeriesImportController
SeriesImportController->SeriesImportService: requestId
activate SeriesImportService
SeriesImportService->SeriesImportController: ImportRequestDto
deactivate SeriesImportService
SeriesImportController->SeriesImportService: requestId
activate SeriesImportService
SeriesImportService->SeriesImportController: SeriesParsedDataDto
deactivate SeriesImportService
SeriesImportController->SeriesSalesImportService: requestId
activate SeriesSalesImportService
SeriesSalesImportService->SeriesImportController: SeriesSaleParsedDataDto
deactivate SeriesSalesImportService
SeriesImportController->Browser: ImportRequestDto\nImportSeriesForm\nImportSellerForm\nImportSeriesSalesForm
deactivate SeriesImportController
end

note over Browser,SeriesImportController: import a series
opt POST /series/import/request/{id}
Browser->+SeriesImportController: ImportSeriesForm
SeriesImportController->+SeriesImportService: "AddSeriesDto\nAddParticipantDto\nAddSeriesSalesDto"
Browser->SeriesImportController: ImportSeriesForm
activate SeriesImportController
SeriesImportController->SeriesImportService: AddSeriesDto\nAddParticipantDto\nAddSeriesSalesDto
activate SeriesImportService
opt Create a series
SeriesImportService->+SeriesService: AddSeriesDto
SeriesService->-SeriesImportService: seriesId
SeriesImportService->SeriesService: AddSeriesDto
activate SeriesService
SeriesService->SeriesImportService: seriesId
deactivate SeriesService
end
opt Create a seller (optional)
SeriesImportService-->+ParticipantService: AddParticipantDto
ParticipantService-->-SeriesImportService: sellerId
SeriesImportService-->ParticipantService: AddParticipantDto
activate ParticipantService
ParticipantService-->SeriesImportService: sellerId
deactivate ParticipantService
end
opt Create a series sale (optional)
SeriesImportService-->+SeriesSalesImportService: AddSeriesSalesDto
SeriesSalesImportService-->-SeriesImportService:
SeriesImportService-->SeriesSalesImportService: AddSeriesSalesDto
activate SeriesSalesImportService
SeriesSalesImportService-->SeriesImportService:
deactivate SeriesSalesImportService
end
SeriesImportService->-SeriesImportController: seriesId
SeriesImportService->SeriesImportController: seriesId
deactivate SeriesImportService
note right of SeriesImportService: ParsingSucceeded -> ImportSucceeded
SeriesImportController->-Browser: redirect to /series/{id}
SeriesImportController->Browser: redirect to /series/{id}
deactivate SeriesImportController
end

@enduml
Binary file modified docs/diagrams/parse-page-failed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 8 additions & 2 deletions docs/diagrams/parse-page-failed.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
@startuml

title Series import flow: stage 3a (handle error of parsing page)

participant ParsingFailedEventListener
participant SeriesImportService

ParsingFailedEventListener->+SeriesImportService:
SeriesImportService->-ParsingFailedEventListener:
ParsingFailedEventListener->SeriesImportService:
activate SeriesImportService
SeriesImportService->ParsingFailedEventListener:
deactivate SeriesImportService
note right of SeriesImportService: DownloadingSucceeded -> ParsingFailed

@enduml
Binary file modified docs/diagrams/parse-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 28 additions & 12 deletions docs/diagrams/parse-page.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
@startuml

title Series import flow: stage 3 (parse page)

participant DownloadingSucceededEventListener
Expand All @@ -8,25 +10,39 @@ participant ExtractorService
participant SeriesSalesImportService
participant EventPublisher

DownloadingSucceededEventListener->+SiteParserService: page URL
SiteParserService->-DownloadingSucceededEventListener: site parser
DownloadingSucceededEventListener->+SeriesImportService: requestId
SeriesImportService->-DownloadingSucceededEventListener: content of downloaded page
DownloadingSucceededEventListener->+SiteParser: content of downloaded page
SiteParser->-DownloadingSucceededEventListener: SeriesInfo
DownloadingSucceededEventListener->+ExtractorService: RawParsedDataDto
ExtractorService->-DownloadingSucceededEventListener: SeriesExtractedInfo
DownloadingSucceededEventListener->SiteParserService: page URL
activate SiteParserService
SiteParserService->DownloadingSucceededEventListener: site parser
deactivate SiteParserService
DownloadingSucceededEventListener->SeriesImportService: requestId
activate SeriesImportService
SeriesImportService->DownloadingSucceededEventListener: content of downloaded page
deactivate SeriesImportService
DownloadingSucceededEventListener->SiteParser: content of downloaded page
activate SiteParser
SiteParser->DownloadingSucceededEventListener: SeriesInfo
deactivate SiteParser
DownloadingSucceededEventListener->ExtractorService: RawParsedDataDto
activate ExtractorService
ExtractorService->DownloadingSucceededEventListener: SeriesExtractedInfo
deactivate ExtractorService
alt
DownloadingSucceededEventListener->+SeriesImportService: SeriesExtractedInfo
DownloadingSucceededEventListener->SeriesImportService: SeriesExtractedInfo
activate SeriesImportService
alt
SeriesImportService-->+SeriesSalesImportService: SeriesSalesParsedDataDbDto
SeriesSalesImportService-->-SeriesImportService:
SeriesImportService-->SeriesSalesImportService: SeriesSalesParsedDataDbDto
activate SeriesSalesImportService
SeriesSalesImportService-->SeriesImportService:
deactivate SeriesSalesImportService
SeriesImportService->SeriesImportService:
note right of SeriesImportService: DownloadingSucceeded -> ParsingSucceeded
else
SeriesImportService->EventPublisher: ParsingFailed
end
SeriesImportService->-DownloadingSucceededEventListener:
SeriesImportService->DownloadingSucceededEventListener:
deactivate SeriesImportService
else
DownloadingSucceededEventListener->EventPublisher: ParsingFailed
end

@enduml