mirror of
https://github.com/aaronpo97/the-biergarten-app.git
synced 2026-05-31 17:53:59 +00:00
* Update class diagrams * Implement BoundedChannel and multithreaded logging infra * Integrate logging channel system * Update string concatenations to use std::format * Add pretty print log
197 lines
5.2 KiB
Plaintext
197 lines
5.2 KiB
Plaintext
@startuml
|
|
skinparam style strictuml
|
|
skinparam defaultFontName "DM Sans"
|
|
skinparam defaultFontSize 14
|
|
skinparam titleFontName "Volkhov"
|
|
skinparam titleFontSize 20
|
|
skinparam backgroundColor #FAFCF9
|
|
skinparam defaultFontColor #28342A
|
|
skinparam titleFontColor #28342A
|
|
skinparam ArrowColor #628A5B
|
|
|
|
skinparam class {
|
|
BackgroundColor #FAFCF9
|
|
HeaderBackgroundColor #EAF0E8
|
|
BorderColor #547461
|
|
ArrowColor #628A5B
|
|
FontColor #28342A
|
|
}
|
|
|
|
skinparam note {
|
|
BackgroundColor #EAF0E8
|
|
BorderColor #547461
|
|
FontColor #28342A
|
|
}
|
|
|
|
title The Biergarten Data Pipeline - Class Diagram
|
|
|
|
class BiergartenDataGenerator {
|
|
- logger_ : std::shared_ptr<ILogger>
|
|
- context_service_ : std::unique_ptr<IEnrichmentService>
|
|
- generator_ : std::unique_ptr<DataGenerator>
|
|
- exporter_ : std::unique_ptr<IExportService>
|
|
- generated_breweries_ : std::vector<GeneratedBrewery>
|
|
+ Run() : bool
|
|
- QueryCitiesWithCountries() : std::vector<Location>
|
|
- GenerateBreweries(cities : std::span<const EnrichedCity>) : void
|
|
- LogResults() : void
|
|
}
|
|
|
|
class LogLevel <<enumeration>> {
|
|
Debug
|
|
Info
|
|
Warn
|
|
Error
|
|
}
|
|
|
|
class PipelinePhase <<enumeration>> {
|
|
Startup
|
|
UserGeneration
|
|
BreweryAndBeerGeneration
|
|
CheckinGeneration
|
|
RatingGeneration
|
|
FollowGeneration
|
|
Teardown
|
|
}
|
|
|
|
struct LogEntry {
|
|
+ timestamp : std::chrono::system_clock::time_point
|
|
+ level : LogLevel
|
|
+ phase : PipelinePhase
|
|
+ message : std::string
|
|
+ worker : std::optional<std::string>
|
|
}
|
|
|
|
interface ILogger <<interface>> {
|
|
+ Log(entry : const LogEntry&) : void
|
|
}
|
|
|
|
class LogProducer {
|
|
- channel_ : BoundedChannel<LogEntry>&
|
|
+ Log(entry : const LogEntry&) : void
|
|
}
|
|
|
|
class LogDispatcher {
|
|
- channel_ : BoundedChannel<LogEntry>&
|
|
+ Run() : void
|
|
- ToSpdlogLevel(level) : spdlog::level::level_enum
|
|
}
|
|
|
|
interface IEnrichmentService <<interface>> {
|
|
+ GetLocationContext(loc : const Location&) : std::string
|
|
}
|
|
|
|
class WikipediaService {
|
|
- client_ : std::unique_ptr<WebClient>
|
|
- extract_cache_ : std::unordered_map<std::string, std::string>
|
|
+ GetLocationContext(loc : const Location&) : std::string
|
|
- FetchExtract(query : std::string_view) : std::string
|
|
}
|
|
|
|
interface WebClient <<interface>> {
|
|
+ Get(url : const std::string&) : std::string
|
|
+ UrlEncode(value : const std::string&) : std::string
|
|
}
|
|
|
|
class HttpWebClient {
|
|
+ Get(url : const std::string&) : std::string
|
|
+ UrlEncode(value : const std::string&) : std::string
|
|
}
|
|
|
|
interface DataGenerator <<interface>> {
|
|
+ GenerateBrewery(location : const Location&, region_context : const std::string&) : BreweryResult
|
|
+ GenerateUser(locale : const std::string&) : UserResult
|
|
}
|
|
|
|
class MockGenerator {
|
|
+ GenerateBrewery(...) : BreweryResult
|
|
+ GenerateUser(...) : UserResult
|
|
- DeterministicHash(location : const Location&) : size_t
|
|
}
|
|
|
|
class LlamaGenerator {
|
|
- model_ : ModelHandle
|
|
- context_ : ContextHandle
|
|
- prompt_formatter_ : std::unique_ptr<IPromptFormatter>
|
|
- rng_ : std::mt19937
|
|
+ GenerateBrewery(...) : BreweryResult
|
|
+ GenerateUser(...) : UserResult
|
|
- Load(model_path : const std::string&) : void
|
|
- Infer(...) : std::string
|
|
- InferFormatted(...) : std::string
|
|
- LoadBrewerySystemPrompt(...) : std::string
|
|
}
|
|
|
|
interface IPromptFormatter <<interface>> {
|
|
+ Format(system_prompt : std::string_view, user_prompt : std::string_view) : std::string
|
|
}
|
|
|
|
class Gemma4JinjaPromptFormatter {
|
|
+ Format(system_prompt : std::string_view, user_prompt : std::string_view) : std::string
|
|
}
|
|
|
|
class JsonLoader {
|
|
+ {static} LoadLocations(filepath : const std::filesystem::path&) : std::vector<Location>
|
|
}
|
|
|
|
interface IExportService <<interface>> {
|
|
+ Initialize() : void
|
|
+ ProcessRecord(brewery : const GeneratedBrewery&) : void
|
|
+ Finalize() : void
|
|
}
|
|
|
|
class SqliteExportService {
|
|
- date_time_provider_ : std::unique_ptr<IDateTimeProvider>
|
|
- run_timestamp_utc_ : std::string
|
|
- database_path_ : std::filesystem::path
|
|
- db_handle_ : sqlite3*
|
|
- insert_location_stmt_ : sqlite3_stmt*
|
|
- insert_brewery_stmt_ : sqlite3_stmt*
|
|
- transaction_open_ : bool
|
|
- location_cache_ : std::unordered_map<std::string, sqlite3_int64>
|
|
+ Initialize() : void
|
|
+ ProcessRecord(brewery : const GeneratedBrewery&) : void
|
|
+ Finalize() : void
|
|
- InitializeSchema() : void
|
|
}
|
|
|
|
interface IDateTimeProvider <<interface>> {
|
|
+ GetUtcTimestamp() : std::string
|
|
}
|
|
|
|
class SystemDateTimeProvider {
|
|
+ GetUtcTimestamp() : std::string
|
|
}
|
|
|
|
' Structural Relationships / Dependency Injection
|
|
BiergartenDataGenerator *-- ILogger : owns
|
|
BiergartenDataGenerator *-- IEnrichmentService : owns
|
|
BiergartenDataGenerator *-- DataGenerator : owns
|
|
BiergartenDataGenerator *-- IExportService : owns
|
|
|
|
LogEntry *-- LogLevel
|
|
LogEntry *-- PipelinePhase
|
|
ILogger <|.. LogProducer : implements
|
|
LogProducer ..> LogEntry : emits
|
|
LogDispatcher ..> LogEntry : consumes
|
|
|
|
IEnrichmentService <|.. WikipediaService : implements
|
|
WikipediaService *-- WebClient : owns
|
|
|
|
WebClient <|.. HttpWebClient : implements
|
|
|
|
DataGenerator <|.. MockGenerator : implements
|
|
DataGenerator <|.. LlamaGenerator : implements
|
|
|
|
LlamaGenerator *-- IPromptFormatter : uses
|
|
|
|
IPromptFormatter <|.. Gemma4JinjaPromptFormatter : implements
|
|
|
|
BiergartenDataGenerator ..> JsonLoader : uses
|
|
|
|
IExportService <|.. SqliteExportService : implements
|
|
SqliteExportService *-- IDateTimeProvider : owns
|
|
IDateTimeProvider <|.. SystemDateTimeProvider : implements
|
|
|
|
@enduml
|