Eventos do Reporter

O Reporter tem 12 definições únicas de eventos de negócio emitidos. São mensagens CloudEvents 1.0 no modo binário, transportadas pelo RabbitMQ quando STREAMING_ENABLED=true. O Reporter não publica esses fatos no Kafka. Quando o streaming está desligado, o manager e o worker usam um emissor no-op e não iniciam um dispatcher de outbox.

Envelope e roteamento

Todo evento usa ce-source reporter, ce-schemaversion 1.0.0 e um ce-type qualificado pela fonte no formato studio.lerian.reporter.<resource>.<event>. O payload é JSON com chaves em snake_case.

Item do contrato	Valor
Exchange	Valor de `RABBITMQ_REPORT_EVENTS_EXCHANGE`
Chave de roteamento AMQP	Exatamente a chave de definição, como `report.finished`
Tipo de conteúdo	`application/json`
Modo de entrega	Mensagem AMQP persistente
Subject	ID de template, relatório ou prazo
Tenant	Tenant do contexto em `ce-tenantid` e `X-Tenant-ID`; fallback single-tenant quando não há tenant presente
Manifesto	`GET /v1/streaming/events`

Use o envelope compartilhado para o contrato completo de header do CloudEvents.

Semântica de entrega

O Reporter emite o evento depois que a mudança de estado de negócio recebe commit. Erros de publicação não falham a operação subjacente.

Importante: publicação direta, com fallback de outbox durável quando o circuito do broker está aberto.
Crítico: o Reporter pula a publicação direta. Ele sempre persiste o evento no outbox durável para despacho e nova tentativa.
As duas políticas solicitam on_routable_failure, mas as rotas atuais do RabbitMQ não definem um destino DLQ explícito. O publicador vê uma falha roteável. Nenhuma cópia vai para uma rota dead-letter.
A entrega do broker é pelo menos uma vez. Os consumidores devem ser idempotentes e fazer deduplicação com (ce-source, ce-id).

Catálogo de eventos emitidos

Chave de definição	`ce-type`	Política	Disparado quando
`template.created`	`studio.lerian.reporter.template.created`	Importante	O arquivo do template e os metadados são persistidos.
`template.updated`	`studio.lerian.reporter.template.updated`	Importante	Uma atualização do template e qualquer substituição de arquivo são concluídas.
`template.deleted`	`studio.lerian.reporter.template.deleted`	Importante	Uma exclusão de template é concluída; o rollback de criação não o emite.
`report.requested`	`studio.lerian.reporter.report.requested`	Importante	O relatório é persistido como `Processing`, antes de o manager tentar publicar o comando do worker. Isso não comprova que o comando foi enfileirado.
`report.finished`	`studio.lerian.reporter.report.finished`	Crítico	O artefato é armazenado e o status `Finished` recebe commit.
`report.partial`	`studio.lerian.reporter.report.partial`	Crítico	O artefato é armazenado e um status terminal parcial recebe commit.
`report.errored`	`studio.lerian.reporter.report.errored`	Crítico	O manager ou o worker faz commit de um status terminal `Error`.
`deadline.created`	`studio.lerian.reporter.deadline.created`	Importante	Um prazo é persistido.
`deadline.updated`	`studio.lerian.reporter.deadline.updated`	Importante	Uma atualização de prazo é persistida e o registro atualizado é carregado.
`deadline.deleted`	`studio.lerian.reporter.deadline.deleted`	Importante	Um soft delete de prazo é persistido.
`deadline.delivered`	`studio.lerian.reporter.deadline.delivered`	Crítico	A marca de entrega é persistida.
`deadline.delivery_reverted`	`studio.lerian.reporter.deadline.delivery_reverted`	Crítico	A marca de entrega é removida.

Tanto o manager quanto o worker emitem report.errored. Todas as variantes usam um ce-id determinístico reporter.report.error.<report_id>. Por isso, um consumidor que faz deduplicação por (ce-source, ce-id) mantém apenas o primeiro report.errored recebido para um report_id. Transições críticas de prazo usam reporter.deadline.<event_type>.<deadline_id>.<timestamp>.

Contratos `data` completos

Essas declarações no estilo TypeScript espelham o formato JSON transmitido. ? significa que a propriedade é opcional. | null significa que a propriedade está presente, mas pode ser null em JSON. Timestamps são strings RFC 3339.

type RFC3339 = string
type UUID = string

type TemplateCreatedDataV1 = {
  template_id: UUID
  output_format: string
  description: string
  file_name: string
  mapped_datasource_keys: string[]
  mapped_fields_count: number
  created_at: RFC3339
}

type TemplateUpdatedDataV1 = {
  template_id: UUID
  output_format: string
  description: string
  updated_fields: string[]
  file_replaced: boolean
  updated_at: RFC3339
}

type TemplateDeletedDataV1 = {
  template_id: UUID
  hard_delete: boolean
  cascaded_deadlines_deleted: number
  deleted_at: RFC3339
}

