Eventos de Reporter

Reporter tiene 12 definiciones únicas de eventos de negocio emitidos. Son mensajes CloudEvents 1.0 en modo binario que viajan por RabbitMQ cuando STREAMING_ENABLED=true. Reporter no publica estos hechos en Kafka. Cuando el streaming está desactivado, manager y worker usan un emisor no-op y no inician un dispatcher de outbox.

Envelope y enrutamiento

Todos los eventos usan ce-source reporter, ce-schemaversion 1.0.0 y un ce-type calificado por fuente con la forma studio.lerian.reporter.<resource>.<event>. El payload es JSON con claves en snake_case.

Elemento del contrato	Valor
Exchange	Valor de `RABBITMQ_REPORT_EVENTS_EXCHANGE`
Routing key de AMQP	Exactamente la clave de definición, por ejemplo `report.finished`
Tipo de contenido	`application/json`
Modo de entrega	Mensaje AMQP persistente
Asunto	Id de plantilla, informe o plazo
Tenant	Tenant de contexto en `ce-tenantid` y `X-Tenant-ID`; usa el fallback de un solo tenant cuando no hay tenant presente
Manifest	`GET /v1/streaming/events`

Consulta el envelope compartido para el contrato completo de headers de CloudEvents.

Semántica de entrega

Reporter emite después de confirmar el cambio de estado de negocio. Los errores de publicación no hacen fallar la operación subyacente.

Importante: publicación directa, con fallback a un outbox duradero cuando el circuito del broker está abierto.
Crítica: Reporter omite la publicación directa. Siempre persiste el evento en el outbox duradero para su despacho y reintento.
Ambas políticas solicitan on_routable_failure, pero las rutas actuales de RabbitMQ no definen un destino DLQ explícito. El publicador ve un fallo enrutable. Ninguna copia llega a una ruta dead-letter.
La entrega del broker es al menos una vez. Los consumidores deben ser idempotentes y deduplicar con (ce-source, ce-id).

Catálogo de eventos emitidos

Clave de definición	`ce-type`	Política	Se dispara cuando
`template.created`	`studio.lerian.reporter.template.created`	Importante	Se persisten el archivo de la plantilla y sus metadatos.
`template.updated`	`studio.lerian.reporter.template.updated`	Importante	Se completan la actualización de la plantilla y cualquier reemplazo de archivo.
`template.deleted`	`studio.lerian.reporter.template.deleted`	Importante	Se completa la eliminación de una plantilla; el rollback de creación no lo emite.
`report.requested`	`studio.lerian.reporter.report.requested`	Importante	El informe se persiste como `Processing`, antes de que manager intente publicar el comando al worker. No prueba que el comando haya quedado en cola.
`report.finished`	`studio.lerian.reporter.report.finished`	Crítica	Se almacena el artefacto y se confirma el estado `Finished`.
`report.partial`	`studio.lerian.reporter.report.partial`	Crítica	Se almacena el artefacto y se confirma un estado terminal parcial.
`report.errored`	`studio.lerian.reporter.report.errored`	Crítica	Manager o worker confirma un estado terminal `Error`.
`deadline.created`	`studio.lerian.reporter.deadline.created`	Importante	Se persiste un plazo.
`deadline.updated`	`studio.lerian.reporter.deadline.updated`	Importante	Se persiste la actualización de un plazo y se carga el registro actualizado.
`deadline.deleted`	`studio.lerian.reporter.deadline.deleted`	Importante	Se persiste la eliminación lógica de un plazo.
`deadline.delivered`	`studio.lerian.reporter.deadline.delivered`	Crítica	Se persiste la marca de entrega.
`deadline.delivery_reverted`	`studio.lerian.reporter.deadline.delivery_reverted`	Crítica	Se elimina la marca de entrega.

Tanto manager como worker emiten report.errored. Todas las variantes usan el ce-id determinista reporter.report.error.<report_id>. Por eso, un consumidor que deduplica según (ce-source, ce-id) conserva solo el primer report.errored recibido para un report_id. Las transiciones críticas de plazo usan reporter.deadline.<event_type>.<deadline_id>.<timestamp>.

Contratos `data` completos

Estas declaraciones al estilo TypeScript reflejan la forma del JSON en el wire. ? indica que la propiedad es opcional. | null indica que la propiedad está presente pero puede ser null en JSON. Los timestamps son 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
}

Riel interno de comandos separado

Manager envía a worker un comando JSON que no es CloudEvents por RabbitMQ. Usa RABBITMQ_EXCHANGE, RABBITMQ_GENERATE_REPORT_KEY y RABBITMQ_GENERATE_REPORT_QUEUE, con entrega persistente. Este comando no forma parte del 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
}

Estado de eventos entrantes

Reporter no consume ningún hecho público de lib-streaming. Su suscriptor de Hub permanece no disponible: habilitarlo se rechaza al iniciar hasta que exista un contrato de worker downstream compatible.

Primeros pasos

API de Plantillas

API del Constructor de Plantillas

API de Informes

API de Plazos

API de Fuentes de Datos

API de Métricas

API de Streaming

Manejo de errores

Eventos

Eventos de Reporter

Envelope y enrutamiento

Semántica de entrega

Catálogo de eventos emitidos

Contratos `data` completos

Riel interno de comandos separado

Estado de eventos entrantes

​Envelope y enrutamiento

​Semántica de entrega

​Catálogo de eventos emitidos

​Contratos data completos

​Riel interno de comandos separado

​Estado de eventos entrantes

Envelope y enrutamiento

Semántica de entrega

Catálogo de eventos emitidos

Contratos `data` completos

Riel interno de comandos separado

Estado de eventos entrantes