¶ RabbitMQ
Este documento descreve a estrutura de mensageria do projeto e como a API se
conecta ao RabbitMQ.
¶ Objetivo
- Agendar execucoes com a engine de rebates.
- Transmitir progresso em tempo real para o webapp.
- Centralizar configuracoes de exchanges e conexoes.
¶ Como a API se conecta
A conexao e criada no startup da aplicacao e compartilhada via
RabbitMQConnectionManager (ver server/common/messaging/rabbitmq.py).
- Se
RABBITMQ_URLexistir, ela e usada diretamente. - Caso contrario, a conexao usa:
RABBITMQ_HOST,RABBITMQ_PORT,RABBITMQ_VIRTUAL_HOST,
RABBITMQ_USER,RABBITMQ_PASSWORD.
¶ Exchanges usadas
¶ Schedule
- Nome:
SCHEDULE_EXCHANGE - Default:
rebates.execution.schedule - Uso: a API publica mensagens para a engine iniciar o processamento.
¶ Progress
- Nome:
PROGRESS_EXCHANGE - Default:
rebates.execution.progress - Uso: a engine publica mensagens de progresso consumidas pelo websocket.
¶ Mensagens
¶ Schedule message
Mensagem enviada pela API para a engine (uma por rede):
class ExecutionScheduleMessage:
request_id: str
retail_chain_id: int
¶ Endpoints relacionados
POST /rebates-execution/schedule: agenda execucoes e publica mensagens.WS /rebates-execution/progress: envia progresso em tempo real para o cliente.
¶ Estrutura em diagrama
¶ Boas praticas
- Nao reusar exchanges para outros dominios.
- Evitar payloads grandes; preferir ids e dados essenciais.
- Padronizar nomes de exchange/queue por dominio.