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

GitHub.searchIssues silently drops 'incomplete_results: true' from search responses

Abierto
  • ¿Algo no está bien?
#57 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
68/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
typescript
Área
api

Línea de trabajo

Start in src/prompt-generators/github/github.ts and trace the #query calls used by searchIssues, then run the minimal reproduction against the mocked GitHub response. Decide how the existing caller contract should surface incomplete_results and verify that a true flag on any page is no longer silent.

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

Descripción

bug S3

Observed behavior

The GitHub search API can respond with incomplete_results: true in its JSON body. From the GitHub docs:

The Search API has a maximum query timeout of 5 seconds and a maximum result set of 1000. The incomplete_results field will be true whenever a response is returned before the timeout completes, and indicates that some results may be missing.

GitHubSearchReply already types this field:

export interface GitHubSearchReply {
  readonly total_count: number;
  readonly incomplete_results?: boolean;
  readonly items: ReadonlyArray<GitHubIssue>;
}

However, GitHub.searchIssues in src/prompt-generators/github/github.ts never reads incomplete_results. When the field is true, the caller receives a ReadonlyArray<GitHubIssue> that silently omits matches, with no indication that the result is partial. The downstream GitHubPromptGenerator then yields prompts only for the partial set as if it were the full result. This matches the S1 description ("a consumer using the library according to its documented contract receives a result that is wrong, with no error or warning to indicate the problem") at the boundary, but in practice the failure mode is intermittent and recovers on retry, so it is in S3 territory.

Expected behavior

searchIssues should surface incomplete_results: true to the caller in some form. Reasonable options:

  • Log a warning to stderr when the flag is observed on any page, similar to logQuery.
  • Throw an error, requiring the caller to opt in to incomplete results.
  • Return a richer result object ({ issues, incomplete }) instead of a bare array.

A console warning is the lowest-friction fix and matches the existing logging style; an opt-in flag (for example, allowIncomplete) would be more rigorous and avoid silent partial results by default.

Minimal reproduction

import { GitHub } from 'loop-the-loop/prompt-generators/github/github';
import { vi } from 'vitest';

vi.stubGlobal(
  'fetch',
  vi.fn().mockResolvedValue({
    ok: true,
    status: 200,
    text: () =>
      Promise.resolve(
        JSON.stringify({
          total_count: 12345,
          incomplete_results: true,
          items: [
            { number: 1, title: 't', html_url: 'https://github.test/1', state: 'open' },
          ],
        }),
      ),
  }),
);

const github = new GitHub({ origin: 'https://api.test' });
const issues = await github.searchIssues({
  repository: 'octocat/Hello-World',
  query: 'is:open',
  perPage: 1,
  maxResults: 1,
});
// issues.length === 1, but the caller has no way to know the search was
// truncated by GitHub's 5-second timeout.

Suggested fix

At minimum, in src/prompt-generators/github/github.ts, check reply.incomplete_results after each #query call and emit a console.warn (or expose the flag through the return type). For example:

if (reply.incomplete_results) {
  console.warn(
    `GitHub search returned incomplete results for query: ${buildIssueSearchQuery(params)}`,
  );
}
Lenguaje dominante
TypeScript
Estrellas
2
Forks
1
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 joewalker/loop-the-loop

Todos los issues de joewalker/loop-the-loop

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.