Desenvolvimento de um bot musical do discord: arquitetura funcional e desenvolvimento orientado por logs

@startuml
!theme plain

title Fluxo de Dados Funcional
participant "Discord Comando" as DC
participant "Validador" as V
participant "Lógica de negócio" as BL
participant "Cliente da API" as AC
participant "Logger" as L

DC -> V: Raw Input
activate V
V -> V: Pydantic Validation
V -> L: Log Validation
V --> DC: Maybe[ValidData]
deactivate V

DC -> BL: ValidData
activate BL
BL -> BL: Pure Computation
BL -> L: Log Business Logic
BL -> AC: API Request
activate AC
AC -> AC: IO Operation
AC -> L: Log API Call
AC --> BL: Maybe[Result]
deactivate AC
BL --> DC: Either[Error, Success]
deactivate BL

DC -> L: Log Final Result

@enduml

@startuml
!theme spacelab

title Log Driven Development Flow

start

:Defina o comportamento esperado;
note right: Especificação dos logs esperados

:Escreva afirmações de log;
note right: Testes baseados nos logs

:Implemente Código Mínimo;
note right: Código apenas suficiente

:Executar & Observar Logs;
note right: Validação comportamental

if (Logs Match Expectations?) then (yes)
  :Refatorar e Otimizar;
  note right: Melhoria contínua
else (no)
  :Depurar via logs;
  note right: Análise das diferenças
  :Correção da Implementação;
endif

:Testes de Integração;
note right: Validação de ponta a ponta

stop

@enduml

INFO: spotify.search.start query="bohemian rhapsody" user_id=123456
DEBUG: spotify.search.validation query_length=16 safe_chars=true
DEBUG: spotify.search.api_call endpoint="/search" params={...}
INFO: spotify.search.success results_count=15 duration_ms=340

@startuml
!theme cerulean-outline

class SpotifyTrack {
  +id: str
  +name: str
  +artists: List[str]
  +duration_ms: int
  +external_urls: Dict[str, str]
  --
  +validate_duration() : bool
  +to_discord_embed() : Embed
}

class YouTubeVideo {
  +id: str
  +title: str
  +duration: timedelta
  +available: bool
  --
  +validate_availability() : bool
  +extract_audio_url() : Optional[str]
}

class DiscordCommand {
  +command: str
  +args: List[str]
  +user: User
  +channel: Channel
  --
  +validate_permissions() : bool
  +log_execution() : None
}

SpotifyTrack --|> BaseModel
YouTubeVideo --|> BaseModel
DiscordCommand --|> BaseModel

@enduml

@startuml
!theme toy

title Fluxo De Tratamento De Erros
participant "Comando" as C
participant "Talvez Monad" as M
participant "Either Monad" as E
participant "Registrador" as L

C -> M: search_query
activate M

alt Valid Query
  M -> E: Success(query)
  activate E
  E -> E: api_call()

  alt API Success
    E -> L: log_success()
    E --> C: Right(result)
  else API Error
    E -> L: log_api_error()
    E --> C: Left(api_error)
  end
  deactivate E

else Invalid Query
  M -> L: log_validation_error()
  M --> C: Nothing
end

deactivate M

@enduml

@startuml
!theme mars

title Estratégia de Fontes Múltiplas
start

:User Request;

:Primary Source\n(Spotify);

if (Available?) then (yes)
  :Return Spotify Data;
  stop
else (no)
  :Log Fallback;
  :Secondary Source\n(YouTube Music);

  if (Available?) then (yes)
    :Return YouTube Data;
    stop
  else (no)
    :Tertiary Source\n(Local Cache);

    if (Available?) then (yes)
      :Return Cached Data;
      :Log Cache Hit;
      stop
    else (no)
      :Return Error;
      :Log Complete Failure;
      stop
    end
  end
end

@enduml

@startuml
!theme vibrant

cloud "Servidores do Discord" {
  [User Commands]
}

node "Ambiente de produção" {
  [Discord Bot]
  [Log Aggregator]
  [Metrics Collector]
  [Health Monitor]
}

database "Armazenamento de logs" {
  [Structured Logs]
  [Error Traces]
  [Performance Metrics]
}

cloud "APIs externas" {
  [Spotify API]
  [YouTube API]
}

[User Commands] --> [Discord Bot]
[Discord Bot] --> [Log Aggregator]
[Discord Bot] --> [Spotify API]
[Discord Bot] --> [YouTube API]
[Log Aggregator] --> [Structured Logs]
[Metrics Collector] --> [Performance Metrics]
[Health Monitor] --> [Error Traces]

@enduml