Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
  • Qualcosa non va?
#57 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
68/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
api

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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)}`,
  );
}
Lingua principale
TypeScript
Stelle
2
Fork
1
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di joewalker/loop-the-loop

Tutte le issue di joewalker/loop-the-loop

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.