type ReportRequestedDataV1 = {
  report_id: UUID
  template_id: UUID
  output_format: string
  status: string
  request_id: string
  filter_datasource_count: number
  template_description: string
}

type ReportFinishedDataV1 = {
  report_id: UUID
  template_id: UUID
  output_format: string
  status: string
  artifact_object_key: string
  artifact_content_type: string
  artifact_ttl?: string
  completed_at: RFC3339
  duration_ms: number
  section_count: number
}

type ReportPartialDataV1 = {
  report_id: UUID
  template_id: UUID
  output_format: string
  status: string
  artifact_object_key: string
  artifact_content_type: string
  section_failures: string[]
  completed_at: RFC3339
  duration_ms: number
  section_count: number
  failed_section_count: number
}

type ManagerReportErroredDataV1 = {
  report_id: UUID
  status: string
  error_code: "report_generation_failed"
  error_summary: "Report generation failed"
  completed_at: RFC3339
}

type WorkerTerminalReportErroredDataV1 = {
  report_id: UUID
  template_id: UUID
  output_format: string
  status: string
  error_code: "report_generation_failed"
  error_summary: "All report data sections failed"
  completed_at: RFC3339
  duration_ms: number
}

type WorkerFunnelReportErroredDataV1 = {
  report_id: UUID
  template_id?: UUID
  output_format?: string
  status: string
  error_code:
    | "report_generation_failed"
    | "report_generation_timeout"
    | "report_generation_canceled"
  error_summary: string
  completed_at: RFC3339
  duration_ms?: number
}

type ReportErroredDataV1 =
  | ManagerReportErroredDataV1
  | WorkerTerminalReportErroredDataV1
  | WorkerFunnelReportErroredDataV1

type DeadlineCreatedDataV1 = {
  deadline_id: UUID
  name: string
  type: string
  template_id: UUID | null
  template_name: string
  due_date: RFC3339
  frequency: string
  months_of_year: number[]
  active: boolean
  notify_days_before: number
  color: string
  status_snapshot: string
  created_at: RFC3339
}

type DeadlineUpdatedDataV1 = {
  deadline_id: UUID
  updated_fields: string[]
  template_id: UUID | null
  template_name: string
  due_date: RFC3339
  frequency: string
  months_of_year: number[]
  active: boolean
  status_snapshot: string
  updated_at: RFC3339
}

type DeadlineDeletedDataV1 = {
  deadline_id: UUID
  soft_delete: boolean
  deleted_at: RFC3339
}

type DeadlineDeliveredDataV1 = {
  deadline_id: UUID
  template_id: UUID | null
  template_name: string
  type: string
  due_date: RFC3339
  delivered_at: RFC3339 | null
  status_snapshot: string
  frequency: string
  next_occurrence: RFC3339 | null
  updated_at: RFC3339
}

type DeadlineDeliveryRevertedDataV1 = {
  deadline_id: UUID
  template_id: UUID | null
  template_name: string
  type: string
  due_date: RFC3339
  reverted_at: RFC3339
  previous_delivered_at: RFC3339 | null
  status_snapshot: string
  frequency: string
  updated_at: RFC3339
}

Canal de comando interno separado

O manager envia ao worker um comando JSON que não é CloudEvents pelo RabbitMQ. Ele usa RABBITMQ_EXCHANGE, RABBITMQ_GENERATE_REPORT_KEY e RABBITMQ_GENERATE_REPORT_QUEUE, com entrega persistente. Esse comando não faz parte do catálogo público de eventos.

type FilterCondition = {
  eq?: unknown[] | null
  gt?: unknown[] | null
  gte?: unknown[] | null
  lt?: unknown[] | null
  lte?: unknown[] | null
  between?: unknown[] | null
  in?: unknown[] | null
  nin?: unknown[] | null
}

type GenerateReportMessage = {
  templateId: UUID
  reportId: UUID
  outputFormat: string
  filters: Record<string, Record<string, Record<string, FilterCondition>>> | null
  mappedFields: Record<string, Record<string, string[]>> | null
}

Status de eventos de entrada

O Reporter não consome nenhum fato público do lib-streaming. O subscriber do Hub continua indisponível: habilitá-lo é rejeitado na inicialização até que exista um contrato compatível de worker downstream.

Primeiros passos

API de Templates

API do Construtor de Templates

API de Relatórios

API de Prazos

API de Fontes de Dados

API de Métricas

API de Streaming

Tratamento de erros

Eventos

Eventos do Reporter

Envelope e roteamento

Semântica de entrega

Catálogo de eventos emitidos

Contratos `data` completos

Canal de comando interno separado

Status de eventos de entrada

​Envelope e roteamento

​Semântica de entrega

​Catálogo de eventos emitidos

​Contratos data completos

​Canal de comando interno separado

​Status de eventos de entrada

Envelope e roteamento

Semântica de entrega

Catálogo de eventos emitidos

Contratos `data` completos

Canal de comando interno separado

Status de eventos de entrada