Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Tasks: API: Add pagination and granular message control to logs endpoint

Abierto
#1,247 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Área
api, backend

Línea de trabajo

Comienza revisando el endpoint de registros de tareas, los patrones de paginación existentes de coderd y codersdk.Pagination. Determina cómo debe funcionar la paginación para los registros activos y las instantáneas pausadas, permitiendo a la vez futuros tipos de mensajes ACP. La tarea estará completa cuando el enfoque esté implementado y documentado, se haya probado para ambos estados y la CLI se haya actualizado si es necesario.

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

Descripción

Problem

The task logs API (GET /api/v2/tasks/{user}/{task}/logs) currently returns the entire conversation history. This is not ideal for tasks with long-running conversations:

  • Large response payloads for tasks with hundreds of messages
  • No way to fetch specific message ranges
  • Inefficient for clients that only need recent messages or want to implement infinite scroll

Current Behavior

The API returns all messages in a single response:

{
  "logs": [...],  // All messages
  "snapshot": false,
  "total_count": 250
}

When a task is paused (post-implementation of pause/resume functionality), it returns the last 10 messages from the snapshot:

{
  "logs": [...],  // Last 10 messages
  "snapshot": true,
  "snapshot_at": "2025-01-18T10:00:00Z",
  "total_count": 10
}

Proposed Enhancement

Add pagination support to the logs endpoint. The exact implementation will depend on the message model after ACP integration, which may introduce more granular message types, status updates, and metadata beyond the current large text blocks.

Pagination should follow coderd's existing patterns (using limit, offset, and after_id query parameters as defined in codersdk.Pagination).

Key considerations:

  • With ACP, messages may be split into multiple granular events rather than 500-line text blocks
  • The message structure and metadata may evolve significantly
  • Pagination design should accommodate future message model changes

Context

Raised during RFC review for Task Start/Pause/Resume Lifecycle. Deferred from Beta/GA as it's an enhancement rather than blocking issue.

Acceptance Criteria

  • Design pagination approach that accommodates future ACP message model changes
  • Works for both active tasks (live logs) and paused tasks (snapshots)
  • Follows coderd's existing pagination patterns
  • Document pagination behavior
  • Update CLI if needed to support fetching message ranges

Related

  • RFC: Task Start/Pause/Resume Lifecycle
  • Future: ACP integration for message-level control
Lenguaje dominante
Sin datos de lenguaje
Estrellas
3
Forks
0
Métricas de merge de PR
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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 coder/internal

Todos los issues de coder/internal

Issues similares

Más issues de Backend & API Design

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.