Fix Bot Mention Trigger Silently Discarded by Queue Worker Due to Raw Event Name Mismatch

Abierto
#169 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
67/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
github, node.js, typescript

Línea de trabajo

Read packages/core/src/review/resolve-job.ts and trace how it loads webhook_deliveries; compare that path with normalization in packages/provider-github/src/webhook.ts and delivery creation in packages/api/src/routes/webhook.ts. Start with the tests around resolveQueuedJob and add coverage for an issue_comment delivery and a closed pull_request delivery. Done means mention reviews and PR-close label cleanup run, existing auto-triggered reviews still work, and the listed typecheck, test, and lint commands pass.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug good first issue

Summary

Mention-triggered reviews (e.g. @codra review posted as a PR comment) are silently dropped before they ever reach the review worker. The pipeline queues the message, but the worker discards it immediately because it checks for a normalized event name that was never stored.

Root Cause

The webhook handler in packages/api/src/routes/webhook.ts reads the raw GitHub header x-github-event (value: "issue_comment") and stores it in the webhook_deliveries table as-is.

When the queue worker calls resolveQueuedJob in packages/core/src/review/resolve-job.ts, it loads the delivery and checks:

if (eventName !== "change_request" && eventName !== "comment") {
  logger.info(`Queue message ignored: unsupported webhook event ${eventName}`);
  return null;
}

Since delivery.event_name is "issue_comment" (raw GitHub header), not "comment" (the normalized name), the check fails and the message is thrown away. Mention-triggered reviews never execute.

The same mismatch applies to pull_request to change_request for PR-close label cleanup. Any job that takes the fallback path through the delivery lookup (without an inline jobId or payload on the queue message) can be affected.

Affected Files

  • packages/api/src/routes/webhook.ts - stores raw eventName in delivery and passes it raw to the queue message (L274-278)
  • packages/core/src/review/resolve-job.ts - checks normalized names against raw stored names (L42-50)
  • packages/provider-github/src/webhook.ts - normalizeGitHubWebhook correctly maps "issue_comment" to "comment", but is never called on the worker path

Proposed Fix

In resolveQueuedJob, after loading the delivery record, normalize eventName before checking:

// After loading delivery:
const normalized = env.webhooks.normalizePayload(delivery.event_name, delivery.payload);
if (normalized) {
  eventName = normalized.eventName;  // "comment" or "change_request"
  payload = normalized.payload;
} else {
  eventName = delivery.event_name;
  payload = delivery.payload as WebhookPayload;
}

Alternatively (and more robustly), store the normalized event name in webhook_deliveries at insertion time in the webhook route, so the queue always receives the canonical name regardless of which path it takes.

Done When

  • @codra review comments on a PR trigger a review job correctly
  • PR-close label cleanup runs for pull_request closed events
  • Existing auto-triggered PR reviews (opened, synchronize, etc.) continue to work
  • Tests cover the mention trigger path end-to-end through resolveQueuedJob
  • Any backend changes work in both Cloudflare Workers and Node/Docker
  • npm run typecheck, npm test, and npm run lint all pass

Before Closing

  • npm run typecheck, npm test, and npm run lint all pass
  • Any backend changes work in both Cloudflare Workers and Node/Docker
  • Tests cover the changed behavior in each affected runtime
Lenguaje dominante
TypeScript
Estrellas
125
Forks
23
Merge medio
2 d 13 h
PR fusionados (30 d)
12

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de devarshishimpi/codra

Todos los issues de devarshishimpi/codra

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.